@cometchat/chat-sdk-javascript 4.0.3 → 4.0.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/CometChat.d.ts +573 -76
- package/CometChat.js +1 -1
- package/package.json +1 -1
package/CometChat.d.ts
CHANGED
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
*/
|
|
10
10
|
export function init(appId: string): CometChat;
|
|
11
11
|
export as namespace CometChat;
|
|
12
|
+
export as namespace CometChatNotifications;
|
|
12
13
|
|
|
13
14
|
export class CometChat {
|
|
14
15
|
static GroupType: typeof GroupType;
|
|
@@ -388,7 +389,6 @@ export class CometChat {
|
|
|
388
389
|
HIDE_DELETED_MESSAGES: string;
|
|
389
390
|
WITH_TAGS: string;
|
|
390
391
|
TAGS: string;
|
|
391
|
-
MY_MENTIONS_ONLY: string;
|
|
392
392
|
MENTIONS_WITH_TAG_INFO: string;
|
|
393
393
|
MENTIONS_WITH_BLOCKED_INFO: string;
|
|
394
394
|
ONLY_INTERACTION_GOAL_COMPLETED: string;
|
|
@@ -892,6 +892,7 @@ export class CometChat {
|
|
|
892
892
|
REGION_DEFAULT_US: string;
|
|
893
893
|
REGION_DEFAULT_IN: string;
|
|
894
894
|
REGION_DEFAULT_PRIVATE: string;
|
|
895
|
+
REACTIONS_MAX_LIMIT: number;
|
|
895
896
|
};
|
|
896
897
|
static DELIVERY_RECEIPTS: {
|
|
897
898
|
RECEIVER_ID: string;
|
|
@@ -974,14 +975,17 @@ export class CometChat {
|
|
|
974
975
|
static User: typeof User;
|
|
975
976
|
static GroupMember: typeof GroupMember;
|
|
976
977
|
static Conversation: typeof Conversation;
|
|
978
|
+
static ReactionCount: typeof ReactionCount;
|
|
979
|
+
static ReactionEvent: typeof ReactionEvent;
|
|
980
|
+
static Reaction: typeof Reaction;
|
|
977
981
|
static USER_STATUS: {
|
|
978
982
|
ONLINE: string;
|
|
979
983
|
OFFLINE: string;
|
|
980
984
|
};
|
|
981
985
|
static MessagesRequest: typeof MessagesRequest;
|
|
982
986
|
static MessagesRequestBuilder: typeof MessagesRequestBuilder;
|
|
983
|
-
static
|
|
984
|
-
static
|
|
987
|
+
static ReactionsRequest: typeof ReactionsRequest;
|
|
988
|
+
static ReactionsRequestBuilder: typeof ReactionsRequestBuilder;
|
|
985
989
|
static UsersRequest: typeof UsersRequest;
|
|
986
990
|
static UsersRequestBuilder: typeof UsersRequestBuilder;
|
|
987
991
|
static ConversationsRequest: typeof ConversationsRequest;
|
|
@@ -1964,6 +1968,78 @@ export class CometChat {
|
|
|
1964
1968
|
static markAsInteracted(messageId: string | any, elementId: string): Promise<string>;
|
|
1965
1969
|
}
|
|
1966
1970
|
|
|
1971
|
+
export class CometChatNotifications {
|
|
1972
|
+
static MessagesOptions: typeof MessagesOptions;
|
|
1973
|
+
static RepliesOptions: typeof RepliesOptions;
|
|
1974
|
+
static ReactionsOptions: typeof ReactionsOptions;
|
|
1975
|
+
static MemberActionsOptions: typeof MemberActionsOptions;
|
|
1976
|
+
static DayOfWeek: typeof DayOfWeek;
|
|
1977
|
+
static DNDOptions: typeof DNDOptions;
|
|
1978
|
+
static MutedConversationType: typeof MutedConversationType;
|
|
1979
|
+
static PushPlatforms: typeof PushPlatforms;
|
|
1980
|
+
static DaySchedule: typeof DaySchedule;
|
|
1981
|
+
static PushPreferences: typeof PushPreferences;
|
|
1982
|
+
static GroupPreferences: typeof GroupPreferences;
|
|
1983
|
+
static OneOnOnePreferences: typeof OneOnOnePreferences;
|
|
1984
|
+
static MutePreferences: typeof MutePreferences;
|
|
1985
|
+
static MutedConversation: typeof MutedConversation;
|
|
1986
|
+
static UnmutedConversation: typeof UnmutedConversation;
|
|
1987
|
+
/**
|
|
1988
|
+
* Function to get preferences set for the logged-in user.
|
|
1989
|
+
* @returns {Promise<PushPreferences>}
|
|
1990
|
+
* @memberof CometChatNotifications
|
|
1991
|
+
*/
|
|
1992
|
+
static fetchPushPreferences(): Promise<PushPreferences>;
|
|
1993
|
+
/**
|
|
1994
|
+
* Function to update preferences for the logged-in user.
|
|
1995
|
+
* @param {PushPreferences} pushPreferences
|
|
1996
|
+
* @returns {Promise<PushPreferences>}
|
|
1997
|
+
* @memberof CometChatNotifications
|
|
1998
|
+
*/
|
|
1999
|
+
static updatePushPreferences(pushPreferences: PushPreferences): Promise<PushPreferences>;
|
|
2000
|
+
/**
|
|
2001
|
+
* Function to reset preferences for the logged-in user.
|
|
2002
|
+
* @returns {Promise<PushPreferences>}
|
|
2003
|
+
* @memberof CometChatNotifications
|
|
2004
|
+
*/
|
|
2005
|
+
static resetPushPreferences(): Promise<PushPreferences>;
|
|
2006
|
+
/**
|
|
2007
|
+
* Function to register push token for the current authToken of the logged-in user.
|
|
2008
|
+
* @returns {Promise<string>}
|
|
2009
|
+
* @param {string} pushToken
|
|
2010
|
+
* @param {PushPlatforms} platform
|
|
2011
|
+
* @param {string} providerId - Optional, default value is `default`.
|
|
2012
|
+
* @memberof CometChatNotifications
|
|
2013
|
+
*/
|
|
2014
|
+
static registerPushToken(pushToken: string, platform: PushPlatforms, providerId?: string): Promise<string>;
|
|
2015
|
+
/**
|
|
2016
|
+
* Function to unregister push token registered for the current authToken of the logged-in user.
|
|
2017
|
+
* @returns {Promise<string>}
|
|
2018
|
+
* @memberof CometChatNotifications
|
|
2019
|
+
*/
|
|
2020
|
+
static unregisterPushToken(): Promise<string>;
|
|
2021
|
+
/**
|
|
2022
|
+
* Function to mute conversations for the logged-in user.
|
|
2023
|
+
* @returns {Promise<string>}
|
|
2024
|
+
* @param {MutedConversation[]} mutedConversations
|
|
2025
|
+
* @memberof CometChatNotifications
|
|
2026
|
+
*/
|
|
2027
|
+
static muteConversations(mutedConversations: MutedConversation[]): Promise<string>;
|
|
2028
|
+
/**
|
|
2029
|
+
* Function to unmute conversations for the logged-in user.
|
|
2030
|
+
* @returns {Promise<string>}
|
|
2031
|
+
* @param {UnmutedConversation[]} unmutedConversations
|
|
2032
|
+
* @memberof CometChatNotifications
|
|
2033
|
+
*/
|
|
2034
|
+
static unmuteConversations(unmutedConversations: UnmutedConversation[]): Promise<string>;
|
|
2035
|
+
/**
|
|
2036
|
+
* Function to retrieve list of muted conversations for the logged-in user.
|
|
2037
|
+
* @returns {Promise<MutedConversation[]>}
|
|
2038
|
+
* @memberof CometChatNotifications
|
|
2039
|
+
*/
|
|
2040
|
+
static getMutedConversations(): Promise<MutedConversation[]>;
|
|
2041
|
+
}
|
|
2042
|
+
|
|
1967
2043
|
/**
|
|
1968
2044
|
*
|
|
1969
2045
|
* @module CometChatException
|
|
@@ -2549,7 +2625,7 @@ export class BaseMessage implements Message {
|
|
|
2549
2625
|
setData(value: object): void;
|
|
2550
2626
|
/**
|
|
2551
2627
|
* set the array of reactions in message
|
|
2552
|
-
* @
|
|
2628
|
+
* @param {ReactionCount[]} reactions
|
|
2553
2629
|
*/
|
|
2554
2630
|
setReactions(reactions: any): ReactionCount[];
|
|
2555
2631
|
/**
|
|
@@ -2662,6 +2738,7 @@ export const DEFAULT_VALUES: {
|
|
|
2662
2738
|
REGION_DEFAULT_US: string;
|
|
2663
2739
|
REGION_DEFAULT_IN: string;
|
|
2664
2740
|
REGION_DEFAULT_PRIVATE: string;
|
|
2741
|
+
REACTIONS_MAX_LIMIT: number;
|
|
2665
2742
|
};
|
|
2666
2743
|
export const CALLING_COMPONENT_VERSION = 5;
|
|
2667
2744
|
export enum GroupType {
|
|
@@ -2884,7 +2961,6 @@ export const MessageConstatnts: {
|
|
|
2884
2961
|
HIDE_DELETED_MESSAGES: string;
|
|
2885
2962
|
WITH_TAGS: string;
|
|
2886
2963
|
TAGS: string;
|
|
2887
|
-
MY_MENTIONS_ONLY: string;
|
|
2888
2964
|
MENTIONS_WITH_TAG_INFO: string;
|
|
2889
2965
|
MENTIONS_WITH_BLOCKED_INFO: string;
|
|
2890
2966
|
ONLY_INTERACTION_GOAL_COMPLETED: string;
|
|
@@ -4946,7 +5022,6 @@ export class MessagesRequestBuilder {
|
|
|
4946
5022
|
/** @private */ tags?: Array<String>;
|
|
4947
5023
|
/** @private */ WithTags?: boolean;
|
|
4948
5024
|
/** @private */ interactionGoalCompletedOnly?: boolean;
|
|
4949
|
-
/** @private */ ListMentionedMessages?: boolean;
|
|
4950
5025
|
/** @private */ mentionsWithUserTags?: boolean;
|
|
4951
5026
|
/** @private */ mentionsWithBlockedRelation?: boolean;
|
|
4952
5027
|
/**
|
|
@@ -5063,12 +5138,6 @@ export class MessagesRequestBuilder {
|
|
|
5063
5138
|
* @returns
|
|
5064
5139
|
*/
|
|
5065
5140
|
withTags(withTags: boolean): this;
|
|
5066
|
-
/**
|
|
5067
|
-
* A method to get the list of message with mentions
|
|
5068
|
-
* @param {boolean} listMentionedMessages
|
|
5069
|
-
* @returns
|
|
5070
|
-
*/
|
|
5071
|
-
myMentionsOnly(listMentionedMessages?: boolean): this;
|
|
5072
5141
|
/**
|
|
5073
5142
|
* A method to include the user tags when getting the list of message with mentions
|
|
5074
5143
|
* @param {boolean} mentionsWithUserTags
|
|
@@ -5456,7 +5525,7 @@ export class CometChatHelper {
|
|
|
5456
5525
|
* @memberof CometChat
|
|
5457
5526
|
*/
|
|
5458
5527
|
static getConversationFromMessage(message: TextMessage | MediaMessage | CustomMessage | InteractiveMessage | any): Promise<Conversation>;
|
|
5459
|
-
static updateMessageWithReactionInfo(baseMessage: BaseMessage, messageReaction:
|
|
5528
|
+
static updateMessageWithReactionInfo(baseMessage: BaseMessage, messageReaction: Reaction, action: REACTION_ACTION): BaseMessage | CometChatException;
|
|
5460
5529
|
}
|
|
5461
5530
|
|
|
5462
5531
|
/**
|
|
@@ -6326,25 +6395,25 @@ export class InteractionReceipt {
|
|
|
6326
6395
|
setInteractions(interactions: Array<Interaction>): void;
|
|
6327
6396
|
}
|
|
6328
6397
|
|
|
6329
|
-
export class
|
|
6330
|
-
constructor(builder?:
|
|
6398
|
+
export class ReactionsRequest {
|
|
6399
|
+
constructor(builder?: ReactionsRequestBuilder);
|
|
6331
6400
|
/**
|
|
6332
|
-
* Get list of next reactions list based on the parameters specified in
|
|
6333
|
-
* @returns {Promise<
|
|
6401
|
+
* Get list of next reactions list based on the parameters specified in ReactionsRequestBuilder class. The Developer need to call this method repeatedly using the same object of ReactionsRequest class to get paginated list of reactions.
|
|
6402
|
+
* @returns {Promise<Reaction[] | []>}
|
|
6334
6403
|
*/
|
|
6335
|
-
fetchNext(): Promise<
|
|
6404
|
+
fetchNext(): Promise<Reaction[] | []>;
|
|
6336
6405
|
/**
|
|
6337
|
-
* Get list of previous reactions list based on the parameters specified in
|
|
6338
|
-
* @returns {Promise<
|
|
6406
|
+
* Get list of previous reactions list based on the parameters specified in ReactionsRequestBuilder class. The Developer need to call this method repeatedly using the same object of ReactionsRequest class to get paginated list of reactions.
|
|
6407
|
+
* @returns {Promise<Reaction[] | []>}
|
|
6339
6408
|
*/
|
|
6340
|
-
fetchPrevious(): Promise<
|
|
6409
|
+
fetchPrevious(): Promise<Reaction[] | []>;
|
|
6341
6410
|
}
|
|
6342
|
-
export class
|
|
6411
|
+
export class ReactionsRequestBuilder {
|
|
6343
6412
|
/** @private */ limit?: number;
|
|
6344
6413
|
/** @private */ msgId: number;
|
|
6345
6414
|
/** @private */ reaction?: string;
|
|
6346
6415
|
/**
|
|
6347
|
-
* A method to set limit for the number of entries returned in a single iteration. A maximum of
|
|
6416
|
+
* A method to set limit for the number of entries returned in a single iteration. A maximum of 20 entries can fetched in a single iteration.
|
|
6348
6417
|
* @param {number} limit
|
|
6349
6418
|
* @returns
|
|
6350
6419
|
*/
|
|
@@ -6356,15 +6425,492 @@ export class ReactionRequestBuilder {
|
|
|
6356
6425
|
*/
|
|
6357
6426
|
setMessageId(id?: number): this;
|
|
6358
6427
|
/**
|
|
6359
|
-
* A method to fetch list of
|
|
6428
|
+
* A method to fetch list of Reaction for a specific reaction.
|
|
6360
6429
|
* @returns
|
|
6361
6430
|
*/
|
|
6362
6431
|
setReaction(reaction: string): this;
|
|
6363
6432
|
/**
|
|
6364
|
-
* This method will return an object of the
|
|
6365
|
-
* @returns {
|
|
6433
|
+
* This method will return an object of the ReactionsRequest class.
|
|
6434
|
+
* @returns {ReactionsRequest}
|
|
6366
6435
|
*/
|
|
6367
|
-
build():
|
|
6436
|
+
build(): ReactionsRequest;
|
|
6437
|
+
}
|
|
6438
|
+
|
|
6439
|
+
export class ReactionCount {
|
|
6440
|
+
constructor(reaction: string, count: number, reactedByMe: boolean);
|
|
6441
|
+
/**
|
|
6442
|
+
* Method to get reacted reaction.
|
|
6443
|
+
* @returns {string}
|
|
6444
|
+
*/
|
|
6445
|
+
getReaction(): string;
|
|
6446
|
+
/**
|
|
6447
|
+
* Method to set reacted reaction.
|
|
6448
|
+
*/
|
|
6449
|
+
setReaction(reaction: string): void;
|
|
6450
|
+
/**
|
|
6451
|
+
* Method to get no of users reacted with a reaction.
|
|
6452
|
+
* @returns {number}
|
|
6453
|
+
*/
|
|
6454
|
+
getCount(): number;
|
|
6455
|
+
/**
|
|
6456
|
+
* Method to set no of users reacted with a reaction.
|
|
6457
|
+
*/
|
|
6458
|
+
setCount(count: number): void;
|
|
6459
|
+
/**
|
|
6460
|
+
* Method to get if loggedIn user reacted with the a reaction.
|
|
6461
|
+
* @returns {boolean}
|
|
6462
|
+
*/
|
|
6463
|
+
getReactedByMe(): boolean;
|
|
6464
|
+
/**
|
|
6465
|
+
* Method to set if loggedIn user reacted with the a reaction.
|
|
6466
|
+
*/
|
|
6467
|
+
setReactedByMe(reactedByMe: boolean): void;
|
|
6468
|
+
}
|
|
6469
|
+
|
|
6470
|
+
export class ReactionEvent {
|
|
6471
|
+
constructor(reaction: Reaction, receiverId: string, receiverType: string, conversationId: string, parentMessageId?: string);
|
|
6472
|
+
getReaction(): Reaction;
|
|
6473
|
+
setReaction(reaction: Reaction): void;
|
|
6474
|
+
getReceiverId(): string;
|
|
6475
|
+
setReceiverId(receiverId: string): void;
|
|
6476
|
+
getReceiverType(): string;
|
|
6477
|
+
setReceiverType(receiverType: string): void;
|
|
6478
|
+
getConversationId(): string;
|
|
6479
|
+
setConversationId(conversationId: string): void;
|
|
6480
|
+
getParentMessageId(): string;
|
|
6481
|
+
setParentMessageId(parentMessageId: string): void;
|
|
6482
|
+
}
|
|
6483
|
+
|
|
6484
|
+
export class Reaction {
|
|
6485
|
+
constructor(reactionId: string, messageId: string, reaction: string, uid: string, reactedAt: number, reactedBy: User);
|
|
6486
|
+
getReactionId(): string;
|
|
6487
|
+
setReactionId(id: string): void;
|
|
6488
|
+
getMessageId(): string;
|
|
6489
|
+
setMessageId(messageId: string): void;
|
|
6490
|
+
getReaction(): string;
|
|
6491
|
+
setReaction(reaction: string): void;
|
|
6492
|
+
getUid(): string;
|
|
6493
|
+
setUid(uid: string): void;
|
|
6494
|
+
getReactedAt(): number;
|
|
6495
|
+
setReactedAt(reactedAt: number): void;
|
|
6496
|
+
getReactedBy(): User;
|
|
6497
|
+
setReactedBy(reactedBy: User): void;
|
|
6498
|
+
}
|
|
6499
|
+
|
|
6500
|
+
/** Push Notification Preferences Enums */
|
|
6501
|
+
export enum MessagesOptions {
|
|
6502
|
+
DONT_SUBSCRIBE,
|
|
6503
|
+
SUBSCRIBE_TO_ALL,
|
|
6504
|
+
SUBSCRIBE_TO_MENTIONS
|
|
6505
|
+
}
|
|
6506
|
+
export enum RepliesOptions {
|
|
6507
|
+
DONT_SUBSCRIBE,
|
|
6508
|
+
SUBSCRIBE_TO_ALL,
|
|
6509
|
+
SUBSCRIBE_TO_MENTIONS
|
|
6510
|
+
}
|
|
6511
|
+
export enum ReactionsOptions {
|
|
6512
|
+
DONT_SUBSCRIBE,
|
|
6513
|
+
SUBSCRIBE_TO_REACTIONS_ON_OWN_MESSAGES,
|
|
6514
|
+
SUBSCRIBE_TO_REACTIONS_ON_ALL_MESSAGES
|
|
6515
|
+
}
|
|
6516
|
+
export enum MemberActionsOptions {
|
|
6517
|
+
DONT_SUBSCRIBE,
|
|
6518
|
+
SUBSCRIBE
|
|
6519
|
+
}
|
|
6520
|
+
export enum DNDOptions {
|
|
6521
|
+
DISABLED,
|
|
6522
|
+
ENABLED
|
|
6523
|
+
}
|
|
6524
|
+
export enum DayOfWeek {
|
|
6525
|
+
MONDAY = "monday",
|
|
6526
|
+
TUESDAY = "tuesday",
|
|
6527
|
+
WEDNESDAY = "wednesday",
|
|
6528
|
+
THURSDAY = "thursday",
|
|
6529
|
+
FRIDAY = "friday",
|
|
6530
|
+
SATURDAY = "saturday",
|
|
6531
|
+
SUNDAY = "sunday"
|
|
6532
|
+
}
|
|
6533
|
+
export enum MutedConversationType {
|
|
6534
|
+
ONE_ON_ONE = "oneOnOne",
|
|
6535
|
+
GROUP = "group"
|
|
6536
|
+
}
|
|
6537
|
+
export enum PushPlatforms {
|
|
6538
|
+
FCM_WEB = "fcm_web"
|
|
6539
|
+
}
|
|
6540
|
+
export const APIConstants: {
|
|
6541
|
+
KEY_GROUP_PREFERENCES: string;
|
|
6542
|
+
KEY_GROUP_MESSAGES: string;
|
|
6543
|
+
KEY_GROUP_REACTIONS: string;
|
|
6544
|
+
KEY_GROUP_REPLIES: string;
|
|
6545
|
+
KEY_GROUP_MEMBER_ADDED: string;
|
|
6546
|
+
KEY_GROUP_MEMBER_LEFT: string;
|
|
6547
|
+
KEY_GROUP_MEMBER_JOINED: string;
|
|
6548
|
+
KEY_GROUP_MEMBER_KICKED: string;
|
|
6549
|
+
KEY_GROUP_MEMBER_BANNED: string;
|
|
6550
|
+
KEY_GROUP_MEMBER_UNBANNED: string;
|
|
6551
|
+
KEY_GROUP_MEMBER_SCOPE_CHANGED: string;
|
|
6552
|
+
KEY_MUTE_PREFERENCES: string;
|
|
6553
|
+
KEY_MUTE_DND: string;
|
|
6554
|
+
KEY_MUTE_SCHEDULE: string;
|
|
6555
|
+
KEY_ONE_ON_ONE_PREFERENCES: string;
|
|
6556
|
+
KEY_ONE_ON_ONE_MESSAGES: string;
|
|
6557
|
+
KEY_ONE_ON_ONE_REACTIONS: string;
|
|
6558
|
+
KEY_ONE_ON_ONE_REPLIES: string;
|
|
6559
|
+
KEY_USE_PRIVACY_TEMPLATE: string;
|
|
6560
|
+
KEY_PROVIDER_ID: string;
|
|
6561
|
+
KEY_TIMEZONE: string;
|
|
6562
|
+
KEY_PLATFORM: string;
|
|
6563
|
+
KEY_FCM_TOKEN: string;
|
|
6564
|
+
KEY_CONVERSATIONS: string;
|
|
6565
|
+
KEY_GET_PREFERENCES: string;
|
|
6566
|
+
KEY_UPDATE_PREFERENCES: string;
|
|
6567
|
+
KEY_RESET_PREFERENCES: string;
|
|
6568
|
+
KEY_REGISTER_TOKEN: string;
|
|
6569
|
+
KEY_UNREGISTER_TOKEN: string;
|
|
6570
|
+
KEY_MUTE_CONVERSATIONS: string;
|
|
6571
|
+
KEY_UNMUTE_CONVERSATIONS: string;
|
|
6572
|
+
KEY_GET_MUTED_CONVERSATIONS: string;
|
|
6573
|
+
KEY_MUTED_CONVERSATIONS: string;
|
|
6574
|
+
KEY_FROM: string;
|
|
6575
|
+
KEY_TO: string;
|
|
6576
|
+
};
|
|
6577
|
+
export const APIResponseConstants: {
|
|
6578
|
+
TOKEN_REGISTER_SUCCESS: string;
|
|
6579
|
+
TOKEN_REGISTER_ERROR: string;
|
|
6580
|
+
TOKEN_UNREGISTER_SUCCESS: string;
|
|
6581
|
+
TOKEN_UNREGISTER_ERROR: string;
|
|
6582
|
+
MUTE_CONVERSATION_SUCCESS: string;
|
|
6583
|
+
MUTE_CONVERSATION_ERROR: string;
|
|
6584
|
+
UNMUTE_CONVERSATION_SUCCESS: string;
|
|
6585
|
+
UNMUTE_CONVERSATION_ERROR: string;
|
|
6586
|
+
};
|
|
6587
|
+
export const DEFAULT_PROVIDER_ID = "default";
|
|
6588
|
+
|
|
6589
|
+
export class DaySchedule {
|
|
6590
|
+
constructor(from: number, to: number, dnd: boolean);
|
|
6591
|
+
/**
|
|
6592
|
+
* Get the from value of Day Schedule.
|
|
6593
|
+
* @returns {number}
|
|
6594
|
+
*/
|
|
6595
|
+
getFrom(): number;
|
|
6596
|
+
/**
|
|
6597
|
+
* @param {number} from
|
|
6598
|
+
* Set the from value of Day Schedule.
|
|
6599
|
+
*/
|
|
6600
|
+
setFrom(from: number): void;
|
|
6601
|
+
/**
|
|
6602
|
+
* Get the to value of Day Schedule.
|
|
6603
|
+
* @returns {number}
|
|
6604
|
+
*/
|
|
6605
|
+
getTo(): number;
|
|
6606
|
+
/**
|
|
6607
|
+
* @param {number} to
|
|
6608
|
+
* Set the to value of Day Schedule.
|
|
6609
|
+
*/
|
|
6610
|
+
setTo(to: number): void;
|
|
6611
|
+
/**
|
|
6612
|
+
* Get the value of DND of Day Schedule.
|
|
6613
|
+
* @returns {boolean}
|
|
6614
|
+
*/
|
|
6615
|
+
getDND(): boolean;
|
|
6616
|
+
/**
|
|
6617
|
+
* @param {boolean} dnd
|
|
6618
|
+
* Set the value of DND of Day Schedule.
|
|
6619
|
+
*/
|
|
6620
|
+
setDND(dnd: boolean): void;
|
|
6621
|
+
}
|
|
6622
|
+
|
|
6623
|
+
/**
|
|
6624
|
+
*
|
|
6625
|
+
* @module GroupPreferences
|
|
6626
|
+
*/
|
|
6627
|
+
export class GroupPreferences {
|
|
6628
|
+
/**
|
|
6629
|
+
* Get the messages preferences for groups.
|
|
6630
|
+
* @returns {MessagesOptions}
|
|
6631
|
+
*/
|
|
6632
|
+
getMessagesPreference(): MessagesOptions;
|
|
6633
|
+
/**
|
|
6634
|
+
* Get the replies preferences for groups.
|
|
6635
|
+
* @returns {RepliesOptions}
|
|
6636
|
+
*/
|
|
6637
|
+
getRepliesPreference(): RepliesOptions;
|
|
6638
|
+
/**
|
|
6639
|
+
* Get the reactions preferences for groups.
|
|
6640
|
+
* @returns {ReactionsOptions}
|
|
6641
|
+
*/
|
|
6642
|
+
getReactionsPreference(): ReactionsOptions;
|
|
6643
|
+
/**
|
|
6644
|
+
* Get the member left preferences for groups.
|
|
6645
|
+
* @returns {MemberActionsOptions}
|
|
6646
|
+
*/
|
|
6647
|
+
getMemberLeftPreference(): MemberActionsOptions;
|
|
6648
|
+
/**
|
|
6649
|
+
* Get the member added preferences for groups.
|
|
6650
|
+
* @returns {MemberActionsOptions}
|
|
6651
|
+
*/
|
|
6652
|
+
getMemberAddedPreference(): MemberActionsOptions;
|
|
6653
|
+
/**
|
|
6654
|
+
* Get the member joined preferences for groups.
|
|
6655
|
+
* @returns {MemberActionsOptions}
|
|
6656
|
+
*/
|
|
6657
|
+
getMemberJoinedPreference(): MemberActionsOptions;
|
|
6658
|
+
/**
|
|
6659
|
+
* Get the member kicked preferences for groups.
|
|
6660
|
+
* @returns {MemberActionsOptions}
|
|
6661
|
+
*/
|
|
6662
|
+
getMemberKickedPreference(): MemberActionsOptions;
|
|
6663
|
+
/**
|
|
6664
|
+
* Get the member banned preferences for groups.
|
|
6665
|
+
* @returns {MemberActionsOptions}
|
|
6666
|
+
*/
|
|
6667
|
+
getMemberBannedPreference(): MemberActionsOptions;
|
|
6668
|
+
/**
|
|
6669
|
+
* Get the member unbanned preferences for groups.
|
|
6670
|
+
* @returns {MemberActionsOptions}
|
|
6671
|
+
*/
|
|
6672
|
+
getMemberUnbannedPreference(): MemberActionsOptions;
|
|
6673
|
+
/**
|
|
6674
|
+
* Get the member scope change preferences for groups.
|
|
6675
|
+
* @returns {MemberActionsOptions}
|
|
6676
|
+
*/
|
|
6677
|
+
getMemberScopeChangedPreference(): MemberActionsOptions;
|
|
6678
|
+
/**
|
|
6679
|
+
* @param {MessagesOptions} messagesPreference
|
|
6680
|
+
* Set messages preference for groups.
|
|
6681
|
+
*/
|
|
6682
|
+
setMessagesPreference(messagesPreference: MessagesOptions): void;
|
|
6683
|
+
/**
|
|
6684
|
+
* @param {RepliesOptions} repliesPreference
|
|
6685
|
+
* Set replies preference for groups.
|
|
6686
|
+
*/
|
|
6687
|
+
setRepliesPreference(repliesPreference: RepliesOptions): void;
|
|
6688
|
+
/**
|
|
6689
|
+
* @param {ReactionsOptions} reactionsPreference
|
|
6690
|
+
* Set reactions preference for groups.
|
|
6691
|
+
*/
|
|
6692
|
+
setReactionsPreference(reactionsPreference: ReactionsOptions): void;
|
|
6693
|
+
/**
|
|
6694
|
+
* @param {MemberActionsOptions} memberLeftPreference
|
|
6695
|
+
* Set member left preference for groups.
|
|
6696
|
+
*/
|
|
6697
|
+
setMemberLeftPreference(memberLeftPreference: MemberActionsOptions): void;
|
|
6698
|
+
/**
|
|
6699
|
+
* @param {MemberActionsOptions} memberAddedPreference
|
|
6700
|
+
* Set member added preference for groups.
|
|
6701
|
+
*/
|
|
6702
|
+
setMemberAddedPreference(memberAddedPreference: MemberActionsOptions): void;
|
|
6703
|
+
/**
|
|
6704
|
+
* @param {MemberActionsOptions} memberJoinedPreference
|
|
6705
|
+
* Set member joined preference for groups.
|
|
6706
|
+
*/
|
|
6707
|
+
setMemberJoinedPreference(memberJoinedPreference: MemberActionsOptions): void;
|
|
6708
|
+
/**
|
|
6709
|
+
* @param {MemberActionsOptions} memberKickedPreference
|
|
6710
|
+
* Set member kicked preference for groups.
|
|
6711
|
+
*/
|
|
6712
|
+
setMemberKickedPreference(memberKickedPreference: MemberActionsOptions): void;
|
|
6713
|
+
/**
|
|
6714
|
+
* @param {MemberActionsOptions} memberBannedPreference
|
|
6715
|
+
* Set member banned preference for groups.
|
|
6716
|
+
*/
|
|
6717
|
+
setMemberBannedPreference(memberBannedPreference: MemberActionsOptions): void;
|
|
6718
|
+
/**
|
|
6719
|
+
* @param {MemberActionsOptions} memberUnbannedPreference
|
|
6720
|
+
* Set member unbanned preference for groups.
|
|
6721
|
+
*/
|
|
6722
|
+
setMemberUnbannedPreference(memberUnbannedPreference: MemberActionsOptions): void;
|
|
6723
|
+
/**
|
|
6724
|
+
* @param {MemberActionsOptions} memberScopeChangedPreference
|
|
6725
|
+
* Set member scope change preference for groups.
|
|
6726
|
+
*/
|
|
6727
|
+
setMemberScopeChangedPreference(memberScopeChangedPreference: MemberActionsOptions): void;
|
|
6728
|
+
/**
|
|
6729
|
+
* @param {Object} jsonData
|
|
6730
|
+
* Convert JSON object to GroupPreferences.
|
|
6731
|
+
*/
|
|
6732
|
+
static fromJSON(jsonData: Object): GroupPreferences;
|
|
6733
|
+
}
|
|
6734
|
+
|
|
6735
|
+
export class MutedConversation {
|
|
6736
|
+
/**
|
|
6737
|
+
* Get the id of muted conversation
|
|
6738
|
+
* @returns {string}
|
|
6739
|
+
*/
|
|
6740
|
+
getId(): string;
|
|
6741
|
+
/**
|
|
6742
|
+
* Set the id of muted conversation
|
|
6743
|
+
* @param {string} id
|
|
6744
|
+
*/
|
|
6745
|
+
setId(id: string): void;
|
|
6746
|
+
/**
|
|
6747
|
+
* Get the conversation type of muted conversation.
|
|
6748
|
+
* @returns {MutedConversationType}
|
|
6749
|
+
*/
|
|
6750
|
+
getType(): MutedConversationType;
|
|
6751
|
+
/**
|
|
6752
|
+
* Set the conversation type of muted conversation.
|
|
6753
|
+
* @param {MutedConversationType} type
|
|
6754
|
+
*/
|
|
6755
|
+
setType(type: MutedConversationType): void;
|
|
6756
|
+
/**
|
|
6757
|
+
* Get the date until which the conversation should be muted.
|
|
6758
|
+
* @returns {number}
|
|
6759
|
+
*/
|
|
6760
|
+
getUntil(): number;
|
|
6761
|
+
/**
|
|
6762
|
+
* Set the date until which the conversation should be muted.
|
|
6763
|
+
* @param {number} until
|
|
6764
|
+
*/
|
|
6765
|
+
setUntil(until: number): void;
|
|
6766
|
+
}
|
|
6767
|
+
|
|
6768
|
+
export class MutePreferences {
|
|
6769
|
+
/**
|
|
6770
|
+
* Get the DND preferences.
|
|
6771
|
+
* @returns {DNDOptions}
|
|
6772
|
+
*/
|
|
6773
|
+
getDNDPreference(): DNDOptions;
|
|
6774
|
+
/**
|
|
6775
|
+
* @param {DNDOptions} dndPreferences
|
|
6776
|
+
* Set DND preferences.
|
|
6777
|
+
*/
|
|
6778
|
+
setDNDPreference(dndPreferences: DNDOptions): void;
|
|
6779
|
+
/**
|
|
6780
|
+
* Get the schedule preferences.
|
|
6781
|
+
* @returns {Map<DayOfWeek, DaySchedule>}
|
|
6782
|
+
*/
|
|
6783
|
+
getSchedulePreference(): Map<DayOfWeek, DaySchedule>;
|
|
6784
|
+
/**
|
|
6785
|
+
* @param {Map<DayOfWeek, DaySchedule>} schedule
|
|
6786
|
+
* Set the schedule preferences.
|
|
6787
|
+
*/
|
|
6788
|
+
setSchedulePreference(schedule: Map<DayOfWeek, DaySchedule>): void;
|
|
6789
|
+
/**
|
|
6790
|
+
* Get the schedule for a day.
|
|
6791
|
+
* @returns {DaySchedule}
|
|
6792
|
+
*/
|
|
6793
|
+
getScheduleFor(day: DayOfWeek): DaySchedule;
|
|
6794
|
+
/**
|
|
6795
|
+
* @param {DayOfWeek} day
|
|
6796
|
+
* @param {DaySchedule} schedule
|
|
6797
|
+
* Set the schedule for a day.
|
|
6798
|
+
*/
|
|
6799
|
+
setScheduleFor(day: DayOfWeek, schedule: DaySchedule): void;
|
|
6800
|
+
/**
|
|
6801
|
+
* @param {Object} jsonData
|
|
6802
|
+
* Convert JSON object to MutePreferences.
|
|
6803
|
+
*/
|
|
6804
|
+
static fromJSON(jsonData: Object): MutePreferences;
|
|
6805
|
+
}
|
|
6806
|
+
|
|
6807
|
+
export class OneOnOnePreferences {
|
|
6808
|
+
/**
|
|
6809
|
+
* Get the reactions preferences for groups.
|
|
6810
|
+
* @returns {ReactionsOptions}
|
|
6811
|
+
*/
|
|
6812
|
+
getReactionsPreference(): ReactionsOptions;
|
|
6813
|
+
/**
|
|
6814
|
+
* @param {ReactionsOptions} reactionsPreference
|
|
6815
|
+
* Set reactions preference for groups.
|
|
6816
|
+
*/
|
|
6817
|
+
setReactionsPreference(reactionsPreference: ReactionsOptions): void;
|
|
6818
|
+
/**
|
|
6819
|
+
* Get the replies preferences for groups.
|
|
6820
|
+
* @returns {RepliesOptions}
|
|
6821
|
+
*/
|
|
6822
|
+
getRepliesPreference(): RepliesOptions;
|
|
6823
|
+
/**
|
|
6824
|
+
* @param {RepliesOptions} repliesPreference
|
|
6825
|
+
* Set replies preference for groups.
|
|
6826
|
+
*/
|
|
6827
|
+
setRepliesPreference(repliesPreference: RepliesOptions): void;
|
|
6828
|
+
/**
|
|
6829
|
+
* Get the messages preferences for groups.
|
|
6830
|
+
* @returns {MessagesOptions}
|
|
6831
|
+
*/
|
|
6832
|
+
getMessagesPreference(): MessagesOptions;
|
|
6833
|
+
/**
|
|
6834
|
+
* @param {MessagesOptions} messagesPreference
|
|
6835
|
+
* Set messages preference for groups.
|
|
6836
|
+
*/
|
|
6837
|
+
setMessagesPreference(messagesPreference: MessagesOptions): void;
|
|
6838
|
+
/**
|
|
6839
|
+
* @param {Object} jsonData
|
|
6840
|
+
* Convert JSON object to OneOnOnePreferences.
|
|
6841
|
+
*/
|
|
6842
|
+
static fromJSON(jsonData: Object): OneOnOnePreferences;
|
|
6843
|
+
}
|
|
6844
|
+
|
|
6845
|
+
export class PushPreferences {
|
|
6846
|
+
/**
|
|
6847
|
+
* Get the OneOnOne preferences.
|
|
6848
|
+
* @returns {OneOnOnePreferences}
|
|
6849
|
+
*/
|
|
6850
|
+
getOneOnOnePreferences(): OneOnOnePreferences;
|
|
6851
|
+
/**
|
|
6852
|
+
* @param {OneOnOnePreferences} oneOnOnePreferences
|
|
6853
|
+
* Set the OneOnOne preferences.
|
|
6854
|
+
*/
|
|
6855
|
+
setOneOnOnePreferences(oneOnOnePreferences: OneOnOnePreferences): void;
|
|
6856
|
+
/**
|
|
6857
|
+
* Get the Muted preferences.
|
|
6858
|
+
* @returns {MutePreferences}
|
|
6859
|
+
*/
|
|
6860
|
+
getMutePreferences(): MutePreferences;
|
|
6861
|
+
/**
|
|
6862
|
+
* @param {MutePreferences} mutePreferences
|
|
6863
|
+
* Set the Mute preferences.
|
|
6864
|
+
*/
|
|
6865
|
+
setMutePreferences(mutePreferences: MutePreferences): void;
|
|
6866
|
+
/**
|
|
6867
|
+
* Get the Group preferences.
|
|
6868
|
+
* @returns {GroupPreferences}
|
|
6869
|
+
*/
|
|
6870
|
+
getGroupPreferences(): GroupPreferences;
|
|
6871
|
+
/**
|
|
6872
|
+
* @param {GroupPreferences} groupPreferences
|
|
6873
|
+
* Set the Group preferences.
|
|
6874
|
+
*/
|
|
6875
|
+
setGroupPreferences(groupPreferences: GroupPreferences): void;
|
|
6876
|
+
/**
|
|
6877
|
+
* Returns whether to use privacy template or not.
|
|
6878
|
+
* @returns {boolean}
|
|
6879
|
+
*/
|
|
6880
|
+
getUsePrivacyTemplate(): boolean;
|
|
6881
|
+
/**
|
|
6882
|
+
* @param {boolean} usePrivacyTemplate
|
|
6883
|
+
* Set whether to use privacy template or not.
|
|
6884
|
+
*/
|
|
6885
|
+
setUsePrivacyTemplate(usePrivacyTemplate: boolean): void;
|
|
6886
|
+
/**
|
|
6887
|
+
* @param {Object} jsonData
|
|
6888
|
+
* Convert JSON object to PushPreferences.
|
|
6889
|
+
*/
|
|
6890
|
+
static fromJSON(jsonData: Object): PushPreferences;
|
|
6891
|
+
}
|
|
6892
|
+
|
|
6893
|
+
export class UnmutedConversation {
|
|
6894
|
+
/**
|
|
6895
|
+
* Get the id of unmuted conversation
|
|
6896
|
+
* @returns {string}
|
|
6897
|
+
*/
|
|
6898
|
+
getId(): string;
|
|
6899
|
+
/**
|
|
6900
|
+
* Set the id of unmuted conversation
|
|
6901
|
+
* @param {string} id
|
|
6902
|
+
*/
|
|
6903
|
+
setId(id: string): void;
|
|
6904
|
+
/**
|
|
6905
|
+
* Get the conversation type of unmuted conversation.
|
|
6906
|
+
* @returns {MutedConversationType}
|
|
6907
|
+
*/
|
|
6908
|
+
getType(): MutedConversationType;
|
|
6909
|
+
/**
|
|
6910
|
+
* Set the conversation type of unmuted conversation.
|
|
6911
|
+
* @param {MutedConversationType} type
|
|
6912
|
+
*/
|
|
6913
|
+
setType(type: MutedConversationType): void;
|
|
6368
6914
|
}
|
|
6369
6915
|
|
|
6370
6916
|
/**
|
|
@@ -6471,55 +7017,6 @@ export class MessageReceipt {
|
|
|
6471
7017
|
setReceiptType(receiptType?: string): void;
|
|
6472
7018
|
}
|
|
6473
7019
|
|
|
6474
|
-
export class ReactionCount {
|
|
6475
|
-
reaction: string;
|
|
6476
|
-
count: number;
|
|
6477
|
-
reactedByMe?: boolean;
|
|
6478
|
-
constructor(object: any);
|
|
6479
|
-
/**
|
|
6480
|
-
* Method to get reacted reaction.
|
|
6481
|
-
* @returns {string}
|
|
6482
|
-
*/
|
|
6483
|
-
getReaction(): string;
|
|
6484
|
-
/**
|
|
6485
|
-
* Method to set reacted reaction.
|
|
6486
|
-
*/
|
|
6487
|
-
setReaction(reaction: string): void;
|
|
6488
|
-
/**
|
|
6489
|
-
* Method to get no of users reacted with a reaction.
|
|
6490
|
-
* @returns {number}
|
|
6491
|
-
*/
|
|
6492
|
-
getCount(): number;
|
|
6493
|
-
/**
|
|
6494
|
-
* Method to set no of users reacted with a reaction.
|
|
6495
|
-
*/
|
|
6496
|
-
setCount(count: number): void;
|
|
6497
|
-
/**
|
|
6498
|
-
* Method to get if loggedIn user reacted with the a reaction.
|
|
6499
|
-
* @returns {boolean}
|
|
6500
|
-
*/
|
|
6501
|
-
getReactedByMe(): boolean;
|
|
6502
|
-
/**
|
|
6503
|
-
* Method to set if loggedIn user reacted with the a reaction.
|
|
6504
|
-
*/
|
|
6505
|
-
setReactedByMe(reactedByMe: boolean): void;
|
|
6506
|
-
}
|
|
6507
|
-
export class MessageReaction {
|
|
6508
|
-
constructor(object: any);
|
|
6509
|
-
getReactionId(): string;
|
|
6510
|
-
setReactionId(id: string): void;
|
|
6511
|
-
getMessageId(): number | string;
|
|
6512
|
-
setMessageId(messageId: number | string): void;
|
|
6513
|
-
getReaction(): string;
|
|
6514
|
-
setReaction(reaction: string): void;
|
|
6515
|
-
getUid(): string;
|
|
6516
|
-
setUid(uid: string): void;
|
|
6517
|
-
getReactedAt(): number;
|
|
6518
|
-
setReactedAt(reactedAt: number): void;
|
|
6519
|
-
getReactedBy(): User;
|
|
6520
|
-
setReactedBy(reactedBy: User): void;
|
|
6521
|
-
}
|
|
6522
|
-
|
|
6523
7020
|
export class RTCUser {
|
|
6524
7021
|
constructor(uid: string);
|
|
6525
7022
|
setUID(uid: string): void;
|