Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.

$jsapi.getCustomTags

The method returns an array of action tags that are used in the script.

Syntax

The method accepts an action tag name as an argument.

$jsapi.getCustomTags("Example");

Return value

The method returns an array of tags:

[
{
"state": "/Example/State",
"params": {
"parameter name 1": "example value 1",
"parameter name 2": "example value 2",
}
},
{
"state": "/Path/To/State",
"params": {
"parameter name 1": "example value 1",
"parameter name 2": "example value 2",
}
}
]

For each tag, the following data is specified:

  • state is the full path to a state in which the tag is used.
  • params is an object with tag parameters and their values.

Example

In a script, there are two InputText tags:

state: FeedbackSurvey
InputText:
prompt = How satisfied are you with our service?
varName = feedback
then = /FeedbackSurvey/GetFeedback

state: Support
InputText:
prompt = Please rate the support service.
varName = supportReview
  1. Call the method:

    $jsapi.getCustomTags("InputText");
  2. The method will return an array:

    [
    {
    "state": "/FeedbackSurvey",
    "params": {
    "prompt": "How satisfied are you with our service?",
    "varName": "feedback",
    "then": "/FeedbackSurvey/GetFeedback"
    }
    },
    {
    "state": "/Support",
    "params": {
    "prompt": "Please rate the support service.",
    "varName": "supportReview"
    }
    }
    ]