DittoSDK.DittoAuthenticator Class Reference

Provides access to authentication information and methods for logging on to Ditto Cloud. Relevant when using an OnlineWithAuthentication or an Online identity. More...

Public Member Functions
async Task< DittoError >	LoginWithToken (string token, string provider)
	Log in to Ditto with a third-party token.
Task<(string clientInfoJson, DittoError error)>	Login (string token, string provider)
	Log in to Ditto with a third-party token.
async Task< DittoError >	LoginWithCredentials (string username, string password, string provider)
	Log in to Ditto with a username and password.
IDisposable	ObserveStatus (Action< DittoAuthenticationStatus > callback)
	Registers a callback that is called whenever the authentication status changes.
void	Logout (Action< Ditto > cleanupAction=null)
	Log out of Ditto.

Properties
DittoAuthenticationStatus	Status [get]
	Gets the current authentication status.

Detailed Description

Provides access to authentication information and methods for logging on to Ditto Cloud. Relevant when using an OnlineWithAuthentication or an Online identity.

Member Function Documentation

Login()

Task<(string clientInfoJson, DittoError error)> DittoSDK.DittoAuthenticator.Login ( string token, string provider )

inline

Log in to Ditto with a third-party token.

If authentication has failed then the returned DittoError will be non-null. The returned clientInfoJson string will not be null if the auth webhook endpoint returned any JSON value under the clientInfo key. That JSON value is what will be passed via the clientInfoJson string, if it's provided.

Parameters

token	The authentication token required to log in.
provider	The name of the authentication provider.

Returns

A tuple containing the clientInfoJson and the DittoError. The error will be null if the authentication succeeded.

LoginWithCredentials()

async Task< DittoError > DittoSDK.DittoAuthenticator.LoginWithCredentials ( string username, string password, string provider )

inline

Log in to Ditto with a username and password.

Parameters

username	The username component of the credentials used for log in.
password	The password component of the credentials used for log in.
provider	The name of the authentication provider.

Returns

A DittoError if the login attempt failed, otherwise null.

LoginWithToken()

async Task< DittoError > DittoSDK.DittoAuthenticator.LoginWithToken ( string token, string provider )

inline

Log in to Ditto with a third-party token.

Parameters

token	The authentication token required to log in.
provider	The name of the authentication provider.

Returns

A DittoError if the login attempt failed, otherwise null.

Logout()

void DittoSDK.DittoAuthenticator.Logout ( Action< Ditto > cleanupAction = null )

inline

Log out of Ditto.

This will stop sync, shut down all replication sessions, and remove any cached authentication credentials. Note that this does not remove any data from the store. If you wish to delete data from the store then use the optional cleanupAction argument to perform any required cleanup.

Parameters

cleanupAction

An optional action that will be called with the relevant Ditto instance as the sole argument that allows you to perform any required cleanup of the store as part of the logout process.

ObserveStatus()

IDisposable DittoSDK.DittoAuthenticator.ObserveStatus ( Action< DittoAuthenticationStatus > callback )

inline

Registers a callback that is called whenever the authentication status changes.

Parameters

callback

An action reference to the caller's callback.

Returns

An IDisposable that you can use to stop this observation.