Response classes

GetAccountInformation class

Class providing 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	-	Client’s clientId
lastActivityDate	`Date`	no	-	Client’s last performed activity date
email	`String`	no	-	Client’s email
phone	`String`	no	-	Client’s phone
customId	`String`	no	-	Client’s customId
uuid	`String`	no	-	Client’s uuid
firstName	`String`	no	-	Client’s first name
lastName	`String`	no	-	Client’s last name
displayName	`String`	no	-	Client’s display name
company	`String`	no	-	Client’s company
address	`String`	no	-	Client’s address
city	`String`	no	-	Client’s city
province	`String`	no	-	Client’s province
zipCode	`String`	no	-	Client’s ZIP code
countryCode	`String`	no	-	Client’s country code
birthDate	`String`	no	-	Client’s birth date
sex	Sex	no	-	Client’s sex
avatarUrl	`String`	no	-	Client’s avatar URL
anonymous	`Boolean`	no	-	Defines if the user is anonymous
agreements	Agreements	no	-	Client’s agreements
attributes	Attributes	no	-	Client’s attributes
tags	`List<String>`	no	-	Client’s tags

Note: All of the properties above are accessible by using getters.

Initializers

There are no initializers.

Methods

There are only getters for the above properties.

Token class

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 of the properties above are accessible by using getters.

Initializers

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

Methods

Method that returns Token model from raw JWT.

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

AuthConditions class

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.

ClientEventData class

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	-	Event label parameter
client	`HashMap<String, Object>`	no	-	Clients

Note: All of the properties above are accessible by using getters and setters.

Initializers

There are no initializers.

Methods

Method that returns the email property from the client hashmap.

public String getClientEmail()

Method that returns the uuid property from the client hashmap.

public String getClientUuid()

Method that returns the clientId property from the client hashmap.

public int getClientId()

RecommendationResponse class

Class responsible for receiving recommendations.

Declared In

com.synerise.sdk.content.model.recommendation.RecommendationResponse

Declaration

public class RecommendationResponse

Properties

Property	Type	Optional	Default	Description
recommended	List<Recommendation>	no	-	List of recommendations
campaignHash	`String`	no	-	Campaign hash
campaignId	`String`	no	-	Campaign ID
schema	`String`	no	-	Recommendation’s schema
slug	`String`	no	-	Slug name
uuid	`String`	no	-	Recommendation’s UUID
name	`String`	no	-	Name of the recommendation
correlationId	`String`	no	-	Correlation ID

Note: All of the properties above are accessible by using getters.

Initializers

There are no initializers.

Methods

Get schema.

public String getSchema()

Get slug.

public String getSlug()

Get UUID.

public String getUuid()

Get recommendations.

public List<Recommendation> getRecommendations()

Get Campaign Hash.

public String getCampaignHash()

Get Campaign ID.

public String getCampaignId()

Recommendation class

Class model for recommendation.

Declared In

com.synerise.sdk.content.model.recommendation.Recommendation

Declaration

public class Recommendation extends BaseModel

Properties

Property	Type	Optional	Default	Description
feed	`HashMap<String, Object>`	no	-	Raw feed from recommendation
itemId	`String`	no	-	Unique ID of the item

Note: All of the properties above are accessible by using getters and setters.

Initializers

There are no initializers.

Methods

There are only getters and setters for the above properties.

RecommendationAttribute class

Class model for custom attributes.

Declared In

com.synerise.sdk.content.model.recommendation.RecommendationAtribute

Declaration

public class RecommendationAtribute

Properties

Property	Type	Optional	Default	Description
name	`String`	no	-	Attribute name
type	`String`	no	-	Attribute type
value	`String`	no	-	Attribute value

Note: All of the properties above are accessible by using getters and setters.

Initializers

There are no initializers.

Methods

There are only getters and setters for the above properties.

ContentWidgetRecommendationDataModel

Model for recommendations inside a content widget

Declared In

com.synerise.sdk.content.widgets.dataModel.ContentWidgetRecommendationDataModel

Declaration

public class ContentWidgetRecommendationDataModel

Properties

There are no properties.

Initializers

Constructor:

public ContentWidgetRecommendationDataModel(String name, String image, String price, String salePrice, String priceCurrency)

Note: priceCurrency should be in ISO format.

Methods

Get item name.

public String getName()

Get URL of the item’s image.

public String getImage()

Get item’s price.

public String getPrice()

Get item’s sale price.

public String getSalePrice()

Get currency of the price.

public String getPriceCurrency()

Get badge model.

public ContentWidgetBadgeDataModel getBadgeDataModel()

Get label.

public String getLabel()

Set badge model.

public void setBadgeDataModel(ContentWidgetBadgeDataModel badge)

Set label.

public void setLabel(String label)

PromotionResponse class

Class model for promotion response.

Declared In

com.synerise.sdk.promotions.model.promotion.PromotionResponse

Declaration

public class PromotionResponse

Properties

Property	Type	Optional	Default	Description
promotionMetadata	PromotionMetadata	no	-	Metadata
promotions	List<Promotion>	no	-	List of promotions

Note: All of the properties above are accessible by using getters.

Initializers

There are no initializers.

Methods

Get promotion metadata.

public PromotionMetadata getPromotionMetadata()

Get promotions.

public List<Promotion> getPromotions()

SinglePromotionResponse class

Class model for single promotion response.

Declared In

com.synerise.sdk.promotions.model.promotion.SinglePromotionResponse

Declaration

public class SinglePromotionResponse

Properties

Property	Type	Optional	Default	Description
promotion	Promotion	no	-	Promotion

Note: All of the properties above are accessible by using getters and setters.

Initializers

There are no initializers.

Methods

There are only getters and setters for the above properties.

Get promotion.

public Promotion getPromotion()

Set promotion.

public void setPromotion(Promotion data)

AssignVoucherResponse class

Class model of AssignVoucherResponse.

Declared In

com.synerise.sdk.promotions.model.AssignVoucherResponse

Declaration

public class AssignVoucherResponse

Properties

Property	Type	Optional	Default	Description
message	`String`	no	-	Message
data	AssignVoucherData	no	-	Voucher data

Note: All of the properties above are accessible by using getters.

Initializers

There are no initializers.

Methods

There are only getters for the above properties.

Get message.

public String getMessage()

Get data.

public AssignVoucherData getData()

VoucherCodesResponse class

Class model of VoucherCodesResponse.

Declared In

com.synerise.sdk.promotions.model.VoucherCodesResponse

Declaration

public class VoucherCodesResponse

Properties

Property	Type	Optional	Default	Description
data	List<VoucherCodesData>	no	-	Voucher data

Note: All of the properties above are accessible by using getters.

Initializers

There are no initializers.

Methods

There are only getters for the above properties.

Get Data.

public List<VoucherCodesData> getData()

PromotionMetadata class

Class model for promotion metadata.

Declared In

com.synerise.sdk.promotions.model.promotion.PromotionMetadata

Declaration

public class PromotionMetadata implements Serializable

Properties

Property	Type	Optional	Default	Description
totalCount	`int`	no	-	Total count of promotions
totalPages	`int`	no	-	Total count of pages
page	`int`	no	-	Page
limit	`int`	no	-	Limit of promotions per page
code	`int`	no	-	Code

Note: All of the properties above are accessible by using getters.

Initializers

There are no initializers.

Methods

Get total count.

public int getTotalCount()

Get total pages.

public int getTotalPages()

Get page.

public int getPage()

Get promotions limit.

public int getLimit()

Get code.

public int getCode()

Promotion class

Class model for promotion.

Declared In

com.synerise.sdk.promotions.model.promotion.Promotion

Declaration

public class Promotion extends BaseModel implements Serializable

Properties

Property	Type	Optional	Default	Description
uuid	`String`	no	-	Promotion UUID
code	`String`	no	-	Promotion code
status	`String`	no	-	Promotion status
type	`String`	no	-	Promotion type
redeemLimitPerClient	`int`	no	-	Redemption limit per client
redeemQuantityPerActivation	`int`	no	-	Redemption quantity per activation
currentRedeemedQuantity	`int`	no	-	Current redeemed quantity
currentRedeemLimit	`int`	no	-	Current redemption limit
activationCounter	`int`	no	-	Activation counter
discountType	`String`	no	-	Discount type
discountValue	`int`	no	-	Discount value
requireRedeemedPoints	`int`	no	-	Required redeemed points
name	`String`	no	-	Promotion name
headline	`String`	no	-	Promotion headline
description	`String`	no	-	Promotion description
images	List	no	-	List of promotion images
startAt	`Date`	no	-	Start time of a promotion
expireAt	`Date`	no	-	Expiration time of a promotion
lastingAt	`Date`	no	-	How long a promotion lasts
params	`HashMap<String, Object>`	no	-	Promotion custom parameters
catalogIndexItems	`List<String>`	no	-	List of item indexes
price	`long`	no	-	Item price
priority	`int`	no	-	Promotion priority

Note: All of the properties above are accessible by using getters.

Initializers

There are no initializers.

Methods

There are only getters for the above properties.

AssignVoucherData class

Class model of AssignVoucherData.

Declared In

com.synerise.sdk.promotions.model.AssignVoucherData

Declaration

public class AssignVoucherData

Properties

Property	Type	Optional	Default	Description
code	`String`	no	-	Code
expireIn	`Date`	no	-	Date of expiration
redeemAt	`Date`	no	-	Redemption at date
assignedAt	`Date`	no	-	Date of assigning voucher
createdAt	`Date`	no	-	Date of creation
updatedAt	`Date`	no	-	Date of voucher update

Note: All of the properties above are accessible by using getters.

Initializers

There are no initializers.

Methods

There are only getters for the above properties.

Get Code.

public String getCode()

Get ExpireIn.

public Date getExpireIn()

Get RedeemAt.

public Date getRedeemAt()

Get AssignedAt.

public Date getAssignedAt()

Get CreatedAt.

public Date getCreatedAt()

Get UpdateAt.

public Date getUpdatedAt()

VoucherCodesData class

Class model of VoucherCodesData.

Declared In

com.synerise.sdk.promotions.model.VoucherCodesData

Declaration

public class VoucherCodesData

Properties

Property	Type	Optional	Default	Description
code	`String`	no	-	Voucher code
status	`String`	no	-	Voucher status
clientUuid	`String`	no	-	Client UUID
poolUuid	`String`	no	-	Pool UUID
expireIn	`Date`	no	-	Voucher expiration date
assignedAt	`Date`	no	-	Voucher assignment date
createdAt	`Date`	no	-	Voucher creation date
updatedAt	`Date`	no	-	Voucher update date

Note: All of the properties above are accessible by using getters.

Initializers

There are no initializers.

Methods

There are only getters for the above properties.

SynerisePushResponse class

Class model for SynerisePushResponse.

Declared In

com.synerise.sdk.injector.net.model.push.notification.SynerisePushResponse

Declaration

public class SynerisePushResponse

Properties

Property	Type	Optional	Default	Description
contentAvailable	`boolean`	no	-	Informs if content is available
data	`SynerisePush`	no	-	Synerise push data
notification	SimpleNotification	no	-	Synerise simple notification

Note: All of the properties above are accessible by using getters.

Initializers

There are no initializers.

Methods

Check if content is available.

public boolean isContentAvailable()

Get data.

public SyneriseData getData()

Get notification.

public SimpleNotification getNotification()

Check if the push is a simple push.

public boolean isSimplePush()

TemplateBanner class

Class model for banners.

Declared In

com.synerise.sdk.injector.net.model.push.banner.TemplateBanner

Declaration

