Skip to main content

@slack/web-api / AgentsConversationsSetCommandsArguments

Interface: AgentsConversationsSetCommandsArguments

Defined in: packages/web-api/src/types/request/agents.ts:89

Extends​

  • TokenOverridable

Properties​

channel_id​

channel_id: string;

Defined in: packages/web-api/src/types/request/agents.ts:91

Description​

ID of the code channel to register commands for.

commands​

commands: object[];

Defined in: packages/web-api/src/types/request/agents.ts:96

argument_hint?​

optional argument_hint?: string;
Description​

Hint describing the command's arguments, shown in the typeahead.

description?​

optional description?: string;
Description​

Short description of what the command does.

name​

name: string;
Description​

Command name, without a leading slash. 1-31 characters, unique within the set.

should_escape?​

optional should_escape?: boolean;
Description​

When true, channel, user, and link references in the command's text are escaped/parsed before being sent to the agent app, matching the slash-command should_escape behavior. Absent is treated as false.

Description​

Full set of commands to register for the calling agent in this channel, replacing that agent's previously registered set. Pass an empty array to clear the agent's commands. At most 10 commands may exist across all agents in the channel; names must be unique within the set and must not collide with builtin Slack commands.

token?​

optional token?: string;

Defined in: packages/web-api/src/types/request/common.ts:43

Description​

Overridable authentication token bearing required scopes.

Inherited from​

TokenOverridable.token