ExternalIdBuilder

Builder that creates an instance of the ExternalId object.

​

Extends

• Builder

​

Constructors

​

new ExternalIdBuilder()

new ExternalIdBuilder(): ExternalIdBuilder

​

Returns

ExternalIdBuilder

​

Methods

​

build()

build(): IExternalId

Builds the ExternalId object based on the parameters provided.

​

Throws

• InvalidArgumentError if one or more of the required fields are missing.
• IllegalStateError if the function is called after this builder instance has already built an object once.

​

Returns

IExternalId IExternalId The built ExternalId object, which can be used to identify the channel in external lineup sources.

---

​

idType()

idType(idType: string): ExternalIdBuilder

Sets the identifier type of the ExternalId.

​

Parameters

idType

string The type of the external identifier. Some canonical values for this field can be found in the developer guide. This field has a maximum length of 8192 bytes.

​

Throws

• IllegalStateError if the function is called after this builder instance has already built an object once.

​

Returns

ExternalIdBuilder ExternalIdBuilder The ExternalIdBuilder object with identifier type set.

---

​

value()

value(value: string): ExternalIdBuilder

Sets the value of the ExternalId.

​

Parameters

value

string The external identifier string value. This field has a maximum length of 8192 bytes.

​

Throws

• IllegalStateError if the function is called after this builder instance has already built an object once.

​

Returns

ExternalIdBuilder ExternalIdBuilder The ExternalIdBuilder object with value set.