Sendbird Chat SDK for Unity
Public Member Functions | Properties | List of all members
SbUser
Inheritance diagram for SbUser:
SbMember SbMember SbParticipant SbRestrictedUser SbSender

Public Member Functions

void CreateMetaData (Dictionary< string, string > inMetaData, SbMetaDataHandler inCompletionHandler)
 Creates the meta data for the current user. More...
 
string GetMetaData (string inKey)
 Gets meta data. More...
 
void UpdateMetaData (Dictionary< string, string > inMetaData, SbMetaDataHandler inCompletionHandler)
 Updates the meta data for the current user. More...
 
void DeleteMetaData (string inKey, SbErrorHandler inCompletionHandler)
 Deletes meta data with key for the current user. More...
 
void DeleteAllMetaData (SbErrorHandler inCompletionHandler)
 Deletes all meta data for the current user. More...
 

Properties

string UserId [get]
 User ID. This has to be unique. More...
 
string Nickname [get]
 User nickname. More...
 
string ProfileUrl [get]
 The profile image URL. If the file encryption feature is enabled, this will have SendbirdChat.EKey combined with the PlainProfileImageUrl so the file can be accessed. For caching the file, it is recommended to use PlainProfileImageUrl as the key of the file cache. More...
 
string OriginalProfileUrl [get]
 Original profile image url. More...
 
string PlainProfileImageUrl [get]
 The plain profile image URL, which does not contain SendbirdChat.EKey as a parameter. If the file encryption feature is enabled, accessing this PlainProfileImageUrl will be denied. More...
 
IReadOnlyList< string > PreferredLanguages [get]
 User’s preferred language. Used for translating messages. More...
 
IReadOnlyDictionary< string, string > MetaData [get]
 All meta data of the user. More...
 
SbUserConnectionStatus ConnectionStatus [get]
 User connection status. This is defined in SbUserConnectionStatus. More...
 
bool IsActive [get]
 Represents the user is activated. This property is changed by the Platform API More...
 
long LastSeenAt [get]
 The latest time when the user became offline. More...
 
string FriendDiscoveryKey [get]
 Discovery key for friend More...
 
string FriendName [get]
 User name for friend More...
 

Detailed Description

Since
4.0.0

Member Function Documentation

◆ CreateMetaData()

void CreateMetaData ( Dictionary< string, string >  inMetaData,
SbMetaDataHandler  inCompletionHandler 
)

Creates the meta data for the current user.

Parameters
inMetaDataThe meta data to be set.
inCompletionHandlerThe handler block to execute. metaData is the meta data which are set on Sendbird server.
Since
4.0.0

◆ DeleteAllMetaData()

void DeleteAllMetaData ( SbErrorHandler  inCompletionHandler)

Deletes all meta data for the current user.

Parameters
inCompletionHandler
Since
4.0.0

◆ DeleteMetaData()

void DeleteMetaData ( string  inKey,
SbErrorHandler  inCompletionHandler 
)

Deletes meta data with key for the current user.

Parameters
inKey
inCompletionHandler
Since
4.0.0

◆ GetMetaData()

string GetMetaData ( string  inKey)

Gets meta data.

Parameters
inKey
Returns
Since
4.0.0

◆ UpdateMetaData()

void UpdateMetaData ( Dictionary< string, string >  inMetaData,
SbMetaDataHandler  inCompletionHandler 
)

Updates the meta data for the current user.

Parameters
inMetaData
inCompletionHandler
Since
4.0.0

Property Documentation

◆ ConnectionStatus

SbUserConnectionStatus ConnectionStatus
get

User connection status. This is defined in SbUserConnectionStatus.

Since
4.0.0

◆ FriendDiscoveryKey

string FriendDiscoveryKey
get

Discovery key for friend

Since
4.0.0

◆ FriendName

string FriendName
get

User name for friend

Since
4.0.0

◆ IsActive

bool IsActive
get

Represents the user is activated. This property is changed by the Platform API

Since
4.0.0

◆ LastSeenAt

long LastSeenAt
get

The latest time when the user became offline.

Since
4.0.0

◆ MetaData

IReadOnlyDictionary<string, string> MetaData
get

All meta data of the user.

Since
4.0.0

◆ Nickname

string Nickname
get

User nickname.

Since
4.0.0

◆ OriginalProfileUrl

string OriginalProfileUrl
get

Original profile image url.

Since
4.0.0

◆ PlainProfileImageUrl

string PlainProfileImageUrl
get

The plain profile image URL, which does not contain SendbirdChat.EKey as a parameter. If the file encryption feature is enabled, accessing this PlainProfileImageUrl will be denied.

Since
4.0.0

◆ PreferredLanguages

IReadOnlyList<string> PreferredLanguages
get

User’s preferred language. Used for translating messages.

Since
4.0.0

◆ ProfileUrl

string ProfileUrl
get

The profile image URL. If the file encryption feature is enabled, this will have SendbirdChat.EKey combined with the PlainProfileImageUrl so the file can be accessed. For caching the file, it is recommended to use PlainProfileImageUrl as the key of the file cache.

Since
4.0.0

◆ UserId

string UserId
get

User ID. This has to be unique.

Since
4.0.0