asteriskserver.html

关于asterisk的java包

<HR>

<A NAME="originateToApplication(java.lang.String, java.lang.String, java.lang.String, long, org.asteriskjava.live.CallerId, java.util.Map)"><!-- --></A><H3>
originateToApplication</H3>
<PRE>
<A HREF="../../../org/asteriskjava/live/AsteriskChannel.html" title="interface in org.asteriskjava.live">AsteriskChannel</A> <B>originateToApplication</B>(java.lang.String&nbsp;channel,
                                       java.lang.String&nbsp;application,
                                       java.lang.String&nbsp;data,
                                       long&nbsp;timeout,
                                       <A HREF="../../../org/asteriskjava/live/CallerId.html" title="class in org.asteriskjava.live">CallerId</A>&nbsp;callerId,
                                       java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;variables)
                                       throws <A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A>,
                                              <A HREF="../../../org/asteriskjava/live/NoSuchChannelException.html" title="class in org.asteriskjava.live">NoSuchChannelException</A></PRE>
<DL>
<DD>Generates an outgoing channel to an application and sets an optional map
 of channel variables.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>channel</CODE> - channel name to call, for example "SIP/1310".<DD><CODE>application</CODE> - application to connect to, for example "MeetMe"<DD><CODE>data</CODE> - data to pass to the application, for example "1000|d", may be
                    <code>null</code>.<DD><CODE>timeout</CODE> - how long to wait for the channel to be answered before its
                    considered to have failed (in ms)<DD><CODE>callerId</CODE> - callerId to use for the outgoing channel, may be
                    <code>null</code>.<DD><CODE>variables</CODE> - channel variables to set, may be <code>null</code>.
<DT><B>Returns:</B><DD>the generated channel
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/NoSuchChannelException.html" title="class in org.asteriskjava.live">NoSuchChannelException</A></CODE> - if the channel is not available on the
                                       Asterisk server, for example because you used "SIP/1310" and
                                       1310 is not a valid SIP user, the SIP channel module hasn't
                                       been loaded or the SIP or IAX peer is not registered
                                       currently.
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if the originate action cannot be
                                       sent to Asterisk</DL>
</DD>
</DL>
<HR>

<A NAME="originateToExtensionAsync(java.lang.String, java.lang.String, java.lang.String, int, long, org.asteriskjava.live.OriginateCallback)"><!-- --></A><H3>
originateToExtensionAsync</H3>
<PRE>
void <B>originateToExtensionAsync</B>(java.lang.String&nbsp;channel,
                               java.lang.String&nbsp;context,
                               java.lang.String&nbsp;exten,
                               int&nbsp;priority,
                               long&nbsp;timeout,
                               <A HREF="../../../org/asteriskjava/live/OriginateCallback.html" title="interface in org.asteriskjava.live">OriginateCallback</A>&nbsp;callback)
                               throws <A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></PRE>
<DL>
<DD>Asynchronously generates an outgoing channel to a dialplan entry
 (extension, context, priority).
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>channel</CODE> - channel name to call, for example "SIP/1310".<DD><CODE>context</CODE> - context to connect to<DD><CODE>exten</CODE> - extension to connect to<DD><CODE>priority</CODE> - priority to connect to<DD><CODE>timeout</CODE> - how long to wait for the channel to be answered before its
                 considered to have failed (in ms)<DD><CODE>callback</CODE> - callback to inform about the result
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if the originate action cannot be
                                       sent to Asterisk</DL>
</DD>
</DL>
<HR>

<A NAME="originateToExtensionAsync(java.lang.String, java.lang.String, java.lang.String, int, long, org.asteriskjava.live.CallerId, java.util.Map, org.asteriskjava.live.OriginateCallback)"><!-- --></A><H3>
originateToExtensionAsync</H3>
<PRE>
void <B>originateToExtensionAsync</B>(java.lang.String&nbsp;channel,
                               java.lang.String&nbsp;context,
                               java.lang.String&nbsp;exten,
                               int&nbsp;priority,
                               long&nbsp;timeout,
                               <A HREF="../../../org/asteriskjava/live/CallerId.html" title="class in org.asteriskjava.live">CallerId</A>&nbsp;callerId,
                               java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;variables,
                               <A HREF="../../../org/asteriskjava/live/OriginateCallback.html" title="interface in org.asteriskjava.live">OriginateCallback</A>&nbsp;callback)
                               throws <A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></PRE>
