@cometchat/chat-sdk-javascript 4.0.0 → 4.0.2

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.
Files changed (72) hide show
  1. package/{dist/index.d.ts → CometChat.d.ts} +444 -32
  2. package/CometChat.js +1 -0
  3. package/LICENSE.md +3 -0
  4. package/{readme.md → README.md} +8 -8
  5. package/package.json +31 -42
  6. package/dist/CometChat.js +0 -1
  7. package/dist/package.json +0 -36
  8. package/dist/type/index.d.ts +0 -10
  9. package/dist/type/lib/BannedMembersRequest.d.ts +0 -60
  10. package/dist/type/lib/BlockedUsersRequest.d.ts +0 -67
  11. package/dist/type/lib/CallSettings.d.ts +0 -429
  12. package/dist/type/lib/CometChat.d.ts +0 -1975
  13. package/dist/type/lib/CometChatErrorConstants.d.ts +0 -124
  14. package/dist/type/lib/CometChatHelper.d.ts +0 -26
  15. package/dist/type/lib/Constants.d.ts +0 -973
  16. package/dist/type/lib/ConversationRequest.d.ts +0 -89
  17. package/dist/type/lib/GroupMembersRequest.d.ts +0 -61
  18. package/dist/type/lib/GroupsRequest.d.ts +0 -78
  19. package/dist/type/lib/Helper.d.ts +0 -47
  20. package/dist/type/lib/ListenerHandlers.d.ts +0 -101
  21. package/dist/type/lib/MessagesRequest.d.ts +0 -188
  22. package/dist/type/lib/UsersRequest.d.ts +0 -142
  23. package/dist/type/lib/WebSockets/WSConnectionHelper.d.ts +0 -41
  24. package/dist/type/lib/WebSockets/WSConstants.d.ts +0 -71
  25. package/dist/type/lib/WebSockets/WSHelper.d.ts +0 -3
  26. package/dist/type/lib/controllers/CallController.d.ts +0 -151
  27. package/dist/type/lib/controllers/ConversationController.d.ts +0 -14
  28. package/dist/type/lib/controllers/GroupMemberController.d.ts +0 -10
  29. package/dist/type/lib/controllers/GroupsController.d.ts +0 -9
  30. package/dist/type/lib/controllers/MessageController.d.ts +0 -18
  31. package/dist/type/lib/controllers/PresenceController.d.ts +0 -0
  32. package/dist/type/lib/controllers/TypingNotificationController.d.ts +0 -14
  33. package/dist/type/lib/controllers/UserAuthController.d.ts +0 -10
  34. package/dist/type/lib/controllers/UsersController.d.ts +0 -9
  35. package/dist/type/lib/localStore/KeyStore.d.ts +0 -45
  36. package/dist/type/lib/localStore/MessageListenerEventMaping.d.ts +0 -56
  37. package/dist/type/lib/localStore/MessagesStore.d.ts +0 -72
  38. package/dist/type/lib/localStore/UserStore.d.ts +0 -72
  39. package/dist/type/lib/localStore/store.d.ts +0 -61
  40. package/dist/type/lib/models/Action.d.ts +0 -159
  41. package/dist/type/lib/models/AppSettings.d.ts +0 -135
  42. package/dist/type/lib/models/BaseMessage.d.ts +0 -259
  43. package/dist/type/lib/models/CCExtension.d.ts +0 -15
  44. package/dist/type/lib/models/Call.d.ts +0 -159
  45. package/dist/type/lib/models/CometChatAuthEvent.d.ts +0 -25
  46. package/dist/type/lib/models/CometChatEvent.d.ts +0 -25
  47. package/dist/type/lib/models/CometChatMessageEvent.d.ts +0 -9
  48. package/dist/type/lib/models/CometChatPingEvent.d.ts +0 -6
  49. package/dist/type/lib/models/CometChatPresenceEvent.d.ts +0 -15
  50. package/dist/type/lib/models/CometChatReceiptEvent.d.ts +0 -14
  51. package/dist/type/lib/models/CometChatTransientEvent.d.ts +0 -11
  52. package/dist/type/lib/models/CometChatTypingEvent.d.ts +0 -14
  53. package/dist/type/lib/models/ConversationModel.d.ts +0 -73
  54. package/dist/type/lib/models/CustomError.d.ts +0 -13
  55. package/dist/type/lib/models/CustomMessage.d.ts +0 -71
  56. package/dist/type/lib/models/ErrorModel.d.ts +0 -12
  57. package/dist/type/lib/models/Group.d.ts +0 -190
  58. package/dist/type/lib/models/GroupMember.d.ts +0 -43
  59. package/dist/type/lib/models/Listner.d.ts +0 -258
  60. package/dist/type/lib/models/MediaDevice.d.ts +0 -36
  61. package/dist/type/lib/models/MediaMessage.d.ts +0 -115
  62. package/dist/type/lib/models/MessageReceipt.d.ts +0 -99
  63. package/dist/type/lib/models/RTCUser.d.ts +0 -18
  64. package/dist/type/lib/models/TextMessage.d.ts +0 -84
  65. package/dist/type/lib/models/TransientMessage.d.ts +0 -48
  66. package/dist/type/lib/models/TypingNotification.d.ts +0 -52
  67. package/dist/type/lib/models/UserModel.d.ts +0 -177
  68. package/dist/type/lib/models/UserPresence.d.ts +0 -0
  69. package/dist/type/lib/models/attachment.d.ts +0 -74
  70. package/dist/type/lib/rest-api/EndPointUtils.d.ts +0 -9
  71. package/dist/type/lib/rest-api/EndpointFactory.d.ts +0 -28
  72. package/dist/type/lib/rest-api/HttpHelper.d.ts +0 -10
@@ -1,89 +0,0 @@
1
- import { Conversation } from './models/ConversationModel';
2
- export declare class ConversationsRequest {
3
- private limit;
4
- private next_page;
5
- private current_page;
6
- private total_pages;
7
- private conversationType;
8
- private fetchingInProgress;
9
- private getUserAndGroupTags;
10
- private tags;
11
- private withTags;
12
- private groupTags;
13
- private userTags;
14
- private pagination;
15
- private validateConversationBuilder;
16
- /**
17
- * @private
18
- * @param {ConversationsRequestBuilder} builder
19
- */
20
- constructor(builder?: ConversationsRequestBuilder);
21
- /**
22
- * Get list of next set of conversations based on the parameters specified in ConversationsRequestBuilder class. The Developer need to call this method repeatedly using the same object of ConversationsRequest class to get paginated list of conversations.
23
- * @returns {Promise<Conversation[] | []>}
24
- */
25
- fetchNext(): Promise<Conversation[] | []>;
26
- /**
27
- * @internal
28
- */
29
- getNextData(): any;
30
- }
31
- export declare class ConversationsRequestBuilder {
32
- /** @private */ conversationType: string;
33
- /** @private */ limit: number;
34
- /** @private */ getUserAndGroupTags: boolean;
35
- /** @private */ tags: Array<String>;
36
- /** @private */ WithTags: boolean;
37
- /** @private */ groupTags: Array<String>;
38
- /** @private */ userTags: Array<String>;
39
- /**
40
- *
41
- * @param {number} limit
42
- * A method to set limit for the number of Conversations returned in a single iteration. A maximum of 50 conversations can fetched in a single iteration.
43
- * @returns
44
- */
45
- setLimit(limit: number): this;
46
- /**
47
- *
48
- * @param {string} conversationType
49
- * A method to set the conversation type. It can take once of the two values: 1. 'user' - to fetch only the user conversations. 2. 'group' - to fetch only the group conversations.
50
- * @returns
51
- */
52
- setConversationType(conversationType: string): this;
53
- /**
54
- *
55
- * @param {boolean} getUserAndGroupTags
56
- * A method to fetch the user/group tags in the ConversationWith Object. The default value is false.
57
- * @returns
58
- */
59
- withUserAndGroupTags(getUserAndGroupTags: boolean): this;
60
- /**
61
- * A method to get conversations with the specified tags.
62
- * @param {Array<String>} tags
63
- * @returns
64
- */
65
- setTags(tags: Array<String>): this;
66
- /**
67
- * A method to get the tags along with conversations.
68
- * @param {boolean} withTags
69
- * @returns
70
- */
71
- withTags(withTags: boolean): this;
72
- /**
73
- * A method to filter conversation list by group tags.
74
- * @param {Array<String>} groupTags
75
- * @returns
76
- */
77
- setGroupTags(groupTags: Array<String>): this;
78
- /**
79
- * A method to filter conversation list by user tags.
80
- * @param {Array<String>} userTags
81
- * @returns
82
- */
83
- setUserTags(userTags: Array<String>): this;
84
- /**
85
- * This method will return an object of the ConversationsRequest class.
86
- * @returns {ConversationsRequest}
87
- */
88
- build(): ConversationsRequest;
89
- }
@@ -1,61 +0,0 @@
1
- import { GroupMember } from './models/GroupMember';
2
- export declare class GroupMembersRequest {
3
- private static MAX_LIMIT;
4
- private static DEFAULT_LIMIT;
5
- private limit;
6
- private guid;
7
- private cursor;
8
- private total;
9
- private searchKeyword;
10
- private next_page;
11
- private last_page;
12
- private current_page;
13
- private total_pages;
14
- private scopes?;
15
- private pagination;
16
- private store;
17
- constructor(builder: GroupMembersRequestBuilder);
18
- private validateGroupMembersBuilder;
19
- /**
20
- * Get list of next set of group members based on the parameters specified in GroupMembersRequestBuilder class. The Developer need to call this method repeatedly using the same object of GroupMembersRequest class to get paginated list of group members.
21
- * @returns {Promise<GroupMember[] | []>}
22
- */
23
- fetchNext(): Promise<GroupMember[] | []>;
24
- /**
25
- * @internal
26
- */
27
- getNextData(): any;
28
- }
29
- export declare class GroupMembersRequestBuilder {
30
- /** @private */ limit: number;
31
- /** @private */ searchKeyword: string;
32
- /** @private */ guid: string;
33
- /** @private */ scopes?: Array<String>;
34
- constructor(guid: string);
35
- /**
36
- *
37
- * @param {number} limit
38
- * A method to set limit for the number of group members returned in a single iteration. A maximum of 100 group members can fetched in a single iteration.
39
- * @returns
40
- */
41
- setLimit(limit: number): this;
42
- /**
43
- *
44
- * @param {string} searchKeyword
45
- * A method to set the search string based on which the group members are to be fetched.
46
- * @returns
47
- */
48
- setSearchKeyword(searchKeyword: string): this;
49
- /**
50
- *
51
- * @param {string[]} scopes
52
- * A method to set the search group members based on their scope.
53
- * @returns
54
- */
55
- setScopes(scopes: Array<String>): this;
56
- /**
57
- * This method will return an object of the GroupMembersRequest class.
58
- * @returns {GroupMembersRequest}
59
- */
60
- build(): GroupMembersRequest;
61
- }
@@ -1,78 +0,0 @@
1
- import { Group } from './models/Group';
2
- export declare class GroupsRequest {
3
- private static MAX_LIMIT;
4
- private static DEFAULT_LIMIT;
5
- private limit;
6
- private cursor;
7
- private total;
8
- private searchKeyword;
9
- private next_page;
10
- private last_page;
11
- private current_page;
12
- private total_pages;
13
- private hasJoined;
14
- private tags;
15
- private withTags;
16
- private pagination;
17
- private validateGroupBuilder;
18
- constructor(builder?: GroupsRequestBuilder);
19
- /**
20
- * Get list of next set of groups based on the parameters specified in GroupsRequestBuilder class The Developer need to call this method repeatedly using the same object of GroupsRequest class to get paginated list of groups.
21
- * @returns {Promise<Group[] | []>}
22
- */
23
- fetchNext(): Promise<Group[] | []>;
24
- /**
25
- * Create the pagination data to send with each request.
26
- *
27
- * @internal
28
- * @returns {*}
29
- * @memberof GroupsRequest
30
- */
31
- private getNextData;
32
- }
33
- export declare class GroupsRequestBuilder {
34
- /** @private */ limit: number;
35
- /** @private */ searchKeyword: string;
36
- /** @private */ hasJoined: boolean;
37
- /** @private */ tags: Array<String>;
38
- /** @private */ showTags: boolean;
39
- /**
40
- *
41
- * @param {number} limit
42
- * A method to set limit for the number of Groups returned in a single iteration. A maximum of 100 groups can fetched in a single iteration.
43
- * @returns
44
- */
45
- setLimit(limit: number): this;
46
- /**
47
- *
48
- * @param {string} searchKeyword
49
- * A method to set the search string based on which the groups are to be fetched.
50
- * @returns
51
- */
52
- setSearchKeyword(searchKeyword: string): this;
53
- /**
54
- * A method to fetch only joined groups.
55
- * @param {boolean} hasJoined
56
- * @returns
57
- */
58
- joinedOnly(hasJoined: boolean): this;
59
- /**
60
- *
61
- * @param {string[]} tags
62
- * A method to set the tags based on which the groups are to be fetched.
63
- * @returns
64
- */
65
- setTags(tags: Array<String>): this;
66
- /**
67
- *
68
- * @param {boolean} withTags
69
- * A method to get the tags along with the other details of the groups.
70
- * @returns
71
- */
72
- withTags(withTags: boolean): this;
73
- /**
74
- * This method will return an object of the GroupsRequest class.
75
- * @returns {GroupsRequest}
76
- */
77
- build(): GroupsRequest;
78
- }
@@ -1,47 +0,0 @@
1
- import { CometChatException } from './models/CustomError';
2
- import { BaseMessage } from './models/BaseMessage';
3
- export declare function getChatHost(appSettings: Object): any;
4
- export declare function getJidHost(appSettings: Object): any;
5
- export declare function isObject(object: any): boolean;
6
- export declare function isTruthy($true: any): any;
7
- export declare function isFalsy($false: any): any;
8
- export declare function getOrdinalSuffix(number: number): string;
9
- export declare function format(fmt: any, ...args: any[]): any;
10
- export declare function createUidFromJid(jid: string): string;
11
- export declare class Logger {
12
- static log(TAG: string, message: any): void;
13
- static error(TAG: string, message: any): void;
14
- static info(TAG: string, message: any): void;
15
- }
16
- export declare const getCurrentTime: () => number;
17
- /**
18
- * returns the settings from localstorage if exists, else fetch from server and update local settings
19
- *
20
- * @export
21
- * @returns promise.
22
- */
23
- export declare function getAppSettings(): Promise<unknown>;
24
- /**
25
- * get the updated settings from the server and replace in the localstorage.
26
- *
27
- * @export
28
- * @returns
29
- */
30
- export declare function getUpdatedSettings(): Promise<unknown>;
31
- export declare const isImage: (file: Blob) => boolean;
32
- export declare const isVideo: (file: Blob) => boolean;
33
- export declare const isAudio: (file: Blob) => boolean;
34
- export declare const validateScope: (scope: any) => CometChatException;
35
- export declare const validateUpdateGroup: (group: any) => CometChatException;
36
- export declare const validateJoinGroup: (group: any, type: any, password: any) => CometChatException;
37
- export declare const validateCreateGroup: (group: any) => CometChatException;
38
- export declare const validateId: (id: any, type: any) => CometChatException;
39
- export declare const validateHideMessagesFromBlockedUsers: (bool: any) => CometChatException;
40
- export declare const validateArray: (array: any, type: any) => CometChatException;
41
- export declare const validateMsgId: (msgId: any) => CometChatException;
42
- export declare const validateChatType: (type: any) => CometChatException;
43
- export declare const validateMessage: (message: any) => BaseMessage | CometChatException;
44
- export declare const validateCreateUser: (user: any) => CometChatException;
45
- export declare const validateUpdateUser: (user: any) => CometChatException;
46
- export declare const validateConversationType: (conversationType: any) => CometChatException;
47
- export declare function updatePropertiesWithDynamicValue(obj: any, searchString: any, dynamicValue: any): Promise<unknown>;
@@ -1,101 +0,0 @@
1
- import { CallListener, CallsListener, ConnectionListener, WSConnectionListener, GroupListener, GroupsListener, LoginListener, UserLoginListener, MessageListener, MessagesListener, UserListener, UsersListener } from "./models/Listner";
2
- export declare class ListenerHandlers {
3
- connectionHandlers?: WSConnectionListener[];
4
- loginHandlers?: UserLoginListener[];
5
- messageHandlers?: MessagesListener[];
6
- userHandlers?: UsersListener[];
7
- groupHandlers?: GroupsListener[];
8
- callHandlers?: CallsListener[];
9
- private static listenerHandlers;
10
- static getInstance(): ListenerHandlers;
11
- /**
12
- * attaches the callback functions which will be acting as connection status listeners.
13
- *
14
- * @param {String} name name of the listener
15
- * @param {Function} callback callback listener function.
16
- * @memberof ListenerHandlers
17
- */
18
- addConnectionEventListener(name: string, connectionEventListener: ConnectionListener): void;
19
- /**
20
- * removing the callback functions which were acting as connection status listeners.
21
- *
22
- * @param {string} handler
23
- * @memberof ListenerHandlers
24
- */
25
- removeConnectionEventListener(handler: string): void;
26
- /**
27
- * attaches the callback functions which will be acting as login progress listeners.
28
- *
29
- * @param {String} name name of the listener
30
- * @param {Function} callback callback listener function.
31
- * @memberof ListenerHandlers
32
- */
33
- addLoginEventListener(name: string, loginEventListener: LoginListener): void;
34
- /**
35
- * removing the callback functions which were acting as login progress listeners.
36
- *
37
- * @param {string} handler
38
- * @memberof ListenerHandlers
39
- */
40
- removeLoginEventListener(handler: string): void;
41
- /**
42
- * attaches the callback functions which will be acting as incoming message listeners.
43
- *
44
- * @param {String} name name of the listener
45
- * @param {Function} callback callback listener function.
46
- * @memberof ListenerHandlers
47
- */
48
- addMessageEventListener(name: string, messageListener: MessageListener): void;
49
- /**
50
- * removing the callback functions which were acting as incoming message listeners.
51
- *
52
- * @param {string} handler
53
- * @memberof ListenerHandlers
54
- */
55
- removeMessageEventListener(handler: string): void;
56
- /**
57
- * attaches the callback functions which will be acting as incoming user presence listeners.
58
- *
59
- * @param {String} name name of the listener
60
- * @param {Function} callback callback listener function.
61
- * @memberof ListenerHandlers
62
- */
63
- addUserEventListener(name: string, userEventListener: UserListener): void;
64
- /**
65
- * removing the callback functions which were acting as incoming user presence listeners.
66
- *
67
- * @param {string} handler
68
- * @memberof ListenerHandlers
69
- */
70
- removeUserEventListener(handler: string): void;
71
- /**
72
- * attaches the callback functions which will be acting as incoming group action listeners.
73
- *
74
- * @param {String} name name of the listener
75
- * @param {Function} callback callback listener function.
76
- * @memberof ListenerHandlers
77
- */
78
- addGroupEventListener(name: string, groupListener: GroupListener): void;
79
- /**
80
- * removing the callback functions which were acting as incoming group action listeners.
81
- *
82
- * @param {string} handler
83
- * @memberof ListenerHandlers
84
- */
85
- removeGroupEventListener(handler: string): void;
86
- /**
87
- * attaches the callback functions which will be acting as incoming call listeners.
88
- *
89
- * @param {String} name name of the listener
90
- * @param {Function} callback callback listener function.
91
- * @memberof ListenerHandlers
92
- */
93
- addCallEventListener(name: string, callListener: CallListener): void;
94
- /**
95
- * removing the callback functions which were acting as incoming call listeners.
96
- *
97
- * @param {string} handler
98
- * @memberof ListenerHandlers
99
- */
100
- removeCallEventListener(handler: string): void;
101
- }
@@ -1,188 +0,0 @@
1
- import { BaseMessage } from "./models/BaseMessage";
2
- export declare class MessagesRequest {
3
- private limit?;
4
- private uid?;
5
- private guid?;
6
- private parentMessageId?;
7
- private timestamp?;
8
- private id?;
9
- private messageStore;
10
- private affix;
11
- private lastAffix;
12
- private currentMethod;
13
- private endpointName;
14
- private listId;
15
- private totalPages;
16
- private unread;
17
- private inProgress;
18
- private hideMessagesFromBlockedUsers;
19
- private searchKey?;
20
- private updatedAt;
21
- private onlyUpdates;
22
- private paginationMeta;
23
- private category?;
24
- private categories?;
25
- private type?;
26
- private types?;
27
- private tags?;
28
- private WithTags?;
29
- private hideReplies?;
30
- private hideDeletedMessages;
31
- constructor(builder?: MessagesRequestBuilder);
32
- /**
33
- * Get list of next messages based on the parameters specified in MessagesRequestBuilder class. The Developer need to call this method repeatedly using the same object of MessagesRequest class to get paginated list of message.
34
- * @returns {Promise<BaseMessage[] | []>}
35
- */
36
- fetchNext(): Promise<BaseMessage[] | []>;
37
- /**
38
- * Get list of previous messages based on the parameters specified in MessagesRequestBuilder class. The Developer need to call this method repeatedly using the same object of MessagesRequest class to get paginated list of message.
39
- * @returns {Promise<BaseMessage[] | []>}
40
- */
41
- fetchPrevious(): Promise<BaseMessage[] | []>;
42
- private makeAPICall;
43
- private createEndpoint;
44
- private makeData;
45
- private getFilteredPreviousDataByReceiverId;
46
- private getFilteredNextDataByReceiverId;
47
- }
48
- export declare class MessagesRequestBuilder {
49
- /** @private */ limit?: number;
50
- /** @private */ maxLimit: number;
51
- /** @private */ uid?: string;
52
- /** @private */ guid?: string;
53
- /** @private */ parentMessageId?: number;
54
- /** @private */ timestamp?: number;
55
- /** @private */ id?: number;
56
- /** @private */ unread?: boolean;
57
- /** @private */ HideMessagesFromBlockedUsers?: boolean;
58
- /** @private */ searchKey?: string;
59
- /** @private */ updatedAt?: string;
60
- /** @private */ onlyUpdate?: number;
61
- /** @private */ category?: string;
62
- /** @private */ categories?: Array<String>;
63
- /** @private */ type?: string;
64
- /** @private */ types?: Array<String>;
65
- /** @private */ HideReplies?: boolean;
66
- /** @private */ HideDeletedMessages?: boolean;
67
- /** @private */ tags?: Array<String>;
68
- /** @private */ WithTags?: boolean;
69
- /**
70
- * A method to set limit for the number of messages returned in a single iteration. A maximum of 100 messages can fetched in a single iteration.
71
- * @param {number} limit
72
- * @returns
73
- */
74
- setLimit(limit: number): this;
75
- /**
76
- * A method to set GUID of a Group to get messages of that particular group conversation.
77
- * @param {string} guid
78
- * @returns
79
- */
80
- setGUID(guid: string): this;
81
- /**
82
- * A method to set UID of a User to get messages of that particular user conversation.
83
- * @param {string} uid
84
- * @returns
85
- */
86
- setUID(uid: string): this;
87
- /**
88
- * A method to set parent message id to get messages of that particular thread.
89
- * @param {number} parentMessageId
90
- * @returns
91
- */
92
- setParentMessageId(parentMessageId: number): this;
93
- /**
94
- * A method to set timestamp to get messages before/after the specified timestamp.
95
- * @param {number} timestamp
96
- * @returns
97
- */
98
- setTimestamp(timestamp?: number): this;
99
- /**
100
- * A method to set message ID of a particular message to get messages before/after the specified message.
101
- * @param {number} id
102
- * @returns
103
- */
104
- setMessageId(id?: number): this;
105
- /**
106
- * A method to get only unread messages.
107
- * @param {boolean} unread
108
- * @returns
109
- */
110
- setUnread(unread?: boolean): this;
111
- /**
112
- * Method to set parameters to hide or show message from blocked users.
113
- * @param {boolean} hideMessagesFromBlockedUsers
114
- * @returns
115
- */
116
- hideMessagesFromBlockedUsers(hideMessagesFromBlockedUsers?: boolean): this;
117
- /**
118
- * A method to set the search string based on which the messages are to be fetched.
119
- * @param {string} searchKey
120
- * @returns
121
- */
122
- setSearchKeyword(searchKey: string): this;
123
- /**
124
- * A method set timestamp to get fetch messages updated/edited after that timestamp.
125
- * @param {string} updatedAt
126
- * @returns
127
- */
128
- setUpdatedAfter(updatedAt: string): this;
129
- /**
130
- * A method to get only edited/updated messages.
131
- * @param {boolean} onlyUpdate
132
- * @returns
133
- */
134
- updatesOnly(onlyUpdate: boolean): this;
135
- /**
136
- * A method to set parameter to get the messages belonging to a specific category.
137
- * @param {string} category
138
- * @returns
139
- */
140
- setCategory(category: string): this;
141
- /**
142
- * A method to set parameter to get the messages belonging to specific categories.
143
- * @param {string[]} categories
144
- * @returns
145
- */
146
- setCategories(categories: Array<String>): this;
147
- /**
148
- * A method to set parameter to get the messages belonging to a specific type.
149
- * @param {string} type
150
- * @returns
151
- */
152
- setType(type: string): this;
153
- /**
154
- * A method to set parameter to get the messages belonging to specific types.
155
- * @param {string[]} types
156
- * @returns
157
- */
158
- setTypes(types: Array<String>): this;
159
- /**
160
- * A method to hide message replies.
161
- * @param {boolean} hideReplies
162
- * @returns
163
- */
164
- hideReplies(hideReplies: boolean): this;
165
- /**
166
- * A method to hide deleted messages.
167
- * @param {boolean} hideDeletedMessages
168
- * @returns
169
- */
170
- hideDeletedMessages(hideDeletedMessages: boolean): this;
171
- /**
172
- * A method to set parameter to get the messages belonging to specific tags.
173
- * @param {Array<String>} tags
174
- * @returns
175
- */
176
- setTags(tags: Array<String>): this;
177
- /**
178
- * A method to get messages with tags.
179
- * @param {boolean} withTags
180
- * @returns
181
- */
182
- withTags(withTags: boolean): this;
183
- /**
184
- * This method will return an object of the MessagesRequest class.
185
- * @returns {MessagesRequest}
186
- */
187
- build(): MessagesRequest;
188
- }