AeroGear.Mobile.Auth.Authenticator.IAuthenticator Interface Reference

Interface for authenticators. Authenticator will perform the actual authentication actions. More...

Inheritance diagram for AeroGear.Mobile.Auth.Authenticator.IAuthenticator:

Public Member Functions
Task< User >	Authenticate (IAuthenticateOptions authenticateOptions)
	Perform the authentication request More...
Task< bool >	Logout (User currentUser)
	Logout the specified currentUser. More...

Detailed Description

Interface for authenticators. Authenticator will perform the actual authentication actions.

Member Function Documentation

Authenticate()

Task<User> AeroGear.Mobile.Auth.Authenticator.IAuthenticator.Authenticate

(

IAuthenticateOptions

authenticateOptions

)

Perform the authentication request

Returns

The authenticated user

Parameters

authenticateOptions

Authenticate options. See IAuthenticateOptions

Implemented in AeroGear.Mobile.Auth.Authenticator.AbstractAuthenticator.

Logout()

Task<bool> AeroGear.Mobile.Auth.Authenticator.IAuthenticator.Logout

(

User

currentUser

)

Logout the specified currentUser.

Returns

If the logout operation is successful.

Parameters

currentUser

Current user.

Implemented in AeroGear.Mobile.Auth.Authenticator.AbstractAuthenticator.

---

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

• Auth/Auth/Authenticator/IAuthenticator.cs