ErrorInfo

public class ErrorInfo : LinphoneObject

Object representing full details about a signaling error or status. All ErrorInfo object returned by the liblinphone API are readonly and transcients. For safety they must be used immediately after obtaining them. Any other function call to the liblinphone may change their content or invalidate the pointer.

  • Get textual phrase from the error info. This is the text that is provided by the peer in the protocol (SIP).

    Declaration

    Swift

    public var phrase: String { get set }

    Return Value

    The error phrase

  • Get protocol from the error info.

    Declaration

    Swift

    public var proto: String { get set }

    Return Value

    The protocol

  • Get the status code from the low level protocol (ex a SIP status code).

    Declaration

    Swift

    public var protocolCode: Int { get set }

    Return Value

    The status code

  • Get reason code from the error info.

    Declaration

    Swift

    public var reason: Reason { get set }

    Return Value

    A LinphoneReason

  • Get Retry-After delay second from the error info.

    Declaration

    Swift

    public var retryAfter: Int { get set }

    Return Value

    The Retry-After delay second

  • Get pointer to chained ErrorInfo set in sub_ei. It corresponds to a Reason header in a received SIP response.

    Declaration

    Swift

    public var subErrorInfo: ErrorInfo? { get set }

    Return Value

    ErrorInfo pointer defined in the ei object.

  • Provides additional information regarding the failure. With SIP protocol, the content of “Warning” headers are returned.

    Declaration

    Swift

    public var warnings: String { get set }

    Return Value

    More details about the failure

  • Assign information to a ErrorInfo object.

    Declaration

    Swift

    public func set(proto: String, reason: Reason, code: Int, statusString: String, warning: String)

    Parameters

    proto

    protocol name
    reason

    reason from LinphoneReason enum
    code

    protocol code
    statusString

    description of the reason
    warning

    warning message