iframe-proxy | Sunbelt Computer Software

309 lines (163 loc) · 8.25 KB
<!DOCTYPE html>
    <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
  Module: ShotgridApiRuby
    &mdash; Documentation by YARD 0.9.43
  <link rel="stylesheet" href="css/style.css" type="text/css">
  <link rel="stylesheet" href="css/common.css" type="text/css">
<script type="text/javascript">
  pathId = "ShotgridApiRuby";
  relpath = '';
  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
    <div id="main_progress" aria-hidden="true"></div>
    <div class="nav_wrap">
      <iframe id="nav" src="class_list.html?1"></iframe>
      <div id="resizer"></div>
    <div id="main" tabindex="-1">
      <div id="header">
        <div id="menu">
    <a href="_index.html">Index (S)</a> &raquo;
    <span class="title">ShotgridApiRuby</span>
        <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>
        <div class="clear"></div>
      </div>
      <div id="content"><h1>Module: ShotgridApiRuby
<div class="box_info">
      <dt>Extended by:</dt>
      <dd>T::Sig</dd>
    <dt>Defined in:</dt>
    <dd>lib/shotgrid_api_ruby/auth.rb<span class="defines">,<br>
  lib/shotgrid_api_ruby.rb,<br> lib/shotgrid_api_ruby/client.rb,<br> lib/shotgrid_api_ruby/entity.rb,<br> lib/shotgrid_api_ruby/version.rb,<br> lib/shotgrid_api_ruby/entities.rb,<br> lib/shotgrid_api_ruby/preferences.rb,<br> lib/shotgrid_api_ruby/server_info.rb,<br> lib/shotgrid_api_ruby/entities/params.rb,<br> lib/shotgrid_api_ruby/entities/schema.rb,<br> lib/shotgrid_api_ruby/types/auth_type.rb,<br> lib/shotgrid_api_ruby/entities/summarize.rb,<br> lib/shotgrid_api_ruby/shotgrid_call_error.rb</span>
<h2>Overview</h2><div class="docstring">
  <div class="discussion">
    <p>typed: strict</p>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
      <strong class="modules">Modules:</strong> <span class='object_link'><a href="ShotgridApiRuby/Types.html" title="ShotgridApiRuby::Types (module)">Types</a></span>
      <strong class="classes">Classes:</strong> <span class='object_link'><a href="ShotgridApiRuby/Auth.html" title="ShotgridApiRuby::Auth (class)">Auth</a></span>, <span class='object_link'><a href="ShotgridApiRuby/Client.html" title="ShotgridApiRuby::Client (class)">Client</a></span>, <span class='object_link'><a href="ShotgridApiRuby/Entities.html" title="ShotgridApiRuby::Entities (class)">Entities</a></span>, <span class='object_link'><a href="ShotgridApiRuby/Entity.html" title="ShotgridApiRuby::Entity (class)">Entity</a></span>, <span class='object_link'><a href="ShotgridApiRuby/Preferences.html" title="ShotgridApiRuby::Preferences (class)">Preferences</a></span>, <span class='object_link'><a href="ShotgridApiRuby/ServerInfo.html" title="ShotgridApiRuby::ServerInfo (class)">ServerInfo</a></span>, <span class='object_link'><a href="ShotgridApiRuby/ShotgridCallError.html" title="ShotgridApiRuby::ShotgridCallError (class)">ShotgridCallError</a></span>
      Constant Summary
      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
    <dl class="constants">
        <dt id="VERSION-constant" class="">VERSION =
        </dt>
        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.2.0.8</span><span class='tstring_end'>&#39;</span></span></pre></dd>
      Class Method Summary
      <small><a href="#" class="summary_toggle">collapse</a></small>
    <ul class="summary">
        <li class="public ">
  <span class="summary_signature">
      <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(auth:, site_url: nil, shotgun_site: nil, shotgrid_site: nil)  &#x21d2; Client </a>
    <span class="summary_desc"><div class='inline'></div></span>
  <div id="class_method_details" class="method_details_list">
    <h2>Class Method Details</h2>
      <div class="method_details first">
  <h3 class="signature first" id="new-class_method">
    .<strong>new</strong>(auth:, site_url: nil, shotgun_site: nil, shotgrid_site: nil)  &#x21d2; <tt><span class='object_link'><a href="ShotgridApiRuby/Client.html" title="ShotgridApiRuby::Client (class)">Client</a></span></tt> 
</h3><div class="docstring">
  <div class="discussion">
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
        <span class='name'>auth</span>
        <span class='type'>(<tt><span class='object_link'><a href="ShotgridApiRuby/Types.html#AuthType-constant" title="ShotgridApiRuby::Types::AuthType (constant)">ShotgridApiRuby::Types::AuthType</a></span></tt>)</span>
        <span class='name'>site_url</span>
        <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
        <em class="default">(defaults to: <tt>nil</tt>)</em>
        <span class='name'>shotgun_site</span>
        <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
        <em class="default">(defaults to: <tt>nil</tt>)</em>
        <span class='name'>shotgrid_site</span>
        <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
        <em class="default">(defaults to: <tt>nil</tt>)</em>
<p class="tag_title">Returns:</p>
<ul class="return">
        <span class='type'>(<tt><span class='object_link'><a href="ShotgridApiRuby/Client.html" title="ShotgridApiRuby::Client (class)">Client</a></span></tt>)</span>
</div><table class="source_code">
      <pre class="lines">
      <pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby.rb', line 27</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>auth:</span><span class='comma'>,</span> <span class='label'>site_url:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>shotgun_site:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>shotgrid_site:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
  <span class='const'><span class='object_link'><a href="ShotgridApiRuby/Client.html" title="ShotgridApiRuby::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
    <span class='label'>auth:</span> <span class='id identifier rubyid_auth'>auth</span><span class='comma'>,</span>
    <span class='label'>site_url:</span> <span class='id identifier rubyid_site_url'>site_url</span><span class='comma'>,</span>
    <span class='label'>shotgun_site:</span> <span class='id identifier rubyid_shotgun_site'>shotgun_site</span><span class='comma'>,</span>
    <span class='label'>shotgrid_site:</span> <span class='id identifier rubyid_shotgrid_site'>shotgrid_site</span><span class='comma'>,</span>
  <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
      <div id="footer">
  Generated on Sun May 10 11:22:59 2026 by
  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.9.43 (ruby-3.3.11).
Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

FilesExpand file tree

ShotgridApiRuby.html

Latest commit

History

ShotgridApiRuby.html

File metadata and controls
