<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shopify SDK for Unity: Shopify.Unity.Image Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Shopify SDK for Unity
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_shopify.html">Shopify</a></li><li class="navelem"><a class="el" href="namespace_shopify_1_1_unity.html">Unity</a></li><li class="navelem"><a class="el" href="class_shopify_1_1_unity_1_1_image.html">Image</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_shopify_1_1_unity_1_1_image-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Shopify.Unity.Image Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Represents an image resource.  
 <a href="class_shopify_1_1_unity_1_1_image.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Shopify.Unity.Image:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_shopify_1_1_unity_1_1_image.png" usemap="#Shopify.Unity.Image_map" alt=""/>
  <map id="Shopify.Unity.Image_map" name="Shopify.Unity.Image_map">
<area href="class_shopify_1_1_unity_1_1_s_d_k_1_1_abstract_response.html" alt="Shopify.Unity.SDK.AbstractResponse" shape="rect" coords="0,0,222,24"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5c736cb692951389443739a5e117fc26"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_shopify_1_1_unity_1_1_image.html#a5c736cb692951389443739a5e117fc26">Image</a> (Dictionary&lt; string, object &gt; dataJSON)</td></tr>
<tr class="memdesc:a5c736cb692951389443739a5e117fc26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accepts deserialized json data.  Will further parse passed in data.  <a href="class_shopify_1_1_unity_1_1_image.html#a5c736cb692951389443739a5e117fc26">More...</a><br /></td></tr>
<tr class="separator:a5c736cb692951389443739a5e117fc26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a431589454f8ffff532d2f7a5bd7c6c1f"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_shopify_1_1_unity_1_1_image.html#a431589454f8ffff532d2f7a5bd7c6c1f">altText</a> ()</td></tr>
<tr class="memdesc:a431589454f8ffff532d2f7a5bd7c6c1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">A word or phrase to share the nature or contents of an image.  <a href="class_shopify_1_1_unity_1_1_image.html#a431589454f8ffff532d2f7a5bd7c6c1f">More...</a><br /></td></tr>
<tr class="separator:a431589454f8ffff532d2f7a5bd7c6c1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f1323bd9c0659ccb203ff64511e51d0"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_shopify_1_1_unity_1_1_image.html#a5f1323bd9c0659ccb203ff64511e51d0">id</a> ()</td></tr>
<tr class="memdesc:a5f1323bd9c0659ccb203ff64511e51d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">A unique identifier for the image.  <a href="class_shopify_1_1_unity_1_1_image.html#a5f1323bd9c0659ccb203ff64511e51d0">More...</a><br /></td></tr>
<tr class="separator:a5f1323bd9c0659ccb203ff64511e51d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5d719003ade99d031f202861585f9c9"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_shopify_1_1_unity_1_1_image.html#ac5d719003ade99d031f202861585f9c9">originalSrc</a> ()</td></tr>
<tr class="memdesc:ac5d719003ade99d031f202861585f9c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The location of the original image as a URL.  <a href="class_shopify_1_1_unity_1_1_image.html#ac5d719003ade99d031f202861585f9c9">More...</a><br /></td></tr>
<tr class="separator:ac5d719003ade99d031f202861585f9c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18260a4ead295cfe3861853746f6133e"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_shopify_1_1_unity_1_1_image.html#a18260a4ead295cfe3861853746f6133e">src</a> ()</td></tr>
<tr class="memdesc:a18260a4ead295cfe3861853746f6133e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The location of the image as a URL.  <a href="class_shopify_1_1_unity_1_1_image.html#a18260a4ead295cfe3861853746f6133e">More...</a><br /></td></tr>
<tr class="separator:a18260a4ead295cfe3861853746f6133e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affd296d13ad33e8008a6a748ff46e353"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_shopify_1_1_unity_1_1_image.html#affd296d13ad33e8008a6a748ff46e353">transformedSrc</a> (string alias=null)</td></tr>
<tr class="memdesc:affd296d13ad33e8008a6a748ff46e353"><td class="mdescLeft">&#160;</td><td class="mdescRight">The location of the transformed image as a URL.  <a href="class_shopify_1_1_unity_1_1_image.html#affd296d13ad33e8008a6a748ff46e353">More...</a><br /></td></tr>
<tr class="separator:affd296d13ad33e8008a6a748ff46e353"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ceb791c8551dd19b49c524aab772832"><td class="memItemLeft" align="right" valign="top"><a id="a9ceb791c8551dd19b49c524aab772832"></a>
object&#160;</td><td class="memItemRight" valign="bottom"><b>Clone</b> ()</td></tr>
<tr class="separator:a9ceb791c8551dd19b49c524aab772832"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_class_shopify_1_1_unity_1_1_s_d_k_1_1_abstract_response"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_shopify_1_1_unity_1_1_s_d_k_1_1_abstract_response')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_shopify_1_1_unity_1_1_s_d_k_1_1_abstract_response.html">Shopify.Unity.SDK.AbstractResponse</a></td></tr>
<tr class="memitem:a63f2dece9ae299261d16aae97b5e110d inherit pro_methods_class_shopify_1_1_unity_1_1_s_d_k_1_1_abstract_response"><td class="memItemLeft" align="right" valign="top"><a id="a63f2dece9ae299261d16aae97b5e110d"></a>
T&#160;</td><td class="memItemRight" valign="bottom"><b>Get&lt; T &gt;</b> (string field, string alias=null)</td></tr>
<tr class="separator:a63f2dece9ae299261d16aae97b5e110d inherit pro_methods_class_shopify_1_1_unity_1_1_s_d_k_1_1_abstract_response"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_class_shopify_1_1_unity_1_1_s_d_k_1_1_abstract_response"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_shopify_1_1_unity_1_1_s_d_k_1_1_abstract_response')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_shopify_1_1_unity_1_1_s_d_k_1_1_abstract_response.html">Shopify.Unity.SDK.AbstractResponse</a></td></tr>
<tr class="memitem:a1a79f9cb472a93682ebaa588731dc0ed inherit pro_attribs_class_shopify_1_1_unity_1_1_s_d_k_1_1_abstract_response"><td class="memItemLeft" align="right" valign="top"><a id="a1a79f9cb472a93682ebaa588731dc0ed"></a>
Dictionary&lt; string, object &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Data</b></td></tr>
<tr class="separator:a1a79f9cb472a93682ebaa588731dc0ed inherit pro_attribs_class_shopify_1_1_unity_1_1_s_d_k_1_1_abstract_response"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header properties_class_shopify_1_1_unity_1_1_s_d_k_1_1_abstract_response"><td colspan="2" onclick="javascript:toggleInherit('properties_class_shopify_1_1_unity_1_1_s_d_k_1_1_abstract_response')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="class_shopify_1_1_unity_1_1_s_d_k_1_1_abstract_response.html">Shopify.Unity.SDK.AbstractResponse</a></td></tr>
<tr class="memitem:a94399a05e28aeadd83fe89d232169305 inherit properties_class_shopify_1_1_unity_1_1_s_d_k_1_1_abstract_response"><td class="memItemLeft" align="right" valign="top"><a id="a94399a05e28aeadd83fe89d232169305"></a>
Dictionary&lt; string, object &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>DataJSON</b><code> [get, protected set]</code></td></tr>
<tr class="separator:a94399a05e28aeadd83fe89d232169305 inherit properties_class_shopify_1_1_unity_1_1_s_d_k_1_1_abstract_response"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents an image resource. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5c736cb692951389443739a5e117fc26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c736cb692951389443739a5e117fc26">&#9670;&nbsp;</a></span>Image()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Shopify.Unity.Image.Image </td>
          <td>(</td>
          <td class="paramtype">Dictionary&lt; string, object &gt;&#160;</td>
          <td class="paramname"><em>dataJSON</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Accepts deserialized json data.  Will further parse passed in data. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">dataJSON</td><td>Deserialized JSON data for <a class="el" href="class_shopify_1_1_unity_1_1_image.html" title="Represents an image resource.">Image</a></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a431589454f8ffff532d2f7a5bd7c6c1f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a431589454f8ffff532d2f7a5bd7c6c1f">&#9670;&nbsp;</a></span>altText()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">string Shopify.Unity.Image.altText </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>A word or phrase to share the nature or contents of an image. </p>

</div>
</div>
<a id="a5f1323bd9c0659ccb203ff64511e51d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f1323bd9c0659ccb203ff64511e51d0">&#9670;&nbsp;</a></span>id()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">string Shopify.Unity.Image.id </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>A unique identifier for the image. </p>

</div>
</div>
<a id="ac5d719003ade99d031f202861585f9c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5d719003ade99d031f202861585f9c9">&#9670;&nbsp;</a></span>originalSrc()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">string Shopify.Unity.Image.originalSrc </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The location of the original image as a URL. </p>
<p>If there are any existing transformations in the original source URL, they will remain and not be stripped.</p>

</div>
</div>
<a id="a18260a4ead295cfe3861853746f6133e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18260a4ead295cfe3861853746f6133e">&#9670;&nbsp;</a></span>src()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">string Shopify.Unity.Image.src </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The location of the image as a URL. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000127">Deprecated:</a></b></dt><dd>Previously an image had a single <code>src</code> field. This could either return the original image location or a URL that contained transformations such as sizing or scale.</dd></dl>
<p>These transformations were specified by arguments on the parent field.</p>
<p>Now an image has two distinct URL fields: <code>originalSrc</code> and <code>transformedSrc</code>.</p>
<ul>
<li><code>originalSrc</code> - the original unmodified image URL</li>
<li><code>transformedSrc</code> - the image URL with the specified transformations included</li>
</ul>
<p>To migrate to the new fields, image transformations should be moved from the parent field to <code>transformedSrc</code>.</p>
<p>Before: </p><div class="fragment"><div class="line">{</div>
<div class="line">shop {</div>
<div class="line">productImages(maxWidth: 200, scale: 2) {</div>
<div class="line">edges {</div>
<div class="line">node {</div>
<div class="line">src</div>
<div class="line">}</div>
<div class="line">}</div>
<div class="line">}</div>
<div class="line">}</div>
<div class="line">}</div>
</div><!-- fragment --><p>After: </p><div class="fragment"><div class="line">{</div>
<div class="line">shop {</div>
<div class="line">productImages {</div>
<div class="line">edges {</div>
<div class="line">node {</div>
<div class="line">transformedSrc(maxWidth: 200, scale: 2)</div>
<div class="line">}</div>
<div class="line">}</div>
<div class="line">}</div>
<div class="line">}</div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
<a id="affd296d13ad33e8008a6a748ff46e353"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affd296d13ad33e8008a6a748ff46e353">&#9670;&nbsp;</a></span>transformedSrc()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">string Shopify.Unity.Image.transformedSrc </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>alias</em> = <code>null</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The location of the transformed image as a URL. </p>
<p>All transformation arguments are considered "best-effort". If they can be applied to an image, they will be. Otherwise any transformations which an image type does not support will be ignored.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">alias</td><td>If the original field queried was queried using an alias, then pass the matching string. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Assets/Shopify/Unity/Generated/Image.cs</li>
</ul>
</div><!-- contents -->
<address class="footer"><small>
    <a href="https://www.shopify.ca/">
        <img class="footer" height="50" src="https://camo.githubusercontent.com/10d580ddb06e6e6ff66ae43959842201195c6269/68747470733a2f2f63646e2e73686f706966792e636f6d2f73686f706966792d6d61726b6574696e675f6173736574732f6275696c64732f31392e302e302f73686f706966792d66756c6c2d636f6c6f722d626c61636b2e737667" alt="Shopify">
    </a>
</small></address>