docs/Prismic/Fragments/GroupDocument.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Prismic::Fragments::GroupDocument
— Documentation by YARD 0.9.8
</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 = "Prismic::Fragments::GroupDocument";
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 (G)</a> »
<span class='title'><span class='object_link'><a href="../../Prismic.html" title="Prismic (module)">Prismic</a></span></span> » <span class='title'><span class='object_link'><a href="../Fragments.html" title="Prismic::Fragments (module)">Fragments</a></span></span>
»
<span class="title">GroupDocument</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: Prismic::Fragments::GroupDocument
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Prismic::Fragments::GroupDocument</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="../WithFragments.html" title="Prismic::WithFragments (module)">WithFragments</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/prismic/fragments/group.rb</dd>
</dl>
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#fragments-instance_method" title="#fragments (instance method)">#<strong>fragments</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute fragments.</p>
</div></span>
</li>
</ul>
<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="#[]-instance_method" title="#[] (instance method)">#<strong>[]</strong>(field) ⇒ Fragments::Fragment </a>
(also: #get)
</span>
<span class="summary_desc"><div class='inline'><p>Get a document's field.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(fragments) ⇒ GroupDocument </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of GroupDocument.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../WithFragments.html" title="Prismic::WithFragments (module)">WithFragments</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../WithFragments.html#as_html-instance_method" title="Prismic::WithFragments#as_html (method)">#as_html</a></span>, <span class='object_link'><a href="../WithFragments.html#as_text-instance_method" title="Prismic::WithFragments#as_text (method)">#as_text</a></span>, <span class='object_link'><a href="../WithFragments.html#each-instance_method" title="Prismic::WithFragments#each (method)">#each</a></span>, <span class='object_link'><a href="../WithFragments.html#first_title-instance_method" title="Prismic::WithFragments#first_title (method)">#first_title</a></span>, <span class='object_link'><a href="../WithFragments.html#get_color-instance_method" title="Prismic::WithFragments#get_color (method)">#get_color</a></span>, <span class='object_link'><a href="../WithFragments.html#get_date-instance_method" title="Prismic::WithFragments#get_date (method)">#get_date</a></span>, <span class='object_link'><a href="../WithFragments.html#get_embed-instance_method" title="Prismic::WithFragments#get_embed (method)">#get_embed</a></span>, <span class='object_link'><a href="../WithFragments.html#get_geopoint-instance_method" title="Prismic::WithFragments#get_geopoint (method)">#get_geopoint</a></span>, <span class='object_link'><a href="../WithFragments.html#get_group-instance_method" title="Prismic::WithFragments#get_group (method)">#get_group</a></span>, <span class='object_link'><a href="../WithFragments.html#get_image-instance_method" title="Prismic::WithFragments#get_image (method)">#get_image</a></span>, <span class='object_link'><a href="../WithFragments.html#get_link-instance_method" title="Prismic::WithFragments#get_link (method)">#get_link</a></span>, <span class='object_link'><a href="../WithFragments.html#get_number-instance_method" title="Prismic::WithFragments#get_number (method)">#get_number</a></span>, <span class='object_link'><a href="../WithFragments.html#get_slice_zone-instance_method" title="Prismic::WithFragments#get_slice_zone (method)">#get_slice_zone</a></span>, <span class='object_link'><a href="../WithFragments.html#get_structured_text-instance_method" title="Prismic::WithFragments#get_structured_text (method)">#get_structured_text</a></span>, <span class='object_link'><a href="../WithFragments.html#get_text-instance_method" title="Prismic::WithFragments#get_text (method)">#get_text</a></span>, <span class='object_link'><a href="../WithFragments.html#get_timestamp-instance_method" title="Prismic::WithFragments#get_timestamp (method)">#get_timestamp</a></span>, <span class='object_link'><a href="../WithFragments.html#length-instance_method" title="Prismic::WithFragments#length (method)">#length</a></span>, <span class='object_link'><a href="../WithFragments.html#linked_documents-instance_method" title="Prismic::WithFragments#linked_documents (method)">#linked_documents</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>(fragments) ⇒ <tt><span class='object_link'><a href="" title="Prismic::Fragments::GroupDocument (class)">GroupDocument</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of GroupDocument</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
9
10
11</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/prismic/fragments/group.rb', line 9</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_fragments'>fragments</span><span class='rparen'>)</span>
<span class='ivar'>@fragments</span> <span class='op'>=</span> <span class='id identifier rubyid_fragments'>fragments</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="fragments=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="fragments-instance_method">
#<strong>fragments</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute fragments</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/prismic/fragments/group.rb', line 7</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fragments'>fragments</span>
<span class='ivar'>@fragments</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="[]-instance_method">
#<strong>[]</strong>(field) ⇒ <tt><span class='object_link'><a href="Fragment.html" title="Prismic::Fragments::Fragment (class)">Fragments::Fragment</a></span></tt>
<span class="aliases">Also known as:
<span class="names"><span id='get-instance_method'>get</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Get a document's field</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Fragment.html" title="Prismic::Fragments::Fragment (class)">Fragments::Fragment</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
15
16
17</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/prismic/fragments/group.rb', line 15</span>
<span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_field'>field</span><span class='rparen'>)</span>
<span class='ivar'>@fragments</span><span class='lbracket'>[</span><span class='id identifier rubyid_field'>field</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jan 16 16:05:10 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.8 (ruby-2.3.1).
</div>
</div>
</body>
</html>