Skip to content

Commit 199a3eb

Browse files
authored
docs: link to streaming methods and context actions block reference (#2429)
1 parent b45dd73 commit 199a3eb

File tree

3 files changed

+8
-0
lines changed

3 files changed

+8
-0
lines changed

packages/types/src/block-kit/block-elements.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,10 +144,12 @@ export interface EmailInput extends Actionable, Dispatchable, Focusable, Placeho
144144
export interface FeedbackButtons extends Actionable {
145145
/**
146146
* @description The type of block. For a feedback buttons block, `type` is always `feedback_buttons`.
147+
* @see {@link https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element Feedback buttons element reference}.
147148
*/
148149
type: 'feedback_buttons';
149150
/**
150151
* @description A button to indicate positive feedback.
152+
* @see {@link https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element/#button-object-fields Feedback buttons object fields reference}.
151153
*/
152154
positive_button: {
153155
/**
@@ -166,6 +168,7 @@ export interface FeedbackButtons extends Actionable {
166168
};
167169
/**
168170
* @description A button to indicate negative feedback.
171+
* @see {@link https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element/#button-object-fields Feedback buttons object fields reference}.
169172
*/
170173
negative_button: {
171174
/**
@@ -209,6 +212,7 @@ export interface FileInput extends Actionable {
209212

210213
/**
211214
* @description An icon button to perform actions.
215+
* @see {@link https://docs.slack.dev/reference/block-kit/block-elements/icon-button-element Icon button element reference}.
212216
*/
213217
export interface IconButton extends Actionable, Confirmable {
214218
/**

packages/types/src/block-kit/blocks.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ export type ContextActionsBlockElement = FeedbackButtons | IconButton;
127127

128128
/**
129129
* @description Displays actions as contextual info, which can include both feedback buttons and icon buttons.
130+
* @see {@link https://docs.slack.dev/reference/block-kit/blocks/context-actions-block Context actions block reference}.
130131
*/
131132
export interface ContextActionsBlock extends Block {
132133
/**

packages/web-api/src/methods.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1571,6 +1571,7 @@ export abstract class Methods extends EventEmitter<WebClientEvent> {
15711571
public readonly chat = {
15721572
/**
15731573
* @description Appends text to an existing streaming conversation.
1574+
* @see {@link https://docs.slack.dev/reference/methods/chat.appendStream `chat.appendStream` API reference}.
15741575
*/
15751576
appendStream: bindApiCall<ChatAppendStreamArguments, ChatAppendStreamResponse>(this, 'chat.appendStream'),
15761577
/**
@@ -1626,10 +1627,12 @@ export abstract class Methods extends EventEmitter<WebClientEvent> {
16261627
},
16271628
/**
16281629
* @description Starts a new streaming conversation.
1630+
* @see {@link https://docs.slack.dev/reference/methods/chat.startStream `chat.startStream` API reference}.
16291631
*/
16301632
startStream: bindApiCall<ChatStartStreamArguments, ChatStartStreamResponse>(this, 'chat.startStream'),
16311633
/**
16321634
* @description Stops a streaming conversation.
1635+
* @see {@link https://docs.slack.dev/reference/methods/chat.stopStream `chat.stopStream` API reference}.
16331636
*/
16341637
stopStream: bindApiCall<ChatStopStreamArguments, ChatStopStreamResponse>(this, 'chat.stopStream'),
16351638
/**

0 commit comments

Comments
 (0)