ChannelDescriptor object.
Extends
Constructors
new ChannelDescriptorBuilder()
new ChannelDescriptorBuilder():ChannelDescriptorBuilder
Returns
ChannelDescriptorBuilder
Inherited from
Builder.constructor
Methods
build()
build():IChannelDescriptor
Builds the ChannelDescriptor object from the fields in the ChannelDescriptorBuilder object.
Returns
IChannelDescriptor
The built ChannelDescriptor 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
identifier()
identifier(identifier): ChannelDescriptorBuilder
Sets the Identifier of the ChannelDescriptor.
Parameters
identifier
string
A string that represents a unique identifier for the channel.
This identifier should be unique across all channels within the application package.
This field has a maximum length of 8192 bytes.
Returns
ChannelDescriptorBuilder
The ChannelDescriptorBuilder object with channel Identifier set.
Details
This field is required for the channel descriptor.Throws
IllegalStateError if the function is called after this builder instance
has already built an object once.
Throws
InvalidArgumentError if the field exceeds the maximum length of 8192 bytes.
Throws
InvalidArgumentError if a string that is not valid UTF-8 is passed in.
