SKWMember

Objective-C


@interface SKWMember : NSObject

Swift

class Member : NSObject

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

  • id

    Memberを識別するためのID

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull id;

    Swift

    var id: String { get }

  • Memberの名前

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nullable name;

    Swift

    var name: String? { get }

  • メタデータ

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nullable metadata;

    Swift

    var metadata: String? { get }

  • メンバータイプ

    Declaration

    Objective-C

    @property (nonatomic, readonly) SKWMemberType type;

    Swift

    var type: MemberType { get }

  • メンバーサイド

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

    Declaration

    Objective-C

    @property (nonatomic, readonly) SKWSide side;

    Swift

    var side: Side { get }

  • サブタイプ

    Botの種類を判別するときに利用します。

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull subtype;

    Swift

    var subtype: String { get }

  • ステート

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

    Declaration

    Objective-C

    @property (nonatomic, readonly) SKWMemberState state;

    Swift

    var state: MemberState { get }

  • Publish中のPublication一覧

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<SKWPublication *> *_Nonnull publications;

    Swift

    var publications: [SKWPublication] { get }

  • Subscribe中のSubscription一覧

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<SKWSubscription *> *_Nonnull subscriptions;

    Swift

    var subscriptions: [SKWSubscription] { get }

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

    Declaration

    Objective-C

    - (void)updateMetadata:(NSString *_Nonnull)metadata
            completion:(SKWMemberUpdateMetadataCompletion _Nullable)completion;

    Swift

    func updateMetadata(_ metadata: String) async throws

    Parameters

    metadata

    更新するメタデータ
    completion

    完了コールバック

  • Channelから退出します。

    Declaration

    Objective-C

    - (void)leaveWithCompletion:(SKWMemberLeaveCompletion _Nullable)completion;

    Swift

    func leave() async throws

    Parameters

    completion

    完了コールバック