BCXCallParticipant

Objective-C

@protocol BCXCallParticipant <NSObject>

Swift

protocol BCXCallParticipant : NSObjectProtocol

Object representing a call participant and its state in the call. This object can be checked for equality.

Properties

  • The user object

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) id<BCXUser> _Nonnull user;

  • The user identifier.

    Declaration

    Objective-C

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

    Swift

    var userId: String { get }

  • The state of the user in the call

    Declaration

    Objective-C

    @property (nonatomic, readonly) BCXCallParticipantState state;

    Swift

    var state: BCXCallParticipantState { get }

States

  • Returns a flag indicating whether the user has answered, or not.

    Declaration

    Objective-C

    - (BOOL)hasAnswered;

    Swift

    func hasAnswered() -> Bool

    Return Value

    YES if the user has answered, NO otherwise.

  • Returns a flag indicating whether the user has declined, or not.

    Declaration

    Objective-C

    - (BOOL)hasDeclined;

    Swift

    func hasDeclined() -> Bool

    Return Value

    YES if the user has declined, NO otherwise.

  • Returns a flag indicating whether the user has declined because of do not disturb, or not.

    Declaration

    Objective-C

    - (BOOL)hasDeclinedByDoNotDisturb;

    Swift

    func hasDeclinedByDoNotDisturb() -> Bool

    Return Value

    YES if the user has declined because of do not disturb, NO otherwise.

  • Returns a flag indicating whether the user has missed the call, and did not answer.

    Declaration

    Objective-C

    - (BOOL)didNotAnswer;

    Swift

    func didNotAnswer() -> Bool

    Return Value

    YES if the user did not answer and missed the call, NO otherwise.

  • Returns a flag indicating whether the user has timed out while connecting the call.

    Declaration

    Objective-C

    - (BOOL)hasTimedOut;

    Swift

    func hasTimedOut() -> Bool

    Return Value

    YES if the user has timed out while connecting the call, NO otherwise.

  • Returns a flag indicating whether the user has disconnected.

    Declaration

    Objective-C

    - (BOOL)hasDisconnected;

    Swift

    func hasDisconnected() -> Bool

    Return Value

    YES if the user has disconnected, NO otherwise.

Video

  • Returns a flag indicating whether the participant has upgraded to video, or not.

    Declaration

    Objective-C

    - (BOOL)didUpgradeToVideo;

    Swift

    func didUpgradeToVideo() -> Bool

    Return Value

    YES if the user has upgraded to video, NO otherwise