📄 java.telephony.events.ev.html
字号:
<!--NewPage--><html><head><!-- Generated by javadoc on Fri Feb 07 16:42:30 PST 1997 --><a name="_top_"></a><title> Interface java.telephony.events.Ev</title></head><body><pre><a href="packages.html">All Packages</a> <a href="tree.html">Class Hierarchy</a> <a href="Package-java.telephony.events.html">This Package</a> <a href="java.telephony.events.ConnUnknownEv.html#_top_">Previous</a> <a href="java.telephony.events.ProvEv.html#_top_">Next</a> <a href="AllNames.html">Index</a></pre><hr><h1> Interface java.telephony.events.Ev</h1><dl> <dt> public interface <b>Ev</b> <dt> extends <a href="java.lang.Object.html#_top_">Object</a></dl>The Ev interface is the parent of all the specific event interfaces.All JTAPI events must extends this interface.<p>The event system is designed to notify event observers when objects inthe call model are changed by the telephony resource (telco switch, ISDNline, phone card, IP connection, etc.). The call model itself describesthe state of the switch, and the event system describes the last change tothat model.<p>Whenever the call model changes, events are sent to all appropriateobservers. Evs occur in the same order as changes made to the callmodel.<p>The getCause() method returns a cause code. All JTAPI eventshave a cause code associated with them. The cause codes listed here areonly an initial listing, more will be added later.<p>The getID() method returns an event id. All JTAPI events have an eventid which matches the object type.<p>There are four objects which can receive events: Provider, Terminal,Address, and Call. All events are grouped into one of these four typesof events. See ProvEv, TermEv, AddrEv, and CallEvfor a listing of event types within each of those groups.<p>The <STRONG>java.telephony.events.Ev</STRONG> interfaces supports the<EM>getMetaCode()</EM> method which returns the "meta-code" for theevent. The meta-code describes the higher-level action going on as thecall changes state. Since events represent singular changes in a paritularobject in a call model and many changes in the call model result in anumber of events being generated, it may be difficult for the applicationto figure out the higher-level action taking place. The meta-code ispresent on the event for provide this information.<p>In one batch of events delivered to applications, there may be severalgroupings of these events belonging to the same higher-level action andcan be described by the same meta-code. Implementations are contrainedthat they must deliver all events belonging to the same higher-level meta-code consecutively. That is, if an event batch contains events with ameta-code of META_CALL_REMOVING_PARTY and events with a meta-code ofMETA_CALL_ADDING_PARTY, these two groups of events must be together inthe array of events sent to the observer.<p>It is possible for two event batches with the same meta-code to arrivecontiguously in time. Applications which need to disambiguate these batches can use the <EM>isNewMetaEvent()</EM> to moniter the start ofeach new meta-code group.<p>There are five types of meta-codes which pertain to individual calls,and two which pertain to a mutli-call action. The five meta-codes whichpertain to individual calls are:<p>META_CALL_STARTING: Indicates that a new active call has been presenting tothe application, either by an application creating a call and performingan action on it, or by an incoming call to an object being observed bythe application.<p>META_CALL_PROGRESS: Indicates that the objects belonging to a call havechanged state, with the exception of Connections moving to DISCONNECTED.For example, when a remote party answers a telephone call and thecorresponding Connection moves into the CONNECTED state, the meta-codeboth the resulting batch of events is META_CALL_PROGRESS.<p>META_CALL_ADDING_PARTY: Indicates that a party has been addeed to the call.A "party" corresponds to a Connection being added. Note that if aTerminalConnection is added, it is listed as a META_CALL_PROGRESS.<p>META_CALL_REMOVING_PARTY: Indicates that a party (i.e. Connection) hasbeen removed from the call by moving into the DISCONNECTED state and allof its TerminalConnections (if any) have moving into the DROPPED state.<p>META_CALL_ENDING: Indicates that an entire telephone call has ended, whichimplies the call has moved into the INVALID state and all of itsConnections and associated TerminalConnections have moved into theDISCONNECTED and DROPPED state, respectively.<p>The two meta-codes pertaining to a mutli-call actions are as follows:<p>META_CALL_MERGING: Indicates that a party has moved from one call toanother as part of the two calls merging. A common example is when twotelephone calls are conferenced.<p>META_CALL_TRANFERRING: Indicates that a party has moved from one call toanother as part of one call being transferred to another. The differs fromMETA_CALL_MERGING because a common party to both calls drops off bothcalls.<hr><a name="index"></a><h2> <img src="images/variable-index.gif" width=207 height=38 alt="Variable Index"></h2><dl> <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o "> <a href="#CAUSE_CALL_CANCELLED"><b>CAUSE_CALL_CANCELLED</b></a> <dd> Cause code indicating the user has terminatedcall without going on-hook <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o "> <a href="#CAUSE_DEST_NOT_OBTAINABLE"><b>CAUSE_DEST_NOT_OBTAINABLE</b></a> <dd> Cause code indicating the destination is notavailable <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o "> <a href="#CAUSE_INCOMPATIBLE_DESTINATION"><b>CAUSE_INCOMPATIBLE_DESTINATION</b></a> <dd> Cause code indicating that a call has encounteredan incompatible destination <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o "> <a href="#CAUSE_LOCKOUT"><b>CAUSE_LOCKOUT</b></a> <dd> Cause code indicating that a call encountered interdigit timeout while dialing <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o "> <a href="#CAUSE_NETWORK_CONGESTION"><b>CAUSE_NETWORK_CONGESTION</b></a> <dd> Cause code indicating call encountered network congestion <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o "> <a href="#CAUSE_NETWORK_NOT_OBTAINABLE"><b>CAUSE_NETWORK_NOT_OBTAINABLE</b></a> <dd> Cause code indicating call could not reach a destination network <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o "> <a href="#CAUSE_NEW_CALL"><b>CAUSE_NEW_CALL</b></a> <dd> Cause code indicating that a new call <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o "> <a href="#CAUSE_NORMAL"><b>CAUSE_NORMAL</b></a> <dd> Cause code indicating normal operation <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o "> <a href="#CAUSE_RESOURCES_NOT_AVAILABLE"><b>CAUSE_RESOURCES_NOT_AVAILABLE</b></a> <dd> Cause code indicating resouces were not available <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o "> <a href="#CAUSE_SNAPSHOT"><b>CAUSE_SNAPSHOT</b></a> <dd> Cause code indicating that the event is part of a snapshot of thecurrent state of the call. <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o "> <a href="#CAUSE_UNKNOWN"><b>CAUSE_UNKNOWN</b></a> <dd> Cause code indicating the cause was unknown <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o "> <a href="#META_CALL_ADDITIONAL_PARTY"><b>META_CALL_ADDITIONAL_PARTY</b></a> <dd> Meta-code description for addition of a party to call. <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o "> <a href="#META_CALL_ENDING"><b>META_CALL_ENDING</b></a> <dd> Meta-code description for the entire call ending. <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o "> <a href="#META_CALL_MERGING"><b>META_CALL_MERGING</b></a> <dd> Meta-code description for an action of merging two calls. <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o "> <a href="#META_CALL_PROGRESS"><b>META_CALL_PROGRESS</b></a> <dd> <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o "> <a href="#META_CALL_REMOVING_PARTY"><b>META_CALL_REMOVING_PARTY</b></a> <dd> Meta-code description for a party leaving the call. <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o "> <a href="#META_CALL_STARTING"><b>META_CALL_STARTING</b></a> <dd> <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o "> <a href="#META_CALL_TRANFERRING"><b>META_CALL_TRANFERRING</b></a> <dd> Meta-code description for an action of transfering one call to another.</dl><h2> <img src="images/method-index.gif" width=207 height=38 alt="Method Index"></h2><dl> <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o "> <a href="#getCause()"><b>getCause</b></a>() <dd> Returns the cause associated with this event. <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o "> <a href="#getID()"><b>getID</b></a>() <dd> Returns the id of event. <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o "> <a href="#getMetaCode()"><b>getMetaCode</b></a>() <dd> Returns the meta-code associated with this event. <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o "> <a href="#getObserved()"><b>getObserved</b></a>() <dd> Returns the object that is being observed. <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o "> <a href="#isNewMetaEvent()"><b>isNewMetaEvent</b></a>() <dd> </dl><a name="variables"></a><h2> <img src="images/variables.gif" width=153 height=38 alt="Variables"></h2><a name="CAUSE_NORMAL"><img src="images/blue-ball.gif" width=12 height=12 alt=" o "></a><b>CAUSE_NORMAL</b><pre> public final static int CAUSE_NORMAL</pre><dl> <dd> Cause code indicating normal operation</dl><a name="CAUSE_UNKNOWN"><img src="images/blue-ball.gif" width=12 height=12 alt=" o "></a><b>CAUSE_UNKNOWN</b><pre>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -