402 lines
16 KiB
HTML
402 lines
16 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 RosterFeatureNegotiator class from the moxxmpp library, for the Dart programming language.">
|
|
<title>RosterFeatureNegotiator 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">RosterFeatureNegotiator class</li>
|
|
</ol>
|
|
<div class="self-name">RosterFeatureNegotiator</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/RosterFeatureNegotiator-class-sidebar.html">
|
|
<div>
|
|
<h1><span class="kind-class">RosterFeatureNegotiator</span> class
|
|
|
|
</h1></div>
|
|
|
|
|
|
<section class="desc markdown">
|
|
<p>A Stub feature negotiator for finding out whether roster versioning is supported.</p>
|
|
</section>
|
|
|
|
|
|
<section>
|
|
<dl class="dl-horizontal">
|
|
|
|
<dt>Inheritance</dt>
|
|
<dd>
|
|
<ul class="gt-separated dark clazz-relationships">
|
|
<li><a href="https://api.dart.dev/stable/3.2.4/dart-core/Object-class.html">Object</a></li>
|
|
<li><a href="../moxxmpp/XmppFeatureNegotiatorBase-class.html">XmppFeatureNegotiatorBase</a></li>
|
|
<li>RosterFeatureNegotiator</li>
|
|
</ul>
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
<section class="summary offset-anchor" id="constructors">
|
|
<h2>Constructors</h2>
|
|
|
|
<dl class="constructor-summary-list">
|
|
<dt id="RosterFeatureNegotiator" class="callable">
|
|
<span class="name"><a href="../moxxmpp/RosterFeatureNegotiator/RosterFeatureNegotiator.html">RosterFeatureNegotiator</a></span><span class="signature">()</span>
|
|
</dt>
|
|
<dd>
|
|
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
|
|
<section class="summary offset-anchor" id="instance-properties">
|
|
<h2>Properties</h2>
|
|
|
|
<dl class="properties">
|
|
<dt id="attributes" class="property inherited">
|
|
<span class="name"><a href="../moxxmpp/XmppFeatureNegotiatorBase/attributes.html">attributes</a></span>
|
|
<span class="signature">→ <a href="../moxxmpp/NegotiatorAttributes-class.html">NegotiatorAttributes</a></span>
|
|
|
|
</dt>
|
|
<dd class="inherited">
|
|
|
|
<div class="features"><span class="feature">no setter</span><span class="feature">inherited</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="id" class="property inherited">
|
|
<span class="name"><a href="../moxxmpp/XmppFeatureNegotiatorBase/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 class="inherited">
|
|
The Id of the negotiator
|
|
<div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>
|
|
|
|
</dd>
|
|
|
|
<dt id="isSupported" class="property">
|
|
<span class="name"><a href="../moxxmpp/RosterFeatureNegotiator/isSupported.html">isSupported</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">no setter</span></div>
|
|
|
|
</dd>
|
|
|
|
<dt id="negotiatingXmlns" class="property inherited">
|
|
<span class="name"><a href="../moxxmpp/XmppFeatureNegotiatorBase/negotiatingXmlns.html">negotiatingXmlns</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 class="inherited">
|
|
The XMLNS the negotiator will negotiate
|
|
<div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>
|
|
|
|
</dd>
|
|
|
|
<dt id="priority" class="property inherited">
|
|
<span class="name"><a href="../moxxmpp/XmppFeatureNegotiatorBase/priority.html">priority</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 priority regarding other negotiators. The higher, the earlier will the
|
|
negotiator be used
|
|
<div class="features"><span class="feature">final</span><span class="feature">inherited</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="sendStreamHeaderWhenDone" class="property inherited">
|
|
<span class="name"><a href="../moxxmpp/XmppFeatureNegotiatorBase/sendStreamHeaderWhenDone.html">sendStreamHeaderWhenDone</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 class="inherited">
|
|
If true, then a new stream header will be sent when the negotiator switches its
|
|
state to done. If false, no stream header will be sent.
|
|
<div class="features"><span class="feature">final</span><span class="feature">inherited</span></div>
|
|
|
|
</dd>
|
|
|
|
<dt id="state" class="property inherited">
|
|
<span class="name"><a href="../moxxmpp/XmppFeatureNegotiatorBase/state.html">state</a></span>
|
|
<span class="signature">↔ <a href="../moxxmpp/NegotiatorState.html">NegotiatorState</a></span>
|
|
|
|
</dt>
|
|
<dd class="inherited">
|
|
The state the negotiator is currently in
|
|
<div class="features"><span class="feature">getter/setter pair</span><span class="feature">inherited</span></div>
|
|
|
|
</dd>
|
|
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
<section
|
|
class="summary offset-anchor"
|
|
id="instance-methods">
|
|
<h2>Methods</h2>
|
|
<dl class="callables">
|
|
<dt id="matchesFeature" class="callable inherited">
|
|
<span class="name"><a href="../moxxmpp/XmppFeatureNegotiatorBase/matchesFeature.html">matchesFeature</a></span><span class="signature">(<wbr><span class="parameter" id="matchesFeature-param-features"><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/XMLNode-class.html">XMLNode</a></span>></span></span> <span class="parameter-name">features</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">
|
|
Returns true if a feature in <code>features</code>, which are the children of the
|
|
<stream:features /> nonza, can be negotiated. Otherwise, returns false.
|
|
<div class="features"><span class="feature">inherited</span></div>
|
|
|
|
</dd>
|
|
|
|
<dt id="negotiate" class="callable">
|
|
<span class="name"><a href="../moxxmpp/RosterFeatureNegotiator/negotiate.html">negotiate</a></span><span class="signature">(<wbr><span class="parameter" id="negotiate-param-nonza"><span class="type-annotation"><a href="../moxxmpp/XMLNode-class.html">XMLNode</a></span> <span class="parameter-name">nonza</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">Result<span class="signature"><<wbr><span class="type-parameter"><a href="../moxxmpp/NegotiatorState.html">NegotiatorState</a></span>, <span class="type-parameter"><a href="../moxxmpp/NegotiatorError-class.html">NegotiatorError</a></span>></span></span>></span></span>
|
|
</span>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
Called with the currently received nonza <code>nonza</code> when the negotiator is active.
|
|
If the negotiator is just elected to be the next one, then <code>nonza</code> is equal to
|
|
the <stream:features /> nonza.
|
|
<div class="features"><span class="feature">override</span></div>
|
|
|
|
</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="onXmppEvent" class="callable inherited">
|
|
<span class="name"><a href="../moxxmpp/XmppFeatureNegotiatorBase/onXmppEvent.html">onXmppEvent</a></span><span class="signature">(<wbr><span class="parameter" id="onXmppEvent-param-event"><span class="type-annotation"><a href="../moxxmpp/XmppEvent-class.html">XmppEvent</a></span> <span class="parameter-name">event</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">void</span>></span></span>
|
|
</span>
|
|
|
|
|
|
</dt>
|
|
<dd class="inherited">
|
|
Called when an event is triggered in the <a href="../moxxmpp/XmppConnection-class.html">XmppConnection</a>.
|
|
<div class="features"><span class="feature">inherited</span></div>
|
|
|
|
</dd>
|
|
|
|
<dt id="postRegisterCallback" class="callable inherited">
|
|
<span class="name"><a href="../moxxmpp/XmppFeatureNegotiatorBase/postRegisterCallback.html">postRegisterCallback</a></span><span class="signature">(<wbr>)
|
|
<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">void</span>></span></span>
|
|
</span>
|
|
|
|
|
|
</dt>
|
|
<dd class="inherited">
|
|
Run after all negotiators are registered. Useful for registering callbacks against
|
|
other negotiators. By default this function does nothing.
|
|
<div class="features"><span class="feature">inherited</span></div>
|
|
|
|
</dd>
|
|
|
|
<dt id="register" class="callable inherited">
|
|
<span class="name"><a href="../moxxmpp/XmppFeatureNegotiatorBase/register.html">register</a></span><span class="signature">(<wbr><span class="parameter" id="register-param-attributes"><span class="type-annotation"><a href="../moxxmpp/NegotiatorAttributes-class.html">NegotiatorAttributes</a></span> <span class="parameter-name">attributes</span></span>)
|
|
<span class="returntype parameter">→ void</span>
|
|
</span>
|
|
|
|
|
|
</dt>
|
|
<dd class="inherited">
|
|
Register the negotiator against a connection class by means of <code>attributes</code>.
|
|
<div class="features"><span class="feature">inherited</span></div>
|
|
|
|
</dd>
|
|
|
|
<dt id="reset" class="callable">
|
|
<span class="name"><a href="../moxxmpp/RosterFeatureNegotiator/reset.html">reset</a></span><span class="signature">(<wbr>)
|
|
<span class="returntype parameter">→ void</span>
|
|
</span>
|
|
|
|
|
|
</dt>
|
|
<dd>
|
|
Reset the negotiator to a state that negotation can happen again.
|
|
<div class="features"><span class="feature">override</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>
|
|
|
|
</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">RosterFeatureNegotiator 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>
|
|
|