Client

ClientIdentityProvider

This enum contains values which set the provider for deleting a profile (a profile itself and their account).

Declared In

com.synerise.sdk.client.model.ClientIdentityProvider

Declaration

public enum ClientIdentityProvider

Values

Property Value Description
FACEBOOK “FACEBOOK” Facebook provider
GOOGLE “GOOGLE” Google provider
OAUTH “OAUTH” Oauth provider
SYNERISE “SYNERISE” Synerise provider

Methods

Get a provider.

public static ClientIdentityProvider getByProvider(String provider)



AuthConditions

Auth conditions model. Model passes status and conditions.

Declared In

com.synerise.sdk.client.model

Declaration

public class AuthConditions

Properties

Property Type Optional Default Description
status ConditionalAuthenticationStatus no - Status of authentication
conditions ArrayList<Object> no - List of conditions
Note: All of the properties above are accessible by using getters.

Methods

There are getters and setters for the above properties.




ConditionalAuthenticationStatus

This enum contains values which describe the status of an after a log-in attempt.

Declared In

com.synerise.sdk.client.model.ConditionalAuthenticationStatus

Declaration

public enum ConditionalAuthenticationStatus

Values

Property Description
SUCCESS Authentication successful
UNAUTHORIZED Currently unused
ACTIVATION_REQUIRED Currently unused
REGISTRATION_REQUIRED Currently unused
APPROVAL_REQUIRED Currently unused
TERMS_ACCEPTANCE_REQUIRED Currently unused
MFA_REQUIRED Currently unused

Methods

There are no methods.



ClientSessionEndReason

This enum contains values which describe the reason for sending a session.

Declared In

com.synerise.sdk.core.types.enums.ClientSessionEndReason

Declaration

public enum ClientSessionEndReason

Values

Property Description
SESSION_EXPIRATION Session ended due to token expiration.
SECURITY_EXCEPTION Session ended due to security errors.
USER_SIGN_OUT Session ended due to a profile sign-out.
SYSTEM_SIGN_OUT Session ended due to a remote sign out by the system.
SESSION_DESTROYED Session ended due to the Client.destroySession method.
CLIENT_REJECTED Session ended due to 401 or 410 response.
USER_ACCOUNT_DELETED Session ended due to profile account deletion.

Methods

There are no methods.



ClientSignOutMode

This enum contains values for the sign out mode.

Declared In

com.synerise.sdk.core.types.enums

Declaration

public enum ClientSignOutMode

Values

Property Value Description
SIGN_OUT “LOGOUT” Sign out with a backend call. The token is invalidated and cleared in the SDK, but the UUID remains the same.
SIGN_OUT_WITH_SESSION_DESTROY “LOGOUT_WITH_SESSION_DESTROY” Sign out with a backend call. The token is invalidated. The token and UUID are cleared in the SDK.

Methods

No methods.




GetAccountInformation

Class providing a profile account information.

Declared In

com.synerise.sdk.client.model.GetAccountInformation

Declaration

public final class GetAccountInformation extends AccountInformation implements Serializable

Properties

Property Type Optional Default Description
clientId long no - A unique ID of a profile
lastActivityDate Date no - Profile’s last performed activity date
email String no - Profile’s email
phone String no - Profile’s phone
customId String no - Profile’s customId
uuid String no - Profile’s UUID
firstName String no - Profile’s first name
lastName String no - Profile’s last name
displayName String no - Profile’s display name
company String no - Profile’s company
address String no - Profile’s address
city String no - Profile’s city
province String no - Profile’s province
zipCode String no - Profile’s ZIP code
countryCode String no - Profile’s country code
birthDate String no - Profile’s birth date
sex Sex no - Profile’s sex
avatarUrl String no - Profile’s avatar URL
anonymous Boolean no - Defines if the profile is anonymous
agreements Agreements no - Profile’s agreements
attributes Attributes no - Profile’s attributes
tags List<String> no - Profile’s tags
Note: All properties above are accessible by using getters.

Initializers

There are no initializers.

Methods

There are only getters for the above properties.




UpdateAccountInformation

Class providing data to update account information.

Declared In

com.synerise.sdk.client.model.UpdateAccountInformation

Declaration

public final class UpdateAccountInformation extends AccountInformation

Properties

Property Type Optional Default Description
email String no - Profile’s email
phoneNumber String no - Profile’s phone
customId String no - Profile’s customId
uuid String no - Profile’s uuid
firstName String no - Profile’s first name
lastName String no - Profile’s last name
displayName String no - Profile’s display name
company String no - Profile’s company
address String no - Profile’s address
city String no - Profile’s city
province String no - Profile’s province
zipCode String no - Profile’s ZIP code
countryCode String no - Profile’s country code
birthDate String no - Profile’s birth date
sex Sex no - Profile’s sex
avatarUrl String no - Profile’s avatar URL
anonymous Boolean no - Defines if the profile is anonymous
agreements Agreements no - Profile’s agreements
attributes Attributes no - Profile’s attributes
Note: All properties above are accessible by using setters.

Initializers

There are no initializers.

Methods

There are only setters for above properties.




RegisterClient

Class responsible for registering a profile.

Declared In

com.synerise.sdk.client.model.client.RegisterClient

Declaration

public class RegisterClient extends BaseClient

Properties

