Skip to content

Commit c47da60

Browse files
committed
📝 docs update
1 parent de76a92 commit c47da60

File tree

4 files changed

+81
-74
lines changed

4 files changed

+81
-74
lines changed

docs-v3/docs/api/classes/api_Client.Client.md

Lines changed: 71 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -7,78 +7,6 @@ custom_edit_url: null
77

88
[api/Client](/api/modules/api_Client.md).Client
99

10-
## Properties
11-
12-
### deleteAllStatus
13-
14-
**deleteAllStatus**: () => `Promise`<`boolean`\>
15-
16-
#### Type declaration <div class="label license restricted">restricted</div>
17-
18-
▸ (): `Promise`<`boolean`\>
19-
20-
:::license May require restricted license
21-
Use this link to get the [correct license](https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License).
22-
:::
23-
24-
Deletes all your existing stories.
25-
26-
##### Returns
27-
28-
`Promise`<`boolean`\>
29-
30-
boolean. True if it worked.
31-
32-
___
33-
34-
### deleteStatus
35-
36-
**deleteStatus**: (`statusesToDelete`: `string` \| `string`[]) => `Promise`<`boolean`\>
37-
38-
#### Type declaration <div class="label license restricted">restricted</div>
39-
40-
▸ (`statusesToDelete`): `Promise`<`boolean`\>
41-
42-
:::license May require restricted license
43-
Use this link to get the [correct license](https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License).
44-
:::
45-
46-
Consumes a list of id strings of stories to delete.
47-
48-
##### Parameters
49-
50-
| Name | Type | Description |
51-
| :------ | :------ | :------ |
52-
| `statusesToDelete` | `string` \| `string`[] | string [] \| string an array of ids of stories to delete. |
53-
54-
##### Returns
55-
56-
`Promise`<`boolean`\>
57-
58-
boolean. True if it worked.
59-
60-
___
61-
62-
### getMyStatusArray
63-
64-
**getMyStatusArray**: () => `Promise`<[`Message`](/api/interfaces/api_model_message.Message.md)[]\>
65-
66-
#### Type declaration <div class="label license restricted">restricted</div>
67-
68-
▸ (): `Promise`<[`Message`](/api/interfaces/api_model_message.Message.md)[]\>
69-
70-
:::license May require restricted license
71-
Use this link to get the [correct license](https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License).
72-
:::
73-
74-
Retrieves all existing stories.
75-
76-
Only works with a Story License Key
77-
78-
##### Returns
79-
80-
`Promise`<[`Message`](/api/interfaces/api_model_message.Message.md)[]\>
81-
8210
## Methods
8311

8412
### B <div class="label license insiders">insiders</div>
@@ -526,6 +454,20 @@ Decrypts a media message.
526454

527455
___
528456

457+
### deleteAllStatus
458+
459+
**deleteAllStatus**(): `Promise`<`boolean`\>
460+
461+
**`Deprecated`**
462+
463+
Alias for deleteStory
464+
465+
#### Returns
466+
467+
`Promise`<`boolean`\>
468+
469+
___
470+
529471
### deleteAllStories <div class="label license restricted">restricted</div>
530472

531473
**deleteAllStories**(): `Promise`<`boolean`\>
@@ -604,6 +546,26 @@ Deletes chats from a certain index (default 1000). E.g if this startingFrom para
604546

605547
___
606548

549+
### deleteStatus
550+
551+
**deleteStatus**(`statusesToDelete`): `Promise`<`boolean`\>
552+
553+
**`Deprecated`**
554+
555+
Alias for deleteStory
556+
557+
#### Parameters
558+
559+
| Name | Type |
560+
| :------ | :------ |
561+
| `statusesToDelete` | `string` \| `string`[] |
562+
563+
#### Returns
564+
565+
`Promise`<`boolean`\>
566+
567+
___
568+
607569
### deleteStory <div class="label license restricted">restricted</div>
608570

609571
**deleteStory**(`statusesToDelete`): `Promise`<`boolean`\>
@@ -1572,6 +1534,7 @@ If you have set `onAnyMessage` or `onMessage` with the second parameter (PQueue
15721534
| `onNewProduct` | `default`<`default`, `DefaultAddOptions`\> |
15731535
| `onOrder` | `default`<`default`, `DefaultAddOptions`\> |
15741536
| `onPlugged` | `default`<`default`, `DefaultAddOptions`\> |
1537+
| `onPollVote` | `default`<`default`, `DefaultAddOptions`\> |
15751538
| `onReaction` | `default`<`default`, `DefaultAddOptions`\> |
15761539
| `onRemovedFromGroup` | `default`<`default`, `DefaultAddOptions`\> |
15771540
| `onStateChanged` | `default`<`default`, `DefaultAddOptions`\> |
@@ -1672,6 +1635,20 @@ message object or `undefined` if the host account's last message could not be fo
16721635

16731636
___
16741637

1638+
### getMyStatusArray
1639+
1640+
**getMyStatusArray**(): `Promise`<[`Message`](/api/interfaces/api_model_message.Message.md)[]\>
1641+
1642+
**`Deprecated`**
1643+
1644+
Alias for deleteStory
1645+
1646+
#### Returns
1647+
1648+
`Promise`<[`Message`](/api/interfaces/api_model_message.Message.md)[]\>
1649+
1650+
___
1651+
16751652
### getMyStoryArray <div class="label license restricted">restricted</div>
16761653

16771654
**getMyStoryArray**(): `Promise`<[`Message`](/api/interfaces/api_model_message.Message.md)[]\>
@@ -4763,6 +4740,28 @@ boolean true if plugged, false if unplugged
47634740
47644741
___
47654742
4743+
### onPollVote
4744+
4745+
▸ **onPollVote**(`fn`): `Promise`<`boolean` \| `Listener`\>
4746+
4747+
Listens to poll vote events
4748+
4749+
**`Fires`**
4750+
4751+
PollData
4752+
4753+
#### Parameters
4754+
4755+
| Name | Type | Description |
4756+
| :------ | :------ | :------ |
4757+
| `fn` | (`pollDate`: [`PollData`](/api/interfaces/api_model_message.PollData.md)) => `void` | callback |
4758+
4759+
#### Returns
4760+
4761+
`Promise`<`boolean` \| `Listener`\>
4762+
4763+
___
4764+
47664765
### onReaction <div class="label license insiders">insiders</div>
47674766
47684767
▸ **onReaction**(`fn`): `Promise`<`boolean` \| `Listener`\>

docs-v3/docs/api/classes/structures_Collector.Collection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ ___
100100

101101
#### Inherited from
102102

103-
BaseCollection.\_\_@species@1947
103+
BaseCollection.\_\_@species@1948
104104

105105
___
106106

docs-v3/docs/api/enums/api_model_events.SimpleListener.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,14 @@ Represents onPlugged
174174

175175
___
176176

177+
### PollVote
178+
179+
**PollVote** = ``"onPollVote"``
180+
181+
Represents onButton
182+
183+
___
184+
177185
### Reaction
178186

179187
**Reaction** = ``"onReaction"``

docs-v3/docs/api/reference

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: "reference"
3-
title: "@open-wa/wa-automate - v4.52.0"
3+
title: "@open-wa/wa-automate - v4.52.1"
44
sidebar_label: "Readme"
55
sidebar_position: 0
66
custom_edit_url: null

0 commit comments

Comments
 (0)