<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: ShotgridApiRuby::Auth::Validator
— Documentation by YARD 0.9.26
</title>
<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::Auth::Validator";
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 (V)</a> »
<span class='title'><span class='object_link'><a href="../../ShotgridApiRuby.html" title="ShotgridApiRuby (module)">ShotgridApiRuby</a></span></span> » <span class='title'><span class='object_link'><a href="../Auth.html" title="ShotgridApiRuby::Auth (class)">Auth</a></span></span>
»
<span class="title">Validator</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>Module: ShotgridApiRuby::Auth::Validator
</h1>
<div class="box_info">
<dl>
<dt>Extended by:</dt>
<dd>T::Sig</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/shotgrid_api_ruby/auth.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Validate auth parameters format</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#valid%3F-class_method" title="valid? (class method)">.<strong>valid?</strong>(client_id: nil, client_secret: nil, username: nil, password: nil, session_token: nil, refresh_token: nil) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Validate auth parameters format.</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="valid?-class_method">
.<strong>valid?</strong>(client_id: nil, client_secret: nil, username: nil, password: nil, session_token: nil, refresh_token: nil) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Validate auth parameters format</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>client_id</span>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
</li>
<li>
<span class='name'>client_secret</span>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
</li>
<li>
<span class='name'>username</span>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
</li>
<li>
<span class='name'>password</span>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
</li>
<li>
<span class='name'>session_token</span>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
</li>
<li>
<span class='name'>refresh_token</span>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
26
27
28
29
30
31
32
33
34
35
36
37
38</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/shotgrid_api_ruby/auth.rb', line 26</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_valid?'>valid?</span><span class='lparen'>(</span>
<span class='label'>client_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>client_secret:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>username:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>password:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>session_token:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>refresh_token:</span> <span class='kw'>nil</span>
<span class='rparen'>)</span>
<span class='op'>!</span><span class='op'>!</span><span class='lparen'>(</span>
<span class='lparen'>(</span><span class='id identifier rubyid_client_id'>client_id</span> <span class='op'>&&</span> <span class='id identifier rubyid_client_secret'>client_secret</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='lparen'>(</span><span class='id identifier rubyid_password'>password</span> <span class='op'>&&</span> <span class='id identifier rubyid_username'>username</span><span class='rparen'>)</span> <span class='op'>||</span>
<span class='id identifier rubyid_session_token'>session_token</span> <span class='op'>||</span> <span class='id identifier rubyid_refresh_token'>refresh_token</span>
<span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Oct 12 21:57:54 2021 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.26 (ruby-3.0.2).
</div>
</div>
</body>
</html>