UrlAction

UrlAction

Represents a URL action.

Constructor

new UrlAction(label, url)

Description:
  • Creates a new instance of the UrlAction class.
Source:
Parameters:
Name Type Description
label The label of the URL action.
url The URL associated with the action.

Extends

Methods

deserializeNestedProperties()

Description:
  • Deserialize nested object properties into corresponding class instances
Source:
Overrides:

getChannelExtensionProperty(channelType, propertyName) → {any}

Description:
  • Get the value of a channel extension property
Source:
Overrides:
Parameters:
Name Type Description
channelType ChannelType The channel type.
propertyName string The name of the property.
Returns:
The property value
Type
any

getChannelExtensions() → {ChannelExtensions}

Description:
  • Gets the channel extensions
Source:
Overrides:
Returns:
The channel extensions
Type
ChannelExtensions

getDisplayType() → {DisplayType}

Description:
  • Gets the style of the action.
Source:
Overrides:
Returns:
The display type of the action.
Type
DisplayType

getId() → {string}

Description:
  • Gets the ID of the action.
Source:
Overrides:
Returns:
The ID of the action.
Type
string

getImageUrl() → {string}

Description:
  • Gets the image URL of the action.
Source:
Overrides:
Returns:
The image URL of the action.
Type
string

getLabel() → {string}

Description:
  • Gets the label of the action.
Source:
Overrides:
Returns:
The label of the action.
Type
string

getStyle() → {string}

Description:
  • Gets the style of the action.
Source:
Overrides:
Returns:
The style of the action.
Type
string

getUrl()

Description:
  • Get the URL associated with the URL action.
Source:
Returns:
The URL.

getVoice() → {Voice}

Description:
  • Gets the voice settings associated with the action.
Source:
Overrides:
Returns:
The voice settings associated with the action.
Type
Voice

setChannelExtensionProperty(channelType, propertyName, propertyValue)

Description:
  • Sets a channel-specific extension property
Source:
Overrides:
Parameters:
Name Type Description
channelType ChannelType The channel type.
propertyName string The name of the property.
propertyValue any The value of the property.
Returns:
The current instance of this class.

setDisplayType(displayType)

Description:
  • Sets the display type of the action.
Source:
Overrides:
Parameters:
Name Type Description
displayType DisplayType The display type to set.
Returns:
The current instance of the Action class.

setId(id)

Description:
  • Sets the ID of the action.
Source:
Overrides:
Parameters:
Name Type Description
id string The ID to set.

setImageUrl(imageUrl)

Description:
  • Sets the image URL of the action.
Source:
Overrides:
Parameters:
Name Type Description
imageUrl string The image URL to set.
Returns:
The current instance of the Action class.

setLabel(label)

Description:
  • Sets the label of the action.
Source:
Overrides:
Parameters:
Name Type Description
label string The label to set.
Returns:
The current instance of the Action class.

setStyle(style)

Description:
  • Sets the style of the action.
Source:
Overrides:
Parameters:
Name Type Description
style string The style to set.
Returns:
The current instance of the Action class.

setUrl(url)

Description:
  • Set the URL for the URL action.
Source:
Parameters:
Name Type Description
url The URL to set.
Returns:
The current instance of the UrlAction class.

setVoice(voice)

Description:
  • Sets the voice settings associated with the action.
Source:
Overrides:
Parameters:
Name Type Description
voice Voice The voice to set.
Returns:
The current instance of the Action class.