UpdateApplicationContextCommandMessage

UpdateApplicationContextCommandMessage

Represents an update context command message. This message is used in co-pilot where the application context can be sent from the client to the skill to invoke or resume a flow, or it is sent from the skill to the client to trigger application navigation.

Constructor

new UpdateApplicationContextCommandMessage(applicationName)

Description:
  • Creates an instance of the UpdateContextCommandMessage class.
Source:
Parameters:
Name Type Description
applicationName string The command type.

Extends

Methods

addAction(action) → {this}

Description:
  • Add an action to the non-raw message.
Source:
Overrides:
Parameters:
Name Type Description
action Action The action to add.
Returns:
The current instance of the NonRawMessage class.
Type
this

addGlobalAction(action) → {this}

Description:
  • Add a global action to the non-raw message.
Source:
Overrides:
Parameters:
Name Type Description
action Action The global action to add.
Returns:
The current instance of the NonRawMessage class.
Type
this

addKeyword(keyword) → {this}

Description:
  • Add a keyword to the non-raw message.
Source:
Overrides:
Parameters:
Name Type Description
keyword Keyword The keyword to add.
Returns:
The current instance of the NonRawMessage class.
Type
this

addParameter(name, value) → {this}

Description:
  • Add a parameter to the message.
Source:
Parameters:
Name Type Description
name string The name of the parameter.
value any The value of the parameter.
Returns:
The current instance of the UpdateContextCommandMessage class.
Type
this

addProperty(name, value) → {this}

Description:
  • Add a property to the message.
Source:
Overrides:
Parameters:
Name Type Description
name string The name of the property.
value any The value of the property.
Returns:
The current instance of the NonRawMessage class.
Type
this

deserializeNestedProperties()

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

getActions() → {Array.<Action>}

Description:
  • Get the actions associated with the non-raw message.
Source:
Overrides:
Returns:
The array of actions.
Type
Array.<Action>

getApplicationName() → {string}

Description:
  • Gets the application name
Source:
Returns:
The name of the application
Type
string

getCommand() → {CommandType}

Description:
  • Gets the command of the message.
Source:
Overrides:
Returns:
The command of the message.
Type
CommandType

getFieldName() → {string}

Description:
  • Gets the field name
Source:
Returns:
The name of the field
Type
string

getFooterForm() → {ReadOnlyForm}

Description:
  • Get the footer form associated with the non-raw message.
Source:
Overrides:
Returns:
The form
Type
ReadOnlyForm

getFooterText() → {string}

Description:
  • Get the footer text of the non-raw message.
Source:
Overrides:
Returns:
The footer text.
Type
string

getGlobalActions() → {Array.<Action>}

Description:
  • Get the global actions associated with the non-raw message.
Source:
Overrides:
Returns:
The array of global actions.
Type
Array.<Action>

getHeaderText() → {string}

Description:
  • Get the header text of the non-raw message.
Source:
Overrides:
Returns:
The header text.
Type
string

getKeywords() → {Array.<Keyword>}

Description:
  • Get the keywords associated with the non-raw message.
Source:
Overrides:
Returns:
The array of keywords.
Type
Array.<Keyword>

getPageName() → {string}

Description:
  • Gets the page name
Source:
Returns:
The name of the page
Type
string

getParameterValue(parameterName) → {any}

Description:
  • Gets the value of a parameter.
Source:
Parameters:
Name Type Description
parameterName string The name of the parameter.
Returns:
The parameter value.
Type
any

getParameters() → {Map.<string, any>}

Description:
  • Gets the parameters of the message.
Source:
Returns:
The parameters of the message.
Type
Map.<string, any>

getProperties() → {Map.<string, any>}

Description:
  • Gets the properties of the message.
Source:
Overrides:
Returns:
The properties of the message.
Type
Map.<string, any>

getPropertyValue(propertyName) → {any}

Description:
  • Gets the value of a property.
Source:
Overrides:
Parameters:
Name Type Description
propertyName string The name of the property.
Returns:
The property value.
Type
any

getReset() → {boolean}

