Class LoginViewModel

The sign-in form: user ID, password, and the homeserver address for servers without discovery; it also creates accounts, with the registration token and the server's policies when the server asks for them.

Inheritance

object

ObservableObject

ViewModelBase

LoginViewModel

Implements

INotifyPropertyChanged

INotifyPropertyChanging

Inherited Members

ObservableObject.PropertyChanged

ObservableObject.PropertyChanging

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Uniform.Chat.Avalonia.ViewModels

Assembly: Uniform.Chat.Avalonia.dll

Syntax

public sealed class LoginViewModel : ViewModelBase, INotifyPropertyChanged, INotifyPropertyChanging

Constructors

LoginViewModel(Func<SignIn, Task>, IAccountCreator?)

The sign-in form: user ID, password, and the homeserver address for servers without discovery; it also creates accounts, with the registration token and the server's policies when the server asks for them.

Declaration

public LoginViewModel(Func<SignIn, Task> signIn, IAccountCreator? creator = null)

Parameters

Type	Name	Description
Func<SignIn, Task>	signIn	Sign in with the form's values; reports failures in ErrorMessage.
IAccountCreator	creator	Creates accounts; null hides account creation.

Fields

PrivacyPolicyUrl

Address of the app's privacy policy.

Declaration

public const string PrivacyPolicyUrl = "https://github.com/tagcode/Uniform.Chat/blob/main/user-docs/Uniform.Chat.Android/privacy-policy.md"

Field Value

Type	Description
string

UserPolicyUrl

Address of the app's user policy, which people accept by signing in.

Declaration

public const string UserPolicyUrl = "https://github.com/tagcode/Uniform.Chat/blob/main/user-docs/Uniform.Chat.Android/user-policy.md"

Field Value

Type	Description
string

Properties

AcceptTerms

Declaration

[ObservableProperty]
[ExcludeFromCodeCoverage]
public bool AcceptTerms { get; set; }

Property Value

Type	Description
bool

ActionText

Text of the main button.

Declaration

public string ActionText { get; }

Property Value

Type	Description
string

CanRegister

Whether accounts can be created here.

Declaration

public bool CanRegister { get; }

Property Value

Type	Description
bool

ErrorMessage

Declaration

[ObservableProperty]
[NotifyPropertyChangedFor("HasError")]
[ExcludeFromCodeCoverage]
public string ErrorMessage { get; set; }

Property Value

Type	Description
string

HasError

Whether there is an error to show.

Declaration

public bool HasError { get; }

Property Value

Type	Description
bool

HasPolicies

Declaration

[ObservableProperty]
[ExcludeFromCodeCoverage]
public bool HasPolicies { get; set; }

Property Value

Type	Description
bool

Homeserver

Declaration

[ObservableProperty]
[ExcludeFromCodeCoverage]
public string Homeserver { get; set; }

Property Value

Type	Description
string

IsBusy

Declaration

[ObservableProperty]
[NotifyCanExecuteChangedFor("SignInCommand")]
[ExcludeFromCodeCoverage]
public bool IsBusy { get; set; }

Property Value

Type	Description
bool

IsRegistering

Declaration

[ObservableProperty]
[NotifyPropertyChangedFor("Title", new string[] { "ActionText", "SwitchText" })]
[ExcludeFromCodeCoverage]
public bool IsRegistering { get; set; }

Property Value

Type	Description
bool

NeedsToken

Declaration

[ObservableProperty]
[ExcludeFromCodeCoverage]
public bool NeedsToken { get; set; }

Property Value

Type	Description
bool

Password

Declaration

[ObservableProperty]
[NotifyCanExecuteChangedFor("SignInCommand")]
[ExcludeFromCodeCoverage]
public string Password { get; set; }

Property Value

Type	Description
string

Policies

The server's policies to accept before registering.

Declaration

public ObservableCollection<TermsPolicy> Policies { get; }

Property Value

Type	Description
ObservableCollection<TermsPolicy>

RegistrationToken

Declaration

[ObservableProperty]
[ExcludeFromCodeCoverage]
public string RegistrationToken { get; set; }

Property Value

Type	Description
string

SignInCommand

Gets an IAsyncRelayCommand instance wrapping Uniform.Chat.Avalonia.ViewModels.LoginViewModel.SignInAsync().

Declaration

[ExcludeFromCodeCoverage]
public IAsyncRelayCommand SignInCommand { get; }

Property Value

Type	Description
IAsyncRelayCommand

SwitchModeCommand

Gets an IRelayCommand instance wrapping Uniform.Chat.Avalonia.ViewModels.LoginViewModel.SwitchMode().

Declaration

[ExcludeFromCodeCoverage]
public IRelayCommand SwitchModeCommand { get; }

Property Value

Type	Description
IRelayCommand

SwitchText

Text of the button that switches between signing in and creating an account.

Declaration

public string SwitchText { get; }

Property Value

Type	Description
string

Title

Heading of the form.

Declaration

public string Title { get; }

Property Value

Type	Description
string

UserId

Declaration

[ObservableProperty]
[NotifyCanExecuteChangedFor("SignInCommand")]
[ExcludeFromCodeCoverage]
public string UserId { get; set; }

Property Value

Type	Description
string

Implements

INotifyPropertyChanged

INotifyPropertyChanging