Swiftgram/submodules/AsyncDisplayKit/docs/appledoc/Protocols/ASMultiplexImageNodeDataSource.html
Peter 9bc996374f Add 'submodules/AsyncDisplayKit/' from commit '02bedc12816e251ad71777f9d2578329b6d2bef6'
git-subtree-dir: submodules/AsyncDisplayKit
git-subtree-mainline: d06f423e0ed3df1fed9bd10d79ee312a9179b632
git-subtree-split: 02bedc12816e251ad71777f9d2578329b6d2bef6
2019-06-11 18:42:43 +01:00

364 lines
9.8 KiB
HTML
Executable File

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>ASMultiplexImageNodeDataSource Protocol Reference</title>
<link rel="stylesheet" href="../css/style.css">
<meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
<meta name="generator" content="appledoc 2.2.1 (build 1334)">
</head>
<body class="appledoc">
<header>
<div class="container" class="hide-in-xcode">
<h1 id="library-title">
<a href="../index.html"> </a>
</h1>
<p id="developer-home">
<a href="../index.html">AsyncDisplayKit</a>
</p>
</div>
</header>
<aside>
<div class="container">
<nav>
<ul id="header-buttons" role="toolbar">
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
<li id="on-this-page" role="navigation">
<label>
On This Page
<div class="chevron">
<div class="chevy chevron-left"></div>
<div class="chevy chevron-right"></div>
</div>
<select id="jump-to">
<option value="top">Jump To&#133;</option>
<option value="overview">Overview</option>
<option value="tasks">Tasks</option>
<optgroup label="Instance Methods">
<option value="//api/name/multiplexImageNode:URLForImageIdentifier:">- multiplexImageNode:URLForImageIdentifier:</option>
<option value="//api/name/multiplexImageNode:assetForLocalIdentifier:">- multiplexImageNode:assetForLocalIdentifier:</option>
<option value="//api/name/multiplexImageNode:imageForImageIdentifier:">- multiplexImageNode:imageForImageIdentifier:</option>
</optgroup>
</select>
</label>
</li>
</ul>
</nav>
</div>
</aside>
<article>
<div id="overview_contents" class="container">
<div id="content">
<main role="main">
<h1 class="title">ASMultiplexImageNodeDataSource Protocol Reference</h1>
<div class="section section-specification"><table cellspacing="0"><tbody>
<tr>
<th>Conforms to</th>
<td>NSObject</td>
</tr><tr>
<th>Declared in</th>
<td>ASMultiplexImageNode.h</td>
</tr>
</tbody></table></div>
<div class="section section-overview">
<a title="Overview" name="overview"></a>
<h2 class="subtitle subtitle-overview">Overview</h2>
<p>The ASMultiplexImageNodeDataSource protocol is adopted by an object that provides the multiplex image node,
for each image identifier, an image or a URL the image node should load.</p>
</div>
<div class="section section-tasks">
<a title="Tasks" name="tasks"></a>
<div class="task-list">
<div class="section-method">
<a name="//api/name/multiplexImageNode:imageForImageIdentifier:" title="multiplexImageNode:imageForImageIdentifier:"></a>
<h3 class="method-title"><code><a href="#//api/name/multiplexImageNode:imageForImageIdentifier:">&ndash;&nbsp;multiplexImageNode:imageForImageIdentifier:</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>An image for the specified identifier.</p>
</div>
<div class="method-subsection method-declaration"><code>- (nullable UIImage *)multiplexImageNode:(ASMultiplexImageNode *)<em>imageNode</em> imageForImageIdentifier:(ASImageIdentifier)<em>imageIdentifier</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>imageNode</code></th>
<td><p>The sender.</p></td>
</tr>
<tr>
<th scope="row" class="argument-name"><code>imageIdentifier</code></th>
<td><p>The identifier for the image that should be returned.</p></td>
</tr>
</table>
</div>
<div class="method-subsection return">
<h4 class="method-subtitle parameter-title">Return Value</h4>
<p>A UIImage corresponding to <code>imageIdentifier</code>, or nil if none is available.</p>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>If the image is already available to the data source, this method should be used in lieu of providing the
URL to the image via -multiplexImageNode:URLForImageIdentifier:.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMultiplexImageNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/multiplexImageNode:URLForImageIdentifier:" title="multiplexImageNode:URLForImageIdentifier:"></a>
<h3 class="method-title"><code><a href="#//api/name/multiplexImageNode:URLForImageIdentifier:">&ndash;&nbsp;multiplexImageNode:URLForImageIdentifier:</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>An image URL for the specified identifier.</p>
</div>
<div class="method-subsection method-declaration"><code>- (nullable NSURL *)multiplexImageNode:(ASMultiplexImageNode *)<em>imageNode</em> URLForImageIdentifier:(ASImageIdentifier)<em>imageIdentifier</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>imageNode</code></th>
<td><p>The sender.</p></td>
</tr>
<tr>
<th scope="row" class="argument-name"><code>imageIdentifier</code></th>
<td><p>The identifier for the image that will be downloaded.</p></td>
</tr>
</table>
</div>
<div class="method-subsection return">
<h4 class="method-subtitle parameter-title">Return Value</h4>
<p>An NSURL for the image identified by <code>imageIdentifier</code>, or nil if none is available.</p>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Supported URLs include HTTP, HTTPS, AssetsLibrary, and FTP URLs as well as Photos framework URLs (see note).</p>
<p>If the image is already available to the data source, it should be provided via <a href="#//api/name/multiplexImageNode:imageForImageIdentifier:">[ASMultiplexImageNodeDataSource multiplexImageNode:imageForImageIdentifier:]</a> instead.</p>
</div>
<div class="method-subsection see-also-section">
<h4 class="method-subtitle">See Also</h4>
<ul>
<li><code><p><code>[NSURL URLWithAssetLocalIdentifier:targetSize:contentMode:options:]</code> below.</p></code></li>
</ul>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMultiplexImageNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/multiplexImageNode:assetForLocalIdentifier:" title="multiplexImageNode:assetForLocalIdentifier:"></a>
<h3 class="method-title"><code><a href="#//api/name/multiplexImageNode:assetForLocalIdentifier:">&ndash;&nbsp;multiplexImageNode:assetForLocalIdentifier:</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>A PHAsset for the specific asset local identifier</p>
</div>
<div class="method-subsection method-declaration"><code>- (nullable PHAsset *)multiplexImageNode:(ASMultiplexImageNode *)<em>imageNode</em> assetForLocalIdentifier:(NSString *)<em>assetLocalIdentifier</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>imageNode</code></th>
<td><p>The sender.</p></td>
</tr>
<tr>
<th scope="row" class="argument-name"><code>assetLocalIdentifier</code></th>
<td><p>The local identifier for a PHAsset that this image node is loading.</p></td>
</tr>
</table>
</div>
<div class="method-subsection return">
<h4 class="method-subtitle parameter-title">Return Value</h4>
<p>A PHAsset corresponding to <code>assetLocalIdentifier</code>, or nil if none is available.</p>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>This optional method can improve image performance if your data source already has the PHAsset available.
If this method is not implemented, or returns nil, the image node will request the asset from the Photos framework.</p><div class="note"><p><strong>Note:</strong> This method may be called from any thread.</p></div>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMultiplexImageNode.h</code></p>
</div>
</div>
</div>
</div>
</div>
</div>
</main>
<footer>
<div class="footer-copyright">
<p class="copyright">Copyright &copy; 2016 AsyncDisplayKit. All rights reserved. Updated: 2016-11-05</p>
<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>
</div>
</footer>
</div>
</div>
</article>
<script src="../js/script.js"></script>
</body>
</html>