public class TemplateBanner extends BasePageMapper implements Parcelable, Validable

Properties

Property	Type	Optional	Default	Description
campaign	Campaign	no	-	Campaign class
trigger	`String`	yes	-	Banner trigger
notification	SimpleNotification	no	-	Notification class
autoDisappear	AutoDisappear	no	-	Auto disappear
page	`NetGenericPageData`	yes	-	Page data

Note: All of the properties above are accessible by using getters.

Initializers

There are no initializers.

Methods

Get campaign.

public Campaign getCampaign()

Get value.

public Object getValue()

Check if banner has a trigger.

public boolean hasTrigger()

Get trigger from banner.

public String getTrigger()

Get notification.

public SimpleNotification getNotification()

Get page.

public PageItem getPage()

Get auto disappear.

public AutoDisappear getAutoDisappear()

SilentCommand class

Class model for silent command.

Declared In

com.synerise.sdk.injector.SilentCommand

Declaration

public class SilentCommand implements Validable

Properties

Property	Type	Optional	Default	Description
className	`String`	no	-	Class name
methodName	`String`	no	-	Method name
methodParameterList	List<MethodParameter>	no	-	Method parameters

Note: All of the properties above are accessible by using getters.

Initializers

There are no initializers.

Methods

Get class name.

public String getClassName()

Get method name.

public String getMethodName()

Get method parameters.

public List<MethodParameter> getMethodParameterList()

MethodParameter class

Class model for method parameter.

Declared In

com.synerise.sdk.injector.MethodParameter

Declaration

public class MethodParameter implements Validable

Properties

Property	Type	Optional	Default	Description
className	`String`	no	-	Class name
value	`Object`	no	-	Parameter value
position	`int`	no	-	Parameter position

Note: All of the properties above are accessible by using getters.

Initializers

There are no initializers.

Methods

Get class name.

public String getClassName()

Get value.

public Object getValue()

Get parameter position.

public int getPosition()

SimpleNotification class

Class model for simple notification.

Declared In

com.synerise.sdk.injector.net.model.push.notification.SimpleNotification

Declaration

public class SimpleNotification implements Serializable

Properties

Property	Type	Optional	Default	Description
title	`String`	no	-	Notification title
body	`String`	no	-	Notification body

Note: All of the properties above are accessible by using getters.

Initializers

There are no initializers.

Methods

Check if notification has a title.

public boolean hasTitle()

Get notification title.

public String getTitle()

Check if notification has a body.

public boolean hasBody()

Get notification body.

public String getBody()

Campaign class

Class model for campaigns.

Declared In

com.synerise.sdk.injector.net.model.Campaign

Declaration

public class Campaign implements Serializable

Properties

Property	Type	Optional	Default	Description
hashId	`String`	no	-	Campaign hash ID
variantId	`int`	no	-	Campaign variant’s ID
title	`String`	no	-	Campaign title
type	`String`	no	-	Campaign type

Note: All of the properties above are accessible by using getters.

Initializers

There are no initializers.

Methods

Get hashId.

public String getHashId()

Get variantId.

public int getVariantId()

Get title.

public String getTitle()

Get type.

public String getType()

AutoDisappear class

Class model for AutoDisappear.

Declared In

com.synerise.sdk.injector.net.model.push.model.banner.AutoDisappear

Declaration

public class AutoDisappear implements Serializable

Properties

Property	Type	Optional	Default	Description
isEnabled	`boolean`	no	-	Informs if auto disappear is enabled
timeout	`int`	no	-	Disappear timeout

Note: All of the properties above are accessible by using getters.

Initializers

There are no initializers.

Methods

Check if auto disappear is enabled.

public boolean isEnabled()

Get auto disappear timeout.

public int getTimeout()

Tracker settings class

Class model for tracker settings.

Declared In

com.synerise.sdk.core.settings.TrackerSettings

Declaration

public class TrackerSettings

Properties

Property	Type	Optional	Default	Description
autoTracking	`TrackerAutoTrackingSettings`	no	-	AutoTracking settings class
isBackendTimeSyncRequired	`boolean`	no	true	This parameter specifies if time sync is required to send event’s or not.
tracking	`TrackerDeclarativeTrackingSettings`	no	-	Declarative tracking settings class
locationAutomatic	`boolean`	no	false	Informs whether to show walkthrough automatically or not
minBatchSize	`int`	no	10	Minimum number of events in one batch
maxBatchSize	`int`	no	100	Maximum number of events in one batch
autoFlushTimeout	`int`	no	5000	Time to send batch in ms

Initializers

There are no initializers.

Methods

Set minimum batch size.

public void setMinimumBatchSize(int size)

Set maximum batch size.

public void setMinimumBatchSize(int size)

Set auto flush timeout.

public void setAutoFlushTimeout(int time)

General settings class

Class model for general SDK settings.

Declared In

com.synerise.sdk.core.settings.GeneralSettings

Declaration

public class GeneralSettings

Properties

Property	Type	Optional	Default	Description
enabled	`boolean`	no	true	Indicates if SDK is enabled
shouldDestroySessionOnApiKeyChange	`boolean`	no	true	Indicates if a session should be destroyed after changing apiKey
minTokenRefreshInterval	`int`	no	60 * 30	Track mode

Initializers

There are no initializers.

Methods

This method sets time interval counting backwards from expirationTime, within which token will be automatically refreshed by the SDK.

public void setMinTokenRefreshInterval(int time)

Get minimum token refresh interval.

public int getMinTokenRefreshInterval()

General settings class

Class model for general SDK settings.

Declared In

com.synerise.sdk.core.settings.GeneralSettings

Declaration

public class GeneralSettings

Properties

Property	Type	Optional	Default	Description
enabled	`boolean`	no	true	Indicates if SDK is enabled
shouldDestroySessionOnApiKeyChange	`boolean`	no	true	Indicates if a session should be destroyed after changing apiKey
minTokenRefreshInterval	`int`	no	60 * 30	Track mode

Initializers

There are no initializers.

Methods

This method sets time interval counting backwards from expirationTime, within which token will be automatically refreshed by the SDK.

public void setMinTokenRefreshInterval(int time)

Get minimum token refresh interval.

public int getMinTokenRefreshInterval()

Notifications settings class

Class model for notification settings.

Declared In

com.synerise.sdk.core.settings.NotificationSettings

Declaration

public class NotificationSettings

Properties

Property	Type	Optional	Default	Description
enabled	`boolean`	no	true	Indicates if notifications are enabled
encryption	`boolean`	no	false	Indicates if a session should be destroyed after changing the apiKey

Initializers

There are no initializers.

Methods

Set notification encryption.

public void setEncryption(boolean enabled)

Get notification encryption status.

public boolean getEncryption()

Injector settings class

Class model for injector settings.

Declared In

com.synerise.sdk.core.settings.InjectorSettings

Declaration

public class InjectorSettings

Properties

Property	Type	Optional	Default	Description
automatic	`boolean`	no	false	Indicates if the injector should show a walkthrough automatically

Initializers

There are no initializers.

Methods

There are no methods.

Synerise Builder

Synerise builder class.

Declared In

com.synerise.sdk.core.Synerise.Builder

Declaration

public static class Builder

Properties

Property	Type	Optional	Default	Description
app	`Application`	no	-	Application context
clientApiKey	`String`	no	-	Client apiKey. Can be retrieved from app.synerise.com
applicationId	`String`	no	-	Application ID
baseUrl	`String`	no	-	Base URL in the SDK. Can be null
syneriseDebugMode	`boolean`	no	-	Debug mode flag
notificationIcon	`int`	no	R.drawable.synerise_ic_default_icon	Notification icon
notificationIconColor	`int`	no	R.color.syneriseGrayTranslucent	Notification color
channelDefaultName	`String`	no	-	Notification channel default name
channelDefaultId	`String`	no	-	Notification channel default ID
channelHighPriorityName	`String`	no	-	High priority notification channel name
channelHighPriorityId	`String`	no	-	High priority notification channel ID
pushListener	`OnRegisterForPushListener`	no	-	Push listener
locationListener	`OnLocationUpdateListener`	no	-	Location listener
crashHandlingEnabled	`boolean`	no	-	Crash handling flag

Initializers

Start initializing Synerise SDK with this method.
To get the Business API Key and Client API Key, sign in to your Synerise account and visit https://app.synerise.com/spa/modules/settings/apikeys/list.
Then, copy or generate a new API Key for the Business Profile and API Key for Clients.

public static Builder with(Application app, String clientApiKey, String appId)

Use this method to finish the initialization process.

public void build()

Methods

This method sets the icon that will be used as the small icon in notifications.
Must be a drawable resource (not a mipmap) due to Android Oreo adaptive icons restrictions.

public Builder notificationIcon(@DrawableRes int notificationIcon)

This method sets the notification icon and text color.
notificationIconColor must be in ARGB format.

public Builder notificationIconColor(int notificationIconColor)

This method enables/disables logcat logs from Synerise SDK.
It is not recommended to use debug mode in the release version of your application.

public Builder syneriseDebugMode(boolean syneriseDebugMode)

This method passes info about Users application crashes as dedicated events to the backend.
It is recommended to use SyneriseCrashHandling.

public Builder crashHandlingEnabled(boolean exceptionHandlerEnabled)

It is important to register your customers for push messages, so Synerise SDK may ask you to register a client for push notifications.
This callback is called after the client signs in, signs up, or deletes the account.

public Builder pushRegistrationRequired(@NonNull OnRegisterForPushListener listener)

This callback is called on demand by push notification, so it may be called at any time.
Check out the sample application for example usage and remember to send.

public Builder locationUpdateRequired(@NonNull OnLocationUpdateListener listener)

You can provide your custom base URL to use your own API.
For example, Synerise base URL is https://api.snrapi.com/

public Builder baseUrl(String baseUrl)

You can provide your notification channel name.
By default, the channel name is set to your application name.

public Builder notificationDefaultChannelName(@NonNull String name)

You can provide your notification channel ID.

public Builder notificationDefaultChannelId(@NonNull String channelId)

You can provide your High Priority notification channel name.
From default, channel name is set to <your application name> High Priority

public Builder notificationHighPriorityChannelName(@NonNull String name)

You can provide your High Priority notification channel ID.

public Builder notificationHighPriorityChannelId(@NonNull String channelId)

Audience

Audience model.

Declared In

com.synerise.sdk.content.model.Audience

Declaration

public class Audience

Properties

Property	Type	Optional	Default	Description
ids	`List<String>`	no	-	List of IDs
query	`String`	no	-	Query

Note: All of the properties above are accessible by using getters.

Methods

There are getters and setters for the above properties.

ScreenViewResponse

Class responsible for receiving recommendations.

Declared In

com.synerise.sdk.content.model.ScreenViewResponse

Declaration

public class ScreenViewResponse

Properties

Property	Type	Optional	Default	Description
audience	Audience	no	-	Audience of a screenView
createdAt	`String`	no	-	Creation time of a screenView
data	`Object`	no	-	Content of a screenView
id	`String`	no	-	ScreenView ID
hash	`String`	no	-	ScreenView hash
name	`String`	no	-	ScreenView name
parentVersion	`String`	no	-	ScreenView parent version
path	`String`	no	-	ScreenView path
priority	`Integer`	no	-	ScreenView priority
updatedAt	`String`	no	-	ScreenView update time
version	`String`	no	-	ScreenView version

Note: All of the properties above are accessible by using getters.

Initializers

There are no initializers.

Methods

Getters and setters for the above properties.

TrackMode enum

This enum contains the values which set a mode for tracking component interactions from the android.widget package.

Declared In

com.synerise.sdk.core.types.enums.TrackMode

Declaration

public enum TrackMode

Values

Property	Description
PLAIN	Tracks screen-visits. Events are sent when onStart of activities/Fragments is called.
FINE	Tracks screen-visits and onClick events from components such as Buttons, ImageButtons, RatingBars

Methods

There are no methods.

ClientSessionEndReason enum

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 user signing out.
SYSTEM_SIGN_OUT	Session ended due to remote sign out by system.
SESSION_DESTROYED	Session ended due to `Client.destroySession` method.
CLIENT_REJECTED	Session ended due to 401 or 410 response.
USER_ACCOUNT_DELETED	Session ended due to Client account deletion.

Methods

There are no methods.

ApiQuerySortingOrder enum

This enum contains values for query sorting order.

Declared In

com.synerise.sdk.core.types.enums.ApiQuerySortingOrder

Declaration

public enum ApiQuerySortingOrder

Values

Property	Value	Description
ASCENDING	“asc”	Sorting order
DESCENDING	“desc”	Sorting order

Methods

Get order.

public String getOrder()

Get order.

public static ApiQuerySortingOrder getBySortingOrder(String order)

TokenRLM enum

This enum contains values for token realm.

Declared In

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

Declaration

public enum TokenRLM

Values

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

Methods

Get rlm.

public String getRlm()

Get rlm.

public static TokenRLM getRlm(String rlm)

TokenOrigin enum

This enum contains values for 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

Get origin.

public String getOrigin()

Get origin.

public static TokenOrigin getOrigin(String rlm)

Sex enum

This enum contains values for sex.

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

Get sex.

public String getSex()

Get sex.

public static Sex getSex(String name)

VoucherCodesStatus enum

This enum contains values for voucher code status.

Declared In

com.synerise.sdk.client.model.client.VoucherCodeStatus

Declaration

public enum VoucherCodeStatus

Values

Property	Value	Description
ASSIGNED	“ASSIGNED”	Assigned
UNASSIGNED	“UNASSIGNED”	Unassigned
REDEEMED	“REDEEMED”	Redeemed
CANCELED	“CANCELED”	Canceled

Methods

Get status.

public String getStatus()

Get status.

public static VoucherCodeStatus getStatus(String status)

DocumentApiQueryType enum

This enum contains values for the Documents API query type.

Declared In

com.synerise.sdk.content.model.DocumentsApiQueryType

Declaration

public enum DocumentsApiQueryType

Values

Property	Value	Description
SCHEMA	“by-schema”	Query type

Methods

Get by path type.

public static DocumentsApiQueryType getByPathType(String type)

PromotionStatus enum

This enum contains values for promotion status.

Declared In

com.synerise.sdk.promotions.model.promotion.PromotionStatus

Declaration

public enum PromotionStatus

Values

Property	Value	Description
ASSIGNED	“ASSIGNED”	Promotion status
ACTIVE	“ACTIVE”	Promotion status
REDEEMED	“REDEEMED”	Promotion status
UNKNOWN	“UNKNOWN”	Promotion status

Methods

Get promotion status.

public static PromotionStatus getByPromotionStatus(String status)

PromotionType enum

This enum contains values for promotion type.

Declared In

com.synerise.sdk.promotions.model.promotion.PromotionType

Declaration

public enum PromotionType

Values

Property	Value	Description
GENERAL	“GENERAL”	Promotion type
CUSTOM	“CUSTOM”	Promotion type
MEMBERS_ONLY	“MEMBERS_ONLY”	Promotion type
UNKNOWN	“UNKNOWN”	Promotion type

Methods

Get promotion type.

public static PromotionType getByPromotionType(String type)

ClientIdentityProvider enum

This enum contains values which set the provider for deleting a client.

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 provider.

public static ClientIdentityProvider getByProvider(String provider)

ConditionalAuthenticationStatus enum

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.

ClientSignOutMode enum

This enum contains values for 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.