Description:
  • Returns the flow reset flag
Source:
Returns:
flow reset flag
Type
boolean

getSource() → {ContextSource}

Description:
  • Gets the context source
Source:
Returns:
The context source
Type
ContextSource

getVoice() → {Voice}

Description:
  • Get the voice associated with the non-raw message.
Source:
Overrides:
Returns:
The voice settings.
Type
Voice

setActions(actions) → {this}

Description:
  • Set the actions for the non-raw message.
Source:
Overrides:
Parameters:
Name Type Description
actions Array.<Action> The array of actions to set.
Returns:
The current instance of the NonRawMessage class.
Type
this

setApplicationName(The) → {this}

Description:
  • Sets the application name
Source:
Parameters:
Name Type Description
The string name of the application
Returns:
The updated instance of the UpdateContextCommandMessage.
Type
this

setCommand(command) → {this}

Description:
  • Sets the command of the message.
Source:
Overrides:
Parameters:
Name Type Description
command CommandType The command to set.
Returns:
The updated instance of the CommandMessage.
Type
this

setFieldName(The) → {this}

Description:
  • Sets the field name
Source:
Parameters:
Name Type Description
The string name of the field
Returns:
The updated instance of the UpdateContextCommandMessage.
Type
this

setFooterForm(footerForm) → {this}

Description:
  • Set the footer form for the non-raw message.
Source:
Overrides:
Parameters:
Name Type Description
footerForm ReadOnlyForm The form to set.
Returns:
The current instance of the NonRawMessage class.
Type
this

setFooterText(footerText) → {this}

Description:
  • Set the footer text for the non-raw message.
Source:
Overrides:
Parameters:
Name Type Description
footerText string The footer text to set.
Returns:
The current instance of the NonRawMessage class.
Type
this

setGlobalActions(globalActions) → {this}

Description:
  • Set the global actions for the non-raw message.
Source:
Overrides:
Parameters:
Name Type Description
globalActions Array.<Action> The array of global actions to set.
Returns:
The current instance of the NonRawMessage class.
Type
this

setHeaderText(headerText) → {this}

Description:
  • Set the header text for the non-raw message.
Source:
Overrides:
Parameters:
Name Type Description
headerText string The header text to set.
Returns:
The current instance of the NonRawMessage class.
Type
this

setKeywords(keywords) → {this}

Description:
  • Set the keywords for the non-raw message.
Source:
Overrides:
Parameters:
Name Type Description
keywords Array.<Keyword> The array of keywords to set.
Returns:
The current instance of the NonRawMessage class.
Type
this

setPageName(The) → {this}

Description:
  • Sets the page name
Source:
Parameters:
Name Type Description
The string name of the page
Returns:
The updated instance of the UpdateContextCommandMessage.
Type
this

setParameters(parameters) → {this}

Description:
  • Sets the parameters of the message.
Source:
Parameters:
Name Type Description
parameters Map.<string, any> The parameters to set.
Returns:
The current instance of the UpdateContextCommandMessage class.
Type
this

setProperties(properties) → {this}

Description:
  • Sets the properties of the message.
Source:
Overrides:
Parameters:
Name Type Description
properties Map.<string, any> The properties to set.
Returns:
The current instance of the NonRawMessage class.
Type
this

setReset(reset) → {this}

Description:
  • Set the flow reset flag
Source:
Parameters:
Name Type Description
reset boolean The reset flag
Returns:
The current instance of the UpdateContextCommandMessage class.
Type
this

setSource(The) → {this}

Description:
  • Sets the context source
Source:
Parameters:
Name Type Description
The ContextSource context source
Returns:
The updated instance of the UpdateContextCommandMessage.
Type
this

setVoice(voice) → {this}

Description:
  • Set the voice settings for the non-raw message.
Source:
Overrides:
Parameters:
Name Type Description
voice Voice The voice settings to set.
Returns:
The current instance of the NonRawMessage class.
Type
this

toJson() → {object}

Description:
  • Convert the message to JSON object
Source:
Overrides:
Returns:
The message in JSON format
Type
object