@cometchat/chat-sdk-javascript 4.0.4 → 4.0.5
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/CometChat.d.ts +46 -0
- package/CometChat.js +1 -1
- package/README.md +6 -60
- package/package.json +1 -1
package/CometChat.d.ts
CHANGED
|
@@ -3766,6 +3766,7 @@ export class Group {
|
|
|
3766
3766
|
private joinedAt;
|
|
3767
3767
|
private membersCount;
|
|
3768
3768
|
private tags;
|
|
3769
|
+
private isBanned;
|
|
3769
3770
|
/**
|
|
3770
3771
|
* Creates an instance of Group.
|
|
3771
3772
|
* @param {string} guid
|
|
@@ -3931,6 +3932,11 @@ export class Group {
|
|
|
3931
3932
|
* @returns {string[]}
|
|
3932
3933
|
*/
|
|
3933
3934
|
getTags(): Array<String>;
|
|
3935
|
+
/**
|
|
3936
|
+
* Method to check if the logged-in user is banned from the group or not.
|
|
3937
|
+
* @returns {boolean} status of the logged-in user as banned or not.
|
|
3938
|
+
*/
|
|
3939
|
+
isBannedFromGroup(): boolean;
|
|
3934
3940
|
}
|
|
3935
3941
|
|
|
3936
3942
|
export class MessageListener {
|
|
@@ -5218,6 +5224,46 @@ export class TypingIndicator {
|
|
|
5218
5224
|
export class CustomMessage extends BaseMessage implements Message {
|
|
5219
5225
|
protected data?: Object;
|
|
5220
5226
|
constructor(...args: any[]);
|
|
5227
|
+
/**
|
|
5228
|
+
* Retrieves the preview text for a custom message to be displayed in the Conversation List.
|
|
5229
|
+
* This method allows for a textual representation of the custom message that can be used
|
|
5230
|
+
* as a conversation snippet or preview, enhancing the user experience by providing context.
|
|
5231
|
+
* @returns {string} The text to display as the conversation preview.
|
|
5232
|
+
*/
|
|
5233
|
+
getConversationText(): string;
|
|
5234
|
+
/**
|
|
5235
|
+
* Sets the preview text for a custom message to be displayed in the Conversation List.
|
|
5236
|
+
* This method allows for a textual representation of the custom message that can be used
|
|
5237
|
+
* as a conversation snippet or preview, enhancing the user experience by providing context.
|
|
5238
|
+
* @param {string} text The text to set as the conversation preview.
|
|
5239
|
+
*/
|
|
5240
|
+
setConversationText(text: string): void;
|
|
5241
|
+
/**
|
|
5242
|
+
* Determines whether the custom message should be considered as the last message
|
|
5243
|
+
* in the conversation, potentially changing the order of conversations.
|
|
5244
|
+
* This method indicates if sending a custom message will update the conversation's last message,
|
|
5245
|
+
* which may affect the conversation's position in the list based on the sorting order.
|
|
5246
|
+
* @returns {boolean} A boolean value indicating whether sending the custom message triggers an update
|
|
5247
|
+
* to the last message of the conversation, potentially altering the conversation order.
|
|
5248
|
+
*/
|
|
5249
|
+
willUpdateConversation(): boolean;
|
|
5250
|
+
/**
|
|
5251
|
+
* Set the flag to determine if the conversation should be updated.
|
|
5252
|
+
* @param {boolean} updateConversation The flag to set if the conversation should be updated.
|
|
5253
|
+
*/
|
|
5254
|
+
shouldUpdateConversation(updateConversation: boolean): void;
|
|
5255
|
+
/**
|
|
5256
|
+
* Determines whether a push notification should be sent for the custom message.
|
|
5257
|
+
* This method checks if the current custom message configuration specifies that a push notification
|
|
5258
|
+
* is warranted when the message is sent.
|
|
5259
|
+
* @returns {boolean} A boolean value indicating whether to send a push notification for the custom message.
|
|
5260
|
+
*/
|
|
5261
|
+
willSendNotification(): boolean;
|
|
5262
|
+
/**
|
|
5263
|
+
* Set the flag to determine if a notification should be sent.
|
|
5264
|
+
* @param {boolean} sendNotification The flag to set if a notification should be sent.
|
|
5265
|
+
*/
|
|
5266
|
+
shouldSendNotification(sendNotification: boolean): void;
|
|
5221
5267
|
/**
|
|
5222
5268
|
* Method to get custom data of the message.
|
|
5223
5269
|
* @returns {Object}
|