Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 40 additions & 10 deletions docs/english/reference/types/enumerations/CustomFieldType.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Enumeration: CustomFieldType

Defined in: [message-metadata.ts:277](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L277)
Defined in: [message-metadata.ts:290](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L290)

## Enumeration Members

Expand All @@ -12,7 +12,17 @@ Defined in: [message-metadata.ts:277](https://github.com/slackapi/node-slack-sdk
Array: "array";
```

Defined in: [message-metadata.ts:280](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L280)
Defined in: [message-metadata.ts:293](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L293)

***

### Boolean

```ts
Boolean: "boolean";
```

Defined in: [message-metadata.ts:300](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L300)

***

Expand All @@ -22,7 +32,7 @@ Defined in: [message-metadata.ts:280](https://github.com/slackapi/node-slack-sdk
ChannelId: "slack#/types/channel_id";
```

Defined in: [message-metadata.ts:284](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L284)
Defined in: [message-metadata.ts:297](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L297)

***

Expand All @@ -32,7 +42,17 @@ Defined in: [message-metadata.ts:284](https://github.com/slackapi/node-slack-sdk
Date: "slack#/types/date";
```

Defined in: [message-metadata.ts:281](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L281)
Defined in: [message-metadata.ts:294](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L294)

***

### Email

```ts
Email: "slack#/types/email";
```

Defined in: [message-metadata.ts:302](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L302)

***

Expand All @@ -42,7 +62,7 @@ Defined in: [message-metadata.ts:281](https://github.com/slackapi/node-slack-sdk
EntityRef: "slack#/types/entity_ref";
```

Defined in: [message-metadata.ts:286](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L286)
Defined in: [message-metadata.ts:299](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L299)

***

Expand All @@ -52,7 +72,7 @@ Defined in: [message-metadata.ts:286](https://github.com/slackapi/node-slack-sdk
Image: "slack#/types/image";
```

Defined in: [message-metadata.ts:283](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L283)
Defined in: [message-metadata.ts:296](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L296)

***

Expand All @@ -62,7 +82,17 @@ Defined in: [message-metadata.ts:283](https://github.com/slackapi/node-slack-sdk
Integer: "integer";
```

Defined in: [message-metadata.ts:278](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L278)
Defined in: [message-metadata.ts:291](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L291)

***

### Link

```ts
Link: "slack#/types/link";
```

Defined in: [message-metadata.ts:301](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L301)

***

Expand All @@ -72,7 +102,7 @@ Defined in: [message-metadata.ts:278](https://github.com/slackapi/node-slack-sdk
String: "string";
```

Defined in: [message-metadata.ts:279](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L279)
Defined in: [message-metadata.ts:292](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L292)

***

Expand All @@ -82,7 +112,7 @@ Defined in: [message-metadata.ts:279](https://github.com/slackapi/node-slack-sdk
Timestamp: "slack#/types/timestamp";
```

Defined in: [message-metadata.ts:282](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L282)
Defined in: [message-metadata.ts:295](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L295)

***

Expand All @@ -92,4 +122,4 @@ Defined in: [message-metadata.ts:282](https://github.com/slackapi/node-slack-sdk
User: "slack#/types/user";
```

Defined in: [message-metadata.ts:285](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L285)
Defined in: [message-metadata.ts:298](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L298)
6 changes: 5 additions & 1 deletion docs/english/reference/types/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @slack/types v2.18.0
# @slack/types v2.19.0

## Enumerations

Expand Down Expand Up @@ -69,6 +69,8 @@
- [EntityActionButton](interfaces/EntityActionButton.md)
- [EntityArrayItemField](interfaces/EntityArrayItemField.md)
- [EntityAttributes](interfaces/EntityAttributes.md)
- [EntityBooleanCheckboxField](interfaces/EntityBooleanCheckboxField.md)
- [EntityBooleanTextField](interfaces/EntityBooleanTextField.md)
- [EntityCustomField](interfaces/EntityCustomField.md)
- [EntityEditSupport](interfaces/EntityEditSupport.md)
- [EntityFullSizePreview](interfaces/EntityFullSizePreview.md)
Expand Down Expand Up @@ -154,6 +156,7 @@
- [PlainTextInput](interfaces/PlainTextInput.md)
- [PlainTextOption](interfaces/PlainTextOption.md)
- [RadioButtons](interfaces/RadioButtons.md)
- [RawTextElement](interfaces/RawTextElement.md)
- [ReactionAddedEvent](interfaces/ReactionAddedEvent.md)
- [ReactionRemovedEvent](interfaces/ReactionRemovedEvent.md)
- [RichTextBlock](interfaces/RichTextBlock.md)
Expand Down Expand Up @@ -190,6 +193,7 @@
- [SubteamSelfAddedEvent](interfaces/SubteamSelfAddedEvent.md)
- [SubteamSelfRemovedEvent](interfaces/SubteamSelfRemovedEvent.md)
- [SubteamUpdatedEvent](interfaces/SubteamUpdatedEvent.md)
- [TableBlock](interfaces/TableBlock.md)
- [TaskEntityFields](interfaces/TaskEntityFields.md)
- [TeamAccessGrantedEvent](interfaces/TeamAccessGrantedEvent.md)
- [TeamAccessRevokedEvent](interfaces/TeamAccessRevokedEvent.md)
Expand Down
8 changes: 4 additions & 4 deletions docs/english/reference/types/interfaces/ActionsBlock.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Interface: ActionsBlock

Defined in: [block-kit/blocks.ts:89](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L89)
Defined in: [block-kit/blocks.ts:96](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L96)

## Description

Expand All @@ -24,7 +24,7 @@ Holds multiple interactive elements.
optional block_id: string;
```

Defined in: [block-kit/blocks.ts:41](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L41)
Defined in: [block-kit/blocks.ts:47](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L47)

#### Description

Expand All @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`.
elements: ActionsBlockElement[];
```

Defined in: [block-kit/blocks.ts:98](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L98)
Defined in: [block-kit/blocks.ts:105](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L105)

#### Description

Expand All @@ -61,7 +61,7 @@ There is a maximum of 25 elements in each action block.
type: "actions";
```

Defined in: [block-kit/blocks.ts:93](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L93)
Defined in: [block-kit/blocks.ts:100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L100)

#### Description

Expand Down
7 changes: 4 additions & 3 deletions docs/english/reference/types/interfaces/Block.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Interface: Block

Defined in: [block-kit/blocks.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L29)
Defined in: [block-kit/blocks.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L35)

## Extended by

Expand All @@ -16,6 +16,7 @@ Defined in: [block-kit/blocks.ts:29](https://github.com/slackapi/node-slack-sdk/
- [`MarkdownBlock`](MarkdownBlock.md)
- [`RichTextBlock`](RichTextBlock.md)
- [`SectionBlock`](SectionBlock.md)
- [`TableBlock`](TableBlock.md)
- [`VideoBlock`](VideoBlock.md)

## Properties
Expand All @@ -26,7 +27,7 @@ Defined in: [block-kit/blocks.ts:29](https://github.com/slackapi/node-slack-sdk/
optional block_id: string;
```

Defined in: [block-kit/blocks.ts:41](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L41)
Defined in: [block-kit/blocks.ts:47](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L47)

#### Description

Expand All @@ -44,7 +45,7 @@ a message. If a message is updated, use a new `block_id`.
type: string;
```

Defined in: [block-kit/blocks.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L33)
Defined in: [block-kit/blocks.ts:39](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L39)

#### Description

Expand Down
6 changes: 3 additions & 3 deletions docs/english/reference/types/interfaces/ChannelsSelect.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Interface: ChannelsSelect

Defined in: [block-kit/block-elements.ts:477](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L477)
Defined in: [block-kit/block-elements.ts:481](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L481)

## Description

Expand Down Expand Up @@ -83,7 +83,7 @@ Defaults to `false`.
optional initial_channel: string;
```

Defined in: [block-kit/block-elements.ts:485](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L485)
Defined in: [block-kit/block-elements.ts:489](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L489)

#### Description

Expand Down Expand Up @@ -137,7 +137,7 @@ for the message will be determined by the value of this select menu.
type: "channels_select";
```

Defined in: [block-kit/block-elements.ts:481](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L481)
Defined in: [block-kit/block-elements.ts:485](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L485)

#### Description

Expand Down
12 changes: 8 additions & 4 deletions docs/english/reference/types/interfaces/ContextActionsBlock.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,16 @@

# Interface: ContextActionsBlock

Defined in: [block-kit/blocks.ts:131](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L131)
Defined in: [block-kit/blocks.ts:139](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L139)

## Description

Displays actions as contextual info, which can include both feedback buttons and icon buttons.

## See

[Context actions block reference](https://docs.slack.dev/reference/block-kit/blocks/context-actions-block).

## Extends

- [`Block`](Block.md)
Expand All @@ -20,7 +24,7 @@ Displays actions as contextual info, which can include both feedback buttons and
optional block_id: string;
```

Defined in: [block-kit/blocks.ts:41](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L41)
Defined in: [block-kit/blocks.ts:47](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L47)

#### Description

Expand All @@ -42,7 +46,7 @@ a message. If a message is updated, use a new `block_id`.
elements: ContextActionsBlockElement[];
```

Defined in: [block-kit/blocks.ts:139](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L139)
Defined in: [block-kit/blocks.ts:147](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L147)

#### Description

Expand All @@ -56,7 +60,7 @@ An array of [FeedbackButtons](FeedbackButtons.md) or [IconButton](IconButton.md)
type: "context_actions";
```

Defined in: [block-kit/blocks.ts:135](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L135)
Defined in: [block-kit/blocks.ts:143](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L143)

#### Description

Expand Down
8 changes: 4 additions & 4 deletions docs/english/reference/types/interfaces/ContextBlock.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Interface: ContextBlock

Defined in: [block-kit/blocks.ts:111](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L111)
Defined in: [block-kit/blocks.ts:118](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L118)

## Description

Expand All @@ -24,7 +24,7 @@ Displays contextual info, which can include both images and text.
optional block_id: string;
```

Defined in: [block-kit/blocks.ts:41](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L41)
Defined in: [block-kit/blocks.ts:47](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L47)

#### Description

Expand All @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`.
elements: ContextBlockElement[];
```

Defined in: [block-kit/blocks.ts:120](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L120)
Defined in: [block-kit/blocks.ts:127](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L127)

#### Description

Expand All @@ -61,7 +61,7 @@ Maximum number of items is 10.
type: "context";
```

Defined in: [block-kit/blocks.ts:115](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L115)
Defined in: [block-kit/blocks.ts:122](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L122)

#### Description

Expand Down
10 changes: 5 additions & 5 deletions docs/english/reference/types/interfaces/ConversationsSelect.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Interface: ConversationsSelect

Defined in: [block-kit/block-elements.ts:405](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L405)
Defined in: [block-kit/block-elements.ts:409](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L409)

## Description

Expand Down Expand Up @@ -63,7 +63,7 @@ with.
optional default_to_current_conversation: boolean;
```

Defined in: [block-kit/block-elements.ts:419](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L419)
Defined in: [block-kit/block-elements.ts:423](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L423)

#### Description

Expand All @@ -78,7 +78,7 @@ modal, if available. Default is `false`.
optional filter: object;
```

Defined in: [block-kit/block-elements.ts:423](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L423)
Defined in: [block-kit/block-elements.ts:427](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L427)

#### exclude\_bot\_users?

Expand Down Expand Up @@ -130,7 +130,7 @@ Defaults to `false`.
optional initial_conversation: string;
```

Defined in: [block-kit/block-elements.ts:414](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L414)
Defined in: [block-kit/block-elements.ts:418](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L418)

#### Description

Expand Down Expand Up @@ -185,7 +185,7 @@ for the message will be determined by the value of this select menu.
type: "conversations_select";
```

Defined in: [block-kit/block-elements.ts:409](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L409)
Defined in: [block-kit/block-elements.ts:413](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L413)

#### Description

Expand Down
6 changes: 3 additions & 3 deletions docs/english/reference/types/interfaces/DividerBlock.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Interface: DividerBlock

Defined in: [block-kit/blocks.ts:147](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L147)
Defined in: [block-kit/blocks.ts:155](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L155)

## Description

Expand All @@ -25,7 +25,7 @@ different blocks inside of a message. The divider block is nice and neat, requir
optional block_id: string;
```

Defined in: [block-kit/blocks.ts:41](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L41)
Defined in: [block-kit/blocks.ts:47](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L47)

#### Description

Expand All @@ -47,7 +47,7 @@ a message. If a message is updated, use a new `block_id`.
type: "divider";
```

Defined in: [block-kit/blocks.ts:151](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L151)
Defined in: [block-kit/blocks.ts:159](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L159)

#### Description

Expand Down
Loading