RoomMember

@objc
open class RoomMember : NSObject, Identifiable

Roomに入室しているMemberの抽象クラス

  • 入室しているRoomのID

    Declaration

    Swift

    @objc
    public let roomId: String
  • 入室しているRoomの名前

    Declaration

    Swift

    @objc
    public let roomName: String?
  • 入室しているRoomの種別

    Declaration

    Swift

    @objc
    public let roomType: RoomType
  • id

    Memberを識別するためのID

    Declaration

    Swift

    @objc
    public var id: String { get }
  • Memberの名前

    Declaration

    Swift

    @objc
    public var name: String? { get }
  • メタデータ

    Declaration

    Swift

    @objc
    public var metadata: String? { get }
  • メンバーサイド

    このクライアントで生成されたメンバーの場合localになります。

    Declaration

    Swift

    @objc
    public var side: Side { get }
  • ステート

    Leftの場合、このオブジェクトの操作は無効です。

    Declaration

    Swift

    @objc
    public var state: MemberState { get }
  • Publish中のPublication一覧

    Declaration

    Swift

    @objc
    public var publications: [RoomPublication] { get }
  • Subscribe中のSubscription一覧

    Declaration

    Swift

    @objc
    public var subscriptions: [RoomSubscription] { get }
  • updateMetadata(_:) Asynchronous

    メタデータを更新します。

    Declaration

    Swift

    @available(iOS 13.0, *)
    @objc
    public func updateMetadata(_ metadata: String) async throws

    Parameters

    metadata

    更新するメタデータ

  • メタデータを更新します。

    Declaration

    Swift

    @objc
    public func updateMetadata(_ metadata: String, completion: ((Error?) -> Void)?)

    Parameters

    metadata

    更新するメタデータ

    completion

    完了コールバック

  • leave() Asynchronous

    Roomから退出します。

    Memberを指定してRoomのleave(_:)をコールした時と同じ効果です。

    Declaration

    Swift

    @available(iOS 13.0, *)
    @objc
    public func leave() async throws
  • Roomから退出します。

    Memberを指定してRoomのleave(_:)をコールした時と同じ効果です。

    Declaration

    Swift

    @objc
    public func leave(completion: ((Error?) -> Void)?)

    Parameters

    completion

    完了コールバック

NSObject

  • Undocumented

    Declaration

    Swift

    override open func isEqual(_ object: Any?) -> Bool
  • Undocumented

    Declaration

    Swift

    open override var hash: Int { get }