587 lines
11 KiB
HTML
587 lines
11 KiB
HTML
|
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!--NewPage-->
|
|
<HTML>
|
|
<HEAD>
|
|
<!-- Generated by colddoc on {ts '2011-06-16 08:20:03'} -->
|
|
<TITLE>
|
|
Callable
|
|
</TITLE>
|
|
|
|
<META NAME="keywords" CONTENT="TwilioLib.classes.concurrent.Callable interface">
|
|
|
|
|
|
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
|
|
|
<SCRIPT type="text/javascript">
|
|
function windowTitle()
|
|
{
|
|
parent.document.title="RESTRequest";
|
|
}
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
</NOSCRIPT>
|
|
|
|
</HEAD>
|
|
|
|
<BODY BGCOLOR="white" onload="windowTitle();">
|
|
|
|
|
|
|
|
|
|
<!-- ========= START OF 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>
|
|
|
|
|
|
|
|
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
CFML Twilio Library 1.0</EM>
|
|
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
|
<A HREF="../../index.html?TwilioLib/classes/RESTRequest.html" target="_top"><B>FRAMES</B></A>
|
|
|
|
</FONT></TD>
|
|
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_top"></A>
|
|
<!-- ========= END OF NAVBAR ========= -->
|
|
|
|
<HR>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
TwilioLib.classes</FONT>
|
|
<BR>
|
|
Class RESTRequest</H2>
|
|
|
|
|
|
|
|
<PRE>WEB-INF.cftags.component
|
|
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">TwilioLib.classes.RESTRequest
|
|
</PRE>
|
|
|
|
|
|
|
|
<HR>
|
|
<DL>
|
|
<DT>
|
|
|
|
|
|
|
|
<PRE>public class <B>RESTRequest</B>
|
|
<DT>extends WEB-INF.cftags.component</DT></PRE>
|
|
</DT>
|
|
</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="RESTRequest.html#init()">init</A></B>()</CODE>
|
|
<BR>
|
|
|
|
</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> struct</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="RESTRequest.html#dump()">dump</A></B>()</CODE>
|
|
<BR>
|
|
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> string</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="RESTRequest.html#getApiVersion()">getApiVersion</A></B>()</CODE>
|
|
<BR>
|
|
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> struct</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="RESTRequest.html#getParameters()">getParameters</A></B>()</CODE>
|
|
<BR>
|
|
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> any</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="RESTRequest.html#getResponse()">getResponse</A></B>()</CODE>
|
|
<BR>
|
|
|
|
|
|
Returns the response object
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> string</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="RESTRequest.html#getResponseFormat()">getResponseFormat</A></B>()</CODE>
|
|
<BR>
|
|
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> string</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="RESTRequest.html#getUrl()">getUrl</A></B>()</CODE>
|
|
<BR>
|
|
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> string</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="RESTRequest.html#getValidParameterList()">getValidParameterList</A></B>()</CODE>
|
|
<BR>
|
|
|
|
|
|
Returns a list of all the valid parameters for all the REST resources
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>package void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="RESTRequest.html#handleResponse()">handleResponse</A></B>([struct response])</CODE>
|
|
<BR>
|
|
|
|
|
|
Handles the response that is returned from Twilio
|
|
</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="RESTRequest.html#setApiVersion()">setApiVersion</A></B>([string ApiVersion])</CODE>
|
|
<BR>
|
|
|
|
</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="RESTRequest.html#setParameters()">setParameters</A></B>([string Type], [struct Values])</CODE>
|
|
<BR>
|
|
|
|
</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="RESTRequest.html#setResponseFormat()">setResponseFormat</A></B>([string ResponseFormat])</CODE>
|
|
<BR>
|
|
|
|
</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="RESTRequest.html#setUrl()">setUrl</A></B>([string Url])</CODE>
|
|
<BR>
|
|
|
|
</TD>
|
|
</TR>
|
|
|
|
</TR>
|
|
</TABLE>
|
|
|
|
|
|
|
|
|
|
<a name="methods_inherited_from_class_WEB-INF.cftags.component"><!-- --></a>
|
|
<table summary="" border="1" cellpadding="3" cellspacing="0" width="100%">
|
|
<tbody><tr class="TableSubHeadingColor" bgcolor="#eeeeff">
|
|
<th align="left"><b>Methods inherited from class WEB-INF.cftags.component</b></th>
|
|
</tr>
|
|
<tr class="TableRowColor" bgcolor="white">
|
|
<td>
|
|
|
|
|
|
<code></code>
|
|
</td>
|
|
</tr>
|
|
</tbody></table>
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
|
<a name="constructor_detail"><!-- --></a>
|
|
</p><table summary="" border="1" cellpadding="3" cellspacing="0" width="100%">
|
|
<tbody><tr class="TableHeadingColor" bgcolor="#ccccff">
|
|
<th colspan="1" align="left"><font size="+2">
|
|
<b>Constructor Detail</b></font></th>
|
|
</tr>
|
|
</tbody></table>
|
|
|
|
<a name="init()"><!-- --></a><h3>
|
|
|
|
init</h3>
|
|
<CODE>public <B>init</B>()</CODE>
|
|
<dl>
|
|
<dd>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
|
|
<a name="method_detail"><!-- --></a>
|
|
<table summary="" border="1" cellpadding="3" cellspacing="0" width="100%">
|
|
<tbody><tr class="TableHeadingColor" bgcolor="#ccccff">
|
|
<th colspan="1" align="left"><font size="+2">
|
|
<b>Method Detail</b></font></th>
|
|
</tr>
|
|
</tbody></table>
|
|
|
|
<a name="dump()"><!-- --></a><h3>
|
|
dump</h3>
|
|
<code>public struct <B>dump</B>()</code>
|
|
|
|
<dl>
|
|
<dd>
|
|
|
|
<p>
|
|
</p></dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<hr>
|
|
|
|
<a name="getApiVersion()"><!-- --></a><h3>
|
|
getApiVersion</h3>
|
|
<code>public string <B>getApiVersion</B>()</code>
|
|
|
|
<dl>
|
|
<dd>
|
|
|
|
<p>
|
|
</p></dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<hr>
|
|
|
|
<a name="getParameters()"><!-- --></a><h3>
|
|
getParameters</h3>
|
|
<code>public struct <B>getParameters</B>()</code>
|
|
|
|
<dl>
|
|
<dd>
|
|
|
|
<p>
|
|
</p></dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<hr>
|
|
|
|
<a name="getResponse()"><!-- --></a><h3>
|
|
getResponse</h3>
|
|
<code>public any <B>getResponse</B>()</code>
|
|
|
|
<dl>
|
|
<dd>
|
|
Returns the response object.
|
|
<p>
|
|
</p></dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<hr>
|
|
|
|
<a name="getResponseFormat()"><!-- --></a><h3>
|
|
getResponseFormat</h3>
|
|
<code>public string <B>getResponseFormat</B>()</code>
|
|
|
|
<dl>
|
|
<dd>
|
|
|
|
<p>
|
|
</p></dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<hr>
|
|
|
|
<a name="getUrl()"><!-- --></a><h3>
|
|
getUrl</h3>
|
|
<code>public string <B>getUrl</B>()</code>
|
|
|
|
<dl>
|
|
<dd>
|
|
|
|
<p>
|
|
</p></dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<hr>
|
|
|
|
<a name="getValidParameterList()"><!-- --></a><h3>
|
|
getValidParameterList</h3>
|
|
<code>public string <B>getValidParameterList</B>()</code>
|
|
|
|
<dl>
|
|
<dd>
|
|
Returns a list of all the valid parameters for all the REST resources.
|
|
<p>
|
|
</p></dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<hr>
|
|
|
|
<a name="handleResponse()"><!-- --></a><h3>
|
|
handleResponse</h3>
|
|
<code>package void <B>handleResponse</B>([struct response])</code>
|
|
|
|
<dl>
|
|
<dd>
|
|
Handles the response that is returned from Twilio.
|
|
<p>
|
|
</p></dd>
|
|
|
|
|
|
<dl>
|
|
<dt><b>Parameters:</b></dt>
|
|
|
|
<dd><code>response</code></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<hr>
|
|
|
|
<a name="setApiVersion()"><!-- --></a><h3>
|
|
setApiVersion</h3>
|
|
<code>public void <B>setApiVersion</B>([string ApiVersion])</code>
|
|
|
|
<dl>
|
|
<dd>
|
|
|
|
<p>
|
|
</p></dd>
|
|
|
|
|
|
<dl>
|
|
<dt><b>Parameters:</b></dt>
|
|
|
|
<dd><code>ApiVersion</code></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<hr>
|
|
|
|
<a name="setParameters()"><!-- --></a><h3>
|
|
setParameters</h3>
|
|
<code>public void <B>setParameters</B>([string Type], [struct Values])</code>
|
|
|
|
<dl>
|
|
<dd>
|
|
|
|
<p>
|
|
</p></dd>
|
|
|
|
|
|
<dl>
|
|
<dt><b>Parameters:</b></dt>
|
|
|
|
<dd><code>Type</code></dd>
|
|
|
|
<dd><code>Values</code></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<hr>
|
|
|
|
<a name="setResponseFormat()"><!-- --></a><h3>
|
|
setResponseFormat</h3>
|
|
<code>public void <B>setResponseFormat</B>([string ResponseFormat])</code>
|
|
|
|
<dl>
|
|
<dd>
|
|
|
|
<p>
|
|
</p></dd>
|
|
|
|
|
|
<dl>
|
|
<dt><b>Parameters:</b></dt>
|
|
|
|
<dd><code>ResponseFormat</code></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<hr>
|
|
|
|
<a name="setUrl()"><!-- --></a><h3>
|
|
setUrl</h3>
|
|
<code>public void <B>setUrl</B>([string Url])</code>
|
|
|
|
<dl>
|
|
<dd>
|
|
|
|
<p>
|
|
</p></dd>
|
|
|
|
|
|
<dl>
|
|
<dt><b>Parameters:</b></dt>
|
|
|
|
<dd><code>Url</code></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<hr>
|
|
|
|
|
|
<!-- ========= START OF 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>
|
|
|
|
|
|
|
|
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
CFML Twilio Library 1.0</EM>
|
|
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
|
<A HREF="../../index.html?TwilioLib/classes/RESTRequest.html" target="_top"><B>FRAMES</B></A>
|
|
|
|
</FONT></TD>
|
|
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_top"></A>
|
|
<!-- ========= END OF NAVBAR ========= -->
|
|
|
|
<HR>
|
|
|
|
</BODY>
|
|
</HTML>
|