Customer session
Refresh customer token
This method refreshes the customer’s current token.
This method requires customer authentication.
Declared In:
lib/main/modules/ClientModule.js
Class:
ClientModule
Declaration:
public refreshToken(onSuccess: () => void, onError: (error: Error) => void)
Parameters:
Parameter | Type | Mandatory | Default | Description |
---|---|---|---|---|
onSuccess | Function | no | - | Function to be executed when the operation is completed successfully |
onError | Function | no | - | Function to be executed when the operation is completed with an error |
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.
This method requires customer authentication.
Declared In:
lib/main/modules/ClientModule.js
Related To:
Token
Class:
ClientModule
Declaration:
public retrieveToken(onSuccess: (token: Token) => void, onError: (error: Error) => void)
Parameters:
Parameter | Type | Mandatory | Default | Description |
---|---|---|---|---|
onSuccess | Function | no | - | Function to be executed when the operation is completed successfully |
onError | Function | no | - | Function to be executed when the operation is completed with an error |
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.
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.
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:
Parameter | Type | Mandatory | Default | Description |
---|---|---|---|---|
clientIdentifier | string | no | - | Seed for UUID generation |
Return Value:
No value is returned.
Destroy current session
This method destroys the whole session completely.
Declared In:
lib/main/modules/ClientModule.js
Class:
ClientModule
Declaration:
public destroySession()
Return Value:
No value is returned.
Example:
Synerise.Client.destroySession();