urbanairship-react-native
Version:
Airship plugin for React Native apps.
349 lines • 16.9 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AttributeEditor | urbanairship-react-native</title>
<meta name="description" content="Documentation for urbanairship-react-native">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">urbanairship-react-native</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/_attributeeditor_.html">"AttributeEditor"</a>
</li>
<li>
<a href="_attributeeditor_.attributeeditor.html">AttributeEditor</a>
</li>
</ul>
<h1>Class AttributeEditor</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Editor for attributes.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">AttributeEditor</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_attributeeditor_.attributeeditor.html#onapply" class="tsd-kind-icon">on<wbr>Apply</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_attributeeditor_.attributeeditor.html#operations" class="tsd-kind-icon">operations</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_attributeeditor_.attributeeditor.html#apply" class="tsd-kind-icon">apply</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_attributeeditor_.attributeeditor.html#removeattribute" class="tsd-kind-icon">remove<wbr>Attribute</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_attributeeditor_.attributeeditor.html#setattribute" class="tsd-kind-icon">set<wbr>Attribute</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="onapply" class="tsd-anchor"></a>
<h3>on<wbr>Apply</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Apply<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>operations<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AttributeOperation</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/AttributeEditor.ts#L32">urbanairship-react-native/js/AttributeEditor.ts:32</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>operations<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AttributeOperation</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>operations: <span class="tsd-signature-type">AttributeOperation</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="operations" class="tsd-anchor"></a>
<h3>operations</h3>
<div class="tsd-signature tsd-kind-icon">operations<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AttributeOperation</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/AttributeEditor.ts#L33">urbanairship-react-native/js/AttributeEditor.ts:33</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="apply" class="tsd-anchor"></a>
<h3>apply</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">apply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/AttributeEditor.ts#L100">urbanairship-react-native/js/AttributeEditor.ts:100</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Applies the attribute operations.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="removeattribute" class="tsd-anchor"></a>
<h3>remove<wbr>Attribute</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">remove<wbr>Attribute<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_attributeeditor_.attributeeditor.html" class="tsd-signature-type">AttributeEditor</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/AttributeEditor.ts#L91">urbanairship-react-native/js/AttributeEditor.ts:91</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Removes an attribute.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The name of the attribute to remove.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_attributeeditor_.attributeeditor.html" class="tsd-signature-type">AttributeEditor</a></h4>
<p>The attribute editor instance.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="setattribute" class="tsd-anchor"></a>
<h3>set<wbr>Attribute</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Attribute<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_attributeeditor_.attributeeditor.html" class="tsd-signature-type">AttributeEditor</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/urbanairship/react-native-airship/blob/0639739/urbanairship-react-native/js/AttributeEditor.ts#L53">urbanairship-react-native/js/AttributeEditor.ts:53</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Adds an attribute.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The attribute name.</p>
</div>
</li>
<li>
<h5>value: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></h5>
<div class="tsd-comment tsd-typography">
<p>The attribute value.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_attributeeditor_.attributeeditor.html" class="tsd-signature-type">AttributeEditor</a></h4>
<p>The attribute editor instance.</p>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/_attributeeditor_.html">"<wbr>Attribute<wbr>Editor"</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_customevent_.html">"<wbr>Custom<wbr>Event"</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_json_.html">"<wbr>Json"</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_messageview_.html">"<wbr>Message<wbr>View"</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_scopedsubscriptionlisteditor_.html">"<wbr>Scoped<wbr>Subscription<wbr>List<wbr>Editor"</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_subscriptionlisteditor_.html">"<wbr>Subscription<wbr>List<wbr>Editor"</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_subscriptionlists_.html">"<wbr>Subscription<wbr>Lists"</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_taggroupeditor_.html">"<wbr>Tag<wbr>Group<wbr>Editor"</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_uaeventemitter_.html">"UAEvent<wbr>Emitter"</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_urbanairship_.html">"<wbr>Urban<wbr>Airship"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="_attributeeditor_.attributeeditor.html" class="tsd-kind-icon">Attribute<wbr>Editor</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_attributeeditor_.attributeeditor.html#onapply" class="tsd-kind-icon">on<wbr>Apply</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_attributeeditor_.attributeeditor.html#operations" class="tsd-kind-icon">operations</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_attributeeditor_.attributeeditor.html#apply" class="tsd-kind-icon">apply</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_attributeeditor_.attributeeditor.html#removeattribute" class="tsd-kind-icon">remove<wbr>Attribute</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_attributeeditor_.attributeeditor.html#setattribute" class="tsd-kind-icon">set<wbr>Attribute</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>