📄 getvaraction.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!--NewPage--><HTML><HEAD><!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 05 17:57:28 CEST 2007 --><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><TITLE>GetVarAction (Asterisk-Java 0.3.1 API)</TITLE><META NAME="date" CONTENT="2007-09-05"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ if (location.href.indexOf('is-external=true') == -1) { parent.document.title="GetVarAction (Asterisk-Java 0.3.1 API)"; }}</SCRIPT><NOSCRIPT></NOSCRIPT></HEAD><BODY BGCOLOR="white" onload="windowTitle();"><HR><!-- ========= START OF TOP NAVBAR ======= --><A NAME="navbar_top"><!-- --></A><A HREF="#skip-navbar_top" title="Skip navigation links"></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""><TR><TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"><A NAME="navbar_top_firstrow"><!-- --></A><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/GetVarAction.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR></TABLE></TD><TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>Asterisk-Java</EM></TD></TR><TR><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../org/asteriskjava/manager/action/GetConfigAction.html" title="class in org.asteriskjava.manager.action"><B>PREV CLASS</B></A> <A HREF="../../../../org/asteriskjava/manager/action/HangupAction.html" title="class in org.asteriskjava.manager.action"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?org/asteriskjava/manager/action/GetVarAction.html" target="_top"><B>FRAMES</B></A> <A HREF="GetVarAction.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--></SCRIPT><NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A></NOSCRIPT></FONT></TD></TR><TR><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD></TR></TABLE><A NAME="skip-navbar_top"></A><!-- ========= END OF TOP NAVBAR ========= --><HR><!-- ======== START OF CLASS DATA ======== --><H2><FONT SIZE="-1">org.asteriskjava.manager.action</FONT><BR>Class GetVarAction</H2><PRE>java.lang.Object <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/asteriskjava/manager/action/AbstractManagerAction.html" title="class in org.asteriskjava.manager.action">org.asteriskjava.manager.action.AbstractManagerAction</A> <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.asteriskjava.manager.action.GetVarAction</B></PRE><DL><DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, <A HREF="../../../../org/asteriskjava/manager/action/ManagerAction.html" title="interface in org.asteriskjava.manager.action">ManagerAction</A></DD></DL><HR><DL><DT><PRE>public class <B>GetVarAction</B><DT>extends <A HREF="../../../../org/asteriskjava/manager/action/AbstractManagerAction.html" title="class in org.asteriskjava.manager.action">AbstractManagerAction</A></DL></PRE><P>The GetVarAction queries for a global or local channel variable.<p> Reading global variables is supported since Asterisk 1.2.<p> You cannot read built-in channel variables such as <code>LANGUAGE</code> or <code>CALLERIDNUM</code> using the Manager API. You can only read channel variables that you have explicitly set using the <code>Set</code> or <code>SetVar</code> (for Asterisk 1.0.x) applications in the dialplan, in an AGI script or by using the <A HREF="../../../../org/asteriskjava/manager/action/SetVarAction.html" title="class in org.asteriskjava.manager.action"><CODE>SetVarAction</CODE></A> through the Manager API itself.<p> To get the actual value from the corresponding <A HREF="../../../../org/asteriskjava/manager/response/ManagerResponse.html" title="class in org.asteriskjava.manager.response"><CODE>ManagerResponse</CODE></A> call <A HREF="../../../../org/asteriskjava/manager/response/ManagerResponse.html#getAttribute(java.lang.String)"><CODE>ManagerResponse.getAttribute(String)</CODE></A> with either the variable name as parameter (for Asterisk 1.0.x) or with "Value" as parameter (for Asterisk since 1.2).<p> Example (for Asterisk 1.2):<p> <pre> GetVarAction getVarAction = new GetVarAction(channel, "MY_VAR"); ManagerResponse response = c.sendAction(getVarAction); String value = response.getAttribute("Value"); System.out.println("MY_VAR on " + channel + " is " + value); </pre> Where <code>c</code> is an instance of <A HREF="../../../../org/asteriskjava/manager/ManagerConnection.html" title="interface in org.asteriskjava.manager"><CODE>ManagerConnection</CODE></A> and <code>channel</code> contains the name of a channel instance, for example "SIP/1234-9cd". <p> Since Asterisk 1.4 this action also supports built-in functions like <code>DB()</code>, <code>CALLERID()</code> and <code>ENV()</code>.<P><P><DL><DT><B>Version:</B></DT> <DD>$Id: GetVarAction.java 729 2007-05-26 05:16:57Z sprior $</DD><DT><B>Author:</B></DT> <DD>srt</DD><DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.asteriskjava.manager.action.GetVarAction">Serialized Form</A></DL><HR><P><!-- ======== CONSTRUCTOR SUMMARY ======== --><A NAME="constructor_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Constructor Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><B><A HREF="../../../../org/asteriskjava/manager/action/GetVarAction.html#GetVarAction()">GetVarAction</A></B>()</CODE><BR> Creates a new empty GetVarAction.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><B><A HREF="../../../../org/asteriskjava/manager/action/GetVarAction.html#GetVarAction(java.lang.String)">GetVarAction</A></B>(java.lang.String variable)</CODE><BR> Creates a new GetVarAction that queries for the given global variable.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><B><A HREF="../../../../org/asteriskjava/manager/action/GetVarAction.html#GetVarAction(java.lang.String, java.lang.String)">GetVarAction</A></B>(java.lang.String channel, java.lang.String variable)</CODE><BR> Creates a new GetVarAction that queries for the given local channel variable.</TD></TR></TABLE> <!-- ========== METHOD SUMMARY =========== --><A NAME="method_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Method Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/manager/action/GetVarAction.html#getAction()">getAction</A></B>()</CODE><BR> Returns the name of this action, i.e.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/manager/action/GetVarAction.html#getChannel()">getChannel</A></B>()</CODE><BR> Returns the name of the channel if you query for a local channel variable or <code>null</code> if it is a global variable.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/manager/action/GetVarAction.html#getVariable()">getVariable</A></B>()</CODE><BR> Retruns the name of the variable to query.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/manager/action/GetVarAction.html#setChannel(java.lang.String)">setChannel</A></B>(java.lang.String channel)</CODE><BR> Sets the name of the channel if you query for a local channel variable.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -