Channel

interface Channel

Channelの操作を行うクラス。

Types

Link copied to clipboard
object Companion
Link copied to clipboard

Channelの状態。

Properties

Link copied to clipboard
abstract val bots: Set<Member>

このChannel内のBotの一覧。

Link copied to clipboard
abstract val id: String

このChannelのID。

Link copied to clipboard
abstract val localPerson: LocalPerson?

このChannel内にこのSDKから参加しているLocalPerson。

Link copied to clipboard
abstract val members: Set<Member>

このChannel内のMember一覧。

Link copied to clipboard
abstract val metadata: String?

このChannelのMetadata。

Link copied to clipboard
abstract val name: String?

このChannelの名前。

Link copied to clipboard
abstract var onClosedHandler: () -> Unit?

このChannelが閉じられた時に発火するハンドラ。

Link copied to clipboard
abstract var onErrorHandler: (Exception) -> Unit?

このChannel内の各種イベントでエラーが起きた時に発火するハンドラ。

Link copied to clipboard
abstract var onMemberJoinedHandler: (member: Member) -> Unit?

このChannelにMemberが入室した時に発火するハンドラ。

Link copied to clipboard
abstract var onMemberLeftHandler: (member: Member) -> Unit?

このChannelからMemberが退出した時に発火するハンドラ。

Link copied to clipboard
abstract var onMemberListChangedHandler: () -> Unit?

このChannel内のMemberの数が変更された時に発火するハンドラ。

Link copied to clipboard
abstract var onMemberMetadataUpdatedHandler: (member: Member, metadata: String) -> Unit?

このChannel内のMemberのMetadataが更新された時に発火するハンドラ。

Link copied to clipboard
abstract var onMetadataUpdatedHandler: (metadata: String) -> Unit?

このChannelのMetadataが更新された時に発火するハンドラ。

Link copied to clipboard
abstract var onPublicationDisabledHandler: (publication: Publication) -> Unit?

このChannel内のPublicationがDisableになった時に発火するハンドラ。

Link copied to clipboard
abstract var onPublicationEnabledHandler: (publication: Publication) -> Unit?

このChannel内のPublicationがEnableになった時に発火するハンドラ。

Link copied to clipboard

このChannel内のPublicationの数が変更された時に発火するハンドラ。

Link copied to clipboard
abstract var onPublicationMetadataUpdatedHandler: (publication: Publication, metadata: String) -> Unit?

このChannel内のPublicationのMetadataが更新された時に発火するハンドラ。

Link copied to clipboard
abstract var onPublicationSubscribedHandler: (subscription: Subscription) -> Unit?

このChannel内のPublicationがSubscribeされた時に発火するハンドラ。 Subscriptionにはまだstreamがsetされていない可能性があります。

Link copied to clipboard
abstract var onPublicationUnsubscribedHandler: (subscription: Subscription) -> Unit?

このChannel内のPublicationがUnsubscribeされた時に発火するハンドラ。

Link copied to clipboard
abstract var onStreamPublishedHandler: (publication: Publication) -> Unit?

このChannel内にStreamがPublishされた時に発火するハンドラ。

Link copied to clipboard
abstract var onStreamUnpublishedHandler: (publication: Publication) -> Unit?

このChannel内にStreamがUnpublishされた時に発火するハンドラ。

Link copied to clipboard

このChannel内のSubscriptionのList変わった時に発火するハンドラ。

Link copied to clipboard

このChannel内のPublicationの一覧。

Link copied to clipboard
abstract val state: Channel.State

このChannelの状態。

Link copied to clipboard

このChannel内のSubscriptionの一覧。

Functions

Link copied to clipboard
abstract suspend fun close(): Boolean

Channelを閉じます。 onClosedHandlerが発火します。

Link copied to clipboard
abstract fun dispose()

Channelを破棄します。 破棄されたChannelではイベントが発火しなくなります。 またChannel内のMemberPublicationSubscriptionも破棄されます。

Link copied to clipboard
abstract suspend fun join(memberInit: Member.Init): LocalPerson?

Channelに入室します。 onMemberJoinedHandlerが発火します。 このChannel内に同時に入室できるLocalPersonは1つだけです。

Link copied to clipboard
abstract suspend fun leave(member: Member): Boolean

指定したメンバーをChannelから退室させます。 onMemberLeftHandlerが発火します。

Link copied to clipboard
abstract suspend fun updateMetadata(metadata: String): Boolean

Channelのmetadataを更新します。 onMetadataUpdatedHandlerが発火します。