ClientImpl class

Inheritance

Constructors

ClientImpl()

Properties

hashCode → int
The hash code for this object.
no setterinherited
isInitialized ↔ bool
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

afterInitialization() → void
inherited
authenticate(ClientAuthContext clientAuthContext, IdentityProvider identityProvider, String tokenString, {required void onSuccess(bool), required void onError(SyneriseError error)}) → Future<void>
This function authenticates a client using an identity provider, clientAuthContext and a token string.
authenticateConditionally(IdentityProvider identityProvider, String tokenString, {required void onSuccess(ClientConditionalAuthResult), required void onError(SyneriseError error), ClientCondtitionalAuthContext? clientAuthContext, String? authID}) → Future<void>
The function authenticateConditionally authenticates a user conditionally based on the provided identity provider, token string, client authentication context, and authentication ID.
beforeInitialization() → void
inherited
changePassword(String oldPassword, String password, {required void onSuccess(), required void onError(SyneriseError error)}) → Future<void>
This function changes the user's password by calling a private method with the old and new passwords as parameters.
confirmAccountActivation(String token, {required void onSuccess(), required void onError(SyneriseError error)}) → Future<void>
This function confirms a user's account using a token.
confirmAccountActivationByPin(String email, String pinCode, {required void onSuccess(), required void onError(SyneriseError error)}) → Future<void>
The function confirmAccountActivationByPin takes an email and a pin code as parameters and confirms the acctivation of an account by a pinCode.
confirmEmailChange(String token, bool newsletterAgreement, {required void onSuccess(), required void onError(SyneriseError error)}) → Future<void>
The function confirmEmailChange in Dart confirms the change of email with a token and updates the newsletter agreement.
confirmPasswordReset(String token, String password, {required void onSuccess(), required void onError(SyneriseError error)}) → Future<void>
This function confirms a password reset using a token and a new password.
confirmPhoneUpdate(String phone, String confirmationCode, bool smsAgreement, {required void onSuccess(), required void onError(SyneriseError error)}) → Future<void>
The function confirmPhoneUpdate takes in a phone number, confirmation code, and SMS agreement, and calls a private method to confirm the phone update.
deleteAccount(String clientAuthFactor, IdentityProvider identityProvider, String? authId, {required void onSuccess(), required void onError(SyneriseError error)}) → Future<void>
This function deletes an account using client authentication factor, identity provider, and optional authentication ID.
destroySession({required void onSuccess(), required void onError(SyneriseError error)}) → Future<void>
This function destroys a session asynchronously.
getAccount({required void onSuccess(ClientAccountInformation), required void onError(SyneriseError error)}) → Future<void>
This function returns a Future object containing the client account information.
getUUID() → Future<String>
This function returns a user's UUID string.
isSignedIn() → Future<bool>
This function returns a boolean value indicating whether the user is signed in or not.
isSignedInViaSimpleAuthentication() → Future<bool>
The function isSignedInViaSimpleAuthentication checks whether the user is signed in via simple authentication.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
refreshToken({required void onSuccess(), required void onError(SyneriseError error)}) → Future<void>
This function refreshes user token.
regenerateUUID() → Future<bool>
This function regenerates a UUID.
regenerateUUIDWithClientIdentifier(String clientIdentifier) → Future<bool>
The function regenerates a UUID using a client identifier.
registerAccount(ClientAccountRegisterContext clientAccountRegisterContext, {required void onSuccess(), required void onError(SyneriseError error)}) → Future<void>
This function registers a client account asynchronously using the provided context.
requestAccountActivation(String email, {required void onSuccess(), required void onError(SyneriseError error)}) → Future<void>
This function activates a user account using their email address.
requestAccountActivationByPin(String email, {required void onSuccess(), required void onError(SyneriseError error)}) → Future<void>
The function requestAccountActivationByPin sends a request to activate an account using a PIN code.
requestEmailChange(String email, String password, {String? externalToken, String? authID, required void onSuccess(), required void onError(SyneriseError error)}) → Future<void>
The function requestEmailChange sends a request to change the user's email address.
requestPasswordReset(String email, {required void onSuccess(), required void onError(SyneriseError error)}) → Future<void>
This function requests a password reset for a given email address.
requestPhoneUpdate(String phone, {required void onSuccess(), required void onError(SyneriseError error)}) → Future<void>
The function requestPhoneUpdate sends a request to update the phone number.
retrieveToken({required void onSuccess(Token), required void onError(SyneriseError error)}) → Future<void>
This function retrieves a token.
signIn(String email, String password, {required void onSuccess(), required void onError(SyneriseError error)}) → Future<void>
This function takes an email and password as parameters and signs in the user using those credentials.
signInConditionally(String email, String password, {required void onSuccess(ClientConditionalAuthResult), required void onError(SyneriseError error)}) → Future<void>
signInConditionally returns a 'ClientConditionalAuthResult' that represents the result of a conditional sign-in operation.
signOut() → Future<void>
This function signs the user out of the current session.
signOutWithMode(ClientSignOutMode mode, bool fromAllDevices, {required void onSuccess(), required void onError(SyneriseError error)}) → Future<void>
The function signOutWithMode signs out the client with the specified mode and from all devices if specified.
simpleAuthentication(ClientSimpleAuthenticationData clientSimpleAuthenticationData, String authID, {required void onSuccess(), required void onError(SyneriseError error)}) → Future<void>
This method signs in a customer with Simple Authentication.
toString() → String
A string representation of this object.
inherited
updateAccount(ClientAccountUpdateContext clientAccountUpdateContext, {required void onSuccess(), required void onError(SyneriseError error)}) → Future<void>
This function updates a client account using the provided context.
updateAccountBasicInformation(ClientAccountUpdateBasicInformationContext clientAccountUpdateBasicInformationContext, {required void onSuccess(), required void onError(SyneriseError error)}) → Future<void>
This function updates an anonymous client account using the provided object.

Operators

operator ==(Object other) → bool
The equality operator.
inherited