payfrit-works/twilio/docs/TwilioLib/classes/RESTResponse.html

536 lines
10 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="RESTResponse";
}
</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>&nbsp;</TD>
<TD BGCOLOR="##EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</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/RESTResponse.html" target="_top"><B>FRAMES</B></A> &nbsp;
</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 RESTResponse</H2>
<PRE>WEB-INF.cftags.component
<IMG SRC="../../resources/inherit.gif" ALT="extended by ">twilio.classes.RESTResponse
</PRE>
<HR>
<DL>
<DT>
<PRE>public class <B>RESTResponse</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="RESTResponse.html#init()">init</A></B>([any RequestObj], [struct Response])</CODE>
<BR>
</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>&nbsp;string</CODE></FONT></TD>
<TD><CODE><B><A HREF="RESTResponse.html#asString()">asString</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the response as a string
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;struct</CODE></FONT></TD>
<TD><CODE><B><A HREF="RESTResponse.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>&nbsp;string</CODE></FONT></TD>
<TD><CODE><B><A HREF="RESTResponse.html#getContentLength()">getContentLength</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;string</CODE></FONT></TD>
<TD><CODE><B><A HREF="RESTResponse.html#getContentType()">getContentType</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;string</CODE></FONT></TD>
<TD><CODE><B><A HREF="RESTResponse.html#getETag()">getETag</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;string</CODE></FONT></TD>
<TD><CODE><B><A HREF="RESTResponse.html#getLastModified()">getLastModified</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;string</CODE></FONT></TD>
<TD><CODE><B><A HREF="RESTResponse.html#getStatusCode()">getStatusCode</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;string</CODE></FONT></TD>
<TD><CODE><B><A HREF="RESTResponse.html#getStatusText()">getStatusText</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;any</CODE></FONT></TD>
<TD><CODE><B><A HREF="RESTResponse.html#output()">output</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the response as represented by the CFML engine
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;struct</CODE></FONT></TD>
<TD><CODE><B><A HREF="RESTResponse.html#raw()">raw</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the complete raw HTTP response
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="RESTResponse.html#wasSuccessful()">wasSuccessful</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicate whether the request was successful or not
</TD>
</TR>
</TR>
</TABLE>
&nbsp;
<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>
&nbsp;
<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>([any RequestObj], [struct Response])</CODE>
<dl>
<dd>
<p>
</p>
<dl>
<dt><b>Parameters:</b></dt>
<dd><code>RequestObj</code></dd>
<dd><code>Response</code></dd>
</dl>
</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="asString()"><!-- --></a><h3>
asString</h3>
<code>public string <B>asString</B>()</code>
<dl>
<dd>
Return the response as a string.
<p>
</p></dd>
</dd>
</dl>
<hr>
<a name="dump()"><!-- --></a><h3>
dump</h3>
<code>public struct <B>dump</B>()</code>
<dl>
<dd>
<p>
</p></dd>
</dd>
</dl>
<hr>
<a name="getContentLength()"><!-- --></a><h3>
getContentLength</h3>
<code>public string <B>getContentLength</B>()</code>
<dl>
<dd>
<p>
</p></dd>
</dd>
</dl>
<hr>
<a name="getContentType()"><!-- --></a><h3>
getContentType</h3>
<code>public string <B>getContentType</B>()</code>
<dl>
<dd>
<p>
</p></dd>
</dd>
</dl>
<hr>
<a name="getETag()"><!-- --></a><h3>
getETag</h3>
<code>public string <B>getETag</B>()</code>
<dl>
<dd>
<p>
</p></dd>
</dd>
</dl>
<hr>
<a name="getLastModified()"><!-- --></a><h3>
getLastModified</h3>
<code>public string <B>getLastModified</B>()</code>
<dl>
<dd>
<p>
</p></dd>
</dd>
</dl>
<hr>
<a name="getStatusCode()"><!-- --></a><h3>
getStatusCode</h3>
<code>public string <B>getStatusCode</B>()</code>
<dl>
<dd>
<p>
</p></dd>
</dd>
</dl>
<hr>
<a name="getStatusText()"><!-- --></a><h3>
getStatusText</h3>
<code>public string <B>getStatusText</B>()</code>
<dl>
<dd>
<p>
</p></dd>
</dd>
</dl>
<hr>
<a name="output()"><!-- --></a><h3>
output</h3>
<code>public any <B>output</B>()</code>
<dl>
<dd>
Return the response as represented by the CFML engine.
<p>
</p></dd>
</dd>
</dl>
<hr>
<a name="raw()"><!-- --></a><h3>
raw</h3>
<code>public struct <B>raw</B>()</code>
<dl>
<dd>
Returns the complete raw HTTP response.
<p>
</p></dd>
</dd>
</dl>
<hr>
<a name="wasSuccessful()"><!-- --></a><h3>
wasSuccessful</h3>
<code>public boolean <B>wasSuccessful</B>()</code>
<dl>
<dd>
Indicate whether the request was successful or not.
<p>
</p></dd>
</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>&nbsp;</TD>
<TD BGCOLOR="##EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</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/RESTResponse.html" target="_top"><B>FRAMES</B></A> &nbsp;
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF NAVBAR ========= -->
<HR>
</BODY>
</HTML>