BDKMakeCallIntent

Objective-C

@interface BDKMakeCallIntent : NSObject <BDKIntent>

Swift

class BDKMakeCallIntent : NSObject, BDKIntent

Represents the request of making an outgoing call.

  • The array of ids for the callee to be called provided on initialization.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSArray<NSString *> *_Nonnull callee;

    Swift

    var callee: [String] { get }

  • A flag representing whether the call should be recorded or not.

    Declaration

    Objective-C

    @property (nonatomic, readonly, getter=shouldRecord) BOOL record;

    Swift

    var shouldRecord: Bool { get }

  • The maximum duration for the call expressed in seconds. A ‘0’ value means the duration is unbounded.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSUInteger maximumDuration;

    Swift

    var maximumDuration: UInt { get }

  • The call type.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BDKCallType callType;

    Swift

    var callType: BDKCallType { get }

  • Initialize an intent for an audio/video call with the callee provided as arguments.

    Throws an NSInvalidArgumentException if an empty callee array is provided as argument.

    Declaration

    Objective-C

    + (nonnull instancetype)intentWithCallee:(nonnull NSArray<NSString *> *)callee;

    Swift

    convenience init(callee: [String])

    Parameters

    callee

    The array of callee ids.

    Return Value

    An initialized intent.

  • Initialize an intent with the callee, types provided as arguments.

    Throws an NSInvalidArgumentException if an empty callee array is provided as argument.*

    Declaration

    Objective-C

    + (nonnull instancetype)intentWithCallee:(nonnull NSArray<NSString *> *)callee
                                    type:(BDKCallType)type;

    Swift

    convenience init(callee: [String], type: BDKCallType)

    Parameters

    callee

    The array of callee ids.
    type

    The type of the call.

    Return Value

    An initialized intent.

  • Initialize an intent with the callee, types and record flag provided as arguments.

    Throws an NSInvalidArgumentException if an empty callee array is provided as argument.

    Declaration

    Objective-C

    + (nonnull instancetype)intentWithCallee:(nonnull NSArray<NSString *> *)callee
                                    type:(BDKCallType)type
                                  record:(BOOL)record;

    Swift

    convenience init(callee: [String], type: BDKCallType, record: Bool)

    Parameters

    callee

    The array of callee ids.
    type

    The type of the call.
    record

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

    Return Value

    An initialized intent.

  • Initialize an intent with the callee, types and duration provided as arguments.

    Throws an NSInvalidArgumentException if an empty callee array is provided as argument.

    Declaration

    Objective-C

    + (nonnull instancetype)intentWithCallee:(nonnull NSArray<NSString *> *)callee
                                    type:(BDKCallType)type
                         maximumDuration:(NSUInteger)duration;

    Swift

    convenience init(callee: [String], type: BDKCallType, maximumDuration duration: UInt)

    Parameters

    callee

    The array of callee ids.
    type

    The type of the call.
    duration

    The maximum duration of the call in seconds. A ‘0’ value means the duration is unbounded.

    Return Value

    An initialized intent.

  • Initialize an intent with the callee, types and options provided as arguments.

    Throws an NSInvalidArgumentException if an empty callee array is provided as argument.

    Declaration

    Objective-C

    + (nonnull instancetype)intentWithCallee:(nonnull NSArray<NSString *> *)callee
                                    type:(BDKCallType)type
                                  record:(BOOL)record
                         maximumDuration:(NSUInteger)duration;

    Swift

    convenience init(callee: [String], type: BDKCallType, record: Bool, maximumDuration duration: UInt)

    Parameters

    callee

    The array of callee ids.
    type

    The type of the call.
    record

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

    The maximum duration of the call in seconds. A ‘0’ value means the duration is unbounded.

    Return Value

    An initialized intent.