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.

  • Declaration

    Swift

    public static func getSwiftObject(cObject: OpaquePointer) -> ErrorInfo

  • Declaration

    Swift

    public var getCobject: OpaquePointer? { get }

  • Assign phrase to a ErrorInfo object.

    Declaration

    Swift

    public var phrase: String { get set }

    Return Value

    The error phrase

  • Assign protocol name to a ErrorInfo object.

    Declaration

    Swift

    public var proto: String { get set }

    Return Value

    The protocol.

  • Assign protocol code to a ErrorInfo object.

    Declaration

    Swift

    public var protocolCode: Int { get set }

    Return Value

    The status code

  • Assign reason Reason to a ErrorInfo object.

    Declaration

    Swift

    public var reason: Reason { get set }

    Return Value

    A Reason object

  • Assign retry-after value to a ErrorInfo object.

    Declaration

    Swift

    public var retryAfter: Int { get set }

    Return Value

    The Retry-After delay second

  • Set the sub_ei in ErrorInfo to another ErrorInfo. Used when a reason header is to be added in a SIP response. The first level ErrorInfo defines the SIP response code and phrase, the second (sub)

    LinphoneErroInfo defining the content of the Reason header.

    Declaration

    Swift

    public var subErrorInfo: ErrorInfo? { get set }

    Return Value

    ErrorInfo pointer defined in the ei object.

  • Assign warnings to a ErrorInfo object.

    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, status: String?, warning: String?)

    Parameters

    proto

    protocol name
    reason

    reason from Reason enum
    code

    protocol code
    status

    description of the reason
    warning

    warning message