Overview
Can be accessed using client.helix.channels on an
ApiClient
instance.
Example
const api = new ApiClient(new StaticAuthProvider(clientId, accessToken));
const channel = await api.helix.channels.getChannelInfo('125328655');
Methods
getChannelEditors(broadcaster)
asyncRetrieves a list of users who have editor permissions on your channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| broadcaster | UserIdResolvable | none | none |
Return type:
Array<HelixChannelEditor>
getChannelInfo(user)
asyncRetrieves the channel data for the given user.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| user | UserIdResolvable | none |
The user you want to get channel info for. |
Return type:
HelixChannel
|
null
startChannelCommercial(broadcaster, length)
asyncStarts a commercial on a channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| broadcaster | UserIdResolvable | none |
The broadcaster on whose channel the commercial is started. |
|
| length | CommercialLength | none |
The length of the commercial, in seconds. |
Return type:
void
updateChannelInfo(user, data)
asyncUpdates the given user's channel data.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| user | UserIdResolvable | none |
The user you want to update channel info for. |
|
| data | HelixChannelUpdate | none | The channel info to set. |
Return type:
void