BDKStartOutgoingCallIntent

Objective-C


@interface BDKStartOutgoingCallIntent : NSObject <BDKIntent>

Swift

class StartOutgoingCallIntent : NSObject, Intent

Represents the request of making an outgoing call.

  • The array containing the callees aliases to be called provided on initialization.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSArray<NSString *> *_Nonnull callees;

    Swift

    var callees: [String] { get }

  • The call options.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) BDKCallOptions *_Nonnull options;

    Swift

    var options: BDKCallOptions { get }

  • Initialises a new intent instance with an array of user aliases to be called along with the call options to be used when making an outgoing call.

    Throws an NSInvalidArgumentException if an empty callees array is provided as argument. Throws an NSInvalidArgumentException if nil options are provided as argument.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCallees:(nonnull NSArray<NSString *> *)callees
                                options:(nonnull BDKCallOptions *)options;

    Swift

    init(callees: [String], options: BDKCallOptions)

    Parameters

    callees

    The array of callee aliases. Cannot be empty.
    options

    The call options. Cannot be nil.

    Return Value

    An initialized intent with the callees and the options provided as arguments.

  • Initialize an intent for an audio/video call with the callees provided as arguments. Default call options will be used.

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

    Declaration

    Objective-C

    + (nonnull instancetype)intentWithCallees:
    (nonnull NSArray<NSString *> *)callees;

    Swift

    convenience init(callees: [String])

    Parameters

    callees

    The array of callee aliases. Cannot be empty.

    Return Value

    An initialized intent with the callees provided as argument and default call options.

  • Convenience factory method Initialising an intent for an outgoing call with the callees and the call options provided as arguments.

    Throws an NSInvalidArgumentException if an empty callees array is provided as argument. Throws an NSInvalidArgumentException if nil options are provided as argument.

    Declaration

    Objective-C

    + (nonnull instancetype)intentWithCallees:(nonnull NSArray<NSString *> *)callees
                                  options:(nonnull BDKCallOptions *)options;

    Parameters

    callees

    The array of callee aliases. Cannot be empty.
    options

    The call options. Cannot be nil.

    Return Value

    An initialized intent with the callees provided and the call options provided as arguments.