Linphone.ErrorInfo Class Reference

Inheritance diagram for Linphone.ErrorInfo:

Public Member Functions
void	Set (string protocol, Linphone.Reason reason, int code, string status, string warning)

Properties
string	Phrase [get, set]
string	Protocol [get, set]
int	ProtocolCode [get, set]
Linphone.Reason	Reason [get, set]
int	RetryAfter [get, set]
Linphone.ErrorInfo	SubErrorInfo [get, set]
string	Warnings [get, set]

Additional Inherited Members
Protected Member Functions inherited from Linphone.LinphoneObject
static String	linphone_pointer_to_string (IntPtr ptr)
static IntPtr	linphone_string_to_pointer ([MarshalAs(LinphoneWrapper.ByteStringMarshalling)] String str)
IntPtr	StringArrayToBctbxList (IEnumerable< string > stringlist)
void	CleanStringArrayPtrs (IntPtr l)

Detailed Description

Object representing full details about a signaling error or status.

All Linphone.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.

Member Function Documentation

void Linphone.ErrorInfo.Set ( string  protocol, Linphone.Reason  reason, int  code, string  status, string  warning  )

inline

Assign information to a Linphone.ErrorInfo object.

Parameters

protocol	protocol name
reason	reason from Linphone.Reason enum
code	protocol code
status	description of the reason
warning	warning message

Property Documentation

string Linphone.ErrorInfo.Phrase

getset

Get textual phrase from the error info.

This is the text that is provided by the peer in the protocol (SIP).

Returns

The error phrase

string Linphone.ErrorInfo.Protocol

getset

Get protocol from the error info.

Returns

The protocol.

int Linphone.ErrorInfo.ProtocolCode

getset

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

Returns

The status code

Linphone.Reason Linphone.ErrorInfo.Reason

getset

Get reason code from the error info.

Returns

A Linphone.Reason object

int Linphone.ErrorInfo.RetryAfter

getset

Get Retry-After delay second from the error info.

Returns

The Retry-After delay second

Linphone.ErrorInfo Linphone.ErrorInfo.SubErrorInfo

getset

Get pointer to chained Linphone.ErrorInfo set in sub_ei.

It corresponds to a Reason header in a received SIP response.

Returns

Linphone.ErrorInfo pointer defined in the ei object.

string Linphone.ErrorInfo.Warnings

getset

Provides additional information regarding the failure.

With SIP protocol, the content of "Warning" headers are returned.

Returns

More details about the failure.

---

The documentation for this class was generated from the following file:

• LinphoneWrapper.cs