Campaigns

InjectorSource

This enum contains values which describe the source of campaign.

Declared In:
com.synerise.sdk.core.types.enums.InjectorSource

Declaration:

public enum InjectorSource

Values:

Property Description
SIMPLE_PUSH Simple push campaign
BANNER Banner campaign
WALKTHROUGH Walkthrough campaign
IN_APP_MESSAGE In-app message campaign


Campaign

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

Initializers:

There are no initializers.

Methods:

This method retrieves a value for the hashId parameter.

public String getHashId()

This method retrieves a value for the variantId parameter.

public int getVariantId()

This method retrieves a value for the title parameter.

public String getTitle()

This method retrieves a value for the type parameter.

public String getType()



SynerisePushResponse

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

Initializers:

There are no initializers.

Methods:

This method checks if content is available.

public boolean isContentAvailable()

This method retrieves a value for the data parameter.

public SyneriseData getData()

This method retrieves a value for the notification parameter.

public SimpleNotification getNotification()

This method checks if the push is a simple push.

public boolean isSimplePush()



SimpleNotification

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

Initializers:

There are no initializers.

Methods:

This method checks if the notification has a title.

public boolean hasTitle()

This method retrieves a value for the title parameter (notification title).

public String getTitle()

This method checks if the notification has a body.

public boolean hasBody()

This method retrieves a value for the body parameter (notification body).

public String getBody()



NotificationInfo

This enum contains values for a voucher code status.

Declared In:
com.synerise.sdk.injector.callback.model

Declaration:

public class NotificationInfo

Values

Property Type Optional Default Description
campaignHashId String no - Identifier of the notification campaign.
campaignTitle String no - Identifier of the notification title.
payload HashMap<String, String> no - Payload of the notification.

Methods:

This method retrieves the value of the campaignHashId parameter.

public String getCampaignHashId()

This method defines the value of the campaignHashId parameter.

public void setCampaignHashId(String campaignHashId)

This method retrieves the value of the CampaignTitle parameter.

public String getCampaignTitle()

This method defines the value of the CampaignTitle parameter.

public void setCampaignTitle(String campaignTitle)

This method retrieves the contents of the payload parameter.

public HashMap<String, String> getPayload()

This method defines the contents of the payload parameter.

public void setPayload(HashMap<String, String> payload)



PushRegistrationOrigin

This enum contains values for the origin parameter of push registration listener methods.

Declared In:
com.synerise.sdk.core.types.enums

Declaration:

public enum PushRegistrationOrigin

Values:

Property Value Description
APP_STARTED “APP_STARTED” After a client.applicationStarted event is sent.
CLIENT_CONTEXT_CHANGE “CLIENT_CONTEXT_CHANGE” After the client context changes.
PERIODIC_JOB “PERIODIC_JOB” After a periodic job of a background task starts.
SECURITY_REASON “SECURITY_REASON” After a security threat

Methods:
There are no methods.




TemplateBanner

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

Initializers:

There are no initializers.

Methods:

This method retrieves the value of the campaign parameter.

public Campaign getCampaign()

This method retrieves the value of the value object.

public Object getValue()

This method checks if a banner has a trigger.

public boolean hasTrigger()

This method retrieves the trigger parameter from a banner.

public String getTrigger()

This method retrieves the value of the notification parameter.

public SimpleNotification getNotification()

This method retrieves the value of the page parameter.

public PageItem getPage()

This method retrieves the value of the autodisappear parameter.

public AutoDisappear getAutoDisappear()



SilentCommand

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

Initializers:

There are no initializers.

Methods:

This method retrieves a value of the className parameter.

public String getClassName()

This method retrieves a value of the methodName parameter.

public String getMethodName()

This method retrieves a list of values of the methodParameters parameter.

public List<MethodParameter> getMethodParameterList()



MethodParameter

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

Initializers:

There are no initializers.

Methods:

This method retrieves a value of the className parameter.

public String getClassName()

This method retrieves a value of the value parameter.

public Object getValue()

This method retrieves a value of the position parameter.

public int getPosition()



AutoDisappear

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

Initializers:

There are no initializers.

Methods:

This method checks if auto disappear is enabled.

public boolean isEnabled()

This method retrieves the value of the timeout parameter.

public int getTimeout()



InAppMessageData

Model for in-app messaging communication.

Declared In:
com.synerise.sdk.injector.inapp.InAppMessageData

Declaration:

public InAppMessageData(String campaignHash, String variantId, HashMap<String, Object> additionalParameters, Boolean isTest)

Properties:

Property Type Optional Default Description
campaignHash String no Identifier of the in-app message campaign.
variantId String no Identifier of the in-app message campaign variant.
additionalParameters HashMap<String, Object> yes Parameters additionally provided by the campaign.
url URL yes URL value from the action of the activity.
deeplink String yes Deep link value from the action of the activity.
isTest Bool no Specifies if the object is from a test campaign.
Note: All the properties above are accessible by using getters.

Methods:
There are only getters for the above properties.

😕

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