SINCallDetails

Objective-C

@protocol SINCallDetails <NSObject>

Swift

protocol SINCallDetails : NSObjectProtocol

The SINCallDetails holds metadata about a call (SINCall).

  • The start time of the call.

    Before the call has started, the value of the startedTime property is nil.

    Declaration

    Objective-C

    @property (atomic, strong, readonly) NSDate *startedTime;

    Swift

    var startedTime: Date! { get }

  • The time where the call did progress, if it reached progressing state.

    Before the call has reached progressing state, the value of the progressedTime property is nil.

    Declaration

    Objective-C

    @property (atomic, strong, readonly) NSDate *progressedTime;

    Swift

    var progressedTime: Date! { get }

  • The time where the call did ring, if it reached ringing state.

    Before the call has reached ringing state, the value of the rungTime property is nil.

    Declaration

    Objective-C

    @property (atomic, strong, readonly) NSDate *rungTime;

    Swift

    var rungTime: Date! { get }

  • The time where the call was answered, if it reached answered state.

    Before the call has reached answered state, the value of the answeredTime property is nil.

    Declaration

    Objective-C

    @property (atomic, strong, readonly) NSDate *answeredTime;

    Swift

    var answeredTime: Date! { get }

  • The time at which the call was established, if it reached established state.

    Before the call has reached established state, the value of the establishedTime property is nil.

    Declaration

    Objective-C

    @property (atomic, strong, readonly) NSDate *establishedTime;

    Swift

    var establishedTime: Date! { get }

  • The end time of the call.

    Before the call has ended, the value of the endedTime property is nil.

    Declaration

    Objective-C

    @property (atomic, strong, readonly) NSDate *endedTime;

    Swift

    var endedTime: Date! { get }

  • Holds the cause of why a call ended, after it has ended. It may be one of the following:

    • SINCallEndCauseNone
    • SINCallEndCauseTimeout
    • SINCallEndCauseDenied
    • SINCallEndCauseNoAnswer
    • SINCallEndCauseError
    • SINCallEndCauseHungUp
    • SINCallEndCauseCanceled
    • SINCallEndCauseOtherDeviceAnswered
    • SINCallEndCauseInactive
    • SINCallEndCauseVoIPCallDetected
    • SINCallEndCauseGSMCallDetected

    If the call has not ended yet, the value is SINCallEndCauseNone.

    Declaration

    Objective-C

    @property (atomic, readonly) SINCallEndCause endCause;

    Swift

    var endCause: SINCallEndCause { get }

  • If the end cause is error, then this property contains an error object that describes the error.

    If the call has not ended yet or if the end cause is not an error, the value of this property is nil.

    Declaration

    Objective-C

    @property (atomic, strong, readonly) NSError *error;

    Swift

    var error: (any Error)! { get }

  • Hint that indicates if video is offered in the call.

    Declaration

    Objective-C

    @property (atomic, readonly, getter=isVideoOffered) BOOL videoOffered;

    Swift

    var isVideoOffered: Bool { get }