com.netease.nimlib.sdk.msg.model

Class CustomNotification

java.lang.Object

com.netease.nimlib.sdk.msg.model.CustomNotification

All Implemented Interfaces:

java.io.Serializable

public class CustomNotification
extends java.lang.Object
implements java.io.Serializable

Custom notification
Custom notifications are delivered in transparent transmission mode and will not be parsed or stored. This is different from IMMessage. The content is specified by third-party apps
Developers can specify whether custom messages can be delivered to offline users.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CustomNotification()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApnsText() get the content of a message pushed over APNS on iOS devices.
CustomNotificationConfig	getConfig()
java.lang.String	getContent() Get the content of a message
java.lang.String	getEnv() Get the environment variable Used to point to different types of configurations for message delivery and third-party callbacks.
java.lang.String	getFromAccount() Get the account that sent the notification
NIMAntiSpamOption	getNIMAntiSpamOption() Get the anti-spam configuration
java.util.Map<java.lang.String,java.lang.Object>	getPushPayload() Get the third-party push payload
java.lang.String	getSessionId() Get the session ID (peer account, group ID)
SessionTypeEnum	getSessionType() Get the session type
long	getTime() Get the time when the message was sent.
boolean	isSendToOnlineUserOnly() Specify whether the messaging is sent only to online users or groups.
void	setApnsText(java.lang.String apnsText) Set the content of a message pushed over APNS on iOS devices.
void	setConfig(CustomNotificationConfig config)
void	setContent(java.lang.String content) Set the content of a message
void	setEnv(java.lang.String env) Set the environment variable Used to point to different types of configurations for message delivery and third-party callbacks.
void	setFromAccount(java.lang.String fromAccount) Get the sender account
void	setNIMAntiSpamOption(NIMAntiSpamOption antiSpamOption) Set anti-spam options
void	setPushPayload(java.util.Map<java.lang.String,java.lang.Object> pushPayload) Set the third-party push payload
void	setSendToOnlineUserOnly(boolean sendToOnlineUserOnly) Send messages only to online users If the value is set to true, message can be received when the peer gets online.
void	setSessionId(java.lang.String sessionId) Set the session ID
void	setSessionType(SessionTypeEnum sessionType) set the session type
void	setTime(long time) Set the time
JSONObject	toJsonObj()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomNotification

public CustomNotification()

Method Detail

getSessionId

public java.lang.String getSessionId()

Get the session ID (peer account, group ID)

Returns:

session ID

setSessionId

public void setSessionId(java.lang.String sessionId)

Set the session ID

Parameters:

sessionId - Session ID

getSessionType

public SessionTypeEnum getSessionType()

Get the session type

Returns:

session type

setSessionType

public void setSessionType(SessionTypeEnum sessionType)

set the session type

Parameters:

sessionType - Session type

getFromAccount

public java.lang.String getFromAccount()

Get the account that sent the notification

Returns:

the account of a sender

setFromAccount

public void setFromAccount(java.lang.String fromAccount)

Get the sender account

Parameters:

fromAccount - The sender account

getTime

public long getTime()

Get the time when the message was sent. Unit: milliseconds

setTime

public void setTime(long time)

Set the time

getContent

public java.lang.String getContent()

Get the content of a message

setContent

public void setContent(java.lang.String content)

Set the content of a message

isSendToOnlineUserOnly

public boolean isSendToOnlineUserOnly()

Specify whether the messaging is sent only to online users or groups.

setSendToOnlineUserOnly

public void setSendToOnlineUserOnly(boolean sendToOnlineUserOnly)

Send messages only to online users
If the value is set to true, message can be received when the peer gets online.
If the value is set to false, messages will be received instantly by online users. Offline users will receive messages when they log in. If the value is set to false, messages will be reliably delivered.

Parameters:

sendToOnlineUserOnly - Specify whether to send messages only to online users. SDK v4.1 and later supports offline custom group notifications.

getApnsText

public java.lang.String getApnsText()

get the content of a message pushed over APNS on iOS devices.

Returns:

apns The message content pushed over APNS

setApnsText

public void setApnsText(java.lang.String apnsText)

Set the content of a message pushed over APNS on iOS devices.

Parameters:

apnsText - APNs push text setting

getPushPayload

public java.util.Map<java.lang.String,java.lang.Object> getPushPayload()

Get the third-party push payload

Returns:

the third-party push payload

setPushPayload

public void setPushPayload(java.util.Map<java.lang.String,java.lang.Object> pushPayload)

Set the third-party push payload

Parameters:

pushPayload - Third party custom push payload. Make sure the payload can be converted into JsonObject. The maximum size of the content is 2048 bytes.

getConfig

public CustomNotificationConfig getConfig()

setConfig

public void setConfig(CustomNotificationConfig config)

getNIMAntiSpamOption

public NIMAntiSpamOption getNIMAntiSpamOption()

Get the anti-spam configuration

Returns:

setNIMAntiSpamOption

public void setNIMAntiSpamOption(NIMAntiSpamOption antiSpamOption)

Set anti-spam options

Parameters:

antiSpamOption -

getEnv

public java.lang.String getEnv()

Get the environment variable Used to point to different types of configurations for message delivery and third-party callbacks.

Returns:

environment variable

setEnv

public void setEnv(java.lang.String env)

Set the environment variable Used to point to different types of configurations for message delivery and third-party callbacks.

Parameters:

env - Environment variable

toJsonObj

public JSONObject toJsonObj()