PluginMethods
PluginMethods =
object
Defined in: packages/core/src/plugin.ts:91
Platform-specific data access methods.
Separated from PluginDefinition because they need access to the constructed RestManager.
Methods receive rest as the first argument — pure functions that are easier to test and compose.
Properties
Section titled “Properties”batchGetBroadcasts()?
Section titled “batchGetBroadcasts()?”
optionalbatchGetBroadcasts: (rest,channelIds) =>Promise<BatchResult<Broadcast[]>>
Defined in: packages/core/src/plugin.ts:117
Batch-retrieve broadcasts by channel IDs (optional).
Parameters
Section titled “Parameters”channelIds
Section titled “channelIds”string[]
Returns
Section titled “Returns”Promise<BatchResult<Broadcast[]>>
batchGetChannels()?
Section titled “batchGetChannels()?”
optionalbatchGetChannels: (rest,ids) =>Promise<BatchResult<Channel>>
Defined in: packages/core/src/plugin.ts:132
Batch-retrieve channels by IDs (optional).
Parameters
Section titled “Parameters”string[]
Returns
Section titled “Returns”Promise<BatchResult<Channel>>
batchGetClips()?
Section titled “batchGetClips()?”
optionalbatchGetClips: (rest,ids) =>Promise<BatchResult<Clip>>
Defined in: packages/core/src/plugin.ts:129
Batch-retrieve clips by IDs (optional).
Parameters
Section titled “Parameters”string[]
Returns
Section titled “Returns”Promise<BatchResult<Clip>>
batchGetContents()?
Section titled “batchGetContents()?”
optionalbatchGetContents: (rest,ids) =>Promise<BatchResult<Content>>
Defined in: packages/core/src/plugin.ts:114
Batch-retrieve content by IDs (optional).
Parameters
Section titled “Parameters”string[]
Returns
Section titled “Returns”Promise<BatchResult<Content>>
getChannel()
Section titled “getChannel()”getChannel: (
rest,id) =>Promise<Channel>
Defined in: packages/core/src/plugin.ts:96
Retrieve channel by ID.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Channel>
getContent()
Section titled “getContent()”getContent: (
rest,id) =>Promise<Content>
Defined in: packages/core/src/plugin.ts:93
Retrieve content by ID.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Content>
listArchives()
Section titled “listArchives()”listArchives: (
rest,channelId,cursor?,pageSize?,options?) =>Promise<Page<Archive>>
Defined in: packages/core/src/plugin.ts:102
List archives for a channel with pagination.
Parameters
Section titled “Parameters”channelId
Section titled “channelId”string
cursor?
Section titled “cursor?”string
pageSize?
Section titled “pageSize?”number
options?
Section titled “options?”Returns
Section titled “Returns”listBroadcasts()
Section titled “listBroadcasts()”listBroadcasts: (
rest,channelId) =>Promise<Broadcast[]>
Defined in: packages/core/src/plugin.ts:99
List currently active broadcasts for a channel.
Parameters
Section titled “Parameters”channelId
Section titled “channelId”string
Returns
Section titled “Returns”Promise<Broadcast[]>
listClips()?
Section titled “listClips()?”
optionallistClips: (rest,channelId,options?) =>Promise<Page<Clip>>
Defined in: packages/core/src/plugin.ts:126
List clips for a channel (optional).
Parameters
Section titled “Parameters”channelId
Section titled “channelId”string
options?
Section titled “options?”Returns
Section titled “Returns”resolveArchive()?
Section titled “resolveArchive()?”
optionalresolveArchive: (rest,live) =>Promise<Archive|null>
Defined in: packages/core/src/plugin.ts:111
Resolve the archive for a broadcast (optional).
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<Archive | null>
search()?
Section titled “search()?”Defined in: packages/core/src/plugin.ts:123
Search for content (optional).