CallParticipants

@available(iOS 12.0, *)
@objc(BDKCallParticipants)
public protocol CallParticipants : NSObjectProtocol

An object representing the participants inside a call and their state.

Participants

  • all

    An array containing all participants (both caller and callees).

    Declaration

    Swift

    var all: [CallParticipant] { get }

  • An array containing the participants identifiers.

    Declaration

    Swift

    var participantsIds: [String] { get }

  • Returns the participant identified by the identifier provided, if any.

    Declaration

    Swift

    @objc(participantIdentifiedBy:)
func participant(identifiedBy identifier: String) -> CallParticipant?

    Parameters

    identifier

    The identifier of the participant you are looking for.

    Return Value

    The participant object identified by the identifier provided as argument, if any.

Caller

  • The caller.

    Declaration

    Swift

    var caller: CallParticipant { get }

  • The caller id.

    Declaration

    Swift

    var callerId: String { get }

Callee

  • An array of callees and their state in the call.

    Declaration

    Swift

    var callees: [CallParticipant] { get }

  • An array containing the callees identifiers.

    Declaration

    Swift

    var calleesIds: [String] { get }

  • Returns the participant object identified by the identifier provided, among the callees, if any.

    Declaration

    Swift

    @objc(calleeIdentifiedBy:)
func callee(identifiedBy identifier: String) -> CallParticipant?

    Parameters

    identifier

    The participant identifier to look for.

    Return Value

    The participant object identified by the identifier provided as argument, among the callees, if any.

Observers

  • Adds a CallParticipantsObserver notified about changes in the state of a participant.

    Important

    The observer will be notified synchronously on a private background queue. The observer object will be held weakly.

    Declaration

    Swift

    @objc(addObserver:)
func add(observer: CallParticipantsObserver)

    Parameters

    observer

    The observer to be added.

  • Adds a CallParticipantsObserver specifying on which dispatch queue it must be notified.

    When a nil queue is provided the observer will be notified synchronously on a private background queue. Otherwise the observer will be notified asynchronously on the queue provided.

    Important

    The observer will be held weakly.

    Declaration

    Swift

    @objc(addObserver:queue:)
func add(observer: CallParticipantsObserver, queue: DispatchQueue?)

    Parameters

    observer

    The observer to be added
    queue

    The dispatch queue onto which the observer will be notified when an event occurs.

  • Removes a CallParticipantsObserver observer.

    Once removed the observer will not receive participant state change notifications anymore unless it is added once again.

    Declaration

    Swift

    @objc(removeObserver:)
func remove(observer: CallParticipantsObserver)

    Parameters

    observer

    The observer to be removed.