Signaling (previously RTM) v1.4.8 API Reference for Unity
Public Member Functions | List of all members
agora_rtm.RtmChannelAttribute Class Reference

Inherits IDisposable.

Public Member Functions

 RtmChannelAttribute (MESSAGE_FLAG flag)
 
 RtmChannelAttribute (IntPtr channelAttributePtr)
 
 RtmChannelAttribute (RtmChannelAttribute channelAttribute, MESSAGE_FLAG flag)
 
void SetKey (string key)
 
string GetKey ()
 
void SetValue (string value)
 
string GetValue ()
 
void SetLastUpdateUserId (string lastUpdateUserId)
 
string GetLastUpdateUserId ()
 
void SetLastUpdateTs (Int64 ts)
 
Int64 GetLastUpdateTs ()
 
IntPtr GetPtr ()
 
void Dispose ()
 
void Dispose (bool disposing)
 

Constructor & Destructor Documentation

◆ RtmChannelAttribute() [1/3]

agora_rtm.RtmChannelAttribute.RtmChannelAttribute ( MESSAGE_FLAG  flag)
inline

◆ RtmChannelAttribute() [2/3]

agora_rtm.RtmChannelAttribute.RtmChannelAttribute ( IntPtr  channelAttributePtr)
inline

◆ RtmChannelAttribute() [3/3]

agora_rtm.RtmChannelAttribute.RtmChannelAttribute ( RtmChannelAttribute  channelAttribute,
MESSAGE_FLAG  flag 
)
inline

Member Function Documentation

◆ Dispose() [1/2]

void agora_rtm.RtmChannelAttribute.Dispose ( )
inline

Release all resources used by the RtmChannelAttribute instance.

◆ Dispose() [2/2]

void agora_rtm.RtmChannelAttribute.Dispose ( bool  disposing)
inline

Release all resources used by the RtmChannelAttribute instance.

◆ GetKey()

string agora_rtm.RtmChannelAttribute.GetKey ( )
inline

Gets the key of the channel attribute.

Returns
Key of the channel attribute.

◆ GetLastUpdateTs()

Int64 agora_rtm.RtmChannelAttribute.GetLastUpdateTs ( )
inline

Gets the timestamp of when the channel attribute was last updated.

Returns
Timestamp of when the channel attribute was last updated in milliseconds.

◆ GetLastUpdateUserId()

string agora_rtm.RtmChannelAttribute.GetLastUpdateUserId ( )
inline

Gets the User ID of the user who makes the latest update to the channel attribute.

Returns
User ID of the user who makes the latest update to the channel attribute.

◆ GetPtr()

IntPtr agora_rtm.RtmChannelAttribute.GetPtr ( )
inline

◆ GetValue()

string agora_rtm.RtmChannelAttribute.GetValue ( )
inline

Gets the value of the channel attribute.

Returns
Value of the channel attribute.

◆ SetKey()

void agora_rtm.RtmChannelAttribute.SetKey ( string  key)
inline

Sets the key of the channel attribute.

Parameters
keyKey of channel attribute. Must be visible characters and not exceed 32 Bytes.

◆ SetLastUpdateTs()

void agora_rtm.RtmChannelAttribute.SetLastUpdateTs ( Int64  ts)
inline

◆ SetLastUpdateUserId()

void agora_rtm.RtmChannelAttribute.SetLastUpdateUserId ( string  lastUpdateUserId)
inline

◆ SetValue()

void agora_rtm.RtmChannelAttribute.SetValue ( string  value)
inline

Sets the value of the channel attribute.

Parameters
valueValue of the channel attribute. Must not exceed 8 KB in length.

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