webphone
Class SIPNotification.APIResult

java.lang.Object
  extended by webphone.SIPNotification
      extended by webphone.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 webphone.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 webphone.SIPNotification
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_USSD, NOTIFICATION_VAD, NOTIFICATION_VIDEO, NOTIFICATION_VREC
 
Method Summary
 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.
 
Methods inherited from class webphone.SIPNotification
getNotificationType, getNotificationTypeText, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

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"