NIM Unity SDK  V2.4.1
Properties | List of all members
NIM.NIMEventInfo Class Reference

Event information More...

Inheritance diagram for NIM.NIMEventInfo:
NimUtility.NimJsonObject< NIMEventInfo >

Properties

int Type [get, set]
 Event type More...
 
int Value [get, set]
 Event value More...
 
string ClientMsgID [get, set]
 Client message ID More...
 
string Config [get, set]
 Custom event extended property, up to 4K in size More...
 
long ValidityPeriod [get, set]
 Event validity period, unit: seconds, time range: 60s to 7 days More...
 
int BroadcastType [get, set]
 Event broadcast type: 1: online only 2: online and offline More...
 
int Sync [get, set]
 0: do not synchronize to other clients, 1: synchronize to other devices More...
 
string NimConfig [get, set]
 Extended field of predefined events (online status event: online client type in JSON) More...
 
int TTLType [get, set]
 Not required on clients More...
 
int Durable [get, set]
 Whether persistence is required (optional). Persistence required by default, 0: no persistence required, 1: persistence required (Not required on clients) More...
 
long EventTime [get, set]
 The timestamp of the event release on the server (Not required on clients) More...
 
string ServerMsgID [get, set]
 The message ID generated on the server (Not required on clients) More...
 
int ClientType [get, set]
 Client type (Not required on clients) More...
 
string MultiPortConfig [get, set]
 Multi-device configuration field, JSON format {"clent_type":"clent_config","1":"xxx","2":"xxx"} More...
 
string PublisherID [get, set]
 The accid of the event publisher (Not required on clients) More...
 
string DeviceID [get, set]
 Device ID (Not required on clients) More...
 
override bool IgnoreDefauleValue [get, set]
 
- Properties inherited from NimUtility.NimJsonObject< NIMEventInfo >
virtual bool IgnoreDefauleValue [get, set]
 
string JSON [get, set]
 

Additional Inherited Members

- Public Member Functions inherited from NimUtility.NimJsonObject< NIMEventInfo >
virtual string Serialize ()
 
virtual string SerializeWithIndented ()
 
- Static Public Member Functions inherited from NimUtility.NimJsonObject< NIMEventInfo >
static T Deserialize (string json)
 

Detailed Description

Event information

Property Documentation

◆ Type

int NIM.NIMEventInfo.Type
getset

Event type

◆ Value

int NIM.NIMEventInfo.Value
getset

Event value

◆ ClientMsgID

string NIM.NIMEventInfo.ClientMsgID
getset

Client message ID

◆ Config

string NIM.NIMEventInfo.Config
getset

Custom event extended property, up to 4K in size

◆ ValidityPeriod

long NIM.NIMEventInfo.ValidityPeriod
getset

Event validity period, unit: seconds, time range: 60s to 7 days

◆ BroadcastType

int NIM.NIMEventInfo.BroadcastType
getset

Event broadcast type: 1: online only 2: online and offline

◆ Sync

int NIM.NIMEventInfo.Sync
getset

0: do not synchronize to other clients, 1: synchronize to other devices

◆ NimConfig

string NIM.NIMEventInfo.NimConfig
getset

Extended field of predefined events (online status event: online client type in JSON)

◆ TTLType

int NIM.NIMEventInfo.TTLType
getset

Not required on clients

◆ Durable

int NIM.NIMEventInfo.Durable
getset

Whether persistence is required (optional). Persistence required by default, 0: no persistence required, 1: persistence required (Not required on clients)

◆ EventTime

long NIM.NIMEventInfo.EventTime
getset

The timestamp of the event release on the server (Not required on clients)

◆ ServerMsgID

string NIM.NIMEventInfo.ServerMsgID
getset

The message ID generated on the server (Not required on clients)

◆ ClientType

int NIM.NIMEventInfo.ClientType
getset

Client type (Not required on clients)

◆ MultiPortConfig

string NIM.NIMEventInfo.MultiPortConfig
getset

Multi-device configuration field, JSON format {"clent_type":"clent_config","1":"xxx","2":"xxx"}

◆ PublisherID

string NIM.NIMEventInfo.PublisherID
getset

The accid of the event publisher (Not required on clients)

◆ DeviceID

string NIM.NIMEventInfo.DeviceID
getset

Device ID (Not required on clients)


The documentation for this class was generated from the following file: