TaskModuleTaskInfo Class

Package:
com.microsoft.bot.schema.teams
Maven Artifact:
com.microsoft.bot:bot-schema:4.14.3
  • java.lang.Object
    • com.microsoft.bot.schema.teams.TaskModuleTaskInfo

public class TaskModuleTaskInfo

Metadata for a Task Module.

Constructor Summary

Constructor Description
TaskModuleTaskInfo()

Method Summary

Modifier and Type Method and Description
Attachment getCard()

Gets the Adaptive card to appear in the task module.
java.lang.String getCompletionBotId()

Gets id if a client does not support the task module feature, this URL is opened in a browser tab.
java.lang.String getFallbackUrl()

Gets the URL if a client does not support the task module feature, this URL is opened in a browser tab.
java.lang.Object getHeight()

Gets title height.
java.lang.String getTitle()

Gets the text that appears below the app name and to the right of the app icon.
java.lang.String getUrl()

Gets the URL of what is loaded as an iframe inside the task module.
java.lang.Object getWidth()

Gets title width.
void setCard(Attachment withCard)

Sets the Adaptive card to appear in the task module.
void setCompletionBotId(String withCompletionBotId)

Sets id if a client does not support the task module feature, this URL is opened in a browser tab.
void setFallbackUrl(String withFallbackUrl)

Sets the URL if a client does not support the task module feature, this URL is opened in a browser tab.
void setHeight(Object withHeight)

Sets title height.
void setTitle(String withTitle)

Sets the text that appears below the app name and to the right of the app icon.
void setUrl(String withUrl)

Sets the URL of what is loaded as an iframe inside the task module.
void setWidth(Object withWidth)

Sets title width.

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

TaskModuleTaskInfo

public TaskModuleTaskInfo()

Method Details

getCard

public Attachment getCard()

Gets the Adaptive card to appear in the task module.

Returns:

The module task card.

getCompletionBotId

public String getCompletionBotId()

Gets id if a client does not support the task module feature, this URL is opened in a browser tab.

Returns:

The completion id.

getFallbackUrl

public String getFallbackUrl()

Gets the URL if a client does not support the task module feature, this URL is opened in a browser tab.

Returns:

The fallback url.

getHeight

public Object getHeight()

Gets title height. This can be a number, representing the task module's height in pixels, or a string, one of: small, medium, large.

Returns:

The title height.

getTitle

public String getTitle()

Gets the text that appears below the app name and to the right of the app icon.

Returns:

The title text.

getUrl

public String getUrl()

Gets the URL of what is loaded as an iframe inside the task module. One of url or card is required.

Returns:

The module url.

getWidth

public Object getWidth()

Gets title width. This can be a number, representing the task module's width in pixels, or a string, one of: small, medium, large.

Returns:

The title width.

setCard

public void setCard(Attachment withCard)

Sets the Adaptive card to appear in the task module.

Parameters:

withCard - The module task card.

setCompletionBotId

public void setCompletionBotId(String withCompletionBotId)

Sets id if a client does not support the task module feature, this URL is opened in a browser tab.

Parameters:

withCompletionBotId - The completion id.

setFallbackUrl

public void setFallbackUrl(String withFallbackUrl)

Sets the URL if a client does not support the task module feature, this URL is opened in a browser tab.

Parameters:

withFallbackUrl - The fallback url.

setHeight

public void setHeight(Object withHeight)

Sets title height. This can be a number, representing the task module's height in pixels, or a string, one of: small, medium, large.

Parameters:

withHeight - The title height.

setTitle

public void setTitle(String withTitle)

Sets the text that appears below the app name and to the right of the app icon.

Parameters:

withTitle - The title text.

setUrl

public void setUrl(String withUrl)

Sets the URL of what is loaded as an iframe inside the task module. One of url or card is required.

Parameters:

withUrl - The module url.

setWidth

public void setWidth(Object withWidth)

Sets title width. This can be a number, representing the task module's width in pixels, or a string, one of: small, medium, large.

Parameters:

withWidth - The title width.

Applies to