Class BlockBuilder

Deprecated

please prefer the rocket.chat/ui-kit components

Hierarchy

BlockBuilder

Index

Constructors

Methods

addActionsBlock addConditionalBlock addContextBlock addDividerBlock addImageBlock addInputBlock addSectionBlock getBlocks newButtonElement newImageElement newMarkdownTextObject newMultiStaticElement newOverflowMenuElement newPlainTextInputElement newPlainTextObject newStaticSelectElement

Constructors

constructor

new BlockBuilder(appId): BlockBuilder
Parameters
- appId: string
Returns BlockBuilder
- Defined in src/definition/uikit/blocks/BlockBuilder.ts:46

Methods

addActionsBlock

addActionsBlock(block): BlockBuilder
Parameters
- block: ActionsBlockParam
Returns BlockBuilder
- Defined in src/definition/uikit/blocks/BlockBuilder.ts:68

addConditionalBlock

addConditionalBlock(innerBlocks, condition?): BlockBuilder
Parameters
- innerBlocks: IBlock[] | BlockBuilder
- Optional condition: IConditionalBlockFilters
Returns BlockBuilder
- Defined in src/definition/uikit/blocks/BlockBuilder.ts:86

addContextBlock

addContextBlock(block): BlockBuilder
Parameters
- block: ContextBlockParam
Returns BlockBuilder
- Defined in src/definition/uikit/blocks/BlockBuilder.ts:74

addDividerBlock

addDividerBlock(): BlockBuilder
Returns BlockBuilder
- Defined in src/definition/uikit/blocks/BlockBuilder.ts:62

addImageBlock

addImageBlock(block): BlockBuilder
Parameters
- block: ImageBlockParam
Returns BlockBuilder
- Defined in src/definition/uikit/blocks/BlockBuilder.ts:56

addInputBlock

addInputBlock(block): BlockBuilder
Parameters
- block: InputBlockParam
Returns BlockBuilder
- Defined in src/definition/uikit/blocks/BlockBuilder.ts:80

addSectionBlock

addSectionBlock(block): BlockBuilder
Parameters
- block: SectionBlockParam
Returns BlockBuilder
- Defined in src/definition/uikit/blocks/BlockBuilder.ts:50

getBlocks

getBlocks(): IBlock[]
Returns IBlock[]
- Defined in src/definition/uikit/blocks/BlockBuilder.ts:94

newButtonElement

newButtonElement(info): IButtonElement
Parameters
- info: Omit<IButtonElement, "type" | "actionId"> | Partial<Pick<IButtonElement, "actionId">>
Returns IButtonElement
- Defined in src/definition/uikit/blocks/BlockBuilder.ts:113

newImageElement

newImageElement(info): IImageElement
Parameters
- info: Omit<IImageElement, "type">
Returns IImageElement
- Defined in src/definition/uikit/blocks/BlockBuilder.ts:120

newMarkdownTextObject

newMarkdownTextObject(text): ITextObject
Parameters
- text: string
Returns ITextObject
- Defined in src/definition/uikit/blocks/BlockBuilder.ts:106

newMultiStaticElement

newMultiStaticElement(info): IMultiStaticSelectElement
Parameters
- info: Omit<IMultiStaticSelectElement, "type" | "actionId"> | Partial<Pick<IMultiStaticSelectElement, "actionId">>
Returns IMultiStaticSelectElement
- Defined in src/definition/uikit/blocks/BlockBuilder.ts:148

newOverflowMenuElement

newOverflowMenuElement(info): IOverflowMenuElement
Parameters
- info: Omit<IOverflowMenuElement, "type" | "actionId"> | Partial<Pick<IOverflowMenuElement, "actionId">>
Returns IOverflowMenuElement
- Defined in src/definition/uikit/blocks/BlockBuilder.ts:127

newPlainTextInputElement

newPlainTextInputElement(info): IPlainTextInputElement
Parameters
- info: Omit<IPlainTextInputElement, "type" | "actionId"> | Partial<Pick<IPlainTextInputElement, "actionId">>
Returns IPlainTextInputElement
- Defined in src/definition/uikit/blocks/BlockBuilder.ts:134

newPlainTextObject

newPlainTextObject(text, emoji?): ITextObject
Parameters
- text: string
- emoji: boolean = false
Returns ITextObject
- Defined in src/definition/uikit/blocks/BlockBuilder.ts:98

newStaticSelectElement

newStaticSelectElement(info): IStaticSelectElement
Parameters
- info: Omit<IStaticSelectElement, "type" | "actionId"> | Partial<Pick<IStaticSelectElement, "actionId">>
Returns IStaticSelectElement
- Defined in src/definition/uikit/blocks/BlockBuilder.ts:141

Generated using TypeDoc