Interface Messages

reactions

delete

• delete(
      serial: Serial,
      deleteMessageParams?: DeleteMessageParams,
  ): Promise<Message>

  Delete a message in the chat room.

  This method uses the Ably Chat API REST endpoint for deleting messages. It performs a soft delete, meaning the message is marked as deleted.

  Note that the Promise may resolve before OR after the message is deleted from the realtime channel. This means you may see the message that was just deleted in a callback to subscribe before the returned promise resolves.

  NOTE: The Message instance returned by this method is the state of the message as a result of the delete operation. If you have a subscription to message events via subscribe, you should discard the message instance returned by this method and use the event payloads from the subscription instead.

  Should you wish to restore a deleted message, and providing you have the appropriate permissions, you can simply send an update to the original message. Note: This is subject to change in future versions, whereby a new permissions model will be introduced and a deleted message may not be restorable in this way.

  Parameters

  • serial: Serial

    A string or object that conveys the serial of the message to delete.
  • OptionaldeleteMessageParams: DeleteMessageParams

    Optional details to record about the delete action.

  Returns Promise<Message>

  A promise that resolves when the message was deleted.

history

• history(options: QueryOptions): Promise<PaginatedResult<Message>>

  Get messages that have been previously sent to the chat room, based on the provided options.

  Parameters

  • options: QueryOptions

    Options for the query.

  Returns Promise<PaginatedResult<Message>>

  A promise that resolves with the paginated result of messages. This paginated result can be used to fetch more messages if available.

send

• send(params: SendMessageParams): Promise<Message>

  Send a message in the chat room.

  This method uses the Ably Chat API endpoint for sending messages.

  Note that the Promise may resolve before OR after the message is received from the realtime channel. This means you may see the message that was just sent in a callback to subscribe before the returned promise resolves.

  Parameters

  • params: SendMessageParams

    an object containing {text, headers, metadata} for the message to be sent. Text is required, metadata and headers are optional.

  Returns Promise<Message>

  A promise that resolves when the message was published.

subscribe

• subscribe(listener: MessageListener): MessageSubscriptionResponse

  Subscribe to new messages in this chat room.

  Parameters

  • listener: MessageListener

    callback that will be called

  Returns MessageSubscriptionResponse

  A response object that allows you to control the subscription.

update

• update(
      serial: Serial,
      updateParams: UpdateMessageParams,
      details?: OperationDetails,
  ): Promise<Message>

  Update a message in the chat room.

  Note that the Promise may resolve before OR after the updated message is received from the realtime channel. This means you may see the update that was just sent in a callback to subscribe before the returned promise resolves.

  NOTE: The Message instance returned by this method is the state of the message as a result of the update operation. If you have a subscription to message events via subscribe, you should discard the message instance returned by this method and use the event payloads from the subscription instead.

  This method uses PUT-like semantics: if headers and metadata are omitted from the updateParams, then the existing headers and metadata are replaced with the empty objects.

  Parameters

  • serial: Serial

    A string or object that conveys the serial of the message to update.
  • updateParams: UpdateMessageParams

    The parameters for updating the message.
  • Optionaldetails: OperationDetails

    Optional details to record about the update action.

  Returns Promise<Message>

  A promise of the updated message.