Spaces:
Paused
Paused
File size: 3,578 Bytes
4c34106 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 | /*
* This file is part of WPPConnect.
*
* WPPConnect is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* WPPConnect is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with WPPConnect. If not, see <https://www.gnu.org/licenses/>.
*/
import { Page } from 'puppeteer';
import { CreateConfig } from '../../config/create-config';
import { evaluateAndReturn } from '../helpers';
import { CatalogLayer } from './catalog.layer';
export class LabelsLayer extends CatalogLayer {
constructor(public page: Page, session?: string, options?: CreateConfig) {
super(page, session, options);
}
/**
* Create New Label
* @category Labels
*
* @example
* ```javascript
* client.addNewLabel(`Name of label`);
* //or
* client.addNewLabel(`Name of label`, { labelColor: '#dfaef0' });
* //or
* client.addNewLabel(`Name of label`, { labelColor: 4292849392 });
* ```
* @param name Name of label
* @param options options of label
*/
public async addNewLabel(name: string, options?: string) {
return await evaluateAndReturn(
this.page,
({ name, options }) => {
WPP.labels.addNewLabel(name, options);
},
{ name, options }
);
}
/**
* Add or delete label of chatId
* @category Labels
*
* @example
* ```javascript
* client.addOrRemoveLabels(['[number]@c.us','[number]@c.us'],
* [
* { labelId:'76', type:'add' },
* { labelId:'75', type:'remove' }
* ]);
* //or
* ```
* @param chatIds ChatIds
* @param options options to remove or add
*/
public async addOrRemoveLabels(
chatIds: string,
options: {
labelId: string;
type: 'add' | 'remove';
}[]
) {
return await evaluateAndReturn(
this.page,
({ chatIds, options }) => {
WPP.labels.addOrRemoveLabels(chatIds, options);
},
{ chatIds, options }
);
}
/**
* Get all Labels
*
* @example
* ```javascript
* client.getAllLabels();
* ```
*/
public async getAllLabels() {
return evaluateAndReturn(this.page, () => WPP.labels.getAllLabels());
}
/**
* Get Label by id
* @category Labels
* @param id - Id of label
*
* @example
* ```javascript
* client.getLabelById('1');
* ```
*/
public async getLabelById(id: string) {
return await evaluateAndReturn(
this.page,
({ id }) => {
WPP.labels.getLabelById(id);
},
{ id }
);
}
/**
* Delete all Labels
* @category Labels
*
* @example
* ```javascript
* client.deleteAllLabels();
* ```
*/
public async deleteAllLabels() {
return await evaluateAndReturn(this.page, () => {
WPP.labels.deleteAllLabels();
});
}
/**
* Add or delete label of chatId
* @category Labels
*
* @example
* ```javascript
* client.deleteLabel();
* ```
* @param id Id or string to labels to delete
*/
public async deleteLabel(id: string | string[]) {
return await evaluateAndReturn(
this.page,
({ id }) => {
WPP.labels.deleteLabel(id);
},
{ id }
);
}
}
|