Property Type Optional Default Description
agreements Agreements no - Profile’s agreements
attributes Attributes no - Profile’s attributes
city String yes - Profile’s city
company String yes - Profile’s company
countryCode String yes - Profile’s country code
customId String yes - Profile’s customId
firstName String yes - Profile’s first name
lastName String yes - Profile’s last name
phoneNumber String yes - Profile’s phone number
province String yes - Profile’s province
sex Sex yes - Profile’s sex
zipCode String yes - Profile’s ZIP code
uuid String yes - Profile’s UUID
email String yes - Profile’s email
password String yes - Profile’s password

Initializers

There are no initializers.

Methods

All properties have their own setters.




PasswordResetRequest

Class responsible for creating a payload for password reset request.

Declared In

com.synerise.sdk.client.model.password.PasswordResetRequest

Declaration

public final class PasswordResetRequest

Properties

Property Type Optional Default Description
email String yes - Profile’s email

Initializers

There is a constructor.

public PasswordResetRequest(@NonNull String email)

Methods

There are no methods.




PasswordResetConfirmation

Class responsible for creating a payload for password reset confirmation.

Declared In

com.synerise.sdk.client.model.password.PasswordResetConfirmation

Declaration

public final class PasswordResetConfirmation

Properties

Property Type Optional Default Description
password String no - Profile’s password
token String no - Profile’s token

Initializers

There is a constructor.

public PasswordResetConfirmation(@NonNull String password, @NonNull String token)

Methods

There are no methods.




Sex

This enum contains values for the sex parameter.

Declared In

com.synerise.sdk.core.types.enums.Sex

Declaration

public enum Sex

Values

Property Value Description
FEMALE “FEMALE” Female
MALE “MALE” Male
OTHER “OTHER” Other
NA “NOT_SPECIFIED” Not specified

Methods

This method retrieves the value of the sex parameter.

public String getSex()

This method retrieves the value of the sex parameter.

public static Sex getSex(String name)



Agreements

Class responsible for passing agreements.

Declared In

com.synerise.sdk.client.model.client.Agreements

Declaration

public class Agreements

Properties

Property Type Optional Default Description
email Boolean yes - Email agreement
sms Boolean yes - SMS agreement
push Boolean yes - Push agreement
bluetooth Boolean yes - Bluetooth agreement
rfid Boolean yes - RFID agreement
wifi Boolean yes - WiFi agreement

Initializers

There are no initializers.

Methods

All properties have their own setters and getters.




Attributes

Class responsible for passing attributes.

Declared In

com.synerise.sdk.client.model.client.Attributes

Declaration

public class Attributes

Properties

Property Type Optional Default Description
properties HashMap<String, String> yes - A key-value pair of profile’s attributes

Initializers

There are no initializers.

Methods

This method adds attributes.

public Attributes add(String key, String value)


This method retrieves a value of an attribute.

public HashMap<String, String> getProperties()




ClientEventData

Event data model.

Declared In

com.synerise.sdk.client.model.events.ClientEventData

Declaration

public class ClientEventData

Properties

Property Type Optional Default Description
time String no - Event time
action String no - Event action
label String no - This value is currently unused
client HashMap<String, Object> no - Profiles
Note: All properties above are accessible by using getters and setters.

Initializers

There are no initializers.

Methods

This method returns the value of the email attribute from the profile hashmap.

public String getClientEmail()

This method returns the uuid attribute from the profile hashmap.

public String getClientUuid()

This method returns the clientId attribute from the profile hashmap.

public int getClientId()



ClientEventQuery

Class responsible for creating a query to get events.

Declared In

com.synerise.sdk.client.model.client.ClientEventsQuery

Declaration

public class ClientEventsQuery

Properties

Property Type Optional Default Description
actions List<String> yes - Event action
timeFrom Date yes - Event time
label String yes - This value is currently unused
limit int yes 1000 Event limit
Note: All properties above are accessible by using setters.

Initializers

There are no initializers.

Methods

There are no methods.




Token

Token model.

Declared In

com.synerise.sdk.core.types.model.Token

Declaration

public class Token

Properties

Property Type Optional Default Description
rawJwt String no - Raw JWT token string
expirationUnixTime long no - Parsed expiration time in UNIX format
signKey String no - Encrypted signing key
tokenRLM TokenRLM no - Token scope
tokenOrigin TokenOrigin no - Token source origin
customId String no - Token customId
Note: All properties above are accessible by using getters.

Initializers

public static Token createToken(String signKey, String rawJwt, long expirationUnixTime, String rlm, String origin)

Methods

This method returns Token model from a raw JWT.

public static Token decodeFromJWT(String rawJwt, String signKey) throws Exception



TokenOrigin

This enum contains values for a token origin.

Declared In

com.synerise.sdk.core.types.model.Token.TokenOrigin

Declaration

public enum TokenOrigin

Values

Property Value Description
SYNERISE “SYNERISE” Token comes from Synerise
FACEBOOK “FACEBOOK” Token comes from Facebook
OAUTH “OAUTH” Token comes from OAuth
UNKNOWN “UNKNOWN” Unknown token source

Methods

This method retrieves the value of the origin parameter.

public String getOrigin()

This method retrieves the value of the origin parameter.

public static TokenOrigin getOrigin(String rlm)



TokenRLM

This enum contains values for a token realm.

Declared In

com.synerise.sdk.core.types.model.Token.TokenRLM

Declaration

public enum TokenRLM

Values

Property Value Description
ANONYMOUS “anonymous_client” Anonymous profile
CLIENT “client” Recognized profile

Methods

This method retrieves the value of the rlm parameter.

public String getRlm()

This method retrieves the value of the rlm parameter.

public static TokenRLM getRlm(String rlm)

😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

Close modal icon Placeholder alt for modal to satisfy link checker