public interface ErrorInfo
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.Modifier and Type | Method and Description |
---|---|
java.lang.String |
getPhrase()
Get textual phrase from the error info.
|
java.lang.String |
getProtocol()
Get protocol from the error info.
|
int |
getProtocolCode()
Get the status code from the low level protocol (ex a SIP status code).
|
Reason |
getReason()
Get reason code from the error info.
|
int |
getRetryAfter()
Get Retry-After delay second from the error info.
|
ErrorInfo |
getSubErrorInfo()
Get pointer to chained
ErrorInfo set in sub_ei. |
java.lang.Object |
getUserData()
Gets the object stored in this object user's data
|
java.lang.String |
getWarnings()
Provides additional information regarding the failure.
|
void |
set(java.lang.String protocol,
Reason reason,
int code,
java.lang.String statusString,
java.lang.String warning)
Assign information to a
ErrorInfo object. |
void |
setPhrase(java.lang.String phrase)
Assign phrase to a
ErrorInfo object. |
void |
setProtocol(java.lang.String proto)
Assign protocol name to a
ErrorInfo object. |
void |
setProtocolCode(int code)
Assign protocol code to a
ErrorInfo object. |
void |
setReason(Reason reason)
Assign reason LinphoneReason to a
ErrorInfo object. |
void |
setRetryAfter(int retryAfter)
Assign retry-after value to a
ErrorInfo object. |
void |
setSubErrorInfo(ErrorInfo appendedEi)
Set the sub_ei in
ErrorInfo to another LinphoneErrorInfo. |
void |
setUserData(java.lang.Object data)
Sets the object to store in this object user's data
|
void |
setWarnings(java.lang.String warnings)
Assign warnings to a
ErrorInfo object. |
java.lang.String getPhrase()
void setPhrase(java.lang.String phrase)
ErrorInfo
object.phrase
- the phrase explaining the errorjava.lang.String getProtocol()
void setProtocol(java.lang.String proto)
ErrorInfo
object.proto
- the protocol nameint getProtocolCode()
void setProtocolCode(int code)
ErrorInfo
object.code
- the protocol codeReason getReason()
void setReason(Reason reason)
ErrorInfo
object.reason
- reason from LinphoneReason enumint getRetryAfter()
void setRetryAfter(int retryAfter)
ErrorInfo
object.retryAfter
- the retry-after valueErrorInfo getSubErrorInfo()
ErrorInfo
set in sub_ei.
It corresponds to a Reason header in a received SIP response.ErrorInfo
pointer defined in the ei object.void setSubErrorInfo(ErrorInfo appendedEi)
ErrorInfo
to another LinphoneErrorInfo.
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.appendedEi
- ErrorInfo
to appendjava.lang.String getWarnings()
void setWarnings(java.lang.String warnings)
ErrorInfo
object.void set(java.lang.String protocol, Reason reason, int code, java.lang.String statusString, java.lang.String warning)
ErrorInfo
object.warning
- warning messagevoid setUserData(java.lang.Object data)
data
- the object to storejava.lang.Object getUserData()