UnifiedClient

UnifiedClient = object

Defined in: packages/core/src/client.ts:34

Methods

batchGetBroadcasts()

batchGetBroadcasts(platform, channelIds): Promise<BatchResult<Broadcast[]>>

Defined in: packages/core/src/client.ts:132

Batch retrieve broadcasts by platform and channel IDs.

Parameters

platform

string

platform name

channelIds

string[]

channel identifiers

Returns

Promise<BatchResult<Broadcast[]>>

batch result with values (Broadcast[] per channel) and per-item errors

Precondition

platform is registered

Postcondition

request-level errors (rate limit, auth, network) are thrown, per-item errors go to errors map

Throws

PlatformNotFoundError if platform is not registered

batchGetChannels()

batchGetChannels(platform, ids): Promise<BatchResult<Channel>>

Defined in: packages/core/src/client.ts:170

Batch retrieve channels by platform and IDs.

Parameters

platform

string

platform name

ids

string[]

channel identifiers

Returns

Promise<BatchResult<Channel>>

batch result with values and per-item errors

Precondition

platform is registered

Postcondition

request-level errors (rate limit, auth, network) are thrown, per-item errors go to errors map

Throws

PlatformNotFoundError if platform is not registered

batchGetClips()

batchGetClips(platform, ids): Promise<BatchResult<Clip>>

Defined in: packages/core/src/client.ts:182

Batch retrieve clips by platform and IDs.

Parameters

platform

string

platform name

ids

string[]

clip identifiers

Returns

Promise<BatchResult<Clip>>

batch result with values and per-item errors

Precondition

platform is registered and supports clips

Throws

PlatformNotFoundError if platform is not registered

Throws

ValidationError if platform doesn’t support clip retrieval by IDs

batchGetContents()

batchGetContents(platform, ids): Promise<BatchResult<Content>>

Defined in: packages/core/src/client.ts:120

Batch retrieve content by platform and IDs.

Parameters

platform

string

platform name

ids

string[]

content identifiers

Returns

Promise<BatchResult<Content>>

batch result with values and per-item errors

Precondition

platform is registered

Postcondition

request-level errors (rate limit, auth, network) are thrown, per-item errors go to errors map

Throws

PlatformNotFoundError if platform is not registered

crossListBroadcasts()

crossListBroadcasts(channels): Promise<Record<string, BatchResult<Broadcast[]>>>

Defined in: packages/core/src/client.ts:192

Fetch broadcasts from all specified platforms in parallel.

Parameters

channels

Record<string, string[]>

mapping of platform name to channel ID arrays

Returns

Promise<Record<string, BatchResult<Broadcast[]>>>

mapping of platform name to batch result of broadcasts; failed platforms get empty BatchResult

Postcondition

all platforms are represented in the result, even on failure

Idempotency

Safe — read-only aggregation

crossSearch()

crossSearch(options): Promise<Record<string, Page<Content>>>

Defined in: packages/core/src/client.ts:204

Search across all registered plugins that support search.

Parameters

options

SearchOptions

search options (query, status, channelId, order, limit, cursor)

Returns

Promise<Record<string, Page<Content>>>

mapping of platform name to paginated search results; failed platforms get empty Page

Postcondition

all searchable platforms are represented in the result, even on failure

Idempotency

Safe — read-only aggregation

getChannel()

getChannel(platform, id): Promise<Channel>

Defined in: packages/core/src/client.ts:108

Retrieve channel information.

Parameters

platform

string

platform name

id

string

channel identifier

Returns

Promise<Channel>

channel information

Precondition

platform is registered

Throws

PlatformNotFoundError if platform is not registered

getContent()

getContent(platform, id): Promise<Content>

Defined in: packages/core/src/client.ts:66

Retrieve content by platform name and ID.

Parameters

platform

string

platform name

id

string

content identifier

Returns

Promise<Content>

the resolved content (Broadcast, ScheduledBroadcast, or Archive)

