doc/Contentful/Asset.html in contentful-2.12.0 vs doc/Contentful/Asset.html in contentful-2.13.0
- old
+ new
@@ -1,449 +1,448 @@
-<!DOCTYPE html>
-<html>
- <head>
- <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
- Class: Contentful::Asset
-
- — Documentation by YARD 0.9.18
-
-</title>
-
- <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
-
- <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
-
-<script type="text/javascript" charset="utf-8">
- pathId = "Contentful::Asset";
- relpath = '../';
-</script>
-
-
- <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-
- <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
-
-
- </head>
- <body>
- <div class="nav_wrap">
- <iframe id="nav" src="../class_list.html?1"></iframe>
- <div id="resizer"></div>
- </div>
-
- <div id="main" tabindex="-1">
- <div id="header">
- <div id="menu">
-
- <a href="../_index.html">Index (A)</a> »
- <span class='title'><span class='object_link'><a href="../Contentful.html" title="Contentful (module)">Contentful</a></span></span>
- »
- <span class="title">Asset</span>
-
-</div>
-
- <div id="search">
-
- <a class="full_list_link" id="class_list_link"
- href="../class_list.html">
-
- <svg width="24" height="24">
- <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
- <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
- <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
- </svg>
- </a>
-
-</div>
- <div class="clear"></div>
- </div>
-
- <div id="content"><h1>Class: Contentful::Asset
-
-
-
-</h1>
-<div class="box_info">
-
- <dl>
- <dt>Inherits:</dt>
- <dd>
- <span class="inheritName"><span class='object_link'><a href="FieldsResource.html" title="Contentful::FieldsResource (class)">FieldsResource</a></span></span>
-
- <ul class="fullTree">
- <li>Object</li>
-
- <li class="next"><span class='object_link'><a href="BaseResource.html" title="Contentful::BaseResource (class)">BaseResource</a></span></li>
-
- <li class="next"><span class='object_link'><a href="FieldsResource.html" title="Contentful::FieldsResource (class)">FieldsResource</a></span></li>
-
- <li class="next">Contentful::Asset</li>
-
- </ul>
- <a href="#" class="inheritanceTree">show all</a>
-
- </dd>
- </dl>
-
-
-
-
-
-
- <dl>
- <dt>Includes:</dt>
- <dd><span class='object_link'><a href="ResourceReferences.html" title="Contentful::ResourceReferences (module)">ResourceReferences</a></span></dd>
- </dl>
-
-
-
-
-
-
- <dl>
- <dt>Defined in:</dt>
- <dd>lib/contentful/asset.rb</dd>
- </dl>
-
-</div>
-
-<h2>Overview</h2><div class="docstring">
- <div class="discussion">
+<!DOCTYPE html>
+<html>
+ <head>
+ <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+ Class: Contentful::Asset
+
+ — Documentation by YARD 0.9.19
+
+</title>
+
+ <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+
+ <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+ pathId = "Contentful::Asset";
+ relpath = '../';
+</script>
+
+
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+ </head>
+ <body>
+ <div class="nav_wrap">
+ <iframe id="nav" src="../class_list.html?1"></iframe>
+ <div id="resizer"></div>
+ </div>
+
+ <div id="main" tabindex="-1">
+ <div id="header">
+ <div id="menu">
+
+ <a href="../_index.html">Index (A)</a> »
+ <span class='title'><span class='object_link'><a href="../Contentful.html" title="Contentful (module)">Contentful</a></span></span>
+ »
+ <span class="title">Asset</span>
+
+</div>
+
+ <div id="search">
+
+ <a class="full_list_link" id="class_list_link"
+ href="../class_list.html">
+
+ <svg width="24" height="24">
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+ </svg>
+ </a>
+
+</div>
+ <div class="clear"></div>
+ </div>
+
+ <div id="content"><h1>Class: Contentful::Asset
+
+
+
+</h1>
+<div class="box_info">
+
+ <dl>
+ <dt>Inherits:</dt>
+ <dd>
+ <span class="inheritName"><span class='object_link'><a href="FieldsResource.html" title="Contentful::FieldsResource (class)">FieldsResource</a></span></span>
+
+ <ul class="fullTree">
+ <li>Object</li>
+
+ <li class="next"><span class='object_link'><a href="BaseResource.html" title="Contentful::BaseResource (class)">BaseResource</a></span></li>
+
+ <li class="next"><span class='object_link'><a href="FieldsResource.html" title="Contentful::FieldsResource (class)">FieldsResource</a></span></li>
+
+ <li class="next">Contentful::Asset</li>
+
+ </ul>
+ <a href="#" class="inheritanceTree">show all</a>
+
+ </dd>
+ </dl>
+
+
+
+
+
+
+ <dl>
+ <dt>Includes:</dt>
+ <dd><span class='object_link'><a href="ResourceReferences.html" title="Contentful::ResourceReferences (module)">ResourceReferences</a></span></dd>
+ </dl>
+
+
+
+
+
+
+ <dl>
+ <dt>Defined in:</dt>
+ <dd>lib/contentful/asset.rb</dd>
+ </dl>
+
+</div>
+
+<h2>Overview</h2><div class="docstring">
+ <div class="discussion">
-<p>Resource class for Asset. <a
-href="https://www.contentful.com/developers/documentation/content-delivery-api/#assets">www.contentful.com/developers/documentation/content-delivery-api/#assets</a></p>
-
-
- </div>
-</div>
-<div class="tags">
-
-
-</div>
-
-
-
-
-
- <h2>Instance Attribute Summary</h2>
-
- <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="FieldsResource.html" title="Contentful::FieldsResource (class)">FieldsResource</a></span></h3>
- <p class="inherited"><span class='object_link'><a href="FieldsResource.html#localized-instance_method" title="Contentful::FieldsResource#localized (method)">#localized</a></span></p>
-
-
-
- <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="BaseResource.html" title="Contentful::BaseResource (class)">BaseResource</a></span></h3>
- <p class="inherited"><span class='object_link'><a href="BaseResource.html#default_locale-instance_method" title="Contentful::BaseResource#default_locale (method)">#default_locale</a></span>, <span class='object_link'><a href="BaseResource.html#raw-instance_method" title="Contentful::BaseResource#raw (method)">#raw</a></span>, <span class='object_link'><a href="BaseResource.html#sys-instance_method" title="Contentful::BaseResource#sys (method)">#sys</a></span></p>
-
-
-
- <h2>
- Instance Method Summary
- <small><a href="#" class="summary_toggle">collapse</a></small>
- </h2>
-
- <ul class="summary">
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#image_url-instance_method" title="#image_url (instance method)">#<strong>image_url</strong>(options = {}) ⇒ String </a>
-
-
-
- (also: #url)
-
- </span>
-
-
-
-
-
-
-
-
-
+<p>Resource class for Asset. <a href="https://www.contentful.com/developers/documentation/content-delivery-api/#assets">www.contentful.com/developers/documentation/content-delivery-api/#assets</a></p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+
+</div>
+
+
+
+
+
+ <h2>Instance Attribute Summary</h2>
+
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="FieldsResource.html" title="Contentful::FieldsResource (class)">FieldsResource</a></span></h3>
+ <p class="inherited"><span class='object_link'><a href="FieldsResource.html#localized-instance_method" title="Contentful::FieldsResource#localized (method)">#localized</a></span></p>
+
+
+
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="BaseResource.html" title="Contentful::BaseResource (class)">BaseResource</a></span></h3>
+ <p class="inherited"><span class='object_link'><a href="BaseResource.html#default_locale-instance_method" title="Contentful::BaseResource#default_locale (method)">#default_locale</a></span>, <span class='object_link'><a href="BaseResource.html#raw-instance_method" title="Contentful::BaseResource#raw (method)">#raw</a></span>, <span class='object_link'><a href="BaseResource.html#sys-instance_method" title="Contentful::BaseResource#sys (method)">#sys</a></span></p>
+
+
+
+ <h2>
+ Instance Method Summary
+ <small><a href="#" class="summary_toggle">collapse</a></small>
+ </h2>
+
+ <ul class="summary">
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#image_url-instance_method" title="#image_url (instance method)">#<strong>image_url</strong>(options = {}) ⇒ String </a>
+
+
+
+ (also: #url)
+
+ </span>
+
+
+
+
+
+
+
+
+
<span class="summary_desc"><div class='inline'>
<p>Generates a URL for the Contentful Image API.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ Asset </a>
-
-
-
- </span>
-
-
- <span class="note title constructor">constructor</span>
-
-
-
-
-
-
-
-
+</div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ Asset </a>
+
+
+
+ </span>
+
+
+ <span class="note title constructor">constructor</span>
+
+
+
+
+
+
+
+
<span class="summary_desc"><div class='inline'>
<p>A new instance of Asset.</p>
-</div></span>
-
-</li>
-
-
- </ul>
-
-
-
-
-
-
-
-
-
-
-
- <h3 class="inherited">Methods included from <span class='object_link'><a href="ResourceReferences.html" title="Contentful::ResourceReferences (module)">ResourceReferences</a></span></h3>
- <p class="inherited"><span class='object_link'><a href="ResourceReferences.html#incoming_references-instance_method" title="Contentful::ResourceReferences#incoming_references (method)">#incoming_references</a></span></p>
-
-
-
-
-
-
-
-
-
- <h3 class="inherited">Methods inherited from <span class='object_link'><a href="FieldsResource.html" title="Contentful::FieldsResource (class)">FieldsResource</a></span></h3>
- <p class="inherited"><span class='object_link'><a href="FieldsResource.html#fields-instance_method" title="Contentful::FieldsResource#fields (method)">#fields</a></span>, <span class='object_link'><a href="FieldsResource.html#fields_with_locales-instance_method" title="Contentful::FieldsResource#fields_with_locales (method)">#fields_with_locales</a></span>, <span class='object_link'><a href="FieldsResource.html#locales-instance_method" title="Contentful::FieldsResource#locales (method)">#locales</a></span></p>
-
-
-
-
-
-
-
-
-
- <h3 class="inherited">Methods inherited from <span class='object_link'><a href="BaseResource.html" title="Contentful::BaseResource (class)">BaseResource</a></span></h3>
- <p class="inherited"><span class='object_link'><a href="BaseResource.html#==-instance_method" title="Contentful::BaseResource#== (method)">#==</a></span>, <span class='object_link'><a href="BaseResource.html#reload-instance_method" title="Contentful::BaseResource#reload (method)">#reload</a></span></p>
-<div id="constructor_details" class="method_details_list">
- <h2>Constructor Details</h2>
-
- <div class="method_details first">
- <h3 class="signature first" id="initialize-instance_method">
-
- #<strong>initialize</strong> ⇒ <tt><span class='object_link'><a href="" title="Contentful::Asset (class)">Asset</a></span></tt>
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
+</div></span>
+
+</li>
+
+
+ </ul>
+
+
+
+
+
+
+
+
+
+
+
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="ResourceReferences.html" title="Contentful::ResourceReferences (module)">ResourceReferences</a></span></h3>
+ <p class="inherited"><span class='object_link'><a href="ResourceReferences.html#incoming_references-instance_method" title="Contentful::ResourceReferences#incoming_references (method)">#incoming_references</a></span></p>
+
+
+
+
+
+
+
+
+
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="FieldsResource.html" title="Contentful::FieldsResource (class)">FieldsResource</a></span></h3>
+ <p class="inherited"><span class='object_link'><a href="FieldsResource.html#fields-instance_method" title="Contentful::FieldsResource#fields (method)">#fields</a></span>, <span class='object_link'><a href="FieldsResource.html#fields_with_locales-instance_method" title="Contentful::FieldsResource#fields_with_locales (method)">#fields_with_locales</a></span>, <span class='object_link'><a href="FieldsResource.html#locales-instance_method" title="Contentful::FieldsResource#locales (method)">#locales</a></span></p>
+
+
+
+
+
+
+
+
+
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="BaseResource.html" title="Contentful::BaseResource (class)">BaseResource</a></span></h3>
+ <p class="inherited"><span class='object_link'><a href="BaseResource.html#==-instance_method" title="Contentful::BaseResource#== (method)">#==</a></span>, <span class='object_link'><a href="BaseResource.html#reload-instance_method" title="Contentful::BaseResource#reload (method)">#reload</a></span></p>
+<div id="constructor_details" class="method_details_list">
+ <h2>Constructor Details</h2>
+
+ <div class="method_details first">
+ <h3 class="signature first" id="initialize-instance_method">
+
+ #<strong>initialize</strong> ⇒ <tt><span class='object_link'><a href="" title="Contentful::Asset (class)">Asset</a></span></tt>
+
+
+
+
+
+</h3><div class="docstring">
+ <div class="discussion">
<p>Returns a new instance of Asset</p>
-
-
- </div>
-</div>
-<div class="tags">
-
-
-</div><table class="source_code">
- <tr>
- <td>
+
+
+ </div>
+</div>
+<div class="tags">
+
+
+</div><table class="source_code">
+ <tr>
+ <td>
<pre class="lines">
31
32
33
34
-35</pre>
- </td>
- <td>
+35</pre>
+ </td>
+ <td>
<pre class="code"><span class="info file"># File 'lib/contentful/asset.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>*</span><span class='rparen'>)</span>
<span class='kw'>super</span>
<span class='id identifier rubyid_create_files!'>create_files!</span>
<span class='id identifier rubyid_define_asset_methods!'>define_asset_methods!</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
-</div>
-
-
- <div id="instance_method_details" class="method_details_list">
- <h2>Instance Method Details</h2>
-
-
- <div class="method_details first">
- <h3 class="signature first" id="image_url-instance_method">
-
- #<strong>image_url</strong>(options = {}) ⇒ <tt>String</tt>
-
-
-
- <span class="aliases">Also known as:
- <span class="names"><span id='url-instance_method'>url</span></span>
- </span>
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
+<span class='kw'>end</span></pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+</div>
+
+
+ <div id="instance_method_details" class="method_details_list">
+ <h2>Instance Method Details</h2>
+
+ <div class="method_details first">
+ <h3 class="signature first" id="image_url-instance_method">
+
+ #<strong>image_url</strong>(options = {}) ⇒ <tt>String</tt>
+
+
+
+ <span class="aliases">Also known as:
+ <span class="names"><span id='url-instance_method'>url</span></span>
+ </span>
+
+
+
+</h3><div class="docstring">
+ <div class="discussion">
+
<p>Generates a URL for the Contentful Image API</p>
-
-
- </div>
-</div>
-<div class="tags">
- <p class="tag_title">Parameters:</p>
-<ul class="param">
-
- <li>
-
- <span class='name'>options</span>
-
-
- <span class='type'>(<tt>Hash</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>{}</tt>)</em>
-
-
- </li>
-
-</ul>
-
-
-
-
- <p class="tag_title">Options Hash (<tt>options</tt>):</p>
- <ul class="option">
-
- <li>
- <span class="name">:width</span>
- <span class="type">(<tt>Integer</tt>)</span>
- <span class="default">
-
- </span>
-
- </li>
-
- <li>
- <span class="name">:height</span>
- <span class="type">(<tt>Integer</tt>)</span>
- <span class="default">
-
- </span>
-
- </li>
-
- <li>
- <span class="name">:format</span>
- <span class="type">(<tt>String</tt>)</span>
- <span class="default">
-
- </span>
-
- </li>
-
- <li>
- <span class="name">:quality</span>
- <span class="type">(<tt>String</tt>)</span>
- <span class="default">
-
- </span>
-
- </li>
-
- <li>
- <span class="name">:focus</span>
- <span class="type">(<tt>String</tt>)</span>
- <span class="default">
-
- </span>
-
- </li>
-
- <li>
- <span class="name">:fit</span>
- <span class="type">(<tt>String</tt>)</span>
- <span class="default">
-
- </span>
-
- </li>
-
- <li>
- <span class="name">:fl</span>
- <span class="type">(<tt>String</tt>)</span>
- <span class="default">
-
- </span>
-
+
+
+ </div>
+</div>
+<div class="tags">
+ <p class="tag_title">Parameters:</p>
+<ul class="param">
+
+ <li>
+
+ <span class='name'>options</span>
+
+
+ <span class='type'>(<tt>Hash</tt>)</span>
+
+
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
+
+
+ </li>
+
+</ul>
+
+
+
+
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
+ <ul class="option">
+
+ <li>
+ <span class="name">:width</span>
+ <span class="type">(<tt>Integer</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ </li>
+
+ <li>
+ <span class="name">:height</span>
+ <span class="type">(<tt>Integer</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ </li>
+
+ <li>
+ <span class="name">:format</span>
+ <span class="type">(<tt>String</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ </li>
+
+ <li>
+ <span class="name">:quality</span>
+ <span class="type">(<tt>String</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ </li>
+
+ <li>
+ <span class="name">:focus</span>
+ <span class="type">(<tt>String</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ </li>
+
+ <li>
+ <span class="name">:fit</span>
+ <span class="type">(<tt>String</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ </li>
+
+ <li>
+ <span class="name">:fl</span>
+ <span class="type">(<tt>String</tt>)</span>
+ <span class="default">
+
+ </span>
+
— <div class='inline'>
<p>File Layering - 'progressive'</p>
-</div>
-
- </li>
-
- <li>
- <span class="name">:background</span>
- <span class="type">(<tt>String</tt>)</span>
- <span class="default">
-
- </span>
-
- </li>
-
- </ul>
-
-
-<p class="tag_title">Returns:</p>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>String</tt>)</span>
-
-
-
- —
+</div>
+
+ </li>
+
+ <li>
+ <span class="name">:background</span>
+ <span class="type">(<tt>String</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ </li>
+
+ </ul>
+
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+
+
+ —
<div class='inline'>
<p>Image API URL</p>
-</div>
-
- </li>
-
-</ul>
-
- <p class="tag_title">See Also:</p>
- <ul class="see">
-
- <li>https://www.contentful.com/developers/documentation/content-delivery-api/#image-asset-resizing</li>
-
- </ul>
-
-</div><table class="source_code">
- <tr>
- <td>
+</div>
+
+ </li>
+
+</ul>
+
+ <p class="tag_title">See Also:</p>
+ <ul class="see">
+
+ <li>https://www.contentful.com/developers/documentation/content-delivery-api/#image-asset-resizing</li>
+
+ </ul>
+
+</div><table class="source_code">
+ <tr>
+ <td>
<pre class="lines">
51
52
@@ -451,37 +450,37 @@
54
55
56
57
58
-59</pre>
- </td>
- <td>
+59</pre>
+ </td>
+ <td>
<pre class="code"><span class="info file"># File 'lib/contentful/asset.rb', line 51</span>
<span class='kw'>def</span> <span class='id identifier rubyid_image_url'>image_url</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='id identifier rubyid_build_query'>build_query</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_query'>query</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
<span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span>
<span class='kw'>else</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span><span class='embexpr_end'>}</span><span class='tstring_content'>?</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode_www_form'>encode_www_form</span><span class='lparen'>(</span><span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- </div>
-
-</div>
-
- <div id="footer">
- Generated on Tue Apr 9 10:49:56 2019 by
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
- 0.9.18 (ruby-2.5.3).
-</div>
-
- </div>
- </body>
+<span class='kw'>end</span></pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ </div>
+
+</div>
+
+ <div id="footer">
+ Generated on Wed Jun 26 15:30:21 2019 by
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+ 0.9.19 (ruby-2.6.1).
+</div>
+
+ </div>
+ </body>
</html>
\ No newline at end of file