TemplateBuilder
Defined in: packages/template/src/builder/template.builder.ts:15
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new TemplateBuilder():
TemplateBuilder
Returns
Section titled “Returns”TemplateBuilder
Methods
Section titled “Methods”appLinkButton()
Section titled “appLinkButton()”appLinkButton(
name,options):TemplateBuilder
Defined in: packages/template/src/builder/template.builder.ts:172
Add an app link button
Parameters
Section titled “Parameters”string
options
Section titled “options”androidScheme?
Section titled “androidScheme?”string
androidUrl?
Section titled “androidUrl?”string
iosScheme?
Section titled “iosScheme?”string
iosUrl?
Section titled “iosUrl?”string
Returns
Section titled “Returns”TemplateBuilder
botKeywordButton()
Section titled “botKeywordButton()”botKeywordButton(
name):TemplateBuilder
Defined in: packages/template/src/builder/template.builder.ts:204
Add a bot keyword button
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”TemplateBuilder
build()
Section titled “build()”build():
object
Defined in: packages/template/src/builder/template.builder.ts:374
Build the final template
Returns
Section titled “Returns”object
buttons?
Section titled “buttons?”
optionalbuttons?:object[]
category
Section titled “category”category:
TemplateCategory
code:
string
content
Section titled “content”content:
string
id:
string
metadata
Section titled “metadata”metadata:
object=TemplateMetadataSchema
metadata.approvedAt?
Section titled “metadata.approvedAt?”
optionalapprovedAt?:Date
metadata.createdAt
Section titled “metadata.createdAt”createdAt:
Date
metadata.rejectedAt?
Section titled “metadata.rejectedAt?”
optionalrejectedAt?:Date
metadata.rejectionReason?
Section titled “metadata.rejectionReason?”
optionalrejectionReason?:string
metadata.updatedAt
Section titled “metadata.updatedAt”updatedAt:
Date
metadata.usage
Section titled “metadata.usage”usage:
object=TemplateUsageStatsSchema
metadata.usage.delivered
Section titled “metadata.usage.delivered”delivered:
number
metadata.usage.failed
Section titled “metadata.usage.failed”failed:
number
metadata.usage.sent
Section titled “metadata.usage.sent”sent:
number
name:
string
provider
Section titled “provider”provider:
string
status
Section titled “status”status:
TemplateStatus
variables?
Section titled “variables?”
optionalvariables?:object[]
button()
Section titled “button()”button(
button):TemplateBuilder
Defined in: packages/template/src/builder/template.builder.ts:224
Add a custom button
Parameters
Section titled “Parameters”button
Section titled “button”linkAndroid?
Section titled “linkAndroid?”string = ...
linkIos?
Section titled “linkIos?”string = ...
linkMobile?
Section titled “linkMobile?”string = ...
linkPc?
Section titled “linkPc?”string = ...
string = ...
schemeAndroid?
Section titled “schemeAndroid?”string = ...
schemeIos?
Section titled “schemeIos?”string = ...
"WL" | "AL" | "DS" | "BK" | "MD" = ...
Returns
Section titled “Returns”TemplateBuilder
category()
Section titled “category()”category(
category):TemplateBuilder
Defined in: packages/template/src/builder/template.builder.ts:68
Set template category
Parameters
Section titled “Parameters”category
Section titled “category”Returns
Section titled “Returns”TemplateBuilder
clearButtons()
Section titled “clearButtons()”clearButtons():
TemplateBuilder
Defined in: packages/template/src/builder/template.builder.ts:240
Clear all buttons
Returns
Section titled “Returns”TemplateBuilder
clone()
Section titled “clone()”clone():
TemplateBuilder
Defined in: packages/template/src/builder/template.builder.ts:347
Clone the current builder
Returns
Section titled “Returns”TemplateBuilder
code()
Section titled “code()”code(
code):TemplateBuilder
Defined in: packages/template/src/builder/template.builder.ts:38
Set template code (provider specific)
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”TemplateBuilder
content()
Section titled “content()”content(
content):TemplateBuilder
Defined in: packages/template/src/builder/template.builder.ts:46
Set template content with variables
Parameters
Section titled “Parameters”content
Section titled “content”string
Returns
Section titled “Returns”TemplateBuilder
deliveryButton()
Section titled “deliveryButton()”deliveryButton(
name):TemplateBuilder
Defined in: packages/template/src/builder/template.builder.ts:194
Add a delivery tracking button
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”TemplateBuilder
messageDeliveryButton()
Section titled “messageDeliveryButton()”messageDeliveryButton(
name):TemplateBuilder
Defined in: packages/template/src/builder/template.builder.ts:214
Add a message delivery button
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”TemplateBuilder
metadata()
Section titled “metadata()”metadata(
metadata):TemplateBuilder
Defined in: packages/template/src/builder/template.builder.ts:248
Set template metadata
Parameters
Section titled “Parameters”metadata
Section titled “metadata”Partial<AlimTalkTemplate["metadata"]>
Returns
Section titled “Returns”TemplateBuilder
name()
Section titled “name()”name(
name):TemplateBuilder
Defined in: packages/template/src/builder/template.builder.ts:30
Set template name
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”TemplateBuilder
preview()
Section titled “preview()”preview(
sampleVariables?):string
Defined in: packages/template/src/builder/template.builder.ts:291
Preview the template with sample variables
Parameters
Section titled “Parameters”sampleVariables?
Section titled “sampleVariables?”Record<string, any> = {}
Returns
Section titled “Returns”string
provider()
Section titled “provider()”provider(
provider):TemplateBuilder
Defined in: packages/template/src/builder/template.builder.ts:76
Set template provider
Parameters
Section titled “Parameters”provider
Section titled “provider”string
Returns
Section titled “Returns”TemplateBuilder
reset()
Section titled “reset()”reset():
TemplateBuilder
Defined in: packages/template/src/builder/template.builder.ts:357
Reset the builder to start fresh
Returns
Section titled “Returns”TemplateBuilder
status()
Section titled “status()”status(
status):TemplateBuilder
Defined in: packages/template/src/builder/template.builder.ts:84
Set template status
Parameters
Section titled “Parameters”status
Section titled “status”Returns
Section titled “Returns”TemplateBuilder
validate()
Section titled “validate()”validate():
object
Defined in: packages/template/src/builder/template.builder.ts:266
Validate the current template
Returns
Section titled “Returns”object
errors
Section titled “errors”errors:
string[]
isValid
Section titled “isValid”isValid:
boolean
warnings
Section titled “warnings”warnings:
string[]
variable()
Section titled “variable()”variable(
name,type?,required?,options?):TemplateBuilder
Defined in: packages/template/src/builder/template.builder.ts:92
Add a variable definition
Parameters
Section titled “Parameters”string
"string" | "number" | "date" | "custom"
required?
Section titled “required?”boolean = true
options?
Section titled “options?”description?
Section titled “description?”string
example?
Section titled “example?”string
format?
Section titled “format?”string
maxLength?
Section titled “maxLength?”number
Returns
Section titled “Returns”TemplateBuilder
variables()
Section titled “variables()”variables(
variables):TemplateBuilder
Defined in: packages/template/src/builder/template.builder.ts:126
Add multiple variables at once
Parameters
Section titled “Parameters”variables
Section titled “variables”object[]
Returns
Section titled “Returns”TemplateBuilder
webLinkButton()
Section titled “webLinkButton()”webLinkButton(
name,mobileUrl?,pcUrl?):TemplateBuilder
Defined in: packages/template/src/builder/template.builder.ts:156
Add a web link button
Parameters
Section titled “Parameters”string
mobileUrl?
Section titled “mobileUrl?”string
pcUrl?
Section titled “pcUrl?”string
Returns
Section titled “Returns”TemplateBuilder