Channel

Defined in: packages/client/src/structures/channel.ts:7

A cached channel slot: name, secret, and send() to broadcast on it.

Constructors

Constructor

new Channel(client, record): Channel;

Defined in: packages/client/src/structures/channel.ts:15

Parameters

client

Client

Owning client

record

ChannelRecord

Channel as decoded from the radio

Returns

Channel

Properties

client

readonly client: Client;

Defined in: packages/client/src/structures/channel.ts:8

Accessors

index

Get Signature

get index(): number;

Defined in: packages/client/src/structures/channel.ts:20

Returns

number

isHashtag

Get Signature

get isHashtag(): boolean;

Defined in: packages/client/src/structures/channel.ts:32

Returns

boolean

name

Get Signature

get name(): string;

Defined in: packages/client/src/structures/channel.ts:24

Returns

string

secret

Get Signature

get secret(): Uint8Array;

Defined in: packages/client/src/structures/channel.ts:28

Returns

Uint8Array

Methods

send()

send(content): Promise<SentMessage>;

Defined in: packages/client/src/structures/channel.ts:37

Parameters

content

MessageContent

Text or MessageBuilder

Returns

Promise<SentMessage>

toString()

toString(): string;

Defined in: packages/client/src/structures/channel.ts:51

Returns

string