Skip to content

UI builder - Studio API

Channel

To execute Channel APIs, take a look at the examples below:

Api.profile("My Profile").channel("My Channel").setChannelName("New Channel Name");
Api.profile("My Profile").channel("My Channel").setAsProgram();

updateChannel

Sets the new type and/or new name of the Channel

Api.profile("My Profile").channel("My Channel").updateChannel(type: string, name: string): void;
Parameter Type Description
type string The Type of channel to be changed to
name string The name of the Channel to be updated

setChannelType

Sets the new type of Channel

Api.profile("My Profile").channel("My Channel").setChannelType(type: string): void;
Parameter Type Description
type string The Type of channel to be changed to

setChannelName

Sets the new name of the Channel

Api.profile("My Profile").channel("My Channel").setChannelName(name: string): void;
Parameter Type Description
name string The new name of the Channel

setAsProgram

Set the Channel as Program

Api.profile("My Profile").channel("My Channel").setAsProgram(): void;

setAsPreview

Set the Channel as Preview

Api.profile("My Profile").channel("My Channel").setAsPreview(): void;

setAsRegularChannel

Set the Channel as Regular Channel

Api.profile("My Profile").channel("My Channel").setAsRegularChannel(): void;