IVSParticipantInfo

Objective-C


@interface IVSParticipantInfo : NSObject

Swift

class IVSParticipantInfo : NSObject

Information about a participant. The properties in this class will remain constant throughout its lifetime, with the exception of userInfo.

  • Unavailable

    Do not create instances of this class directly

    Declaration

    Objective-C

    IVS_INIT_UNAVAILABLE

  • Unavailable

    Do not create instances of this class directly

    Declaration

    Objective-C

    IVS_INIT_UNAVAILABLE

  • A unique ID assigned to this participant.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull participantId;

    Swift

    var participantId: String { get }

  • A user ID associated with this participant.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull userId;

    Swift

    var userId: String { get }

  • Attributes associated with this participant.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSDictionary<NSString *, NSString *> *_Nonnull attributes;

    Swift

    var attributes: [String : String] { get }

  • This represents if the participant is local (associated with the token used on this device to join the Stage).

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL isLocal;

    Swift

    var isLocal: Bool { get }

  • This represents the capabilities that can be performed on this participant.

    Declaration

    Objective-C

    @property (nonatomic, readonly) IVSParticipantCapability capabilities;

    Swift

    var capabilities: IVSParticipantCapability { get }

  • This object exists for use by the developer, to store information that might be associated with this participant. This object will never be accessed by the SDK, and changes will not be synced to remote SDK userInfo objects.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSMutableDictionary<NSString *, id> *_Nonnull userInfo;

    Swift

    var userInfo: NSMutableDictionary { get }