MessagingExtensionAction Class

Package:
com.microsoft.bot.schema.teams
Maven Artifact:
com.microsoft.bot:bot-schema:4.14.3

public class MessagingExtensionAction
extends TaskModuleRequest

Messaging extension action.

Constructor Summary

Constructor Description
MessagingExtensionAction()

Method Summary

Modifier and Type Method and Description
java.util.List<Activity> getBotActivityPreview()

Gets the list of preview Activities.
java.lang.String getBotMessagePreviewAction()

Gets bot message preview action taken by user.
java.lang.String getCommandContext()

Gets the context from which the command originates.
java.lang.String getCommandId()

Gets id of the command assigned by Bot.
MessageActionsPayload getMessagePayload()

Gets message content sent as part of the command request.
void setBotActivityPreview(List<Activity> withBotActivityPreview)

Sets the list of preview Activities.
void setBotMessagePreviewAction(String withBotMessagePreviewAction)

Sets bot message preview action taken by user.
void setCommandContext(String withCommandContext)

Sets the context from which the command originates.
void setCommandId(String withCommandId)

Sets id of the command assigned by Bot.
void setMessagePayload(MessageActionsPayload withMessagePayload)

Sets message content sent as part of the command request.

Methods inherited from TaskModuleRequest

getContext getData getTabContext setContext setData setTabContext

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

MessagingExtensionAction

public MessagingExtensionAction()

Method Details

getBotActivityPreview

public List getBotActivityPreview()

Gets the list of preview Activities.

Returns:

The preview activities.

getBotMessagePreviewAction

public String getBotMessagePreviewAction()

Gets bot message preview action taken by user. Possible values include: 'edit', 'send'

Returns:

The preview action.

getCommandContext

public String getCommandContext()

Gets the context from which the command originates. Possible values include: 'message', 'compose', 'commandbox'

Returns:

The command context.

getCommandId

public String getCommandId()

Gets id of the command assigned by Bot.

Returns:

The command id.

getMessagePayload

public MessageActionsPayload getMessagePayload()

Gets message content sent as part of the command request.

Returns:

The message payload.

setBotActivityPreview

public void setBotActivityPreview(List withBotActivityPreview)

Sets the list of preview Activities.

Parameters:

withBotActivityPreview - The preview activities.

setBotMessagePreviewAction

public void setBotMessagePreviewAction(String withBotMessagePreviewAction)

Sets bot message preview action taken by user. Possible values include: 'edit', 'send'

Parameters:

withBotMessagePreviewAction - The preview action.

setCommandContext

public void setCommandContext(String withCommandContext)

Sets the context from which the command originates. Possible values include: 'message', 'compose', 'commandbox'

Parameters:

withCommandContext - The command context.

setCommandId

public void setCommandId(String withCommandId)

Sets id of the command assigned by Bot.

Parameters:

withCommandId - The command id.

setMessagePayload

public void setMessagePayload(MessageActionsPayload withMessagePayload)

Sets message content sent as part of the command request.

Parameters:

withMessagePayload - The message payload.

Applies to