Constructor
new User(jsonObject)
- See:
-
- https://sendbird.com/docs/chat/v3/platform-api/guides/user. Actual Javascript implementation may vary from platform specification
Parameters:
| Name | Type | Description |
|---|---|---|
jsonObject |
Object |
Members
(static) NON_AVAILABLE :string
- Default Value:
- "nonavailable"
Type:
- string
(static) OFFLINE :string
- Default Value:
- "offline"
Type:
- string
(static) ONLINE :string
- Default Value:
- "online"
Type:
- string
connectionStatus :string
- Default Value:
- ""
Type:
- string
friendDiscoveryKey :null
- Default Value:
- null
Type:
- null
(nullable) friendName :string
- Default Value:
- null
Type:
- string
isActive :boolean
- Default Value:
- true
Type:
- boolean
(nullable) lastSeenAt :number
- Default Value:
- null
Type:
- number
metaData :Object
- Default Value:
- {}
- See:
Type:
- Object
nickname :string
- Default Value:
- ""
Type:
- string
plainProfileUrl :string
- Default Value:
- ""
Type:
- string
preferredLanguages
(nullable) requireAuth :boolean
- Default Value:
- false
Type:
- boolean
userId :string
- Default Value:
- ""
Type:
- string
Methods
(static) buildFromSerializedData(serializedObject) → {module:model/user~User}
Parameters:
| Name | Type | Description |
|---|---|---|
serializedObject |
Object |
Returns:
createMetaData(metaData, callbackopt, nullable) → {Promise|undefined}
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
metaData |
Object | ||
callback |
commonCallback |
<optional> <nullable> |
Returns:
- Type
- Promise | undefined
deleteAllMetaData(callbackopt, nullable) → {Promise|undefined}
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
callback |
commonCallback |
<optional> <nullable> |
Returns:
- Type
- Promise | undefined
deleteMetaData(metaDataKey, callbackopt, nullable) → {Promise|undefined}
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
metaDataKey |
string | ||
callback |
commonCallback |
<optional> <nullable> |
Returns:
- Type
- Promise | undefined
getOriginalProfileUrl() → {string}
Returns:
- Type
- string
serialize() → {Object}
Returns:
- frozen representation of current object
- Type
- Object
updateMetaData(metaData, upsertopt, callbackopt, nullable) → {Promise|undefined}
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
metaData |
Object | |||
upsert |
boolean |
<optional> |
false
|
|
callback |
commonCallback |
<optional> <nullable> |
Returns:
- Type
- Promise | undefined