ChannelMetadata object.
Extends
Constructors
new ChannelMetadataBuilder()
new ChannelMetadataBuilder():ChannelMetadataBuilder
Returns
ChannelMetadataBuilder
Inherited from
Builder.constructor
Methods
attributes()
attributes(attributes): ChannelMetadataBuilder
Sets the channel attributes in the ChannelMetadata builder.
Parameters
attributes
string[]
Attributes of the channel.
Please refer to the developer guide for a recommended list of canonical values for this field.
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
ChannelMetadataBuilder
The ChannelMetadataBuilder object with channel attributes set.
Details
This field is optional for the channel metadata.Throws
IllegalStateError if the function is called after this builder instance
has already built an object once.
Throws
InvalidArgumentError if a string that is not valid UTF-8 is passed in.
build()
build():IChannelMetadata
Builds the ChannelMetadata object based on the fields in the ChannelMetadataBuilder.
Returns
IChannelMetadata
The built ChannelMetadata object.
Throws
InvalidArgumentError if one or more of the required fields are missing.
Throws
IllegalStateError if the function is called after this builder instance
has already built an object once.
Overrides
Builder.build
