doc/api/classes/ActionWebService/API/Method.html
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Class: ActionWebService::API::Method</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">ActionWebService::API::Method</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../../files/vendor/rails/actionwebservice/lib/action_web_service/api_rb.html">
vendor/rails/actionwebservice/lib/action_web_service/api.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
Object
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
Represents an API method and its associated metadata, and provides
functionality to assist in commonly performed API method tasks.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000477">[]</a>
<a href="#M000473">cast_expects</a>
<a href="#M000474">cast_returns</a>
<a href="#M000475">expects_index_of</a>
<a href="#M000476">expects_to_hash</a>
<a href="#M000471">new</a>
<a href="#M000472">param_names</a>
<a href="#M000478">to_s</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<div id="attribute-list">
<h3 class="section-bar">Attributes</h3>
<div class="name-list">
<table>
<tr class="top-aligned-row context-row">
<td class="context-item-name">expects</td>
<td class="context-item-value"> [R] </td>
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">name</td>
<td class="context-item-value"> [R] </td>
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">public_name</td>
<td class="context-item-value"> [R] </td>
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">returns</td>
<td class="context-item-value"> [R] </td>
<td class="context-item-desc"></td>
</tr>
</table>
</div>
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000471" class="method-detail">
<a name="M000471"></a>
<div class="method-heading">
<a href="#M000471" class="method-signature">
<span class="method-name">new</span><span class="method-args">(name, public_name, expects, returns)</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000471-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000471-source">
<pre>
<span class="ruby-comment cmt"># File vendor/rails/actionwebservice/lib/action_web_service/api.rb, line 172</span>
172: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">public_name</span>, <span class="ruby-identifier">expects</span>, <span class="ruby-identifier">returns</span>)
173: <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
174: <span class="ruby-ivar">@public_name</span> = <span class="ruby-identifier">public_name</span>
175: <span class="ruby-ivar">@expects</span> = <span class="ruby-identifier">expects</span>
176: <span class="ruby-ivar">@returns</span> = <span class="ruby-identifier">returns</span>
177: <span class="ruby-ivar">@caster</span> = <span class="ruby-constant">ActionWebService</span><span class="ruby-operator">::</span><span class="ruby-constant">Casting</span><span class="ruby-operator">::</span><span class="ruby-constant">BaseCaster</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>)
178: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000477" class="method-detail">
<a name="M000477"></a>
<div class="method-heading">
<a href="#M000477" class="method-signature">
<span class="method-name">[]</span><span class="method-args">(sig_type)</span>
</a>
</div>
<div class="method-description">
<p>
Backwards compatibility with previous API
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000477-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000477-source">
<pre>
<span class="ruby-comment cmt"># File vendor/rails/actionwebservice/lib/action_web_service/api.rb, line 216</span>
216: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">sig_type</span>)
217: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">sig_type</span>
218: <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:expects</span>
219: <span class="ruby-ivar">@expects</span>.<span class="ruby-identifier">map</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">compat_signature_entry</span>(<span class="ruby-identifier">x</span>)}
220: <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:returns</span>
221: <span class="ruby-ivar">@returns</span>.<span class="ruby-identifier">map</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">compat_signature_entry</span>(<span class="ruby-identifier">x</span>)}
222: <span class="ruby-keyword kw">end</span>
223: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000473" class="method-detail">
<a name="M000473"></a>
<div class="method-heading">
<a href="#M000473" class="method-signature">
<span class="method-name">cast_expects</span><span class="method-args">(params)</span>
</a>
</div>
<div class="method-description">
<p>
Casts a set of Ruby values into the expected Ruby values
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000473-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000473-source">
<pre>
<span class="ruby-comment cmt"># File vendor/rails/actionwebservice/lib/action_web_service/api.rb, line 187</span>
187: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">cast_expects</span>(<span class="ruby-identifier">params</span>)
188: <span class="ruby-ivar">@caster</span>.<span class="ruby-identifier">cast_expects</span>(<span class="ruby-identifier">params</span>)
189: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000474" class="method-detail">
<a name="M000474"></a>
<div class="method-heading">
<a href="#M000474" class="method-signature">
<span class="method-name">cast_returns</span><span class="method-args">(return_value)</span>
</a>
</div>
<div class="method-description">
<p>
Cast a Ruby return value into the expected Ruby value
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000474-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000474-source">
<pre>
<span class="ruby-comment cmt"># File vendor/rails/actionwebservice/lib/action_web_service/api.rb, line 192</span>
192: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">cast_returns</span>(<span class="ruby-identifier">return_value</span>)
193: <span class="ruby-ivar">@caster</span>.<span class="ruby-identifier">cast_returns</span>(<span class="ruby-identifier">return_value</span>)
194: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000475" class="method-detail">
<a name="M000475"></a>
<div class="method-heading">
<a href="#M000475" class="method-signature">
<span class="method-name">expects_index_of</span><span class="method-args">(param_name)</span>
</a>
</div>
<div class="method-description">
<p>
Returns the index of the first expected parameter with the given name
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000475-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000475-source">
<pre>
<span class="ruby-comment cmt"># File vendor/rails/actionwebservice/lib/action_web_service/api.rb, line 198</span>
198: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">expects_index_of</span>(<span class="ruby-identifier">param_name</span>)
199: <span class="ruby-keyword kw">return</span> <span class="ruby-value">-1</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@expects</span>.<span class="ruby-identifier">nil?</span>
200: (<span class="ruby-value">0</span><span class="ruby-operator">..</span>(<span class="ruby-ivar">@expects</span>.<span class="ruby-identifier">length</span><span class="ruby-operator">-</span><span class="ruby-value">1</span>)).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
201: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">i</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@expects</span>[<span class="ruby-identifier">i</span>].<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">param_name</span>.<span class="ruby-identifier">to_s</span>
202: <span class="ruby-keyword kw">end</span>
203: <span class="ruby-value">-1</span>
204: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000476" class="method-detail">
<a name="M000476"></a>
<div class="method-heading">
<a href="#M000476" class="method-signature">
<span class="method-name">expects_to_hash</span><span class="method-args">(params)</span>
</a>
</div>
<div class="method-description">
<p>
Returns a hash keyed by parameter name for the given parameter list
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000476-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000476-source">
<pre>
<span class="ruby-comment cmt"># File vendor/rails/actionwebservice/lib/action_web_service/api.rb, line 208</span>
208: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">expects_to_hash</span>(<span class="ruby-identifier">params</span>)
209: <span class="ruby-keyword kw">return</span> {} <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@expects</span>.<span class="ruby-identifier">nil?</span>
210: <span class="ruby-identifier">h</span> = {}
211: <span class="ruby-ivar">@expects</span>.<span class="ruby-identifier">zip</span>(<span class="ruby-identifier">params</span>){ <span class="ruby-operator">|</span><span class="ruby-identifier">type</span>, <span class="ruby-identifier">param</span><span class="ruby-operator">|</span> <span class="ruby-identifier">h</span>[<span class="ruby-identifier">type</span>.<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">param</span> }
212: <span class="ruby-identifier">h</span>
213: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000472" class="method-detail">
<a name="M000472"></a>
<div class="method-heading">
<a href="#M000472" class="method-signature">
<span class="method-name">param_names</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
The list of parameter names for this method
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000472-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000472-source">
<pre>
<span class="ruby-comment cmt"># File vendor/rails/actionwebservice/lib/action_web_service/api.rb, line 181</span>
181: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">param_names</span>
182: <span class="ruby-keyword kw">return</span> [] <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@expects</span>
183: <span class="ruby-ivar">@expects</span>.<span class="ruby-identifier">map</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">type</span><span class="ruby-operator">|</span> <span class="ruby-identifier">type</span>.<span class="ruby-identifier">name</span> }
184: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000478" class="method-detail">
<a name="M000478"></a>
<div class="method-heading">
<a href="#M000478" class="method-signature">
<span class="method-name">to_s</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
String representation of this method
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000478-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000478-source">
<pre>
<span class="ruby-comment cmt"># File vendor/rails/actionwebservice/lib/action_web_service/api.rb, line 226</span>
226: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
227: <span class="ruby-identifier">fqn</span> = <span class="ruby-value str">""</span>
228: <span class="ruby-identifier">fqn</span> <span class="ruby-operator"><<</span> (<span class="ruby-ivar">@returns</span> <span class="ruby-operator">?</span> (<span class="ruby-ivar">@returns</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">human_name</span>(<span class="ruby-keyword kw">false</span>) <span class="ruby-operator">+</span> <span class="ruby-value str">" "</span>) <span class="ruby-operator">:</span> <span class="ruby-value str">"void "</span>)
229: <span class="ruby-identifier">fqn</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"#{@public_name}("</span>
230: <span class="ruby-identifier">fqn</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@expects</span>.<span class="ruby-identifier">map</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">p</span><span class="ruby-operator">|</span> <span class="ruby-identifier">p</span>.<span class="ruby-identifier">human_name</span> }.<span class="ruby-identifier">join</span>(<span class="ruby-value str">", "</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@expects</span>
231: <span class="ruby-identifier">fqn</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">")"</span>
232: <span class="ruby-identifier">fqn</span>
233: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>