UnbluMessageCustomActionInvocation

All Superinterfaces:: UnbluCustomActionInvocation

public interface UnbluMessageCustomActionInvocation extends UnbluCustomActionInvocation

An extension of the UnbluCustomActionInvocation interface for custom actions invoked on a message.

Method Summary

Modifier and Type

Method

Description

String

getMessageId()

Gets the ID of the message the action was invoked on.

String

getMessageSenderPersonDisplayName()

String

getMessageSenderPersonId()

String

getMessageText()

Gets the text of the message that the action was invoked on.

String

getMessageType()

Gets the type of the message the action was invoked on.

Methods inherited from interface com.unblu.sdk.core.conversation.customaction.UnbluCustomActionInvocation
geIinvocationId, getConversationId, getInvocationTimestamp, getInvokingPersonDisplayName, getInvokingPersonId, getKey

Method Details
- getMessageId
  
  String getMessageId()
  
  Gets the ID of the message the action was invoked on.
  
  Returns:
  
  The ID of the message as a string.
- getMessageType
  
  String getMessageType()
  Gets the type of the message the action was invoked on. The value returned is one of the following:
  
  TEXT
  
  SYSTEM
  
  FILE
  
  CARD
  
  LIST
  
  APPROVAL_REQUEST
  
  MULTICHOICE_QUESTION/
  
  RATING_QUESTION
  
  TEXT_QUESTION
  
  REPLY
  
  QUESTION_ABORTED
  
  RECORDING_AVAILABLE
  Returns:
  
  A string representation of the message's type of the message
- getMessageSenderPersonId
  
  String getMessageSenderPersonId()
  
  Returns:
  
  The ID of person who sent the message that the action was invoked on, as a string
- getMessageSenderPersonDisplayName
  
  String getMessageSenderPersonDisplayName()
  
  Returns:
  
  The display name of the person who sent the message that the action was invoked on, as a string
- getMessageText
  
  String getMessageText()
  
  Gets the text of the message that the action was invoked on. If the message type contains complex data such as a file, the fallback text for the message type is returned.
  
  Returns:
  
  The text of the message that the action was invoked on, as a string