aerogear-xamarin-sdk
AeroGear Xamarin SDK
AeroGear.Mobile.Auth.IAuthService Interface Reference

Interface for an auth service module IServiceModule. More...

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

Public Member Functions

User CurrentUser ()
 Retrieve the current user. More...
 
Task< UserAuthenticate (IAuthenticateOptions authenticateOptions)
 Initiate an authentication flow. More...
 
void Configure (AuthenticationConfig authConfig)
 Configure the service module. More...
 
Task< bool > Logout (User user)
 Logout the specified user. More...
 
- Public Member Functions inherited from AeroGear.Mobile.Core.IServiceModule
void Destroy ()
 Called when singleThreadService destroyed. More...
 
void Configure (MobileCore core, ServiceConfiguration config)
 

Additional Inherited Members

- 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

Interface for an auth service module IServiceModule.

Member Function Documentation

◆ Authenticate()

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

Initiate an authentication flow.

Returns
Task

Implemented in AeroGear.Mobile.Auth.AbstractAuthService.

◆ Configure()

void AeroGear.Mobile.Auth.IAuthService.Configure ( AuthenticationConfig  authConfig)

Configure the service module.

Parameters
authConfigAuthentication configuration.

Implemented in AeroGear.Mobile.Auth.AbstractAuthService.

◆ CurrentUser()

User AeroGear.Mobile.Auth.IAuthService.CurrentUser ( )

Retrieve the current user.

Returns
The current user.

Implemented in AeroGear.Mobile.Auth.AbstractAuthService.

◆ Logout()

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

Logout the specified user.

Returns
Task

Implemented in AeroGear.Mobile.Auth.AbstractAuthService.


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