Sender

Sender

Class representing a sender (user)

Constructor

new Sender(jsonObjectopt)

Parameters:
Name Type Attributes Description
jsonObject Object <optional>

Extends

Members

connectionStatus :string

Overrides:
Default Value:
  • ""
Type:
  • string

friendDiscoveryKey :null

Overrides:
Default Value:
  • null
Type:
  • null

(nullable) friendName :string

Overrides:
Default Value:
  • null
Type:
  • string

isActive :boolean

Overrides:
Default Value:
  • true
Type:
  • boolean

isBlockedByMe :boolean

Default Value:
  • false
Type:
  • boolean

(nullable) lastSeenAt :number

Overrides:
Default Value:
  • null
Type:
  • number

metaData :Object

Overrides:
Default Value:
  • {}
See:
Type:
  • Object

nickname :string

Overrides:
Default Value:
  • ""
Type:
  • string

plainProfileUrl :string

Overrides:
Default Value:
  • ""
Type:
  • string

preferredLanguages

Overrides:

(nullable) requireAuth :boolean

Overrides:
Default Value:
  • false
Type:
  • boolean

role :string

Default Value:
  • ""
Type:
  • string

userId :string

Overrides:
Default Value:
  • ""
Type:
  • string

Methods

(static) buildFromSerializedData(serializedObject)

Parameters:
Name Type Description
serializedObject Object

createMetaData(metaData, callbackopt, nullable) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
metaData Object
callback commonCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

deleteAllMetaData(callbackopt, nullable) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
callback commonCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

deleteMetaData(metaDataKey, callbackopt, nullable) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Description
metaDataKey string
callback commonCallback <optional>
<nullable>
Returns:
Type
Promise | undefined

getOriginalProfileUrl() → {string}

Overrides:
Returns:
Type
string

serialize() → {Object}

Overrides:
Returns:
  • frozen representation of current object
Type
Object

updateMetaData(metaData, upsertopt, callbackopt, nullable) → {Promise|undefined}

Overrides:
See:
Parameters:
Name Type Attributes Default Description
metaData Object
upsert boolean <optional>
 false
callback commonCallback <optional>
<nullable>
Returns:
Type
Promise | undefined