speedybot / Exports / SpeedyCard

Class: SpeedyCard

Card Builder

This is a utility that makes it convenient to build + pass data to Adaptive Cards

Note: This extends Adaptive Card functionality to include "chips" which when tapped will trigger your text handling logic

You can add "pickers" for date, time, select (and multi-select)

Table of contents

Constructors

• constructor

Properties

• tools

Methods

• addAction
• addBlock
• addButton
• addChip
• addChips
• addDeleteButton
• addHeader
• addImage
• addLink
• addLinkButton
• addMultiSelect
• addPickerDate
• addPickerDropdown
• addPickerTime
• addSingleSelect
• addSubcard
• addSubtitle
• addTable
• addText
• addTextInput
• addTextarea
• addTitle
• attachData
• build
• needsSubmit
• setBackgroundImage
• setSubmitButtonTitle
• survey

Constructors

constructor

• new SpeedyCard()

Defined in

cards.ts:281

Properties

tools

• tools: Object

Type declaration

Name	Type
checkColor	(candidate: string) => BaseColors

Defined in

cards.ts:217

Methods

addAction

▸ Private addAction(a): void

Parameters

Name	Type
a	any

Returns

void

Defined in

cards.ts:748

---

addBlock

▸ addBlock(content, config?): SpeedyCard

Parameters

Name	Type
content	string | SpeedyCard
config	Object
config.backgroundColor?	ColorChoices
config.separator?	boolean
config.vertAlign?	VAlignChoices

Returns

SpeedyCard

Defined in

cards.ts:521

---

addButton

▸ addButton(label, id?, attachedData?): SpeedyCard

Parameters

Name	Type	Default value
label	string	undefined
id	string	"button_result"
attachedData	string | { [key: string]: number | string | boolean; }	{}

Returns

SpeedyCard

Defined in

cards.ts:763

---

addChip

▸ addChip(payload, id?): SpeedyCard

Parameters

Name	Type	Default value
payload	string | { title: string ; value?: string }	undefined
id	string	CONSTANTS.CHIP_LABEL

Returns

SpeedyCard

Defined in

cards.ts:315

---

addChips

▸ addChips(chips, id?): SpeedyCard

Parameters

Name	Type	Default value
chips	(string | { title: string ; value?: string })[]	undefined
id	string	CONSTANTS.CHIP_LABEL

Returns

SpeedyCard

Defined in

cards.ts:322

---

addDeleteButton

▸ addDeleteButton(label?): SpeedyCard

Parameters

Name	Type	Default value
label	string	CONSTANTS.destroyLabel

Returns

SpeedyCard

Defined in

cards.ts:755

---

addHeader

▸ addHeader(text, config?): SpeedyCard

Parameters

Name	Type
text	string
config	HeaderConfig

Returns

SpeedyCard

Defined in

cards.ts:455

---

addImage

▸ addImage(url, config?): SpeedyCard

Parameters

Name	Type
url	string
config	Object
config.align?	AlignmentChoices
config.size?	SizeChoices
config.targetURL?	string

Returns

SpeedyCard

Defined in

cards.ts:358

---

addLink

▸ addLink(url, label?): SpeedyCard

Parameters

Name	Type
url	string
label?	string

Returns

SpeedyCard

Defined in

cards.ts:388

---

addLinkButton

▸ addLinkButton(url, label?): SpeedyCard

Parameters

Name	Type
url	string
label?	string

Returns

SpeedyCard

Defined in

cards.ts:392

---

addMultiSelect

▸ addMultiSelect(choices, id?): SpeedyCard

Parameters

Name	Type	Default value
choices	(string | number)[] | { title: string ; value: string }[]	undefined
id	string	"addMultiSelect_result"

Returns

SpeedyCard

Defined in

cards.ts:612

---

addPickerDate

▸ addPickerDate(textLabel, id?): SpeedyCard

Parameters

Name	Type	Default value
textLabel	string	undefined
id	string	"addPickerDate_result"

Returns

SpeedyCard

Defined in

cards.ts:660

---

addPickerDropdown

▸ addPickerDropdown(choices, id?): SpeedyCard

Parameters

Name	Type	Default value
choices	(string | number | { title: string ; value: string | number })[]	undefined
id	string	SpeedyCardId.dropdown

Returns

SpeedyCard

Defined in

cards.ts:575

---

addPickerTime

▸ addPickerTime(textLabel, id?): SpeedyCard

Parameters

Name	Type	Default value
textLabel	string	undefined
id	string	"addPickerTime_result"

Returns

SpeedyCard

Defined in

cards.ts:672

---

addSingleSelect

▸ addSingleSelect(choices, id?): SpeedyCard

Parameters

Name	Type	Default value
choices	(string | number)[] | { title: string ; value: string }[]	undefined
id	string	"addSingleSelectresult"

Returns

SpeedyCard

Defined in

cards.ts:602

---

addSubcard

▸ addSubcard(card, textLabel?): SpeedyCard

Parameters

Name	Type	Default value
card	Card | SpeedyCard	undefined
textLabel	string	""

Returns

SpeedyCard

Defined in

cards.ts:561

---

addSubtitle

▸ addSubtitle(subTitle): SpeedyCard

Parameters

Name	Type
subTitle	string

Returns

SpeedyCard

Defined in

cards.ts:288

---

addTable

▸ addTable(input, separator?): SpeedyCard

Parameters

Name	Type	Default value
input	(string | number)[][] | { [key: string]: string | number; }	undefined
separator	boolean	false

Returns

SpeedyCard

Defined in

cards.ts:293

---

addText

▸ addText(text, config?): SpeedyCard

Parameters

Name	Type
text	string
config	Object
config.align?	AlignmentChoices
config.backgroundColor?	ColorChoices
config.bold?	boolean
config.color?	ColorChoices
config.size?	SizeChoices
config.vertAlign?	VAlignChoices

Returns

SpeedyCard

Defined in

cards.ts:406

---

addTextInput

▸ addTextInput(placeholder, id?): SpeedyCard

Parameters

Name	Type	Default value
placeholder	string	undefined
id	string	"addTextInput_result"

Returns

SpeedyCard

Defined in

cards.ts:685

---

addTextarea

▸ addTextarea(placeholder, id?): SpeedyCard

Parameters

Name	Type	Default value
placeholder	string	undefined
id	string	"addTextarea_result"

Returns

SpeedyCard

Defined in

cards.ts:698

---

addTitle

▸ addTitle(title): SpeedyCard

Parameters

Name	Type
title	string

Returns

SpeedyCard

Defined in

cards.ts:283

---

attachData

▸ attachData(payload): SpeedyCard

Parameters

Name	Type
payload	AttachedData

Returns

SpeedyCard

Defined in

cards.ts:723

---

build

▸ build(): any

Returns

any

Defined in

cards.ts:817

---

needsSubmit

▸ needsSubmit(): boolean

Returns

boolean

Defined in

cards.ts:263

---

setBackgroundImage

▸ setBackgroundImage(url): SpeedyCard

Parameters

Name	Type
url	string

Returns

SpeedyCard

Defined in

cards.ts:712

---

setSubmitButtonTitle

▸ setSubmitButtonTitle(label): SpeedyCard

Parameters

Name	Type
label	string

Returns

SpeedyCard

Defined in

cards.ts:717

---

survey

▸ survey(questions, title?): SpeedyCard

Parameters

Name	Type	Default value
questions	SurveyQuestion[]	undefined
title	string	"📝 Survey"

Returns

SpeedyCard

Defined in

cards.ts:779