<DL>
<DD>Asynchronously generates an outgoing channel to a dialplan entry
 (extension, context, priority) and sets an optional map of channel
 variables.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>channel</CODE> - channel name to call, for example "SIP/1310".<DD><CODE>context</CODE> - context to connect to<DD><CODE>exten</CODE> - extension to connect to<DD><CODE>priority</CODE> - priority to connect to<DD><CODE>timeout</CODE> - how long to wait for the channel to be answered before its
                  considered to have failed (in ms)<DD><CODE>callerId</CODE> - callerId to use for the outgoing channel, may be
                  <code>null</code>.<DD><CODE>variables</CODE> - channel variables to set, may be <code>null</code>.<DD><CODE>callback</CODE> - callback to inform about the result
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if the originate action cannot be
                                       sent to Asterisk</DL>
</DD>
</DL>
<HR>

<A NAME="originateToApplicationAsync(java.lang.String, java.lang.String, java.lang.String, long, org.asteriskjava.live.OriginateCallback)"><!-- --></A><H3>
originateToApplicationAsync</H3>
<PRE>
void <B>originateToApplicationAsync</B>(java.lang.String&nbsp;channel,
                                 java.lang.String&nbsp;application,
                                 java.lang.String&nbsp;data,
                                 long&nbsp;timeout,
                                 <A HREF="../../../org/asteriskjava/live/OriginateCallback.html" title="interface in org.asteriskjava.live">OriginateCallback</A>&nbsp;callback)
                                 throws <A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></PRE>
<DL>
<DD>Asynchronously generates an outgoing channel to an application.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>channel</CODE> - channel name to call, for example "SIP/1310".<DD><CODE>application</CODE> - application to connect to, for example "MeetMe"<DD><CODE>data</CODE> - data to pass to the application, for example "1000|d", may be
                    <code>null</code>.<DD><CODE>timeout</CODE> - how long to wait for the channel to be answered before its
                    considered to have failed (in ms)<DD><CODE>callback</CODE> - callback to inform about the result
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if the originate action cannot be
                                       sent to Asterisk</DL>
</DD>
</DL>
<HR>

<A NAME="originateToApplicationAsync(java.lang.String, java.lang.String, java.lang.String, long, org.asteriskjava.live.CallerId, java.util.Map, org.asteriskjava.live.OriginateCallback)"><!-- --></A><H3>
originateToApplicationAsync</H3>
<PRE>
void <B>originateToApplicationAsync</B>(java.lang.String&nbsp;channel,
                                 java.lang.String&nbsp;application,
                                 java.lang.String&nbsp;data,
                                 long&nbsp;timeout,
                                 <A HREF="../../../org/asteriskjava/live/CallerId.html" title="class in org.asteriskjava.live">CallerId</A>&nbsp;callerId,
                                 java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;variables,
                                 <A HREF="../../../org/asteriskjava/live/OriginateCallback.html" title="interface in org.asteriskjava.live">OriginateCallback</A>&nbsp;callback)
                                 throws <A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></PRE>
<DL>
<DD>Asynchronously generates an outgoing channel to an application and sets
 an optional map of channel variables.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>channel</CODE> - channel name to call, for example "SIP/1310".<DD><CODE>application</CODE> - application to connect to, for example "MeetMe"<DD><CODE>data</CODE> - data to pass to the application, for example "1000|d", may be
                    <code>null</code>.<DD><CODE>timeout</CODE> - how long to wait for the channel to be answered before its
                    considered to have failed (in ms)<DD><CODE>callerId</CODE> - callerId to use for the outgoing channel, may be
                    <code>null</code>.<DD><CODE>variables</CODE> - channel variables to set, may be <code>null</code>.<DD><CODE>callback</CODE> - callback to inform about the result
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if the originate action cannot be
                                       sent to Asterisk</DL>
