Class BlockBuilder

Hierarchy

BlockBuilder

Index

Constructors

constructor

Methods

Constructors

constructor

new BlockBuilder(appId: string): BlockBuilder

- Defined in src/definition/uikit/blocks/BlockBuilder.ts:37
Parameters
- appId: string
Returns BlockBuilder

Methods

addActionsBlock

addActionsBlock(block: Pick<IActionsBlock, "appId" | "blockId" | "elements">): BlockBuilder

- Defined in src/definition/uikit/blocks/BlockBuilder.ts:61
Parameters
- block: Pick<IActionsBlock, "appId" | "blockId" | "elements">
Returns BlockBuilder

addConditionalBlock

addConditionalBlock(innerBlocks: BlockBuilder | IBlock[], condition?: IConditionalBlockFilters): BlockBuilder

- Defined in src/definition/uikit/blocks/BlockBuilder.ts:79
Parameters
- innerBlocks: BlockBuilder | IBlock[]
- Optional condition: IConditionalBlockFilters
Returns BlockBuilder

addContextBlock

addContextBlock(block: Pick<IContextBlock, "appId" | "blockId" | "elements">): BlockBuilder

- Defined in src/definition/uikit/blocks/BlockBuilder.ts:67
Parameters
- block: Pick<IContextBlock, "appId" | "blockId" | "elements">
Returns BlockBuilder

addDividerBlock

addDividerBlock(): BlockBuilder

- Defined in src/definition/uikit/blocks/BlockBuilder.ts:55
Returns BlockBuilder

addImageBlock

addImageBlock(block: Pick<IImageBlock, "appId" | "title" | "blockId" | "imageUrl" | "altText">): BlockBuilder

- Defined in src/definition/uikit/blocks/BlockBuilder.ts:49
Parameters
- block: Pick<IImageBlock, "appId" | "title" | "blockId" | "imageUrl" | "altText">
Returns BlockBuilder

addInputBlock

addInputBlock(block: Pick<IInputBlock, "appId" | "blockId" | "element" | "label" | "optional">): BlockBuilder

- Defined in src/definition/uikit/blocks/BlockBuilder.ts:73
Parameters
- block: Pick<IInputBlock, "appId" | "blockId" | "element" | "label" | "optional">
Returns BlockBuilder

addSectionBlock

addSectionBlock(block: Pick<ISectionBlock, "appId" | "text" | "accessory" | "blockId">): BlockBuilder

- Defined in src/definition/uikit/blocks/BlockBuilder.ts:43
Parameters
- block: Pick<ISectionBlock, "appId" | "text" | "accessory" | "blockId">
Returns BlockBuilder

getBlocks

getBlocks(): IBlock[]

- Defined in src/definition/uikit/blocks/BlockBuilder.ts:87
Returns IBlock[]

newButtonElement

newButtonElement(info: Pick<IButtonElement, "text" | "value" | "url" | "style"> | Partial<Pick<IButtonElement, "actionId">>): IButtonElement

- Defined in src/definition/uikit/blocks/BlockBuilder.ts:106
Parameters
- info: Pick<IButtonElement, "text" | "value" | "url" | "style"> | Partial<Pick<IButtonElement, "actionId">>
Returns IButtonElement

newImageElement

newImageElement(info: Pick<IImageElement, "imageUrl" | "altText">): IImageElement

- Defined in src/definition/uikit/blocks/BlockBuilder.ts:113
Parameters
- info: Pick<IImageElement, "imageUrl" | "altText">
Returns IImageElement

newMarkdownTextObject

newMarkdownTextObject(text: string): ITextObject

- Defined in src/definition/uikit/blocks/BlockBuilder.ts:99
Parameters
- text: string
Returns ITextObject

newMultiStaticElement

newMultiStaticElement(info: Pick<IMultiStaticSelectElement, "options" | "initialValue" | "placeholder"> | Partial<Pick<IMultiStaticSelectElement, "actionId">>): IMultiStaticSelectElement

- Defined in src/definition/uikit/blocks/BlockBuilder.ts:141
Parameters
- info: Pick<IMultiStaticSelectElement, "options" | "initialValue" | "placeholder"> | Partial<Pick<IMultiStaticSelectElement, "actionId">>
Returns IMultiStaticSelectElement

newOverflowMenuElement

newOverflowMenuElement(info: Pick<IOverflowMenuElement, "options"> | Partial<Pick<IOverflowMenuElement, "actionId">>): IOverflowMenuElement

- Defined in src/definition/uikit/blocks/BlockBuilder.ts:120
Parameters
- info: Pick<IOverflowMenuElement, "options"> | Partial<Pick<IOverflowMenuElement, "actionId">>
Returns IOverflowMenuElement

newPlainTextInputElement

newPlainTextInputElement(info: Pick<IPlainTextInputElement, "initialValue" | "multiline" | "placeholder"> | Partial<Pick<IPlainTextInputElement, "actionId">>): IPlainTextInputElement

- Defined in src/definition/uikit/blocks/BlockBuilder.ts:127
Parameters
- info: Pick<IPlainTextInputElement, "initialValue" | "multiline" | "placeholder"> | Partial<Pick<IPlainTextInputElement, "actionId">>
Returns IPlainTextInputElement

newPlainTextObject

newPlainTextObject(text: string, emoji?: boolean): ITextObject

- Defined in src/definition/uikit/blocks/BlockBuilder.ts:91
Parameters
- text: string
- emoji: boolean = false
Returns ITextObject

newStaticSelectElement

newStaticSelectElement(info: Pick<IStaticSelectElement, "options" | "initialValue" | "placeholder"> | Partial<Pick<IStaticSelectElement, "actionId">>): IStaticSelectElement

- Defined in src/definition/uikit/blocks/BlockBuilder.ts:134
Parameters
- info: Pick<IStaticSelectElement, "options" | "initialValue" | "placeholder"> | Partial<Pick<IStaticSelectElement, "actionId">>
Returns IStaticSelectElement

Generated using TypeDoc