BDKUser

Objective-C

@protocol BDKUser <NSObject>

Swift

protocol User : NSObjectProtocol

Represents a Bandyer user with its status.

Properties

  • The user’s alias (i.e. identifier).

    Declaration

    Objective-C

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

    Swift

    var alias: String { get }

  • The user’s first name.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) NSString *firstName;

    Swift

    var firstName: String? { get }

  • The user’s last name.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) NSString *lastName;

    Swift

    var lastName: String? { get }

  • The user’s email address.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) NSString *email;

    Swift

    var email: String? { get }

  • The user’s image filename.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) NSString *imageFilename;

    Swift

    var imageFilename: String? { get }

User state

  • The user current state

    Declaration

    Objective-C

    @property (nonatomic, readonly) BDKUserState state;

    Swift

    var state: UserState { get }

  • Returns a flag indicating whether the user is in busy state, or not.

    Declaration

    Objective-C

    - (BOOL)isBusy;

    Swift

    func isBusy() -> Bool

    Return Value

    YES if the user is in busy state, NO otherwise

  • Returns a flag indicating whether the user is online, or not.

    Declaration

    Objective-C

    - (BOOL)isOnline;

    Swift

    func isOnline() -> Bool

    Return Value

    YES if the user is online, NO otherwise

  • Returns a flag indicating whether the user is offline, or not.

    Declaration

    Objective-C

    - (BOOL)isOffline;

    Swift

    func isOffline() -> Bool

    Return Value

    YES if the user is offline, NO otherwise

User’s capabilities

  • Returns a boolean flag indicating whether the user has permission to upgrade calls to audio/video calls, or not.

    Declaration

    Objective-C

    - (BOOL)canUpgradeToVideo;

    Swift

    func canUpgradeToVideo() -> Bool

    Return Value

    YES if the user has the permission to upgrade a call to an audio/video call, NO otherwise.