asteriskchannel.html

关于asterisk的java包

  <DD>0.3</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getHangupCause()"><!-- --></A><H3>
getHangupCause</H3>
<PRE>
<A HREF="../../../org/asteriskjava/live/HangupCause.html" title="enum in org.asteriskjava.live">HangupCause</A> <B>getHangupCause</B>()</PRE>
<DL>
<DD>Returns the reason for hangup.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the reason for hangup or <code>null</code> if the channel has
         not yet been hung up or no hangup cause is available for this
         type of channel.<DT><B>Since:</B></DT>
  <DD>0.3</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getHangupCauseText()"><!-- --></A><H3>
getHangupCauseText</H3>
<PRE>
java.lang.String <B>getHangupCauseText</B>()</PRE>
<DL>
<DD>Returns a textual representation of the reason for hangup.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the textual representation of the reason for hangup or
         <code>null</code> if the channel has not yet been hung up or no
         hangup cause is available for this type of channel. If no hangup
         cause is available an empty String may be returned, too.<DT><B>Since:</B></DT>
  <DD>0.3</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getCallDetailRecord()"><!-- --></A><H3>
getCallDetailRecord</H3>
<PRE>
<A HREF="../../../org/asteriskjava/live/CallDetailRecord.html" title="interface in org.asteriskjava.live">CallDetailRecord</A> <B>getCallDetailRecord</B>()</PRE>
<DL>
<DD>Returns the call detail record for this channel.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the call detail record for this channel or <code>null</code> if
         none has (yet) been received.</DL>
</DD>
</DL>
<HR>

<A NAME="getDialedChannel()"><!-- --></A><H3>
getDialedChannel</H3>
<PRE>
<A HREF="../../../org/asteriskjava/live/AsteriskChannel.html" title="interface in org.asteriskjava.live">AsteriskChannel</A> <B>getDialedChannel</B>()</PRE>
<DL>
<DD>Returns the channel that has been dialed by this channel most recently,
 this is the destination channel that was created because this channel
 dialed it.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the channel that has been dialed by this channel or
         <code>null</code> if none has been dialed.</DL>
</DD>
</DL>
<HR>

<A NAME="getDialedChannelHistory()"><!-- --></A><H3>
getDialedChannelHistory</H3>
<PRE>
java.util.List&lt;<A HREF="../../../org/asteriskjava/live/DialedChannelHistoryEntry.html" title="class in org.asteriskjava.live">DialedChannelHistoryEntry</A>&gt; <B>getDialedChannelHistory</B>()</PRE>
<DL>
<DD>Returns a list of all channels that have been dialed by this channel.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a list of all channels that have been dialed by this channel.</DL>
</DD>
</DL>
<HR>

<A NAME="getDialingChannel()"><!-- --></A><H3>
getDialingChannel</H3>
<PRE>
<A HREF="../../../org/asteriskjava/live/AsteriskChannel.html" title="interface in org.asteriskjava.live">AsteriskChannel</A> <B>getDialingChannel</B>()</PRE>
<DL>
<DD>Returns the channel that was dialing this channel, this is the source
 channel that created this channel by dialing it.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the channel that was dialing this channel or <code>null</code>
         if none was dialing.</DL>
</DD>
</DL>
<HR>

<A NAME="getLinkedChannel()"><!-- --></A><H3>
getLinkedChannel</H3>
<PRE>
<A HREF="../../../org/asteriskjava/live/AsteriskChannel.html" title="interface in org.asteriskjava.live">AsteriskChannel</A> <B>getLinkedChannel</B>()</PRE>
<DL>
<DD>Returns the channel this channel is currently bridged with, if any.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the channel this channel is bridged with, or <code>null</code>
         if this channel is currently not bridged to another channel.</DL>
</DD>
</DL>
<HR>

<A NAME="getLinkedChannelHistory()"><!-- --></A><H3>
getLinkedChannelHistory</H3>
<PRE>
java.util.List&lt;<A HREF="../../../org/asteriskjava/live/LinkedChannelHistoryEntry.html" title="class in org.asteriskjava.live">LinkedChannelHistoryEntry</A>&gt; <B>getLinkedChannelHistory</B>()</PRE>
<DL>
<DD>Returns a list of all channels this channel was briged with.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a list of all channels this channel was briged with.</DL>
</DD>
</DL>
<HR>

