342 lines
14 KiB
HTML
342 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
|
|
<meta name="description" content="API docs for the StickerPack class from the moxxmpp library, for the Dart programming language.">
|
|
<title>StickerPack class - moxxmpp library - Dart API</title>
|
|
|
|
|
|
|
|
<link rel="preconnect" href="https://fonts.gstatic.com">
|
|
<link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
|
|
<link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@48,400,0,0" rel="stylesheet">
|
|
|
|
<link rel="stylesheet" href="../static-assets/github.css?v1">
|
|
<link rel="stylesheet" href="../static-assets/styles.css?v1">
|
|
<link rel="icon" href="../static-assets/favicon.png?v1">
|
|
|
|
|
|
</head>
|
|
|
|
|
|
<body data-base-href="../" data-using-base-href="false" class="light-theme">
|
|
|
|
<div id="overlay-under-drawer"></div>
|
|
|
|
<header id="title">
|
|
<span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
|
|
<ol class="breadcrumbs gt-separated dark hidden-xs">
|
|
<li><a href="../index.html">moxxmpp</a></li>
|
|
<li><a href="../moxxmpp/moxxmpp-library.html">moxxmpp</a></li>
|
|
<li class="self-crumb">StickerPack class</li>
|
|
</ol>
|
|
<div class="self-name">StickerPack</div>
|
|
<form class="search navbar-right" role="search">
|
|
<input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
|
|
</form>
|
|
<div class="toggle" id="theme-button">
|
|
<label for="theme">
|
|
<input type="checkbox" id="theme" value="light-theme">
|
|
<span id="dark-theme-button" class="material-symbols-outlined">
|
|
brightness_4
|
|
</span>
|
|
<span id="light-theme-button" class="material-symbols-outlined">
|
|
brightness_5
|
|
</span>
|
|
</label>
|
|
</div>
|
|
</header>
|
|
<main>
|
|
|
|
<div
|
|
id="dartdoc-main-content"
|
|
class="main-content"
|
|
data-above-sidebar="moxxmpp/moxxmpp-library-sidebar.html"
|
|
data-below-sidebar="moxxmpp/StickerPack-class-sidebar.html">
|
|
<div>
|
|
<h1><span class="kind-class">StickerPack</span> class
|
|
|
|
</h1></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section class="summary offset-anchor" id="constructors">
|
|
<h2>Constructors</h2>
|
|
|
|
<dl class="constructor-summary-list">
|
|
<dt id="StickerPack" class="callable">
|
|
<span class="name"><a href="../moxxmpp/StickerPack/StickerPack.html">StickerPack</a></span><span class="signature">(<span class="parameter" id="-param-id"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.2.4/dart-core/String-class.html">String</a></span> <span class="parameter-name">id</span>, </span><span class="parameter" id="-param-name"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.2.4/dart-core/String-class.html">String</a></span> <span class="parameter-name">name</span>, </span><span class="parameter" id="-param-summary"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.2.4/dart-core/String-class.html">String</a></span> <span class="parameter-name">summary</span>, </span><span class="parameter" id="-param-hashAlgorithm"><span class="type-annotation"><a href="../moxxmpp/HashFunction.html">HashFunction</a></span> <span class="parameter-name">hashAlgorithm</span>, </span><span class="parameter" id="-param-hashValue"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.2.4/dart-core/String-class.html">String</a></span> <span class="parameter-name">hashValue</span>, </span><span class="parameter" id="-param-stickers"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.2.4/dart-core/List-class.html">List</a><span class="signature"><<wbr><span class="type-parameter"><a href="../moxxmpp/Sticker-class.html">Sticker</a></span>></span></span> <span class="parameter-name">stickers</span>, </span><span class="parameter" id="-param-restricted"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.2.4/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">restricted</span></span>)</span>
|
|
</dt>
|
|
<dd>
|
|
|
|
<div class="constructor-modifier features">const</div>
|
|
</dd>
|
|
<dt id="StickerPack.fromXML" class="callable">
|
|
<span class="name"><a href="../moxxmpp/StickerPack/StickerPack.fromXML.html">StickerPack.fromXML</a></span><span class="signature">(<span class="parameter" id="fromXML-param-id"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.2.4/dart-core/String-class.html">String</a></span> <span class="parameter-name">id</span>, </span><span class="parameter" id="fromXML-param-node"><span class="type-annotation"><a href="../moxxmpp/XMLNode-class.html">XMLNode</a></span> <span class="parameter-name">node</span>, </span><span class="parameter" id="fromXML-param-hashAvailable">{<span class="type-annotation"><a href="https://api.dart.dev/stable/3.2.4/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">hashAvailable</span> = <span class="default-value">true</span>}</span>)</span>
|
|
</dt>
|
|
<dd>
|
|
|
|
<div class="constructor-modifier features">factory</div>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
|
|
<section class="summary offset-anchor" id="instance-properties">
|
|
<h2>Properties</h2>
|
|
|
|
<dl class="properties">
|
|
<dt id="hashAlgorithm" class="property">
|
|
<span class="name"><a href="../moxxmpp/StickerPack/hashAlgorithm.html">hashAlgorithm</a></span>
|
|
<span class="signature">→ <a href="../moxxmpp/HashFunction.html">HashFunction</a></span>
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
<div class="features"><span class="feature">final</span></div>
|
|
|
|
</dd>
|
|
|
|
<dt id="hashCode" class="property inherited">
|
|
<span class="name"><a href="https://api.dart.dev/stable/3.2.4/dart-core/Object/hashCode.html">hashCode</a></span>
|
|
<span class="signature">→ <a href="https://api.dart.dev/stable/3.2.4/dart-core/int-class.html">int</a></span>
|
|
|
|
</dt>
|
|
<dd class="inherited">
|
|
The hash code for this object.
|
|
<div class="features"><span class="feature">no setter</span><span class="feature">inherited</span></div>
|
|
|
|
</dd>
|
|
|
|
<dt id="hashValue" class="property">
|
|
<span class="name"><a href="../moxxmpp/StickerPack/hashValue.html">hashValue</a></span>
|
|
<span class="signature">→ <a href="https://api.dart.dev/stable/3.2.4/dart-core/String-class.html">String</a></span>
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
<div class="features"><span class="feature">final</span></div>
|
|
|
|
</dd>
|
|
|
|
<dt id="id" class="property">
|
|
<span class="name"><a href="../moxxmpp/StickerPack/id.html">id</a></span>
|
|
<span class="signature">→ <a href="https://api.dart.dev/stable/3.2.4/dart-core/String-class.html">String</a></span>
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
<div class="features"><span class="feature">final</span></div>
|
|
|
|
</dd>
|
|
|
|
<dt id="name" class="property">
|
|
<span class="name"><a href="../moxxmpp/StickerPack/name.html">name</a></span>
|
|
<span class="signature">→ <a href="https://api.dart.dev/stable/3.2.4/dart-core/String-class.html">String</a></span>
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
<div class="features"><span class="feature">final</span></div>
|
|
|
|
</dd>
|
|
|
|
<dt id="restricted" class="property">
|
|
<span class="name"><a href="../moxxmpp/StickerPack/restricted.html">restricted</a></span>
|
|
<span class="signature">→ <a href="https://api.dart.dev/stable/3.2.4/dart-core/bool-class.html">bool</a></span>
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
<div class="features"><span class="feature">final</span></div>
|
|
|
|
</dd>
|
|
|
|
<dt id="runtimeType" class="property inherited">
|
|
<span class="name"><a href="https://api.dart.dev/stable/3.2.4/dart-core/Object/runtimeType.html">runtimeType</a></span>
|
|
<span class="signature">→ <a href="https://api.dart.dev/stable/3.2.4/dart-core/Type-class.html">Type</a></span>
|
|
|
|
</dt>
|
|
<dd class="inherited">
|
|
A representation of the runtime type of the object.
|
|
<div class="features"><span class="feature">no setter</span><span class="feature">inherited</span></div>
|
|
|
|
</dd>
|
|
|
|
<dt id="stickers" class="property">
|
|
<span class="name"><a href="../moxxmpp/StickerPack/stickers.html">stickers</a></span>
|
|
<span class="signature">→ <a href="https://api.dart.dev/stable/3.2.4/dart-core/List-class.html">List</a><span class="signature"><<wbr><span class="type-parameter"><a href="../moxxmpp/Sticker-class.html">Sticker</a></span>></span></span>
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
<div class="features"><span class="feature">final</span></div>
|
|
|
|
</dd>
|
|
|
|
<dt id="summary" class="property">
|
|
<span class="name"><a href="../moxxmpp/StickerPack/summary.html">summary</a></span>
|
|
<span class="signature">→ <a href="https://api.dart.dev/stable/3.2.4/dart-core/String-class.html">String</a></span>
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
<div class="features"><span class="feature">final</span></div>
|
|
|
|
</dd>
|
|
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
<section
|
|
class="summary offset-anchor"
|
|
id="instance-methods">
|
|
<h2>Methods</h2>
|
|
<dl class="callables">
|
|
<dt id="copyWithId" class="callable">
|
|
<span class="name"><a href="../moxxmpp/StickerPack/copyWithId.html">copyWithId</a></span><span class="signature">(<wbr><span class="parameter" id="copyWithId-param-newHashFunction"><span class="type-annotation"><a href="../moxxmpp/HashFunction.html">HashFunction</a></span> <span class="parameter-name">newHashFunction</span>, </span><span class="parameter" id="copyWithId-param-newId"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.2.4/dart-core/String-class.html">String</a></span> <span class="parameter-name">newId</span></span>)
|
|
<span class="returntype parameter">→ <a href="../moxxmpp/StickerPack-class.html">StickerPack</a></span>
|
|
</span>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
When using the fromXML factory to parse a description of a sticker pack with a
|
|
yet unknown hash, then this function can be used in order to apply the freshly
|
|
calculated hash to the object.
|
|
|
|
|
|
</dd>
|
|
|
|
<dt id="getHash" class="callable">
|
|
<span class="name"><a href="../moxxmpp/StickerPack/getHash.html">getHash</a></span><span class="signature">(<wbr><span class="parameter" id="getHash-param-hashFunction"><span class="type-annotation"><a href="../moxxmpp/HashFunction.html">HashFunction</a></span> <span class="parameter-name">hashFunction</span></span>)
|
|
<span class="returntype parameter">→ <a href="https://api.dart.dev/stable/3.2.4/dart-async/Future-class.html">Future</a><span class="signature"><<wbr><span class="type-parameter"><a href="https://api.dart.dev/stable/3.2.4/dart-core/String-class.html">String</a></span>></span></span>
|
|
</span>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
Calculates the sticker pack's hash as specified by XEP-0449.
|
|
|
|
|
|
</dd>
|
|
|
|
<dt id="noSuchMethod" class="callable inherited">
|
|
<span class="name"><a href="https://api.dart.dev/stable/3.2.4/dart-core/Object/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.2.4/dart-core/Invocation-class.html">Invocation</a></span> <span class="parameter-name">invocation</span></span>)
|
|
<span class="returntype parameter">→ dynamic</span>
|
|
</span>
|
|
|
|
|
|
</dt>
|
|
<dd class="inherited">
|
|
Invoked when a nonexistent method or property is accessed.
|
|
<div class="features"><span class="feature">inherited</span></div>
|
|
|
|
</dd>
|
|
|
|
<dt id="toString" class="callable inherited">
|
|
<span class="name"><a href="https://api.dart.dev/stable/3.2.4/dart-core/Object/toString.html">toString</a></span><span class="signature">(<wbr>)
|
|
<span class="returntype parameter">→ <a href="https://api.dart.dev/stable/3.2.4/dart-core/String-class.html">String</a></span>
|
|
</span>
|
|
|
|
|
|
</dt>
|
|
<dd class="inherited">
|
|
A string representation of this object.
|
|
<div class="features"><span class="feature">inherited</span></div>
|
|
|
|
</dd>
|
|
|
|
<dt id="toXML" class="callable">
|
|
<span class="name"><a href="../moxxmpp/StickerPack/toXML.html">toXML</a></span><span class="signature">(<wbr>)
|
|
<span class="returntype parameter">→ <a href="../moxxmpp/XMLNode-class.html">XMLNode</a></span>
|
|
</span>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
</dl>
|
|
</section>
|
|
|
|
<section
|
|
class="summary offset-anchor inherited"
|
|
id="operators">
|
|
<h2>Operators</h2>
|
|
<dl class="callables">
|
|
<dt id="operator ==" class="callable inherited">
|
|
<span class="name"><a href="https://api.dart.dev/stable/3.2.4/dart-core/Object/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.2.4/dart-core/Object-class.html">Object</a></span> <span class="parameter-name">other</span></span>)
|
|
<span class="returntype parameter">→ <a href="https://api.dart.dev/stable/3.2.4/dart-core/bool-class.html">bool</a></span>
|
|
</span>
|
|
|
|
|
|
</dt>
|
|
<dd class="inherited">
|
|
The equality operator.
|
|
<div class="features"><span class="feature">inherited</span></div>
|
|
|
|
</dd>
|
|
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
</div> <!-- /.main-content -->
|
|
|
|
<div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
|
|
<!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
|
|
<header id="header-search-sidebar" class="hidden-l">
|
|
<form class="search-sidebar" role="search">
|
|
<input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
|
|
</form>
|
|
</header>
|
|
|
|
<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
|
|
<li><a href="../index.html">moxxmpp</a></li>
|
|
<li><a href="../moxxmpp/moxxmpp-library.html">moxxmpp</a></li>
|
|
<li class="self-crumb">StickerPack class</li>
|
|
</ol>
|
|
|
|
|
|
<h5>moxxmpp library</h5>
|
|
<div id="dartdoc-sidebar-left-content"></div>
|
|
</div>
|
|
|
|
<div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
|
|
</div><!--/.sidebar-offcanvas-->
|
|
|
|
</main>
|
|
|
|
<footer>
|
|
<span class="no-break">
|
|
moxxmpp
|
|
0.4.0
|
|
</span>
|
|
|
|
|
|
</footer>
|
|
|
|
|
|
|
|
<script src="../static-assets/highlight.pack.js?v1"></script>
|
|
<script src="../static-assets/docs.dart.js"></script>
|
|
|
|
|
|
|
|
</body>
|
|
|
|
</html>
|
|
|