SINCallNotificationResult

Objective-C

@protocol SINCallNotificationResult <NSObject>

Swift

protocol SINCallNotificationResult : NSObjectProtocol

SINCallNotificationResult is used to indicate the result of -[SINClient relayPushNotificationPayload:] when the Sinch-specific payload in the notification represents an incoming call.

One example of a scenario where SINCallNotificationResult is when a user have been attempted to be reached, but not acted on the notification directly. In that case, the notification result object can indicate that the notification is too old (isTimedOut), and also contains the remoteUserId which can be used for display purposes.

Important

Thread safety notes: All interaction should be done on main thread/main GCD queue.

  • Indicates whether the notification has timed out or not.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly) BOOL isTimedOut;

    Swift

    var isTimedOut: Bool { get }

  • Identifier of the user from which the call represented by the notification originated.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *remoteUserId;

    Swift

    var remoteUserId: String! { get }

  • A unique identifier pertaining to the call

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *callId;

    Swift

    var callId: String! { get }

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

    Declaration

    Objective-C

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

    Swift

    var isVideoOffered: Bool { get }

  • Return headers set by the caller when initiating the call.

    See

    - [SINCallClient callUserWithId: headers:].

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSDictionary *headers;

    Swift

    var headers: [AnyHashable : Any]! { get }