Precondition

platform is registered

Postcondition

returns Content (Broadcast, ScheduledBroadcast, or Archive)

Throws

PlatformNotFoundError if platform is not registered

listArchives()

listArchives(platform, channelId, cursor?, pageSize?, options?): Promise<Page<Archive>>

Defined in: packages/core/src/client.ts:91

List archives for a channel with cursor-based pagination.

Parameters

platform

string

platform name

channelId

string

channel identifier

cursor?

string

pagination cursor

pageSize?

number

number of items per page

options?

ArchiveListOptions

optional archive filter options (period, sort, videoType)

Returns

Promise<Page<Archive>>

paginated list of archives

Precondition

platform is registered

Throws

PlatformNotFoundError if platform is not registered

listBroadcasts()

listBroadcasts(platform, channelId): Promise<Broadcast[]>

Defined in: packages/core/src/client.ts:77

List currently active broadcasts for a channel.

Parameters

platform

string

platform name

channelId

string

channel identifier

Returns

Promise<Broadcast[]>

active broadcasts for the channel

Precondition

platform is registered

Throws

PlatformNotFoundError if platform is not registered

listClips()

listClips(platform, channelId, options?): Promise<Page<Clip>>

Defined in: packages/core/src/client.ts:158

List clips for a channel on a platform.

Parameters

platform

string

platform name

channelId

string

channel identifier

options?

ClipOptions

optional clip query options (date range, limit, cursor)

Returns

Promise<Page<Clip>>

paginated list of clips

Precondition

platform is registered and supports clips

Throws

PlatformNotFoundError if platform is not registered

Throws

ValidationError if platform doesn’t support clips

match()

match(url): ResolvedUrl | null

Defined in: packages/core/src/client.ts:223

Parse a URL to determine which platform and resource it refers to. No network calls.

Parameters

url

string

URL to match against registered plugins

Returns

ResolvedUrl | null

resolved URL info, or null if no plugin matches

Postcondition

returns ResolvedUrl or null if no plugin matches

platform()

platform(name): PlatformPlugin

Defined in: packages/core/src/client.ts:213

Access a specific platform plugin.

Parameters

name

string

platform name to look up

Returns

PlatformPlugin

the registered platform plugin

Throws

PlatformNotFoundError if platform is not registered

platforms()

platforms(): string[]

Defined in: packages/core/src/client.ts:231

Returns the names of all registered platforms.

Returns

string[]

array of platform name strings

Postcondition

returns a snapshot of currently registered platform names

register()

register(plugin): void

Defined in: packages/core/src/client.ts:43

Parameters

plugin

PlatformPlugin

the platform plugin to register

Returns

void

Precondition

plugin.name is unique across registered plugins

Postcondition

plugin is available for URL matching and API calls

Idempotency

Re-registering the same name overwrites the previous plugin

resolve()

resolve(url): Promise<Content>

Defined in: packages/core/src/client.ts:54

Resolve a URL to content. Automatically routes to the correct plugin.

Parameters

url

string

content URL to resolve and fetch

Returns

Promise<Content>

the resolved content (Broadcast, ScheduledBroadcast, or Archive)

Precondition

url matches a registered plugin

Postcondition

returns Content (Broadcast, ScheduledBroadcast, or Archive)

Throws

PlatformNotFoundError if no plugin matches the URL

search()

search(platform, options): Promise<Page<Content>>

Defined in: packages/core/src/client.ts:145

Search content on a platform. At least one of query/status/channelId required.

Parameters

platform

string

platform name

options

SearchOptions

search options (query, status, channelId, order, limit, cursor)

Returns

Promise<Page<Content>>

paginated search results

Precondition

platform is registered and supports search

Precondition

at least one of options.query, options.status, or options.channelId is provided

Throws

PlatformNotFoundError if platform is not registered

Throws

ValidationError if no query, status, or channelId provided, or platform doesn’t support search