Class AuthgearSdk

Inheritance
System.Object
AuthgearSdk
Namespace: Authgear.Xamarin
Assembly: Authgear.Xamarin.dll
Syntax
public sealed class AuthgearSdk : IDisposable

Properties

| Improve this Doc View Source

AccessToken

Declaration
public string? AccessToken { get; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

AuthTime

Declaration
public DateTimeOffset? AuthTime { get; }
Property Value
Type Description
System.Nullable<DateTimeOffset>
| Improve this Doc View Source

CanReauthenticate

Declaration
public bool CanReauthenticate { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ClientId

Declaration
public string ClientId { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IdTokenHint

Declaration
public string? IdTokenHint { get; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

SessionState

Declaration
public SessionState SessionState { get; }
Property Value
Type Description
SessionState

Methods

| Improve this Doc View Source

AuthenticateAnonymouslyAsync()

Declaration
public async Task<UserInfo> AuthenticateAnonymouslyAsync()
Returns
Type Description
Task<UserInfo>
| Improve this Doc View Source

AuthenticateAsync(AuthenticateOptions)

Declaration
public async Task<UserInfo> AuthenticateAsync(AuthenticateOptions options)
Parameters
Type Name Description
AuthenticateOptions options
Returns
Type Description
Task<UserInfo>
| Improve this Doc View Source

AuthenticateBiometricAsync(BiometricOptions)

Declaration
public async Task<UserInfo> AuthenticateBiometricAsync(BiometricOptions options)
Parameters
Type Name Description
BiometricOptions options
Returns
Type Description
Task<UserInfo>
Exceptions
Type Condition
BiometricPrivateKeyNotFoundException
| Improve this Doc View Source

ClearSessionState()

Declaration
public void ClearSessionState()
| Improve this Doc View Source

ConfigureAsync()

Declaration
public async Task ConfigureAsync()
Returns
Type Description
Task
| Improve this Doc View Source

DisableBiometricAsync()

Declaration
public async Task DisableBiometricAsync()
Returns
Type Description
Task
| Improve this Doc View Source

Dispose()

Declaration
public void Dispose()
| Improve this Doc View Source

EnableBiometricAsync(BiometricOptions)

Declaration
public async Task EnableBiometricAsync(BiometricOptions options)
Parameters
Type Name Description
BiometricOptions options
Returns
Type Description
Task
Exceptions
Type Condition
UnauthenticatedUserException
| Improve this Doc View Source

EnsureBiometricIsSupported(BiometricOptions)

Declaration
public void EnsureBiometricIsSupported(BiometricOptions options)
Parameters
Type Name Description
BiometricOptions options
| Improve this Doc View Source

FetchUserInfoAsync()

Declaration
public async Task<UserInfo> FetchUserInfoAsync()
Returns
Type Description
Task<UserInfo>
| Improve this Doc View Source

GetIsBiometricEnabledAsync()

Declaration
public async Task<bool> GetIsBiometricEnabledAsync()
Returns
Type Description
Task<System.Boolean>
| Improve this Doc View Source

LogoutAsync(Nullable<Boolean>)

Declaration
public async Task LogoutAsync(bool? force = null)
Parameters
Type Name Description
System.Nullable<System.Boolean> force
Returns
Type Description
Task
| Improve this Doc View Source

OpenAsync(SettingsPage, SettingsOptions)

Declaration
public async Task OpenAsync(SettingsPage page, SettingsOptions options = null)
Parameters
Type Name Description
SettingsPage page
SettingsOptions options
Returns
Type Description
Task
| Improve this Doc View Source

OpenUrlAsync(String, SettingsOptions)

Declaration
public async Task OpenUrlAsync(string path, SettingsOptions options = null)
Parameters
Type Name Description
System.String path
SettingsOptions options
Returns
Type Description
Task
| Improve this Doc View Source

PromoteAnonymousUserAsync(PromoteOptions)

Declaration
public async Task<UserInfo> PromoteAnonymousUserAsync(PromoteOptions options)
Parameters
Type Name Description
PromoteOptions options
Returns
Type Description
Task<UserInfo>
Exceptions
Type Condition
AnonymousUserNotFoundException
| Improve this Doc View Source

ReauthenticateAsync(ReauthenticateOptions, BiometricOptions)

Declaration
public async Task<UserInfo> ReauthenticateAsync(ReauthenticateOptions options, BiometricOptions biometricOptions)
Parameters
Type Name Description
ReauthenticateOptions options
BiometricOptions biometricOptions
Returns
Type Description
Task<UserInfo>
Exceptions
Type Condition
AuthgearException
| Improve this Doc View Source

RefreshAccessTokenIfNeededAsync()

Declaration
public async Task<string> RefreshAccessTokenIfNeededAsync()
Returns
Type Description
Task<System.String>
| Improve this Doc View Source

RefreshIdTokenAsync()

Declaration
public async Task RefreshIdTokenAsync()
Returns
Type Description
Task

Events

| Improve this Doc View Source

SessionStateChange

Declaration
public event EventHandler<SessionStateChangeReason> SessionStateChange
Event Type
Type Description
EventHandler<SessionStateChangeReason>