Skip to content

feat(pin-save-thread-subscription-js-sdk): add documentation for pin/save messages, pin conversations and thread subscription - #469

Open
PrajwalDhuleCC wants to merge 3 commits into
mainfrom
feature/pin-save-thread-subscription-js-sdk
Open

feat(pin-save-thread-subscription-js-sdk): add documentation for pin/save messages, pin conversations and thread subscription#469
PrajwalDhuleCC wants to merge 3 commits into
mainfrom
feature/pin-save-thread-subscription-js-sdk

fix(sdk/javascript): repoint the calling-flow links at the Calls SDK …

992be3c
Select commit
Loading
Failed to load commit list.
Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck completed Sep 2, 2026 in 3s

Mintlify Validation (cometchat-22654f5b) - vale-spellcheck Failed

Found 224 suggested changes across 7 files in 1403.86ms

Details

Running Vale across on the following files affected by this PR:

- sdk/javascript/all-real-time-listeners.mdx
- sdk/javascript/message-filtering.mdx
- sdk/javascript/threaded-messages.mdx
- sdk/javascript/pin-conversation.mdx
- sdk/javascript/pin-message.mdx
- sdk/javascript/save-message.mdx
- sdk/javascript/thread-subscription.mdx

Attempting to initialize Vale linter...
No customer vale configuration detected. Using Mintlify's default configuration.
Attempting to run Vale spellcheck...
Vale spellcheck completed successfully.

sdk/javascript/all-real-time-listeners.mdx:
	- 38:21      Did you really mean 'offlineUser'?
	- 40:41      Did you really mean 'offlineUser'?
	- 95:51      Did you really mean 'joinedUser'?
	- 95:79      Did you really mean 'joinedGroup'?
	- 96:49      Did you really mean 'leftUser'?
	- 96:75      Did you really mean 'leftGroup'?
	- 97:51      Did you really mean 'kickedUser'?
	- 97:79      Did you really mean 'kickedBy'?
	- 97:105     Did you really mean 'kickedFrom'?
	- 98:51      Did you really mean 'bannedUser'?
	- 98:79      Did you really mean 'bannedBy'?
	- 98:105     Did you really mean 'bannedFrom'?
	- 99:53      Did you really mean 'unbannedUser'?
	- 99:83      Did you really mean 'unbannedBy'?
	- 99:111     Did you really mean 'unbannedFrom'?
	- 100:57     Did you really mean 'changedUser'?
	- 100:86     Did you really mean 'newScope'?
	- 100:104    Did you really mean 'oldScope'?
	- 100:122    Did you really mean 'changedGroup'?
	- 101:52     Did you really mean 'userAdded'?
	- 101:79     Did you really mean 'addedBy'?
	- 101:104    Did you really mean 'addedTo'?
	- 120:7      Did you really mean 'leftUser'?
	- 121:7      Did you really mean 'leftGroup'?
	- 123:51     Did you really mean 'leftUser'?
	- 123:61     Did you really mean 'leftGroup'?
	- 127:7      Did you really mean 'kickedUser'?
	- 128:7      Did you really mean 'kickedBy'?
	- 129:7      Did you really mean 'kickedFrom'?
	- 133:9      Did you really mean 'kickedUser'?
	- 134:9      Did you really mean 'kickedBy'?
	- 135:9      Did you really mean 'kickedFrom'?
	- 140:7      Did you really mean 'bannedUser'?
	- 141:7      Did you really mean 'bannedBy'?
	- 142:7      Did you really mean 'bannedFrom'?
	- 146:9      Did you really mean 'bannedUser'?
	- 147:9      Did you really mean 'bannedBy'?
	- 148:9      Did you really mean 'bannedFrom'?
	- 153:7      Did you really mean 'unbannedUser'?
	- 154:7      Did you really mean 'unbannedBy'?
	- 155:7      Did you really mean 'unbannedFrom'?
	- 159:9      Did you really mean 'unbannedUser'?
	- 160:9      Did you really mean 'unbannedBy'?
	- 161:9      Did you really mean 'unbannedFrom'?
	- 166:7      Did you really mean 'changedUser'?
	- 167:7      Did you really mean 'newScope'?
	- 168:7      Did you really mean 'oldScope'?
	- 169:7      Did you really mean 'changedGroup'?
	- 173:9      Did you really mean 'changedUser'?
	- 174:9      Did you really mean 'newScope'?
	- 175:9      Did you really mean 'oldScope'?
	- 176:9      Did you really mean 'changedGroup'?
	- 181:7      Did you really mean 'userAdded'?
	- 182:7      Did you really mean 'addedby'?
	- 183:7      Did you really mean 'addedTo'?
	- 187:9      Did you really mean 'userAdded'?
	- 188:9      Did you really mean 'addedby'?
	- 189:9      Did you really mean 'addedTo'?
	- 315:125    Did you really mean 'unsaves'?
	- 331:30     Did you really mean 'mediaMessage'?
	- 332:58     Did you really mean 'mediaMessage'?
	- 334:31     Did you really mean 'customMessage'?
	- 335:59     Did you really mean 'customMessage'?
	- 337:27     Did you really mean 'messageReceipt'?
	- 338:40     Did you really mean 'messageReceipt'?
	- 340:22     Did you really mean 'messageReceipt'?
	- 341:35     Did you really mean 'messageReceipt'?
	- 343:23     Did you really mean 'typingIndicator'?
	- 344:37     Did you really mean 'typingIndicator'?
	- 347:35     Did you really mean 'typingIndicator'?
	- 368:47     Did you really mean 'messageReceipt'?
	- 371:42     Did you really mean 'messageReceipt'?
	- 774:104    Did you really mean 'listenerId'?
	- 786:23     Did you really mean 'onError'?
	- 852:8      Did you really mean 'loginFailure'?
	- 854:23     Did you really mean 'loginFailure'?
	- 854:57     Did you really mean 'logoutSuccess'?
	- 856:51     Did you really mean 'logoutSuccess'?
	- 857:18     Did you really mean 'logoutFailure'?
	- 860:19     Did you really mean 'logoutFailure'?
	- 915:2      Did you really mean 'inConnecting'?
	- 918:14     Did you really mean 'onDisconnected'?
	- 937:2      Did you really mean 'inConnecting'?
	- 940:14     Did you really mean 'onDisconnected'?

