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
8 changes: 8 additions & 0 deletions docs/english/reference/types/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
- [ChannelUnarchiveMessageEvent](interfaces/ChannelUnarchiveMessageEvent.md)
- [ChannelUnsharedEvent](interfaces/ChannelUnsharedEvent.md)
- [Checkboxes](interfaces/Checkboxes.md)
- [Chunk](interfaces/Chunk.md)
- [~~Confirm~~](interfaces/Confirm.md)
- [Confirmable](interfaces/Confirmable.md)
- [Confirmation](interfaces/Confirmation.md)
Expand Down Expand Up @@ -124,6 +125,7 @@
- [LinkSharedEvent](interfaces/LinkSharedEvent.md)
- [LinkUnfurls](interfaces/LinkUnfurls.md)
- [MarkdownBlock](interfaces/MarkdownBlock.md)
- [MarkdownTextChunk](interfaces/MarkdownTextChunk.md)
- [MaxItemsSelectable](interfaces/MaxItemsSelectable.md)
- [MemberJoinedChannelEvent](interfaces/MemberJoinedChannelEvent.md)
- [MemberLeftChannelEvent](interfaces/MemberLeftChannelEvent.md)
Expand Down Expand Up @@ -155,6 +157,8 @@
- [PlainTextElement](interfaces/PlainTextElement.md)
- [PlainTextInput](interfaces/PlainTextInput.md)
- [PlainTextOption](interfaces/PlainTextOption.md)
- [PlanBlock](interfaces/PlanBlock.md)
- [PlanUpdateChunk](interfaces/PlanUpdateChunk.md)
- [RadioButtons](interfaces/RadioButtons.md)
- [RawTextElement](interfaces/RawTextElement.md)
- [ReactionAddedEvent](interfaces/ReactionAddedEvent.md)
Expand Down Expand Up @@ -194,7 +198,9 @@
- [SubteamSelfRemovedEvent](interfaces/SubteamSelfRemovedEvent.md)
- [SubteamUpdatedEvent](interfaces/SubteamUpdatedEvent.md)
- [TableBlock](interfaces/TableBlock.md)
- [TaskCardBlock](interfaces/TaskCardBlock.md)
- [TaskEntityFields](interfaces/TaskEntityFields.md)
- [TaskUpdateChunk](interfaces/TaskUpdateChunk.md)
- [TeamAccessGrantedEvent](interfaces/TeamAccessGrantedEvent.md)
- [TeamAccessRevokedEvent](interfaces/TeamAccessRevokedEvent.md)
- [TeamDomainChangeEvent](interfaces/TeamDomainChangeEvent.md)
Expand All @@ -206,6 +212,7 @@
- [UrlImageObject](interfaces/UrlImageObject.md)
- [URLInput](interfaces/URLInput.md)
- [URLRespondable](interfaces/URLRespondable.md)
- [URLSourceElement](interfaces/URLSourceElement.md)
- [UserChangeEvent](interfaces/UserChangeEvent.md)
- [UserHuddleChangedEvent](interfaces/UserHuddleChangedEvent.md)
- [UserProfileChangedEvent](interfaces/UserProfileChangedEvent.md)
Expand All @@ -226,6 +233,7 @@
- [AllMessageEvents](type-aliases/AllMessageEvents.md)
- [AllMessageMetadataEvents](type-aliases/AllMessageMetadataEvents.md)
- [AnyBlock](type-aliases/AnyBlock.md)
- [AnyChunk](type-aliases/AnyChunk.md)
- [CallUser](type-aliases/CallUser.md)
- [ColorScheme](type-aliases/ColorScheme.md)
- [ContextActionsBlockElement](type-aliases/ContextActionsBlockElement.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:96](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L96)
Defined in: [block-kit/blocks.ts:99](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L99)

## Description

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

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

#### 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:105](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L105)
Defined in: [block-kit/blocks.ts:108](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L108)

#### 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:100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L100)
Defined in: [block-kit/blocks.ts:103](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L103)

#### Description

Expand Down
8 changes: 5 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:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L35)
Defined in: [block-kit/blocks.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L36)

