ExternalIdBuilder

Builder that creates an instance of the ExternalId object.

Extends

• Builder<IExternalId>

Constructors

new ExternalIdBuilder()

new ExternalIdBuilder(): ExternalIdBuilder

Returns

ExternalIdBuilder

Inherited from

Builder.constructor

Properties

_className

protected readonly _className: string = 'ExternalIdBuilder'

Overrides

Builder._className

Methods

build()

build(): IExternalId

Builds the ExternalId object based on the parameters provided.

Returns

IExternalId

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

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

---

idType()

idType(idType): 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.

Returns

ExternalIdBuilder

The ExternalIdBuilder object with identifier type set.

Throws

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

---

markBuilderAsUsed()

protected markBuilderAsUsed(): void

Returns

void

Inherited from

Builder.markBuilderAsUsed

---

throwErrorIfBuilderAlreadyUsed()

protected throwErrorIfBuilderAlreadyUsed(): void

Returns

void

Inherited from

Builder.throwErrorIfBuilderAlreadyUsed

---

value()

value(value): ExternalIdBuilder

Sets the value of the ExternalId.

Parameters

value

string

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

Returns

ExternalIdBuilder

The ExternalIdBuilder object with value set.

Throws

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

---

Last updated: Sep 30, 2025