IOpenUrlAction interface

Package:

@microsoft/teams.cards

Opens the provided URL in either a separate browser tab or within the host application.

Properties

fallback	An alternate action to render if the type of this one is unsupported or if the host application doesn't support all the capabilities specified in the requires property.
iconUrl	A URL (or Base64-encoded Data URI) to a PNG, GIF, JPEG or SVG image to be displayed on the left of the action's title. iconUrl also accepts the <icon-name>[,regular|filled] format to display an icon from the vast Adaptive Card icon catalog instead of an image.
id	A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot.
isEnabled	Controls the enabled state of the action. A disabled action cannot be clicked. If the action is represented as a button, the button's style will reflect this state.
mode	Controls if the action is primary or secondary. Secondary actions appear in an overflow menu.
requires	A list of capabilities the element requires the host application to support. If the host application doesn't support at least one of the listed capabilities, the element is not rendered (or its fallback is rendered if provided).
style	Control the style of the action, affecting its visual and spoken representations.
title	The title of the action, as it appears on buttons.
tooltip	The tooltip text to display when the action is hovered over.
type	Must be Action.OpenUrl.
url	The URL to open.

Property Details

fallback

An alternate action to render if the type of this one is unsupported or if the host application doesn't support all the capabilities specified in the requires property.

fallback?: FallbackAction

Property Value

FallbackAction

iconUrl

A URL (or Base64-encoded Data URI) to a PNG, GIF, JPEG or SVG image to be displayed on the left of the action's title.

iconUrl also accepts the <icon-name>[,regular|filled] format to display an icon from the vast Adaptive Card icon catalog instead of an image.

iconUrl?: string

Property Value

string

id

A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot.

id?: string

Property Value

string

isEnabled

Controls the enabled state of the action. A disabled action cannot be clicked. If the action is represented as a button, the button's style will reflect this state.

isEnabled?: boolean

Property Value

boolean

mode

Controls if the action is primary or secondary. Secondary actions appear in an overflow menu.

mode?: ActionMode

Property Value

ActionMode

requires

A list of capabilities the element requires the host application to support. If the host application doesn't support at least one of the listed capabilities, the element is not rendered (or its fallback is rendered if provided).

requires?: IHostCapabilities

Property Value

IHostCapabilities

style

Control the style of the action, affecting its visual and spoken representations.

style?: ActionStyle

Property Value

ActionStyle

title

The title of the action, as it appears on buttons.

title?: string

Property Value

string

tooltip

The tooltip text to display when the action is hovered over.

tooltip?: string

Property Value

string

type

Must be Action.OpenUrl.

type: "Action.OpenUrl"

Property Value

"Action.OpenUrl"

url

The URL to open.

url: string

Property Value

string