npm - @twilio/conversations - Versions diffs - 1.3.0-rc8 → 2.0.0-rc.4 - Mend

@twilio/conversations 1.3.0-rc8 → 2.0.0-rc.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (282) hide show

package/CHANGELOG.md +210 -0
package/README.md +22 -17
package/dist/browser.js +7873 -0
package/dist/browser.js.map +1 -0
package/dist/docs/assets/css/main.css +2660 -0
package/dist/docs/assets/images/icons.png +0 -0
package/dist/docs/assets/images/icons@2x.png +0 -0
package/dist/docs/assets/images/widgets.png +0 -0
package/dist/docs/assets/images/widgets@2x.png +0 -0
package/dist/docs/assets/js/main.js +248 -0
package/dist/docs/assets/js/search.js +1 -0
package/dist/docs/classes/AggregatedDeliveryReceipt.html +3286 -0
package/dist/docs/classes/Client.html +4181 -0
package/dist/docs/classes/Conversation.html +4397 -0
package/dist/docs/classes/DetailedDeliveryReceipt.html +3265 -0
package/dist/docs/classes/Media.html +3295 -0
package/dist/docs/classes/Message.html +3713 -0
package/dist/docs/classes/MessageBuilder.html +3280 -0
package/dist/docs/classes/Participant.html +3517 -0
package/dist/docs/classes/PushNotification.html +3232 -0
package/dist/docs/classes/RestPaginator.html +3262 -0
package/dist/docs/classes/UnsentMessage.html +3144 -0
package/dist/docs/classes/User.html +3451 -0
package/dist/docs/index.html +3394 -212
package/dist/docs/interfaces/ClientOptions.html +3136 -0
package/dist/docs/interfaces/ConversationState.html +3152 -0
package/dist/docs/interfaces/CreateConversationOptions.html +3168 -0
package/dist/docs/interfaces/LastMessage.html +3152 -0
package/dist/docs/interfaces/Paginator.html +3243 -0
package/dist/docs/interfaces/PushNotificationData.html +3168 -0
package/dist/docs/interfaces/SendEmailOptions.html +3136 -0
package/dist/docs/interfaces/SendMediaOptions.html +3170 -0
package/dist/docs/modules.html +3425 -0
package/dist/lib.d.ts +1952 -0
package/dist/lib.js +7873 -0
package/dist/lib.js.map +1 -0
package/dist/post-install.js +29 -0
package/dist/react-native.js +4038 -0
package/dist/react-native.js.map +1 -0
package/dist/twilio-conversations.js +40912 -0
package/dist/twilio-conversations.min.js +156 -0
package/package.json +59 -48
package/.circleci/config.yml +0 -650
package/.deepsource.toml +0 -6
package/.env.example +0 -13
package/browser/aggregateddeliveryreceipt.js +0 -152
package/browser/client.js +0 -991
package/browser/configuration.js +0 -80
package/browser/conversation.js +0 -1826
package/browser/data/conversations.js +0 -632
package/browser/data/messages.js +0 -522
package/browser/data/participants.js +0 -411
package/browser/data/users.js +0 -281
package/browser/detaileddeliveryreceipt.js +0 -44
package/browser/index.js +0 -4
package/browser/interfaces/limits.js +0 -3
package/browser/interfaces/notificationtypes.js +0 -21
package/browser/interfaces/paginator.js +0 -53
package/browser/interfaces/responsecodes.js +0 -20
package/browser/interfaces/transport.js +0 -3
package/browser/logger.js +0 -141
package/browser/media.js +0 -198
package/browser/message.js +0 -685
package/browser/participant.js +0 -415
package/browser/pushnotification.js +0 -49
package/browser/restpaginator.js +0 -74
package/browser/services/network.js +0 -223
package/browser/services/readhorizon.js +0 -181
package/browser/services/typingindicator.js +0 -142
package/browser/session.js +0 -505
package/browser/sessionerror.js +0 -93
package/browser/sri.json +0 -1
package/browser/synclist.js +0 -90
package/browser/synclistdescriptor.js +0 -29
package/browser/syncpaginator.js +0 -63
package/browser/user.js +0 -431
package/browser/util/deferred.js +0 -56
package/browser/util/index.js +0 -108
package/dist/@twilio/conversations.js +0 -35533
package/dist/@twilio/conversations.min.js +0 -204
package/dist/docs/AggregatedDeliveryReceipt.html +0 -948
package/dist/docs/Client.html +0 -5075
package/dist/docs/Conversation.html +0 -6018
package/dist/docs/DetailedDeliveryReceipt.html +0 -641
package/dist/docs/Media.html +0 -694
package/dist/docs/Message.html +0 -1934
package/dist/docs/Paginator.html +0 -605
package/dist/docs/Participant.html +0 -1510
package/dist/docs/PushNotification.html +0 -836
package/dist/docs/SessionError.html +0 -379
package/dist/docs/User.html +0 -1315
package/dist/docs/classes.list.html +0 -4431
package/dist/docs/fonts/glyphicons-halflings-regular.eot +0 -0
package/dist/docs/fonts/glyphicons-halflings-regular.svg +0 -288
package/dist/docs/fonts/glyphicons-halflings-regular.ttf +0 -0
package/dist/docs/fonts/glyphicons-halflings-regular.woff +0 -0
package/dist/docs/fonts/glyphicons-halflings-regular.woff2 +0 -0
package/dist/docs/img/glyphicons-halflings-white.png +0 -0
package/dist/docs/img/glyphicons-halflings.png +0 -0
package/dist/docs/quicksearch.html +0 -31
package/dist/docs/scripts/docstrap.lib.js +0 -11
package/dist/docs/scripts/fulltext-search-ui.js +0 -89
package/dist/docs/scripts/fulltext-search.js +0 -36
package/dist/docs/scripts/lunr.min.js +0 -6
package/dist/docs/scripts/prettify/Apache-License-2.0.txt +0 -202
package/dist/docs/scripts/prettify/jquery.min.js +0 -6
package/dist/docs/scripts/prettify/lang-css.js +0 -21
package/dist/docs/scripts/prettify/prettify.js +0 -496
package/dist/docs/scripts/sunlight.js +0 -1157
package/dist/docs/scripts/toc.js +0 -203
package/dist/docs/styles/darkstrap.css +0 -960
package/dist/docs/styles/prettify-tomorrow.css +0 -132
package/dist/docs/styles/site.cerulean.css +0 -7008
package/dist/docs/styles/site.cosmo.css +0 -7061
package/dist/docs/styles/site.cyborg.css +0 -7048
package/dist/docs/styles/site.darkly.css +0 -7171
package/dist/docs/styles/site.darkstrap.css +0 -5638
package/dist/docs/styles/site.dibs-bootstrap.css +0 -5899
package/dist/docs/styles/site.flatly.css +0 -7147
package/dist/docs/styles/site.journal.css +0 -6973
package/dist/docs/styles/site.lumen.css +0 -7298
package/dist/docs/styles/site.paper.css +0 -7623
package/dist/docs/styles/site.readable.css +0 -6997
package/dist/docs/styles/site.sandstone.css +0 -7035
package/dist/docs/styles/site.simplex.css +0 -7023
package/dist/docs/styles/site.slate.css +0 -7343
package/dist/docs/styles/site.spacelab.css +0 -7055
package/dist/docs/styles/site.superhero.css +0 -7131
package/dist/docs/styles/site.united.css +0 -6895
package/dist/docs/styles/site.yeti.css +0 -7195
package/dist/docs/styles/sunlight.dark.css +0 -345
package/dist/docs/styles/sunlight.default.css +0 -344
package/dist/sri.json +0 -1
package/lib/aggregateddeliveryreceipt.d.ts +0 -98
package/lib/aggregateddeliveryreceipt.js +0 -112
package/lib/client.d.ts +0 -317
package/lib/client.js +0 -633
package/lib/configuration.d.ts +0 -21
package/lib/configuration.js +0 -41
package/lib/conversation.d.ts +0 -460
package/lib/conversation.js +0 -940
package/lib/data/conversations.d.ts +0 -57
package/lib/data/conversations.js +0 -296
package/lib/data/messages.d.ts +0 -75
package/lib/data/messages.js +0 -208
package/lib/data/participants.d.ts +0 -94
package/lib/data/participants.js +0 -204
package/lib/data/users.d.ts +0 -42
package/lib/data/users.js +0 -113
package/lib/detaileddeliveryreceipt.d.ts +0 -45
package/lib/detaileddeliveryreceipt.js +0 -34
package/lib/index.d.ts +0 -1
package/lib/index.js +0 -3
package/lib/interfaces/limits.d.ts +0 -8
package/lib/interfaces/limits.js +0 -2
package/lib/interfaces/notificationtypes.d.ts +0 -8
package/lib/interfaces/notificationtypes.js +0 -11
package/lib/interfaces/paginator.d.ts +0 -52
package/lib/interfaces/paginator.js +0 -28
package/lib/interfaces/responsecodes.d.ts +0 -8
package/lib/interfaces/responsecodes.js +0 -10
package/lib/interfaces/transport.d.ts +0 -13
package/lib/interfaces/transport.js +0 -2
package/lib/logger.d.ts +0 -18
package/lib/logger.js +0 -35
package/lib/media.d.ts +0 -52
package/lib/media.js +0 -69
package/lib/message.d.ts +0 -136
package/lib/message.js +0 -305
package/lib/participant.d.ts +0 -142
package/lib/participant.js +0 -219
package/lib/pushnotification.d.ts +0 -48
package/lib/pushnotification.js +0 -39
package/lib/restpaginator.d.ts +0 -19
package/lib/restpaginator.js +0 -36
package/lib/services/network.d.ts +0 -22
package/lib/services/network.js +0 -87
package/lib/services/readhorizon.d.ts +0 -28
package/lib/services/readhorizon.js +0 -112
package/lib/services/typingindicator.d.ts +0 -50
package/lib/services/typingindicator.js +0 -102
package/lib/session.d.ts +0 -63
package/lib/session.js +0 -213
package/lib/sessionerror.d.ts +0 -12
package/lib/sessionerror.js +0 -24
package/lib/sri.json +0 -1
package/lib/synclist.d.ts +0 -24
package/lib/synclist.js +0 -28
package/lib/synclistdescriptor.d.ts +0 -27
package/lib/synclistdescriptor.js +0 -19
package/lib/syncpaginator.d.ts +0 -22
package/lib/syncpaginator.js +0 -37
package/lib/user.d.ts +0 -98
package/lib/user.js +0 -219
package/lib/util/deferred.d.ts +0 -12
package/lib/util/deferred.js +0 -22
package/lib/util/index.d.ts +0 -28
package/lib/util/index.js +0 -82
package/tools/rtd-sdk-cdn-pin/.gitrepo +0 -12
package/tools/rtd-sdk-cdn-pin/README.md +0 -54
package/tools/rtd-sdk-cdn-pin/bintray-settings.xml.template +0 -16
package/tools/rtd-sdk-cdn-pin/cdn-common/cdn-prepare.sh +0 -67
package/tools/rtd-sdk-cdn-pin/cdn-pin-latest.sh +0 -19
package/tools/rtd-sdk-cdn-pin/cdn-pin.sh +0 -19
package/tools/rtd-sdk-cdn-pin/cdn-upload.sh +0 -13
package/tools/rtd-sdk-cdn-pin/fetch/common/fetch-bintray-android.sh +0 -34
package/tools/rtd-sdk-cdn-pin/fetch/common/fetch-npm.sh +0 -18
package/tools/rtd-sdk-cdn-pin/fetch/twilio-chat-android.sh +0 -5
package/tools/rtd-sdk-cdn-pin/fetch/twilio-chat-js.sh +0 -5
package/tools/rtd-sdk-cdn-pin/fetch/twilio-conversations-android.sh +0 -6
package/tools/rtd-sdk-cdn-pin/fetch/twilio-conversations-js.sh +0 -5
package/tools/rtd-sdk-cdn-pin/fetch/twilio-sync-android.sh +0 -5
package/tools/rtd-sdk-cdn-pin/fetch/twilio-sync-js.sh +0 -5
package/tools/rtd-sdk-cdn-pin/fetch-artifact.sh +0 -26
package/tools/sdk-release-tool/.gitrepo +0 -12
package/tools/sdk-release-tool/Makefile +0 -49
package/tools/sdk-release-tool/README.md +0 -275
package/tools/sdk-release-tool/delete +0 -3
package/tools/sdk-release-tool/download +0 -3
package/tools/sdk-release-tool/get-cors +0 -3
package/tools/sdk-release-tool/list +0 -3
package/tools/sdk-release-tool/pin +0 -3
package/tools/sdk-release-tool/pin-latest +0 -3
package/tools/sdk-release-tool/requirements.txt +0 -4
package/tools/sdk-release-tool/sdk-release-tool +0 -3
package/tools/sdk-release-tool/sdk_release_tools/__init__.py +0 -0
package/tools/sdk-release-tool/sdk_release_tools/__main__.py +0 -110
package/tools/sdk-release-tool/sdk_release_tools/aws.py +0 -70
package/tools/sdk-release-tool/sdk_release_tools/cli.py +0 -181
package/tools/sdk-release-tool/sdk_release_tools/log.py +0 -24
package/tools/sdk-release-tool/sdk_release_tools/ops.py +0 -295
package/tools/sdk-release-tool/sdk_release_tools/rpm.py +0 -28
package/tools/sdk-release-tool/sdk_release_tools/util.py +0 -186
package/tools/sdk-release-tool/sdk_release_tools/versions.py +0 -362
package/tools/sdk-release-tool/signal-sdk-js.json +0 -28
package/tools/sdk-release-tool/tests/test_versions.py +0 -94
package/tools/sdk-release-tool/twilio-accessmanager-android.json +0 -19
package/tools/sdk-release-tool/twilio-accessmanager-ios.json +0 -26
package/tools/sdk-release-tool/twilio-auth-ios.json +0 -29
package/tools/sdk-release-tool/twilio-authenticator-ios.json +0 -29
package/tools/sdk-release-tool/twilio-chat-android-2.json +0 -19
package/tools/sdk-release-tool/twilio-chat-android.json +0 -22
package/tools/sdk-release-tool/twilio-chat-ios.json +0 -26
package/tools/sdk-release-tool/twilio-chat-js.json +0 -27
package/tools/sdk-release-tool/twilio-client-android-aar.json +0 -22
package/tools/sdk-release-tool/twilio-client-android.json +0 -22
package/tools/sdk-release-tool/twilio-client-ios.json +0 -20
package/tools/sdk-release-tool/twilio-client-js.json +0 -17
package/tools/sdk-release-tool/twilio-client-sounds-js.json +0 -14
package/tools/sdk-release-tool/twilio-common-android-maven.json +0 -16
package/tools/sdk-release-tool/twilio-common-android.json +0 -22
package/tools/sdk-release-tool/twilio-common-ios-rtc.json +0 -25
package/tools/sdk-release-tool/twilio-common-ios.json +0 -25
package/tools/sdk-release-tool/twilio-common-js.json +0 -19
package/tools/sdk-release-tool/twilio-conversations-android.json +0 -22
package/tools/sdk-release-tool/twilio-conversations-ios.json +0 -26
package/tools/sdk-release-tool/twilio-conversations-js.json +0 -27
package/tools/sdk-release-tool/twilio-flex-js.json +0 -20
package/tools/sdk-release-tool/twilio-flex-webchat-js.json +0 -16
package/tools/sdk-release-tool/twilio-frame-chat-android.json +0 -22
package/tools/sdk-release-tool/twilio-frame-chat-ios.json +0 -23
package/tools/sdk-release-tool/twilio-frame-chat-js.json +0 -23
package/tools/sdk-release-tool/twilio-ip-messaging-android-maven.json +0 -16
package/tools/sdk-release-tool/twilio-ip-messaging-android.json +0 -22
package/tools/sdk-release-tool/twilio-ip-messaging-ios.json +0 -25
package/tools/sdk-release-tool/twilio-ip-messaging-js.json +0 -21
package/tools/sdk-release-tool/twilio-sync-android.json +0 -22
package/tools/sdk-release-tool/twilio-sync-ios.json +0 -26
package/tools/sdk-release-tool/twilio-sync-js.json +0 -39
package/tools/sdk-release-tool/twilio-taskrouter-js.json +0 -17
package/tools/sdk-release-tool/twilio-video-android.json +0 -22
package/tools/sdk-release-tool/twilio-video-cpp-linux-cross-rootfs.json +0 -13
package/tools/sdk-release-tool/twilio-video-cpp.json +0 -33
package/tools/sdk-release-tool/twilio-video-ios.json +0 -25
package/tools/sdk-release-tool/twilio-video-js.json +0 -19
package/tools/sdk-release-tool/twilio-video-jsdocs.json +0 -14
package/tools/sdk-release-tool/twilio-voice-android.json +0 -22
package/tools/sdk-release-tool/twilio-voice-ios.json +0 -29
package/tools/sdk-release-tool/unpin +0 -3
package/tools/sdk-release-tool/unpin-latest +0 -3
package/tools/sdk-release-tool/upload +0 -3
package/twilio-chat.js.iml +0 -9

