com.mizuvoip.jvoip

Class SIPNotification.APIResult

java.lang.Object

com.mizuvoip.jvoip.SIPNotification

com.mizuvoip.jvoip.SIPNotification.APIResult

Enclosing class:

SIPNotification

public static class SIPNotification.APIResult
extends SIPNotification

API return value notification.
Triggered by: API calls.
Event: SIPNotificationListener.onAPIResult
Fields: USSD,id,function,result

Nested Class Summary

Nested classes/interfaces inherited from class com.mizuvoip.jvoip.SIPNotification

SIPNotification.Account, SIPNotification.AI, SIPNotification.Answer, SIPNotification.APIResult, SIPNotification.BLF, SIPNotification.Block, SIPNotification.CDR, SIPNotification.Chat, SIPNotification.ChatComposing, SIPNotification.ChatReport, SIPNotification.Credit, SIPNotification.DTMF, SIPNotification.Event, SIPNotification.Group, SIPNotification.INFO, SIPNotification.LicKey, SIPNotification.Line, SIPNotification.Log, SIPNotification.Media, SIPNotification.MWI, SIPNotification.NewContact, SIPNotification.PlayReady, SIPNotification.Popup, SIPNotification.Presence, SIPNotification.Rating, SIPNotification.Register, SIPNotification.RTPE, SIPNotification.RTPStat, SIPNotification.RTPT, SIPNotification.ServerContacts, SIPNotification.ShouldReset, SIPNotification.SIP, SIPNotification.SRS, SIPNotification.Start, SIPNotification.Status, SIPNotification.Stop, SIPNotification.USSD, SIPNotification.VAD, SIPNotification.Video, SIPNotification.Vrec

Field Summary

Fields inherited from class com.mizuvoip.jvoip.SIPNotification

line, NOTIFICATION_ACCOUNT, NOTIFICATION_AI, NOTIFICATION_ALL, NOTIFICATION_ANSWER, NOTIFICATION_APIRESULT, NOTIFICATION_BLF, NOTIFICATION_BLOCK, NOTIFICATION_CDR, NOTIFICATION_CHAT, NOTIFICATION_CHATCOMPOSING, NOTIFICATION_CHATREPORT, NOTIFICATION_CREDIT, NOTIFICATION_DTMF, NOTIFICATION_EVENT, NOTIFICATION_GROUP, NOTIFICATION_INFO, NOTIFICATION_INVALID, NOTIFICATION_LICKEY, NOTIFICATION_LINE, NOTIFICATION_LOG, NOTIFICATION_MEDIA, NOTIFICATION_MWI, NOTIFICATION_NEWUSER, NOTIFICATION_PLAYREADY, NOTIFICATION_POPUP, NOTIFICATION_PRESENCE, NOTIFICATION_RATING, NOTIFICATION_REGISTER, NOTIFICATION_RTPE, NOTIFICATION_RTPSTAT, NOTIFICATION_RTPT, NOTIFICATION_SERVERCONTACTS, NOTIFICATION_SHOULDRESET, NOTIFICATION_SIP, NOTIFICATION_SRS, NOTIFICATION_START, NOTIFICATION_STATUS, NOTIFICATION_STOP, notification_string, notification_type, NOTIFICATION_USSD, NOTIFICATION_VAD, NOTIFICATION_VIDEO, NOTIFICATION_VREC

Constructor Summary

Constructors

Constructor and Description
APIResult()
APIResult(Common common_in)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFunction() the API function name in lower case (for example "api_call") for which the result is returned
int	getId() API call ID if you passed it (you can use an auto-increment sequence number)
java.lang.String	getResult() the API return value as string.
void	Parse(java.lang.String str, java.lang.String[] params)

Methods inherited from class com.mizuvoip.jvoip.SIPNotification

getNotificationType, getNotificationTypeText, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

APIResult

public APIResult()

APIResult

public APIResult(Common common_in)

Method Detail

getId

public int getId()

API call ID if you passed it (you can use an auto-increment sequence number)

getFunction

public java.lang.String getFunction()

the API function name in lower case (for example "api_call") for which the result is returned

getResult

public java.lang.String getResult()

the API return value as string. int will be converted to string, boolean will be converted to "true"/"false". The API call failed if it begins with "ERROR"

Parse

public void Parse(java.lang.String str,
                  java.lang.String[] params)