API Docs for: 0.9.9
Show:

Message Class

Defined in: src/SDK/Message.js:5
Module: SinchInternal

A class for Instant Messages

Constructor

Message

(
  • msgObj
  • fromOther
)
protected

Defined in src/SDK/Message.js:5

Parameters:

  • msgObj MXPMessageObj | Object

    Create new Message based on a MXPMessageObj (incoming) or a regular Object (outgoing).

  • fromOther Boolean

    Indicate if message is from me.

Methods

getMXPMessageObj

() MXPMessageObj protected

Defined in src/SDK/Message.js:94

A method to clone this {Message} object into a new {MXPMessageObj}

Returns:

MXPMessageObj:

A new MXPMessageObj Object

Properties

delivered

Object

Defined in src/SDK/Message.js:81

Array of recipients which have acknowledged delivery of their message.

direction

Boolean

Defined in src/SDK/Message.js:87

True if outgoing (from myself) or false for incoming (from other user)

headers

Object

Defined in src/SDK/Message.js:69

Custom headers for message

messageId

Number

Defined in src/SDK/Message.js:45

Id of message

recipientIds

Array

Defined in src/SDK/Message.js:51

Array of usernames for recipients. Array with one item if there's only one recipient.

senderId

String

Defined in src/SDK/Message.js:63

Username for sender of this message

textBody

String

Defined in src/SDK/Message.js:57

Text body of message

timestamp

Number

Defined in src/SDK/Message.js:75

Local javascript time when message was created