Interface for building out a message. Please note, that a room and sender must be associated otherwise you will NOT be able to successfully save the message object.


  • IMessageBuilder




  • Adds a custom field to the message. Note: This key can not already exist or it will throw an error. Note: The key must not contain a period in it, an error will be thrown.


    • key: string

      the name of the custom field

    • value: any

      the value of this custom field

    Returns IMessageBuilder

  • Retrieves the threadId to which this message belongs, if any.

    If you would like to retrieve the actual message that the thread originated from, you can use the IMessageRead.getById() method

    Returns string

Generated using TypeDoc