Customer session

Refresh customer token

This method refreshes the customer’s current token.

Declared In:
lib/main/modules/ClientModule.js

Class:
ClientModule

Declaration:

public refreshToken(onSuccess: () => void, onError: (error: Error) => void)

Parameters:

Return Value:
No value is returned.

Example:

Synerise.Client.refreshToken(function(token) {
  // success
}, function(error) {
  // failure
});

Retrieve customer token

This method retrieves the customer’s current, active token.

Declared In:
lib/main/modules/ClientModule.js

Related To:
Token

Class:
ClientModule

Declaration:

public retrieveToken(onSuccess: (token: Token) => void, onError: (error: Error) => void)

Parameters:

Return Value:
No value is returned.

Example:

Synerise.Client.retrieveToken(function(token) {
  // success
}, function(error) {
  // failure
});

Get current customer UUID

This method retrieves the customer’s current UUID.

Declared In:
lib/main/modules/ClientModule.js

Class:
ClientModule

Declaration:

public getUUID(): string

Return Value:
The method returns the customer’s UUID as string.

Example:

let uuid = Synerise.Client.getUUID();

Regenerate customer

This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier.

This operation works only if the customer is anonymous.

This operation clears the authentication token, login (if applicable), custom email, and custom identifier.

Declared In:
lib/main/modules/ClientModule.js

Class:
ClientModule

Declaration:

public regenerateUUID()

Return Value:
No value is returned.

Example:

Synerise.Client.regenerateUUID();

Regenerate customer with identifier

This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier.

This operation works only if the customer is anonymous.

This operation clears the authentication token, login (if applicable), custom email, and custom identifier

The optional clientIdentifier parameter is a seed for UUID generation.

Declared In:
lib/main/modules/ClientModule.js

Class:
ClientModule

Declaration:

public regenerateUUIDWithClientIdentifier(clientIdentifier: string)

Parameters:

Return Value:
No value is returned.

Destroy current session

This method destroys the session completely.

This method clears all session data (both client and anonymous) and removes cached data. Then, it regenerates the UUID and creates the new anonymous session.

Declared In:
lib/main/modules/ClientModule.js

Class:
ClientModule

Declaration:

public destroySession()

Return Value:
No value is returned.

Example:

Synerise.Client.destroySession();