public interface ErrorInfo
ErrorInfo
object returned by the liblinphone API are readonly andModifier and Type | Method and Description |
---|---|
long |
getNativePointer()
Gets the native pointer used by this class to make native method calls.
|
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 status,
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 protocol)
Assign protocol name to a
ErrorInfo object. |
void |
setProtocolCode(int code)
Assign protocol code to a
ErrorInfo object. |
void |
setReason(Reason reason)
|
void |
setRetryAfter(int retryAfter)
Assign retry-after value to a
ErrorInfo object. |
void |
setSubErrorInfo(ErrorInfo appendedErrorInfo)
|
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 |
toString() |
@Nullable java.lang.String getPhrase()
void setPhrase(@Nullable java.lang.String phrase)
phrase
- the phrase explaining the error @Nullable java.lang.String getProtocol()
void setProtocol(@Nullable java.lang.String protocol)
protocol
- the protocol name int getProtocolCode()
void setProtocolCode(int code)
code
- the protocol code int getRetryAfter()
void setRetryAfter(int retryAfter)
retryAfter
- the retry-after value @Nullable ErrorInfo getSubErrorInfo()
ErrorInfo
set in sub_ei. ErrorInfo
pointer defined in the ei object. void setSubErrorInfo(@Nullable ErrorInfo appendedErrorInfo)
ErrorInfo
to another ErrorInfo
. ErrorInfo
defines the SIP response code and phrase, the second (sub)appendedErrorInfo
- ErrorInfo
to append @Nullable java.lang.String getWarnings()
void setWarnings(@Nullable java.lang.String warnings)
warnings
- the warnings void set(@Nullable java.lang.String protocol, Reason reason, int code, @Nullable java.lang.String status, @Nullable java.lang.String warning)
protocol
- protocol name reason
- reason from Reason
enum code
- protocol code status
- description of the reason warning
- warning message void setUserData(java.lang.Object data)
data
- the object to storejava.lang.Object getUserData()
long getNativePointer()
java.lang.String toString()
toString
in class java.lang.Object