SIPNotification.AI (JVoIP JavaDoc)

webphone
Class SIPNotification.AI

java.lang.Object
  webphone.SIPNotification
      webphone.SIPNotification.AI

Enclosing class:: SIPNotification

public static class SIPNotification.AI
extends SIPNotification
extends SIPNotification

Notifications from AI integration.
Triggered by: AI connection state change
Event: SIPNotificationListener.onAI
Fields: AI,line,callid,status

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

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
`static int`	`STATUS_CONNECTED` websocket connected
`static int`	`STATUS_CONNECTING` websocket connecting
`static int`	`STATUS_DISCONNECTED` stopped
`static int`	`STATUS_ERROR` error
`static int`	`STATUS_INIT` ctor - startup
`static int`	`STATUS_NOTSET` not set yet.
`static int`	`STATUS_RECEIVED` first audio or text received
`static int`	`STATUS_SENDRECV` first audio or text send and received
`static int`	`STATUS_SENT` first audio or text sent
`static int`	`STATUS_SETUP` setup cmd sent
`static int`	`STATUS_TRANSFER` call transfer
`static int`	`STATUS_UNKNOWN` unknown.

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

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`	`getCallID()` SIP Call-ID
`int`	`getLine()` endpoint line
`java.lang.String`	`getPeer()` peer username or phone number
`int`	`getStatAudioRec()` statistics: received audio packets from AI
`int`	`getStatAudioSent()` statistics: sent audio packets to AI
`int`	`getStatTxtRec()` statistics: received text messages from AI
`int`	`getStatTxtSent()` statistics: sent text messages to AI
`int`	`getStatus()` the status as int (STATUS_...
`java.lang.String`	`getStatusText()` the status as string
`java.lang.String`	`isTransferred()` returns the transfer target phone number or username if the call was transferred.

Methods inherited from class webphone.SIPNotification
`getNotificationType, getNotificationTypeText, toString`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

STATUS_NOTSET

public static final int STATUS_NOTSET

not set yet. should not be emitted

See Also:: Constant Field Values

STATUS_INIT

public static final int STATUS_INIT

ctor - startup

See Also:: Constant Field Values

STATUS_CONNECTING

public static final int STATUS_CONNECTING

websocket connecting

See Also:: Constant Field Values

STATUS_CONNECTED

public static final int STATUS_CONNECTED

websocket connected

See Also:: Constant Field Values

STATUS_SETUP

public static final int STATUS_SETUP

setup cmd sent

See Also:: Constant Field Values

STATUS_SENT

public static final int STATUS_SENT

first audio or text sent

See Also:: Constant Field Values

STATUS_RECEIVED

public static final int STATUS_RECEIVED

first audio or text received

See Also:: Constant Field Values

STATUS_SENDRECV

public static final int STATUS_SENDRECV

first audio or text send and received

See Also:: Constant Field Values

STATUS_TRANSFER

public static final int STATUS_TRANSFER

call transfer

See Also:: Constant Field Values

STATUS_DISCONNECTED

public static final int STATUS_DISCONNECTED

stopped

See Also:: Constant Field Values

STATUS_ERROR

public static final int STATUS_ERROR

error

See Also:: Constant Field Values

STATUS_UNKNOWN

public static final int STATUS_UNKNOWN

unknown. should not be emitted

See Also:: Constant Field Values

Method Detail

getLine

public int getLine()

endpoint line

getCallID

public java.lang.String getCallID()

SIP Call-ID

getPeer

public java.lang.String getPeer()

peer username or phone number

getStatus

public int getStatus()

the status as int (STATUS_... constant)

getStatusText

public java.lang.String getStatusText()

the status as string

getStatAudioSent

public int getStatAudioSent()

statistics: sent audio packets to AI

getStatAudioRec

public int getStatAudioRec()

statistics: received audio packets from AI

getStatTxtSent

public int getStatTxtSent()

statistics: sent text messages to AI

getStatTxtRec

public int getStatTxtRec()

statistics: received text messages from AI

isTransferred

public java.lang.String isTransferred()

returns the transfer target phone number or username if the call was transferred. otherwise will return empty string

webphone Class SIPNotification.AI