Class MediaMessage

Hierarchy

BaseMessage
- MediaMessage

Implements

Message

Index

Constructors

constructor

Methods

Constructors

constructor

new MediaMessage(receiverId: string, file: string | object, type: string, receiverType: string): MediaMessage

Overrides BaseMessage.constructor

Parameters
- receiverId: string
- file: string | object
- type: string
- receiverType: string
Returns MediaMessage

Methods

getAttachment

getAttachment(): Attachment

Method to get attachment of media message.

Returns Attachment

getCaption

getCaption(): string

Method to get caption of the media message.

Returns string

getCategory

getCategory(): MessageCategory

Inherited from BaseMessage.getCategory

Get category of the message.

Returns MessageCategory

getConversationId

getConversationId(): string

Inherited from BaseMessage.getConversationId

Get conversation ID of the message.

Returns string

getData

getData(): Object

Method to get data of the message.

Returns Object

getDeletedAt

getDeletedAt(): number

Inherited from BaseMessage.getDeletedAt

Get timestamp of the message when it was deleted.

Returns number

getDeletedBy

getDeletedBy(): string

Inherited from BaseMessage.getDeletedBy

Get UID of the user who deleted the message.

Returns string

getDeliveredAt

getDeliveredAt(): number

Inherited from BaseMessage.getDeliveredAt

Get delivery timestamp of the message.

Returns number

getDeliveredToMeAt

getDeliveredToMeAt(): number

Inherited from BaseMessage.getDeliveredToMeAt

Get timestamp of the message at which it was delivered to logged in user.

Returns number

getEditedAt

getEditedAt(): number

Inherited from BaseMessage.getEditedAt

Get timestamp of the message when it was updated/edited.

Returns number

getEditedBy

getEditedBy(): string

Inherited from BaseMessage.getEditedBy

Get UID of the user who edited/updated the message.

Returns string

getId

getId(): number

Inherited from BaseMessage.getId

Get ID of the message

Returns number

getMetadata

getMetadata(): Object

Method to get metadata of the message.

Returns Object

getMuid

getMuid(): string

Inherited from BaseMessage.getMuid

Get MUID of the message.

Returns string

getParentMessageId

getParentMessageId(): number

Inherited from BaseMessage.getParentMessageId

Get parent message ID of the message.

Returns number

getRawMessage

getRawMessage(): Object

Inherited from BaseMessage.getRawMessage

Get the raw JSON of the message.

Returns Object

getReadAt

getReadAt(): number

Inherited from BaseMessage.getReadAt

Get read timestamp of the message.

Returns number

getReadByMeAt

getReadByMeAt(): number

Inherited from BaseMessage.getReadByMeAt

Get timestamp of the message at which it was read by the logged in user.

Returns number

getReceiver

getReceiver(): Group | User

Overrides BaseMessage.getReceiver

Method to get receiver of the message.

Returns Group | User

getReceiverId

getReceiverId(): string

Inherited from BaseMessage.getReceiverId

Get receiverID of the message.

Returns string

getReceiverType

getReceiverType(): string

Inherited from BaseMessage.getReceiverType

Get receiver type of the message.

Returns string

getReplyCount

getReplyCount(): number

Inherited from BaseMessage.getReplyCount

Get the number of replies of the message.

Returns number

getSender

getSender(): User

Overrides BaseMessage.getSender

Method to get sender of the message.

Returns User

getSentAt

getSentAt(): number

Inherited from BaseMessage.getSentAt

Get message's sentAt timestamp.

Returns number

getTags

getTags(): String[]

Get the tags of the message.

Returns String[]

getType

getType(): string

Inherited from BaseMessage.getType

Get type of the message.

Returns string

getURL

getURL(): string

Method to get URL of the media file.

Returns string

setAttachment

setAttachment(attachment: Attachment): void

Method to set attachment of media message.

Parameters
- attachment: Attachment
Returns void

setCaption

setCaption(text: string): void

Method to set caption for the media message.

Parameters
- text: string
Returns void

setCategory

setCategory(category: MessageCategory): void

Inherited from BaseMessage.setCategory

Parameters
- category: MessageCategory
  
  Set category of the message.
Returns void

setConversationId

setConversationId(value: string): void

Inherited from BaseMessage.setConversationId

Parameters
- value: string
  
  Set conversation ID of the message.
Returns void

setData

setData(value: Object): void

Method to set data of the message.

Parameters
- value: Object
Returns void

setDeletedAt

setDeletedAt(deletedAt: number): void

Inherited from BaseMessage.setDeletedAt

Parameters
- deletedAt: number
  
  Set timestamp of the message when it was deleted.
Returns void

setDeletedBy

setDeletedBy(deletedBy: string): void

Inherited from BaseMessage.setDeletedBy

Parameters
- deletedBy: string
  
  Set UID of the user who deleted the message.
Returns void

setDeliveredAt

setDeliveredAt(deliveredAt: number): void

Inherited from BaseMessage.setDeliveredAt

Parameters
- deliveredAt: number
  
  Set delivery timestamp of the message.
Returns void

setDeliveredToMeAt

setDeliveredToMeAt(deliveredToMeAt: number): void

Inherited from BaseMessage.setDeliveredToMeAt

Parameters
- deliveredToMeAt: number
  
  Set timestamp of the message at which it was delivered to logged in user.
Returns void

setEditedAt

setEditedAt(editedAt: number): void

Inherited from BaseMessage.setEditedAt

Parameters
- editedAt: number
  
  Set timestamp of the message when it was updated/edited.
Returns void

setEditedBy

setEditedBy(editedBy: string): void

Inherited from BaseMessage.setEditedBy

Parameters
- editedBy: string
  
  Set UID of the user who edited/updated the message.
Returns void

setId

setId(value: number): void

Inherited from BaseMessage.setId

Parameters
- value: number
  
  Set ID of the message
Returns void

setMetadata

setMetadata(metadata: Object): void

Method to set metadata of the message.

Parameters
- metadata: Object
Returns void

setMuid

setMuid(value: string): void

Inherited from BaseMessage.setMuid

Parameters
- value: string
  
  Sets the MUID of the message.
Returns void

setParentMessageId

setParentMessageId(value: number): void

Inherited from BaseMessage.setParentMessageId

Parameters
- value: number
  
  Set parent message ID of the message.
Returns void

setRawMessage

setRawMessage(rawMessage: Object): void

Inherited from BaseMessage.setRawMessage

Parameters
- rawMessage: Object
  
  Set the raw JSON of the message.
Returns void

setReadAt

setReadAt(readAt: number): void

Inherited from BaseMessage.setReadAt

Parameters
- readAt: number
  
  Set read timestamp of the message.
Returns void

setReadByMeAt

setReadByMeAt(readByMeAt: number): void

Inherited from BaseMessage.setReadByMeAt

Parameters
- readByMeAt: number
  
  Set timestamp of the message at which it was read by the logged in user.
Returns void

setReceiver

setReceiver(value: Group | User): void

Inherited from BaseMessage.setReceiver

Parameters
- value: Group | User
  
  Set receiver of the message.
Returns void

setReceiverId

setReceiverId(value: string): void

Inherited from BaseMessage.setReceiverId

Parameters
- value: string
  
  Set receiverId of the message.
Returns void

setReceiverType

setReceiverType(value: string): void

Inherited from BaseMessage.setReceiverType

Parameters
- value: string
  
  Set the receiver type of the message.
Returns void

setReplyCount

setReplyCount(value: number): void

Inherited from BaseMessage.setReplyCount

Parameters
- value: number
  
  Set the number of replies of the message.
Returns void

setSender

setSender(value: User): void

Inherited from BaseMessage.setSender

Parameters
- value: User
  
  Set sender of the message.
Returns void

setSentAt

setSentAt(value: number): void

Inherited from BaseMessage.setSentAt

Parameters
- value: number
  
  Set message's sentAt timestamp.
Returns void

setTags

setTags(tags: String[]): void

Parameters
- tags: String[]
  
  Set the tags for the message.
Returns void

setType

setType(value: string): void

Inherited from BaseMessage.setType

Parameters
- value: string
  
  Set type of the message.
Returns void