sdk/javascript/message-filtering.mdx:
	- 34:5       Did you really mean 'messagesRequest'?
	- 42:5       Did you really mean 'messagesRequest'?
	- 59:5       Did you really mean 'messagesRequest'?
	- 68:5       Did you really mean 'messagesRequest'?
	- 88:5       Did you really mean 'messagesRequest'?
	- 97:5       Did you really mean 'messagesRequest'?
	- 117:3      Did you really mean 'messageId'?
	- 119:3      Did you really mean 'messagesRequest'?
	- 132:5      Did you really mean 'messageId'?
	- 134:5      Did you really mean 'messagesRequest'?
	- 146:3      Did you really mean 'messageId'?
	- 148:3      Did you really mean 'messagesRequest'?
	- 161:5      Did you really mean 'messageId'?
	- 163:5      Did you really mean 'messagesRequest'?
	- 186:3      Did you really mean 'messagesRequest'?
	- 201:5      Did you really mean 'messagesRequest'?
	- 215:3      Did you really mean 'messagesRequest'?
	- 230:5      Did you really mean 'messagesRequest'?
	- 252:3      Did you really mean 'messagesRequest'?
	- 266:5      Did you really mean 'messagesRequest'?
	- 279:3      Did you really mean 'messagesRequest'?
	- 293:5      Did you really mean 'messagesRequest'?
	- 315:3      Did you really mean 'messagesRequest'?
	- 329:5      Did you really mean 'messagesRequest'?
	- 342:3      Did you really mean 'messagesRequest'?
	- 356:5      Did you really mean 'messagesRequest'?
	- 379:3      Did you really mean 'messagesRequest'?
	- 394:5      Did you really mean 'messagesRequest'?
	- 408:3      Did you really mean 'messagesRequest'?
	- 423:5      Did you really mean 'messagesRequest'?
	- 446:3      Did you really mean 'messagesRequest'?
	- 462:5      Did you really mean 'messagesRequest'?
	- 477:3      Did you really mean 'messagesRequest'?
	- 493:5      Did you really mean 'messagesRequest'?
	- 517:3      Did you really mean 'messagesRequest'?
	- 532:5      Did you really mean 'messagesRequest'?
	- 546:3      Did you really mean 'messagesRequest'?
	- 561:5      Did you really mean 'messagesRequest'?
	- 585:3      Did you really mean 'messagesRequest'?
	- 602:5      Did you really mean 'messagesRequest'?
	- 618:3      Did you really mean 'messagesRequest'?
	- 635:5      Did you really mean 'messagesRequest'?
	- 658:3      Did you really mean 'messageId'?
	- 659:3      Did you really mean 'messagesRequest'?
	- 672:5      Did you really mean 'messageId'?
	- 674:5      Did you really mean 'messagesRequest'?
	- 687:3      Did you really mean 'messageId'?
	- 688:3      Did you really mean 'messagesRequest'?
	- 701:5      Did you really mean 'messageId'?
	- 703:5      Did you really mean 'messagesRequest'?
	- 725:3      Did you really mean 'messagesRequest'?
	- 739:5      Did you really mean 'messagesRequest'?
	- 752:3      Did you really mean 'messagesRequest'?
	- 766:5      Did you really mean 'messagesRequest'?
	- 787:3      Did you really mean 'messagesRequest'?
	- 799:5      Did you really mean 'messagesRequest'?
	- 820:3      Did you really mean 'messagesRequest'?
	- 834:5      Did you really mean 'messagesRequest'?
	- 847:3      Did you really mean 'messagesRequest'?
	- 861:5      Did you really mean 'messagesRequest'?
	- 880:3      Did you really mean 'messagesRequest'?
	- 894:5      Did you really mean 'messagesRequest'?
	- 907:3      Did you really mean 'messagesRequest'?
	- 921:5      Did you really mean 'messagesRequest'?
	- 940:3      Did you really mean 'messagesRequest'?
	- 954:5      Did you really mean 'messagesRequest'?
	- 967:3      Did you really mean 'messagesRequest'?
	- 981:5      Did you really mean 'messagesRequest'?
	- 1000:27    Did you really mean 'starredMessage'?
	- 1001:3     Did you really mean 'messagesRequest'?
	- 1015:14    Did you really mean 'starredMessage'?
	- 1016:5     Did you really mean 'messagesRequest'?
	- 1029:27    Did you really mean 'starredMessage'?
	- 1030:3     Did you really mean 'messagesRequest'?
	- 1044:14    Did you really mean 'starredMessage'?
	- 1045:5     Did you really mean 'messagesRequest'?
	- 1064:3     Did you really mean 'messagesRequest'?
	- 1078:5     Did you really mean 'messagesRequest'?
	- 1091:3     Did you really mean 'messagesRequest'?
	- 1105:5     Did you really mean 'messagesRequest'?
	- 1136:3     Did you really mean 'messagesRequest'?
	- 1150:5     Did you really mean 'messagesRequest'?
	- 1163:3     Did you really mean 'messagesRequest'?
	- 1177:5     Did you really mean 'messagesRequest'?
	- 1202:3     Did you really mean 'messagesRequest'?
	- 1216:5     Did you really mean 'messagesRequest'?
	- 1229:3     Did you really mean 'messagesRequest'?
	- 1243:5     Did you really mean 'messagesRequest'?
	- 1271:3     Did you really mean 'messagesRequest'?
	- 1285:5     Did you really mean 'messagesRequest'?
	- 1298:3     Did you really mean 'messagesRequest'?
	- 1312:5     Did you really mean 'messagesRequest'?
	- 1340:3     Did you really mean 'messagesRequest'?
	- 1354:5     Did you really mean 'messagesRequest'?
	- 1367:3     Did you really mean 'messagesRequest'?
	- 1381:5     Did you really mean 'messagesRequest'?
	- 1396:43    Did you really mean 'UIDs'?
	- 1409:3     Did you really mean 'messagesRequest'?
	- 1423:5     Did you really mean 'messagesRequest'?
	- 1436:3     Did you really mean 'messagesRequest'?
	- 1450:5     Did you really mean 'messagesRequest'?
	- 1478:3     Did you really mean 'messagesRequest'?
	- 1492:5     Did you really mean 'messagesRequest'?
	- 1505:3     Did you really mean 'messagesRequest'?
	- 1519:5     Did you really mean 'messagesRequest'?

