Sendbird Chat SDK for .NET  3.0.29
SendBird.User Class Reference
Inheritance diagram for SendBird.User:
SendBird.Member SendBird.Sender

Public Types

enum  UserConnectionStatus { NON_AVAILABLE, ONLINE, OFFLINE }
 

Public Member Functions

virtual string toString ()
 
byte[] Serialize ()
 
void CreateMetaData (Dictionary< string, string > metaDataMap, MetaDataHandler handler)
 
void UpdateMetaData (Dictionary< string, string > metaDataMap, MetaDataHandler handler)
 
string GetMetaData (string key)
 
Dictionary< string, string > GetMetaData ()
 
void DeleteMetaData (string key, DeleteMetaDataHandler handler)
 
void DeleteAllMetaData (DeleteMetaDataHandler handler)
 
delegate void MetaDataHandler (Dictionary< string, string > metaDataMap, SendBirdException e)
 
delegate void DeleteMetaDataHandler (SendBirdException e)
 

Static Public Member Functions

static User BuildFromSerializedData (byte[] data)
 

Properties

string UserId [get, set]
 
string Nickname [get]
 
string ProfileUrl [get]
 
UserConnectionStatus ConnectionStatus [get]
 
long LastSeenAt [get]
 

Detailed Description

Represents a user.

Member Enumeration Documentation

◆ UserConnectionStatus

The user connection status type.

Member Function Documentation

◆ BuildFromSerializedData()

static User SendBird.User.BuildFromSerializedData ( byte[]  data)
inlinestatic

Builds User instance from serialized data generated by serialize().

Parameters
dataSerialized User data.
Returns
User instance.
Since
3.0.22

◆ CreateMetaData()

void SendBird.User.CreateMetaData ( Dictionary< string, string >  metaDataMap,
MetaDataHandler  handler 
)
inline

Creates meta data. This can be used to customize the user.

Parameters
metaDataMapMeta data key-value map.
handlerCallback handler.
Since
3.0.22

◆ DeleteAllMetaData()

void SendBird.User.DeleteAllMetaData ( DeleteMetaDataHandler  handler)
inline

Deletes all meta data.

Parameters
handlerCallback handler.
Since
3.0.22

◆ DeleteMetaData()

void SendBird.User.DeleteMetaData ( string  key,
DeleteMetaDataHandler  handler 
)
inline

Deletes a meta data.

Parameters
keyMeta data key to delete.
handlerCallback handler.
Since
3.0.22

◆ GetMetaData() [1/2]

Dictionary<string, string> SendBird.User.GetMetaData ( )
inline

Gets all meta data.

Returns
Meta data map.
Since
3.0.22

◆ GetMetaData() [2/2]

string SendBird.User.GetMetaData ( string  key)
inline

Gets meta data.

Parameters
keyMeta data to get.
Returns
Meta data value.
Since
3.0.22

◆ UpdateMetaData()

void SendBird.User.UpdateMetaData ( Dictionary< string, string >  metaDataMap,
MetaDataHandler  handler 
)
inline

Updates meta data.

Parameters
metaDataMapMeta data key-value map to update.
handlerCallback handler.
Since
3.0.22

Property Documentation

◆ ConnectionStatus

UserConnectionStatus SendBird.User.ConnectionStatus
get

Returns User connection status.

Returns
The User connection status.

◆ LastSeenAt

long SendBird.User.LastSeenAt
get

Returns the time this User has been last seen at. Zero if this User is online.

Returns
Timestamp in milliseconds.

◆ Nickname

string SendBird.User.Nickname
get

Returns User nickname.

Returns
The User nickname.

◆ ProfileUrl

string SendBird.User.ProfileUrl
get

Returns User profile URL.

Returns
The URL.

◆ UserId

string SendBird.User.UserId
getset

Returns User ID.

Returns
The User ID.

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