com.voximplant.sdk.messaging

Interface IMessage



  • public interface IMessage
    Interface that represents message within a conversation.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.lang.String getConversation()
      Get UUID of the conversation this message belongs to.
      java.util.List<Payload> getPayload()
      Get list of Payload objects associated with the message.
      java.lang.String getSender()
      Get user id of the sender of this message.
      long getSequence()
      Get message sequence number.
      java.lang.String getText()
      Get text of this message.
      java.lang.String getUUID()
      Get universally unique identifier of message.
      void remove()
      Remove the message.
      void update(java.lang.String text, java.util.List<Payload> payload)
      Sends text and payload changes to the server.
    • Method Detail

      • getConversation

        java.lang.String getConversation()
        Get UUID of the conversation this message belongs to.
        Returns:
        Conversation UUID
      • getPayload

        java.util.List<Payload> getPayload()
        Get list of Payload objects associated with the message.
        Returns:
        List of Payload
        See Also:
        Payload
      • getSender

        java.lang.String getSender()
        Get user id of the sender of this message.
        Returns:
        User id
      • getText

        java.lang.String getText()
        Get text of this message.
        Returns:
        Message text
      • getUUID

        java.lang.String getUUID()
        Get universally unique identifier of message. Can be used on client side for house keeping.
        Returns:
        UUID of this message
      • getSequence

        long getSequence()
        Get message sequence number.
        Returns:
        Message sequence number
      • update

        void update(java.lang.String text, java.util.List<Payload> payload)
        Sends text and payload changes to the server.
        Parameters:
        text - New text of this message. If null, message text will not be updated.
        payload - New payload of this message. If null, message payload will not be updated.
      • remove

        void remove()
        Remove the message. Triggers the onRemoveMessage event for all messenger objects on all clients, including this one. Clients that are not connected will receive it later.
        See Also:
        IMessengerListener.onRemoveMessage(IMessageEvent)