sdk/javascript/pin-conversation.mdx:
	- 98:9     Did you really mean 'conversationsRequest'?
	- 116:9    Did you really mean 'conversationsRequest'?
	- 221:9    Did you really mean 'systemLimit'?

sdk/javascript/pin-message.mdx:
	- 21:9      Did you really mean 'messageId'?
	- 35:9      Did you really mean 'messageId'?
	- 49:55     Did you really mean 'pinner'?
	- 49:153    Did you really mean 'pinner'?
	- 89:9      Did you really mean 'messagesRequest'?
	- 108:9     Did you really mean 'messagesRequest'?
	- 171:52    Did you really mean 'pinner'?
	- 221:9     Did you really mean 'systemLimit'?

sdk/javascript/save-message.mdx:
	- 3:24      Did you really mean 'unsave'?
	- 20:9      Did you really mean 'messageId'?
	- 34:9      Did you really mean 'messageId'?
	- 50:4      Did you really mean 'Unsave'?
	- 88:9      Did you really mean 'messagesRequest'?
	- 106:9     Did you really mean 'messagesRequest'?
	- 180:10    Did you really mean 'unsave'?

sdk/javascript/thread-subscription.mdx:
	- 142:77    Did you really mean 'else's'?
	- 221:9     Did you really mean 'threadsRequest'?
	- 239:9     Did you really mean 'threadsRequest'?

