LiveEvent object.
Extends
Constructors
new LiveEventBuilder()
new LiveEventBuilder():LiveEventBuilder
Returns
LiveEventBuilder
Inherited from
Builder.constructor
Methods
attributes()
attributes(attributes): LiveEventBuilder
Sets the attributes of the live event in the live event builder and returns an instance of the builder.
Parameters
attributes
string[]
Properties of the live event.
Please refer to the developer guide for a recommended list of canonical values for this field.
This field is optional but SHALL be provided if known.
The maximum size of the list is 32. If there are more than 32 items, the extra items will be removed.
The maximmum size of each item is 255 bytes, any items that exceeds this length will be truncated and the last 3 bytes replaced with ”…”.
Returns
LiveEventBuilder
The LiveEventBuilder object with attributes set.
Throws
If the function is called after this builder instance has already built an object once.Throws
if a string that is not valid UTF-8 is passed in.build()
build():ILiveEvent
Builds the LiveEvent object from the provided parameters.
Returns
ILiveEvent
The built LiveEvent object.
Details
This function should be called after the desired fields of the live event builder have been set using the other builder functions. The build() function should only be called once per builder object.Throws
If one or more of the required fields are missing.Throws
if the function is called after this builder instance has already built an object once.Overrides
Builder.build
