BDKCallOptions

Objective-C


@interface BDKCallOptions : NSObject <NSCopying>

Swift

class CallOptions : NSObject, NSCopying

A value object representing the options used when creating a call.

This is a value object so instances can be checked for equality.

Properties

  • A flag indicating whether the call should be recorded or not. The default value for this property is false.

    Declaration

    Objective-C

    @property (nonatomic, readonly, getter=isRecorded) BOOL recorded;

    Swift

    var isRecorded: Bool { get }

  • The maximum duration in seconds for the call. If the value is zero the call will last until all participants have left. The default value for this property is zero.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSUInteger maximumDuration;

    Swift

    var maximumDuration: UInt { get }

Call type

  • The call type.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BDKCallType callType;

    Swift

    var callType: CallType { get }

  • Returns a flag indicating whether the call type is audio / video, or not.

    Declaration

    Objective-C

    - (BOOL)isAudioVideo;

    Swift

    func isAudioVideo() -> Bool

    Return Value

    a flag indicating whether the call type is audio / video, or not.

  • Returns a flag indicating whether the call type is audio upgradable, or not.

    Declaration

    Objective-C

    - (BOOL)isAudioUpgradable;

    Swift

    func isAudioUpgradable() -> Bool

    Return Value

    a flag indicating whether the call type is audio upgradable, or not.

  • Returns a flag indicating whether the call type is audio only, or not.

    Declaration

    Objective-C

    - (BOOL)isAudioOnly;

    Swift

    func isAudioOnly() -> Bool

    Return Value

    a flag indicating whether the call type is audio only, or not.

Initialization

  • Creates an option instance setting the call type to the value provided as argument. The recorded flag will be set to false. The maximum duration value will be set to zero (call will last until all participants have left the call).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCallType:(BDKCallType)callType;

    Swift

    convenience init(callType: CallType)

    Parameters

    callType

    The call type.

    Return Value

    A call options instance with the call type provided as argument and the recorded flag and maximumDuration properties set to default values.

  • Creates an option instance setting the call type and the recorded flag to the values provided as arguments. The maximum duration value will be set to zero (call will last until all participants have left the call).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCallType:(BDKCallType)callType
                                recorded:(BOOL)recorded;

    Swift

    convenience init(callType: CallType, recorded: Bool)

    Parameters

    callType

    The call type.
    recorded

    A flag indicating whether the call should be recorded or not.

    Return Value

    A call options instance with the call type and the recorded flag values provided as argument. The maximumDuration property will be set to the default value (0).

  • Creates an option instance setting the call type and the maximum duration flag to the values provided as arguments. The recorded flag will be set to false.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCallType:(BDKCallType)callType
                                duration:(NSUInteger)duration;

    Swift

    convenience init(callType: CallType, duration: UInt)

    Parameters

    callType

    The call type.
    duration

    The maximum duration of the call expressed in seconds. A value of zero means the call will last until all participants have left.

    Return Value

    A call options instance with the call type and the maximum duration values provided as arguments. The recorded flag will be set to the default value (false).

  • Creates an option instance setting the call type, the recorded flag and the maximum duration flag to the values provided as arguments.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCallType:(BDKCallType)callType
                                recorded:(BOOL)recorded
                                duration:(NSUInteger)duration;

    Swift

    init(callType: CallType, recorded: Bool, duration: UInt)

    Parameters

    callType

    The call type.
    recorded

    A flag indicating whether the call should be recorded or not.
    duration

    The maximum duration of the call expressed in seconds. A value of zero means the call will last until all participants have left.

    Return Value

    A call options instance with the call type and the maximum duration values provided as arguments. The recorded flag will be set to the default value (false).

Factory methods

  • Creates an option instance setting the call type to the value provided as argument. The recorded flag will be set to false. The maximum duration value will be set to zero (call will last until all participants have left the call).

    Declaration

    Objective-C

    + (nonnull instancetype)optionsWithCallType:(BDKCallType)callType;

    Parameters

    callType

    The call type.

    Return Value

    A call options instance with the call type provided as argument and the recorded flag and maximumDuration properties set to default values.

  • Creates an option instance setting the call type and the recorded flag to the values provided as arguments. The maximum duration value will be set to zero (call will last until all participants have left the call).

    Declaration

    Objective-C

    + (nonnull instancetype)optionsWithCallType:(BDKCallType)callType
                                   recorded:(BOOL)recorded;

    Parameters

    callType

    The call type.
    recorded

    A flag indicating whether the call should be recorded or not.

    Return Value

    A call options instance with the call type and the recorded flag values provided as argument. The maximumDuration property will be set to the default value (0).

  • Creates an option instance setting the call type and the maximum duration flag to the values provided as arguments. The recorded flag will be set to false.

    Declaration

    Objective-C

    + (nonnull instancetype)optionsWithCallType:(BDKCallType)callType
                                   duration:(NSUInteger)duration;

    Parameters

    callType

    The call type.
    duration

    The maximum duration of the call expressed in seconds. A value of zero means the call will last until all participants have left.

    Return Value

    A call options instance with the call type and the maximum duration values provided as arguments. The recorded flag will be set to the default value (false).

  • Creates an option instance setting the call type, the recorded flag and the maximum duration flag to the values provided as arguments.

    Declaration

    Objective-C

    + (nonnull instancetype)optionsWithCallType:(BDKCallType)callType
                                   recorded:(BOOL)recorded
                                   duration:(NSUInteger)duration;

    Parameters

    callType

    The call type.
    recorded

    A flag indicating whether the call should be recorded or not.
    duration

    The maximum duration of the call expressed in seconds. A value of zero means the call will last until all participants have left.

    Return Value

    A call options instance with the call type and the maximum duration values provided as arguments. The recorded flag will be set to the default value (false).