taskInfo object

Task module to be launched when fetch task set to false.

Properties that reference this object type:

• root.bots.configuration.groupChat.taskInfo
• root.bots.configuration.team.taskInfo
• root.composeExtensions.commands.taskInfo

Syntax

Syntax

{
  "title": "{string}",
  "width": "{string}",
  "height": "{string}",
  "url": "{string}"
}

Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "title": {
      "type": "string",
      "description": "Initial dialog title",
      "maxLength": 64
    },
    "width": {
      "$ref": "#/definitions/taskInfoDimension",
      "description": "Dialog width - either a number in pixels or default layout such as \u0027large\u0027, \u0027medium\u0027, or \u0027small\u0027"
    },
    "height": {
      "$ref": "#/definitions/taskInfoDimension",
      "description": "Dialog height - either a number in pixels or default layout such as \u0027large\u0027, \u0027medium\u0027, or \u0027small\u0027"
    },
    "url": {
      "$ref": "#/definitions/httpsUrl",
      "description": "Initial webview URL"
    }
  }
}

Properties

title

Initial dialog title.

This property is localizable. For more information, see the localization schema.

Type
string

Required
—

Constraints
Maximum string length: 64.

Supported values

width

Dialog width.

Type
string

Required
—

Constraints
Maximum string length: 16.

Supported values
The string value must be a number or Large, Medium, Small.

height

Dialog height.

Type
string

Required
—

Constraints
Maximum string length: 16.

Supported values
The string value must be a number or Large, Medium, Small.

url

Initial webview URL.

Type
string

Required
—

Constraints
Maximum string length: 2048.

Supported values
The string must start with https://.

Examples

{
    "taskInfo": {
        "title": "Initial dialog title",
        "width": "Dialog width",
        "height": "Dialog height",
        "url": "Initial webview URL"
    }
}