Structures

The following structures are available globally.

  • SinchCallNotificationResult is used to indicate the result of SinchClient.relayPushNotification when the Sinch-specific payload in the notification represents an incoming call.

    One example of a scenario where SinchCallNotificationResult 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.

    See more

    Declaration

    Swift

    public struct SinchCallNotificationResult
  • SinchNotificationResult is used to indicate the result of SinchClient.relayPushNotification(withUserInfo:) and queryPushNotificationPayload(_:).

    Example use:

    let result = self.client.relayPushNotification(withUserInfo: payload)
    
    if (result.isCall && result.callResult.isTimedOut) {
        let remoteUserId = result.callResult.remoteUserId;
        // Present UI indicating user missed the call.
    }
    

    It can be especially useful for scenarios which will not result in the SinchClientDelegate receiving any callback for an incoming call as a result of calling the methods mentioned above. One such scenario 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.

    See more

    Declaration

    Swift

    public struct SinchNotificationResult
  • Options for dialing a phone number through the Sinch Voice V2 platform.

    Warning

    Beta API. It is functional, but its signature or behaviour may change in a future release without going through the usual deprecation cycle.
    See more

    Declaration

    Swift

    public struct SinchDialPhoneNumberOptions
  • Options for dialing a SIP endpoint through the Sinch Voice V2 platform.

    Warning

    Beta API. It is functional, but its signature or behaviour may change in a future release without going through the usual deprecation cycle.
    See more

    Declaration

    Swift

    public struct SinchDialSipOptions
  • Audio stream configuration for a stream dial.

    A nil property is omitted from the dial request and the Voice V2 platform applies its default.

    Warning

    Beta API. It is functional, but its signature or behaviour may change in a future release without going through the usual deprecation cycle.
    See more

    Declaration

    Swift

    public struct SinchDialStreamConfiguration
  • Options for dialing an audio stream through the Sinch Voice V2 platform.

    Warning

    Beta API. It is functional, but its signature or behaviour may change in a future release without going through the usual deprecation cycle.
    See more

    Declaration

    Swift

    public struct SinchDialStreamOptions
  • Options for dialing a Voice Relay endpoint through the Sinch Voice V2 platform.

    Voice Relay connects the call to speech-to-text (STT) and text-to-speech (TTS) services through a WebSocket endpoint. A nil optional property is omitted from the dial request and the Voice V2 platform applies its default.

    See Voice locales for the available voices and locales.

    Warning

    Beta API. It is functional, but its signature or behaviour may change in a future release without going through the usual deprecation cycle.
    See more

    Declaration

    Swift

    public struct SinchDialVoiceRelayOptions