@itentialopensource/adapter-slack 3.0.0 → 3.1.0
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/CALLS.md +828 -0
- package/CHANGELOG.md +8 -0
- package/CONTRIBUTING.md +1 -160
- package/ENHANCE.md +2 -2
- package/README.md +32 -23
- package/adapter.js +161 -333
- package/adapterBase.js +549 -879
- package/changelogs/changelog.md +134 -0
- package/metadata.json +60 -0
- package/package.json +24 -25
- package/pronghorn.json +980 -641
- package/propertiesSchema.json +431 -31
- package/refs?service=git-upload-pack +0 -0
- package/report/adapter-openapi.json +21800 -0
- package/report/adapter-openapi.yaml +17947 -0
- package/report/adapterInfo.json +8 -8
- package/report/updateReport1691506988051.json +120 -0
- package/report/updateReport1692201597680.json +120 -0
- package/report/updateReport1692203018066.json +120 -0
- package/report/updateReport1694455107043.json +120 -0
- package/report/updateReport1694466927115.json +120 -0
- package/report/updateReport1698422097350.json +120 -0
- package/sampleProperties.json +63 -2
- package/test/integration/adapterTestBasicGet.js +2 -4
- package/test/integration/adapterTestConnectivity.js +91 -42
- package/test/integration/adapterTestIntegration.js +130 -2
- package/test/unit/adapterBaseTestUnit.js +388 -313
- package/test/unit/adapterTestUnit.js +338 -112
- package/utils/adapterInfo.js +1 -1
- package/utils/addAuth.js +1 -1
- package/utils/artifactize.js +1 -1
- package/utils/checkMigrate.js +1 -1
- package/utils/entitiesToDB.js +2 -2
- package/utils/findPath.js +1 -1
- package/utils/methodDocumentor.js +273 -0
- package/utils/modify.js +13 -15
- package/utils/packModificationScript.js +1 -1
- package/utils/pre-commit.sh +2 -0
- package/utils/taskMover.js +309 -0
- package/utils/tbScript.js +89 -34
- package/utils/tbUtils.js +41 -21
- package/utils/testRunner.js +1 -1
- package/utils/troubleshootingAdapter.js +9 -6
- package/workflows/README.md +0 -3
- package/workflows/Slack Adapter Channel Workflow.json +0 -1
- package/workflows/Slack Adapter User Management Workflow.json +0 -1
package/CALLS.md
CHANGED
|
@@ -165,5 +165,833 @@ Specific adapter calls are built based on the API of the Adapter for Slack. The
|
|
|
165
165
|
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Path</span></th>
|
|
166
166
|
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
|
|
167
167
|
</tr>
|
|
168
|
+
<tr>
|
|
169
|
+
<td style="padding:15px">getApitest(foo, error, callback)</td>
|
|
170
|
+
<td style="padding:15px">Checks API calling code.</td>
|
|
171
|
+
<td style="padding:15px">{base_path}/{version}/api.test?{query}</td>
|
|
172
|
+
<td style="padding:15px">Yes</td>
|
|
173
|
+
</tr>
|
|
174
|
+
<tr>
|
|
175
|
+
<td style="padding:15px">getAppspermissionsinfo(token, callback)</td>
|
|
176
|
+
<td style="padding:15px">Returns list of permissions this app has on a team.</td>
|
|
177
|
+
<td style="padding:15px">{base_path}/{version}/apps.permissions.info?{query}</td>
|
|
178
|
+
<td style="padding:15px">Yes</td>
|
|
179
|
+
</tr>
|
|
180
|
+
<tr>
|
|
181
|
+
<td style="padding:15px">getAppspermissionsrequest(scopes, token, triggerId, callback)</td>
|
|
182
|
+
<td style="padding:15px">Allows an app to request additional scopes</td>
|
|
183
|
+
<td style="padding:15px">{base_path}/{version}/apps.permissions.request?{query}</td>
|
|
184
|
+
<td style="padding:15px">Yes</td>
|
|
185
|
+
</tr>
|
|
186
|
+
<tr>
|
|
187
|
+
<td style="padding:15px">getAppspermissionsresourceslist(cursor, token, limit, callback)</td>
|
|
188
|
+
<td style="padding:15px">Returns list of resource grants this app has on a team.</td>
|
|
189
|
+
<td style="padding:15px">{base_path}/{version}/apps.permissions.resources.list?{query}</td>
|
|
190
|
+
<td style="padding:15px">Yes</td>
|
|
191
|
+
</tr>
|
|
192
|
+
<tr>
|
|
193
|
+
<td style="padding:15px">getAppspermissionsscopeslist(token, callback)</td>
|
|
194
|
+
<td style="padding:15px">Returns list of scopes this app has on a team.</td>
|
|
195
|
+
<td style="padding:15px">{base_path}/{version}/apps.permissions.scopes.list?{query}</td>
|
|
196
|
+
<td style="padding:15px">Yes</td>
|
|
197
|
+
</tr>
|
|
198
|
+
<tr>
|
|
199
|
+
<td style="padding:15px">getAuthrevoke(test, token, callback)</td>
|
|
200
|
+
<td style="padding:15px">Revokes a token.</td>
|
|
201
|
+
<td style="padding:15px">{base_path}/{version}/auth.revoke?{query}</td>
|
|
202
|
+
<td style="padding:15px">Yes</td>
|
|
203
|
+
</tr>
|
|
204
|
+
<tr>
|
|
205
|
+
<td style="padding:15px">getAuthtest(token, callback)</td>
|
|
206
|
+
<td style="padding:15px">Checks authentication & identity.</td>
|
|
207
|
+
<td style="padding:15px">{base_path}/{version}/auth.test?{query}</td>
|
|
208
|
+
<td style="padding:15px">Yes</td>
|
|
209
|
+
</tr>
|
|
210
|
+
<tr>
|
|
211
|
+
<td style="padding:15px">getBotsinfo(token, bot, callback)</td>
|
|
212
|
+
<td style="padding:15px">Gets information about a bot user.</td>
|
|
213
|
+
<td style="padding:15px">{base_path}/{version}/bots.info?{query}</td>
|
|
214
|
+
<td style="padding:15px">Yes</td>
|
|
215
|
+
</tr>
|
|
216
|
+
<tr>
|
|
217
|
+
<td style="padding:15px">postChannelsarchive(token, channel, callback)</td>
|
|
218
|
+
<td style="padding:15px">Archives a channel.</td>
|
|
219
|
+
<td style="padding:15px">{base_path}/{version}/channels.archive?{query}</td>
|
|
220
|
+
<td style="padding:15px">Yes</td>
|
|
221
|
+
</tr>
|
|
222
|
+
<tr>
|
|
223
|
+
<td style="padding:15px">postChannelscreate(validate, token, name, callback)</td>
|
|
224
|
+
<td style="padding:15px">Creates a channel.</td>
|
|
225
|
+
<td style="padding:15px">{base_path}/{version}/channels.create?{query}</td>
|
|
226
|
+
<td style="padding:15px">Yes</td>
|
|
227
|
+
</tr>
|
|
228
|
+
<tr>
|
|
229
|
+
<td style="padding:15px">getChannelshistory(count, unreads, inclusive, token, oldest, channel, latest, callback)</td>
|
|
230
|
+
<td style="padding:15px">Fetches history of messages and events from a channel.</td>
|
|
231
|
+
<td style="padding:15px">{base_path}/{version}/channels.history?{query}</td>
|
|
232
|
+
<td style="padding:15px">Yes</td>
|
|
233
|
+
</tr>
|
|
234
|
+
<tr>
|
|
235
|
+
<td style="padding:15px">getChannelsinfo(token, includeLocale, channel, callback)</td>
|
|
236
|
+
<td style="padding:15px">Gets information about a channel.</td>
|
|
237
|
+
<td style="padding:15px">{base_path}/{version}/channels.info?{query}</td>
|
|
238
|
+
<td style="padding:15px">Yes</td>
|
|
239
|
+
</tr>
|
|
240
|
+
<tr>
|
|
241
|
+
<td style="padding:15px">postChannelsinvite(token, user, channel, callback)</td>
|
|
242
|
+
<td style="padding:15px">Invites a user to a channel.</td>
|
|
243
|
+
<td style="padding:15px">{base_path}/{version}/channels.invite?{query}</td>
|
|
244
|
+
<td style="padding:15px">Yes</td>
|
|
245
|
+
</tr>
|
|
246
|
+
<tr>
|
|
247
|
+
<td style="padding:15px">postChannelsjoin(validate, token, name, callback)</td>
|
|
248
|
+
<td style="padding:15px">Joins a channel, creating it if needed.</td>
|
|
249
|
+
<td style="padding:15px">{base_path}/{version}/channels.join?{query}</td>
|
|
250
|
+
<td style="padding:15px">Yes</td>
|
|
251
|
+
</tr>
|
|
252
|
+
<tr>
|
|
253
|
+
<td style="padding:15px">postChannelskick(token, user, channel, callback)</td>
|
|
254
|
+
<td style="padding:15px">Removes a user from a channel.</td>
|
|
255
|
+
<td style="padding:15px">{base_path}/{version}/channels.kick?{query}</td>
|
|
256
|
+
<td style="padding:15px">Yes</td>
|
|
257
|
+
</tr>
|
|
258
|
+
<tr>
|
|
259
|
+
<td style="padding:15px">postChannelsleave(token, channel, callback)</td>
|
|
260
|
+
<td style="padding:15px">Leaves a channel.</td>
|
|
261
|
+
<td style="padding:15px">{base_path}/{version}/channels.leave?{query}</td>
|
|
262
|
+
<td style="padding:15px">Yes</td>
|
|
263
|
+
</tr>
|
|
264
|
+
<tr>
|
|
265
|
+
<td style="padding:15px">getChannelslist(excludeMembers, cursor, token, limit, excludeArchived, callback)</td>
|
|
266
|
+
<td style="padding:15px">Lists all channels in a Slack team.</td>
|
|
267
|
+
<td style="padding:15px">{base_path}/{version}/channels.list?{query}</td>
|
|
268
|
+
<td style="padding:15px">Yes</td>
|
|
269
|
+
</tr>
|
|
270
|
+
<tr>
|
|
271
|
+
<td style="padding:15px">postChannelsmark(token, ts, channel, callback)</td>
|
|
272
|
+
<td style="padding:15px">Sets the read cursor in a channel.</td>
|
|
273
|
+
<td style="padding:15px">{base_path}/{version}/channels.mark?{query}</td>
|
|
274
|
+
<td style="padding:15px">Yes</td>
|
|
275
|
+
</tr>
|
|
276
|
+
<tr>
|
|
277
|
+
<td style="padding:15px">postChannelsrename(validate, token, name, channel, callback)</td>
|
|
278
|
+
<td style="padding:15px">Renames a channel.</td>
|
|
279
|
+
<td style="padding:15px">{base_path}/{version}/channels.rename?{query}</td>
|
|
280
|
+
<td style="padding:15px">Yes</td>
|
|
281
|
+
</tr>
|
|
282
|
+
<tr>
|
|
283
|
+
<td style="padding:15px">getChannelsreplies(threadTs, token, channel, callback)</td>
|
|
284
|
+
<td style="padding:15px">Retrieve a thread of messages posted to a channel</td>
|
|
285
|
+
<td style="padding:15px">{base_path}/{version}/channels.replies?{query}</td>
|
|
286
|
+
<td style="padding:15px">Yes</td>
|
|
287
|
+
</tr>
|
|
288
|
+
<tr>
|
|
289
|
+
<td style="padding:15px">postChannelssetPurpose(token, purpose, channel, callback)</td>
|
|
290
|
+
<td style="padding:15px">Sets the purpose for a channel.</td>
|
|
291
|
+
<td style="padding:15px">{base_path}/{version}/channels.setPurpose?{query}</td>
|
|
292
|
+
<td style="padding:15px">Yes</td>
|
|
293
|
+
</tr>
|
|
294
|
+
<tr>
|
|
295
|
+
<td style="padding:15px">postChannelssetTopic(topic, token, channel, callback)</td>
|
|
296
|
+
<td style="padding:15px">Sets the topic for a channel.</td>
|
|
297
|
+
<td style="padding:15px">{base_path}/{version}/channels.setTopic?{query}</td>
|
|
298
|
+
<td style="padding:15px">Yes</td>
|
|
299
|
+
</tr>
|
|
300
|
+
<tr>
|
|
301
|
+
<td style="padding:15px">postChannelsunarchive(token, channel, callback)</td>
|
|
302
|
+
<td style="padding:15px">Unarchives a channel.</td>
|
|
303
|
+
<td style="padding:15px">{base_path}/{version}/channels.unarchive?{query}</td>
|
|
304
|
+
<td style="padding:15px">Yes</td>
|
|
305
|
+
</tr>
|
|
306
|
+
<tr>
|
|
307
|
+
<td style="padding:15px">postChatdelete(asUser, token, ts, channel, callback)</td>
|
|
308
|
+
<td style="padding:15px">Deletes a message.</td>
|
|
309
|
+
<td style="padding:15px">{base_path}/{version}/chat.delete?{query}</td>
|
|
310
|
+
<td style="padding:15px">Yes</td>
|
|
311
|
+
</tr>
|
|
312
|
+
<tr>
|
|
313
|
+
<td style="padding:15px">getChatgetPermalink(token, messageTs, channel, callback)</td>
|
|
314
|
+
<td style="padding:15px">Retrieve a permalink URL for a specific extant message</td>
|
|
315
|
+
<td style="padding:15px">{base_path}/{version}/chat.getPermalink?{query}</td>
|
|
316
|
+
<td style="padding:15px">Yes</td>
|
|
317
|
+
</tr>
|
|
318
|
+
<tr>
|
|
319
|
+
<td style="padding:15px">postChatmeMessage(text, token, channel, callback)</td>
|
|
320
|
+
<td style="padding:15px">Share a me message into a channel.</td>
|
|
321
|
+
<td style="padding:15px">{base_path}/{version}/chat.meMessage?{query}</td>
|
|
322
|
+
<td style="padding:15px">Yes</td>
|
|
323
|
+
</tr>
|
|
324
|
+
<tr>
|
|
325
|
+
<td style="padding:15px">postChatpostEphemeral(attachments, text, linkNames, parse, token, user, asUser, channel, callback)</td>
|
|
326
|
+
<td style="padding:15px">Sends an ephemeral message to a user in a channel.</td>
|
|
327
|
+
<td style="padding:15px">{base_path}/{version}/chat.postEphemeral?{query}</td>
|
|
328
|
+
<td style="padding:15px">Yes</td>
|
|
329
|
+
</tr>
|
|
330
|
+
<tr>
|
|
331
|
+
<td style="padding:15px">postChatpostMessage(username, threadTs, attachments, unfurlLinks, text, unfurlMedia, parse, asUser, token, mrkdwn, iconEmoji, linkNames, iconUrl, channel, replyBroadcast, callback)</td>
|
|
332
|
+
<td style="padding:15px">Sends a message to a channel.</td>
|
|
333
|
+
<td style="padding:15px">{base_path}/{version}/chat.postMessage?{query}</td>
|
|
334
|
+
<td style="padding:15px">Yes</td>
|
|
335
|
+
</tr>
|
|
336
|
+
<tr>
|
|
337
|
+
<td style="padding:15px">postChatunfurl(userAuthMessage, userAuthRequired, unfurls, ts, userAuthUrl, token, channel, callback)</td>
|
|
338
|
+
<td style="padding:15px">Provide custom unfurl behavior for user-posted URLs</td>
|
|
339
|
+
<td style="padding:15px">{base_path}/{version}/chat.unfurl?{query}</td>
|
|
340
|
+
<td style="padding:15px">Yes</td>
|
|
341
|
+
</tr>
|
|
342
|
+
<tr>
|
|
343
|
+
<td style="padding:15px">postChatupdate(attachments, text, ts, parse, asUser, token, linkNames, channel, callback)</td>
|
|
344
|
+
<td style="padding:15px">Updates a message.</td>
|
|
345
|
+
<td style="padding:15px">{base_path}/{version}/chat.update?{query}</td>
|
|
346
|
+
<td style="padding:15px">Yes</td>
|
|
347
|
+
</tr>
|
|
348
|
+
<tr>
|
|
349
|
+
<td style="padding:15px">postConversationsarchive(token, channel, callback)</td>
|
|
350
|
+
<td style="padding:15px">Archives a conversation.</td>
|
|
351
|
+
<td style="padding:15px">{base_path}/{version}/conversations.archive?{query}</td>
|
|
352
|
+
<td style="padding:15px">Yes</td>
|
|
353
|
+
</tr>
|
|
354
|
+
<tr>
|
|
355
|
+
<td style="padding:15px">postConversationsclose(token, channel, callback)</td>
|
|
356
|
+
<td style="padding:15px">Closes a direct message or multi-person direct message.</td>
|
|
357
|
+
<td style="padding:15px">{base_path}/{version}/conversations.close?{query}</td>
|
|
358
|
+
<td style="padding:15px">Yes</td>
|
|
359
|
+
</tr>
|
|
360
|
+
<tr>
|
|
361
|
+
<td style="padding:15px">postConversationscreate(token, name, isPrivate, callback)</td>
|
|
362
|
+
<td style="padding:15px">Initiates a public or private channel-based conversation</td>
|
|
363
|
+
<td style="padding:15px">{base_path}/{version}/conversations.create?{query}</td>
|
|
364
|
+
<td style="padding:15px">Yes</td>
|
|
365
|
+
</tr>
|
|
366
|
+
<tr>
|
|
367
|
+
<td style="padding:15px">getConversationshistory(inclusive, cursor, token, limit, oldest, channel, latest, callback)</td>
|
|
368
|
+
<td style="padding:15px">Fetches a conversation's history of messages and events.</td>
|
|
369
|
+
<td style="padding:15px">{base_path}/{version}/conversations.history?{query}</td>
|
|
370
|
+
<td style="padding:15px">Yes</td>
|
|
371
|
+
</tr>
|
|
372
|
+
<tr>
|
|
373
|
+
<td style="padding:15px">getConversationsinfo(token, channel, includeLocale, callback)</td>
|
|
374
|
+
<td style="padding:15px">Retrieve information about a conversation.</td>
|
|
375
|
+
<td style="padding:15px">{base_path}/{version}/conversations.info?{query}</td>
|
|
376
|
+
<td style="padding:15px">Yes</td>
|
|
377
|
+
</tr>
|
|
378
|
+
<tr>
|
|
379
|
+
<td style="padding:15px">postConversationsinvite(token, users, channel, callback)</td>
|
|
380
|
+
<td style="padding:15px">Invites users to a channel.</td>
|
|
381
|
+
<td style="padding:15px">{base_path}/{version}/conversations.invite?{query}</td>
|
|
382
|
+
<td style="padding:15px">Yes</td>
|
|
383
|
+
</tr>
|
|
384
|
+
<tr>
|
|
385
|
+
<td style="padding:15px">postConversationsjoin(token, channel, callback)</td>
|
|
386
|
+
<td style="padding:15px">Joins an existing conversation.</td>
|
|
387
|
+
<td style="padding:15px">{base_path}/{version}/conversations.join?{query}</td>
|
|
388
|
+
<td style="padding:15px">Yes</td>
|
|
389
|
+
</tr>
|
|
390
|
+
<tr>
|
|
391
|
+
<td style="padding:15px">postConversationskick(token, user, channel, callback)</td>
|
|
392
|
+
<td style="padding:15px">Removes a user from a conversation.</td>
|
|
393
|
+
<td style="padding:15px">{base_path}/{version}/conversations.kick?{query}</td>
|
|
394
|
+
<td style="padding:15px">Yes</td>
|
|
395
|
+
</tr>
|
|
396
|
+
<tr>
|
|
397
|
+
<td style="padding:15px">postConversationsleave(token, channel, callback)</td>
|
|
398
|
+
<td style="padding:15px">Leaves a conversation.</td>
|
|
399
|
+
<td style="padding:15px">{base_path}/{version}/conversations.leave?{query}</td>
|
|
400
|
+
<td style="padding:15px">Yes</td>
|
|
401
|
+
</tr>
|
|
402
|
+
<tr>
|
|
403
|
+
<td style="padding:15px">getConversationslist(cursor, token, limit, excludeArchived, types, callback)</td>
|
|
404
|
+
<td style="padding:15px">Lists all channels in a Slack team.</td>
|
|
405
|
+
<td style="padding:15px">{base_path}/{version}/conversations.list?{query}</td>
|
|
406
|
+
<td style="padding:15px">Yes</td>
|
|
407
|
+
</tr>
|
|
408
|
+
<tr>
|
|
409
|
+
<td style="padding:15px">getConversationsmembers(cursor, token, limit, channel, callback)</td>
|
|
410
|
+
<td style="padding:15px">Retrieve members of a conversation.</td>
|
|
411
|
+
<td style="padding:15px">{base_path}/{version}/conversations.members?{query}</td>
|
|
412
|
+
<td style="padding:15px">Yes</td>
|
|
413
|
+
</tr>
|
|
414
|
+
<tr>
|
|
415
|
+
<td style="padding:15px">postConversationsopen(token, returnIm, users, channel, callback)</td>
|
|
416
|
+
<td style="padding:15px">Opens or resumes a direct message or multi-person direct message.</td>
|
|
417
|
+
<td style="padding:15px">{base_path}/{version}/conversations.open?{query}</td>
|
|
418
|
+
<td style="padding:15px">Yes</td>
|
|
419
|
+
</tr>
|
|
420
|
+
<tr>
|
|
421
|
+
<td style="padding:15px">postConversationsrename(token, name, channel, callback)</td>
|
|
422
|
+
<td style="padding:15px">Renames a conversation.</td>
|
|
423
|
+
<td style="padding:15px">{base_path}/{version}/conversations.rename?{query}</td>
|
|
424
|
+
<td style="padding:15px">Yes</td>
|
|
425
|
+
</tr>
|
|
426
|
+
<tr>
|
|
427
|
+
<td style="padding:15px">getConversationsreplies(inclusive, ts, cursor, token, limit, oldest, channel, latest, callback)</td>
|
|
428
|
+
<td style="padding:15px">Retrieve a thread of messages posted to a conversation</td>
|
|
429
|
+
<td style="padding:15px">{base_path}/{version}/conversations.replies?{query}</td>
|
|
430
|
+
<td style="padding:15px">Yes</td>
|
|
431
|
+
</tr>
|
|
432
|
+
<tr>
|
|
433
|
+
<td style="padding:15px">postConversationssetPurpose(token, purpose, channel, callback)</td>
|
|
434
|
+
<td style="padding:15px">Sets the purpose for a conversation.</td>
|
|
435
|
+
<td style="padding:15px">{base_path}/{version}/conversations.setPurpose?{query}</td>
|
|
436
|
+
<td style="padding:15px">Yes</td>
|
|
437
|
+
</tr>
|
|
438
|
+
<tr>
|
|
439
|
+
<td style="padding:15px">postConversationssetTopic(topic, token, channel, callback)</td>
|
|
440
|
+
<td style="padding:15px">Sets the topic for a conversation.</td>
|
|
441
|
+
<td style="padding:15px">{base_path}/{version}/conversations.setTopic?{query}</td>
|
|
442
|
+
<td style="padding:15px">Yes</td>
|
|
443
|
+
</tr>
|
|
444
|
+
<tr>
|
|
445
|
+
<td style="padding:15px">postConversationsunarchive(token, channel, callback)</td>
|
|
446
|
+
<td style="padding:15px">Reverses conversation archival.</td>
|
|
447
|
+
<td style="padding:15px">{base_path}/{version}/conversations.unarchive?{query}</td>
|
|
448
|
+
<td style="padding:15px">Yes</td>
|
|
449
|
+
</tr>
|
|
450
|
+
<tr>
|
|
451
|
+
<td style="padding:15px">getDialogopen(token, dialog, triggerId, callback)</td>
|
|
452
|
+
<td style="padding:15px">Open a dialog with a user</td>
|
|
453
|
+
<td style="padding:15px">{base_path}/{version}/dialog.open?{query}</td>
|
|
454
|
+
<td style="padding:15px">Yes</td>
|
|
455
|
+
</tr>
|
|
456
|
+
<tr>
|
|
457
|
+
<td style="padding:15px">postDndendDnd(token, callback)</td>
|
|
458
|
+
<td style="padding:15px">Ends the current user's Do Not Disturb session immediately.</td>
|
|
459
|
+
<td style="padding:15px">{base_path}/{version}/dnd.endDnd?{query}</td>
|
|
460
|
+
<td style="padding:15px">Yes</td>
|
|
461
|
+
</tr>
|
|
462
|
+
<tr>
|
|
463
|
+
<td style="padding:15px">postDndendSnooze(token, callback)</td>
|
|
464
|
+
<td style="padding:15px">Ends the current user's snooze mode immediately.</td>
|
|
465
|
+
<td style="padding:15px">{base_path}/{version}/dnd.endSnooze?{query}</td>
|
|
466
|
+
<td style="padding:15px">Yes</td>
|
|
467
|
+
</tr>
|
|
468
|
+
<tr>
|
|
469
|
+
<td style="padding:15px">getDndinfo(token, user, callback)</td>
|
|
470
|
+
<td style="padding:15px">Retrieves a user's current Do Not Disturb status.</td>
|
|
471
|
+
<td style="padding:15px">{base_path}/{version}/dnd.info?{query}</td>
|
|
472
|
+
<td style="padding:15px">Yes</td>
|
|
473
|
+
</tr>
|
|
474
|
+
<tr>
|
|
475
|
+
<td style="padding:15px">postDndsetSnooze(numMinutes, token, callback)</td>
|
|
476
|
+
<td style="padding:15px">Turns on Do Not Disturb mode for the current user, or changes its duration.</td>
|
|
477
|
+
<td style="padding:15px">{base_path}/{version}/dnd.setSnooze?{query}</td>
|
|
478
|
+
<td style="padding:15px">Yes</td>
|
|
479
|
+
</tr>
|
|
480
|
+
<tr>
|
|
481
|
+
<td style="padding:15px">getDndteamInfo(token, users, callback)</td>
|
|
482
|
+
<td style="padding:15px">Retrieves the Do Not Disturb status for users on a team.</td>
|
|
483
|
+
<td style="padding:15px">{base_path}/{version}/dnd.teamInfo?{query}</td>
|
|
484
|
+
<td style="padding:15px">Yes</td>
|
|
485
|
+
</tr>
|
|
486
|
+
<tr>
|
|
487
|
+
<td style="padding:15px">getEmojilist(token, callback)</td>
|
|
488
|
+
<td style="padding:15px">Lists custom emoji for a team.</td>
|
|
489
|
+
<td style="padding:15px">{base_path}/{version}/emoji.list?{query}</td>
|
|
490
|
+
<td style="padding:15px">Yes</td>
|
|
491
|
+
</tr>
|
|
492
|
+
<tr>
|
|
493
|
+
<td style="padding:15px">postFilescommentsadd(comment, token, file, callback)</td>
|
|
494
|
+
<td style="padding:15px">Add a comment to an existing file.</td>
|
|
495
|
+
<td style="padding:15px">{base_path}/{version}/files.comments.add?{query}</td>
|
|
496
|
+
<td style="padding:15px">Yes</td>
|
|
497
|
+
</tr>
|
|
498
|
+
<tr>
|
|
499
|
+
<td style="padding:15px">postFilescommentsdelete(token, id, file, callback)</td>
|
|
500
|
+
<td style="padding:15px">Deletes an existing comment on a file.</td>
|
|
501
|
+
<td style="padding:15px">{base_path}/{version}/files.comments.delete?{query}</td>
|
|
502
|
+
<td style="padding:15px">Yes</td>
|
|
503
|
+
</tr>
|
|
504
|
+
<tr>
|
|
505
|
+
<td style="padding:15px">postFilescommentsedit(comment, token, id, file, callback)</td>
|
|
506
|
+
<td style="padding:15px">Edit an existing file comment.</td>
|
|
507
|
+
<td style="padding:15px">{base_path}/{version}/files.comments.edit?{query}</td>
|
|
508
|
+
<td style="padding:15px">Yes</td>
|
|
509
|
+
</tr>
|
|
510
|
+
<tr>
|
|
511
|
+
<td style="padding:15px">postFilesdelete(token, file, callback)</td>
|
|
512
|
+
<td style="padding:15px">Deletes a file.</td>
|
|
513
|
+
<td style="padding:15px">{base_path}/{version}/files.delete?{query}</td>
|
|
514
|
+
<td style="padding:15px">Yes</td>
|
|
515
|
+
</tr>
|
|
516
|
+
<tr>
|
|
517
|
+
<td style="padding:15px">getFilesinfo(count, token, file, page, callback)</td>
|
|
518
|
+
<td style="padding:15px">Gets information about a team file.</td>
|
|
519
|
+
<td style="padding:15px">{base_path}/{version}/files.info?{query}</td>
|
|
520
|
+
<td style="padding:15px">Yes</td>
|
|
521
|
+
</tr>
|
|
522
|
+
<tr>
|
|
523
|
+
<td style="padding:15px">getFileslist(count, channel, tsTo, tsFrom, token, user, page, types, callback)</td>
|
|
524
|
+
<td style="padding:15px">Lists & filters team files.</td>
|
|
525
|
+
<td style="padding:15px">{base_path}/{version}/files.list?{query}</td>
|
|
526
|
+
<td style="padding:15px">Yes</td>
|
|
527
|
+
</tr>
|
|
528
|
+
<tr>
|
|
529
|
+
<td style="padding:15px">postFilesrevokePublicURL(token, file, callback)</td>
|
|
530
|
+
<td style="padding:15px">Revokes public/external sharing access for a file</td>
|
|
531
|
+
<td style="padding:15px">{base_path}/{version}/files.revokePublicURL?{query}</td>
|
|
532
|
+
<td style="padding:15px">Yes</td>
|
|
533
|
+
</tr>
|
|
534
|
+
<tr>
|
|
535
|
+
<td style="padding:15px">postFilessharedPublicURL(token, file, callback)</td>
|
|
536
|
+
<td style="padding:15px">Enables a file for public/external sharing.</td>
|
|
537
|
+
<td style="padding:15px">{base_path}/{version}/files.sharedPublicURL?{query}</td>
|
|
538
|
+
<td style="padding:15px">Yes</td>
|
|
539
|
+
</tr>
|
|
540
|
+
<tr>
|
|
541
|
+
<td style="padding:15px">postFilesupload(channels, title, initialComment, filetype, filename, content, token, file, threadTs, callback)</td>
|
|
542
|
+
<td style="padding:15px">Uploads or creates a file.</td>
|
|
543
|
+
<td style="padding:15px">{base_path}/{version}/files.upload?{query}</td>
|
|
544
|
+
<td style="padding:15px">Yes</td>
|
|
545
|
+
</tr>
|
|
546
|
+
<tr>
|
|
547
|
+
<td style="padding:15px">postGroupsarchive(token, channel, callback)</td>
|
|
548
|
+
<td style="padding:15px">Archives a private channel.</td>
|
|
549
|
+
<td style="padding:15px">{base_path}/{version}/groups.archive?{query}</td>
|
|
550
|
+
<td style="padding:15px">Yes</td>
|
|
551
|
+
</tr>
|
|
552
|
+
<tr>
|
|
553
|
+
<td style="padding:15px">postGroupscreate(validate, token, name, callback)</td>
|
|
554
|
+
<td style="padding:15px">Creates a private channel.</td>
|
|
555
|
+
<td style="padding:15px">{base_path}/{version}/groups.create?{query}</td>
|
|
556
|
+
<td style="padding:15px">Yes</td>
|
|
557
|
+
</tr>
|
|
558
|
+
<tr>
|
|
559
|
+
<td style="padding:15px">postGroupscreateChild(token, channel, callback)</td>
|
|
560
|
+
<td style="padding:15px">Clones and archives a private channel.</td>
|
|
561
|
+
<td style="padding:15px">{base_path}/{version}/groups.createChild?{query}</td>
|
|
562
|
+
<td style="padding:15px">Yes</td>
|
|
563
|
+
</tr>
|
|
564
|
+
<tr>
|
|
565
|
+
<td style="padding:15px">getGroupshistory(count, unreads, inclusive, token, oldest, channel, latest, callback)</td>
|
|
566
|
+
<td style="padding:15px">Fetches history of messages and events from a private channel.</td>
|
|
567
|
+
<td style="padding:15px">{base_path}/{version}/groups.history?{query}</td>
|
|
568
|
+
<td style="padding:15px">Yes</td>
|
|
569
|
+
</tr>
|
|
570
|
+
<tr>
|
|
571
|
+
<td style="padding:15px">getGroupsinfo(token, includeLocale, channel, callback)</td>
|
|
572
|
+
<td style="padding:15px">Gets information about a private channel.</td>
|
|
573
|
+
<td style="padding:15px">{base_path}/{version}/groups.info?{query}</td>
|
|
574
|
+
<td style="padding:15px">Yes</td>
|
|
575
|
+
</tr>
|
|
576
|
+
<tr>
|
|
577
|
+
<td style="padding:15px">postGroupsinvite(token, user, channel, callback)</td>
|
|
578
|
+
<td style="padding:15px">Invites a user to a private channel.</td>
|
|
579
|
+
<td style="padding:15px">{base_path}/{version}/groups.invite?{query}</td>
|
|
580
|
+
<td style="padding:15px">Yes</td>
|
|
581
|
+
</tr>
|
|
582
|
+
<tr>
|
|
583
|
+
<td style="padding:15px">postGroupskick(token, user, channel, callback)</td>
|
|
584
|
+
<td style="padding:15px">Removes a user from a private channel.</td>
|
|
585
|
+
<td style="padding:15px">{base_path}/{version}/groups.kick?{query}</td>
|
|
586
|
+
<td style="padding:15px">Yes</td>
|
|
587
|
+
</tr>
|
|
588
|
+
<tr>
|
|
589
|
+
<td style="padding:15px">postGroupsleave(token, channel, callback)</td>
|
|
590
|
+
<td style="padding:15px">Leaves a private channel.</td>
|
|
591
|
+
<td style="padding:15px">{base_path}/{version}/groups.leave?{query}</td>
|
|
592
|
+
<td style="padding:15px">Yes</td>
|
|
593
|
+
</tr>
|
|
594
|
+
<tr>
|
|
595
|
+
<td style="padding:15px">getGroupslist(excludeMembers, token, excludeArchived, callback)</td>
|
|
596
|
+
<td style="padding:15px">Lists private channels that the calling user has access to.</td>
|
|
597
|
+
<td style="padding:15px">{base_path}/{version}/groups.list?{query}</td>
|
|
598
|
+
<td style="padding:15px">Yes</td>
|
|
599
|
+
</tr>
|
|
600
|
+
<tr>
|
|
601
|
+
<td style="padding:15px">postGroupsmark(token, ts, channel, callback)</td>
|
|
602
|
+
<td style="padding:15px">Sets the read cursor in a private channel.</td>
|
|
603
|
+
<td style="padding:15px">{base_path}/{version}/groups.mark?{query}</td>
|
|
604
|
+
<td style="padding:15px">Yes</td>
|
|
605
|
+
</tr>
|
|
606
|
+
<tr>
|
|
607
|
+
<td style="padding:15px">postGroupsopen(token, channel, callback)</td>
|
|
608
|
+
<td style="padding:15px">Opens a private channel.</td>
|
|
609
|
+
<td style="padding:15px">{base_path}/{version}/groups.open?{query}</td>
|
|
610
|
+
<td style="padding:15px">Yes</td>
|
|
611
|
+
</tr>
|
|
612
|
+
<tr>
|
|
613
|
+
<td style="padding:15px">postGroupsrename(validate, token, name, channel, callback)</td>
|
|
614
|
+
<td style="padding:15px">Renames a private channel.</td>
|
|
615
|
+
<td style="padding:15px">{base_path}/{version}/groups.rename?{query}</td>
|
|
616
|
+
<td style="padding:15px">Yes</td>
|
|
617
|
+
</tr>
|
|
618
|
+
<tr>
|
|
619
|
+
<td style="padding:15px">getGroupsreplies(threadTs, token, channel, callback)</td>
|
|
620
|
+
<td style="padding:15px">Retrieve a thread of messages posted to a private channel</td>
|
|
621
|
+
<td style="padding:15px">{base_path}/{version}/groups.replies?{query}</td>
|
|
622
|
+
<td style="padding:15px">Yes</td>
|
|
623
|
+
</tr>
|
|
624
|
+
<tr>
|
|
625
|
+
<td style="padding:15px">postGroupssetPurpose(token, purpose, channel, callback)</td>
|
|
626
|
+
<td style="padding:15px">Sets the purpose for a private channel.</td>
|
|
627
|
+
<td style="padding:15px">{base_path}/{version}/groups.setPurpose?{query}</td>
|
|
628
|
+
<td style="padding:15px">Yes</td>
|
|
629
|
+
</tr>
|
|
630
|
+
<tr>
|
|
631
|
+
<td style="padding:15px">postGroupssetTopic(topic, token, channel, callback)</td>
|
|
632
|
+
<td style="padding:15px">Sets the topic for a private channel.</td>
|
|
633
|
+
<td style="padding:15px">{base_path}/{version}/groups.setTopic?{query}</td>
|
|
634
|
+
<td style="padding:15px">Yes</td>
|
|
635
|
+
</tr>
|
|
636
|
+
<tr>
|
|
637
|
+
<td style="padding:15px">postGroupsunarchive(token, channel, callback)</td>
|
|
638
|
+
<td style="padding:15px">Unarchives a private channel.</td>
|
|
639
|
+
<td style="padding:15px">{base_path}/{version}/groups.unarchive?{query}</td>
|
|
640
|
+
<td style="padding:15px">Yes</td>
|
|
641
|
+
</tr>
|
|
642
|
+
<tr>
|
|
643
|
+
<td style="padding:15px">postImclose(token, channel, callback)</td>
|
|
644
|
+
<td style="padding:15px">Close a direct message channel.</td>
|
|
645
|
+
<td style="padding:15px">{base_path}/{version}/im.close?{query}</td>
|
|
646
|
+
<td style="padding:15px">Yes</td>
|
|
647
|
+
</tr>
|
|
648
|
+
<tr>
|
|
649
|
+
<td style="padding:15px">getImhistory(count, unreads, inclusive, token, oldest, channel, latest, callback)</td>
|
|
650
|
+
<td style="padding:15px">Fetches history of messages and events from direct message channel.</td>
|
|
651
|
+
<td style="padding:15px">{base_path}/{version}/im.history?{query}</td>
|
|
652
|
+
<td style="padding:15px">Yes</td>
|
|
653
|
+
</tr>
|
|
654
|
+
<tr>
|
|
655
|
+
<td style="padding:15px">getImlist(cursor, token, limit, callback)</td>
|
|
656
|
+
<td style="padding:15px">Lists direct message channels for the calling user.</td>
|
|
657
|
+
<td style="padding:15px">{base_path}/{version}/im.list?{query}</td>
|
|
658
|
+
<td style="padding:15px">Yes</td>
|
|
659
|
+
</tr>
|
|
660
|
+
<tr>
|
|
661
|
+
<td style="padding:15px">postImmark(token, ts, channel, callback)</td>
|
|
662
|
+
<td style="padding:15px">Sets the read cursor in a direct message channel.</td>
|
|
663
|
+
<td style="padding:15px">{base_path}/{version}/im.mark?{query}</td>
|
|
664
|
+
<td style="padding:15px">Yes</td>
|
|
665
|
+
</tr>
|
|
666
|
+
<tr>
|
|
667
|
+
<td style="padding:15px">postImopen(token, returnIm, user, includeLocale, callback)</td>
|
|
668
|
+
<td style="padding:15px">Opens a direct message channel.</td>
|
|
669
|
+
<td style="padding:15px">{base_path}/{version}/im.open?{query}</td>
|
|
670
|
+
<td style="padding:15px">Yes</td>
|
|
671
|
+
</tr>
|
|
672
|
+
<tr>
|
|
673
|
+
<td style="padding:15px">getImreplies(threadTs, token, channel, callback)</td>
|
|
674
|
+
<td style="padding:15px">Retrieve a thread of messages posted to a direct message conversation</td>
|
|
675
|
+
<td style="padding:15px">{base_path}/{version}/im.replies?{query}</td>
|
|
676
|
+
<td style="padding:15px">Yes</td>
|
|
677
|
+
</tr>
|
|
678
|
+
<tr>
|
|
679
|
+
<td style="padding:15px">getMigrationexchange(token, toOld, users, callback)</td>
|
|
680
|
+
<td style="padding:15px">For Enterprise Grid workspaces, map local user IDs to global user IDs</td>
|
|
681
|
+
<td style="padding:15px">{base_path}/{version}/migration.exchange?{query}</td>
|
|
682
|
+
<td style="padding:15px">Yes</td>
|
|
683
|
+
</tr>
|
|
684
|
+
<tr>
|
|
685
|
+
<td style="padding:15px">postMpimclose(token, channel, callback)</td>
|
|
686
|
+
<td style="padding:15px">Closes a multiparty direct message channel.</td>
|
|
687
|
+
<td style="padding:15px">{base_path}/{version}/mpim.close?{query}</td>
|
|
688
|
+
<td style="padding:15px">Yes</td>
|
|
689
|
+
</tr>
|
|
690
|
+
<tr>
|
|
691
|
+
<td style="padding:15px">getMpimhistory(count, unreads, inclusive, token, oldest, channel, latest, callback)</td>
|
|
692
|
+
<td style="padding:15px">Fetches history of messages and events from a multiparty direct message.</td>
|
|
693
|
+
<td style="padding:15px">{base_path}/{version}/mpim.history?{query}</td>
|
|
694
|
+
<td style="padding:15px">Yes</td>
|
|
695
|
+
</tr>
|
|
696
|
+
<tr>
|
|
697
|
+
<td style="padding:15px">getMpimlist(token, callback)</td>
|
|
698
|
+
<td style="padding:15px">Lists multiparty direct message channels for the calling user.</td>
|
|
699
|
+
<td style="padding:15px">{base_path}/{version}/mpim.list?{query}</td>
|
|
700
|
+
<td style="padding:15px">Yes</td>
|
|
701
|
+
</tr>
|
|
702
|
+
<tr>
|
|
703
|
+
<td style="padding:15px">postMpimmark(token, ts, channel, callback)</td>
|
|
704
|
+
<td style="padding:15px">Sets the read cursor in a multiparty direct message channel.</td>
|
|
705
|
+
<td style="padding:15px">{base_path}/{version}/mpim.mark?{query}</td>
|
|
706
|
+
<td style="padding:15px">Yes</td>
|
|
707
|
+
</tr>
|
|
708
|
+
<tr>
|
|
709
|
+
<td style="padding:15px">postMpimopen(token, users, callback)</td>
|
|
710
|
+
<td style="padding:15px">This method opens a multiparty direct message.</td>
|
|
711
|
+
<td style="padding:15px">{base_path}/{version}/mpim.open?{query}</td>
|
|
712
|
+
<td style="padding:15px">Yes</td>
|
|
713
|
+
</tr>
|
|
714
|
+
<tr>
|
|
715
|
+
<td style="padding:15px">getMpimreplies(threadTs, token, channel, callback)</td>
|
|
716
|
+
<td style="padding:15px">Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message.</td>
|
|
717
|
+
<td style="padding:15px">{base_path}/{version}/mpim.replies?{query}</td>
|
|
718
|
+
<td style="padding:15px">Yes</td>
|
|
719
|
+
</tr>
|
|
720
|
+
<tr>
|
|
721
|
+
<td style="padding:15px">getOauthaccess(clientSecret, code, singleChannel, clientId, redirectUri, callback)</td>
|
|
722
|
+
<td style="padding:15px">Exchanges a temporary OAuth verifier code for an access token.</td>
|
|
723
|
+
<td style="padding:15px">{base_path}/{version}/oauth.access?{query}</td>
|
|
724
|
+
<td style="padding:15px">Yes</td>
|
|
725
|
+
</tr>
|
|
726
|
+
<tr>
|
|
727
|
+
<td style="padding:15px">getOauthtoken(clientSecret, code, singleChannel, clientId, redirectUri, callback)</td>
|
|
728
|
+
<td style="padding:15px">Exchanges a temporary OAuth verifier code for a workspace token.</td>
|
|
729
|
+
<td style="padding:15px">{base_path}/{version}/oauth.token?{query}</td>
|
|
730
|
+
<td style="padding:15px">Yes</td>
|
|
731
|
+
</tr>
|
|
732
|
+
<tr>
|
|
733
|
+
<td style="padding:15px">postPinsadd(fileComment, timestamp, token, file, channel, callback)</td>
|
|
734
|
+
<td style="padding:15px">Pins an item to a channel.</td>
|
|
735
|
+
<td style="padding:15px">{base_path}/{version}/pins.add?{query}</td>
|
|
736
|
+
<td style="padding:15px">Yes</td>
|
|
737
|
+
</tr>
|
|
738
|
+
<tr>
|
|
739
|
+
<td style="padding:15px">getPinslist(token, channel, callback)</td>
|
|
740
|
+
<td style="padding:15px">Lists items pinned to a channel.</td>
|
|
741
|
+
<td style="padding:15px">{base_path}/{version}/pins.list?{query}</td>
|
|
742
|
+
<td style="padding:15px">Yes</td>
|
|
743
|
+
</tr>
|
|
744
|
+
<tr>
|
|
745
|
+
<td style="padding:15px">postPinsremove(fileComment, timestamp, token, file, channel, callback)</td>
|
|
746
|
+
<td style="padding:15px">Un-pins an item from a channel.</td>
|
|
747
|
+
<td style="padding:15px">{base_path}/{version}/pins.remove?{query}</td>
|
|
748
|
+
<td style="padding:15px">Yes</td>
|
|
749
|
+
</tr>
|
|
750
|
+
<tr>
|
|
751
|
+
<td style="padding:15px">postReactionsadd(name, fileComment, timestamp, token, file, channel, callback)</td>
|
|
752
|
+
<td style="padding:15px">Adds a reaction to an item.</td>
|
|
753
|
+
<td style="padding:15px">{base_path}/{version}/reactions.add?{query}</td>
|
|
754
|
+
<td style="padding:15px">Yes</td>
|
|
755
|
+
</tr>
|
|
756
|
+
<tr>
|
|
757
|
+
<td style="padding:15px">getReactionsget(full, fileComment, timestamp, token, file, channel, callback)</td>
|
|
758
|
+
<td style="padding:15px">Gets reactions for an item.</td>
|
|
759
|
+
<td style="padding:15px">{base_path}/{version}/reactions.get?{query}</td>
|
|
760
|
+
<td style="padding:15px">Yes</td>
|
|
761
|
+
</tr>
|
|
762
|
+
<tr>
|
|
763
|
+
<td style="padding:15px">getReactionslist(count, token, full, user, page, callback)</td>
|
|
764
|
+
<td style="padding:15px">Lists reactions made by a user.</td>
|
|
765
|
+
<td style="padding:15px">{base_path}/{version}/reactions.list?{query}</td>
|
|
766
|
+
<td style="padding:15px">Yes</td>
|
|
767
|
+
</tr>
|
|
768
|
+
<tr>
|
|
769
|
+
<td style="padding:15px">postReactionsremove(name, fileComment, timestamp, token, file, channel, callback)</td>
|
|
770
|
+
<td style="padding:15px">Removes a reaction from an item.</td>
|
|
771
|
+
<td style="padding:15px">{base_path}/{version}/reactions.remove?{query}</td>
|
|
772
|
+
<td style="padding:15px">Yes</td>
|
|
773
|
+
</tr>
|
|
774
|
+
<tr>
|
|
775
|
+
<td style="padding:15px">postRemindersadd(text, token, user, time, callback)</td>
|
|
776
|
+
<td style="padding:15px">Creates a reminder.</td>
|
|
777
|
+
<td style="padding:15px">{base_path}/{version}/reminders.add?{query}</td>
|
|
778
|
+
<td style="padding:15px">Yes</td>
|
|
779
|
+
</tr>
|
|
780
|
+
<tr>
|
|
781
|
+
<td style="padding:15px">postReminderscomplete(token, reminder, callback)</td>
|
|
782
|
+
<td style="padding:15px">Marks a reminder as complete.</td>
|
|
783
|
+
<td style="padding:15px">{base_path}/{version}/reminders.complete?{query}</td>
|
|
784
|
+
<td style="padding:15px">Yes</td>
|
|
785
|
+
</tr>
|
|
786
|
+
<tr>
|
|
787
|
+
<td style="padding:15px">postRemindersdelete(token, reminder, callback)</td>
|
|
788
|
+
<td style="padding:15px">Deletes a reminder.</td>
|
|
789
|
+
<td style="padding:15px">{base_path}/{version}/reminders.delete?{query}</td>
|
|
790
|
+
<td style="padding:15px">Yes</td>
|
|
791
|
+
</tr>
|
|
792
|
+
<tr>
|
|
793
|
+
<td style="padding:15px">getRemindersinfo(token, reminder, callback)</td>
|
|
794
|
+
<td style="padding:15px">Gets information about a reminder.</td>
|
|
795
|
+
<td style="padding:15px">{base_path}/{version}/reminders.info?{query}</td>
|
|
796
|
+
<td style="padding:15px">Yes</td>
|
|
797
|
+
</tr>
|
|
798
|
+
<tr>
|
|
799
|
+
<td style="padding:15px">getReminderslist(token, callback)</td>
|
|
800
|
+
<td style="padding:15px">Lists all reminders created by or for a given user.</td>
|
|
801
|
+
<td style="padding:15px">{base_path}/{version}/reminders.list?{query}</td>
|
|
802
|
+
<td style="padding:15px">Yes</td>
|
|
803
|
+
</tr>
|
|
804
|
+
<tr>
|
|
805
|
+
<td style="padding:15px">getRtmconnect(presenceSub, token, batchPresenceAware, callback)</td>
|
|
806
|
+
<td style="padding:15px">Starts a Real Time Messaging session.</td>
|
|
807
|
+
<td style="padding:15px">{base_path}/{version}/rtm.connect?{query}</td>
|
|
808
|
+
<td style="padding:15px">Yes</td>
|
|
809
|
+
</tr>
|
|
810
|
+
<tr>
|
|
811
|
+
<td style="padding:15px">getRtmstart(noLatest, simpleLatest, includeLocale, presenceSub, noUnreads, batchPresenceAware, mpimAware, token, callback)</td>
|
|
812
|
+
<td style="padding:15px">Starts a Real Time Messaging session.</td>
|
|
813
|
+
<td style="padding:15px">{base_path}/{version}/rtm.start?{query}</td>
|
|
814
|
+
<td style="padding:15px">Yes</td>
|
|
815
|
+
</tr>
|
|
816
|
+
<tr>
|
|
817
|
+
<td style="padding:15px">getSearchall(sortDir, query, sort, count, token, highlight, page, callback)</td>
|
|
818
|
+
<td style="padding:15px">Searches for messages and files matching a query.</td>
|
|
819
|
+
<td style="padding:15px">{base_path}/{version}/search.all?{query}</td>
|
|
820
|
+
<td style="padding:15px">Yes</td>
|
|
821
|
+
</tr>
|
|
822
|
+
<tr>
|
|
823
|
+
<td style="padding:15px">getSearchfiles(sortDir, query, sort, highlight, count, token, page, callback)</td>
|
|
824
|
+
<td style="padding:15px">Searches for files matching a query.</td>
|
|
825
|
+
<td style="padding:15px">{base_path}/{version}/search.files?{query}</td>
|
|
826
|
+
<td style="padding:15px">Yes</td>
|
|
827
|
+
</tr>
|
|
828
|
+
<tr>
|
|
829
|
+
<td style="padding:15px">getSearchmessages(sortDir, query, sort, count, token, highlight, page, callback)</td>
|
|
830
|
+
<td style="padding:15px">Searches for messages matching a query.</td>
|
|
831
|
+
<td style="padding:15px">{base_path}/{version}/search.messages?{query}</td>
|
|
832
|
+
<td style="padding:15px">Yes</td>
|
|
833
|
+
</tr>
|
|
834
|
+
<tr>
|
|
835
|
+
<td style="padding:15px">postStarsadd(fileComment, timestamp, token, channel, file, callback)</td>
|
|
836
|
+
<td style="padding:15px">Adds a star to an item.</td>
|
|
837
|
+
<td style="padding:15px">{base_path}/{version}/stars.add?{query}</td>
|
|
838
|
+
<td style="padding:15px">Yes</td>
|
|
839
|
+
</tr>
|
|
840
|
+
<tr>
|
|
841
|
+
<td style="padding:15px">getStarslist(count, token, page, callback)</td>
|
|
842
|
+
<td style="padding:15px">Lists stars for a user.</td>
|
|
843
|
+
<td style="padding:15px">{base_path}/{version}/stars.list?{query}</td>
|
|
844
|
+
<td style="padding:15px">Yes</td>
|
|
845
|
+
</tr>
|
|
846
|
+
<tr>
|
|
847
|
+
<td style="padding:15px">postStarsremove(fileComment, timestamp, token, channel, file, callback)</td>
|
|
848
|
+
<td style="padding:15px">Removes a star from an item.</td>
|
|
849
|
+
<td style="padding:15px">{base_path}/{version}/stars.remove?{query}</td>
|
|
850
|
+
<td style="padding:15px">Yes</td>
|
|
851
|
+
</tr>
|
|
852
|
+
<tr>
|
|
853
|
+
<td style="padding:15px">getTeamaccessLogs(count, token, page, before, callback)</td>
|
|
854
|
+
<td style="padding:15px">Gets the access logs for the current team.</td>
|
|
855
|
+
<td style="padding:15px">{base_path}/{version}/team.accessLogs?{query}</td>
|
|
856
|
+
<td style="padding:15px">Yes</td>
|
|
857
|
+
</tr>
|
|
858
|
+
<tr>
|
|
859
|
+
<td style="padding:15px">getTeambillableInfo(token, user, callback)</td>
|
|
860
|
+
<td style="padding:15px">Gets billable users information for the current team.</td>
|
|
861
|
+
<td style="padding:15px">{base_path}/{version}/team.billableInfo?{query}</td>
|
|
862
|
+
<td style="padding:15px">Yes</td>
|
|
863
|
+
</tr>
|
|
864
|
+
<tr>
|
|
865
|
+
<td style="padding:15px">getTeaminfo(token, callback)</td>
|
|
866
|
+
<td style="padding:15px">Gets information about the current team.</td>
|
|
867
|
+
<td style="padding:15px">{base_path}/{version}/team.info?{query}</td>
|
|
868
|
+
<td style="padding:15px">Yes</td>
|
|
869
|
+
</tr>
|
|
870
|
+
<tr>
|
|
871
|
+
<td style="padding:15px">getTeamintegrationLogs(count, changeType, appId, token, user, serviceId, page, callback)</td>
|
|
872
|
+
<td style="padding:15px">Gets the integration logs for the current team.</td>
|
|
873
|
+
<td style="padding:15px">{base_path}/{version}/team.integrationLogs?{query}</td>
|
|
874
|
+
<td style="padding:15px">Yes</td>
|
|
875
|
+
</tr>
|
|
876
|
+
<tr>
|
|
877
|
+
<td style="padding:15px">getTeamprofileget(token, visibility, callback)</td>
|
|
878
|
+
<td style="padding:15px">Retrieve a team's profile.</td>
|
|
879
|
+
<td style="padding:15px">{base_path}/{version}/team.profile.get?{query}</td>
|
|
880
|
+
<td style="padding:15px">Yes</td>
|
|
881
|
+
</tr>
|
|
882
|
+
<tr>
|
|
883
|
+
<td style="padding:15px">postUsergroupscreate(handle, name, channels, token, includeCount, description, callback)</td>
|
|
884
|
+
<td style="padding:15px">Create a User Group</td>
|
|
885
|
+
<td style="padding:15px">{base_path}/{version}/usergroups.create?{query}</td>
|
|
886
|
+
<td style="padding:15px">Yes</td>
|
|
887
|
+
</tr>
|
|
888
|
+
<tr>
|
|
889
|
+
<td style="padding:15px">postUsergroupsdisable(token, includeCount, usergroup, callback)</td>
|
|
890
|
+
<td style="padding:15px">Disable an existing User Group</td>
|
|
891
|
+
<td style="padding:15px">{base_path}/{version}/usergroups.disable?{query}</td>
|
|
892
|
+
<td style="padding:15px">Yes</td>
|
|
893
|
+
</tr>
|
|
894
|
+
<tr>
|
|
895
|
+
<td style="padding:15px">postUsergroupsenable(token, includeCount, usergroup, callback)</td>
|
|
896
|
+
<td style="padding:15px">Enable a User Group</td>
|
|
897
|
+
<td style="padding:15px">{base_path}/{version}/usergroups.enable?{query}</td>
|
|
898
|
+
<td style="padding:15px">Yes</td>
|
|
899
|
+
</tr>
|
|
900
|
+
<tr>
|
|
901
|
+
<td style="padding:15px">getUsergroupslist(includeUsers, token, includeCount, includeDisabled, callback)</td>
|
|
902
|
+
<td style="padding:15px">List all User Groups for a team</td>
|
|
903
|
+
<td style="padding:15px">{base_path}/{version}/usergroups.list?{query}</td>
|
|
904
|
+
<td style="padding:15px">Yes</td>
|
|
905
|
+
</tr>
|
|
906
|
+
<tr>
|
|
907
|
+
<td style="padding:15px">postUsergroupsupdate(handle, description, channels, token, includeCount, usergroup, name, callback)</td>
|
|
908
|
+
<td style="padding:15px">Update an existing User Group</td>
|
|
909
|
+
<td style="padding:15px">{base_path}/{version}/usergroups.update?{query}</td>
|
|
910
|
+
<td style="padding:15px">Yes</td>
|
|
911
|
+
</tr>
|
|
912
|
+
<tr>
|
|
913
|
+
<td style="padding:15px">getUsergroupsuserslist(token, includeDisabled, usergroup, callback)</td>
|
|
914
|
+
<td style="padding:15px">List all users in a User Group</td>
|
|
915
|
+
<td style="padding:15px">{base_path}/{version}/usergroups.users.list?{query}</td>
|
|
916
|
+
<td style="padding:15px">Yes</td>
|
|
917
|
+
</tr>
|
|
918
|
+
<tr>
|
|
919
|
+
<td style="padding:15px">postUsergroupsusersupdate(includeCount, token, users, usergroup, callback)</td>
|
|
920
|
+
<td style="padding:15px">Update the list of users for a User Group</td>
|
|
921
|
+
<td style="padding:15px">{base_path}/{version}/usergroups.users.update?{query}</td>
|
|
922
|
+
<td style="padding:15px">Yes</td>
|
|
923
|
+
</tr>
|
|
924
|
+
<tr>
|
|
925
|
+
<td style="padding:15px">getUsersconversations(cursor, token, limit, user, excludeArchived, types, callback)</td>
|
|
926
|
+
<td style="padding:15px">List conversations the calling user may access.</td>
|
|
927
|
+
<td style="padding:15px">{base_path}/{version}/users.conversations?{query}</td>
|
|
928
|
+
<td style="padding:15px">Yes</td>
|
|
929
|
+
</tr>
|
|
930
|
+
<tr>
|
|
931
|
+
<td style="padding:15px">postUsersdeletePhoto(token, callback)</td>
|
|
932
|
+
<td style="padding:15px">Delete the user profile photo</td>
|
|
933
|
+
<td style="padding:15px">{base_path}/{version}/users.deletePhoto?{query}</td>
|
|
934
|
+
<td style="padding:15px">Yes</td>
|
|
935
|
+
</tr>
|
|
936
|
+
<tr>
|
|
937
|
+
<td style="padding:15px">getUsersgetPresence(token, user, callback)</td>
|
|
938
|
+
<td style="padding:15px">Gets user presence information.</td>
|
|
939
|
+
<td style="padding:15px">{base_path}/{version}/users.getPresence?{query}</td>
|
|
940
|
+
<td style="padding:15px">Yes</td>
|
|
941
|
+
</tr>
|
|
942
|
+
<tr>
|
|
943
|
+
<td style="padding:15px">getUsersidentity(token, callback)</td>
|
|
944
|
+
<td style="padding:15px">Get a user's identity.</td>
|
|
945
|
+
<td style="padding:15px">{base_path}/{version}/users.identity?{query}</td>
|
|
946
|
+
<td style="padding:15px">Yes</td>
|
|
947
|
+
</tr>
|
|
948
|
+
<tr>
|
|
949
|
+
<td style="padding:15px">getUsersinfo(includeLocale, token, user, callback)</td>
|
|
950
|
+
<td style="padding:15px">Gets information about a user.</td>
|
|
951
|
+
<td style="padding:15px">{base_path}/{version}/users.info?{query}</td>
|
|
952
|
+
<td style="padding:15px">Yes</td>
|
|
953
|
+
</tr>
|
|
954
|
+
<tr>
|
|
955
|
+
<td style="padding:15px">getUserslist(presence, cursor, token, limit, includeLocale, callback)</td>
|
|
956
|
+
<td style="padding:15px">Lists all users in a Slack team.</td>
|
|
957
|
+
<td style="padding:15px">{base_path}/{version}/users.list?{query}</td>
|
|
958
|
+
<td style="padding:15px">Yes</td>
|
|
959
|
+
</tr>
|
|
960
|
+
<tr>
|
|
961
|
+
<td style="padding:15px">getUserslookupByEmail(token, email, callback)</td>
|
|
962
|
+
<td style="padding:15px">Find a user with an email address.</td>
|
|
963
|
+
<td style="padding:15px">{base_path}/{version}/users.lookupByEmail?{query}</td>
|
|
964
|
+
<td style="padding:15px">Yes</td>
|
|
965
|
+
</tr>
|
|
966
|
+
<tr>
|
|
967
|
+
<td style="padding:15px">postUserssetActive(token, callback)</td>
|
|
968
|
+
<td style="padding:15px">Marked a user as active. Deprecated and non-functional.</td>
|
|
969
|
+
<td style="padding:15px">{base_path}/{version}/users.setActive?{query}</td>
|
|
970
|
+
<td style="padding:15px">Yes</td>
|
|
971
|
+
</tr>
|
|
972
|
+
<tr>
|
|
973
|
+
<td style="padding:15px">postUserssetPhoto(image, cropW, token, cropY, cropX, callback)</td>
|
|
974
|
+
<td style="padding:15px">Set the user profile photo</td>
|
|
975
|
+
<td style="padding:15px">{base_path}/{version}/users.setPhoto?{query}</td>
|
|
976
|
+
<td style="padding:15px">Yes</td>
|
|
977
|
+
</tr>
|
|
978
|
+
<tr>
|
|
979
|
+
<td style="padding:15px">postUserssetPresence(token, presence, callback)</td>
|
|
980
|
+
<td style="padding:15px">Manually sets user presence.</td>
|
|
981
|
+
<td style="padding:15px">{base_path}/{version}/users.setPresence?{query}</td>
|
|
982
|
+
<td style="padding:15px">Yes</td>
|
|
983
|
+
</tr>
|
|
984
|
+
<tr>
|
|
985
|
+
<td style="padding:15px">getUsersprofileget(token, includeLabels, user, callback)</td>
|
|
986
|
+
<td style="padding:15px">Retrieves a user's profile information.</td>
|
|
987
|
+
<td style="padding:15px">{base_path}/{version}/users.profile.get?{query}</td>
|
|
988
|
+
<td style="padding:15px">Yes</td>
|
|
989
|
+
</tr>
|
|
990
|
+
<tr>
|
|
991
|
+
<td style="padding:15px">postUsersprofileset(profile, token, user, value, name, callback)</td>
|
|
992
|
+
<td style="padding:15px">Set the profile information for a user.</td>
|
|
993
|
+
<td style="padding:15px">{base_path}/{version}/users.profile.set?{query}</td>
|
|
994
|
+
<td style="padding:15px">Yes</td>
|
|
995
|
+
</tr>
|
|
168
996
|
</table>
|
|
169
997
|
<br>
|