Interface Channel

interface Channel {
    appId: string;
    bots: RemoteMember[];
    close: (() => Promise<void>);
    dispose: (() => void);
    id: string;
    join: ((memberInit?: {
        metadata?: string;
        name?: string;
    } & Partial<LocalMemberConfig>) => Promise<LocalPerson>);
    leave: ((member: Member) => Promise<void>);
    localPerson?: LocalPerson;
    members: Member[];
    metadata?: string;
    name?: string;
    onClosed: Event<ChannelClosedEvent>;
    onMemberJoined: Event<MemberJoinedEvent>;
    onMemberLeft: Event<MemberLeftEvent>;
    onMemberListChanged: Event<ListChangedEvent>;
    onMemberMetadataUpdated: Event<MemberMetadataUpdatedEvent>;
    onMetadataUpdated: Event<ChannelMetadataUpdatedEvent>;
    onPublicationDisabled: Event<PublicationDisabledEvent>;
    onPublicationEnabled: Event<PublicationEnabledEvent>;
    onPublicationListChanged: Event<ListChangedEvent>;
    onPublicationMetadataUpdated: Event<PublicationMetadataUpdatedEvent>;
    onPublicationSubscribed: Event<StreamSubscribedEvent>;
    onPublicationUnsubscribed: Event<StreamUnsubscribedEvent>;
    onStreamPublished: Event<StreamPublishedEvent>;
    onStreamUnpublished: Event<StreamUnpublishedEvent>;
    onSubscriptionListChanged: Event<ListChangedEvent>;
    publications: Publication<LocalStream>[];
    state: ChannelState;
    subscriptions: Subscription<RemoteStream>[];
    updateMetadata: ((metadata: string) => Promise<void>);
}

Properties

appId bots close dispose id join leave localPerson? members metadata? name? onClosed onMemberJoined onMemberLeft onMemberListChanged onMemberMetadataUpdated onMetadataUpdated onPublicationDisabled onPublicationEnabled onPublicationListChanged onPublicationMetadataUpdated onPublicationSubscribed onPublicationUnsubscribed onStreamPublished onStreamUnpublished onSubscriptionListChanged publications state subscriptions updateMetadata

Properties

ReadonlyappId

appId: string

bots

bots: RemoteMember[]

Description

[japanese] Channel中のBotの一覧を取得する

close

close: (() => Promise<void>)

Description

[japanese] Channelを閉じる。

dispose

dispose: (() => void)

Description

[japanese] Channelを閉じずにChannelインスタンスの利用を終了し次のリソースを解放する。

  • サーバとの通信
  • イベントリスナー
  • LocalPersonのインスタンス

Readonlyid

id: string

join

join: ((memberInit?: {
    metadata?: string;
    name?: string;
} & Partial<LocalMemberConfig>) => Promise<LocalPerson>)

Description

[japanese] ChannelにMemberを追加する

leave

leave: ((member: Member) => Promise<void>)

Description

[japanese] ChannelからMemberを退出させる

OptionallocalPerson

localPerson?: LocalPerson

Description

[japanese] Channel中のLocalPersonを取得する

members

members: Member[]

Description

[japanese] Channel中のMemberの一覧を取得する

Optionalmetadata

metadata?: string

Optional Readonlyname

name?: string

ReadonlyonClosed

onClosed: Event<ChannelClosedEvent>

Description

[japanese] このChannelが閉じられた時に発生するイベント

ReadonlyonMemberJoined

onMemberJoined: Event<MemberJoinedEvent>

Description

[japanese] ChannelにMemberが参加した時に発生するイベント

ReadonlyonMemberLeft

onMemberLeft: Event<MemberLeftEvent>

Description

[japanese] ChannelからMemberが退出した時に発生するイベント

ReadonlyonMemberListChanged

onMemberListChanged: Event<ListChangedEvent>

Description

[japanese] このChannelのMemberの数が変化した時に発生するイベント

ReadonlyonMemberMetadataUpdated

onMemberMetadataUpdated: Event<MemberMetadataUpdatedEvent>

Description

[japanese] MemberのMetadataが更新された時に発生するイベント

ReadonlyonMetadataUpdated

onMetadataUpdated: Event<ChannelMetadataUpdatedEvent>

Description

[japanese] このChannelのMetadataが更新された時に発生するイベント

ReadonlyonPublicationDisabled

onPublicationDisabled: Event<PublicationDisabledEvent>

Description

[japanese] このChannelのPublicationが無効化された時に発生するイベント

ReadonlyonPublicationEnabled

onPublicationEnabled: Event<PublicationEnabledEvent>

Description

[japanese] このChannelのPublicationが有効化された時に発生するイベント

ReadonlyonPublicationListChanged

onPublicationListChanged: Event<ListChangedEvent>

Description

[japanese] このChannelのPublicationの数が変化した時に発生するイベント

ReadonlyonPublicationMetadataUpdated

onPublicationMetadataUpdated: Event<PublicationMetadataUpdatedEvent>

Description

[japanese] StreamのPublicationのMetadataが更新された時に発生するイベント

ReadonlyonPublicationSubscribed

onPublicationSubscribed: Event<StreamSubscribedEvent>

Description

[japanese] ChannelのPublicationがSubscribeされた時に発生するイベント

ReadonlyonPublicationUnsubscribed

onPublicationUnsubscribed: Event<StreamUnsubscribedEvent>

Description

[japanese] ChannelのPublicationがUnsubscribeされた時に発生するイベント

ReadonlyonStreamPublished

onStreamPublished: Event<StreamPublishedEvent>

Description

[japanese] ChannelにStreamがPublishされた時に発生するイベント

ReadonlyonStreamUnpublished

onStreamUnpublished: Event<StreamUnpublishedEvent>

Description

[japanese] ChannelからStreamがUnpublishされた時に発生するイベント

ReadonlyonSubscriptionListChanged

onSubscriptionListChanged: Event<ListChangedEvent>

Description

[japanese] このChannelのSubscriptionの数が変化した時に発生するイベント

publications

publications: Publication<LocalStream>[]

Description

[japanese] Channel中のPublicationの一覧を取得する

state

state: ChannelState

subscriptions

subscriptions: Subscription<RemoteStream>[]

Description

[japanese] Channel中のSubscriptionの一覧を取得する

updateMetadata

updateMetadata: ((metadata: string) => Promise<void>)

Description

[japanese] ChannelのMetadataを更新する

Settings

Member Visibility

On This Page

Properties