StartOutgoingCallIntent

@available(iOS 12.0, *)
@objc(BDKStartOutgoingCallIntent)
public class StartOutgoingCallIntent : NSObject, Intent

Represents the request of making an outgoing call.

  • The intent unique identifier.

    Declaration

    Swift

    @objc
public let uuid: UUID

  • The array containing the ids of the callees to be called.

    Declaration

    Swift

    @objc
public let callees: [String]

  • The call options.

    Declaration

    Swift

    @objc
public let options: CallOptions

Object initialization

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

    Precondition

    callees array must not be empty.

    Declaration

    Swift

    @objc(initWithCallees:options:)
public init(callees: [String], options: CallOptions)

    Parameters

    callees

    The array of callee aliases. Cannot be empty.
    options

    The call options.

    Return Value

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

  • Initialises a new intent instance with an array of user ids to be called. Default call options will be used.

    Precondition

    callees array must not be empty.

    Declaration

    Swift

    public 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.

  • Initialises a new intent instance with an array of user ids to be called. Default call options will be used.

    Declaration

    Swift

    public convenience init(callee: String, otherCallees: String...)

    Parameters

    callee

    The first callee aliases.
    otherCallees

    The array of all other callee aliases after the provided one, if present.

    Return Value

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

  • Initialises a new intent instance with an array of user ids to be called. Default call options will be used.

    Declaration

    Swift

    public convenience init(callee: String, options: CallOptions, otherCallees: String...)

    Parameters

    callee

    The first callee aliases.
    options

    The call options.
    otherCallees

    The array of all other callee aliases after the provided one, if present.

    Return Value

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

Factory Method

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

    Precondition

    callees array must not be empty.

    Declaration

    Swift

    @objc(intentWithCallees:)
public static func intent(with callees: [String]) -> StartOutgoingCallIntent

    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.

    Precondition

    callees array must not be empty.

    Declaration

    Swift

    @objc(intentWithCallees:options:)
public static func intent(with callees: [String], options: CallOptions) -> StartOutgoingCallIntent

    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.