Enumeration: ParameterType¶
Defined in: api_types.ts:139
Enumeration of types of formula parameters. These describe semantic value types (as opposed to JavaScript value types).
Enumeration Members¶
Boolean¶
Boolean:
"boolean"
Defined in: api_types.ts:151
Indicates a parameter that is a boolean value.
BooleanArray¶
BooleanArray:
"booleanArray"
Defined in: api_types.ts:196
Indicates a parameter that is a list of boolean values.
Date¶
Date:
"date"
Defined in: api_types.ts:155
Indicates a parameter that is a date value (which includes time and datetime values).
DateArray¶
DateArray:
"dateArray"
Defined in: api_types.ts:217
Indicates a parameter that is a list of date values (which includes time and datetime values).
Currently, when such a parameter is used with a sync table formula or an action formula (BaseFormulaDef.isAction), which will generate a builder UI for selecting parameters, a date array parameter will always render as a date range selector. A date range will always be passed to a pack formula as a list of two elements, the beginning of the range and the end of the range.
Email¶
Email:
"email"
Defined in: api_types.ts:175
Indicates a parameter that is an email value.
EmailArray¶
EmailArray:
"emailArray"
Defined in: api_types.ts:204
Indicates a parameter that is a list of email values.
File¶
File:
"file"
Defined in: api_types.ts:167
Indicates a parameter that is a file. The pack is passed a file URL.
FileArray¶
FileArray:
"fileArray"
Defined in: api_types.ts:241
Indicates a parameter that is a list of file values. The pack is passed a list of file URLs.
Html¶
Html:
"html"
Defined in: api_types.ts:159
Indicates a parameter that is a rich text value that should be passed to the pack as HTML.
HtmlArray¶
HtmlArray:
"htmlArray`"
Defined in: api_types.ts:225
Indicates a parameter that is a list of rich text values that should be passed to the pack as HTML.
Image¶
Image:
"image"
Defined in: api_types.ts:163
Indicates a parameter that is an image. The pack is passed an image URL.
ImageArray¶
ImageArray:
"imageArray"
Defined in: api_types.ts:233
Indicates a parameter that is a list of image values. The pack is passed a list of image URLs.
Markdown¶
Markdown:
"markdown"
Defined in: api_types.ts:171
Indicates a parameter that is a rich text value that should be passed to the pack as Markdown.
MarkdownArray¶
MarkdownArray:
"markdownArray`"
Defined in: api_types.ts:250
Indicates a parameter that is a list of rich text values that should be passed to the pack as Markdown.
Number¶
Number:
"number"
Defined in: api_types.ts:147
Indicates a parameter that is a number value.
NumberArray¶
NumberArray:
"numberArray"
Defined in: api_types.ts:188
Indicates a parameter that is a list of Superhuman Docs number values.
SparseBooleanArray¶
SparseBooleanArray:
"sparseBooleanArray"
Defined in: api_types.ts:200
BooleanArray that accepts unparsable values as undefined.
SparseDateArray¶
SparseDateArray:
"sparseDateArray"
Defined in: api_types.ts:221
DateArray that accepts unparsable values as undefined.
SparseEmailArray¶
SparseEmailArray:
"sparseEmailArray"
Defined in: api_types.ts:208
EmailArray that accepts unparsable values as undefined.
SparseFileArray¶
SparseFileArray:
"sparseFileArray"
Defined in: api_types.ts:245
FileArray that accepts unparsable values as undefined.
SparseHtmlArray¶
SparseHtmlArray:
"sparseHtmlArray"
Defined in: api_types.ts:229
HtmlArray that accepts unparsable values as undefined.
SparseImageArray¶
SparseImageArray:
"sparseImageArray"
Defined in: api_types.ts:237
ImageArray that accepts unparsable values as undefined.
SparseMarkdownArray¶
SparseMarkdownArray:
"sparseMarkdownArray"
Defined in: api_types.ts:254
MarkdownArray that accepts unparsable values as undefined.
SparseNumberArray¶
SparseNumberArray:
"sparseNumberArray"
Defined in: api_types.ts:192
NumberArray that accepts unparsable values as undefined.
SparseStringArray¶
SparseStringArray:
"sparseStringArray"
Defined in: api_types.ts:184
StringArray that accepts unparsable values as undefined.
String¶
String:
"string"
Defined in: api_types.ts:143
Indicates a parameter that is a text value.
StringArray¶
StringArray:
"stringArray"
Defined in: api_types.ts:180
Indicates a parameter that is a list of text values.