Interface IDeviceUser

The interface for the Device functionality

Namespace: Phoenix.Users
Assembly: Phoenix.Abstractions.Users.dll
Syntax
[Obsolete("Implementation of this class has been removed. Use the device console library instead.", true)]
public interface IDeviceUser

Properties

View Source

Device

Gets the Device.

Declaration
IDevice Device { get; }
Property Value
Type Description
IDevice

Methods

View Source

AddUserAsync(String, String)

Adds a user to the device.

Declaration
Task<PhoenixUser> AddUserAsync(string email, string password)
Parameters
Type Name Description
System.String email

The email address to add.
System.String password

The password to use to sign in.
Returns
Type Description
System.Threading.Tasks.Task<PhoenixUser>

A task which will return a newly created PhoenixUser based on the device user.
View Source

GetDefaultSignedInUserAsync()

Gets the default signed in user.

Declaration
Task<string> GetDefaultSignedInUserAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

the default signed in user
View Source

GetUsersAsync()

Gets the users of the device.

Declaration
Task<IEnumerable<PhoenixUser>> GetUsersAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<PhoenixUser>>

A list of users currently present.
View Source

ImportFromUserFileAsync(String)

Imports users from the specified file. The file must at least contain the user's e-mail.

Declaration
Task<IEnumerable<SerializableUser>> ImportFromUserFileAsync(string filePath)
Parameters
Type Name Description
System.String filePath

Path to the file to import from.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<SerializableUser>>

List of imported users or null if an error was found.
View Source

RemoveAllUsersAsync()

Removes all users from the device.

Declaration
Task RemoveAllUsersAsync()
Returns
Type Description
System.Threading.Tasks.Task

The task performing the request.
View Source

RemoveUserAsync(String)

Removes the user from the device.

Declaration
Task RemoveUserAsync(string email)
Parameters
Type Name Description
System.String email

The email associated with the user to remove.
Returns
Type Description
System.Threading.Tasks.Task

The task performing the request.
View Source

SetDefaultSignedInUserAsync(String)

Sets the default signed in user.

Declaration
Task SetDefaultSignedInUserAsync(string user)
Parameters
Type Name Description
System.String user

The user to set.
Returns
Type Description
System.Threading.Tasks.Task

awaitable task
View Source

SignInUserAsync(String, String)

Signs in a user to the device.

Declaration
Task<PhoenixUser> SignInUserAsync(string email, string password)
Parameters
Type Name Description
System.String email

The email address to sign in.
System.String password

The password to use to sign in.
Returns
Type Description
System.Threading.Tasks.Task<PhoenixUser>

A task which will return the signed-in PhoenixUser based on the device user.
View Source

SignOutUserAsync(String)

Signs out a user from the device.

Declaration
Task<PhoenixUser> SignOutUserAsync(string email)
Parameters
Type Name Description
System.String email

The email address to sign out.
Returns
Type Description
System.Threading.Tasks.Task<PhoenixUser>

A task which will return the signed-out PhoenixUser based on the device user.