aerogear-xamarin-sdk
AeroGear Xamarin SDK
AeroGear.Mobile.Auth.AbstractAuthService Class Referenceabstract

Abstract implementation of IAuthService. More...

Inheritance diagram for AeroGear.Mobile.Auth.AbstractAuthService:
AeroGear.Mobile.Auth.IAuthService AeroGear.Mobile.Core.IServiceModule

Public Member Functions

abstract User CurrentUser ()
 Retrieve the current user. More...
 
 AbstractAuthService (MobileCore mobileCore=null, ServiceConfiguration serviceConfig=null)
 Initializes a new instance of the T:AeroGear.Mobile.Auth.AbstractAuthService class. More...
 
abstract void Configure (AuthenticationConfig authConfig)
 Configure the service module. More...
 
Task< UserAuthenticate (IAuthenticateOptions authenticateOptions)
 Initiate an authentication flow. More...
 
void Destroy ()
 Perform teardown steps that should be done before destroying the instance. More...
 
Task< bool > Logout (User user)
 Logout the specified user. More...
 
void Configure (MobileCore core, ServiceConfiguration config)
 

Public Attributes

string Type => "keycloak"
 
bool RequiresConfiguration => false
 
string Id => null
 

Protected Attributes

readonly KeycloakConfig KeycloakConfig
 
readonly MobileCore Core
 

Properties

CredentialManager CredentialManager [get, set]
 
AuthenticationConfig AuthenticationConfig [get]
 
IAuthenticator Authenticator [get, set]
 
- Properties inherited from AeroGear.Mobile.Core.IServiceModule
String Id [get]
 
String Type [get]
 Type/name used in the mobile-singleThreadService.json More...
 
bool RequiresConfiguration [get]
 Whether the singleThreadService module requires its singleThreadService configuration to be defined or if it can be null. If this is More...
 

Detailed Description

Abstract implementation of IAuthService.

Constructor & Destructor Documentation

◆ AbstractAuthService()

AeroGear.Mobile.Auth.AbstractAuthService.AbstractAuthService ( MobileCore  mobileCore = null,
ServiceConfiguration  serviceConfig = null 
)

Initializes a new instance of the T:AeroGear.Mobile.Auth.AbstractAuthService class.

Parameters
mobileCoreMobile core.
serviceConfigService config.

Member Function Documentation

◆ Authenticate()

Task<User> AeroGear.Mobile.Auth.AbstractAuthService.Authenticate ( IAuthenticateOptions  authenticateOptions)

Initiate an authentication flow.

Returns
The authenticate.
Parameters
authenticateOptionsAuthenticate options.

Implements AeroGear.Mobile.Auth.IAuthService.

◆ Configure() [1/2]

abstract void AeroGear.Mobile.Auth.AbstractAuthService.Configure ( AuthenticationConfig  authConfig)
pure virtual

Configure the service module.

Parameters
authConfigAuthentication configuration.

Implements AeroGear.Mobile.Auth.IAuthService.

◆ Configure() [2/2]

void AeroGear.Mobile.Auth.AbstractAuthService.Configure ( MobileCore  core,
ServiceConfiguration  config 
)

◆ CurrentUser()

abstract User AeroGear.Mobile.Auth.AbstractAuthService.CurrentUser ( )
pure virtual

Retrieve the current user.

Returns
The current user.

Implements AeroGear.Mobile.Auth.IAuthService.

◆ Destroy()

void AeroGear.Mobile.Auth.AbstractAuthService.Destroy ( )

Perform teardown steps that should be done before destroying the instance.

Implements AeroGear.Mobile.Core.IServiceModule.

◆ Logout()

Task<bool> AeroGear.Mobile.Auth.AbstractAuthService.Logout ( User  user)

Logout the specified user.

Returns
Task
Parameters
userThe user to logout.

Implements AeroGear.Mobile.Auth.IAuthService.

Member Data Documentation

◆ Core

readonly MobileCore AeroGear.Mobile.Auth.AbstractAuthService.Core
protected

◆ Id

string AeroGear.Mobile.Auth.AbstractAuthService.Id => null

◆ KeycloakConfig

readonly KeycloakConfig AeroGear.Mobile.Auth.AbstractAuthService.KeycloakConfig
protected

◆ RequiresConfiguration

bool AeroGear.Mobile.Auth.AbstractAuthService.RequiresConfiguration => false

◆ Type

string AeroGear.Mobile.Auth.AbstractAuthService.Type => "keycloak"

Property Documentation

◆ AuthenticationConfig

AuthenticationConfig AeroGear.Mobile.Auth.AbstractAuthService.AuthenticationConfig
getprotected

◆ Authenticator

IAuthenticator AeroGear.Mobile.Auth.AbstractAuthService.Authenticator
getsetprotected

◆ CredentialManager

CredentialManager AeroGear.Mobile.Auth.AbstractAuthService.CredentialManager
getsetprotected

The documentation for this class was generated from the following file: