public class PushNotificationParam extends Object implements Serializable
setPushNotificationMessage(String)
NOTE: The maximum payload data size for iOS 7 or older must not exceed 256 bytes.
For iOS 8 and later the maximum size is 2048 bytes. Please consider that the push notification payload does not consist
only of the "pushNotificationPayload" that you can set here, but the message itself is also part of the payload.Constructor and Description |
---|
PushNotificationParam() |
Modifier and Type | Method and Description |
---|---|
List<String> |
getAppName() |
int |
getDeviceId() |
String |
getPushNotificationMessage() |
List<com.kobil.ssms.asm.logic.template.SimpleEntryItem> |
getPushNotificationPayload() |
List<com.kobil.ssms.asm.logic.template.SimpleEntryItem> |
getTemplateVariables() |
String |
getUserId() |
boolean |
isHighPriority() |
void |
setAppName(List<String> appName)
This is an optional value.
|
void |
setDeviceId(int deviceId)
This is a required value.
|
void |
setHighPriority(boolean highPriority)
This is an optional value.
|
void |
setPushNotificationMessage(String pushNotificationMessage)
This is an optional value.
|
void |
setPushNotificationPayload(List<com.kobil.ssms.asm.logic.template.SimpleEntryItem> pushNotificationPayload)
This is an optional value.
|
void |
setTemplateVariables(List<com.kobil.ssms.asm.logic.template.SimpleEntryItem> templateVariables)
This is an optional value.
|
void |
setUserId(String userId)
This is an optional value if a device Id is set.
|
String |
toString() |
public String getUserId()
public void setUserId(String userId)
userId
- The SSMS user Id.public int getDeviceId()
public void setDeviceId(int deviceId)
deviceId
- The device Id.public List<com.kobil.ssms.asm.logic.template.SimpleEntryItem> getPushNotificationPayload()
public void setPushNotificationPayload(List<com.kobil.ssms.asm.logic.template.SimpleEntryItem> pushNotificationPayload)
setPushNotificationPayload(List)
or setPushNotificationMessage(String)
. setPushNotificationPayload(List)
and setPushNotificationMessage(String)
setPushNotificationMessage(String)
has priority and
the message contained in setPushNotificationPayload(List)
will be ignored.pushNotificationPayload
- A List
of SimpleEntryItem
holding detailed informations for the device (For example: A message).public String getPushNotificationMessage()
public void setPushNotificationMessage(String pushNotificationMessage)
setPushNotificationPayload(List)
or setPushNotificationMessage(String)
. setPushNotificationPayload(List)
and setPushNotificationMessage(String)
setPushNotificationMessage(String)
has priority and
setPushNotificationPayload(List)
will be ignored.pushNotificationMessage
- This message is using the SSMS template mechanism. If this message is equal to a key of an existing SSMS text resource,
the text resource will be the push notification message and the variables must be set with
setTemplateVariables(List)t
.public List<com.kobil.ssms.asm.logic.template.SimpleEntryItem> getTemplateVariables()
public void setTemplateVariables(List<com.kobil.ssms.asm.logic.template.SimpleEntryItem> templateVariables)
setPushNotificationMessage(String)
is null.templateVariables
- This List
of SimpleEntryItem
holding variables which will be replaced in
setPushNotificationMessage(String)
.public boolean isHighPriority()
public void setHighPriority(boolean highPriority)
false
. highPriority
- True
means, the priority of the regarding message will be set to HIGH. False
means, the priority of the regarding message will be set to NORMAL.Copyright © 2022 KOBIL Systems GmbH. All rights reserved.