package/dist/docs/User.html DELETED Viewed

@@ -1,1315 +0,0 @@
-<!DOCTYPE html><html lang="en"><head>
-	<meta charset="utf-8">
-	<meta name="viewport" content="width=device-width">
-	<title>Documentation Class: User</title>
-	<!--[if lt IE 9]>
-	<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-	<![endif]-->
-	<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
-	<link type="text/css" rel="stylesheet" href="styles/site.simplex.css">
-</head>
-<body>
-<div class="navbar navbar-default navbar-fixed-top ">
-<div class="container">
-	<div class="navbar-header">
-		<a class="navbar-brand" href="index.html">Documentation</a>
-		<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
-			<span class="icon-bar"></span>
-			<span class="icon-bar"></span>
-			<span class="icon-bar"></span>
-        </button>
-	</div>
-	<div class="navbar-collapse collapse" id="topNavigation">
-		<ul class="nav navbar-nav"><li class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" aria-expanded="false">Classes<b class="caret"></b></a><ul class="dropdown-menu"><li><a href="Client.html"><span style="color: #999">Twilio.Conversations.</span>Client</a></li><li><a href="Conversation.html">Conversation</a></li><li><a href="Participant.html">Participant</a></li><li><a href="Message.html">Message</a></li><li><a href="Media.html">Media</a></li><li><a href="AggregatedDeliveryReceipt.html">AggregatedDeliveryReceipt</a></li><li><a href="DetailedDeliveryReceipt.html">DetailedDeliveryReceipt</a></li><li><a href="User.html">User</a></li><li><a href="Paginator.html">Paginator</a></li><li><a href="PushNotification.html">PushNotification</a></li></ul></li><li class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" aria-expanded="false">Exceptions<b class="caret"></b></a><ul class="dropdown-menu"><li><a href="SessionError.html">SessionError</a></li></ul></li></ul>
-            <div class="col-sm-3 col-md-3">
-                <form class="navbar-form" role="search">
-                    <div class="input-group">
-                        <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
-                        <div class="input-group-btn">
-                            <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
-                        </div>
-                    </div>
-                </form>
-            </div>
-	</div>
-</div>
-</div>
-<div class="container" id="toc-content">
-<div class="row">
-	<div class="col-md-8">
-		<div id="main">
-	<h1 class="page-title">Class: User</h1>
-<section>
-<header>
-        <h2>
-        User
-        </h2>
-            <div class="class-description">Extended user information.
-Note that <code>isOnline</code> and <code>isNotifiable</code> properties are eligible
-to use only if reachability function is enabled.
-You may check if it is enabled by reading value of <a href="Client.html">Client</a>&apos;s <code>reachabilityEnabled</code> property.</div>
-</header>
-<article>
-    <div class="container-overview">
-<hr>
-<dt>
-</dt>
-<dd>
-<dl class="details">
-    <h5 class="subsection-title">Properties:</h5>
-    <dl>
-<table class="props table table-striped">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>identity</code></td>
-            <td class="type">
-<span class="param-type">String</span>
-            </td>
-            <td class="description last">User identity</td>
-        </tr>
-        <tr>
-                <td class="name"><code>friendlyName</code></td>
-            <td class="type">
-<span class="param-type">String</span>
-            </td>
-            <td class="description last">User friendly name, null if not set</td>
-        </tr>
-        <tr>
-                <td class="name"><code>attributes</code></td>
-            <td class="type">
-<span class="param-type">any</span>
-            </td>
-            <td class="description last">Object with custom attributes for user</td>
-        </tr>
-        <tr>
-                <td class="name"><code>isOnline</code></td>
-            <td class="type">
-<span class="param-type">Boolean</span>
-            </td>
-            <td class="description last">User real-time conversation connection status</td>
-        </tr>
-        <tr>
-                <td class="name"><code>isNotifiable</code></td>
-            <td class="type">
-<span class="param-type">Boolean</span>
-            </td>
-            <td class="description last">User push notification registration status</td>
-        </tr>
-        <tr>
-                <td class="name"><code>isSubscribed</code></td>
-            <td class="type">
-<span class="param-type">Boolean</span>
-            </td>
-            <td class="description last">Check if this user receives real-time status updates</td>
-        </tr>
-    </tbody>
-</table>
-</dl>
-</dl>
-    <h5>Fires:</h5>
-    <ul>
-        <li><a href="User.html#event:updated">User#event:updated</a></li>
-        <li><a href="User.html#event:userSubscribed">User#event:userSubscribed</a></li>
-        <li><a href="User.html#event:userUnsubscribed">User#event:userUnsubscribed</a></li>
-    </ul>
-</dd>
-    </div>
-        <h3 class="subsection-title">Methods</h3>
-        <dl>
-<hr>
-<dt>
-    <h4 class="name" id="unsubscribe"><span class="type-signature"></span>unsubscribe()</h4>
-</dt>
-<dd>
-    <div class="description">
-        Removes User from subscription list.
-    </div>
-<dl class="details">
-</dl>
-    <h5>Returns:</h5>
-<div class="param-desc">
-    Promise of completion
-</div>
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Promise.&lt;void&gt;</span>
-    </dd>
-</dl>
-</dd>
-<hr>
-<dt>
-    <h4 class="name" id="updateAttributes"><span class="type-signature"></span>updateAttributes(attributes)</h4>
-</dt>
-<dd>
-    <div class="description">
-        Updates user attributes.
-    </div>
-        <h5>Parameters:</h5>
-<table class="params table table-striped">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>attributes</code></td>
-            <td class="type">
-<span class="param-type">any</span>
-            </td>
-            <td class="description last">new attributes for User.</td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-</dl>
-    <h5>Returns:</h5>
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Promise.&lt;<a href="User.html">User</a>&gt;</span>
-    </dd>
-</dl>
-</dd>
-<hr>
-<dt>
-    <h4 class="name" id="updateFriendlyName"><span class="type-signature"></span>updateFriendlyName(friendlyName)</h4>
-</dt>
-<dd>
-    <div class="description">
-        Update Users friendlyName.
-    </div>
-        <h5>Parameters:</h5>
-<table class="params table table-striped">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>friendlyName</code></td>
-            <td class="type">
-<span class="param-type">String</span>
-|
-<span class="param-type">null</span>
-            </td>
-            <td class="description last">Updated friendlyName</td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-</dl>
-    <h5>Returns:</h5>
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Promise.&lt;<a href="User.html">User</a>&gt;</span>
-    </dd>
-</dl>
-</dd>
-        </dl>
-        <h3 class="subsection-title">Type Definitions</h3>
-        <dl>
-<hr>
-<dt class="name" id="UpdateReason">
-    <h4 id="UpdateReason">UpdateReason</h4>
-</dt>
-<dd>
-    <div class="description">
-        The update reason for <code>updated</code> event emitted on User
-    </div>
-        <h5>Type:</h5>
-        <ul>
-            <li>
-<span class="param-type">&apos;friendlyName&apos;</span>
-|
-<span class="param-type">&apos;attributes&apos;</span>
-|
-<span class="param-type">&apos;reachabilityOnline&apos;</span>
-|
-<span class="param-type">&apos;reachabilityNotifiable&apos;</span>
-            </li>
-        </ul>
-<dl class="details">
-</dl>
-</dd>
-            </dl>
-        <h3 class="subsection-title">Events</h3>
-        <dl>
-<hr>
-<dt>
-    <h4 class="name" id="event:updated">updated</h4>
-</dt>
-<dd>
-    <div class="description">
-        Fired when User&apos;s properties or reachability status have been updated.
-    </div>
-        <h5>Type:
-<span class="param-type">Object</span>
-</h5>
-<dl class="details">
-    <h5 class="subsection-title">Properties:</h5>
-    <dl>
-<table class="props table table-striped">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>user</code></td>
-            <td class="type">
-<span class="param-type"><a href="User.html">User</a></span>
-            </td>
-            <td class="description last">Updated User</td>
-        </tr>
-        <tr>
-                <td class="name"><code>updateReasons</code></td>
-            <td class="type">
-<span class="param-type">Array.&lt;<a href="User.html#UpdateReason">User#UpdateReason</a>&gt;</span>
-            </td>
-            <td class="description last">Array of User&apos;s updated event reasons</td>
-        </tr>
-    </tbody>
-</table>
-</dl>
-</dl>
-</dd>
-<hr>
-<dt>
-    <h4 class="name" id="event:userSubscribed">userSubscribed</h4>
-</dt>
-<dd>
-    <div class="description">
-        Fired when Client is subscribed to User.
-    </div>
-        <h5>Type:
-<span class="param-type"><a href="User.html">User</a></span>
-</h5>
-<dl class="details">
-</dl>
-</dd>
-<hr>
-<dt>
-    <h4 class="name" id="event:userUnsubscribed">userUnsubscribed</h4>
-</dt>
-<dd>
-    <div class="description">
-        Fired when Client is unsubscribed from this User.
-    </div>
-        <h5>Type:
-<span class="param-type"><a href="User.html">User</a></span>
-</h5>
-<dl class="details">
-</dl>
-</dd>
-        </dl>
-</article>
-</section>
-		</div>
-	</div>
-	<div class="clearfix"></div>
-		<div class="col-md-3">
-			<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
-		</div>
-</div>
-</div>
-    <div class="modal fade" id="searchResults">
-      <div class="modal-dialog">
-        <div class="modal-content">
-          <div class="modal-header">
-            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&#xD7;</span></button>
-            <h4 class="modal-title">Search results</h4>
-          </div>
-          <div class="modal-body"></div>
-          <div class="modal-footer">
-            <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
-          </div>
-        </div><!-- /.modal-content -->
-      </div><!-- /.modal-dialog -->
-    </div>
-<footer>
-<span class="jsdoc-message">
-	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
-		on 2021-06-30T16:21:28+00:00
-	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
-</span>
-</footer>
-<script src="scripts/docstrap.lib.js"></script>
-<script src="scripts/toc.js"></script>
-    <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
-<script>
-$( function () {
-	$( "[id*='$']" ).each( function () {
-		var $this = $( this );
-		$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
-	} );
-	$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
-		var $this = $( this );
-		var example = $this.find( "code" );
-		exampleText = example.html();
-		var lang = /{@lang (.*?)}/.exec( exampleText );
-		if ( lang && lang[1] ) {
-			exampleText = exampleText.replace( lang[0], "" );
-			example.html( exampleText );
-			lang = lang[1];
-		} else {
-			var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
-			lang = langClassMatch ? langClassMatch[1] : "javascript";
-		}
-		if ( lang ) {
-			$this
-			.addClass( "sunlight-highlight-" + lang )
-			.addClass( "linenums" )
-			.html( example.html() );
-		}
-	} );
-	Sunlight.highlightAll( {
-		lineNumbers : false,
-		showMenu : true,
-		enableDoclinks : true
-	} );
-	$.catchAnchorLinks( {
-        navbarOffset: 10
-	} );
-	$( "#toc" ).toc( {
-		anchorName  : function ( i, heading, prefix ) {
-			return $( heading ).attr( "id" ) || ( prefix + i );
-		},
-		selectors   : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
-		showAndHide : false,
-		smoothScrolling: true
-	} );
-	$( "#main span[id^='toc']" ).addClass( "toc-shim" );
-	$( '.dropdown-toggle' ).dropdown();
-    $( "table" ).each( function () {
-      var $this = $( this );
-      $this.addClass('table');
-    } );
-} );
-</script>
-<!--Navigation and Symbol Display-->
-<!--Google Analytics-->
-    <script type="text/javascript">
-        $(document).ready(function() {
-            SearcherDisplay.init();
-        });
-    </script>
-</body></html>