command (Toast XML Schema)

Article
03/10/2022

Specifies a scenario-associated button shown in a toast. The scenario is specified in the parent commands element.

Note

The command element has been deprecated. This functionality is implemented using the scenario attribute of the toast element and the actions element.

Element hierarchy

<toast>

<commands>: <command>

Syntax

<command id?        = "snooze" | "dismiss" | "video" | "voice" | "decline"
         arguments? = string />

Key

? optional (zero or one)

Attributes and Elements

Attributes

Attribute	Description	Data type	Required	Default value
arguments	An argument string that can be passed to the associated app to provide specifics about the action that it should execute in response to the user action.	string	No	None
id	Specifies one command from the system-defined command list. These values correspond to available actions that the user can take. Two scenarios are available through the commands element. Only certain commands are used with a given scenario, as shown here: alarm snooze dismiss incomingCall video voice decline	This attribute can have one of the following values: snooze dismiss video voice decline	No	None

arguments

An argument string that can be passed to the associated app to provide specifics about the action that it should execute in response to the user action.

string

None

Specifies one command from the system-defined command list. These values correspond to available actions that the user can take. Two scenarios are available through the commands element. Only certain commands are used with a given scenario, as shown here:

alarm
- snooze
- dismiss
incomingCall
- video
- voice
- decline

This attribute can have one of the following values:

snooze
dismiss
video
voice
decline

None

Child Elements

None.

Parent Elements

Parent Element	Description
commands	Specifies that the toast notification is being used to indicate an incoming call or an alarm, with appropriate commands associated with each scenario.