@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.
- 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
@@ -1,1510 +0,0 @@
|
|
1
|
-
<!DOCTYPE html><html lang="en"><head>
|
2
|
-
<meta charset="utf-8">
|
3
|
-
<meta name="viewport" content="width=device-width">
|
4
|
-
<title>Documentation Class: Participant</title>
|
5
|
-
|
6
|
-
<!--[if lt IE 9]>
|
7
|
-
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
8
|
-
<![endif]-->
|
9
|
-
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
|
10
|
-
|
11
|
-
<link type="text/css" rel="stylesheet" href="styles/site.simplex.css">
|
12
|
-
|
13
|
-
</head>
|
14
|
-
|
15
|
-
<body>
|
16
|
-
|
17
|
-
<div class="navbar navbar-default navbar-fixed-top ">
|
18
|
-
<div class="container">
|
19
|
-
<div class="navbar-header">
|
20
|
-
<a class="navbar-brand" href="index.html">Documentation</a>
|
21
|
-
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
|
22
|
-
<span class="icon-bar"></span>
|
23
|
-
<span class="icon-bar"></span>
|
24
|
-
<span class="icon-bar"></span>
|
25
|
-
</button>
|
26
|
-
</div>
|
27
|
-
<div class="navbar-collapse collapse" id="topNavigation">
|
28
|
-
<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>
|
29
|
-
|
30
|
-
<div class="col-sm-3 col-md-3">
|
31
|
-
<form class="navbar-form" role="search">
|
32
|
-
<div class="input-group">
|
33
|
-
<input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
|
34
|
-
<div class="input-group-btn">
|
35
|
-
<button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
|
36
|
-
</div>
|
37
|
-
</div>
|
38
|
-
</form>
|
39
|
-
</div>
|
40
|
-
|
41
|
-
</div>
|
42
|
-
|
43
|
-
</div>
|
44
|
-
</div>
|
45
|
-
|
46
|
-
|
47
|
-
<div class="container" id="toc-content">
|
48
|
-
<div class="row">
|
49
|
-
|
50
|
-
|
51
|
-
<div class="col-md-8">
|
52
|
-
|
53
|
-
<div id="main">
|
54
|
-
|
55
|
-
|
56
|
-
<h1 class="page-title">Class: Participant</h1>
|
57
|
-
<section>
|
58
|
-
|
59
|
-
<header>
|
60
|
-
|
61
|
-
<h2>
|
62
|
-
Participant
|
63
|
-
</h2>
|
64
|
-
|
65
|
-
<div class="class-description">A Participant represents a remote Client in a Conversation.</div>
|
66
|
-
|
67
|
-
|
68
|
-
</header>
|
69
|
-
|
70
|
-
|
71
|
-
<article>
|
72
|
-
<div class="container-overview">
|
73
|
-
|
74
|
-
|
75
|
-
<hr>
|
76
|
-
<dt>
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
</dt>
|
81
|
-
<dd>
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
<dl class="details">
|
94
|
-
|
95
|
-
|
96
|
-
<h5 class="subsection-title">Properties:</h5>
|
97
|
-
|
98
|
-
<dl>
|
99
|
-
|
100
|
-
<table class="props table table-striped">
|
101
|
-
<thead>
|
102
|
-
<tr>
|
103
|
-
|
104
|
-
<th>Name</th>
|
105
|
-
|
106
|
-
|
107
|
-
<th>Type</th>
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
<th class="last">Description</th>
|
114
|
-
</tr>
|
115
|
-
</thead>
|
116
|
-
|
117
|
-
<tbody>
|
118
|
-
|
119
|
-
|
120
|
-
<tr>
|
121
|
-
|
122
|
-
<td class="name"><code>attributes</code></td>
|
123
|
-
|
124
|
-
|
125
|
-
<td class="type">
|
126
|
-
|
127
|
-
|
128
|
-
<span class="param-type">any</span>
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
|
133
|
-
</td>
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
<td class="description last">Object with custom attributes for Participant</td>
|
140
|
-
</tr>
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
<tr>
|
145
|
-
|
146
|
-
<td class="name"><code>conversation</code></td>
|
147
|
-
|
148
|
-
|
149
|
-
<td class="type">
|
150
|
-
|
151
|
-
|
152
|
-
<span class="param-type"><a href="Conversation.html">Conversation</a></span>
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
</td>
|
158
|
-
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
<td class="description last">The Conversation the remote Client is a Participant of</td>
|
164
|
-
</tr>
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
<tr>
|
169
|
-
|
170
|
-
<td class="name"><code>dateCreated</code></td>
|
171
|
-
|
172
|
-
|
173
|
-
<td class="type">
|
174
|
-
|
175
|
-
|
176
|
-
<span class="param-type">Date</span>
|
177
|
-
|
178
|
-
|
179
|
-
|
180
|
-
|
181
|
-
</td>
|
182
|
-
|
183
|
-
|
184
|
-
|
185
|
-
|
186
|
-
|
187
|
-
<td class="description last">The Date this Participant was created</td>
|
188
|
-
</tr>
|
189
|
-
|
190
|
-
|
191
|
-
|
192
|
-
<tr>
|
193
|
-
|
194
|
-
<td class="name"><code>dateUpdated</code></td>
|
195
|
-
|
196
|
-
|
197
|
-
<td class="type">
|
198
|
-
|
199
|
-
|
200
|
-
<span class="param-type">Date</span>
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
|
205
|
-
</td>
|
206
|
-
|
207
|
-
|
208
|
-
|
209
|
-
|
210
|
-
|
211
|
-
<td class="description last">The Date this Participant was last updated</td>
|
212
|
-
</tr>
|
213
|
-
|
214
|
-
|
215
|
-
|
216
|
-
<tr>
|
217
|
-
|
218
|
-
<td class="name"><code>identity</code></td>
|
219
|
-
|
220
|
-
|
221
|
-
<td class="type">
|
222
|
-
|
223
|
-
|
224
|
-
<span class="param-type">String</span>
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
</td>
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
<td class="description last">The identity of the remote Client</td>
|
236
|
-
</tr>
|
237
|
-
|
238
|
-
|
239
|
-
|
240
|
-
<tr>
|
241
|
-
|
242
|
-
<td class="name"><code>isTyping</code></td>
|
243
|
-
|
244
|
-
|
245
|
-
<td class="type">
|
246
|
-
|
247
|
-
|
248
|
-
<span class="param-type">Boolean</span>
|
249
|
-
|
250
|
-
|
251
|
-
|
252
|
-
|
253
|
-
</td>
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
<td class="description last">Whether or not this Participant is currently typing</td>
|
260
|
-
</tr>
|
261
|
-
|
262
|
-
|
263
|
-
|
264
|
-
<tr>
|
265
|
-
|
266
|
-
<td class="name"><code>lastReadMessageIndex</code></td>
|
267
|
-
|
268
|
-
|
269
|
-
<td class="type">
|
270
|
-
|
271
|
-
|
272
|
-
<span class="param-type">Number</span>
|
273
|
-
|
|
274
|
-
|
275
|
-
<span class="param-type">null</span>
|
276
|
-
|
277
|
-
|
278
|
-
|
279
|
-
|
280
|
-
</td>
|
281
|
-
|
282
|
-
|
283
|
-
|
284
|
-
|
285
|
-
|
286
|
-
<td class="description last">Latest read Message index by this Participant.
|
287
|
-
Note that just retrieving messages on a client endpoint does not mean that messages are read,
|
288
|
-
please consider reading about <a href="https://www.twilio.com/docs/api/chat/guides/consumption-horizon">Read Horizon feature</a>
|
289
|
-
to find out how to mark messages as read.</td>
|
290
|
-
</tr>
|
291
|
-
|
292
|
-
|
293
|
-
|
294
|
-
<tr>
|
295
|
-
|
296
|
-
<td class="name"><code>lastReadTimestamp</code></td>
|
297
|
-
|
298
|
-
|
299
|
-
<td class="type">
|
300
|
-
|
301
|
-
|
302
|
-
<span class="param-type">Date</span>
|
303
|
-
|
304
|
-
|
305
|
-
|
306
|
-
|
307
|
-
</td>
|
308
|
-
|
309
|
-
|
310
|
-
|
311
|
-
|
312
|
-
|
313
|
-
<td class="description last">Date when Participant has updated his read horizon</td>
|
314
|
-
</tr>
|
315
|
-
|
316
|
-
|
317
|
-
|
318
|
-
<tr>
|
319
|
-
|
320
|
-
<td class="name"><code>sid</code></td>
|
321
|
-
|
322
|
-
|
323
|
-
<td class="type">
|
324
|
-
|
325
|
-
|
326
|
-
<span class="param-type">String</span>
|
327
|
-
|
328
|
-
|
329
|
-
|
330
|
-
|
331
|
-
</td>
|
332
|
-
|
333
|
-
|
334
|
-
|
335
|
-
|
336
|
-
|
337
|
-
<td class="description last">The server-assigned unique identifier for the Participant</td>
|
338
|
-
</tr>
|
339
|
-
|
340
|
-
|
341
|
-
|
342
|
-
<tr>
|
343
|
-
|
344
|
-
<td class="name"><code>type</code></td>
|
345
|
-
|
346
|
-
|
347
|
-
<td class="type">
|
348
|
-
|
349
|
-
|
350
|
-
<span class="param-type"><a href="Participant.html#Type">Participant#Type</a></span>
|
351
|
-
|
352
|
-
|
353
|
-
|
354
|
-
|
355
|
-
</td>
|
356
|
-
|
357
|
-
|
358
|
-
|
359
|
-
|
360
|
-
|
361
|
-
<td class="description last">The type of Participant</td>
|
362
|
-
</tr>
|
363
|
-
|
364
|
-
|
365
|
-
</tbody>
|
366
|
-
</table>
|
367
|
-
</dl>
|
368
|
-
|
369
|
-
|
370
|
-
|
371
|
-
|
372
|
-
|
373
|
-
|
374
|
-
|
375
|
-
|
376
|
-
|
377
|
-
|
378
|
-
|
379
|
-
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
|
395
|
-
|
396
|
-
|
397
|
-
|
398
|
-
|
399
|
-
|
400
|
-
|
401
|
-
|
402
|
-
|
403
|
-
|
404
|
-
</dl>
|
405
|
-
|
406
|
-
|
407
|
-
|
408
|
-
|
409
|
-
|
410
|
-
<h5>Fires:</h5>
|
411
|
-
<ul>
|
412
|
-
<li><a href="Participant.html#event:typingEnded">Participant#event:typingEnded</a></li>
|
413
|
-
|
414
|
-
<li><a href="Participant.html#event:typingStarted">Participant#event:typingStarted</a></li>
|
415
|
-
|
416
|
-
<li><a href="Participant.html#event:updated">Participant#event:updated</a></li>
|
417
|
-
</ul>
|
418
|
-
|
419
|
-
|
420
|
-
|
421
|
-
|
422
|
-
|
423
|
-
|
424
|
-
|
425
|
-
|
426
|
-
|
427
|
-
|
428
|
-
|
429
|
-
</dd>
|
430
|
-
|
431
|
-
|
432
|
-
</div>
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
440
|
-
|
441
|
-
|
442
|
-
|
443
|
-
|
444
|
-
|
445
|
-
<h3 class="subsection-title">Members</h3>
|
446
|
-
|
447
|
-
<dl>
|
448
|
-
|
449
|
-
<hr>
|
450
|
-
<dt class="name" id="bindings">
|
451
|
-
<h4 id="bindings"><span class="type-signature"></span>bindings<span class="type-signature"></span></h4>
|
452
|
-
|
453
|
-
|
454
|
-
</dt>
|
455
|
-
<dd>
|
456
|
-
|
457
|
-
<div class="description">
|
458
|
-
Get the bindings mapping for the current participant.
|
459
|
-
Available binding depends on the participant type.
|
460
|
-
You could access it as `participant.bindings.sms?.address` or
|
461
|
-
using the type dynamically `participant.bindings[participant.type]`
|
462
|
-
just be aware that the binding information has different structure for
|
463
|
-
each participant type.
|
464
|
-
See also {EmailBinding}, the only available binding descriptor available currently.
|
465
|
-
</div>
|
466
|
-
|
467
|
-
|
468
|
-
|
469
|
-
|
470
|
-
|
471
|
-
<dl class="details">
|
472
|
-
|
473
|
-
|
474
|
-
|
475
|
-
|
476
|
-
|
477
|
-
|
478
|
-
|
479
|
-
|
480
|
-
|
481
|
-
|
482
|
-
|
483
|
-
|
484
|
-
|
485
|
-
|
486
|
-
|
487
|
-
|
488
|
-
|
489
|
-
|
490
|
-
|
491
|
-
|
492
|
-
|
493
|
-
|
494
|
-
|
495
|
-
|
496
|
-
|
497
|
-
|
498
|
-
|
499
|
-
|
500
|
-
|
501
|
-
|
502
|
-
|
503
|
-
|
504
|
-
|
505
|
-
|
506
|
-
|
507
|
-
</dl>
|
508
|
-
|
509
|
-
|
510
|
-
|
511
|
-
</dd>
|
512
|
-
|
513
|
-
</dl>
|
514
|
-
|
515
|
-
|
516
|
-
|
517
|
-
<h3 class="subsection-title">Methods</h3>
|
518
|
-
|
519
|
-
<dl>
|
520
|
-
|
521
|
-
<hr>
|
522
|
-
<dt>
|
523
|
-
<h4 class="name" id="getUser"><span class="type-signature"></span>getUser()</h4>
|
524
|
-
|
525
|
-
|
526
|
-
</dt>
|
527
|
-
<dd>
|
528
|
-
|
529
|
-
|
530
|
-
<div class="description">
|
531
|
-
Gets User for this participant and subscribes to it. Supported only for <code>chat</code> type of Participants
|
532
|
-
</div>
|
533
|
-
|
534
|
-
|
535
|
-
|
536
|
-
|
537
|
-
|
538
|
-
|
539
|
-
|
540
|
-
|
541
|
-
|
542
|
-
|
543
|
-
<dl class="details">
|
544
|
-
|
545
|
-
|
546
|
-
|
547
|
-
|
548
|
-
|
549
|
-
|
550
|
-
|
551
|
-
|
552
|
-
|
553
|
-
|
554
|
-
|
555
|
-
|
556
|
-
|
557
|
-
|
558
|
-
|
559
|
-
|
560
|
-
|
561
|
-
|
562
|
-
|
563
|
-
|
564
|
-
|
565
|
-
|
566
|
-
|
567
|
-
|
568
|
-
|
569
|
-
|
570
|
-
|
571
|
-
|
572
|
-
|
573
|
-
|
574
|
-
|
575
|
-
|
576
|
-
|
577
|
-
|
578
|
-
|
579
|
-
</dl>
|
580
|
-
|
581
|
-
|
582
|
-
|
583
|
-
|
584
|
-
|
585
|
-
|
586
|
-
|
587
|
-
|
588
|
-
|
589
|
-
|
590
|
-
|
591
|
-
|
592
|
-
|
593
|
-
<h5>Returns:</h5>
|
594
|
-
|
595
|
-
|
596
|
-
|
597
|
-
|
598
|
-
<dl>
|
599
|
-
<dt>
|
600
|
-
Type
|
601
|
-
</dt>
|
602
|
-
<dd>
|
603
|
-
|
604
|
-
<span class="param-type">Promise.<<a href="User.html">User</a>></span>
|
605
|
-
|
606
|
-
|
607
|
-
|
608
|
-
</dd>
|
609
|
-
</dl>
|
610
|
-
|
611
|
-
|
612
|
-
|
613
|
-
|
614
|
-
|
615
|
-
</dd>
|
616
|
-
|
617
|
-
|
618
|
-
|
619
|
-
<hr>
|
620
|
-
<dt>
|
621
|
-
<h4 class="name" id="remove"><span class="type-signature"></span>remove()</h4>
|
622
|
-
|
623
|
-
|
624
|
-
</dt>
|
625
|
-
<dd>
|
626
|
-
|
627
|
-
|
628
|
-
<div class="description">
|
629
|
-
Remove Participant from the Conversation.
|
630
|
-
</div>
|
631
|
-
|
632
|
-
|
633
|
-
|
634
|
-
|
635
|
-
|
636
|
-
|
637
|
-
|
638
|
-
|
639
|
-
|
640
|
-
|
641
|
-
<dl class="details">
|
642
|
-
|
643
|
-
|
644
|
-
|
645
|
-
|
646
|
-
|
647
|
-
|
648
|
-
|
649
|
-
|
650
|
-
|
651
|
-
|
652
|
-
|
653
|
-
|
654
|
-
|
655
|
-
|
656
|
-
|
657
|
-
|
658
|
-
|
659
|
-
|
660
|
-
|
661
|
-
|
662
|
-
|
663
|
-
|
664
|
-
|
665
|
-
|
666
|
-
|
667
|
-
|
668
|
-
|
669
|
-
|
670
|
-
|
671
|
-
|
672
|
-
|
673
|
-
|
674
|
-
|
675
|
-
|
676
|
-
|
677
|
-
</dl>
|
678
|
-
|
679
|
-
|
680
|
-
|
681
|
-
|
682
|
-
|
683
|
-
|
684
|
-
|
685
|
-
|
686
|
-
|
687
|
-
|
688
|
-
|
689
|
-
|
690
|
-
|
691
|
-
<h5>Returns:</h5>
|
692
|
-
|
693
|
-
|
694
|
-
|
695
|
-
|
696
|
-
<dl>
|
697
|
-
<dt>
|
698
|
-
Type
|
699
|
-
</dt>
|
700
|
-
<dd>
|
701
|
-
|
702
|
-
<span class="param-type">Promise.<void></span>
|
703
|
-
|
704
|
-
|
705
|
-
|
706
|
-
</dd>
|
707
|
-
</dl>
|
708
|
-
|
709
|
-
|
710
|
-
|
711
|
-
|
712
|
-
|
713
|
-
</dd>
|
714
|
-
|
715
|
-
|
716
|
-
|
717
|
-
<hr>
|
718
|
-
<dt>
|
719
|
-
<h4 class="name" id="updateAttributes"><span class="type-signature"></span>updateAttributes(attributes)</h4>
|
720
|
-
|
721
|
-
|
722
|
-
</dt>
|
723
|
-
<dd>
|
724
|
-
|
725
|
-
|
726
|
-
<div class="description">
|
727
|
-
Edit participant attributes.
|
728
|
-
</div>
|
729
|
-
|
730
|
-
|
731
|
-
|
732
|
-
|
733
|
-
|
734
|
-
|
735
|
-
|
736
|
-
|
737
|
-
<h5>Parameters:</h5>
|
738
|
-
|
739
|
-
|
740
|
-
<table class="params table table-striped">
|
741
|
-
<thead>
|
742
|
-
<tr>
|
743
|
-
|
744
|
-
<th>Name</th>
|
745
|
-
|
746
|
-
|
747
|
-
<th>Type</th>
|
748
|
-
|
749
|
-
|
750
|
-
|
751
|
-
|
752
|
-
|
753
|
-
<th class="last">Description</th>
|
754
|
-
</tr>
|
755
|
-
</thead>
|
756
|
-
|
757
|
-
<tbody>
|
758
|
-
|
759
|
-
|
760
|
-
<tr>
|
761
|
-
|
762
|
-
<td class="name"><code>attributes</code></td>
|
763
|
-
|
764
|
-
|
765
|
-
<td class="type">
|
766
|
-
|
767
|
-
|
768
|
-
<span class="param-type">any</span>
|
769
|
-
|
770
|
-
|
771
|
-
|
772
|
-
|
773
|
-
</td>
|
774
|
-
|
775
|
-
|
776
|
-
|
777
|
-
|
778
|
-
|
779
|
-
<td class="description last">new attributes for Participant.</td>
|
780
|
-
</tr>
|
781
|
-
|
782
|
-
|
783
|
-
</tbody>
|
784
|
-
</table>
|
785
|
-
|
786
|
-
|
787
|
-
|
788
|
-
|
789
|
-
<dl class="details">
|
790
|
-
|
791
|
-
|
792
|
-
|
793
|
-
|
794
|
-
|
795
|
-
|
796
|
-
|
797
|
-
|
798
|
-
|
799
|
-
|
800
|
-
|
801
|
-
|
802
|
-
|
803
|
-
|
804
|
-
|
805
|
-
|
806
|
-
|
807
|
-
|
808
|
-
|
809
|
-
|
810
|
-
|
811
|
-
|
812
|
-
|
813
|
-
|
814
|
-
|
815
|
-
|
816
|
-
|
817
|
-
|
818
|
-
|
819
|
-
|
820
|
-
|
821
|
-
|
822
|
-
|
823
|
-
|
824
|
-
|
825
|
-
</dl>
|
826
|
-
|
827
|
-
|
828
|
-
|
829
|
-
|
830
|
-
|
831
|
-
|
832
|
-
|
833
|
-
|
834
|
-
|
835
|
-
|
836
|
-
|
837
|
-
|
838
|
-
|
839
|
-
<h5>Returns:</h5>
|
840
|
-
|
841
|
-
|
842
|
-
|
843
|
-
|
844
|
-
<dl>
|
845
|
-
<dt>
|
846
|
-
Type
|
847
|
-
</dt>
|
848
|
-
<dd>
|
849
|
-
|
850
|
-
<span class="param-type">Promise.<<a href="Participant.html">Participant</a>></span>
|
851
|
-
|
852
|
-
|
853
|
-
|
854
|
-
</dd>
|
855
|
-
</dl>
|
856
|
-
|
857
|
-
|
858
|
-
|
859
|
-
|
860
|
-
|
861
|
-
</dd>
|
862
|
-
|
863
|
-
</dl>
|
864
|
-
|
865
|
-
|
866
|
-
|
867
|
-
<h3 class="subsection-title">Type Definitions</h3>
|
868
|
-
|
869
|
-
<dl>
|
870
|
-
|
871
|
-
<hr>
|
872
|
-
<dt class="name" id="Type">
|
873
|
-
<h4 id="Type">Type</h4>
|
874
|
-
|
875
|
-
|
876
|
-
</dt>
|
877
|
-
<dd>
|
878
|
-
|
879
|
-
<div class="description">
|
880
|
-
The type of Participant
|
881
|
-
</div>
|
882
|
-
|
883
|
-
|
884
|
-
|
885
|
-
<h5>Type:</h5>
|
886
|
-
<ul>
|
887
|
-
<li>
|
888
|
-
|
889
|
-
<span class="param-type">'chat'</span>
|
890
|
-
|
|
891
|
-
|
892
|
-
<span class="param-type">'sms'</span>
|
893
|
-
|
|
894
|
-
|
895
|
-
<span class="param-type">'whatsapp'</span>
|
896
|
-
|
|
897
|
-
|
898
|
-
<span class="param-type">'email'</span>
|
899
|
-
|
900
|
-
|
901
|
-
|
902
|
-
</li>
|
903
|
-
</ul>
|
904
|
-
|
905
|
-
|
906
|
-
|
907
|
-
<dl class="details">
|
908
|
-
|
909
|
-
|
910
|
-
|
911
|
-
|
912
|
-
|
913
|
-
|
914
|
-
|
915
|
-
|
916
|
-
|
917
|
-
|
918
|
-
|
919
|
-
|
920
|
-
|
921
|
-
|
922
|
-
|
923
|
-
|
924
|
-
|
925
|
-
|
926
|
-
|
927
|
-
|
928
|
-
|
929
|
-
|
930
|
-
|
931
|
-
|
932
|
-
|
933
|
-
|
934
|
-
|
935
|
-
|
936
|
-
|
937
|
-
|
938
|
-
|
939
|
-
|
940
|
-
|
941
|
-
|
942
|
-
|
943
|
-
</dl>
|
944
|
-
|
945
|
-
|
946
|
-
|
947
|
-
</dd>
|
948
|
-
|
949
|
-
|
950
|
-
|
951
|
-
<hr>
|
952
|
-
<dt class="name" id="UpdateReason">
|
953
|
-
<h4 id="UpdateReason">UpdateReason</h4>
|
954
|
-
|
955
|
-
|
956
|
-
</dt>
|
957
|
-
<dd>
|
958
|
-
|
959
|
-
<div class="description">
|
960
|
-
The update reason for <code>updated</code> event emitted on Participant
|
961
|
-
</div>
|
962
|
-
|
963
|
-
|
964
|
-
|
965
|
-
<h5>Type:</h5>
|
966
|
-
<ul>
|
967
|
-
<li>
|
968
|
-
|
969
|
-
<span class="param-type">'attributes'</span>
|
970
|
-
|
|
971
|
-
|
972
|
-
<span class="param-type">'dateCreated'</span>
|
973
|
-
|
|
974
|
-
|
975
|
-
<span class="param-type">'dateUpdated'</span>
|
976
|
-
|
|
977
|
-
|
978
|
-
<span class="param-type">'roleSid'</span>
|
979
|
-
|
|
980
|
-
|
981
|
-
<span class="param-type">'lastReadMessageIndex'</span>
|
982
|
-
|
|
983
|
-
|
984
|
-
<span class="param-type">'lastReadTimestamp'</span>
|
985
|
-
|
|
986
|
-
|
987
|
-
<span class="param-type">'bindings'</span>
|
988
|
-
|
989
|
-
|
990
|
-
|
991
|
-
</li>
|
992
|
-
</ul>
|
993
|
-
|
994
|
-
|
995
|
-
|
996
|
-
<dl class="details">
|
997
|
-
|
998
|
-
|
999
|
-
|
1000
|
-
|
1001
|
-
|
1002
|
-
|
1003
|
-
|
1004
|
-
|
1005
|
-
|
1006
|
-
|
1007
|
-
|
1008
|
-
|
1009
|
-
|
1010
|
-
|
1011
|
-
|
1012
|
-
|
1013
|
-
|
1014
|
-
|
1015
|
-
|
1016
|
-
|
1017
|
-
|
1018
|
-
|
1019
|
-
|
1020
|
-
|
1021
|
-
|
1022
|
-
|
1023
|
-
|
1024
|
-
|
1025
|
-
|
1026
|
-
|
1027
|
-
|
1028
|
-
|
1029
|
-
|
1030
|
-
|
1031
|
-
|
1032
|
-
</dl>
|
1033
|
-
|
1034
|
-
|
1035
|
-
|
1036
|
-
</dd>
|
1037
|
-
|
1038
|
-
</dl>
|
1039
|
-
|
1040
|
-
|
1041
|
-
|
1042
|
-
<h3 class="subsection-title">Events</h3>
|
1043
|
-
|
1044
|
-
<dl>
|
1045
|
-
|
1046
|
-
<hr>
|
1047
|
-
<dt>
|
1048
|
-
<h4 class="name" id="event:typingEnded">typingEnded</h4>
|
1049
|
-
|
1050
|
-
|
1051
|
-
</dt>
|
1052
|
-
<dd>
|
1053
|
-
|
1054
|
-
|
1055
|
-
<div class="description">
|
1056
|
-
Fired when Participant ended to type.
|
1057
|
-
</div>
|
1058
|
-
|
1059
|
-
|
1060
|
-
|
1061
|
-
|
1062
|
-
|
1063
|
-
<h5>Type:
|
1064
|
-
<span class="param-type"><a href="Participant.html">Participant</a></span>
|
1065
|
-
|
1066
|
-
|
1067
|
-
</h5>
|
1068
|
-
|
1069
|
-
|
1070
|
-
|
1071
|
-
|
1072
|
-
|
1073
|
-
|
1074
|
-
<dl class="details">
|
1075
|
-
|
1076
|
-
|
1077
|
-
|
1078
|
-
|
1079
|
-
|
1080
|
-
|
1081
|
-
|
1082
|
-
|
1083
|
-
|
1084
|
-
|
1085
|
-
|
1086
|
-
|
1087
|
-
|
1088
|
-
|
1089
|
-
|
1090
|
-
|
1091
|
-
|
1092
|
-
|
1093
|
-
|
1094
|
-
|
1095
|
-
|
1096
|
-
|
1097
|
-
|
1098
|
-
|
1099
|
-
|
1100
|
-
|
1101
|
-
|
1102
|
-
|
1103
|
-
|
1104
|
-
|
1105
|
-
|
1106
|
-
|
1107
|
-
|
1108
|
-
|
1109
|
-
|
1110
|
-
</dl>
|
1111
|
-
|
1112
|
-
|
1113
|
-
|
1114
|
-
|
1115
|
-
|
1116
|
-
|
1117
|
-
|
1118
|
-
|
1119
|
-
|
1120
|
-
|
1121
|
-
|
1122
|
-
|
1123
|
-
|
1124
|
-
|
1125
|
-
|
1126
|
-
</dd>
|
1127
|
-
|
1128
|
-
|
1129
|
-
|
1130
|
-
<hr>
|
1131
|
-
<dt>
|
1132
|
-
<h4 class="name" id="event:typingStarted">typingStarted</h4>
|
1133
|
-
|
1134
|
-
|
1135
|
-
</dt>
|
1136
|
-
<dd>
|
1137
|
-
|
1138
|
-
|
1139
|
-
<div class="description">
|
1140
|
-
Fired when Participant started to type.
|
1141
|
-
</div>
|
1142
|
-
|
1143
|
-
|
1144
|
-
|
1145
|
-
|
1146
|
-
|
1147
|
-
<h5>Type:
|
1148
|
-
<span class="param-type"><a href="Participant.html">Participant</a></span>
|
1149
|
-
|
1150
|
-
|
1151
|
-
</h5>
|
1152
|
-
|
1153
|
-
|
1154
|
-
|
1155
|
-
|
1156
|
-
|
1157
|
-
|
1158
|
-
<dl class="details">
|
1159
|
-
|
1160
|
-
|
1161
|
-
|
1162
|
-
|
1163
|
-
|
1164
|
-
|
1165
|
-
|
1166
|
-
|
1167
|
-
|
1168
|
-
|
1169
|
-
|
1170
|
-
|
1171
|
-
|
1172
|
-
|
1173
|
-
|
1174
|
-
|
1175
|
-
|
1176
|
-
|
1177
|
-
|
1178
|
-
|
1179
|
-
|
1180
|
-
|
1181
|
-
|
1182
|
-
|
1183
|
-
|
1184
|
-
|
1185
|
-
|
1186
|
-
|
1187
|
-
|
1188
|
-
|
1189
|
-
|
1190
|
-
|
1191
|
-
|
1192
|
-
|
1193
|
-
|
1194
|
-
</dl>
|
1195
|
-
|
1196
|
-
|
1197
|
-
|
1198
|
-
|
1199
|
-
|
1200
|
-
|
1201
|
-
|
1202
|
-
|
1203
|
-
|
1204
|
-
|
1205
|
-
|
1206
|
-
|
1207
|
-
|
1208
|
-
|
1209
|
-
|
1210
|
-
</dd>
|
1211
|
-
|
1212
|
-
|
1213
|
-
|
1214
|
-
<hr>
|
1215
|
-
<dt>
|
1216
|
-
<h4 class="name" id="event:updated">updated</h4>
|
1217
|
-
|
1218
|
-
|
1219
|
-
</dt>
|
1220
|
-
<dd>
|
1221
|
-
|
1222
|
-
|
1223
|
-
<div class="description">
|
1224
|
-
Fired when Participant's fields has been updated.
|
1225
|
-
</div>
|
1226
|
-
|
1227
|
-
|
1228
|
-
|
1229
|
-
|
1230
|
-
|
1231
|
-
<h5>Type:
|
1232
|
-
<span class="param-type">Object</span>
|
1233
|
-
|
1234
|
-
|
1235
|
-
</h5>
|
1236
|
-
|
1237
|
-
|
1238
|
-
|
1239
|
-
|
1240
|
-
|
1241
|
-
|
1242
|
-
<dl class="details">
|
1243
|
-
|
1244
|
-
|
1245
|
-
<h5 class="subsection-title">Properties:</h5>
|
1246
|
-
|
1247
|
-
<dl>
|
1248
|
-
|
1249
|
-
<table class="props table table-striped">
|
1250
|
-
<thead>
|
1251
|
-
<tr>
|
1252
|
-
|
1253
|
-
<th>Name</th>
|
1254
|
-
|
1255
|
-
|
1256
|
-
<th>Type</th>
|
1257
|
-
|
1258
|
-
|
1259
|
-
|
1260
|
-
|
1261
|
-
|
1262
|
-
<th class="last">Description</th>
|
1263
|
-
</tr>
|
1264
|
-
</thead>
|
1265
|
-
|
1266
|
-
<tbody>
|
1267
|
-
|
1268
|
-
|
1269
|
-
<tr>
|
1270
|
-
|
1271
|
-
<td class="name"><code>participant</code></td>
|
1272
|
-
|
1273
|
-
|
1274
|
-
<td class="type">
|
1275
|
-
|
1276
|
-
|
1277
|
-
<span class="param-type"><a href="Participant.html">Participant</a></span>
|
1278
|
-
|
1279
|
-
|
1280
|
-
|
1281
|
-
|
1282
|
-
</td>
|
1283
|
-
|
1284
|
-
|
1285
|
-
|
1286
|
-
|
1287
|
-
|
1288
|
-
<td class="description last">Updated Participant</td>
|
1289
|
-
</tr>
|
1290
|
-
|
1291
|
-
|
1292
|
-
|
1293
|
-
<tr>
|
1294
|
-
|
1295
|
-
<td class="name"><code>updateReasons</code></td>
|
1296
|
-
|
1297
|
-
|
1298
|
-
<td class="type">
|
1299
|
-
|
1300
|
-
|
1301
|
-
<span class="param-type">Array.<<a href="Participant.html#UpdateReason">Participant#UpdateReason</a>></span>
|
1302
|
-
|
1303
|
-
|
1304
|
-
|
1305
|
-
|
1306
|
-
</td>
|
1307
|
-
|
1308
|
-
|
1309
|
-
|
1310
|
-
|
1311
|
-
|
1312
|
-
<td class="description last">Array of Participant's updated event reasons</td>
|
1313
|
-
</tr>
|
1314
|
-
|
1315
|
-
|
1316
|
-
</tbody>
|
1317
|
-
</table>
|
1318
|
-
</dl>
|
1319
|
-
|
1320
|
-
|
1321
|
-
|
1322
|
-
|
1323
|
-
|
1324
|
-
|
1325
|
-
|
1326
|
-
|
1327
|
-
|
1328
|
-
|
1329
|
-
|
1330
|
-
|
1331
|
-
|
1332
|
-
|
1333
|
-
|
1334
|
-
|
1335
|
-
|
1336
|
-
|
1337
|
-
|
1338
|
-
|
1339
|
-
|
1340
|
-
|
1341
|
-
|
1342
|
-
|
1343
|
-
|
1344
|
-
|
1345
|
-
|
1346
|
-
|
1347
|
-
|
1348
|
-
|
1349
|
-
|
1350
|
-
|
1351
|
-
|
1352
|
-
|
1353
|
-
|
1354
|
-
|
1355
|
-
</dl>
|
1356
|
-
|
1357
|
-
|
1358
|
-
|
1359
|
-
|
1360
|
-
|
1361
|
-
|
1362
|
-
|
1363
|
-
|
1364
|
-
|
1365
|
-
|
1366
|
-
|
1367
|
-
|
1368
|
-
|
1369
|
-
|
1370
|
-
|
1371
|
-
</dd>
|
1372
|
-
|
1373
|
-
</dl>
|
1374
|
-
|
1375
|
-
</article>
|
1376
|
-
|
1377
|
-
</section>
|
1378
|
-
|
1379
|
-
|
1380
|
-
|
1381
|
-
|
1382
|
-
</div>
|
1383
|
-
</div>
|
1384
|
-
|
1385
|
-
<div class="clearfix"></div>
|
1386
|
-
|
1387
|
-
|
1388
|
-
<div class="col-md-3">
|
1389
|
-
<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
|
1390
|
-
</div>
|
1391
|
-
|
1392
|
-
|
1393
|
-
</div>
|
1394
|
-
</div>
|
1395
|
-
|
1396
|
-
|
1397
|
-
<div class="modal fade" id="searchResults">
|
1398
|
-
<div class="modal-dialog">
|
1399
|
-
<div class="modal-content">
|
1400
|
-
<div class="modal-header">
|
1401
|
-
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
|
1402
|
-
<h4 class="modal-title">Search results</h4>
|
1403
|
-
</div>
|
1404
|
-
<div class="modal-body"></div>
|
1405
|
-
<div class="modal-footer">
|
1406
|
-
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
|
1407
|
-
</div>
|
1408
|
-
</div><!-- /.modal-content -->
|
1409
|
-
</div><!-- /.modal-dialog -->
|
1410
|
-
</div>
|
1411
|
-
|
1412
|
-
|
1413
|
-
<footer>
|
1414
|
-
|
1415
|
-
|
1416
|
-
<span class="jsdoc-message">
|
1417
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
|
1418
|
-
|
1419
|
-
on 2021-06-30T16:21:28+00:00
|
1420
|
-
|
1421
|
-
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
|
1422
|
-
</span>
|
1423
|
-
</footer>
|
1424
|
-
|
1425
|
-
<script src="scripts/docstrap.lib.js"></script>
|
1426
|
-
<script src="scripts/toc.js"></script>
|
1427
|
-
|
1428
|
-
<script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
|
1429
|
-
|
1430
|
-
|
1431
|
-
<script>
|
1432
|
-
$( function () {
|
1433
|
-
$( "[id*='$']" ).each( function () {
|
1434
|
-
var $this = $( this );
|
1435
|
-
|
1436
|
-
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
|
1437
|
-
} );
|
1438
|
-
|
1439
|
-
$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
|
1440
|
-
var $this = $( this );
|
1441
|
-
|
1442
|
-
var example = $this.find( "code" );
|
1443
|
-
exampleText = example.html();
|
1444
|
-
var lang = /{@lang (.*?)}/.exec( exampleText );
|
1445
|
-
if ( lang && lang[1] ) {
|
1446
|
-
exampleText = exampleText.replace( lang[0], "" );
|
1447
|
-
example.html( exampleText );
|
1448
|
-
lang = lang[1];
|
1449
|
-
} else {
|
1450
|
-
var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
|
1451
|
-
lang = langClassMatch ? langClassMatch[1] : "javascript";
|
1452
|
-
}
|
1453
|
-
|
1454
|
-
if ( lang ) {
|
1455
|
-
|
1456
|
-
$this
|
1457
|
-
.addClass( "sunlight-highlight-" + lang )
|
1458
|
-
.addClass( "linenums" )
|
1459
|
-
.html( example.html() );
|
1460
|
-
|
1461
|
-
}
|
1462
|
-
} );
|
1463
|
-
|
1464
|
-
Sunlight.highlightAll( {
|
1465
|
-
lineNumbers : false,
|
1466
|
-
showMenu : true,
|
1467
|
-
enableDoclinks : true
|
1468
|
-
} );
|
1469
|
-
|
1470
|
-
$.catchAnchorLinks( {
|
1471
|
-
navbarOffset: 10
|
1472
|
-
} );
|
1473
|
-
$( "#toc" ).toc( {
|
1474
|
-
anchorName : function ( i, heading, prefix ) {
|
1475
|
-
return $( heading ).attr( "id" ) || ( prefix + i );
|
1476
|
-
},
|
1477
|
-
selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
|
1478
|
-
showAndHide : false,
|
1479
|
-
smoothScrolling: true
|
1480
|
-
} );
|
1481
|
-
|
1482
|
-
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
|
1483
|
-
$( '.dropdown-toggle' ).dropdown();
|
1484
|
-
|
1485
|
-
$( "table" ).each( function () {
|
1486
|
-
var $this = $( this );
|
1487
|
-
$this.addClass('table');
|
1488
|
-
} );
|
1489
|
-
|
1490
|
-
} );
|
1491
|
-
</script>
|
1492
|
-
|
1493
|
-
|
1494
|
-
|
1495
|
-
<!--Navigation and Symbol Display-->
|
1496
|
-
|
1497
|
-
|
1498
|
-
<!--Google Analytics-->
|
1499
|
-
|
1500
|
-
|
1501
|
-
|
1502
|
-
<script type="text/javascript">
|
1503
|
-
$(document).ready(function() {
|
1504
|
-
SearcherDisplay.init();
|
1505
|
-
});
|
1506
|
-
</script>
|
1507
|
-
|
1508
|
-
|
1509
|
-
|
1510
|
-
</body></html>
|