</DD>
</DL>
<HR>

<A NAME="getChannels()"><!-- --></A><H3>
getChannels</H3>
<PRE>
java.util.Collection&lt;<A HREF="../../../org/asteriskjava/live/AsteriskChannel.html" title="interface in org.asteriskjava.live">AsteriskChannel</A>&gt; <B>getChannels</B>()
                                                  throws <A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></PRE>
<DL>
<DD>Returns the active channels of the Asterisk server.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a Collection of active channels.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if there is a problem communication
                                       with Asterisk</DL>
</DD>
</DL>
<HR>

<A NAME="getChannelByName(java.lang.String)"><!-- --></A><H3>
getChannelByName</H3>
<PRE>
<A HREF="../../../org/asteriskjava/live/AsteriskChannel.html" title="interface in org.asteriskjava.live">AsteriskChannel</A> <B>getChannelByName</B>(java.lang.String&nbsp;name)
                                 throws <A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></PRE>
<DL>
<DD>Returns a channel by its name.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - name of the channel to return
<DT><B>Returns:</B><DD>the channel with the given name or <code>null</code> if there
         is no such channel.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if there is a problem communication
                                       with Asterisk</DL>
</DD>
</DL>
<HR>

<A NAME="getChannelById(java.lang.String)"><!-- --></A><H3>
getChannelById</H3>
<PRE>
<A HREF="../../../org/asteriskjava/live/AsteriskChannel.html" title="interface in org.asteriskjava.live">AsteriskChannel</A> <B>getChannelById</B>(java.lang.String&nbsp;id)
                               throws <A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></PRE>
<DL>
<DD>Returns a channel by its unique id.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>id</CODE> - the unique id of the channel to return
<DT><B>Returns:</B><DD>the channel with the given unique id or <code>null</code> if
         there is no such channel.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if there is a problem communication
                                       with Asterisk</DL>
</DD>
</DL>
<HR>

<A NAME="getMeetMeRooms()"><!-- --></A><H3>
getMeetMeRooms</H3>
<PRE>
java.util.Collection&lt;<A HREF="../../../org/asteriskjava/live/MeetMeRoom.html" title="interface in org.asteriskjava.live">MeetMeRoom</A>&gt; <B>getMeetMeRooms</B>()
                                                throws <A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></PRE>
<DL>
<DD>Returns the acitve MeetMe rooms on the Asterisk server.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a Collection of MeetMeRooms
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if there is a problem communication
                                       with Asterisk</DL>
</DD>
</DL>
<HR>

<A NAME="getMeetMeRoom(java.lang.String)"><!-- --></A><H3>
getMeetMeRoom</H3>
<PRE>
<A HREF="../../../org/asteriskjava/live/MeetMeRoom.html" title="interface in org.asteriskjava.live">MeetMeRoom</A> <B>getMeetMeRoom</B>(java.lang.String&nbsp;roomNumber)
                         throws <A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></PRE>
<DL>
<DD>Returns the MeetMe room with the given number, if the room does not yet
 exist a new <A HREF="../../../org/asteriskjava/live/MeetMeRoom.html" title="interface in org.asteriskjava.live"><CODE>MeetMeRoom</CODE></A> object is created.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>roomNumber</CODE> - the number of the room to return
<DT><B>Returns:</B><DD>the MeetMe room with the given number.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if there is a problem communication
                                       with Asterisk</DL>
</DD>
</DL>
<HR>

<A NAME="getQueues()"><!-- --></A><H3>
getQueues</H3>
<PRE>
java.util.Collection&lt;<A HREF="../../../org/asteriskjava/live/AsteriskQueue.html" title="interface in org.asteriskjava.live">AsteriskQueue</A>&gt; <B>getQueues</B>()
                                              throws <A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></PRE>
<DL>
<DD>Returns the queues served by the Asterisk server.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a Collection of queues.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if there is a problem communication
                                       with Asterisk</DL>
</DD>
</DL>
<HR>