com.phloxui
Version:
PhloxUI Ng2+ Framework
753 lines • 43 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>INotificationManager | com.phloxui</title>
<meta name="description" content="">
<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.js" 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">com.phloxui</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/_share_inotificationmanager_.html">"share/INotificationManager"</a>
</li>
<li>
<a href="_share_inotificationmanager_.inotificationmanager.html">INotificationManager</a>
</li>
</ul>
<h1>Interface INotificationManager</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 style="text-indent: 2em;">
A <code>ng</code> service interface having main responsibilities on <code>application</code> notification <code>UI</code> logics.
Please note that this class does NOT directly involve with server-side push notification logics. It's only a client-side
API providing the way to interact with notification <code>UI</code> components. A <a href="../classes/_component_model_notification_.notification.html">Notification</a> can be <code>pinned</code>
on the screen --you can do this via <a href="_share_inotificationmanager_.inotificationmanager.html#pinnotification">pinNotification</a> method. This will make it not to be removed from the screen when
display timeout is reached unless the user clicks on the close button. All <code>unread</code> notifications --those which
automatically removed when display timeout is reached-- will be displayed as a badge notification showing the number of
<code>unread</code> items. You can also retrieve the list of <code>unread</code> items by using <a href="_share_inotificationmanager_.inotificationmanager.html#getunreadnotifications">getUnreadNotifications</a>
method.
</p>
</div>
<dl class="tsd-comment-tags">
<dt>author</dt>
<dd><p>shiorin, tee4cute</p>
</dd>
<dt>see</dt>
<dd><p><a href="../classes/_component_model_notification_.notification.html">Notification</a></p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">INotificationManager</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/_service_notificationmanager_service_.notificationmanager.html" class="tsd-signature-type">NotificationManager</a></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>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_share_inotificationmanager_.inotificationmanager.html#clear" class="tsd-kind-icon">clear</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_share_inotificationmanager_.inotificationmanager.html#clearall" class="tsd-kind-icon">clear<wbr>All</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_share_inotificationmanager_.inotificationmanager.html#clearby" class="tsd-kind-icon">clear<wbr>By</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_share_inotificationmanager_.inotificationmanager.html#getnotifications" class="tsd-kind-icon">get<wbr>Notifications</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_share_inotificationmanager_.inotificationmanager.html#getnotificationsby" class="tsd-kind-icon">get<wbr>Notifications<wbr>By</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_share_inotificationmanager_.inotificationmanager.html#getshowingnotifications" class="tsd-kind-icon">get<wbr>Showing<wbr>Notifications</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_share_inotificationmanager_.inotificationmanager.html#getshowingnotificationsby" class="tsd-kind-icon">get<wbr>Showing<wbr>Notifications<wbr>By</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_share_inotificationmanager_.inotificationmanager.html#getunreadnotifications" class="tsd-kind-icon">get<wbr>Unread<wbr>Notifications</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_share_inotificationmanager_.inotificationmanager.html#getunreadnotificationsby" class="tsd-kind-icon">get<wbr>Unread<wbr>Notifications<wbr>By</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_share_inotificationmanager_.inotificationmanager.html#markasread" class="tsd-kind-icon">mark<wbr>AsRead</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_share_inotificationmanager_.inotificationmanager.html#markasreadall" class="tsd-kind-icon">mark<wbr>AsRead<wbr>All</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_share_inotificationmanager_.inotificationmanager.html#markasreadby" class="tsd-kind-icon">mark<wbr>AsRead<wbr>By</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_share_inotificationmanager_.inotificationmanager.html#notify" class="tsd-kind-icon">notify</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_share_inotificationmanager_.inotificationmanager.html#pinnotification" class="tsd-kind-icon">pin<wbr>Notification</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_share_inotificationmanager_.inotificationmanager.html#unpinnotification" class="tsd-kind-icon">unpin<wbr>Notification</a></li>
</ul>
</section>
</div>
</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-interface">
<a name="clear" class="tsd-anchor"></a>
<h3>clear</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">clear<span class="tsd-signature-symbol">(</span>notification<span class="tsd-signature-symbol">: </span><a href="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a><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 share/INotificationManager.ts:33</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Remove the given <code><b>notification</b></code> from the <code>UI</code>. This also remove the notification message
from <code>unread</code> and <code>pinned</code> items list.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>notification: <a href="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a></h5>
</li>
</ul>
<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-interface">
<a name="clearall" class="tsd-anchor"></a>
<h3>clear<wbr>All</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">clear<wbr>All<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 share/INotificationManager.ts:54</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Clear all notifications from the <code>UI</code>. This also remove all notification messages from <code>unread</code> and
<code>pinned</code> items list.
</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-interface">
<a name="clearby" class="tsd-anchor"></a>
<h3>clear<wbr>By</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">clear<wbr>By<span class="tsd-signature-symbol">(</span>notificationType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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><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 share/INotificationManager.ts:46</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Remove all notifications which matches the given <code><b>notificationType</b></code> and <code><b>name</b></code>. This
method also remove the notifications from <code>unread</code> and <code>pinned</code> items list.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>notificationType: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A notification's type (<a href="../classes/_component_model_notification_.notification.html#type">Notification.type</a>) to be cleared. Passing <code>null</code> means not to
apply the filter on this field.</p>
</div>
</li>
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A notification's name (<a href="../classes/_component_model_notification_.notification.html#name">Notification.name</a>) to be cleared. Passing <code>null</code> means not to
apply the filter on this field.</p>
</div>
</li>
</ul>
<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-interface">
<a name="getnotifications" class="tsd-anchor"></a>
<h3>get<wbr>Notifications</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Notifications<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in share/INotificationManager.ts:61</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Get all notifications in the <code>UI</code>.
</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getnotificationsby" class="tsd-anchor"></a>
<h3>get<wbr>Notifications<wbr>By</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Notifications<wbr>By<span class="tsd-signature-symbol">(</span>notificationType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in share/INotificationManager.ts:72</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Get all notifications in the <code>UI</code> by the given <code><b>notificationType</b></code> and <code><b>name</b></code>.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>notificationType: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A notification's type (<a href="../classes/_component_model_notification_.notification.html#type">Notification.type</a>) to filter. Passing <code>null</code> means not to apply the filter
on this field.</p>
</div>
</li>
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A notification's name (<a href="../classes/_component_model_notification_.notification.html#name">Notification.name</a>) to filter. Passing <code>null</code> means not to apply the filter on this field.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getshowingnotifications" class="tsd-anchor"></a>
<h3>get<wbr>Showing<wbr>Notifications</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Showing<wbr>Notifications<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in share/INotificationManager.ts:79</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Get all notifications being shown in the <code>UI</code>.
</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getshowingnotificationsby" class="tsd-anchor"></a>
<h3>get<wbr>Showing<wbr>Notifications<wbr>By</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Showing<wbr>Notifications<wbr>By<span class="tsd-signature-symbol">(</span>notificationType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in share/INotificationManager.ts:90</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Get all notifications being shown in the <code>UI</code> by the given <code><b>notificationType</b></code> and <code><b>name</b></code>.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>notificationType: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A notification's type (<a href="../classes/_component_model_notification_.notification.html#type">Notification.type</a>) to filter. Passing <code>null</code> means not to apply the filter
on this field.</p>
</div>
</li>
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A notification's name (<a href="../classes/_component_model_notification_.notification.html#name">Notification.name</a>) to filter. Passing <code>null</code> means not to apply the filter on this field.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getunreadnotifications" class="tsd-anchor"></a>
<h3>get<wbr>Unread<wbr>Notifications</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Unread<wbr>Notifications<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in share/INotificationManager.ts:97</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Get all <code>unread</code> notifications in the <code>UI</code>.
</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getunreadnotificationsby" class="tsd-anchor"></a>
<h3>get<wbr>Unread<wbr>Notifications<wbr>By</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Unread<wbr>Notifications<wbr>By<span class="tsd-signature-symbol">(</span>notificationType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in share/INotificationManager.ts:108</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Get all <code>unread</code> notifications in the <code>UI</code> by the given <code><b>notificationType</b></code> and <code><b>name</b></code>.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>notificationType: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A notification's type (<a href="../classes/_component_model_notification_.notification.html#type">Notification.type</a>) to filter. Passing <code>null</code> means not to apply the filter
on this field.</p>
</div>
</li>
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A notification's name (<a href="../classes/_component_model_notification_.notification.html#name">Notification.name</a>) to filter. Passing <code>null</code> means not to apply the filter on this field.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="markasread" class="tsd-anchor"></a>
<h3>mark<wbr>AsRead</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">mark<wbr>AsRead<span class="tsd-signature-symbol">(</span>notification<span class="tsd-signature-symbol">: </span><a href="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a><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 share/INotificationManager.ts:115</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Mark the given <code>notification</code> as <code>read</code>.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>notification: <a href="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a></h5>
</li>
</ul>
<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-interface">
<a name="markasreadall" class="tsd-anchor"></a>
<h3>mark<wbr>AsRead<wbr>All</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">mark<wbr>AsRead<wbr>All<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 share/INotificationManager.ts:133</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Mark all <code>notification</code>s as <code>read</code>.
</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-interface">
<a name="markasreadby" class="tsd-anchor"></a>
<h3>mark<wbr>AsRead<wbr>By</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">mark<wbr>AsRead<wbr>By<span class="tsd-signature-symbol">(</span>notificationType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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><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 share/INotificationManager.ts:126</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Mark <code>notification</code>s as <code>read</code> by the given <code><b>notificationType</b></code> and <code><b>name</b></code>.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>notificationType: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A notification's type (<a href="../classes/_component_model_notification_.notification.html#type">Notification.type</a>) to filter. Passing <code>null</code> means not to apply the filter
on this field.</p>
</div>
</li>
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A notification's name (<a href="../classes/_component_model_notification_.notification.html#name">Notification.name</a>) to filter. Passing <code>null</code> means not to apply the filter on this field.</p>
</div>
</li>
</ul>
<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-interface">
<a name="notify" class="tsd-anchor"></a>
<h3>notify</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">notify<span class="tsd-signature-symbol">(</span>notification<span class="tsd-signature-symbol">: </span><a href="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a><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 share/INotificationManager.ts:25</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Notify user by displaying the given <code><b>notification</b></code> message on the screen.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>notification: <a href="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a></h5>
</li>
</ul>
<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-interface">
<a name="pinnotification" class="tsd-anchor"></a>
<h3>pin<wbr>Notification</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">pin<wbr>Notification<span class="tsd-signature-symbol">(</span>notification<span class="tsd-signature-symbol">: </span><a href="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a><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 share/INotificationManager.ts:140</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Pin the given <code>notification</code> on the screen.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>notification: <a href="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a></h5>
</li>
</ul>
<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-interface">
<a name="unpinnotification" class="tsd-anchor"></a>
<h3>unpin<wbr>Notification</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">unpin<wbr>Notification<span class="tsd-signature-symbol">(</span>notification<span class="tsd-signature-symbol">: </span><a href="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a><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 share/INotificationManager.ts:147</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Unpin the given <code>notification</code> off the screen.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>notification: <a href="../classes/_component_model_notification_.notification.html" class="tsd-signature-type">Notification</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</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-external-module">
<a href="../modules/_share_inotificationmanager_.html">"share/INotification<wbr>Manager"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-external-module">
<a href="_share_inotificationmanager_.inotificationmanager.html" class="tsd-kind-icon">INotification<wbr>Manager</a>
<ul>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_share_inotificationmanager_.inotificationmanager.html#clear" class="tsd-kind-icon">clear</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_share_inotificationmanager_.inotificationmanager.html#clearall" class="tsd-kind-icon">clear<wbr>All</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_share_inotificationmanager_.inotificationmanager.html#clearby" class="tsd-kind-icon">clear<wbr>By</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_share_inotificationmanager_.inotificationmanager.html#getnotifications" class="tsd-kind-icon">get<wbr>Notifications</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_share_inotificationmanager_.inotificationmanager.html#getnotificationsby" class="tsd-kind-icon">get<wbr>Notifications<wbr>By</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_share_inotificationmanager_.inotificationmanager.html#getshowingnotifications" class="tsd-kind-icon">get<wbr>Showing<wbr>Notifications</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_share_inotificationmanager_.inotificationmanager.html#getshowingnotificationsby" class="tsd-kind-icon">get<wbr>Showing<wbr>Notifications<wbr>By</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_share_inotificationmanager_.inotificationmanager.html#getunreadnotifications" class="tsd-kind-icon">get<wbr>Unread<wbr>Notifications</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_share_inotificationmanager_.inotificationmanager.html#getunreadnotificationsby" class="tsd-kind-icon">get<wbr>Unread<wbr>Notifications<wbr>By</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_share_inotificationmanager_.inotificationmanager.html#markasread" class="tsd-kind-icon">mark<wbr>AsRead</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_share_inotificationmanager_.inotificationmanager.html#markasreadall" class="tsd-kind-icon">mark<wbr>AsRead<wbr>All</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_share_inotificationmanager_.inotificationmanager.html#markasreadby" class="tsd-kind-icon">mark<wbr>AsRead<wbr>By</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_share_inotificationmanager_.inotificationmanager.html#notify" class="tsd-kind-icon">notify</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_share_inotificationmanager_.inotificationmanager.html#pinnotification" class="tsd-kind-icon">pin<wbr>Notification</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_share_inotificationmanager_.inotificationmanager.html#unpinnotification" class="tsd-kind-icon">unpin<wbr>Notification</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-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</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-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</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-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</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>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>