com.netease.nimlib.sdk.event.model

Class Event

java.lang.Object

com.netease.nimlib.sdk.event.model.Event

All Implemented Interfaces:

java.io.Serializable

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	broadcastOnlineOnly Specify whether to broadcast to online users only.
protected java.lang.String	config Extended field of the event.
protected java.lang.String	eventId Event ID
protected int	eventType Event type, The value range 1-99999 is reserved type by CommsEase
protected int	eventValue Event state value
protected long	expiry The validity period of the event.
protected java.lang.String	multiClientConfig Configuration for multiple devices
protected java.util.Map<java.lang.Integer,java.lang.String>	multiClientConfigMap Parse the map of multiClientConfig
protected java.lang.String	nimConfig Server configuration items for predefined events.
protected java.lang.String	publisherAccount CommsEase account of the event publisher
protected int	publisherClientType The client type of the event publisher.
protected long	publishTime The publishing time of the event
protected boolean	syncSelfEnable Specify whether to support multiple device synchronization

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Event()
	Event(int eventType, int eventValue, long expiry)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConfig()
java.lang.String	getConfigByClient(int clientType)
java.lang.String	getEventId()
int	getEventType()
int	getEventValue()
long	getExpiry()
java.lang.String	getMultiClientConfig()
java.lang.String	getNimConfig()
java.lang.String	getPublisherAccount()
int	getPublisherClientType()
long	getPublishTime()
boolean	isBroadcastOnlineOnly()
boolean	isSyncSelfEnable()
void	setBroadcastOnlineOnly(boolean broadcastOnlineOnly)
void	setConfig(java.lang.String config)
void	setEventType(int eventType)
void	setEventValue(int eventValue)
void	setExpiry(long expiry)
void	setSyncSelfEnable(boolean syncSelfEnable)

Methods inherited from class java.lang.Object

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

Field Detail

eventId

protected java.lang.String eventId

Event ID

eventType

protected int eventType

Event type, The value range 1-99999 is reserved type by CommsEase

eventValue

protected int eventValue

Event state value

config

protected java.lang.String config

Extended field of the event. The maximum length of the field is 256 bytes. The field is configured by the publisher client.

expiry

protected long expiry

The validity period of the event. Value range: 60 seconds to 7 days. Unit: seconds.

broadcastOnlineOnly

protected boolean broadcastOnlineOnly

Specify whether to broadcast to online users only. If the value is set to false, the event can be broadcast online and synced after login.

syncSelfEnable

protected boolean syncSelfEnable

Specify whether to support multiple device synchronization

publisherAccount

protected java.lang.String publisherAccount

CommsEase account of the event publisher

publishTime

protected long publishTime

The publishing time of the event

publisherClientType

protected int publisherClientType

The client type of the event publisher. For more information, @see ClientType

multiClientConfig

protected java.lang.String multiClientConfig

Configuration for multiple devices

multiClientConfigMap

protected java.util.Map<java.lang.Integer,java.lang.String> multiClientConfigMap

Parse the map of multiClientConfig

nimConfig

protected java.lang.String nimConfig

Server configuration items for predefined events. The settings are applied to only predefined events.

Constructor Detail

Event

protected Event()

Event

public Event(int eventType,
             int eventValue,
             long expiry)

Method Detail

setEventType

public void setEventType(int eventType)

setEventValue

public void setEventValue(int eventValue)

setConfig

public void setConfig(java.lang.String config)

setBroadcastOnlineOnly

public void setBroadcastOnlineOnly(boolean broadcastOnlineOnly)

setExpiry

public void setExpiry(long expiry)

setSyncSelfEnable

public void setSyncSelfEnable(boolean syncSelfEnable)

getEventId

public java.lang.String getEventId()

getEventType

public int getEventType()

getEventValue

public int getEventValue()

getConfig

public java.lang.String getConfig()

getExpiry

public long getExpiry()

isBroadcastOnlineOnly

public boolean isBroadcastOnlineOnly()

isSyncSelfEnable

public boolean isSyncSelfEnable()

getPublisherAccount

public java.lang.String getPublisherAccount()

getPublishTime

public long getPublishTime()

getPublisherClientType

public int getPublisherClientType()

getMultiClientConfig

public java.lang.String getMultiClientConfig()

getConfigByClient

public java.lang.String getConfigByClient(int clientType)

getNimConfig

public java.lang.String getNimConfig()