sdk/javascript/threaded-messages.mdx:
	- 15:5      Did you really mean 'receiverId'?
	- 16:3      Did you really mean 'receiverType'?
	- 17:3      Did you really mean 'textMessage'?
	- 17:87     Did you really mean 'receiverType'?
	- 18:3      Did you really mean 'messageId'?
	- 73:26     Did you really mean 'mediaMessage'?
	- 78:27     Did you really mean 'customMessage'?
	- 130:3     Did you really mean 'messagesRequest'?
	- 178:5     Did you really mean 'messagesRequest'?
	- 190:5     Did you really mean 'messagesRequest'?
	- 205:64    Did you really mean 'unfollow'?
	- 249:3     Did you really mean 'messagesRequest'?
	- 292:3     Did you really mean 'messagesRequest'?
	- 336:83    Did you really mean 'unmount'?


Found 224 suggested changes across 7 files in 1403.86ms

Annotations

Check warning on line 38 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L38

Did you really mean 'offlineUser'?

Check warning on line 40 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L40

Did you really mean 'offlineUser'?

Check warning on line 95 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L95

Did you really mean 'joinedUser'?

Check warning on line 95 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L95

Did you really mean 'joinedGroup'?

Check warning on line 96 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L96

Did you really mean 'leftUser'?

Check warning on line 96 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L96

Did you really mean 'leftGroup'?

Check warning on line 97 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L97

Did you really mean 'kickedUser'?

Check warning on line 97 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L97

Did you really mean 'kickedBy'?

Check warning on line 97 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L97

Did you really mean 'kickedFrom'?

Check warning on line 98 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L98

Did you really mean 'bannedUser'?

Check warning on line 98 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L98

Did you really mean 'bannedBy'?

Check warning on line 98 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L98

Did you really mean 'bannedFrom'?

Check warning on line 99 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L99

Did you really mean 'unbannedUser'?

Check warning on line 99 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L99

Did you really mean 'unbannedBy'?

Check warning on line 99 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L99

Did you really mean 'unbannedFrom'?

Check warning on line 100 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L100

Did you really mean 'changedUser'?

Check warning on line 100 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L100

Did you really mean 'newScope'?

Check warning on line 100 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L100

Did you really mean 'oldScope'?

Check warning on line 100 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L100

Did you really mean 'changedGroup'?

Check warning on line 101 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L101

Did you really mean 'userAdded'?

Check warning on line 101 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L101

Did you really mean 'addedBy'?

Check warning on line 101 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L101

Did you really mean 'addedTo'?

Check warning on line 120 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L120

Did you really mean 'leftUser'?

Check warning on line 121 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L121

Did you really mean 'leftGroup'?

Check warning on line 123 in sdk/javascript/all-real-time-listeners.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

sdk/javascript/all-real-time-listeners.mdx#L123

Did you really mean 'leftUser'?