## Extended by

Expand All @@ -17,6 +17,8 @@ Defined in: [block-kit/blocks.ts:35](https://github.com/slackapi/node-slack-sdk/
- [`RichTextBlock`](RichTextBlock.md)
- [`SectionBlock`](SectionBlock.md)
- [`TableBlock`](TableBlock.md)
- [`TaskCardBlock`](TaskCardBlock.md)
- [`PlanBlock`](PlanBlock.md)
- [`VideoBlock`](VideoBlock.md)

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

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

#### Description

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

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

#### Description

Expand Down
24 changes: 24 additions & 0 deletions docs/english/reference/types/interfaces/Chunk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[@slack/types](../index.md) / Chunk

# Interface: Chunk

Defined in: [chunk.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/chunk.ts#L6)

Base interface for streaming message chunks.
https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming

## Extended by

- [`MarkdownTextChunk`](MarkdownTextChunk.md)
- [`PlanUpdateChunk`](PlanUpdateChunk.md)
- [`TaskUpdateChunk`](TaskUpdateChunk.md)

## Properties

### type

```ts
type: string;
```

Defined in: [chunk.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/chunk.ts#L7)
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Interface: ContextActionsBlock

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:142](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L142)

## Description

Expand All @@ -24,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:47](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L47)
Defined in: [block-kit/blocks.ts:48](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L48)

#### Description

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

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:150](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L150)

#### Description

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

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

#### 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:118](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L118)
Defined in: [block-kit/blocks.ts:121](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L121)

## 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:47](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L47)
Defined in: [block-kit/blocks.ts:48](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L48)

#### 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:127](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L127)
Defined in: [block-kit/blocks.ts:130](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L130)

#### Description

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

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

#### Description

Expand Down
2 changes: 1 addition & 1 deletion docs/english/reference/types/interfaces/Dialog.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ optional selected_options: SelectOption[];
#### ~~subtype?~~

```ts
optional subtype: "number" | "email" | "tel" | "url";
optional subtype: "number" | "url" | "email" | "tel";
```

#### ~~type~~
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:155](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L155)
Defined in: [block-kit/blocks.ts:158](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L158)

## 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:47](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L47)
Defined in: [block-kit/blocks.ts:48](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L48)

#### 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:159](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L159)
Defined in: [block-kit/blocks.ts:162](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L162)

#### Description

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

# Interface: FileBlock

Defined in: [block-kit/blocks.ts:169](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L169)
Defined in: [block-kit/blocks.ts:172](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L172)

## Description

Expand All @@ -27,7 +27,7 @@ that contain remote files. If you want to add remote files to messages,
optional block_id: string;
```

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

#### Description

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

Defined in: [block-kit/blocks.ts:181](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L181)
Defined in: [block-kit/blocks.ts:184](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L184)

#### Description

Expand All @@ -63,7 +63,7 @@ The external unique ID for this file.
source: string;
```

Defined in: [block-kit/blocks.ts:177](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L177)
Defined in: [block-kit/blocks.ts:180](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L180)

#### Description

Expand All @@ -77,7 +77,7 @@ At the moment, source will always be `remote` for a remote file.
type: "file";
```

Defined in: [block-kit/blocks.ts:173](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L173)
Defined in: [block-kit/blocks.ts:176](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L176)

#### Description

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

# Interface: HeaderBlock

Defined in: [block-kit/blocks.ts:189](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L189)
Defined in: [block-kit/blocks.ts:192](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L192)

## Description

Expand All @@ -25,7 +25,7 @@ font. Use it to delineate between different groups of content in your app's surf
optional block_id: string;
```

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

#### Description

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

Defined in: [block-kit/blocks.ts:198](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L198)
Defined in: [block-kit/blocks.ts:201](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L201)

#### Description

Expand All @@ -62,7 +62,7 @@ Maximum length for the text in this field is 150 characters.
type: "header";
```

Defined in: [block-kit/blocks.ts:193](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L193)
Defined in: [block-kit/blocks.ts:196](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L196)

#### Description

Expand Down
Loading