<A NAME="wasLinked()"><!-- --></A><H3>
wasLinked</H3>
<PRE>
boolean <B>wasLinked</B>()</PRE>
<DL>
<DD>Indicates if this channel was linked to another channel at least once.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD><code>true</code> if this channel was linked to another channel
         at least once, <code>false</code> otherwise.<DT><B>Since:</B></DT>
  <DD>0.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getMeetMeUser()"><!-- --></A><H3>
getMeetMeUser</H3>
<PRE>
<A HREF="../../../org/asteriskjava/live/MeetMeUser.html" title="interface in org.asteriskjava.live">MeetMeUser</A> <B>getMeetMeUser</B>()</PRE>
<DL>
<DD>Returns the MeetMeUser associated with this channel if this channel is
 currently taking part in a MeetMe conference.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the MeetMeUser associated with this channel or <code>null</code>
         if this channel is currently not taking part in a MeetMe
         conference.</DL>
</DD>
</DL>
<HR>

<A NAME="hangup()"><!-- --></A><H3>
hangup</H3>
<PRE>
void <B>hangup</B>()
            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>Hangs up this channel.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if the hangup action cannot be sent
             to Asterisk.
<DD><CODE><A HREF="../../../org/asteriskjava/live/NoSuchChannelException.html" title="class in org.asteriskjava.live">NoSuchChannelException</A></CODE> - if this channel had already been hung up
             before the hangup was sent.<DT><B>Since:</B></DT>
  <DD>0.3</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="hangup(org.asteriskjava.live.HangupCause)"><!-- --></A><H3>
hangup</H3>
<PRE>
void <B>hangup</B>(<A HREF="../../../org/asteriskjava/live/HangupCause.html" title="enum in org.asteriskjava.live">HangupCause</A>&nbsp;cause)
            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>Hangs up this channel using a given cause code. The cause code is mainly
 used for Zap PRI channels where it makes Asterisk send a PRI DISCONNECT
 message with the set CAUSE element to the switch.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cause</CODE> - the cause code to send.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if the hangup action cannot be sent
             to Asterisk.
<DD><CODE><A HREF="../../../org/asteriskjava/live/NoSuchChannelException.html" title="class in org.asteriskjava.live">NoSuchChannelException</A></CODE> - if this channel had already been hung up
             before the hangup was sent.<DT><B>Since:</B></DT>
  <DD>0.3</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="setAbsoluteTimeout(int)"><!-- --></A><H3>
setAbsoluteTimeout</H3>
<PRE>
void <B>setAbsoluteTimeout</B>(int&nbsp;seconds)
                        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>Sets the absolute maximum amount of time permitted for a call on a given
 channel, it hangs up the channel after this time.
 <p>
 Time is counted from when you call setAbsoluteTimeout, not from the
 beginning of the call.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>seconds</CODE> - maximum duration of the call in seconds, 0 for unlimited
            call length.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if the absolute timeout action
             cannot be sent to Asterisk.
<DD><CODE><A HREF="../../../org/asteriskjava/live/NoSuchChannelException.html" title="class in org.asteriskjava.live">NoSuchChannelException</A></CODE> - if this channel had already been hung up
             before the absolute timeout was set.<DT><B>Since:</B></DT>
  <DD>0.3</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="redirect(java.lang.String, java.lang.String, int)"><!-- --></A><H3>
redirect</H3>
<PRE>
void <B>redirect</B>(java.lang.String&nbsp;context,
              java.lang.String&nbsp;exten,
              int&nbsp;priority)
              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>Redirects this channel to a new extension.
 <p>
 If this channel is linked to another channel, the linked channel is hung
 up.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>context</CODE> - the destination context.<DD><CODE>exten</CODE> - the destination extension.<DD><CODE>priority</CODE> - the destination priority.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/asteriskjava/live/ManagerCommunicationException.html" title="class in org.asteriskjava.live">ManagerCommunicationException</A></CODE> - if the redirect action cannot be
             sent to Asterisk.
<DD><CODE><A HREF="../../../org/asteriskjava/live/NoSuchChannelException.html" title="class in org.asteriskjava.live">NoSuchChannelException</A></CODE> - if this channel had been hung up before
             the redirect was sent.<DT><B>Since:</B></DT>
  <DD>0.3</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="redirectBothLegs(java.lang.String, java.lang.String, int)"><!-- --></A><H3>
redirectBothLegs</H3>