ChannelManager

Defined in: packages/client/src/managers/channel-manager.ts:20

client.channels: caches the radio's channel slots and creates or deletes channels.

Constructors

Constructor

new ChannelManager(client): ChannelManager;

Defined in: packages/client/src/managers/channel-manager.ts:25

Parameters

client

Client

Owning client

Returns

ChannelManager

Properties

cache

readonly cache: Collection<number, Channel>;

Defined in: packages/client/src/managers/channel-manager.ts:22

client

readonly client: Client;

Defined in: packages/client/src/managers/channel-manager.ts:21

Methods

create()

create(options): Promise<Channel>;

Defined in: packages/client/src/managers/channel-manager.ts:49

Parameters

options

CreateChannelOptions

name and optional secret, hashtag channels derive it

Returns

Promise<Channel>

delete()

delete(channel): Promise<void>;

Defined in: packages/client/src/managers/channel-manager.ts:71

Parameters

channel

string | number | Channel

Channel, name or slot

Returns

Promise<void>

fetch()

fetch(options?): Promise<Collection<number, Channel>>;

Defined in: packages/client/src/managers/channel-manager.ts:37

Parameters

options?

emitEvents emits channelUpdate for the differences

emitEvents?

boolean

Returns

Promise<Collection<number, Channel>>

get()

get(nameOrIndex): Channel | undefined;

Defined in: packages/client/src/managers/channel-manager.ts:30

Parameters

nameOrIndex

string | number

Channel name or slot

Returns

Channel | undefined