diff --git a/404.html b/404.html index 5351b6f22..ad50a8c4d 100644 --- a/404.html +++ b/404.html @@ -16,7 +16,7 @@ - + diff --git a/assets/js/0058b4c6.15fd0581.js b/assets/js/0058b4c6.f392e14b.js similarity index 99% rename from assets/js/0058b4c6.15fd0581.js rename to assets/js/0058b4c6.f392e14b.js index e02a77558..f829baf7c 100644 --- a/assets/js/0058b4c6.15fd0581.js +++ b/assets/js/0058b4c6.f392e14b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[849],{6164:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Introduction","href":"/docs/intro","docId":"intro","unlisted":false},{"type":"category","label":"Concepts","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Glossary","href":"/docs/concepts/glossary","docId":"concepts/glossary","unlisted":false},{"type":"link","label":"How does this work?","href":"/docs/concepts/how-it-works","docId":"concepts/how-it-works","unlisted":false}]},{"type":"category","label":"Get Started","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Easy API","href":"/docs/get-started/quick-run","docId":"get-started/quick-run","unlisted":false},{"type":"link","label":"Docker","href":"/docs/get-started/docker","docId":"get-started/docker","unlisted":false},{"type":"link","label":"Custom Code","href":"/docs/get-started/installation","docId":"get-started/installation","unlisted":false},{"type":"link","label":"Link Code Login","href":"/docs/get-started/link-code","docId":"get-started/link-code","unlisted":false},{"type":"link","label":"Socket mode","href":"/docs/get-started/socketmode","docId":"get-started/socketmode","unlisted":false}]},{"type":"category","label":"Configuration","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"The Config Object","href":"/docs/configuration/config-object","docId":"configuration/config-object","unlisted":false},{"type":"link","label":"EASY API CLI options","href":"/docs/configuration/command-line-options","docId":"configuration/command-line-options","unlisted":false},{"type":"link","label":"The Client","href":"/docs/configuration/the-client","docId":"configuration/the-client","unlisted":false},{"type":"link","label":"Capturing QR Code","href":"/docs/configuration/capture-qr","docId":"configuration/capture-qr","unlisted":false},{"type":"link","label":"Capturing the session data","href":"/docs/configuration/capture-sd","docId":"configuration/capture-sd","unlisted":false},{"type":"link","label":"Launch Events","href":"/docs/configuration/launch-events","docId":"configuration/launch-events","unlisted":false},{"type":"link","label":"Licensed Features","href":"/docs/configuration/licensed-features","docId":"configuration/licensed-features","unlisted":false},{"type":"link","label":"Multiple Sessions","href":"/docs/configuration/multiple-sessions","docId":"configuration/multiple-sessions","unlisted":false}]},{"type":"category","label":"Tutorial - Basics","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create a Page","href":"/docs/tutorial-basics/create-a-page","docId":"tutorial-basics/create-a-page","unlisted":false},{"type":"link","label":"Create a Document","href":"/docs/tutorial-basics/create-a-document","docId":"tutorial-basics/create-a-document","unlisted":false},{"type":"link","label":"Create a Blog Post","href":"/docs/tutorial-basics/create-a-blog-post","docId":"tutorial-basics/create-a-blog-post","unlisted":false},{"type":"link","label":"Markdown Features","href":"/docs/tutorial-basics/markdown-features","docId":"tutorial-basics/markdown-features","unlisted":false},{"type":"link","label":"Deploy your site","href":"/docs/tutorial-basics/deploy-your-site","docId":"tutorial-basics/deploy-your-site","unlisted":false},{"type":"link","label":"Congratulations!","href":"/docs/tutorial-basics/congratulations","docId":"tutorial-basics/congratulations","unlisted":false}],"href":"/docs/category/tutorial---basics"},{"type":"category","label":"Advanced","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Best Practice","href":"/docs/advanced/best-practices","docId":"advanced/best-practices","unlisted":false}]},{"type":"category","label":"Tutorial - Extras","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Manage Docs Versions","href":"/docs/tutorial-extras/manage-docs-versions","docId":"tutorial-extras/manage-docs-versions","unlisted":false},{"type":"link","label":"Translate your site","href":"/docs/tutorial-extras/translate-your-site","docId":"tutorial-extras/translate-your-site","unlisted":false}],"href":"/docs/category/tutorial---extras"},{"type":"category","label":"Integrations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Chatwoot integrations","href":"/docs/Integrations/chatwoot","docId":"Integrations/chatwoot","unlisted":false}]},{"type":"link","label":"@open-wa/wa-automate v4.71.15","href":"/docs/api/","docId":"api/index","unlisted":false},{"type":"category","label":"How To","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Creating an API","href":"/docs/how-to/create-api","docId":"how-to/create-api","unlisted":false},{"type":"link","label":"Decrypting Media","href":"/docs/how-to/decrypt-media","docId":"how-to/decrypt-media","unlisted":false},{"type":"link","label":"Detecting Logouts","href":"/docs/how-to/detect-logout","docId":"how-to/detect-logout","unlisted":false},{"type":"link","label":"Group","href":"/docs/how-to/groups","docId":"how-to/groups","unlisted":false},{"type":"link","label":"Error Handling","href":"/docs/how-to/handle-errors","docId":"how-to/handle-errors","unlisted":false},{"type":"link","label":"Handle Incoming Call","href":"/docs/how-to/incoming-calls","docId":"how-to/incoming-calls","unlisted":false},{"type":"link","label":"Location","href":"/docs/how-to/location","docId":"how-to/location","unlisted":false},{"type":"link","label":"Manage Participants","href":"/docs/how-to/manage-participants","docId":"how-to/manage-participants","unlisted":false},{"type":"link","label":"More examples","href":"/docs/how-to/misc","docId":"how-to/misc","unlisted":false},{"type":"link","label":"Reacting To Group Events","href":"/docs/how-to/react-to-group-events","docId":"how-to/react-to-group-events","unlisted":false},{"type":"link","label":"read-state","href":"/docs/how-to/read-state","docId":"how-to/read-state","unlisted":false},{"type":"link","label":"receive-files","href":"/docs/how-to/receive-files","docId":"how-to/receive-files","unlisted":false},{"type":"link","label":"Receiving Messages","href":"/docs/how-to/receive-messages","docId":"how-to/receive-messages","unlisted":false},{"type":"link","label":"Sending Files","href":"/docs/how-to/send-files","docId":"how-to/send-files","unlisted":false},{"type":"link","label":"Sending Messages","href":"/docs/how-to/send-messages","docId":"how-to/send-messages","unlisted":false},{"type":"link","label":"Send Video","href":"/docs/how-to/send-videos","docId":"how-to/send-videos","unlisted":false},{"type":"link","label":"SendFile","href":"/docs/how-to/sendfile","docId":"how-to/sendfile","unlisted":false},{"type":"link","label":"Proxying your session","href":"/docs/how-to/use-a-proxy","docId":"how-to/use-a-proxy","unlisted":false}]},{"type":"category","label":"@open-wa/wa-automate v4.72.5","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"api","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"api/Client","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Class: Client","href":"/docs/reference/api/Client/classes/Client","docId":"reference/api/Client/classes/Client","unlisted":false}]},{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: namespace","href":"/docs/reference/api/Client/enumerations/namespace","docId":"reference/api/Client/enumerations/namespace","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: useragent","href":"/docs/reference/api/Client/variables/useragent","docId":"reference/api/Client/variables/useragent","unlisted":false}]}],"href":"/docs/reference/api/Client/"},{"type":"category","label":"functions","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"api/functions/exposed.enum","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: ExposedFn","href":"/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn","docId":"reference/api/functions/exposed.enum/enumerations/ExposedFn","unlisted":false}]}],"href":"/docs/reference/api/functions/exposed.enum/"}]},{"type":"category","label":"api/model","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"api/model/aliases","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: AccountNumber","href":"/docs/reference/api/model/aliases/type-aliases/AccountNumber","docId":"reference/api/model/aliases/type-aliases/AccountNumber","unlisted":false},{"type":"link","label":"Type Alias: AdvancedFile","href":"/docs/reference/api/model/aliases/type-aliases/AdvancedFile","docId":"reference/api/model/aliases/type-aliases/AdvancedFile","unlisted":false},{"type":"link","label":"Type Alias: Base64","href":"/docs/reference/api/model/aliases/type-aliases/Base64","docId":"reference/api/model/aliases/type-aliases/Base64","unlisted":false},{"type":"link","label":"Type Alias: ChatId","href":"/docs/reference/api/model/aliases/type-aliases/ChatId","docId":"reference/api/model/aliases/type-aliases/ChatId","unlisted":false},{"type":"link","label":"Type Alias: ChatServer","href":"/docs/reference/api/model/aliases/type-aliases/ChatServer","docId":"reference/api/model/aliases/type-aliases/ChatServer","unlisted":false},{"type":"link","label":"Type Alias: ContactId","href":"/docs/reference/api/model/aliases/type-aliases/ContactId","docId":"reference/api/model/aliases/type-aliases/ContactId","unlisted":false},{"type":"link","label":"Type Alias: Content","href":"/docs/reference/api/model/aliases/type-aliases/Content","docId":"reference/api/model/aliases/type-aliases/Content","unlisted":false},{"type":"link","label":"Type Alias: CountryCode","href":"/docs/reference/api/model/aliases/type-aliases/CountryCode","docId":"reference/api/model/aliases/type-aliases/CountryCode","unlisted":false},{"type":"link","label":"Type Alias: DataURL","href":"/docs/reference/api/model/aliases/type-aliases/DataURL","docId":"reference/api/model/aliases/type-aliases/DataURL","unlisted":false},{"type":"link","label":"Type Alias: FilePath","href":"/docs/reference/api/model/aliases/type-aliases/FilePath","docId":"reference/api/model/aliases/type-aliases/FilePath","unlisted":false},{"type":"link","label":"Type Alias: GetURL","href":"/docs/reference/api/model/aliases/type-aliases/GetURL","docId":"reference/api/model/aliases/type-aliases/GetURL","unlisted":false},{"type":"link","label":"Type Alias: GroupChatId","href":"/docs/reference/api/model/aliases/type-aliases/GroupChatId","docId":"reference/api/model/aliases/type-aliases/GroupChatId","unlisted":false},{"type":"link","label":"Type Alias: GroupChatServer","href":"/docs/reference/api/model/aliases/type-aliases/GroupChatServer","docId":"reference/api/model/aliases/type-aliases/GroupChatServer","unlisted":false},{"type":"link","label":"Type Alias: GroupId","href":"/docs/reference/api/model/aliases/type-aliases/GroupId","docId":"reference/api/model/aliases/type-aliases/GroupId","unlisted":false},{"type":"link","label":"Type Alias: MessageId","href":"/docs/reference/api/model/aliases/type-aliases/MessageId","docId":"reference/api/model/aliases/type-aliases/MessageId","unlisted":false},{"type":"link","label":"Type Alias: NonSerializedId","href":"/docs/reference/api/model/aliases/type-aliases/NonSerializedId","docId":"reference/api/model/aliases/type-aliases/NonSerializedId","unlisted":false},{"type":"link","label":"Type Alias: WaServers","href":"/docs/reference/api/model/aliases/type-aliases/WaServers","docId":"reference/api/model/aliases/type-aliases/WaServers","unlisted":false}]}],"href":"/docs/reference/api/model/aliases/"},{"type":"category","label":"api/model/button","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: AdvancedButton","href":"/docs/reference/api/model/button/interfaces/AdvancedButton","docId":"reference/api/model/button/interfaces/AdvancedButton","unlisted":false},{"type":"link","label":"Interface: Button","href":"/docs/reference/api/model/button/interfaces/Button","docId":"reference/api/model/button/interfaces/Button","unlisted":false},{"type":"link","label":"Interface: LocationButtonBody","href":"/docs/reference/api/model/button/interfaces/LocationButtonBody","docId":"reference/api/model/button/interfaces/LocationButtonBody","unlisted":false},{"type":"link","label":"Interface: Row","href":"/docs/reference/api/model/button/interfaces/Row","docId":"reference/api/model/button/interfaces/Row","unlisted":false},{"type":"link","label":"Interface: Section","href":"/docs/reference/api/model/button/interfaces/Section","docId":"reference/api/model/button/interfaces/Section","unlisted":false}]}],"href":"/docs/reference/api/model/button/"},{"type":"category","label":"api/model/call","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: CallState","href":"/docs/reference/api/model/call/enumerations/CallState","docId":"reference/api/model/call/enumerations/CallState","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: Call","href":"/docs/reference/api/model/call/interfaces/Call","docId":"reference/api/model/call/interfaces/Call","unlisted":false}]}],"href":"/docs/reference/api/model/call/"},{"type":"category","label":"api/model/chat","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: ChatMuteDuration","href":"/docs/reference/api/model/chat/enumerations/ChatMuteDuration","docId":"reference/api/model/chat/enumerations/ChatMuteDuration","unlisted":false},{"type":"link","label":"Enumeration: ChatState","href":"/docs/reference/api/model/chat/enumerations/ChatState","docId":"reference/api/model/chat/enumerations/ChatState","unlisted":false},{"type":"link","label":"Enumeration: ChatTypes","href":"/docs/reference/api/model/chat/enumerations/ChatTypes","docId":"reference/api/model/chat/enumerations/ChatTypes","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: BaseChat","href":"/docs/reference/api/model/chat/interfaces/BaseChat","docId":"reference/api/model/chat/interfaces/BaseChat","unlisted":false},{"type":"link","label":"Interface: GroupChat","href":"/docs/reference/api/model/chat/interfaces/GroupChat","docId":"reference/api/model/chat/interfaces/GroupChat","unlisted":false},{"type":"link","label":"Interface: GroupChatCreationParticipantAddResponse","href":"/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse","docId":"reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse","unlisted":false},{"type":"link","label":"Interface: GroupChatCreationResponse","href":"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse","docId":"reference/api/model/chat/interfaces/GroupChatCreationResponse","unlisted":false},{"type":"link","label":"Interface: LiveLocationChangedEvent","href":"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent","docId":"reference/api/model/chat/interfaces/LiveLocationChangedEvent","unlisted":false},{"type":"link","label":"Interface: SingleChat","href":"/docs/reference/api/model/chat/interfaces/SingleChat","docId":"reference/api/model/chat/interfaces/SingleChat","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: Chat","href":"/docs/reference/api/model/chat/type-aliases/Chat","docId":"reference/api/model/chat/type-aliases/Chat","unlisted":false},{"type":"link","label":"Type Alias: EphemeralDuration","href":"/docs/reference/api/model/chat/type-aliases/EphemeralDuration","docId":"reference/api/model/chat/type-aliases/EphemeralDuration","unlisted":false}]}],"href":"/docs/reference/api/model/chat/"},{"type":"category","label":"api/model/config","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: CLOUD\\\\_PROVIDERS","href":"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS","docId":"reference/api/model/config/enumerations/CLOUD_PROVIDERS","unlisted":false},{"type":"link","label":"Enumeration: DIRECTORY\\\\_STRATEGY","href":"/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY","docId":"reference/api/model/config/enumerations/DIRECTORY_STRATEGY","unlisted":false},{"type":"link","label":"Enumeration: LicenseType","href":"/docs/reference/api/model/config/enumerations/LicenseType","docId":"reference/api/model/config/enumerations/LicenseType","unlisted":false},{"type":"link","label":"Enumeration: NotificationLanguage","href":"/docs/reference/api/model/config/enumerations/NotificationLanguage","docId":"reference/api/model/config/enumerations/NotificationLanguage","unlisted":false},{"type":"link","label":"Enumeration: OnError","href":"/docs/reference/api/model/config/enumerations/OnError","docId":"reference/api/model/config/enumerations/OnError","unlisted":false},{"type":"link","label":"Enumeration: QRFormat","href":"/docs/reference/api/model/config/enumerations/QRFormat","docId":"reference/api/model/config/enumerations/QRFormat","unlisted":false},{"type":"link","label":"Enumeration: QRQuality","href":"/docs/reference/api/model/config/enumerations/QRQuality","docId":"reference/api/model/config/enumerations/QRQuality","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: ConfigObject","href":"/docs/reference/api/model/config/interfaces/ConfigObject","docId":"reference/api/model/config/interfaces/ConfigObject","unlisted":false},{"type":"link","label":"Interface: DevTools","href":"/docs/reference/api/model/config/interfaces/DevTools","docId":"reference/api/model/config/interfaces/DevTools","unlisted":false},{"type":"link","label":"Interface: EventPayload","href":"/docs/reference/api/model/config/interfaces/EventPayload","docId":"reference/api/model/config/interfaces/EventPayload","unlisted":false},{"type":"link","label":"Interface: ProxyServerCredentials","href":"/docs/reference/api/model/config/interfaces/ProxyServerCredentials","docId":"reference/api/model/config/interfaces/ProxyServerCredentials","unlisted":false},{"type":"link","label":"Interface: SessionData","href":"/docs/reference/api/model/config/interfaces/SessionData","docId":"reference/api/model/config/interfaces/SessionData","unlisted":false},{"type":"link","label":"Interface: Webhook","href":"/docs/reference/api/model/config/interfaces/Webhook","docId":"reference/api/model/config/interfaces/Webhook","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: AdvancedConfig","href":"/docs/reference/api/model/config/type-aliases/AdvancedConfig","docId":"reference/api/model/config/type-aliases/AdvancedConfig","unlisted":false}]}],"href":"/docs/reference/api/model/config/"},{"type":"category","label":"api/model/contact","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: BizCategory","href":"/docs/reference/api/model/contact/interfaces/BizCategory","docId":"reference/api/model/contact/interfaces/BizCategory","unlisted":false},{"type":"link","label":"Interface: BizProfileOptions","href":"/docs/reference/api/model/contact/interfaces/BizProfileOptions","docId":"reference/api/model/contact/interfaces/BizProfileOptions","unlisted":false},{"type":"link","label":"Interface: BusinessHours","href":"/docs/reference/api/model/contact/interfaces/BusinessHours","docId":"reference/api/model/contact/interfaces/BusinessHours","unlisted":false},{"type":"link","label":"Interface: BusinessProfile","href":"/docs/reference/api/model/contact/interfaces/BusinessProfile","docId":"reference/api/model/contact/interfaces/BusinessProfile","unlisted":false},{"type":"link","label":"Interface: Contact","href":"/docs/reference/api/model/contact/interfaces/Contact","docId":"reference/api/model/contact/interfaces/Contact","unlisted":false},{"type":"link","label":"Interface: NumberCheck","href":"/docs/reference/api/model/contact/interfaces/NumberCheck","docId":"reference/api/model/contact/interfaces/NumberCheck","unlisted":false}]}],"href":"/docs/reference/api/model/contact/"},{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: Events","href":"/docs/reference/api/model/enumerations/Events","docId":"reference/api/model/enumerations/Events","unlisted":false},{"type":"link","label":"Enumeration: STATE","href":"/docs/reference/api/model/enumerations/STATE","docId":"reference/api/model/enumerations/STATE","unlisted":false},{"type":"link","label":"Enumeration: Status","href":"/docs/reference/api/model/enumerations/Status","docId":"reference/api/model/enumerations/Status","unlisted":false}]},{"type":"category","label":"api/model/errors","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Class: AddParticipantError","href":"/docs/reference/api/model/errors/classes/AddParticipantError","docId":"reference/api/model/errors/classes/AddParticipantError","unlisted":false},{"type":"link","label":"Class: CustomError","href":"/docs/reference/api/model/errors/classes/CustomError","docId":"reference/api/model/errors/classes/CustomError","unlisted":false},{"type":"link","label":"Class: PageEvaluationTimeout","href":"/docs/reference/api/model/errors/classes/PageEvaluationTimeout","docId":"reference/api/model/errors/classes/PageEvaluationTimeout","unlisted":false},{"type":"link","label":"Class: SessionExpiredError","href":"/docs/reference/api/model/errors/classes/SessionExpiredError","docId":"reference/api/model/errors/classes/SessionExpiredError","unlisted":false}]},{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: AddParticipantErrorStatusCode","href":"/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode","docId":"reference/api/model/errors/enumerations/AddParticipantErrorStatusCode","unlisted":false},{"type":"link","label":"Enumeration: ERROR\\\\_NAME","href":"/docs/reference/api/model/errors/enumerations/ERROR_NAME","docId":"reference/api/model/errors/enumerations/ERROR_NAME","unlisted":false}]}],"href":"/docs/reference/api/model/errors/"},{"type":"category","label":"api/model/events","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: SimpleListener","href":"/docs/reference/api/model/events/enumerations/SimpleListener","docId":"reference/api/model/events/enumerations/SimpleListener","unlisted":false}]}],"href":"/docs/reference/api/model/events/"},{"type":"category","label":"api/model/group-metadata","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: GroupNotificationTypes","href":"/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes","docId":"reference/api/model/group-metadata/enumerations/GroupNotificationTypes","unlisted":false},{"type":"link","label":"Enumeration: groupChangeEvent","href":"/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent","docId":"reference/api/model/group-metadata/enumerations/groupChangeEvent","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: GenericGroupChangeEvent","href":"/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent","docId":"reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent","unlisted":false},{"type":"link","label":"Interface: GroupMetadata","href":"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata","docId":"reference/api/model/group-metadata/interfaces/GroupMetadata","unlisted":false},{"type":"link","label":"Interface: NewCommunityGroup","href":"/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup","docId":"reference/api/model/group-metadata/interfaces/NewCommunityGroup","unlisted":false},{"type":"link","label":"Interface: Participant","href":"/docs/reference/api/model/group-metadata/interfaces/Participant","docId":"reference/api/model/group-metadata/interfaces/Participant","unlisted":false},{"type":"link","label":"Interface: ParticipantChangedEventModel","href":"/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel","docId":"reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel","unlisted":false}]}],"href":"/docs/reference/api/model/group-metadata/"},{"type":"category","label":"api/model/id","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: Id","href":"/docs/reference/api/model/id/interfaces/Id","docId":"reference/api/model/id/interfaces/Id","unlisted":false}]}],"href":"/docs/reference/api/model/id/"},{"type":"category","label":"api/model/label","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: Label","href":"/docs/reference/api/model/label/interfaces/Label","docId":"reference/api/model/label/interfaces/Label","unlisted":false}]}],"href":"/docs/reference/api/model/label/"},{"type":"category","label":"api/model/media","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: Mp4StickerConversionProcessOptions","href":"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions","docId":"reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions","unlisted":false},{"type":"link","label":"Type Alias: StickerMetadata","href":"/docs/reference/api/model/media/type-aliases/StickerMetadata","docId":"reference/api/model/media/type-aliases/StickerMetadata","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: defaultProcessOptions","href":"/docs/reference/api/model/media/variables/defaultProcessOptions","docId":"reference/api/model/media/variables/defaultProcessOptions","unlisted":false}]}],"href":"/docs/reference/api/model/media/"},{"type":"category","label":"api/model/message","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: MessageAck","href":"/docs/reference/api/model/message/enumerations/MessageAck","docId":"reference/api/model/message/enumerations/MessageAck","unlisted":false},{"type":"link","label":"Enumeration: MessageTypes","href":"/docs/reference/api/model/message/enumerations/MessageTypes","docId":"reference/api/model/message/enumerations/MessageTypes","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: Message","href":"/docs/reference/api/model/message/interfaces/Message","docId":"reference/api/model/message/interfaces/Message","unlisted":false},{"type":"link","label":"Interface: MessageInfo","href":"/docs/reference/api/model/message/interfaces/MessageInfo","docId":"reference/api/model/message/interfaces/MessageInfo","unlisted":false},{"type":"link","label":"Interface: MessageInfoInteraction","href":"/docs/reference/api/model/message/interfaces/MessageInfoInteraction","docId":"reference/api/model/message/interfaces/MessageInfoInteraction","unlisted":false},{"type":"link","label":"Interface: PollData","href":"/docs/reference/api/model/message/interfaces/PollData","docId":"reference/api/model/message/interfaces/PollData","unlisted":false},{"type":"link","label":"Interface: PollOption","href":"/docs/reference/api/model/message/interfaces/PollOption","docId":"reference/api/model/message/interfaces/PollOption","unlisted":false},{"type":"link","label":"Interface: PollVote","href":"/docs/reference/api/model/message/interfaces/PollVote","docId":"reference/api/model/message/interfaces/PollVote","unlisted":false},{"type":"link","label":"Interface: QuoteMap","href":"/docs/reference/api/model/message/interfaces/QuoteMap","docId":"reference/api/model/message/interfaces/QuoteMap","unlisted":false},{"type":"link","label":"Interface: ReactionSender","href":"/docs/reference/api/model/message/interfaces/ReactionSender","docId":"reference/api/model/message/interfaces/ReactionSender","unlisted":false}]}],"href":"/docs/reference/api/model/message/"},{"type":"category","label":"api/model/product","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: CartItem","href":"/docs/reference/api/model/product/interfaces/CartItem","docId":"reference/api/model/product/interfaces/CartItem","unlisted":false},{"type":"link","label":"Interface: CustomProduct","href":"/docs/reference/api/model/product/interfaces/CustomProduct","docId":"reference/api/model/product/interfaces/CustomProduct","unlisted":false},{"type":"link","label":"Interface: Order","href":"/docs/reference/api/model/product/interfaces/Order","docId":"reference/api/model/product/interfaces/Order","unlisted":false},{"type":"link","label":"Interface: Product","href":"/docs/reference/api/model/product/interfaces/Product","docId":"reference/api/model/product/interfaces/Product","unlisted":false}]}],"href":"/docs/reference/api/model/product/"},{"type":"category","label":"api/model/reactions","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: Reaction","href":"/docs/reference/api/model/reactions/type-aliases/Reaction","docId":"reference/api/model/reactions/type-aliases/Reaction","unlisted":false},{"type":"link","label":"Type Alias: ReactionEvent","href":"/docs/reference/api/model/reactions/type-aliases/ReactionEvent","docId":"reference/api/model/reactions/type-aliases/ReactionEvent","unlisted":false},{"type":"link","label":"Type Alias: ReactionRecord","href":"/docs/reference/api/model/reactions/type-aliases/ReactionRecord","docId":"reference/api/model/reactions/type-aliases/ReactionRecord","unlisted":false}]}],"href":"/docs/reference/api/model/reactions/"},{"type":"category","label":"api/model/sessionInfo","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: HealthCheck","href":"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck","docId":"reference/api/model/sessionInfo/interfaces/HealthCheck","unlisted":false},{"type":"link","label":"Interface: SessionInfo","href":"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo","docId":"reference/api/model/sessionInfo/interfaces/SessionInfo","unlisted":false}]}],"href":"/docs/reference/api/model/sessionInfo/"},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: EasyApiResponse","href":"/docs/reference/api/model/type-aliases/EasyApiResponse","docId":"reference/api/model/type-aliases/EasyApiResponse","unlisted":false}]}],"href":"/docs/reference/api/model/"}]},{"type":"category","label":"controllers","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"controllers/events","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: ev","href":"/docs/reference/controllers/events/variables/ev","docId":"reference/controllers/events/variables/ev","unlisted":false}]}],"href":"/docs/reference/controllers/events/"},{"type":"link","label":"controllers/init\\\\_patch","href":"/docs/reference/controllers/init_patch/","docId":"reference/controllers/init_patch/index","unlisted":false},{"type":"category","label":"controllers/initializer","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"functions","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Function: create()","href":"/docs/reference/controllers/initializer/functions/create","docId":"reference/controllers/initializer/functions/create","unlisted":false},{"type":"link","label":"Function: timeout()","href":"/docs/reference/controllers/initializer/functions/timeout","docId":"reference/controllers/initializer/functions/timeout","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: configWithCases","href":"/docs/reference/controllers/initializer/variables/configWithCases","docId":"reference/controllers/initializer/variables/configWithCases","unlisted":false},{"type":"link","label":"Variable: pkg","href":"/docs/reference/controllers/initializer/variables/pkg","docId":"reference/controllers/initializer/variables/pkg","unlisted":false},{"type":"link","label":"Variable: screenshot","href":"/docs/reference/controllers/initializer/variables/screenshot","docId":"reference/controllers/initializer/variables/screenshot","unlisted":false}]}],"href":"/docs/reference/controllers/initializer/"},{"type":"category","label":"controllers/patch\\\\_manager","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"functions","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Function: earlyInjectionCheck()","href":"/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck","docId":"reference/controllers/patch_manager/functions/earlyInjectionCheck","unlisted":false},{"type":"link","label":"Function: getAndInjectLicense()","href":"/docs/reference/controllers/patch_manager/functions/getAndInjectLicense","docId":"reference/controllers/patch_manager/functions/getAndInjectLicense","unlisted":false}]}],"href":"/docs/reference/controllers/patch_manager/"}]},{"type":"category","label":"logging","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"logging/custom\\\\_transport","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Class: LogToEvTransport","href":"/docs/reference/logging/custom_transport/classes/LogToEvTransport","docId":"reference/logging/custom_transport/classes/LogToEvTransport","unlisted":false},{"type":"link","label":"Class: NoOpTransport","href":"/docs/reference/logging/custom_transport/classes/NoOpTransport","docId":"reference/logging/custom_transport/classes/NoOpTransport","unlisted":false}]}],"href":"/docs/reference/logging/custom_transport/"},{"type":"category","label":"logging/logging","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"functions","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Function: addRotateFileLogTransport()","href":"/docs/reference/logging/logging/functions/addRotateFileLogTransport","docId":"reference/logging/logging/functions/addRotateFileLogTransport","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: ConfigLogTransport","href":"/docs/reference/logging/logging/type-aliases/ConfigLogTransport","docId":"reference/logging/logging/type-aliases/ConfigLogTransport","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: log","href":"/docs/reference/logging/logging/variables/log","docId":"reference/logging/logging/variables/log","unlisted":false}]}],"href":"/docs/reference/logging/logging/"}]},{"type":"category","label":"structures","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"structures/Collector","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Class: Collection\\\\","href":"/docs/reference/structures/Collector/classes/Collection","docId":"reference/structures/Collector/classes/Collection","unlisted":false},{"type":"link","label":"Class: Collector","href":"/docs/reference/structures/Collector/classes/Collector","docId":"reference/structures/Collector/classes/Collector","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: AwaitMessagesOptions","href":"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions","docId":"reference/structures/Collector/interfaces/AwaitMessagesOptions","unlisted":false},{"type":"link","label":"Interface: CollectorOptions","href":"/docs/reference/structures/Collector/interfaces/CollectorOptions","docId":"reference/structures/Collector/interfaces/CollectorOptions","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: CollectorFilter()\\\\","href":"/docs/reference/structures/Collector/type-aliases/CollectorFilter","docId":"reference/structures/Collector/type-aliases/CollectorFilter","unlisted":false}]}],"href":"/docs/reference/structures/Collector/"},{"type":"category","label":"structures/Dialog","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: ValidationType","href":"/docs/reference/structures/Dialog/enumerations/ValidationType","docId":"reference/structures/Dialog/enumerations/ValidationType","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: CurrentDialogProps","href":"/docs/reference/structures/Dialog/interfaces/CurrentDialogProps","docId":"reference/structures/Dialog/interfaces/CurrentDialogProps","unlisted":false},{"type":"link","label":"Interface: DialogButtons","href":"/docs/reference/structures/Dialog/interfaces/DialogButtons","docId":"reference/structures/Dialog/interfaces/DialogButtons","unlisted":false},{"type":"link","label":"Interface: DialogListMessageRow","href":"/docs/reference/structures/Dialog/interfaces/DialogListMessageRow","docId":"reference/structures/Dialog/interfaces/DialogListMessageRow","unlisted":false},{"type":"link","label":"Interface: DialogListMessageSection","href":"/docs/reference/structures/Dialog/interfaces/DialogListMessageSection","docId":"reference/structures/Dialog/interfaces/DialogListMessageSection","unlisted":false},{"type":"link","label":"Interface: DialogProperty","href":"/docs/reference/structures/Dialog/interfaces/DialogProperty","docId":"reference/structures/Dialog/interfaces/DialogProperty","unlisted":false},{"type":"link","label":"Interface: DialogState","href":"/docs/reference/structures/Dialog/interfaces/DialogState","docId":"reference/structures/Dialog/interfaces/DialogState","unlisted":false},{"type":"link","label":"Interface: DialogTemplate","href":"/docs/reference/structures/Dialog/interfaces/DialogTemplate","docId":"reference/structures/Dialog/interfaces/DialogTemplate","unlisted":false},{"type":"link","label":"Interface: DialogValidation","href":"/docs/reference/structures/Dialog/interfaces/DialogValidation","docId":"reference/structures/Dialog/interfaces/DialogValidation","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: CheckFunction()","href":"/docs/reference/structures/Dialog/type-aliases/CheckFunction","docId":"reference/structures/Dialog/type-aliases/CheckFunction","unlisted":false}]}],"href":"/docs/reference/structures/Dialog/"},{"type":"category","label":"structures/MessageCollector","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Class: MessageCollector","href":"/docs/reference/structures/MessageCollector/classes/MessageCollector","docId":"reference/structures/MessageCollector/classes/MessageCollector","unlisted":false}]}],"href":"/docs/reference/structures/MessageCollector/"},{"type":"category","label":"structures/preProcessors","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: PREPROCESSORS","href":"/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS","docId":"reference/structures/preProcessors/enumerations/PREPROCESSORS","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: MPConfigType","href":"/docs/reference/structures/preProcessors/type-aliases/MPConfigType","docId":"reference/structures/preProcessors/type-aliases/MPConfigType","unlisted":false},{"type":"link","label":"Type Alias: MessagePreProcessor()","href":"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor","docId":"reference/structures/preProcessors/type-aliases/MessagePreProcessor","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: MessagePreprocessors","href":"/docs/reference/structures/preProcessors/variables/MessagePreprocessors","docId":"reference/structures/preProcessors/variables/MessagePreprocessors","unlisted":false}]}],"href":"/docs/reference/structures/preProcessors/"}]}],"href":"/docs/reference/"}]},"docs":{"advanced/best-practices":{"id":"advanced/best-practices","title":"Best Practice","description":"Since this is not an officially sanctioned solution it is temperamental to say the least. Here are some best practices:","sidebar":"tutorialSidebar"},"api/index":{"id":"api/index","title":"@open-wa/wa-automate v4.71.15","description":"Modules","sidebar":"tutorialSidebar"},"concepts/glossary":{"id":"concepts/glossary","title":"Glossary of terms","description":"In order to get used to this project, you might find it useful to learn a few regularly used terms","sidebar":"tutorialSidebar"},"concepts/how-it-works":{"id":"concepts/how-it-works","title":"How does this work?","description":"wa-automate works by automating a chrome/chromium browser process, injecting some code into the web page and exposing functionality through the \\"Client\\". Think of it like a robot sitting in front of your whatsapp web and you\'re controlling that robot with an API or via code.","sidebar":"tutorialSidebar"},"configuration/capture-qr":{"id":"configuration/capture-qr","title":"Capturing QR Code","description":"An event is emitted every time the QR code is received by the system. You can grab hold of this event emitter by importing ev. You can capture this qr code and save it to a file.","sidebar":"tutorialSidebar"},"configuration/capture-sd":{"id":"configuration/capture-sd","title":"Capturing the session data","description":"By default, the session data is saved as a [sessionId].data.json file in the process working directory, however, you can disable this ([ConfigObject.skipSessionSave]) and implement a custom handler for session data. It is important that you always update session data with the latest values. The default behaviour is to override the data.json file with the latest session data.","sidebar":"tutorialSidebar"},"configuration/command-line-options":{"id":"configuration/command-line-options","title":"EASY API CLI options","description":"Command-line options reference documentation.","sidebar":"tutorialSidebar"},"configuration/config-object":{"id":"configuration/config-object","title":"Configuration","description":"Guide showing how to edit the settings.","sidebar":"tutorialSidebar"},"configuration/launch-events":{"id":"configuration/launch-events","title":"Launch Events","description":"When you call create] there is actually a lot happening in the background and in some use cases, it may be useful to listen to those events. In order to do this you have to use the built in event emitter [ev:","sidebar":"tutorialSidebar"},"configuration/licensed-features":{"id":"configuration/licensed-features","title":"Licensed Features","description":"Features","sidebar":"tutorialSidebar"},"configuration/multiple-sessions":{"id":"configuration/multiple-sessions","title":"Multiple Sessions","description":"You can run multiple sessions of @open-wa/wa-automate in the same process. This allows you to do interesting things for example:","sidebar":"tutorialSidebar"},"configuration/the-client":{"id":"configuration/the-client","title":"The Client","description":"Guide showing how to edit the settings.","sidebar":"tutorialSidebar"},"get-started/docker":{"id":"get-started/docker","title":"Get started with wa-automate via Docker","description":"Guide showing how to use wa-automate with Docker. This also covers how to import data as well as persistence.","sidebar":"tutorialSidebar"},"get-started/installation":{"id":"get-started/installation","title":"Custom Code","description":"Standard Installation","sidebar":"tutorialSidebar"},"get-started/link-code":{"id":"get-started/link-code","title":"Logging in with a link code","description":"Simple docs showing how to use open-wa/wa-automate with a link code.","sidebar":"tutorialSidebar"},"get-started/quick-run":{"id":"get-started/quick-run","title":"Get started with wa-automate via Docker","description":"Guide showing how to use wa-automate with Docker. This also covers how to import data as well as persistence.","sidebar":"tutorialSidebar"},"get-started/socketmode":{"id":"get-started/socketmode","title":"Socket mode","description":"Guide showing how to develop your own solutions without needing to wait for session restarts.","sidebar":"tutorialSidebar"},"how-to/create-api":{"id":"how-to/create-api","title":"Creating an API","description":"There are multiple convinient ways to create an API.","sidebar":"tutorialSidebar"},"how-to/decrypt-media":{"id":"how-to/decrypt-media","title":"Decrypting Media","description":"Here is a sample of how to decrypt media. This has been tested on images, videos, documents, audio and voice notes.","sidebar":"tutorialSidebar"},"how-to/detect-logout":{"id":"how-to/detect-logout","title":"Detecting Logouts","description":"First use [[onStateChanged]] to detect changes in the session state. Then use [[forceRefocus]] to force the the app to continue working. If state equals UNPAIRED that means the host account user has manually de authenticated the session through the app.","sidebar":"tutorialSidebar"},"how-to/groups":{"id":"how-to/groups","title":"Group","description":"Create a Group","sidebar":"tutorialSidebar"},"how-to/handle-errors":{"id":"how-to/handle-errors","title":"Error Handling","description":"Keep your promises!","sidebar":"tutorialSidebar"},"how-to/incoming-calls":{"id":"how-to/incoming-calls","title":"Handle Incoming Call","description":"[[onIncomingCall]] emits a [[Call]] object. You can use this to tell people not to call the number","sidebar":"tutorialSidebar"},"how-to/location":{"id":"how-to/location","title":"Location","description":"Sending Location","sidebar":"tutorialSidebar"},"how-to/manage-participants":{"id":"how-to/manage-participants","title":"Manage Participants","description":"[[addParticipant]] - add a participant","sidebar":"tutorialSidebar"},"how-to/misc":{"id":"how-to/misc","title":"More examples","description":"Simulate typing","sidebar":"tutorialSidebar"},"how-to/react-to-group-events":{"id":"how-to/react-to-group-events","title":"Reacting To Group Events","description":"For a specific group you can use [[onParticipantsChanged]], this will fire all detectable group participant change events (see: [[ParticipantChangedEventModel]]).","sidebar":"tutorialSidebar"},"how-to/read-state":{"id":"how-to/read-state","title":"read-state","description":"","sidebar":"tutorialSidebar"},"how-to/receive-files":{"id":"how-to/receive-files","title":"receive-files","description":"","sidebar":"tutorialSidebar"},"how-to/receive-messages":{"id":"how-to/receive-messages","title":"Receiving Messages","description":"Listen to only incoming messages","sidebar":"tutorialSidebar"},"how-to/send-files":{"id":"how-to/send-files","title":"Sending Files","description":"Send Image","sidebar":"tutorialSidebar"},"how-to/send-messages":{"id":"how-to/send-messages","title":"Sending Messages","description":"When sending a message, make sure to await the promise. It usually returns an id if the message was sent successfully.","sidebar":"tutorialSidebar"},"how-to/send-videos":{"id":"how-to/send-videos","title":"Send Video","description":"In order to send videos, the client must be started with an instance of chrome! Otherwise videos will be sent as files and not render properly in the app.","sidebar":"tutorialSidebar"},"how-to/sendfile":{"id":"how-to/sendfile","title":"SendFile","description":"","sidebar":"tutorialSidebar"},"how-to/use-a-proxy":{"id":"how-to/use-a-proxy","title":"Proxying your session","description":"It is extremely simple to use a proxy with @open-wa. Once you have your proxy protocol, address, port, username and password you just need to set the [[proxyServerCredentials]] and @open-wa will connect your session via the proxy. For example, if your proxy details are:","sidebar":"tutorialSidebar"},"Integrations/chatwoot":{"id":"Integrations/chatwoot","title":"Chatwoot integrations","description":"ready made integration for chatwoot.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Introduction","description":"open-wa is a collection of tools designed to enable you to easily automate your WhatsApp account.","sidebar":"tutorialSidebar"},"reference/api/Client/classes/Client":{"id":"reference/api/Client/classes/Client","title":"Class: Client","description":"Methods","sidebar":"tutorialSidebar"},"reference/api/Client/enumerations/namespace":{"id":"reference/api/Client/enumerations/namespace","title":"Enumeration: namespace","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/Client/index":{"id":"reference/api/Client/index","title":"api/Client","description":"Index","sidebar":"tutorialSidebar"},"reference/api/Client/variables/useragent":{"id":"reference/api/Client/variables/useragent","title":"Variable: useragent","description":"const useragent: string","sidebar":"tutorialSidebar"},"reference/api/functions/exposed.enum/enumerations/ExposedFn":{"id":"reference/api/functions/exposed.enum/enumerations/ExposedFn","title":"Enumeration: ExposedFn","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/functions/exposed.enum/index":{"id":"reference/api/functions/exposed.enum/index","title":"api/functions/exposed.enum","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/aliases/index":{"id":"reference/api/model/aliases/index","title":"api/model/aliases","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/AccountNumber":{"id":"reference/api/model/aliases/type-aliases/AccountNumber","title":"Type Alias: AccountNumber","description":"AccountNumber: \\\\$\\\\{number\\\\}\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/AdvancedFile":{"id":"reference/api/model/aliases/type-aliases/AdvancedFile","title":"Type Alias: AdvancedFile","description":"AdvancedFile: DataURL \\\\| FilePath \\\\| GetURL","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/Base64":{"id":"reference/api/model/aliases/type-aliases/Base64","title":"Type Alias: Base64","description":"Base64: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/ChatId":{"id":"reference/api/model/aliases/type-aliases/ChatId","title":"Type Alias: ChatId","description":"ChatId: ContactId \\\\| GroupChatId","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/ChatServer":{"id":"reference/api/model/aliases/type-aliases/ChatServer","title":"Type Alias: ChatServer","description":"ChatServer: \\"c.us\\"","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/ContactId":{"id":"reference/api/model/aliases/type-aliases/ContactId","title":"Type Alias: ContactId","description":"ContactId: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/Content":{"id":"reference/api/model/aliases/type-aliases/Content","title":"Type Alias: Content","description":"Content: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/CountryCode":{"id":"reference/api/model/aliases/type-aliases/CountryCode","title":"Type Alias: CountryCode","description":"CountryCode: 1 \\\\| 7 \\\\| 20 \\\\| 27 \\\\| 30 \\\\| 31 \\\\| 32 \\\\| 33 \\\\| 34 \\\\| 36 \\\\| 39 \\\\| 40 \\\\| 41 \\\\| 43 \\\\| 44 \\\\| 45 \\\\| 46 \\\\| 47 \\\\| 48 \\\\| 49 \\\\| 51 \\\\| 52 \\\\| 53 \\\\| 54 \\\\| 55 \\\\| 56 \\\\| 57 \\\\| 58 \\\\| 60 \\\\| 61 \\\\| 62 \\\\| 63 \\\\| 64 \\\\| 65 \\\\| 66 \\\\| 81 \\\\| 82 \\\\| 84 \\\\| 86 \\\\| 90 \\\\| 91 \\\\| 92 \\\\| 93 \\\\| 94 \\\\| 95 \\\\| 98 \\\\| 211 \\\\| 212 \\\\| 213 \\\\| 216 \\\\| 218 \\\\| 220 \\\\| 221 \\\\| 222 \\\\| 223 \\\\| 224 \\\\| 225 \\\\| 226 \\\\| 227 \\\\| 228 \\\\| 229 \\\\| 230 \\\\| 231 \\\\| 232 \\\\| 233 \\\\| 234 \\\\| 235 \\\\| 236 \\\\| 237 \\\\| 238 \\\\| 239 \\\\| 240 \\\\| 241 \\\\| 242 \\\\| 243 \\\\| 244 \\\\| 245 \\\\| 246 \\\\| 248 \\\\| 249 \\\\| 250 \\\\| 251 \\\\| 252 \\\\| 253 \\\\| 254 \\\\| 255 \\\\| 256 \\\\| 257 \\\\| 258 \\\\| 260 \\\\| 261 \\\\| 262 \\\\| 263 \\\\| 264 \\\\| 265 \\\\| 266 \\\\| 267 \\\\| 268 \\\\| 269 \\\\| 290 \\\\| 291 \\\\| 297 \\\\| 298 \\\\| 299 \\\\| 350 \\\\| 351 \\\\| 352 \\\\| 353 \\\\| 354 \\\\| 355 \\\\| 356 \\\\| 357 \\\\| 358 \\\\| 359 \\\\| 370 \\\\| 371 \\\\| 372 \\\\| 373 \\\\| 374 \\\\| 375 \\\\| 376 \\\\| 377 \\\\| 378 \\\\| 380 \\\\| 381 \\\\| 382 \\\\| 383 \\\\| 385 \\\\| 386 \\\\| 387 \\\\| 389 \\\\| 420 \\\\| 421 \\\\| 423 \\\\| 500 \\\\| 501 \\\\| 502 \\\\| 503 \\\\| 504 \\\\| 505 \\\\| 506 \\\\| 507 \\\\| 508 \\\\| 509 \\\\| 590 \\\\| 591 \\\\| 592 \\\\| 593 \\\\| 594 \\\\| 595 \\\\| 596 \\\\| 597 \\\\| 598 \\\\| 599 \\\\| 670 \\\\| 672 \\\\| 673 \\\\| 674 \\\\| 675 \\\\| 676 \\\\| 677 \\\\| 678 \\\\| 679 \\\\| 680 \\\\| 681 \\\\| 682 \\\\| 683 \\\\| 685 \\\\| 686 \\\\| 687 \\\\| 688 \\\\| 689 \\\\| 690 \\\\| 691 \\\\| 692 \\\\| 850 \\\\| 852 \\\\| 853 \\\\| 855 \\\\| 856 \\\\| 880 \\\\| 886 \\\\| 960 \\\\| 961 \\\\| 962 \\\\| 963 \\\\| 964 \\\\| 965 \\\\| 966 \\\\| 967 \\\\| 968 \\\\| 970 \\\\| 971 \\\\| 972 \\\\| 973 \\\\| 974 \\\\| 975 \\\\| 976 \\\\| 977 \\\\| 992 \\\\| 993 \\\\| 994 \\\\| 995 \\\\| 996 \\\\| 998","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/DataURL":{"id":"reference/api/model/aliases/type-aliases/DataURL","title":"Type Alias: DataURL","description":"DataURL: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/FilePath":{"id":"reference/api/model/aliases/type-aliases/FilePath","title":"Type Alias: FilePath","description":"FilePath: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/GetURL":{"id":"reference/api/model/aliases/type-aliases/GetURL","title":"Type Alias: GetURL","description":"GetURL: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/GroupChatId":{"id":"reference/api/model/aliases/type-aliases/GroupChatId","title":"Type Alias: GroupChatId","description":"GroupChatId: \\\\$\\\\{AccountNumber\\\\}-$\\\\{number\\\\}@$\\\\{GroupChatServer\\\\}\\\\ \\\\| GroupId","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/GroupChatServer":{"id":"reference/api/model/aliases/type-aliases/GroupChatServer","title":"Type Alias: GroupChatServer","description":"GroupChatServer: \\"g.us\\"","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/GroupId":{"id":"reference/api/model/aliases/type-aliases/GroupId","title":"Type Alias: GroupId","description":"GroupId: \\\\$\\\\{number\\\\}@$\\\\{GroupChatServer\\\\}\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/MessageId":{"id":"reference/api/model/aliases/type-aliases/MessageId","title":"Type Alias: MessageId","description":"MessageId: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/NonSerializedId":{"id":"reference/api/model/aliases/type-aliases/NonSerializedId","title":"Type Alias: NonSerializedId","description":"NonSerializedId: object","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/WaServers":{"id":"reference/api/model/aliases/type-aliases/WaServers","title":"Type Alias: WaServers","description":"WaServers: ChatServer \\\\| GroupChatServer","sidebar":"tutorialSidebar"},"reference/api/model/button/index":{"id":"reference/api/model/button/index","title":"api/model/button","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/button/interfaces/AdvancedButton":{"id":"reference/api/model/button/interfaces/AdvancedButton","title":"Interface: AdvancedButton","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/button/interfaces/Button":{"id":"reference/api/model/button/interfaces/Button","title":"Interface: Button","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/button/interfaces/LocationButtonBody":{"id":"reference/api/model/button/interfaces/LocationButtonBody","title":"Interface: LocationButtonBody","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/button/interfaces/Row":{"id":"reference/api/model/button/interfaces/Row","title":"Interface: Row","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/button/interfaces/Section":{"id":"reference/api/model/button/interfaces/Section","title":"Interface: Section","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/call/enumerations/CallState":{"id":"reference/api/model/call/enumerations/CallState","title":"Enumeration: CallState","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/call/index":{"id":"reference/api/model/call/index","title":"api/model/call","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/call/interfaces/Call":{"id":"reference/api/model/call/interfaces/Call","title":"Interface: Call","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/chat/enumerations/ChatMuteDuration":{"id":"reference/api/model/chat/enumerations/ChatMuteDuration","title":"Enumeration: ChatMuteDuration","description":"Valid durations for muting a chat using [[muteChat]]","sidebar":"tutorialSidebar"},"reference/api/model/chat/enumerations/ChatState":{"id":"reference/api/model/chat/enumerations/ChatState","title":"Enumeration: ChatState","description":"The ChatState represents the state you\'d normally see represented under the chat name in the app.","sidebar":"tutorialSidebar"},"reference/api/model/chat/enumerations/ChatTypes":{"id":"reference/api/model/chat/enumerations/ChatTypes","title":"Enumeration: ChatTypes","description":"Chat types","sidebar":"tutorialSidebar"},"reference/api/model/chat/index":{"id":"reference/api/model/chat/index","title":"api/model/chat","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/BaseChat":{"id":"reference/api/model/chat/interfaces/BaseChat","title":"Interface: BaseChat","description":"Extended by","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/GroupChat":{"id":"reference/api/model/chat/interfaces/GroupChat","title":"Interface: GroupChat","description":"Extends","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse":{"id":"reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse","title":"Interface: GroupChatCreationParticipantAddResponse","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/GroupChatCreationResponse":{"id":"reference/api/model/chat/interfaces/GroupChatCreationResponse","title":"Interface: GroupChatCreationResponse","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/LiveLocationChangedEvent":{"id":"reference/api/model/chat/interfaces/LiveLocationChangedEvent","title":"Interface: LiveLocationChangedEvent","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/SingleChat":{"id":"reference/api/model/chat/interfaces/SingleChat","title":"Interface: SingleChat","description":"Extends","sidebar":"tutorialSidebar"},"reference/api/model/chat/type-aliases/Chat":{"id":"reference/api/model/chat/type-aliases/Chat","title":"Type Alias: Chat","description":"Chat: SingleChat \\\\| GroupChat","sidebar":"tutorialSidebar"},"reference/api/model/chat/type-aliases/EphemeralDuration":{"id":"reference/api/model/chat/type-aliases/EphemeralDuration","title":"Type Alias: EphemeralDuration","description":"EphemeralDuration: 86400 \\\\| 604800 \\\\| 7776000","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/CLOUD_PROVIDERS":{"id":"reference/api/model/config/enumerations/CLOUD_PROVIDERS","title":"Enumeration: CLOUD\\\\_PROVIDERS","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/DIRECTORY_STRATEGY":{"id":"reference/api/model/config/enumerations/DIRECTORY_STRATEGY","title":"Enumeration: DIRECTORY\\\\_STRATEGY","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/LicenseType":{"id":"reference/api/model/config/enumerations/LicenseType","title":"Enumeration: LicenseType","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/NotificationLanguage":{"id":"reference/api/model/config/enumerations/NotificationLanguage","title":"Enumeration: NotificationLanguage","description":"The available languages for the host security notification","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/OnError":{"id":"reference/api/model/config/enumerations/OnError","title":"Enumeration: OnError","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/QRFormat":{"id":"reference/api/model/config/enumerations/QRFormat","title":"Enumeration: QRFormat","description":"The different types of qr code output.","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/QRQuality":{"id":"reference/api/model/config/enumerations/QRQuality","title":"Enumeration: QRQuality","description":"The set values of quality you can set for the quality of the qr code output. Ten being the highest quality.","sidebar":"tutorialSidebar"},"reference/api/model/config/index":{"id":"reference/api/model/config/index","title":"api/model/config","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/ConfigObject":{"id":"reference/api/model/config/interfaces/ConfigObject","title":"Interface: ConfigObject","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/DevTools":{"id":"reference/api/model/config/interfaces/DevTools","title":"Interface: DevTools","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/EventPayload":{"id":"reference/api/model/config/interfaces/EventPayload","title":"Interface: EventPayload","description":"Indexable","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/ProxyServerCredentials":{"id":"reference/api/model/config/interfaces/ProxyServerCredentials","title":"Interface: ProxyServerCredentials","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/SessionData":{"id":"reference/api/model/config/interfaces/SessionData","title":"Interface: SessionData","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/Webhook":{"id":"reference/api/model/config/interfaces/Webhook","title":"Interface: Webhook","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/config/type-aliases/AdvancedConfig":{"id":"reference/api/model/config/type-aliases/AdvancedConfig","title":"Type Alias: AdvancedConfig","description":"AdvancedConfig: ConfigObject & object","sidebar":"tutorialSidebar"},"reference/api/model/contact/index":{"id":"reference/api/model/contact/index","title":"api/model/contact","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/BizCategory":{"id":"reference/api/model/contact/interfaces/BizCategory","title":"Interface: BizCategory","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/BizProfileOptions":{"id":"reference/api/model/contact/interfaces/BizProfileOptions","title":"Interface: BizProfileOptions","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/BusinessHours":{"id":"reference/api/model/contact/interfaces/BusinessHours","title":"Interface: BusinessHours","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/BusinessProfile":{"id":"reference/api/model/contact/interfaces/BusinessProfile","title":"Interface: BusinessProfile","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/Contact":{"id":"reference/api/model/contact/interfaces/Contact","title":"Interface: Contact","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/NumberCheck":{"id":"reference/api/model/contact/interfaces/NumberCheck","title":"Interface: NumberCheck","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/enumerations/Events":{"id":"reference/api/model/enumerations/Events","title":"Enumeration: Events","description":"Events that can be emitted by the client","sidebar":"tutorialSidebar"},"reference/api/model/enumerations/STATE":{"id":"reference/api/model/enumerations/STATE","title":"Enumeration: STATE","description":"The state of the WA Web session. You can listen to session state changes using [[onStateChanged]]. Just to be clear, some of these states aren\'t understood completely.","sidebar":"tutorialSidebar"},"reference/api/model/enumerations/Status":{"id":"reference/api/model/enumerations/Status","title":"Enumeration: Status","description":"Client status","sidebar":"tutorialSidebar"},"reference/api/model/errors/classes/AddParticipantError":{"id":"reference/api/model/errors/classes/AddParticipantError","title":"Class: AddParticipantError","description":"Extends","sidebar":"tutorialSidebar"},"reference/api/model/errors/classes/CustomError":{"id":"reference/api/model/errors/classes/CustomError","title":"Class: CustomError","description":"A simple custom error class that takes the first parameter as the name using the [[ERROR_NAME]] enum","sidebar":"tutorialSidebar"},"reference/api/model/errors/classes/PageEvaluationTimeout":{"id":"reference/api/model/errors/classes/PageEvaluationTimeout","title":"Class: PageEvaluationTimeout","description":"Extends","sidebar":"tutorialSidebar"},"reference/api/model/errors/classes/SessionExpiredError":{"id":"reference/api/model/errors/classes/SessionExpiredError","title":"Class: SessionExpiredError","description":"Extends","sidebar":"tutorialSidebar"},"reference/api/model/errors/enumerations/AddParticipantErrorStatusCode":{"id":"reference/api/model/errors/enumerations/AddParticipantErrorStatusCode","title":"Enumeration: AddParticipantErrorStatusCode","description":"Add Participants Status Code Enum","sidebar":"tutorialSidebar"},"reference/api/model/errors/enumerations/ERROR_NAME":{"id":"reference/api/model/errors/enumerations/ERROR_NAME","title":"Enumeration: ERROR\\\\_NAME","description":"Enum of error names specific to this library","sidebar":"tutorialSidebar"},"reference/api/model/errors/index":{"id":"reference/api/model/errors/index","title":"api/model/errors","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/events/enumerations/SimpleListener":{"id":"reference/api/model/events/enumerations/SimpleListener","title":"Enumeration: SimpleListener","description":"An enum of all the \\"simple listeners\\". A simple listener is a listener that just takes one parameter which is the callback function to handle the event.","sidebar":"tutorialSidebar"},"reference/api/model/events/index":{"id":"reference/api/model/events/index","title":"api/model/events","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/enumerations/groupChangeEvent":{"id":"reference/api/model/group-metadata/enumerations/groupChangeEvent","title":"Enumeration: groupChangeEvent","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/enumerations/GroupNotificationTypes":{"id":"reference/api/model/group-metadata/enumerations/GroupNotificationTypes","title":"Enumeration: GroupNotificationTypes","description":"Group notification types","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/index":{"id":"reference/api/model/group-metadata/index","title":"api/model/group-metadata","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent":{"id":"reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent","title":"Interface: GenericGroupChangeEvent","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/interfaces/GroupMetadata":{"id":"reference/api/model/group-metadata/interfaces/GroupMetadata","title":"Interface: GroupMetadata","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/interfaces/NewCommunityGroup":{"id":"reference/api/model/group-metadata/interfaces/NewCommunityGroup","title":"Interface: NewCommunityGroup","description":"Used when creating a new community with.","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/interfaces/Participant":{"id":"reference/api/model/group-metadata/interfaces/Participant","title":"Interface: Participant","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel":{"id":"reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel","title":"Interface: ParticipantChangedEventModel","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/id/index":{"id":"reference/api/model/id/index","title":"api/model/id","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/id/interfaces/Id":{"id":"reference/api/model/id/interfaces/Id","title":"Interface: Id","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/index":{"id":"reference/api/model/index","title":"api/model","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/label/index":{"id":"reference/api/model/label/index","title":"api/model/label","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/label/interfaces/Label":{"id":"reference/api/model/label/interfaces/Label","title":"Interface: Label","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/media/index":{"id":"reference/api/model/media/index","title":"api/model/media","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions":{"id":"reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions","title":"Type Alias: Mp4StickerConversionProcessOptions","description":"Mp4StickerConversionProcessOptions: object","sidebar":"tutorialSidebar"},"reference/api/model/media/type-aliases/StickerMetadata":{"id":"reference/api/model/media/type-aliases/StickerMetadata","title":"Type Alias: StickerMetadata","description":"StickerMetadata: object","sidebar":"tutorialSidebar"},"reference/api/model/media/variables/defaultProcessOptions":{"id":"reference/api/model/media/variables/defaultProcessOptions","title":"Variable: defaultProcessOptions","description":"const defaultProcessOptions: Mp4StickerConversionProcessOptions","sidebar":"tutorialSidebar"},"reference/api/model/message/enumerations/MessageAck":{"id":"reference/api/model/message/enumerations/MessageAck","title":"Enumeration: MessageAck","description":"Message ACK","sidebar":"tutorialSidebar"},"reference/api/model/message/enumerations/MessageTypes":{"id":"reference/api/model/message/enumerations/MessageTypes","title":"Enumeration: MessageTypes","description":"Message types","sidebar":"tutorialSidebar"},"reference/api/model/message/index":{"id":"reference/api/model/message/index","title":"api/model/message","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/Message":{"id":"reference/api/model/message/interfaces/Message","title":"Interface: Message","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/MessageInfo":{"id":"reference/api/model/message/interfaces/MessageInfo","title":"Interface: MessageInfo","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/MessageInfoInteraction":{"id":"reference/api/model/message/interfaces/MessageInfoInteraction","title":"Interface: MessageInfoInteraction","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/PollData":{"id":"reference/api/model/message/interfaces/PollData","title":"Interface: PollData","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/PollOption":{"id":"reference/api/model/message/interfaces/PollOption","title":"Interface: PollOption","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/PollVote":{"id":"reference/api/model/message/interfaces/PollVote","title":"Interface: PollVote","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/QuoteMap":{"id":"reference/api/model/message/interfaces/QuoteMap","title":"Interface: QuoteMap","description":"Indexable","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/ReactionSender":{"id":"reference/api/model/message/interfaces/ReactionSender","title":"Interface: ReactionSender","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/product/index":{"id":"reference/api/model/product/index","title":"api/model/product","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/product/interfaces/CartItem":{"id":"reference/api/model/product/interfaces/CartItem","title":"Interface: CartItem","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/product/interfaces/CustomProduct":{"id":"reference/api/model/product/interfaces/CustomProduct","title":"Interface: CustomProduct","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/product/interfaces/Order":{"id":"reference/api/model/product/interfaces/Order","title":"Interface: Order","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/product/interfaces/Product":{"id":"reference/api/model/product/interfaces/Product","title":"Interface: Product","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/reactions/index":{"id":"reference/api/model/reactions/index","title":"api/model/reactions","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/reactions/type-aliases/Reaction":{"id":"reference/api/model/reactions/type-aliases/Reaction","title":"Type Alias: Reaction","description":"Reaction: object","sidebar":"tutorialSidebar"},"reference/api/model/reactions/type-aliases/ReactionEvent":{"id":"reference/api/model/reactions/type-aliases/ReactionEvent","title":"Type Alias: ReactionEvent","description":"ReactionEvent: object","sidebar":"tutorialSidebar"},"reference/api/model/reactions/type-aliases/ReactionRecord":{"id":"reference/api/model/reactions/type-aliases/ReactionRecord","title":"Type Alias: ReactionRecord","description":"ReactionRecord: object","sidebar":"tutorialSidebar"},"reference/api/model/sessionInfo/index":{"id":"reference/api/model/sessionInfo/index","title":"api/model/sessionInfo","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/sessionInfo/interfaces/HealthCheck":{"id":"reference/api/model/sessionInfo/interfaces/HealthCheck","title":"Interface: HealthCheck","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/sessionInfo/interfaces/SessionInfo":{"id":"reference/api/model/sessionInfo/interfaces/SessionInfo","title":"Interface: SessionInfo","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/type-aliases/EasyApiResponse":{"id":"reference/api/model/type-aliases/EasyApiResponse","title":"Type Alias: EasyApiResponse","description":"EasyApiResponse: object","sidebar":"tutorialSidebar"},"reference/controllers/events/index":{"id":"reference/controllers/events/index","title":"controllers/events","description":"Index","sidebar":"tutorialSidebar"},"reference/controllers/events/variables/ev":{"id":"reference/controllers/events/variables/ev","title":"Variable: ev","description":"const ev: EventEmitter2","sidebar":"tutorialSidebar"},"reference/controllers/init_patch/index":{"id":"reference/controllers/init_patch/index","title":"controllers/init\\\\_patch","description":"","sidebar":"tutorialSidebar"},"reference/controllers/initializer/functions/create":{"id":"reference/controllers/initializer/functions/create","title":"Function: create()","description":"create(config): Promise\\\\","sidebar":"tutorialSidebar"},"reference/controllers/initializer/functions/timeout":{"id":"reference/controllers/initializer/functions/timeout","title":"Function: timeout()","description":"timeout(ms): Promise\\\\","sidebar":"tutorialSidebar"},"reference/controllers/initializer/index":{"id":"reference/controllers/initializer/index","title":"controllers/initializer","description":"Index","sidebar":"tutorialSidebar"},"reference/controllers/initializer/variables/configWithCases":{"id":"reference/controllers/initializer/variables/configWithCases","title":"Variable: configWithCases","description":"const configWithCases: any","sidebar":"tutorialSidebar"},"reference/controllers/initializer/variables/pkg":{"id":"reference/controllers/initializer/variables/pkg","title":"Variable: pkg","description":"const pkg: any","sidebar":"tutorialSidebar"},"reference/controllers/initializer/variables/screenshot":{"id":"reference/controllers/initializer/variables/screenshot","title":"Variable: screenshot","description":"screenshot: any","sidebar":"tutorialSidebar"},"reference/controllers/patch_manager/functions/earlyInjectionCheck":{"id":"reference/controllers/patch_manager/functions/earlyInjectionCheck","title":"Function: earlyInjectionCheck()","description":"earlyInjectionCheck(page): Promise\\\\ boolean\\\\>","sidebar":"tutorialSidebar"},"reference/controllers/patch_manager/functions/getAndInjectLicense":{"id":"reference/controllers/patch_manager/functions/getAndInjectLicense","title":"Function: getAndInjectLicense()","description":"getAndInjectLicense(page, config, me, debugInfo, spinner?, preloadedLicense?): Promise\\\\","sidebar":"tutorialSidebar"},"reference/controllers/patch_manager/index":{"id":"reference/controllers/patch_manager/index","title":"controllers/patch\\\\_manager","description":"Index","sidebar":"tutorialSidebar"},"reference/index":{"id":"reference/index","title":"@open-wa/wa-automate v4.72.5","description":"Modules","sidebar":"tutorialSidebar"},"reference/logging/custom_transport/classes/LogToEvTransport":{"id":"reference/logging/custom_transport/classes/LogToEvTransport","title":"Class: LogToEvTransport","description":"Extends","sidebar":"tutorialSidebar"},"reference/logging/custom_transport/classes/NoOpTransport":{"id":"reference/logging/custom_transport/classes/NoOpTransport","title":"Class: NoOpTransport","description":"Extends","sidebar":"tutorialSidebar"},"reference/logging/custom_transport/index":{"id":"reference/logging/custom_transport/index","title":"logging/custom\\\\_transport","description":"Index","sidebar":"tutorialSidebar"},"reference/logging/logging/functions/addRotateFileLogTransport":{"id":"reference/logging/logging/functions/addRotateFileLogTransport","title":"Function: addRotateFileLogTransport()","description":"addRotateFileLogTransport(options): void","sidebar":"tutorialSidebar"},"reference/logging/logging/index":{"id":"reference/logging/logging/index","title":"logging/logging","description":"Index","sidebar":"tutorialSidebar"},"reference/logging/logging/type-aliases/ConfigLogTransport":{"id":"reference/logging/logging/type-aliases/ConfigLogTransport","title":"Type Alias: ConfigLogTransport","description":"ConfigLogTransport: object","sidebar":"tutorialSidebar"},"reference/logging/logging/variables/log":{"id":"reference/logging/logging/variables/log","title":"Variable: log","description":"const log: Logger","sidebar":"tutorialSidebar"},"reference/structures/Collector/classes/Collection":{"id":"reference/structures/Collector/classes/Collection","title":"Class: Collection\\\\","description":"Extends","sidebar":"tutorialSidebar"},"reference/structures/Collector/classes/Collector":{"id":"reference/structures/Collector/classes/Collector","title":"Class: Collector","description":"Abstract class for defining a new Collector.","sidebar":"tutorialSidebar"},"reference/structures/Collector/index":{"id":"reference/structures/Collector/index","title":"structures/Collector","description":"Index","sidebar":"tutorialSidebar"},"reference/structures/Collector/interfaces/AwaitMessagesOptions":{"id":"reference/structures/Collector/interfaces/AwaitMessagesOptions","title":"Interface: AwaitMessagesOptions","description":"Options to be applied to the collector.","sidebar":"tutorialSidebar"},"reference/structures/Collector/interfaces/CollectorOptions":{"id":"reference/structures/Collector/interfaces/CollectorOptions","title":"Interface: CollectorOptions","description":"Options to be applied to the collector.","sidebar":"tutorialSidebar"},"reference/structures/Collector/type-aliases/CollectorFilter":{"id":"reference/structures/Collector/type-aliases/CollectorFilter","title":"Type Alias: CollectorFilter()\\\\","description":"CollectorFilter\\\\: (...args) => boolean \\\\| Promise\\\\","sidebar":"tutorialSidebar"},"reference/structures/Dialog/enumerations/ValidationType":{"id":"reference/structures/Dialog/enumerations/ValidationType","title":"Enumeration: ValidationType","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/structures/Dialog/index":{"id":"reference/structures/Dialog/index","title":"structures/Dialog","description":"Index","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/CurrentDialogProps":{"id":"reference/structures/Dialog/interfaces/CurrentDialogProps","title":"Interface: CurrentDialogProps","description":"Indexable","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogButtons":{"id":"reference/structures/Dialog/interfaces/DialogButtons","title":"Interface: DialogButtons","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogListMessageRow":{"id":"reference/structures/Dialog/interfaces/DialogListMessageRow","title":"Interface: DialogListMessageRow","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogListMessageSection":{"id":"reference/structures/Dialog/interfaces/DialogListMessageSection","title":"Interface: DialogListMessageSection","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogProperty":{"id":"reference/structures/Dialog/interfaces/DialogProperty","title":"Interface: DialogProperty","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogState":{"id":"reference/structures/Dialog/interfaces/DialogState","title":"Interface: DialogState","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogTemplate":{"id":"reference/structures/Dialog/interfaces/DialogTemplate","title":"Interface: DialogTemplate","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogValidation":{"id":"reference/structures/Dialog/interfaces/DialogValidation","title":"Interface: DialogValidation","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/type-aliases/CheckFunction":{"id":"reference/structures/Dialog/type-aliases/CheckFunction","title":"Type Alias: CheckFunction()","description":"CheckFunction: (lastReceivedMessage, currentProps) => boolean","sidebar":"tutorialSidebar"},"reference/structures/MessageCollector/classes/MessageCollector":{"id":"reference/structures/MessageCollector/classes/MessageCollector","title":"Class: MessageCollector","description":"Collects messages on a chat.","sidebar":"tutorialSidebar"},"reference/structures/MessageCollector/index":{"id":"reference/structures/MessageCollector/index","title":"structures/MessageCollector","description":"Index","sidebar":"tutorialSidebar"},"reference/structures/preProcessors/enumerations/PREPROCESSORS":{"id":"reference/structures/preProcessors/enumerations/PREPROCESSORS","title":"Enumeration: PREPROCESSORS","description":"A set of easy to use, built-in message processors.","sidebar":"tutorialSidebar"},"reference/structures/preProcessors/index":{"id":"reference/structures/preProcessors/index","title":"structures/preProcessors","description":"Index","sidebar":"tutorialSidebar"},"reference/structures/preProcessors/type-aliases/MessagePreProcessor":{"id":"reference/structures/preProcessors/type-aliases/MessagePreProcessor","title":"Type Alias: MessagePreProcessor()","description":"MessagePreProcessor: (message, client?, alreadyProcessed?, source?) => Promise\\\\","sidebar":"tutorialSidebar"},"reference/structures/preProcessors/type-aliases/MPConfigType":{"id":"reference/structures/preProcessors/type-aliases/MPConfigType","title":"Type Alias: MPConfigType","description":"MPConfigType: PREPROCESSORS \\\\| MessagePreProcessor \\\\| (PREPROCESSORS \\\\| MessagePreProcessor)[]","sidebar":"tutorialSidebar"},"reference/structures/preProcessors/variables/MessagePreprocessors":{"id":"reference/structures/preProcessors/variables/MessagePreprocessors","title":"Variable: MessagePreprocessors","description":"const MessagePreprocessors: object","sidebar":"tutorialSidebar"},"tutorial-basics/congratulations":{"id":"tutorial-basics/congratulations","title":"Congratulations!","description":"You have just learned the basics of Docusaurus and made some changes to the initial template.","sidebar":"tutorialSidebar"},"tutorial-basics/create-a-blog-post":{"id":"tutorial-basics/create-a-blog-post","title":"Create a Blog Post","description":"Docusaurus creates a page for each blog post, but also a blog index page, a tag system, an RSS feed...","sidebar":"tutorialSidebar"},"tutorial-basics/create-a-document":{"id":"tutorial-basics/create-a-document","title":"Create a Document","description":"Documents are groups of pages connected through:","sidebar":"tutorialSidebar"},"tutorial-basics/create-a-page":{"id":"tutorial-basics/create-a-page","title":"Create a Page","description":"Add Markdown or React files to src/pages to create a standalone page:","sidebar":"tutorialSidebar"},"tutorial-basics/deploy-your-site":{"id":"tutorial-basics/deploy-your-site","title":"Deploy your site","description":"Docusaurus is a static-site-generator (also called Jamstack).","sidebar":"tutorialSidebar"},"tutorial-basics/markdown-features":{"id":"tutorial-basics/markdown-features","title":"Markdown Features","description":"Docusaurus supports Markdown and a few additional features.","sidebar":"tutorialSidebar"},"tutorial-extras/manage-docs-versions":{"id":"tutorial-extras/manage-docs-versions","title":"Manage Docs Versions","description":"Docusaurus can manage multiple versions of your docs.","sidebar":"tutorialSidebar"},"tutorial-extras/translate-your-site":{"id":"tutorial-extras/translate-your-site","title":"Translate your site","description":"Let\'s translate docs/intro.md to French.","sidebar":"tutorialSidebar"}}}}')}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[849],{6164:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Introduction","href":"/docs/intro","docId":"intro","unlisted":false},{"type":"category","label":"Concepts","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Glossary","href":"/docs/concepts/glossary","docId":"concepts/glossary","unlisted":false},{"type":"link","label":"How does this work?","href":"/docs/concepts/how-it-works","docId":"concepts/how-it-works","unlisted":false}]},{"type":"category","label":"Get Started","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Easy API","href":"/docs/get-started/quick-run","docId":"get-started/quick-run","unlisted":false},{"type":"link","label":"Docker","href":"/docs/get-started/docker","docId":"get-started/docker","unlisted":false},{"type":"link","label":"Custom Code","href":"/docs/get-started/installation","docId":"get-started/installation","unlisted":false},{"type":"link","label":"Link Code Login","href":"/docs/get-started/link-code","docId":"get-started/link-code","unlisted":false},{"type":"link","label":"Socket mode","href":"/docs/get-started/socketmode","docId":"get-started/socketmode","unlisted":false}]},{"type":"category","label":"Configuration","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"The Config Object","href":"/docs/configuration/config-object","docId":"configuration/config-object","unlisted":false},{"type":"link","label":"EASY API CLI options","href":"/docs/configuration/command-line-options","docId":"configuration/command-line-options","unlisted":false},{"type":"link","label":"The Client","href":"/docs/configuration/the-client","docId":"configuration/the-client","unlisted":false},{"type":"link","label":"Capturing QR Code","href":"/docs/configuration/capture-qr","docId":"configuration/capture-qr","unlisted":false},{"type":"link","label":"Capturing the session data","href":"/docs/configuration/capture-sd","docId":"configuration/capture-sd","unlisted":false},{"type":"link","label":"Launch Events","href":"/docs/configuration/launch-events","docId":"configuration/launch-events","unlisted":false},{"type":"link","label":"Licensed Features","href":"/docs/configuration/licensed-features","docId":"configuration/licensed-features","unlisted":false},{"type":"link","label":"Multiple Sessions","href":"/docs/configuration/multiple-sessions","docId":"configuration/multiple-sessions","unlisted":false}]},{"type":"category","label":"Tutorial - Basics","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create a Page","href":"/docs/tutorial-basics/create-a-page","docId":"tutorial-basics/create-a-page","unlisted":false},{"type":"link","label":"Create a Document","href":"/docs/tutorial-basics/create-a-document","docId":"tutorial-basics/create-a-document","unlisted":false},{"type":"link","label":"Create a Blog Post","href":"/docs/tutorial-basics/create-a-blog-post","docId":"tutorial-basics/create-a-blog-post","unlisted":false},{"type":"link","label":"Markdown Features","href":"/docs/tutorial-basics/markdown-features","docId":"tutorial-basics/markdown-features","unlisted":false},{"type":"link","label":"Deploy your site","href":"/docs/tutorial-basics/deploy-your-site","docId":"tutorial-basics/deploy-your-site","unlisted":false},{"type":"link","label":"Congratulations!","href":"/docs/tutorial-basics/congratulations","docId":"tutorial-basics/congratulations","unlisted":false}],"href":"/docs/category/tutorial---basics"},{"type":"category","label":"Advanced","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Best Practice","href":"/docs/advanced/best-practices","docId":"advanced/best-practices","unlisted":false}]},{"type":"category","label":"Tutorial - Extras","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Manage Docs Versions","href":"/docs/tutorial-extras/manage-docs-versions","docId":"tutorial-extras/manage-docs-versions","unlisted":false},{"type":"link","label":"Translate your site","href":"/docs/tutorial-extras/translate-your-site","docId":"tutorial-extras/translate-your-site","unlisted":false}],"href":"/docs/category/tutorial---extras"},{"type":"category","label":"Integrations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Chatwoot integrations","href":"/docs/Integrations/chatwoot","docId":"Integrations/chatwoot","unlisted":false}]},{"type":"link","label":"@open-wa/wa-automate v4.71.15","href":"/docs/api/","docId":"api/index","unlisted":false},{"type":"category","label":"How To","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Creating an API","href":"/docs/how-to/create-api","docId":"how-to/create-api","unlisted":false},{"type":"link","label":"Decrypting Media","href":"/docs/how-to/decrypt-media","docId":"how-to/decrypt-media","unlisted":false},{"type":"link","label":"Detecting Logouts","href":"/docs/how-to/detect-logout","docId":"how-to/detect-logout","unlisted":false},{"type":"link","label":"Group","href":"/docs/how-to/groups","docId":"how-to/groups","unlisted":false},{"type":"link","label":"Error Handling","href":"/docs/how-to/handle-errors","docId":"how-to/handle-errors","unlisted":false},{"type":"link","label":"Handle Incoming Call","href":"/docs/how-to/incoming-calls","docId":"how-to/incoming-calls","unlisted":false},{"type":"link","label":"Location","href":"/docs/how-to/location","docId":"how-to/location","unlisted":false},{"type":"link","label":"Manage Participants","href":"/docs/how-to/manage-participants","docId":"how-to/manage-participants","unlisted":false},{"type":"link","label":"More examples","href":"/docs/how-to/misc","docId":"how-to/misc","unlisted":false},{"type":"link","label":"Reacting To Group Events","href":"/docs/how-to/react-to-group-events","docId":"how-to/react-to-group-events","unlisted":false},{"type":"link","label":"read-state","href":"/docs/how-to/read-state","docId":"how-to/read-state","unlisted":false},{"type":"link","label":"receive-files","href":"/docs/how-to/receive-files","docId":"how-to/receive-files","unlisted":false},{"type":"link","label":"Receiving Messages","href":"/docs/how-to/receive-messages","docId":"how-to/receive-messages","unlisted":false},{"type":"link","label":"Sending Files","href":"/docs/how-to/send-files","docId":"how-to/send-files","unlisted":false},{"type":"link","label":"Sending Messages","href":"/docs/how-to/send-messages","docId":"how-to/send-messages","unlisted":false},{"type":"link","label":"Send Video","href":"/docs/how-to/send-videos","docId":"how-to/send-videos","unlisted":false},{"type":"link","label":"SendFile","href":"/docs/how-to/sendfile","docId":"how-to/sendfile","unlisted":false},{"type":"link","label":"Proxying your session","href":"/docs/how-to/use-a-proxy","docId":"how-to/use-a-proxy","unlisted":false}]},{"type":"category","label":"@open-wa/wa-automate v4.74.0","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"api","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"api/Client","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Class: Client","href":"/docs/reference/api/Client/classes/Client","docId":"reference/api/Client/classes/Client","unlisted":false}]},{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: namespace","href":"/docs/reference/api/Client/enumerations/namespace","docId":"reference/api/Client/enumerations/namespace","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: useragent","href":"/docs/reference/api/Client/variables/useragent","docId":"reference/api/Client/variables/useragent","unlisted":false}]}],"href":"/docs/reference/api/Client/"},{"type":"category","label":"functions","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"api/functions/exposed.enum","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: ExposedFn","href":"/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn","docId":"reference/api/functions/exposed.enum/enumerations/ExposedFn","unlisted":false}]}],"href":"/docs/reference/api/functions/exposed.enum/"}]},{"type":"category","label":"api/model","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"api/model/aliases","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: AccountNumber","href":"/docs/reference/api/model/aliases/type-aliases/AccountNumber","docId":"reference/api/model/aliases/type-aliases/AccountNumber","unlisted":false},{"type":"link","label":"Type Alias: AdvancedFile","href":"/docs/reference/api/model/aliases/type-aliases/AdvancedFile","docId":"reference/api/model/aliases/type-aliases/AdvancedFile","unlisted":false},{"type":"link","label":"Type Alias: Base64","href":"/docs/reference/api/model/aliases/type-aliases/Base64","docId":"reference/api/model/aliases/type-aliases/Base64","unlisted":false},{"type":"link","label":"Type Alias: ChatId","href":"/docs/reference/api/model/aliases/type-aliases/ChatId","docId":"reference/api/model/aliases/type-aliases/ChatId","unlisted":false},{"type":"link","label":"Type Alias: ChatServer","href":"/docs/reference/api/model/aliases/type-aliases/ChatServer","docId":"reference/api/model/aliases/type-aliases/ChatServer","unlisted":false},{"type":"link","label":"Type Alias: ContactId","href":"/docs/reference/api/model/aliases/type-aliases/ContactId","docId":"reference/api/model/aliases/type-aliases/ContactId","unlisted":false},{"type":"link","label":"Type Alias: Content","href":"/docs/reference/api/model/aliases/type-aliases/Content","docId":"reference/api/model/aliases/type-aliases/Content","unlisted":false},{"type":"link","label":"Type Alias: CountryCode","href":"/docs/reference/api/model/aliases/type-aliases/CountryCode","docId":"reference/api/model/aliases/type-aliases/CountryCode","unlisted":false},{"type":"link","label":"Type Alias: DataURL","href":"/docs/reference/api/model/aliases/type-aliases/DataURL","docId":"reference/api/model/aliases/type-aliases/DataURL","unlisted":false},{"type":"link","label":"Type Alias: FilePath","href":"/docs/reference/api/model/aliases/type-aliases/FilePath","docId":"reference/api/model/aliases/type-aliases/FilePath","unlisted":false},{"type":"link","label":"Type Alias: GetURL","href":"/docs/reference/api/model/aliases/type-aliases/GetURL","docId":"reference/api/model/aliases/type-aliases/GetURL","unlisted":false},{"type":"link","label":"Type Alias: GroupChatId","href":"/docs/reference/api/model/aliases/type-aliases/GroupChatId","docId":"reference/api/model/aliases/type-aliases/GroupChatId","unlisted":false},{"type":"link","label":"Type Alias: GroupChatServer","href":"/docs/reference/api/model/aliases/type-aliases/GroupChatServer","docId":"reference/api/model/aliases/type-aliases/GroupChatServer","unlisted":false},{"type":"link","label":"Type Alias: GroupId","href":"/docs/reference/api/model/aliases/type-aliases/GroupId","docId":"reference/api/model/aliases/type-aliases/GroupId","unlisted":false},{"type":"link","label":"Type Alias: MessageId","href":"/docs/reference/api/model/aliases/type-aliases/MessageId","docId":"reference/api/model/aliases/type-aliases/MessageId","unlisted":false},{"type":"link","label":"Type Alias: NonSerializedId","href":"/docs/reference/api/model/aliases/type-aliases/NonSerializedId","docId":"reference/api/model/aliases/type-aliases/NonSerializedId","unlisted":false},{"type":"link","label":"Type Alias: WaServers","href":"/docs/reference/api/model/aliases/type-aliases/WaServers","docId":"reference/api/model/aliases/type-aliases/WaServers","unlisted":false}]}],"href":"/docs/reference/api/model/aliases/"},{"type":"category","label":"api/model/button","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: AdvancedButton","href":"/docs/reference/api/model/button/interfaces/AdvancedButton","docId":"reference/api/model/button/interfaces/AdvancedButton","unlisted":false},{"type":"link","label":"Interface: Button","href":"/docs/reference/api/model/button/interfaces/Button","docId":"reference/api/model/button/interfaces/Button","unlisted":false},{"type":"link","label":"Interface: LocationButtonBody","href":"/docs/reference/api/model/button/interfaces/LocationButtonBody","docId":"reference/api/model/button/interfaces/LocationButtonBody","unlisted":false},{"type":"link","label":"Interface: Row","href":"/docs/reference/api/model/button/interfaces/Row","docId":"reference/api/model/button/interfaces/Row","unlisted":false},{"type":"link","label":"Interface: Section","href":"/docs/reference/api/model/button/interfaces/Section","docId":"reference/api/model/button/interfaces/Section","unlisted":false}]}],"href":"/docs/reference/api/model/button/"},{"type":"category","label":"api/model/call","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: CallState","href":"/docs/reference/api/model/call/enumerations/CallState","docId":"reference/api/model/call/enumerations/CallState","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: Call","href":"/docs/reference/api/model/call/interfaces/Call","docId":"reference/api/model/call/interfaces/Call","unlisted":false}]}],"href":"/docs/reference/api/model/call/"},{"type":"category","label":"api/model/chat","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: ChatMuteDuration","href":"/docs/reference/api/model/chat/enumerations/ChatMuteDuration","docId":"reference/api/model/chat/enumerations/ChatMuteDuration","unlisted":false},{"type":"link","label":"Enumeration: ChatState","href":"/docs/reference/api/model/chat/enumerations/ChatState","docId":"reference/api/model/chat/enumerations/ChatState","unlisted":false},{"type":"link","label":"Enumeration: ChatTypes","href":"/docs/reference/api/model/chat/enumerations/ChatTypes","docId":"reference/api/model/chat/enumerations/ChatTypes","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: BaseChat","href":"/docs/reference/api/model/chat/interfaces/BaseChat","docId":"reference/api/model/chat/interfaces/BaseChat","unlisted":false},{"type":"link","label":"Interface: GroupChat","href":"/docs/reference/api/model/chat/interfaces/GroupChat","docId":"reference/api/model/chat/interfaces/GroupChat","unlisted":false},{"type":"link","label":"Interface: GroupChatCreationParticipantAddResponse","href":"/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse","docId":"reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse","unlisted":false},{"type":"link","label":"Interface: GroupChatCreationResponse","href":"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse","docId":"reference/api/model/chat/interfaces/GroupChatCreationResponse","unlisted":false},{"type":"link","label":"Interface: LiveLocationChangedEvent","href":"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent","docId":"reference/api/model/chat/interfaces/LiveLocationChangedEvent","unlisted":false},{"type":"link","label":"Interface: SingleChat","href":"/docs/reference/api/model/chat/interfaces/SingleChat","docId":"reference/api/model/chat/interfaces/SingleChat","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: Chat","href":"/docs/reference/api/model/chat/type-aliases/Chat","docId":"reference/api/model/chat/type-aliases/Chat","unlisted":false},{"type":"link","label":"Type Alias: EphemeralDuration","href":"/docs/reference/api/model/chat/type-aliases/EphemeralDuration","docId":"reference/api/model/chat/type-aliases/EphemeralDuration","unlisted":false}]}],"href":"/docs/reference/api/model/chat/"},{"type":"category","label":"api/model/config","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: CLOUD\\\\_PROVIDERS","href":"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS","docId":"reference/api/model/config/enumerations/CLOUD_PROVIDERS","unlisted":false},{"type":"link","label":"Enumeration: DIRECTORY\\\\_STRATEGY","href":"/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY","docId":"reference/api/model/config/enumerations/DIRECTORY_STRATEGY","unlisted":false},{"type":"link","label":"Enumeration: LicenseType","href":"/docs/reference/api/model/config/enumerations/LicenseType","docId":"reference/api/model/config/enumerations/LicenseType","unlisted":false},{"type":"link","label":"Enumeration: NotificationLanguage","href":"/docs/reference/api/model/config/enumerations/NotificationLanguage","docId":"reference/api/model/config/enumerations/NotificationLanguage","unlisted":false},{"type":"link","label":"Enumeration: OnError","href":"/docs/reference/api/model/config/enumerations/OnError","docId":"reference/api/model/config/enumerations/OnError","unlisted":false},{"type":"link","label":"Enumeration: QRFormat","href":"/docs/reference/api/model/config/enumerations/QRFormat","docId":"reference/api/model/config/enumerations/QRFormat","unlisted":false},{"type":"link","label":"Enumeration: QRQuality","href":"/docs/reference/api/model/config/enumerations/QRQuality","docId":"reference/api/model/config/enumerations/QRQuality","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: ConfigObject","href":"/docs/reference/api/model/config/interfaces/ConfigObject","docId":"reference/api/model/config/interfaces/ConfigObject","unlisted":false},{"type":"link","label":"Interface: DevTools","href":"/docs/reference/api/model/config/interfaces/DevTools","docId":"reference/api/model/config/interfaces/DevTools","unlisted":false},{"type":"link","label":"Interface: EventPayload","href":"/docs/reference/api/model/config/interfaces/EventPayload","docId":"reference/api/model/config/interfaces/EventPayload","unlisted":false},{"type":"link","label":"Interface: ProxyServerCredentials","href":"/docs/reference/api/model/config/interfaces/ProxyServerCredentials","docId":"reference/api/model/config/interfaces/ProxyServerCredentials","unlisted":false},{"type":"link","label":"Interface: SessionData","href":"/docs/reference/api/model/config/interfaces/SessionData","docId":"reference/api/model/config/interfaces/SessionData","unlisted":false},{"type":"link","label":"Interface: Webhook","href":"/docs/reference/api/model/config/interfaces/Webhook","docId":"reference/api/model/config/interfaces/Webhook","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: AdvancedConfig","href":"/docs/reference/api/model/config/type-aliases/AdvancedConfig","docId":"reference/api/model/config/type-aliases/AdvancedConfig","unlisted":false}]}],"href":"/docs/reference/api/model/config/"},{"type":"category","label":"api/model/contact","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: BizCategory","href":"/docs/reference/api/model/contact/interfaces/BizCategory","docId":"reference/api/model/contact/interfaces/BizCategory","unlisted":false},{"type":"link","label":"Interface: BizProfileOptions","href":"/docs/reference/api/model/contact/interfaces/BizProfileOptions","docId":"reference/api/model/contact/interfaces/BizProfileOptions","unlisted":false},{"type":"link","label":"Interface: BusinessHours","href":"/docs/reference/api/model/contact/interfaces/BusinessHours","docId":"reference/api/model/contact/interfaces/BusinessHours","unlisted":false},{"type":"link","label":"Interface: BusinessProfile","href":"/docs/reference/api/model/contact/interfaces/BusinessProfile","docId":"reference/api/model/contact/interfaces/BusinessProfile","unlisted":false},{"type":"link","label":"Interface: Contact","href":"/docs/reference/api/model/contact/interfaces/Contact","docId":"reference/api/model/contact/interfaces/Contact","unlisted":false},{"type":"link","label":"Interface: NumberCheck","href":"/docs/reference/api/model/contact/interfaces/NumberCheck","docId":"reference/api/model/contact/interfaces/NumberCheck","unlisted":false}]}],"href":"/docs/reference/api/model/contact/"},{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: Events","href":"/docs/reference/api/model/enumerations/Events","docId":"reference/api/model/enumerations/Events","unlisted":false},{"type":"link","label":"Enumeration: STATE","href":"/docs/reference/api/model/enumerations/STATE","docId":"reference/api/model/enumerations/STATE","unlisted":false},{"type":"link","label":"Enumeration: Status","href":"/docs/reference/api/model/enumerations/Status","docId":"reference/api/model/enumerations/Status","unlisted":false}]},{"type":"category","label":"api/model/errors","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Class: AddParticipantError","href":"/docs/reference/api/model/errors/classes/AddParticipantError","docId":"reference/api/model/errors/classes/AddParticipantError","unlisted":false},{"type":"link","label":"Class: CustomError","href":"/docs/reference/api/model/errors/classes/CustomError","docId":"reference/api/model/errors/classes/CustomError","unlisted":false},{"type":"link","label":"Class: PageEvaluationTimeout","href":"/docs/reference/api/model/errors/classes/PageEvaluationTimeout","docId":"reference/api/model/errors/classes/PageEvaluationTimeout","unlisted":false},{"type":"link","label":"Class: SessionExpiredError","href":"/docs/reference/api/model/errors/classes/SessionExpiredError","docId":"reference/api/model/errors/classes/SessionExpiredError","unlisted":false}]},{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: AddParticipantErrorStatusCode","href":"/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode","docId":"reference/api/model/errors/enumerations/AddParticipantErrorStatusCode","unlisted":false},{"type":"link","label":"Enumeration: ERROR\\\\_NAME","href":"/docs/reference/api/model/errors/enumerations/ERROR_NAME","docId":"reference/api/model/errors/enumerations/ERROR_NAME","unlisted":false}]}],"href":"/docs/reference/api/model/errors/"},{"type":"category","label":"api/model/events","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: SimpleListener","href":"/docs/reference/api/model/events/enumerations/SimpleListener","docId":"reference/api/model/events/enumerations/SimpleListener","unlisted":false}]}],"href":"/docs/reference/api/model/events/"},{"type":"category","label":"api/model/group-metadata","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: GroupNotificationTypes","href":"/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes","docId":"reference/api/model/group-metadata/enumerations/GroupNotificationTypes","unlisted":false},{"type":"link","label":"Enumeration: groupChangeEvent","href":"/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent","docId":"reference/api/model/group-metadata/enumerations/groupChangeEvent","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: GenericGroupChangeEvent","href":"/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent","docId":"reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent","unlisted":false},{"type":"link","label":"Interface: GroupMetadata","href":"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata","docId":"reference/api/model/group-metadata/interfaces/GroupMetadata","unlisted":false},{"type":"link","label":"Interface: NewCommunityGroup","href":"/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup","docId":"reference/api/model/group-metadata/interfaces/NewCommunityGroup","unlisted":false},{"type":"link","label":"Interface: Participant","href":"/docs/reference/api/model/group-metadata/interfaces/Participant","docId":"reference/api/model/group-metadata/interfaces/Participant","unlisted":false},{"type":"link","label":"Interface: ParticipantChangedEventModel","href":"/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel","docId":"reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel","unlisted":false}]}],"href":"/docs/reference/api/model/group-metadata/"},{"type":"category","label":"api/model/id","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: Id","href":"/docs/reference/api/model/id/interfaces/Id","docId":"reference/api/model/id/interfaces/Id","unlisted":false}]}],"href":"/docs/reference/api/model/id/"},{"type":"category","label":"api/model/label","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: Label","href":"/docs/reference/api/model/label/interfaces/Label","docId":"reference/api/model/label/interfaces/Label","unlisted":false}]}],"href":"/docs/reference/api/model/label/"},{"type":"category","label":"api/model/media","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: Mp4StickerConversionProcessOptions","href":"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions","docId":"reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions","unlisted":false},{"type":"link","label":"Type Alias: StickerMetadata","href":"/docs/reference/api/model/media/type-aliases/StickerMetadata","docId":"reference/api/model/media/type-aliases/StickerMetadata","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: defaultProcessOptions","href":"/docs/reference/api/model/media/variables/defaultProcessOptions","docId":"reference/api/model/media/variables/defaultProcessOptions","unlisted":false}]}],"href":"/docs/reference/api/model/media/"},{"type":"category","label":"api/model/message","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: MessageAck","href":"/docs/reference/api/model/message/enumerations/MessageAck","docId":"reference/api/model/message/enumerations/MessageAck","unlisted":false},{"type":"link","label":"Enumeration: MessageTypes","href":"/docs/reference/api/model/message/enumerations/MessageTypes","docId":"reference/api/model/message/enumerations/MessageTypes","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: Message","href":"/docs/reference/api/model/message/interfaces/Message","docId":"reference/api/model/message/interfaces/Message","unlisted":false},{"type":"link","label":"Interface: MessageInfo","href":"/docs/reference/api/model/message/interfaces/MessageInfo","docId":"reference/api/model/message/interfaces/MessageInfo","unlisted":false},{"type":"link","label":"Interface: MessageInfoInteraction","href":"/docs/reference/api/model/message/interfaces/MessageInfoInteraction","docId":"reference/api/model/message/interfaces/MessageInfoInteraction","unlisted":false},{"type":"link","label":"Interface: PollData","href":"/docs/reference/api/model/message/interfaces/PollData","docId":"reference/api/model/message/interfaces/PollData","unlisted":false},{"type":"link","label":"Interface: PollOption","href":"/docs/reference/api/model/message/interfaces/PollOption","docId":"reference/api/model/message/interfaces/PollOption","unlisted":false},{"type":"link","label":"Interface: PollVote","href":"/docs/reference/api/model/message/interfaces/PollVote","docId":"reference/api/model/message/interfaces/PollVote","unlisted":false},{"type":"link","label":"Interface: QuoteMap","href":"/docs/reference/api/model/message/interfaces/QuoteMap","docId":"reference/api/model/message/interfaces/QuoteMap","unlisted":false},{"type":"link","label":"Interface: ReactionSender","href":"/docs/reference/api/model/message/interfaces/ReactionSender","docId":"reference/api/model/message/interfaces/ReactionSender","unlisted":false}]}],"href":"/docs/reference/api/model/message/"},{"type":"category","label":"api/model/product","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: CartItem","href":"/docs/reference/api/model/product/interfaces/CartItem","docId":"reference/api/model/product/interfaces/CartItem","unlisted":false},{"type":"link","label":"Interface: CustomProduct","href":"/docs/reference/api/model/product/interfaces/CustomProduct","docId":"reference/api/model/product/interfaces/CustomProduct","unlisted":false},{"type":"link","label":"Interface: Order","href":"/docs/reference/api/model/product/interfaces/Order","docId":"reference/api/model/product/interfaces/Order","unlisted":false},{"type":"link","label":"Interface: Product","href":"/docs/reference/api/model/product/interfaces/Product","docId":"reference/api/model/product/interfaces/Product","unlisted":false}]}],"href":"/docs/reference/api/model/product/"},{"type":"category","label":"api/model/reactions","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: Reaction","href":"/docs/reference/api/model/reactions/type-aliases/Reaction","docId":"reference/api/model/reactions/type-aliases/Reaction","unlisted":false},{"type":"link","label":"Type Alias: ReactionEvent","href":"/docs/reference/api/model/reactions/type-aliases/ReactionEvent","docId":"reference/api/model/reactions/type-aliases/ReactionEvent","unlisted":false},{"type":"link","label":"Type Alias: ReactionRecord","href":"/docs/reference/api/model/reactions/type-aliases/ReactionRecord","docId":"reference/api/model/reactions/type-aliases/ReactionRecord","unlisted":false}]}],"href":"/docs/reference/api/model/reactions/"},{"type":"category","label":"api/model/sessionInfo","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: HealthCheck","href":"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck","docId":"reference/api/model/sessionInfo/interfaces/HealthCheck","unlisted":false},{"type":"link","label":"Interface: SessionInfo","href":"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo","docId":"reference/api/model/sessionInfo/interfaces/SessionInfo","unlisted":false}]}],"href":"/docs/reference/api/model/sessionInfo/"},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: EasyApiResponse","href":"/docs/reference/api/model/type-aliases/EasyApiResponse","docId":"reference/api/model/type-aliases/EasyApiResponse","unlisted":false}]}],"href":"/docs/reference/api/model/"}]},{"type":"category","label":"controllers","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"controllers/events","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: ev","href":"/docs/reference/controllers/events/variables/ev","docId":"reference/controllers/events/variables/ev","unlisted":false}]}],"href":"/docs/reference/controllers/events/"},{"type":"link","label":"controllers/init\\\\_patch","href":"/docs/reference/controllers/init_patch/","docId":"reference/controllers/init_patch/index","unlisted":false},{"type":"category","label":"controllers/initializer","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"functions","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Function: create()","href":"/docs/reference/controllers/initializer/functions/create","docId":"reference/controllers/initializer/functions/create","unlisted":false},{"type":"link","label":"Function: timeout()","href":"/docs/reference/controllers/initializer/functions/timeout","docId":"reference/controllers/initializer/functions/timeout","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: configWithCases","href":"/docs/reference/controllers/initializer/variables/configWithCases","docId":"reference/controllers/initializer/variables/configWithCases","unlisted":false},{"type":"link","label":"Variable: pkg","href":"/docs/reference/controllers/initializer/variables/pkg","docId":"reference/controllers/initializer/variables/pkg","unlisted":false},{"type":"link","label":"Variable: screenshot","href":"/docs/reference/controllers/initializer/variables/screenshot","docId":"reference/controllers/initializer/variables/screenshot","unlisted":false}]}],"href":"/docs/reference/controllers/initializer/"},{"type":"category","label":"controllers/patch\\\\_manager","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"functions","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Function: earlyInjectionCheck()","href":"/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck","docId":"reference/controllers/patch_manager/functions/earlyInjectionCheck","unlisted":false},{"type":"link","label":"Function: getAndInjectLicense()","href":"/docs/reference/controllers/patch_manager/functions/getAndInjectLicense","docId":"reference/controllers/patch_manager/functions/getAndInjectLicense","unlisted":false}]}],"href":"/docs/reference/controllers/patch_manager/"}]},{"type":"category","label":"logging","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"logging/custom\\\\_transport","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Class: LogToEvTransport","href":"/docs/reference/logging/custom_transport/classes/LogToEvTransport","docId":"reference/logging/custom_transport/classes/LogToEvTransport","unlisted":false},{"type":"link","label":"Class: NoOpTransport","href":"/docs/reference/logging/custom_transport/classes/NoOpTransport","docId":"reference/logging/custom_transport/classes/NoOpTransport","unlisted":false}]}],"href":"/docs/reference/logging/custom_transport/"},{"type":"category","label":"logging/logging","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"functions","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Function: addRotateFileLogTransport()","href":"/docs/reference/logging/logging/functions/addRotateFileLogTransport","docId":"reference/logging/logging/functions/addRotateFileLogTransport","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: ConfigLogTransport","href":"/docs/reference/logging/logging/type-aliases/ConfigLogTransport","docId":"reference/logging/logging/type-aliases/ConfigLogTransport","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: log","href":"/docs/reference/logging/logging/variables/log","docId":"reference/logging/logging/variables/log","unlisted":false}]}],"href":"/docs/reference/logging/logging/"}]},{"type":"category","label":"structures","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"structures/Collector","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Class: Collection\\\\","href":"/docs/reference/structures/Collector/classes/Collection","docId":"reference/structures/Collector/classes/Collection","unlisted":false},{"type":"link","label":"Class: Collector","href":"/docs/reference/structures/Collector/classes/Collector","docId":"reference/structures/Collector/classes/Collector","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: AwaitMessagesOptions","href":"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions","docId":"reference/structures/Collector/interfaces/AwaitMessagesOptions","unlisted":false},{"type":"link","label":"Interface: CollectorOptions","href":"/docs/reference/structures/Collector/interfaces/CollectorOptions","docId":"reference/structures/Collector/interfaces/CollectorOptions","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: CollectorFilter()\\\\","href":"/docs/reference/structures/Collector/type-aliases/CollectorFilter","docId":"reference/structures/Collector/type-aliases/CollectorFilter","unlisted":false}]}],"href":"/docs/reference/structures/Collector/"},{"type":"category","label":"structures/Dialog","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: ValidationType","href":"/docs/reference/structures/Dialog/enumerations/ValidationType","docId":"reference/structures/Dialog/enumerations/ValidationType","unlisted":false}]},{"type":"category","label":"interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Interface: CurrentDialogProps","href":"/docs/reference/structures/Dialog/interfaces/CurrentDialogProps","docId":"reference/structures/Dialog/interfaces/CurrentDialogProps","unlisted":false},{"type":"link","label":"Interface: DialogButtons","href":"/docs/reference/structures/Dialog/interfaces/DialogButtons","docId":"reference/structures/Dialog/interfaces/DialogButtons","unlisted":false},{"type":"link","label":"Interface: DialogListMessageRow","href":"/docs/reference/structures/Dialog/interfaces/DialogListMessageRow","docId":"reference/structures/Dialog/interfaces/DialogListMessageRow","unlisted":false},{"type":"link","label":"Interface: DialogListMessageSection","href":"/docs/reference/structures/Dialog/interfaces/DialogListMessageSection","docId":"reference/structures/Dialog/interfaces/DialogListMessageSection","unlisted":false},{"type":"link","label":"Interface: DialogProperty","href":"/docs/reference/structures/Dialog/interfaces/DialogProperty","docId":"reference/structures/Dialog/interfaces/DialogProperty","unlisted":false},{"type":"link","label":"Interface: DialogState","href":"/docs/reference/structures/Dialog/interfaces/DialogState","docId":"reference/structures/Dialog/interfaces/DialogState","unlisted":false},{"type":"link","label":"Interface: DialogTemplate","href":"/docs/reference/structures/Dialog/interfaces/DialogTemplate","docId":"reference/structures/Dialog/interfaces/DialogTemplate","unlisted":false},{"type":"link","label":"Interface: DialogValidation","href":"/docs/reference/structures/Dialog/interfaces/DialogValidation","docId":"reference/structures/Dialog/interfaces/DialogValidation","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: CheckFunction()","href":"/docs/reference/structures/Dialog/type-aliases/CheckFunction","docId":"reference/structures/Dialog/type-aliases/CheckFunction","unlisted":false}]}],"href":"/docs/reference/structures/Dialog/"},{"type":"category","label":"structures/MessageCollector","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"classes","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Class: MessageCollector","href":"/docs/reference/structures/MessageCollector/classes/MessageCollector","docId":"reference/structures/MessageCollector/classes/MessageCollector","unlisted":false}]}],"href":"/docs/reference/structures/MessageCollector/"},{"type":"category","label":"structures/preProcessors","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"enumerations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Enumeration: PREPROCESSORS","href":"/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS","docId":"reference/structures/preProcessors/enumerations/PREPROCESSORS","unlisted":false}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: MPConfigType","href":"/docs/reference/structures/preProcessors/type-aliases/MPConfigType","docId":"reference/structures/preProcessors/type-aliases/MPConfigType","unlisted":false},{"type":"link","label":"Type Alias: MessagePreProcessor()","href":"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor","docId":"reference/structures/preProcessors/type-aliases/MessagePreProcessor","unlisted":false}]},{"type":"category","label":"variables","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Variable: MessagePreprocessors","href":"/docs/reference/structures/preProcessors/variables/MessagePreprocessors","docId":"reference/structures/preProcessors/variables/MessagePreprocessors","unlisted":false}]}],"href":"/docs/reference/structures/preProcessors/"}]}],"href":"/docs/reference/"}]},"docs":{"advanced/best-practices":{"id":"advanced/best-practices","title":"Best Practice","description":"Since this is not an officially sanctioned solution it is temperamental to say the least. Here are some best practices:","sidebar":"tutorialSidebar"},"api/index":{"id":"api/index","title":"@open-wa/wa-automate v4.71.15","description":"Modules","sidebar":"tutorialSidebar"},"concepts/glossary":{"id":"concepts/glossary","title":"Glossary of terms","description":"In order to get used to this project, you might find it useful to learn a few regularly used terms","sidebar":"tutorialSidebar"},"concepts/how-it-works":{"id":"concepts/how-it-works","title":"How does this work?","description":"wa-automate works by automating a chrome/chromium browser process, injecting some code into the web page and exposing functionality through the \\"Client\\". Think of it like a robot sitting in front of your whatsapp web and you\'re controlling that robot with an API or via code.","sidebar":"tutorialSidebar"},"configuration/capture-qr":{"id":"configuration/capture-qr","title":"Capturing QR Code","description":"An event is emitted every time the QR code is received by the system. You can grab hold of this event emitter by importing ev. You can capture this qr code and save it to a file.","sidebar":"tutorialSidebar"},"configuration/capture-sd":{"id":"configuration/capture-sd","title":"Capturing the session data","description":"By default, the session data is saved as a [sessionId].data.json file in the process working directory, however, you can disable this ([ConfigObject.skipSessionSave]) and implement a custom handler for session data. It is important that you always update session data with the latest values. The default behaviour is to override the data.json file with the latest session data.","sidebar":"tutorialSidebar"},"configuration/command-line-options":{"id":"configuration/command-line-options","title":"EASY API CLI options","description":"Command-line options reference documentation.","sidebar":"tutorialSidebar"},"configuration/config-object":{"id":"configuration/config-object","title":"Configuration","description":"Guide showing how to edit the settings.","sidebar":"tutorialSidebar"},"configuration/launch-events":{"id":"configuration/launch-events","title":"Launch Events","description":"When you call create] there is actually a lot happening in the background and in some use cases, it may be useful to listen to those events. In order to do this you have to use the built in event emitter [ev:","sidebar":"tutorialSidebar"},"configuration/licensed-features":{"id":"configuration/licensed-features","title":"Licensed Features","description":"Features","sidebar":"tutorialSidebar"},"configuration/multiple-sessions":{"id":"configuration/multiple-sessions","title":"Multiple Sessions","description":"You can run multiple sessions of @open-wa/wa-automate in the same process. This allows you to do interesting things for example:","sidebar":"tutorialSidebar"},"configuration/the-client":{"id":"configuration/the-client","title":"The Client","description":"Guide showing how to edit the settings.","sidebar":"tutorialSidebar"},"get-started/docker":{"id":"get-started/docker","title":"Get started with wa-automate via Docker","description":"Guide showing how to use wa-automate with Docker. This also covers how to import data as well as persistence.","sidebar":"tutorialSidebar"},"get-started/installation":{"id":"get-started/installation","title":"Custom Code","description":"Standard Installation","sidebar":"tutorialSidebar"},"get-started/link-code":{"id":"get-started/link-code","title":"Logging in with a link code","description":"Simple docs showing how to use open-wa/wa-automate with a link code.","sidebar":"tutorialSidebar"},"get-started/quick-run":{"id":"get-started/quick-run","title":"Get started with wa-automate via Docker","description":"Guide showing how to use wa-automate with Docker. This also covers how to import data as well as persistence.","sidebar":"tutorialSidebar"},"get-started/socketmode":{"id":"get-started/socketmode","title":"Socket mode","description":"Guide showing how to develop your own solutions without needing to wait for session restarts.","sidebar":"tutorialSidebar"},"how-to/create-api":{"id":"how-to/create-api","title":"Creating an API","description":"There are multiple convinient ways to create an API.","sidebar":"tutorialSidebar"},"how-to/decrypt-media":{"id":"how-to/decrypt-media","title":"Decrypting Media","description":"Here is a sample of how to decrypt media. This has been tested on images, videos, documents, audio and voice notes.","sidebar":"tutorialSidebar"},"how-to/detect-logout":{"id":"how-to/detect-logout","title":"Detecting Logouts","description":"First use [[onStateChanged]] to detect changes in the session state. Then use [[forceRefocus]] to force the the app to continue working. If state equals UNPAIRED that means the host account user has manually de authenticated the session through the app.","sidebar":"tutorialSidebar"},"how-to/groups":{"id":"how-to/groups","title":"Group","description":"Create a Group","sidebar":"tutorialSidebar"},"how-to/handle-errors":{"id":"how-to/handle-errors","title":"Error Handling","description":"Keep your promises!","sidebar":"tutorialSidebar"},"how-to/incoming-calls":{"id":"how-to/incoming-calls","title":"Handle Incoming Call","description":"[[onIncomingCall]] emits a [[Call]] object. You can use this to tell people not to call the number","sidebar":"tutorialSidebar"},"how-to/location":{"id":"how-to/location","title":"Location","description":"Sending Location","sidebar":"tutorialSidebar"},"how-to/manage-participants":{"id":"how-to/manage-participants","title":"Manage Participants","description":"[[addParticipant]] - add a participant","sidebar":"tutorialSidebar"},"how-to/misc":{"id":"how-to/misc","title":"More examples","description":"Simulate typing","sidebar":"tutorialSidebar"},"how-to/react-to-group-events":{"id":"how-to/react-to-group-events","title":"Reacting To Group Events","description":"For a specific group you can use [[onParticipantsChanged]], this will fire all detectable group participant change events (see: [[ParticipantChangedEventModel]]).","sidebar":"tutorialSidebar"},"how-to/read-state":{"id":"how-to/read-state","title":"read-state","description":"","sidebar":"tutorialSidebar"},"how-to/receive-files":{"id":"how-to/receive-files","title":"receive-files","description":"","sidebar":"tutorialSidebar"},"how-to/receive-messages":{"id":"how-to/receive-messages","title":"Receiving Messages","description":"Listen to only incoming messages","sidebar":"tutorialSidebar"},"how-to/send-files":{"id":"how-to/send-files","title":"Sending Files","description":"Send Image","sidebar":"tutorialSidebar"},"how-to/send-messages":{"id":"how-to/send-messages","title":"Sending Messages","description":"When sending a message, make sure to await the promise. It usually returns an id if the message was sent successfully.","sidebar":"tutorialSidebar"},"how-to/send-videos":{"id":"how-to/send-videos","title":"Send Video","description":"In order to send videos, the client must be started with an instance of chrome! Otherwise videos will be sent as files and not render properly in the app.","sidebar":"tutorialSidebar"},"how-to/sendfile":{"id":"how-to/sendfile","title":"SendFile","description":"","sidebar":"tutorialSidebar"},"how-to/use-a-proxy":{"id":"how-to/use-a-proxy","title":"Proxying your session","description":"It is extremely simple to use a proxy with @open-wa. Once you have your proxy protocol, address, port, username and password you just need to set the [[proxyServerCredentials]] and @open-wa will connect your session via the proxy. For example, if your proxy details are:","sidebar":"tutorialSidebar"},"Integrations/chatwoot":{"id":"Integrations/chatwoot","title":"Chatwoot integrations","description":"ready made integration for chatwoot.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Introduction","description":"open-wa is a collection of tools designed to enable you to easily automate your WhatsApp account.","sidebar":"tutorialSidebar"},"reference/api/Client/classes/Client":{"id":"reference/api/Client/classes/Client","title":"Class: Client","description":"Methods","sidebar":"tutorialSidebar"},"reference/api/Client/enumerations/namespace":{"id":"reference/api/Client/enumerations/namespace","title":"Enumeration: namespace","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/Client/index":{"id":"reference/api/Client/index","title":"api/Client","description":"Index","sidebar":"tutorialSidebar"},"reference/api/Client/variables/useragent":{"id":"reference/api/Client/variables/useragent","title":"Variable: useragent","description":"const useragent: string","sidebar":"tutorialSidebar"},"reference/api/functions/exposed.enum/enumerations/ExposedFn":{"id":"reference/api/functions/exposed.enum/enumerations/ExposedFn","title":"Enumeration: ExposedFn","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/functions/exposed.enum/index":{"id":"reference/api/functions/exposed.enum/index","title":"api/functions/exposed.enum","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/aliases/index":{"id":"reference/api/model/aliases/index","title":"api/model/aliases","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/AccountNumber":{"id":"reference/api/model/aliases/type-aliases/AccountNumber","title":"Type Alias: AccountNumber","description":"AccountNumber: \\\\$\\\\{number\\\\}\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/AdvancedFile":{"id":"reference/api/model/aliases/type-aliases/AdvancedFile","title":"Type Alias: AdvancedFile","description":"AdvancedFile: DataURL \\\\| FilePath \\\\| GetURL","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/Base64":{"id":"reference/api/model/aliases/type-aliases/Base64","title":"Type Alias: Base64","description":"Base64: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/ChatId":{"id":"reference/api/model/aliases/type-aliases/ChatId","title":"Type Alias: ChatId","description":"ChatId: ContactId \\\\| GroupChatId","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/ChatServer":{"id":"reference/api/model/aliases/type-aliases/ChatServer","title":"Type Alias: ChatServer","description":"ChatServer: \\"c.us\\"","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/ContactId":{"id":"reference/api/model/aliases/type-aliases/ContactId","title":"Type Alias: ContactId","description":"ContactId: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/Content":{"id":"reference/api/model/aliases/type-aliases/Content","title":"Type Alias: Content","description":"Content: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/CountryCode":{"id":"reference/api/model/aliases/type-aliases/CountryCode","title":"Type Alias: CountryCode","description":"CountryCode: 1 \\\\| 7 \\\\| 20 \\\\| 27 \\\\| 30 \\\\| 31 \\\\| 32 \\\\| 33 \\\\| 34 \\\\| 36 \\\\| 39 \\\\| 40 \\\\| 41 \\\\| 43 \\\\| 44 \\\\| 45 \\\\| 46 \\\\| 47 \\\\| 48 \\\\| 49 \\\\| 51 \\\\| 52 \\\\| 53 \\\\| 54 \\\\| 55 \\\\| 56 \\\\| 57 \\\\| 58 \\\\| 60 \\\\| 61 \\\\| 62 \\\\| 63 \\\\| 64 \\\\| 65 \\\\| 66 \\\\| 81 \\\\| 82 \\\\| 84 \\\\| 86 \\\\| 90 \\\\| 91 \\\\| 92 \\\\| 93 \\\\| 94 \\\\| 95 \\\\| 98 \\\\| 211 \\\\| 212 \\\\| 213 \\\\| 216 \\\\| 218 \\\\| 220 \\\\| 221 \\\\| 222 \\\\| 223 \\\\| 224 \\\\| 225 \\\\| 226 \\\\| 227 \\\\| 228 \\\\| 229 \\\\| 230 \\\\| 231 \\\\| 232 \\\\| 233 \\\\| 234 \\\\| 235 \\\\| 236 \\\\| 237 \\\\| 238 \\\\| 239 \\\\| 240 \\\\| 241 \\\\| 242 \\\\| 243 \\\\| 244 \\\\| 245 \\\\| 246 \\\\| 248 \\\\| 249 \\\\| 250 \\\\| 251 \\\\| 252 \\\\| 253 \\\\| 254 \\\\| 255 \\\\| 256 \\\\| 257 \\\\| 258 \\\\| 260 \\\\| 261 \\\\| 262 \\\\| 263 \\\\| 264 \\\\| 265 \\\\| 266 \\\\| 267 \\\\| 268 \\\\| 269 \\\\| 290 \\\\| 291 \\\\| 297 \\\\| 298 \\\\| 299 \\\\| 350 \\\\| 351 \\\\| 352 \\\\| 353 \\\\| 354 \\\\| 355 \\\\| 356 \\\\| 357 \\\\| 358 \\\\| 359 \\\\| 370 \\\\| 371 \\\\| 372 \\\\| 373 \\\\| 374 \\\\| 375 \\\\| 376 \\\\| 377 \\\\| 378 \\\\| 380 \\\\| 381 \\\\| 382 \\\\| 383 \\\\| 385 \\\\| 386 \\\\| 387 \\\\| 389 \\\\| 420 \\\\| 421 \\\\| 423 \\\\| 500 \\\\| 501 \\\\| 502 \\\\| 503 \\\\| 504 \\\\| 505 \\\\| 506 \\\\| 507 \\\\| 508 \\\\| 509 \\\\| 590 \\\\| 591 \\\\| 592 \\\\| 593 \\\\| 594 \\\\| 595 \\\\| 596 \\\\| 597 \\\\| 598 \\\\| 599 \\\\| 670 \\\\| 672 \\\\| 673 \\\\| 674 \\\\| 675 \\\\| 676 \\\\| 677 \\\\| 678 \\\\| 679 \\\\| 680 \\\\| 681 \\\\| 682 \\\\| 683 \\\\| 685 \\\\| 686 \\\\| 687 \\\\| 688 \\\\| 689 \\\\| 690 \\\\| 691 \\\\| 692 \\\\| 850 \\\\| 852 \\\\| 853 \\\\| 855 \\\\| 856 \\\\| 880 \\\\| 886 \\\\| 960 \\\\| 961 \\\\| 962 \\\\| 963 \\\\| 964 \\\\| 965 \\\\| 966 \\\\| 967 \\\\| 968 \\\\| 970 \\\\| 971 \\\\| 972 \\\\| 973 \\\\| 974 \\\\| 975 \\\\| 976 \\\\| 977 \\\\| 992 \\\\| 993 \\\\| 994 \\\\| 995 \\\\| 996 \\\\| 998","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/DataURL":{"id":"reference/api/model/aliases/type-aliases/DataURL","title":"Type Alias: DataURL","description":"DataURL: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/FilePath":{"id":"reference/api/model/aliases/type-aliases/FilePath","title":"Type Alias: FilePath","description":"FilePath: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/GetURL":{"id":"reference/api/model/aliases/type-aliases/GetURL","title":"Type Alias: GetURL","description":"GetURL: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/GroupChatId":{"id":"reference/api/model/aliases/type-aliases/GroupChatId","title":"Type Alias: GroupChatId","description":"GroupChatId: \\\\$\\\\{AccountNumber\\\\}-$\\\\{number\\\\}@$\\\\{GroupChatServer\\\\}\\\\ \\\\| GroupId","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/GroupChatServer":{"id":"reference/api/model/aliases/type-aliases/GroupChatServer","title":"Type Alias: GroupChatServer","description":"GroupChatServer: \\"g.us\\"","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/GroupId":{"id":"reference/api/model/aliases/type-aliases/GroupId","title":"Type Alias: GroupId","description":"GroupId: \\\\$\\\\{number\\\\}@$\\\\{GroupChatServer\\\\}\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/MessageId":{"id":"reference/api/model/aliases/type-aliases/MessageId","title":"Type Alias: MessageId","description":"MessageId: Brand\\\\","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/NonSerializedId":{"id":"reference/api/model/aliases/type-aliases/NonSerializedId","title":"Type Alias: NonSerializedId","description":"NonSerializedId: object","sidebar":"tutorialSidebar"},"reference/api/model/aliases/type-aliases/WaServers":{"id":"reference/api/model/aliases/type-aliases/WaServers","title":"Type Alias: WaServers","description":"WaServers: ChatServer \\\\| GroupChatServer","sidebar":"tutorialSidebar"},"reference/api/model/button/index":{"id":"reference/api/model/button/index","title":"api/model/button","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/button/interfaces/AdvancedButton":{"id":"reference/api/model/button/interfaces/AdvancedButton","title":"Interface: AdvancedButton","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/button/interfaces/Button":{"id":"reference/api/model/button/interfaces/Button","title":"Interface: Button","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/button/interfaces/LocationButtonBody":{"id":"reference/api/model/button/interfaces/LocationButtonBody","title":"Interface: LocationButtonBody","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/button/interfaces/Row":{"id":"reference/api/model/button/interfaces/Row","title":"Interface: Row","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/button/interfaces/Section":{"id":"reference/api/model/button/interfaces/Section","title":"Interface: Section","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/call/enumerations/CallState":{"id":"reference/api/model/call/enumerations/CallState","title":"Enumeration: CallState","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/call/index":{"id":"reference/api/model/call/index","title":"api/model/call","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/call/interfaces/Call":{"id":"reference/api/model/call/interfaces/Call","title":"Interface: Call","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/chat/enumerations/ChatMuteDuration":{"id":"reference/api/model/chat/enumerations/ChatMuteDuration","title":"Enumeration: ChatMuteDuration","description":"Valid durations for muting a chat using [[muteChat]]","sidebar":"tutorialSidebar"},"reference/api/model/chat/enumerations/ChatState":{"id":"reference/api/model/chat/enumerations/ChatState","title":"Enumeration: ChatState","description":"The ChatState represents the state you\'d normally see represented under the chat name in the app.","sidebar":"tutorialSidebar"},"reference/api/model/chat/enumerations/ChatTypes":{"id":"reference/api/model/chat/enumerations/ChatTypes","title":"Enumeration: ChatTypes","description":"Chat types","sidebar":"tutorialSidebar"},"reference/api/model/chat/index":{"id":"reference/api/model/chat/index","title":"api/model/chat","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/BaseChat":{"id":"reference/api/model/chat/interfaces/BaseChat","title":"Interface: BaseChat","description":"Extended by","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/GroupChat":{"id":"reference/api/model/chat/interfaces/GroupChat","title":"Interface: GroupChat","description":"Extends","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse":{"id":"reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse","title":"Interface: GroupChatCreationParticipantAddResponse","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/GroupChatCreationResponse":{"id":"reference/api/model/chat/interfaces/GroupChatCreationResponse","title":"Interface: GroupChatCreationResponse","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/LiveLocationChangedEvent":{"id":"reference/api/model/chat/interfaces/LiveLocationChangedEvent","title":"Interface: LiveLocationChangedEvent","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/chat/interfaces/SingleChat":{"id":"reference/api/model/chat/interfaces/SingleChat","title":"Interface: SingleChat","description":"Extends","sidebar":"tutorialSidebar"},"reference/api/model/chat/type-aliases/Chat":{"id":"reference/api/model/chat/type-aliases/Chat","title":"Type Alias: Chat","description":"Chat: SingleChat \\\\| GroupChat","sidebar":"tutorialSidebar"},"reference/api/model/chat/type-aliases/EphemeralDuration":{"id":"reference/api/model/chat/type-aliases/EphemeralDuration","title":"Type Alias: EphemeralDuration","description":"EphemeralDuration: 86400 \\\\| 604800 \\\\| 7776000","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/CLOUD_PROVIDERS":{"id":"reference/api/model/config/enumerations/CLOUD_PROVIDERS","title":"Enumeration: CLOUD\\\\_PROVIDERS","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/DIRECTORY_STRATEGY":{"id":"reference/api/model/config/enumerations/DIRECTORY_STRATEGY","title":"Enumeration: DIRECTORY\\\\_STRATEGY","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/LicenseType":{"id":"reference/api/model/config/enumerations/LicenseType","title":"Enumeration: LicenseType","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/NotificationLanguage":{"id":"reference/api/model/config/enumerations/NotificationLanguage","title":"Enumeration: NotificationLanguage","description":"The available languages for the host security notification","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/OnError":{"id":"reference/api/model/config/enumerations/OnError","title":"Enumeration: OnError","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/QRFormat":{"id":"reference/api/model/config/enumerations/QRFormat","title":"Enumeration: QRFormat","description":"The different types of qr code output.","sidebar":"tutorialSidebar"},"reference/api/model/config/enumerations/QRQuality":{"id":"reference/api/model/config/enumerations/QRQuality","title":"Enumeration: QRQuality","description":"The set values of quality you can set for the quality of the qr code output. Ten being the highest quality.","sidebar":"tutorialSidebar"},"reference/api/model/config/index":{"id":"reference/api/model/config/index","title":"api/model/config","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/ConfigObject":{"id":"reference/api/model/config/interfaces/ConfigObject","title":"Interface: ConfigObject","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/DevTools":{"id":"reference/api/model/config/interfaces/DevTools","title":"Interface: DevTools","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/EventPayload":{"id":"reference/api/model/config/interfaces/EventPayload","title":"Interface: EventPayload","description":"Indexable","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/ProxyServerCredentials":{"id":"reference/api/model/config/interfaces/ProxyServerCredentials","title":"Interface: ProxyServerCredentials","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/SessionData":{"id":"reference/api/model/config/interfaces/SessionData","title":"Interface: SessionData","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/config/interfaces/Webhook":{"id":"reference/api/model/config/interfaces/Webhook","title":"Interface: Webhook","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/config/type-aliases/AdvancedConfig":{"id":"reference/api/model/config/type-aliases/AdvancedConfig","title":"Type Alias: AdvancedConfig","description":"AdvancedConfig: ConfigObject & object","sidebar":"tutorialSidebar"},"reference/api/model/contact/index":{"id":"reference/api/model/contact/index","title":"api/model/contact","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/BizCategory":{"id":"reference/api/model/contact/interfaces/BizCategory","title":"Interface: BizCategory","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/BizProfileOptions":{"id":"reference/api/model/contact/interfaces/BizProfileOptions","title":"Interface: BizProfileOptions","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/BusinessHours":{"id":"reference/api/model/contact/interfaces/BusinessHours","title":"Interface: BusinessHours","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/BusinessProfile":{"id":"reference/api/model/contact/interfaces/BusinessProfile","title":"Interface: BusinessProfile","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/Contact":{"id":"reference/api/model/contact/interfaces/Contact","title":"Interface: Contact","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/contact/interfaces/NumberCheck":{"id":"reference/api/model/contact/interfaces/NumberCheck","title":"Interface: NumberCheck","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/enumerations/Events":{"id":"reference/api/model/enumerations/Events","title":"Enumeration: Events","description":"Events that can be emitted by the client","sidebar":"tutorialSidebar"},"reference/api/model/enumerations/STATE":{"id":"reference/api/model/enumerations/STATE","title":"Enumeration: STATE","description":"The state of the WA Web session. You can listen to session state changes using [[onStateChanged]]. Just to be clear, some of these states aren\'t understood completely.","sidebar":"tutorialSidebar"},"reference/api/model/enumerations/Status":{"id":"reference/api/model/enumerations/Status","title":"Enumeration: Status","description":"Client status","sidebar":"tutorialSidebar"},"reference/api/model/errors/classes/AddParticipantError":{"id":"reference/api/model/errors/classes/AddParticipantError","title":"Class: AddParticipantError","description":"Extends","sidebar":"tutorialSidebar"},"reference/api/model/errors/classes/CustomError":{"id":"reference/api/model/errors/classes/CustomError","title":"Class: CustomError","description":"A simple custom error class that takes the first parameter as the name using the [[ERROR_NAME]] enum","sidebar":"tutorialSidebar"},"reference/api/model/errors/classes/PageEvaluationTimeout":{"id":"reference/api/model/errors/classes/PageEvaluationTimeout","title":"Class: PageEvaluationTimeout","description":"Extends","sidebar":"tutorialSidebar"},"reference/api/model/errors/classes/SessionExpiredError":{"id":"reference/api/model/errors/classes/SessionExpiredError","title":"Class: SessionExpiredError","description":"Extends","sidebar":"tutorialSidebar"},"reference/api/model/errors/enumerations/AddParticipantErrorStatusCode":{"id":"reference/api/model/errors/enumerations/AddParticipantErrorStatusCode","title":"Enumeration: AddParticipantErrorStatusCode","description":"Add Participants Status Code Enum","sidebar":"tutorialSidebar"},"reference/api/model/errors/enumerations/ERROR_NAME":{"id":"reference/api/model/errors/enumerations/ERROR_NAME","title":"Enumeration: ERROR\\\\_NAME","description":"Enum of error names specific to this library","sidebar":"tutorialSidebar"},"reference/api/model/errors/index":{"id":"reference/api/model/errors/index","title":"api/model/errors","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/events/enumerations/SimpleListener":{"id":"reference/api/model/events/enumerations/SimpleListener","title":"Enumeration: SimpleListener","description":"An enum of all the \\"simple listeners\\". A simple listener is a listener that just takes one parameter which is the callback function to handle the event.","sidebar":"tutorialSidebar"},"reference/api/model/events/index":{"id":"reference/api/model/events/index","title":"api/model/events","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/enumerations/groupChangeEvent":{"id":"reference/api/model/group-metadata/enumerations/groupChangeEvent","title":"Enumeration: groupChangeEvent","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/enumerations/GroupNotificationTypes":{"id":"reference/api/model/group-metadata/enumerations/GroupNotificationTypes","title":"Enumeration: GroupNotificationTypes","description":"Group notification types","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/index":{"id":"reference/api/model/group-metadata/index","title":"api/model/group-metadata","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent":{"id":"reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent","title":"Interface: GenericGroupChangeEvent","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/interfaces/GroupMetadata":{"id":"reference/api/model/group-metadata/interfaces/GroupMetadata","title":"Interface: GroupMetadata","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/interfaces/NewCommunityGroup":{"id":"reference/api/model/group-metadata/interfaces/NewCommunityGroup","title":"Interface: NewCommunityGroup","description":"Used when creating a new community with.","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/interfaces/Participant":{"id":"reference/api/model/group-metadata/interfaces/Participant","title":"Interface: Participant","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel":{"id":"reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel","title":"Interface: ParticipantChangedEventModel","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/id/index":{"id":"reference/api/model/id/index","title":"api/model/id","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/id/interfaces/Id":{"id":"reference/api/model/id/interfaces/Id","title":"Interface: Id","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/index":{"id":"reference/api/model/index","title":"api/model","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/label/index":{"id":"reference/api/model/label/index","title":"api/model/label","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/label/interfaces/Label":{"id":"reference/api/model/label/interfaces/Label","title":"Interface: Label","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/media/index":{"id":"reference/api/model/media/index","title":"api/model/media","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions":{"id":"reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions","title":"Type Alias: Mp4StickerConversionProcessOptions","description":"Mp4StickerConversionProcessOptions: object","sidebar":"tutorialSidebar"},"reference/api/model/media/type-aliases/StickerMetadata":{"id":"reference/api/model/media/type-aliases/StickerMetadata","title":"Type Alias: StickerMetadata","description":"StickerMetadata: object","sidebar":"tutorialSidebar"},"reference/api/model/media/variables/defaultProcessOptions":{"id":"reference/api/model/media/variables/defaultProcessOptions","title":"Variable: defaultProcessOptions","description":"const defaultProcessOptions: Mp4StickerConversionProcessOptions","sidebar":"tutorialSidebar"},"reference/api/model/message/enumerations/MessageAck":{"id":"reference/api/model/message/enumerations/MessageAck","title":"Enumeration: MessageAck","description":"Message ACK","sidebar":"tutorialSidebar"},"reference/api/model/message/enumerations/MessageTypes":{"id":"reference/api/model/message/enumerations/MessageTypes","title":"Enumeration: MessageTypes","description":"Message types","sidebar":"tutorialSidebar"},"reference/api/model/message/index":{"id":"reference/api/model/message/index","title":"api/model/message","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/Message":{"id":"reference/api/model/message/interfaces/Message","title":"Interface: Message","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/MessageInfo":{"id":"reference/api/model/message/interfaces/MessageInfo","title":"Interface: MessageInfo","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/MessageInfoInteraction":{"id":"reference/api/model/message/interfaces/MessageInfoInteraction","title":"Interface: MessageInfoInteraction","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/PollData":{"id":"reference/api/model/message/interfaces/PollData","title":"Interface: PollData","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/PollOption":{"id":"reference/api/model/message/interfaces/PollOption","title":"Interface: PollOption","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/PollVote":{"id":"reference/api/model/message/interfaces/PollVote","title":"Interface: PollVote","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/QuoteMap":{"id":"reference/api/model/message/interfaces/QuoteMap","title":"Interface: QuoteMap","description":"Indexable","sidebar":"tutorialSidebar"},"reference/api/model/message/interfaces/ReactionSender":{"id":"reference/api/model/message/interfaces/ReactionSender","title":"Interface: ReactionSender","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/product/index":{"id":"reference/api/model/product/index","title":"api/model/product","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/product/interfaces/CartItem":{"id":"reference/api/model/product/interfaces/CartItem","title":"Interface: CartItem","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/product/interfaces/CustomProduct":{"id":"reference/api/model/product/interfaces/CustomProduct","title":"Interface: CustomProduct","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/product/interfaces/Order":{"id":"reference/api/model/product/interfaces/Order","title":"Interface: Order","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/product/interfaces/Product":{"id":"reference/api/model/product/interfaces/Product","title":"Interface: Product","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/reactions/index":{"id":"reference/api/model/reactions/index","title":"api/model/reactions","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/reactions/type-aliases/Reaction":{"id":"reference/api/model/reactions/type-aliases/Reaction","title":"Type Alias: Reaction","description":"Reaction: object","sidebar":"tutorialSidebar"},"reference/api/model/reactions/type-aliases/ReactionEvent":{"id":"reference/api/model/reactions/type-aliases/ReactionEvent","title":"Type Alias: ReactionEvent","description":"ReactionEvent: object","sidebar":"tutorialSidebar"},"reference/api/model/reactions/type-aliases/ReactionRecord":{"id":"reference/api/model/reactions/type-aliases/ReactionRecord","title":"Type Alias: ReactionRecord","description":"ReactionRecord: object","sidebar":"tutorialSidebar"},"reference/api/model/sessionInfo/index":{"id":"reference/api/model/sessionInfo/index","title":"api/model/sessionInfo","description":"Index","sidebar":"tutorialSidebar"},"reference/api/model/sessionInfo/interfaces/HealthCheck":{"id":"reference/api/model/sessionInfo/interfaces/HealthCheck","title":"Interface: HealthCheck","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/sessionInfo/interfaces/SessionInfo":{"id":"reference/api/model/sessionInfo/interfaces/SessionInfo","title":"Interface: SessionInfo","description":"Properties","sidebar":"tutorialSidebar"},"reference/api/model/type-aliases/EasyApiResponse":{"id":"reference/api/model/type-aliases/EasyApiResponse","title":"Type Alias: EasyApiResponse","description":"EasyApiResponse: object","sidebar":"tutorialSidebar"},"reference/controllers/events/index":{"id":"reference/controllers/events/index","title":"controllers/events","description":"Index","sidebar":"tutorialSidebar"},"reference/controllers/events/variables/ev":{"id":"reference/controllers/events/variables/ev","title":"Variable: ev","description":"const ev: EventEmitter2","sidebar":"tutorialSidebar"},"reference/controllers/init_patch/index":{"id":"reference/controllers/init_patch/index","title":"controllers/init\\\\_patch","description":"","sidebar":"tutorialSidebar"},"reference/controllers/initializer/functions/create":{"id":"reference/controllers/initializer/functions/create","title":"Function: create()","description":"create(config): Promise\\\\","sidebar":"tutorialSidebar"},"reference/controllers/initializer/functions/timeout":{"id":"reference/controllers/initializer/functions/timeout","title":"Function: timeout()","description":"timeout(ms): Promise\\\\","sidebar":"tutorialSidebar"},"reference/controllers/initializer/index":{"id":"reference/controllers/initializer/index","title":"controllers/initializer","description":"Index","sidebar":"tutorialSidebar"},"reference/controllers/initializer/variables/configWithCases":{"id":"reference/controllers/initializer/variables/configWithCases","title":"Variable: configWithCases","description":"const configWithCases: any","sidebar":"tutorialSidebar"},"reference/controllers/initializer/variables/pkg":{"id":"reference/controllers/initializer/variables/pkg","title":"Variable: pkg","description":"const pkg: any","sidebar":"tutorialSidebar"},"reference/controllers/initializer/variables/screenshot":{"id":"reference/controllers/initializer/variables/screenshot","title":"Variable: screenshot","description":"screenshot: any","sidebar":"tutorialSidebar"},"reference/controllers/patch_manager/functions/earlyInjectionCheck":{"id":"reference/controllers/patch_manager/functions/earlyInjectionCheck","title":"Function: earlyInjectionCheck()","description":"earlyInjectionCheck(page): Promise\\\\ boolean\\\\>","sidebar":"tutorialSidebar"},"reference/controllers/patch_manager/functions/getAndInjectLicense":{"id":"reference/controllers/patch_manager/functions/getAndInjectLicense","title":"Function: getAndInjectLicense()","description":"getAndInjectLicense(page, config, me, debugInfo, spinner?, preloadedLicense?): Promise\\\\","sidebar":"tutorialSidebar"},"reference/controllers/patch_manager/index":{"id":"reference/controllers/patch_manager/index","title":"controllers/patch\\\\_manager","description":"Index","sidebar":"tutorialSidebar"},"reference/index":{"id":"reference/index","title":"@open-wa/wa-automate v4.74.0","description":"Modules","sidebar":"tutorialSidebar"},"reference/logging/custom_transport/classes/LogToEvTransport":{"id":"reference/logging/custom_transport/classes/LogToEvTransport","title":"Class: LogToEvTransport","description":"Extends","sidebar":"tutorialSidebar"},"reference/logging/custom_transport/classes/NoOpTransport":{"id":"reference/logging/custom_transport/classes/NoOpTransport","title":"Class: NoOpTransport","description":"Extends","sidebar":"tutorialSidebar"},"reference/logging/custom_transport/index":{"id":"reference/logging/custom_transport/index","title":"logging/custom\\\\_transport","description":"Index","sidebar":"tutorialSidebar"},"reference/logging/logging/functions/addRotateFileLogTransport":{"id":"reference/logging/logging/functions/addRotateFileLogTransport","title":"Function: addRotateFileLogTransport()","description":"addRotateFileLogTransport(options): void","sidebar":"tutorialSidebar"},"reference/logging/logging/index":{"id":"reference/logging/logging/index","title":"logging/logging","description":"Index","sidebar":"tutorialSidebar"},"reference/logging/logging/type-aliases/ConfigLogTransport":{"id":"reference/logging/logging/type-aliases/ConfigLogTransport","title":"Type Alias: ConfigLogTransport","description":"ConfigLogTransport: object","sidebar":"tutorialSidebar"},"reference/logging/logging/variables/log":{"id":"reference/logging/logging/variables/log","title":"Variable: log","description":"const log: Logger","sidebar":"tutorialSidebar"},"reference/structures/Collector/classes/Collection":{"id":"reference/structures/Collector/classes/Collection","title":"Class: Collection\\\\","description":"Extends","sidebar":"tutorialSidebar"},"reference/structures/Collector/classes/Collector":{"id":"reference/structures/Collector/classes/Collector","title":"Class: Collector","description":"Abstract class for defining a new Collector.","sidebar":"tutorialSidebar"},"reference/structures/Collector/index":{"id":"reference/structures/Collector/index","title":"structures/Collector","description":"Index","sidebar":"tutorialSidebar"},"reference/structures/Collector/interfaces/AwaitMessagesOptions":{"id":"reference/structures/Collector/interfaces/AwaitMessagesOptions","title":"Interface: AwaitMessagesOptions","description":"Options to be applied to the collector.","sidebar":"tutorialSidebar"},"reference/structures/Collector/interfaces/CollectorOptions":{"id":"reference/structures/Collector/interfaces/CollectorOptions","title":"Interface: CollectorOptions","description":"Options to be applied to the collector.","sidebar":"tutorialSidebar"},"reference/structures/Collector/type-aliases/CollectorFilter":{"id":"reference/structures/Collector/type-aliases/CollectorFilter","title":"Type Alias: CollectorFilter()\\\\","description":"CollectorFilter\\\\: (...args) => boolean \\\\| Promise\\\\","sidebar":"tutorialSidebar"},"reference/structures/Dialog/enumerations/ValidationType":{"id":"reference/structures/Dialog/enumerations/ValidationType","title":"Enumeration: ValidationType","description":"Enumeration Members","sidebar":"tutorialSidebar"},"reference/structures/Dialog/index":{"id":"reference/structures/Dialog/index","title":"structures/Dialog","description":"Index","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/CurrentDialogProps":{"id":"reference/structures/Dialog/interfaces/CurrentDialogProps","title":"Interface: CurrentDialogProps","description":"Indexable","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogButtons":{"id":"reference/structures/Dialog/interfaces/DialogButtons","title":"Interface: DialogButtons","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogListMessageRow":{"id":"reference/structures/Dialog/interfaces/DialogListMessageRow","title":"Interface: DialogListMessageRow","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogListMessageSection":{"id":"reference/structures/Dialog/interfaces/DialogListMessageSection","title":"Interface: DialogListMessageSection","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogProperty":{"id":"reference/structures/Dialog/interfaces/DialogProperty","title":"Interface: DialogProperty","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogState":{"id":"reference/structures/Dialog/interfaces/DialogState","title":"Interface: DialogState","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogTemplate":{"id":"reference/structures/Dialog/interfaces/DialogTemplate","title":"Interface: DialogTemplate","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/interfaces/DialogValidation":{"id":"reference/structures/Dialog/interfaces/DialogValidation","title":"Interface: DialogValidation","description":"Properties","sidebar":"tutorialSidebar"},"reference/structures/Dialog/type-aliases/CheckFunction":{"id":"reference/structures/Dialog/type-aliases/CheckFunction","title":"Type Alias: CheckFunction()","description":"CheckFunction: (lastReceivedMessage, currentProps) => boolean","sidebar":"tutorialSidebar"},"reference/structures/MessageCollector/classes/MessageCollector":{"id":"reference/structures/MessageCollector/classes/MessageCollector","title":"Class: MessageCollector","description":"Collects messages on a chat.","sidebar":"tutorialSidebar"},"reference/structures/MessageCollector/index":{"id":"reference/structures/MessageCollector/index","title":"structures/MessageCollector","description":"Index","sidebar":"tutorialSidebar"},"reference/structures/preProcessors/enumerations/PREPROCESSORS":{"id":"reference/structures/preProcessors/enumerations/PREPROCESSORS","title":"Enumeration: PREPROCESSORS","description":"A set of easy to use, built-in message processors.","sidebar":"tutorialSidebar"},"reference/structures/preProcessors/index":{"id":"reference/structures/preProcessors/index","title":"structures/preProcessors","description":"Index","sidebar":"tutorialSidebar"},"reference/structures/preProcessors/type-aliases/MessagePreProcessor":{"id":"reference/structures/preProcessors/type-aliases/MessagePreProcessor","title":"Type Alias: MessagePreProcessor()","description":"MessagePreProcessor: (message, client?, alreadyProcessed?, source?) => Promise\\\\","sidebar":"tutorialSidebar"},"reference/structures/preProcessors/type-aliases/MPConfigType":{"id":"reference/structures/preProcessors/type-aliases/MPConfigType","title":"Type Alias: MPConfigType","description":"MPConfigType: PREPROCESSORS \\\\| MessagePreProcessor \\\\| (PREPROCESSORS \\\\| MessagePreProcessor)[]","sidebar":"tutorialSidebar"},"reference/structures/preProcessors/variables/MessagePreprocessors":{"id":"reference/structures/preProcessors/variables/MessagePreprocessors","title":"Variable: MessagePreprocessors","description":"const MessagePreprocessors: object","sidebar":"tutorialSidebar"},"tutorial-basics/congratulations":{"id":"tutorial-basics/congratulations","title":"Congratulations!","description":"You have just learned the basics of Docusaurus and made some changes to the initial template.","sidebar":"tutorialSidebar"},"tutorial-basics/create-a-blog-post":{"id":"tutorial-basics/create-a-blog-post","title":"Create a Blog Post","description":"Docusaurus creates a page for each blog post, but also a blog index page, a tag system, an RSS feed...","sidebar":"tutorialSidebar"},"tutorial-basics/create-a-document":{"id":"tutorial-basics/create-a-document","title":"Create a Document","description":"Documents are groups of pages connected through:","sidebar":"tutorialSidebar"},"tutorial-basics/create-a-page":{"id":"tutorial-basics/create-a-page","title":"Create a Page","description":"Add Markdown or React files to src/pages to create a standalone page:","sidebar":"tutorialSidebar"},"tutorial-basics/deploy-your-site":{"id":"tutorial-basics/deploy-your-site","title":"Deploy your site","description":"Docusaurus is a static-site-generator (also called Jamstack).","sidebar":"tutorialSidebar"},"tutorial-basics/markdown-features":{"id":"tutorial-basics/markdown-features","title":"Markdown Features","description":"Docusaurus supports Markdown and a few additional features.","sidebar":"tutorialSidebar"},"tutorial-extras/manage-docs-versions":{"id":"tutorial-extras/manage-docs-versions","title":"Manage Docs Versions","description":"Docusaurus can manage multiple versions of your docs.","sidebar":"tutorialSidebar"},"tutorial-extras/translate-your-site":{"id":"tutorial-extras/translate-your-site","title":"Translate your site","description":"Let\'s translate docs/intro.md to French.","sidebar":"tutorialSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/0274794e.11ea20e1.js b/assets/js/0274794e.c7d6f30b.js similarity index 97% rename from assets/js/0274794e.11ea20e1.js rename to assets/js/0274794e.c7d6f30b.js index 533fe9581..539cfe32f 100644 --- a/assets/js/0274794e.11ea20e1.js +++ b/assets/js/0274794e.c7d6f30b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6377],{1494:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>t,metadata:()=>l,toc:()=>d});var s=i(4848),r=i(8453);const t={},a="api/Client",l={id:"reference/api/Client/index",title:"api/Client",description:"Index",source:"@site/docs/reference/api/Client/index.md",sourceDirName:"reference/api/Client",slug:"/reference/api/Client/",permalink:"/docs/reference/api/Client/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/Client/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"@open-wa/wa-automate v4.72.5",permalink:"/docs/reference/"},next:{title:"Class: Client",permalink:"/docs/reference/api/Client/classes/Client"}},c={},d=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Classes",id:"classes",level:3},{value:"Variables",id:"variables",level:3}];function o(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"apiclient",children:"api/Client"})}),"\n",(0,s.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,s.jsx)(n.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/docs/reference/api/Client/enumerations/namespace",children:"namespace"})}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"classes",children:"Classes"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/docs/reference/api/Client/classes/Client",children:"Client"})}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"variables",children:"Variables"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/docs/reference/api/Client/variables/useragent",children:"useragent"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>l});var s=i(6540);const r={},t=s.createContext(r);function a(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6377],{1494:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>t,metadata:()=>l,toc:()=>d});var s=i(4848),r=i(8453);const t={},a="api/Client",l={id:"reference/api/Client/index",title:"api/Client",description:"Index",source:"@site/docs/reference/api/Client/index.md",sourceDirName:"reference/api/Client",slug:"/reference/api/Client/",permalink:"/docs/reference/api/Client/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/Client/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"@open-wa/wa-automate v4.74.0",permalink:"/docs/reference/"},next:{title:"Class: Client",permalink:"/docs/reference/api/Client/classes/Client"}},c={},d=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Classes",id:"classes",level:3},{value:"Variables",id:"variables",level:3}];function o(e){const n={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"apiclient",children:"api/Client"})}),"\n",(0,s.jsx)(n.h2,{id:"index",children:"Index"}),"\n",(0,s.jsx)(n.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/docs/reference/api/Client/enumerations/namespace",children:"namespace"})}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"classes",children:"Classes"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/docs/reference/api/Client/classes/Client",children:"Client"})}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"variables",children:"Variables"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/docs/reference/api/Client/variables/useragent",children:"useragent"})}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>l});var s=i(6540);const r={},t=s.createContext(r);function a(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1a3c9b31.635b2b30.js b/assets/js/1a3c9b31.f2e512af.js similarity index 95% rename from assets/js/1a3c9b31.635b2b30.js rename to assets/js/1a3c9b31.f2e512af.js index 770213ccd..faddf5238 100644 --- a/assets/js/1a3c9b31.635b2b30.js +++ b/assets/js/1a3c9b31.f2e512af.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9242],{1307:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>d,contentTitle:()=>l,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var c=n(4848),s=n(8453);const i={},l="@open-wa/wa-automate v4.72.5",o={id:"reference/index",title:"@open-wa/wa-automate v4.72.5",description:"Modules",source:"@site/docs/reference/index.md",sourceDirName:"reference",slug:"/reference/",permalink:"/docs/reference/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Proxying your session",permalink:"/docs/how-to/use-a-proxy"},next:{title:"api/Client",permalink:"/docs/reference/api/Client/"}},d={},a=[{value:"Modules",id:"modules",level:2}];function t(e){const r={a:"a",h1:"h1",h2:"h2",header:"header",li:"li",ul:"ul",...(0,s.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(r.header,{children:(0,c.jsx)(r.h1,{id:"open-wawa-automate-v4725",children:"@open-wa/wa-automate v4.72.5"})}),"\n",(0,c.jsx)(r.h2,{id:"modules",children:"Modules"}),"\n",(0,c.jsxs)(r.ul,{children:["\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/Client/",children:"api/Client"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/functions/exposed.enum/",children:"api/functions/exposed.enum"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/",children:"api/model"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/aliases/",children:"api/model/aliases"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/button/",children:"api/model/button"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/call/",children:"api/model/call"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/chat/",children:"api/model/chat"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/config/",children:"api/model/config"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/contact/",children:"api/model/contact"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/errors/",children:"api/model/errors"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/events/",children:"api/model/events"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/group-metadata/",children:"api/model/group-metadata"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/id/",children:"api/model/id"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/label/",children:"api/model/label"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/media/",children:"api/model/media"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/message/",children:"api/model/message"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/product/",children:"api/model/product"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/reactions/",children:"api/model/reactions"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/sessionInfo/",children:"api/model/sessionInfo"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/controllers/events/",children:"controllers/events"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/controllers/init_patch/",children:"controllers/init_patch"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/controllers/initializer/",children:"controllers/initializer"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/controllers/patch_manager/",children:"controllers/patch_manager"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/logging/custom_transport/",children:"logging/custom_transport"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/logging/logging/",children:"logging/logging"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/structures/Collector/",children:"structures/Collector"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/structures/Dialog/",children:"structures/Dialog"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/structures/MessageCollector/",children:"structures/MessageCollector"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/structures/preProcessors/",children:"structures/preProcessors"})}),"\n"]})]})}function h(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,c.jsx)(r,{...e,children:(0,c.jsx)(t,{...e})}):t(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>l,x:()=>o});var c=n(6540);const s={},i=c.createContext(s);function l(e){const r=c.useContext(i);return c.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),c.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9242],{1307:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>d,contentTitle:()=>l,default:()=>h,frontMatter:()=>i,metadata:()=>o,toc:()=>a});var c=n(4848),s=n(8453);const i={},l="@open-wa/wa-automate v4.74.0",o={id:"reference/index",title:"@open-wa/wa-automate v4.74.0",description:"Modules",source:"@site/docs/reference/index.md",sourceDirName:"reference",slug:"/reference/",permalink:"/docs/reference/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Proxying your session",permalink:"/docs/how-to/use-a-proxy"},next:{title:"api/Client",permalink:"/docs/reference/api/Client/"}},d={},a=[{value:"Modules",id:"modules",level:2}];function t(e){const r={a:"a",h1:"h1",h2:"h2",header:"header",li:"li",ul:"ul",...(0,s.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(r.header,{children:(0,c.jsx)(r.h1,{id:"open-wawa-automate-v4740",children:"@open-wa/wa-automate v4.74.0"})}),"\n",(0,c.jsx)(r.h2,{id:"modules",children:"Modules"}),"\n",(0,c.jsxs)(r.ul,{children:["\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/Client/",children:"api/Client"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/functions/exposed.enum/",children:"api/functions/exposed.enum"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/",children:"api/model"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/aliases/",children:"api/model/aliases"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/button/",children:"api/model/button"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/call/",children:"api/model/call"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/chat/",children:"api/model/chat"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/config/",children:"api/model/config"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/contact/",children:"api/model/contact"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/errors/",children:"api/model/errors"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/events/",children:"api/model/events"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/group-metadata/",children:"api/model/group-metadata"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/id/",children:"api/model/id"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/label/",children:"api/model/label"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/media/",children:"api/model/media"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/message/",children:"api/model/message"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/product/",children:"api/model/product"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/reactions/",children:"api/model/reactions"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/api/model/sessionInfo/",children:"api/model/sessionInfo"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/controllers/events/",children:"controllers/events"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/controllers/init_patch/",children:"controllers/init_patch"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/controllers/initializer/",children:"controllers/initializer"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/controllers/patch_manager/",children:"controllers/patch_manager"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/logging/custom_transport/",children:"logging/custom_transport"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/logging/logging/",children:"logging/logging"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/structures/Collector/",children:"structures/Collector"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/structures/Dialog/",children:"structures/Dialog"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/structures/MessageCollector/",children:"structures/MessageCollector"})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/reference/structures/preProcessors/",children:"structures/preProcessors"})}),"\n"]})]})}function h(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,c.jsx)(r,{...e,children:(0,c.jsx)(t,{...e})}):t(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>l,x:()=>o});var c=n(6540);const s={},i=c.createContext(s);function l(e){const r=c.useContext(i);return c.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),c.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/26af37c4.17b0cee8.js b/assets/js/26af37c4.17b0cee8.js deleted file mode 100644 index 1e7c705e4..000000000 --- a/assets/js/26af37c4.17b0cee8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8745],{8114:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>t,contentTitle:()=>l,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>a});var r=n(4848),i=n(8453);const d={},l="Class: Client",c={id:"reference/api/Client/classes/Client",title:"Class: Client",description:"Methods",source:"@site/docs/reference/api/Client/classes/Client.md",sourceDirName:"reference/api/Client/classes",slug:"/reference/api/Client/classes/Client",permalink:"/docs/reference/api/Client/classes/Client",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/Client/classes/Client.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/Client",permalink:"/docs/reference/api/Client/"},next:{title:"Enumeration: namespace",permalink:"/docs/reference/api/Client/enumerations/namespace"}},t={},a=[{value:"Methods",id:"methods",level:2},{value:'B()
insiders
',id:"b-insiders",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Example",id:"example",level:4},{value:"acceptGroupJoinRequest()",id:"acceptgroupjoinrequest",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"addLabel()",id:"addlabel",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"addParticipant()",id:"addparticipant",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"approveGroupJoinRequest()",id:"approvegroupjoinrequest",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"archiveChat()",id:"archivechat",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"autoReject()",id:"autoreject",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"awaitMessages()",id:"awaitmessages",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Example",id:"example-1",level:4},{value:"checkNumberStatus()",id:"checknumberstatus",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:'checkReadReceipts()
insiders
',id:"checkreadreceipts-insiders",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"clearAllChats()",id:"clearallchats",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"clearChat()",id:"clearchat",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-11",level:4},{value:"contactBlock()",id:"contactblock",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-12",level:4},{value:"contactUnblock()",id:"contactunblock",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-13",level:4},{value:'createCommunity()
insiders
',id:"createcommunity-insiders",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-14",level:4},{value:"createGroup()",id:"creategroup",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-15",level:4},{value:'createLabel()
insiders
',id:"createlabel-insiders",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-16",level:4},{value:"createMessageCollector()",id:"createmessagecollector",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-17",level:4},{value:'createNewProduct()
insiders
',id:"createnewproduct-insiders",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-18",level:4},{value:"cutChatCache()",id:"cutchatcache",level:3},{value:"Returns",id:"returns-19",level:4},{value:"after",id:"after",level:5},{value:"after.chats",id:"afterchats",level:5},{value:"after.msgs",id:"aftermsgs",level:5},{value:"before",id:"before",level:5},{value:"before.chats",id:"beforechats",level:5},{value:"before.msgs",id:"beforemsgs",level:5},{value:"cutMsgCache()",id:"cutmsgcache",level:3},{value:"Returns",id:"returns-20",level:4},{value:"darkMode()",id:"darkmode",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-21",level:4},{value:"decryptMedia()",id:"decryptmedia",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-22",level:4},{value:"deleteAllStatus()",id:"deleteallstatus",level:3},{value:"Returns",id:"returns-23",level:4},{value:'deleteAllStories()
restricted
',id:"deleteallstories-restricted",level:3},{value:"Returns",id:"returns-24",level:4},{value:"deleteChat()",id:"deletechat",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-25",level:4},{value:"deleteMessage()",id:"deletemessage",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-26",level:4},{value:"deleteStaleChats()",id:"deletestalechats",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-27",level:4},{value:"deleteStatus()",id:"deletestatus",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-28",level:4},{value:'deleteStory()
restricted
',id:"deletestory-restricted",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-29",level:4},{value:"demoteParticipant()",id:"demoteparticipant",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-30",level:4},{value:"download()",id:"download",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-31",level:4},{value:"downloadFileWithCredentials()",id:"downloadfilewithcredentials",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-32",level:4},{value:"downloadProfilePicFromMessage()",id:"downloadprofilepicfrommessage",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"Returns",id:"returns-33",level:4},{value:"editMessage()",id:"editmessage",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"Returns",id:"returns-34",level:4},{value:'editProduct()
insiders
',id:"editproduct-insiders",level:3},{value:"Parameters",id:"parameters-31",level:4},{value:"Returns",id:"returns-35",level:4},{value:"emitUnreadMessages()",id:"emitunreadmessages",level:3},{value:"Returns",id:"returns-36",level:4},{value:"forceRefocus()",id:"forcerefocus",level:3},{value:"Returns",id:"returns-37",level:4},{value:'forceStaleMediaUpdate()
insiders
',id:"forcestalemediaupdate-insiders",level:3},{value:"Parameters",id:"parameters-32",level:4},{value:"Returns",id:"returns-38",level:4},{value:"forceUpdateConnectionState()",id:"forceupdateconnectionstate",level:3},{value:"Parameters",id:"parameters-33",level:4},{value:"Returns",id:"returns-39",level:4},{value:"forceUpdateLiveLocation()",id:"forceupdatelivelocation",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"Returns",id:"returns-40",level:4},{value:"forwardMessages()",id:"forwardmessages",level:3},{value:"Parameters",id:"parameters-35",level:4},{value:"Returns",id:"returns-41",level:4},{value:"gc()",id:"gc",level:3},{value:"Returns",id:"returns-42",level:4},{value:"getAllChatIds()",id:"getallchatids",level:3},{value:"Returns",id:"returns-43",level:4},{value:"getAllChats()",id:"getallchats",level:3},{value:"Parameters",id:"parameters-36",level:4},{value:"Returns",id:"returns-44",level:4},{value:"getAllChatsWithMessages()",id:"getallchatswithmessages",level:3},{value:"Parameters",id:"parameters-37",level:4},{value:"Returns",id:"returns-45",level:4},{value:"Deprecated",id:"deprecated",level:4},{value:"getAllCommunities()",id:"getallcommunities",level:3},{value:"Returns",id:"returns-46",level:4},{value:"getAllContacts()",id:"getallcontacts",level:3},{value:"Returns",id:"returns-47",level:4},{value:"getAllGroups()",id:"getallgroups",level:3},{value:"Parameters",id:"parameters-38",level:4},{value:"Returns",id:"returns-48",level:4},{value:"getAllLabels()",id:"getalllabels",level:3},{value:"Returns",id:"returns-49",level:4},{value:"getAllMessagesInChat()",id:"getallmessagesinchat",level:3},{value:"Parameters",id:"parameters-39",level:4},{value:"Returns",id:"returns-50",level:4},{value:"getAllNewMessages()",id:"getallnewmessages",level:3},{value:"Returns",id:"returns-51",level:4},{value:"getAllUnreadMessages()",id:"getallunreadmessages",level:3},{value:"Returns",id:"returns-52",level:4},{value:"getAmountOfLoadedMessages()",id:"getamountofloadedmessages",level:3},{value:"Returns",id:"returns-53",level:4},{value:"getBatteryLevel()",id:"getbatterylevel",level:3},{value:"Returns",id:"returns-54",level:4},{value:"getBlockedIds()",id:"getblockedids",level:3},{value:"Returns",id:"returns-55",level:4},{value:"getBusinessProfile()",id:"getbusinessprofile",level:3},{value:"Parameters",id:"parameters-40",level:4},{value:"Returns",id:"returns-56",level:4},{value:"getBusinessProfilesProducts()",id:"getbusinessprofilesproducts",level:3},{value:"Parameters",id:"parameters-41",level:4},{value:"Returns",id:"returns-57",level:4},{value:"getChat()",id:"getchat",level:3},{value:"Parameters",id:"parameters-42",level:4},{value:"Returns",id:"returns-58",level:4},{value:"getChatById()",id:"getchatbyid",level:3},{value:"Parameters",id:"parameters-43",level:4},{value:"Returns",id:"returns-59",level:4},{value:"getChatWithNonContacts()",id:"getchatwithnoncontacts",level:3},{value:"Returns",id:"returns-60",level:4},{value:"getChatsByLabel()",id:"getchatsbylabel",level:3},{value:"Parameters",id:"parameters-44",level:4},{value:"Returns",id:"returns-61",level:4},{value:"Label",id:"label",level:4},{value:'getCommonGroups()
insiders
',id:"getcommongroups-insiders",level:3},{value:"Parameters",id:"parameters-45",level:4},{value:"Returns",id:"returns-62",level:4},{value:"getCommunityAdminIds()",id:"getcommunityadminids",level:3},{value:"Parameters",id:"parameters-46",level:4},{value:"Returns",id:"returns-63",level:4},{value:"getCommunityAdmins()",id:"getcommunityadmins",level:3},{value:"Parameters",id:"parameters-47",level:4},{value:"Returns",id:"returns-64",level:4},{value:"getCommunityInfo()",id:"getcommunityinfo",level:3},{value:"Parameters",id:"parameters-48",level:4},{value:"Returns",id:"returns-65",level:4},{value:"getCommunityParticipantIds()",id:"getcommunityparticipantids",level:3},{value:"Parameters",id:"parameters-49",level:4},{value:"Returns",id:"returns-66",level:4},{value:"getCommunityParticipants()",id:"getcommunityparticipants",level:3},{value:"Parameters",id:"parameters-50",level:4},{value:"Returns",id:"returns-67",level:4},{value:"getConfig()",id:"getconfig",level:3},{value:"Returns",id:"returns-68",level:4},{value:"getConnectionState()",id:"getconnectionstate",level:3},{value:"Returns",id:"returns-69",level:4},{value:"getContact()",id:"getcontact",level:3},{value:"Parameters",id:"parameters-51",level:4},{value:"Returns",id:"returns-70",level:4},{value:"getEventSignature()",id:"geteventsignature",level:3},{value:"Parameters",id:"parameters-52",level:4},{value:"Returns",id:"returns-71",level:4},{value:"getFeatures()",id:"getfeatures",level:3},{value:"Returns",id:"returns-72",level:4},{value:"getGeneratedUserAgent()",id:"getgenerateduseragent",level:3},{value:"Parameters",id:"parameters-53",level:4},{value:"Returns",id:"returns-73",level:4},{value:"getGptArray()",id:"getgptarray",level:3},{value:"Parameters",id:"parameters-54",level:4},{value:"Returns",id:"returns-74",level:4},{value:"getGroupAdmins()",id:"getgroupadmins",level:3},{value:"Parameters",id:"parameters-55",level:4},{value:"Returns",id:"returns-75",level:4},{value:"getGroupApprovalRequests()",id:"getgroupapprovalrequests",level:3},{value:"Parameters",id:"parameters-56",level:4},{value:"Returns",id:"returns-76",level:4},{value:"getGroupInfo()",id:"getgroupinfo",level:3},{value:"Parameters",id:"parameters-57",level:4},{value:"Returns",id:"returns-77",level:4},{value:"getGroupInviteLink()",id:"getgroupinvitelink",level:3},{value:"Parameters",id:"parameters-58",level:4},{value:"Returns",id:"returns-78",level:4},{value:"getGroupMembers()",id:"getgroupmembers",level:3},{value:"Parameters",id:"parameters-59",level:4},{value:"Returns",id:"returns-79",level:4},{value:"getGroupMembersId()",id:"getgroupmembersid",level:3},{value:"Parameters",id:"parameters-60",level:4},{value:"Returns",id:"returns-80",level:4},{value:"getHostNumber()",id:"gethostnumber",level:3},{value:"Returns",id:"returns-81",level:4},{value:"getIndicatedNewMessages()",id:"getindicatednewmessages",level:3},{value:"Returns",id:"returns-82",level:4},{value:"getInstanceId()",id:"getinstanceid",level:3},{value:"Returns",id:"returns-83",level:4},{value:"getIsPlugged()",id:"getisplugged",level:3},{value:"Returns",id:"returns-84",level:4},{value:"getIssueLink()",id:"getissuelink",level:3},{value:"Returns",id:"returns-85",level:4},{value:"getKickedGroups()",id:"getkickedgroups",level:3},{value:"Returns",id:"returns-86",level:4},{value:"getLastMsgTimestamps()",id:"getlastmsgtimestamps",level:3},{value:"Returns",id:"returns-87",level:4},{value:"getLastSeen()",id:"getlastseen",level:3},{value:"Parameters",id:"parameters-61",level:4},{value:"Returns",id:"returns-88",level:4},{value:"getLicenseLink()",id:"getlicenselink",level:3},{value:"Parameters",id:"parameters-62",level:4},{value:"Returns",id:"returns-89",level:4},{value:"getLicenseType()",id:"getlicensetype",level:3},{value:"Returns",id:"returns-90",level:4},{value:"getListenerQueues()",id:"getlistenerqueues",level:3},{value:"Returns",id:"returns-91",level:4},{value:"onAck",id:"onack",level:5},{value:"onAddedToGroup",id:"onaddedtogroup",level:5},{value:"onAnyMessage",id:"onanymessage",level:5},{value:"onBattery",id:"onbattery",level:5},{value:"onBroadcast",id:"onbroadcast",level:5},{value:"onButton",id:"onbutton",level:5},{value:"onCallState",id:"oncallstate",level:5},{value:"onChatDeleted",id:"onchatdeleted",level:5},{value:"onChatOpened",id:"onchatopened",level:5},{value:"onChatState",id:"onchatstate",level:5},{value:"onContactAdded",id:"oncontactadded",level:5},{value:"onGlobalParticipantsChanged",id:"onglobalparticipantschanged",level:5},{value:"onGroupApprovalRequest",id:"ongroupapprovalrequest",level:5},{value:"onGroupChange",id:"ongroupchange",level:5},{value:"onIncomingCall",id:"onincomingcall",level:5},{value:"onLabel",id:"onlabel",level:5},{value:"onLogout",id:"onlogout",level:5},{value:"onMessage",id:"onmessage",level:5},{value:"onMessageDeleted",id:"onmessagedeleted",level:5},{value:"onNewProduct",id:"onnewproduct",level:5},{value:"onOrder",id:"onorder",level:5},{value:"onPlugged",id:"onplugged",level:5},{value:"onPollVote",id:"onpollvote",level:5},{value:"onReaction",id:"onreaction",level:5},{value:"onRemovedFromGroup",id:"onremovedfromgroup",level:5},{value:"onStateChanged",id:"onstatechanged",level:5},{value:"onStory",id:"onstory",level:5},{value:"getMe()",id:"getme",level:3},{value:"Returns",id:"returns-92",level:4},{value:"getMessageById()",id:"getmessagebyid",level:3},{value:"Parameters",id:"parameters-63",level:4},{value:"Returns",id:"returns-93",level:4},{value:'getMessageInfo()
insiders
',id:"getmessageinfo-insiders",level:3},{value:"Parameters",id:"parameters-64",level:4},{value:"Returns",id:"returns-94",level:4},{value:"getMessageReaders()",id:"getmessagereaders",level:3},{value:"Parameters",id:"parameters-65",level:4},{value:"Returns",id:"returns-95",level:4},{value:"getMyLastMessage()",id:"getmylastmessage",level:3},{value:"Parameters",id:"parameters-66",level:4},{value:"Returns",id:"returns-96",level:4},{value:"getMyStatusArray()",id:"getmystatusarray",level:3},{value:"Returns",id:"returns-97",level:4},{value:'getMyStoryArray()
restricted
',id:"getmystoryarray-restricted",level:3},{value:"Returns",id:"returns-98",level:4},{value:'getOrder()
insiders
',id:"getorder-insiders",level:3},{value:"Parameters",id:"parameters-67",level:4},{value:"Returns",id:"returns-99",level:4},{value:"getPage()",id:"getpage",level:3},{value:"Returns",id:"returns-100",level:4},{value:"getPollData()",id:"getpolldata",level:3},{value:"Parameters",id:"parameters-68",level:4},{value:"Returns",id:"returns-101",level:4},{value:"getProcessStats()",id:"getprocessstats",level:3},{value:"Returns",id:"returns-102",level:4},{value:"getProfilePicFromServer()",id:"getprofilepicfromserver",level:3},{value:"Parameters",id:"parameters-69",level:4},{value:"Returns",id:"returns-103",level:4},{value:"getSessionId()",id:"getsessionid",level:3},{value:"Returns",id:"returns-104",level:4},{value:"getSessionInfo()",id:"getsessioninfo",level:3},{value:"Returns",id:"returns-105",level:4},{value:"getSingleProperty()",id:"getsingleproperty",level:3},{value:"Parameters",id:"parameters-70",level:4},{value:"Returns",id:"returns-106",level:4},{value:"getSnapshot()",id:"getsnapshot",level:3},{value:"Parameters",id:"parameters-71",level:4},{value:"Returns",id:"returns-107",level:4},{value:"getStarredMessages()",id:"getstarredmessages",level:3},{value:"Parameters",id:"parameters-72",level:4},{value:"Returns",id:"returns-108",level:4},{value:"getStatus()",id:"getstatus",level:3},{value:"Parameters",id:"parameters-73",level:4},{value:"Returns",id:"returns-109",level:4},{value:"id",id:"id",level:5},{value:"status",id:"status",level:5},{value:"getStickerDecryptable()",id:"getstickerdecryptable",level:3},{value:"Parameters",id:"parameters-74",level:4},{value:"Returns",id:"returns-110",level:4},{value:"Deprecated",id:"deprecated-1",level:4},{value:'getStoryViewers()
restricted
',id:"getstoryviewers-restricted",level:3},{value:"Parameters",id:"parameters-75",level:4},{value:"Returns",id:"returns-111",level:4},{value:"getTunnelCode()",id:"gettunnelcode",level:3},{value:"Returns",id:"returns-112",level:4},{value:"getUnreadMessages()",id:"getunreadmessages",level:3},{value:"Parameters",id:"parameters-76",level:4},{value:"Returns",id:"returns-113",level:4},{value:"getUnsentMessages()",id:"getunsentmessages",level:3},{value:"Returns",id:"returns-114",level:4},{value:"getVCards()",id:"getvcards",level:3},{value:"Parameters",id:"parameters-77",level:4},{value:"Returns",id:"returns-115",level:4},{value:"getWAVersion()",id:"getwaversion",level:3},{value:"Returns",id:"returns-116",level:4},{value:"ghostForward()",id:"ghostforward",level:3},{value:"Parameters",id:"parameters-78",level:4},{value:"Returns",id:"returns-117",level:4},{value:"healthCheck()",id:"healthcheck",level:3},{value:"Returns",id:"returns-118",level:4},{value:"iAmAdmin()",id:"iamadmin",level:3},{value:"Returns",id:"returns-119",level:4},{value:"inviteInfo()",id:"inviteinfo",level:3},{value:"Parameters",id:"parameters-79",level:4},{value:"Returns",id:"returns-120",level:4},{value:"isChatMuted()",id:"ischatmuted",level:3},{value:"Parameters",id:"parameters-80",level:4},{value:"Returns",id:"returns-121",level:4},{value:"isChatOnline()",id:"ischatonline",level:3},{value:"Parameters",id:"parameters-81",level:4},{value:"Returns",id:"returns-122",level:4},{value:"isConnected()",id:"isconnected",level:3},{value:"Returns",id:"returns-123",level:4},{value:'isGroupIdUnsafe()
insiders
',id:"isgroupidunsafe-insiders",level:3},{value:"Parameters",id:"parameters-82",level:4},{value:"Returns",id:"returns-124",level:4},{value:"isPhoneDisconnected()",id:"isphonedisconnected",level:3},{value:"Returns",id:"returns-125",level:4},{value:"joinGroupViaLink()",id:"joingroupvialink",level:3},{value:"Parameters",id:"parameters-83",level:4},{value:"Returns",id:"returns-126",level:4},{value:"joinWebBeta()",id:"joinwebbeta",level:3},{value:"Parameters",id:"parameters-84",level:4},{value:"Returns",id:"returns-127",level:4},{value:"kill()",id:"kill",level:3},{value:"Parameters",id:"parameters-85",level:4},{value:"Returns",id:"returns-128",level:4},{value:"leaveGroup()",id:"leavegroup",level:3},{value:"Parameters",id:"parameters-86",level:4},{value:"Returns",id:"returns-129",level:4},{value:"listWebhooks()",id:"listwebhooks",level:3},{value:"Returns",id:"returns-130",level:4},{value:"loadAllEarlierMessages()",id:"loadallearliermessages",level:3},{value:"Parameters",id:"parameters-87",level:4},{value:"Returns",id:"returns-131",level:4},{value:"loadAndGetAllMessagesInChat()",id:"loadandgetallmessagesinchat",level:3},{value:"Parameters",id:"parameters-88",level:4},{value:"Returns",id:"returns-132",level:4},{value:"loadEarlierMessages()",id:"loadearliermessages",level:3},{value:"Parameters",id:"parameters-89",level:4},{value:"Returns",id:"returns-133",level:4},{value:"loadEarlierMessagesTillDate()",id:"loadearliermessagestilldate",level:3},{value:"Parameters",id:"parameters-90",level:4},{value:"Returns",id:"returns-134",level:4},{value:"logger()",id:"logger",level:3},{value:"Returns",id:"returns-135",level:4},{value:"logout()",id:"logout",level:3},{value:"Parameters",id:"parameters-91",level:4},{value:"Returns",id:"returns-136",level:4},{value:"markAllRead()",id:"markallread",level:3},{value:"Returns",id:"returns-137",level:4},{value:"markAsUnread()",id:"markasunread",level:3},{value:"Parameters",id:"parameters-92",level:4},{value:"Returns",id:"returns-138",level:4},{value:"metrics()",id:"metrics",level:3},{value:"Returns",id:"returns-139",level:4},{value:"middleware()",id:"middleware",level:3},{value:"Parameters",id:"parameters-93",level:4},{value:"Returns",id:"returns-140",level:4},{value:"Parameters",id:"parameters-94",level:5},{value:"Returns",id:"returns-141",level:5},{value:'muteChat()
insiders
',id:"mutechat-insiders",level:3},{value:"Parameters",id:"parameters-95",level:4},{value:"Returns",id:"returns-142",level:4},{value:'onNewProduct()
insiders
',id:"onnewproduct-insiders",level:3},{value:"Parameters",id:"parameters-96",level:4},{value:"Returns",id:"returns-143",level:4},{value:'onOrder()
insiders
',id:"onorder-insiders",level:3},{value:"Parameters",id:"parameters-97",level:4},{value:"Returns",id:"returns-144",level:4},{value:"pinChat()",id:"pinchat",level:3},{value:"Parameters",id:"parameters-98",level:4},{value:"Returns",id:"returns-145",level:4},{value:'postImageStatus()
restricted
',id:"postimagestatus-restricted",level:3},{value:"Parameters",id:"parameters-99",level:4},{value:"Returns",id:"returns-146",level:4},{value:'postTextStatus()
restricted
',id:"posttextstatus-restricted",level:3},{value:"Parameters",id:"parameters-100",level:4},{value:"Returns",id:"returns-147",level:4},{value:'postThumbnailStatus()
restricted
',id:"postthumbnailstatus-restricted",level:3},{value:"Parameters",id:"parameters-101",level:4},{value:"Returns",id:"returns-148",level:4},{value:'postVideoStatus()
restricted
',id:"postvideostatus-restricted",level:3},{value:"Parameters",id:"parameters-102",level:4},{value:"Returns",id:"returns-149",level:4},{value:"prepEventData()",id:"prepeventdata",level:3},{value:"Parameters",id:"parameters-103",level:4},{value:"Returns",id:"returns-150",level:4},{value:"promoteParticipant()",id:"promoteparticipant",level:3},{value:"Parameters",id:"parameters-104",level:4},{value:"Returns",id:"returns-151",level:4},{value:"react()",id:"react",level:3},{value:"Parameters",id:"parameters-105",level:4},{value:"Returns",id:"returns-152",level:4},{value:"refresh()",id:"refresh",level:3},{value:"Returns",id:"returns-153",level:4},{value:"registerWebhook()",id:"registerwebhook",level:3},{value:"Parameters",id:"parameters-106",level:4},{value:"Returns",id:"returns-154",level:4},{value:"rejectGroupJoinRequest()",id:"rejectgroupjoinrequest",level:3},{value:"Parameters",id:"parameters-107",level:4},{value:"Returns",id:"returns-155",level:4},{value:"removeAllListeners()",id:"removealllisteners",level:3},{value:"Returns",id:"returns-156",level:4},{value:"removeLabel()",id:"removelabel",level:3},{value:"Parameters",id:"parameters-108",level:4},{value:"Returns",id:"returns-157",level:4},{value:"removeListener()",id:"removelistener",level:3},{value:"Parameters",id:"parameters-109",level:4},{value:"Returns",id:"returns-158",level:4},{value:"removeParticipant()",id:"removeparticipant",level:3},{value:"Parameters",id:"parameters-110",level:4},{value:"Returns",id:"returns-159",level:4},{value:"removeProduct()",id:"removeproduct",level:3},{value:"Parameters",id:"parameters-111",level:4},{value:"Returns",id:"returns-160",level:4},{value:"removeWebhook()",id:"removewebhook",level:3},{value:"Parameters",id:"parameters-112",level:4},{value:"Returns",id:"returns-161",level:4},{value:"Retruns",id:"retruns",level:4},{value:"reply()",id:"reply",level:3},{value:"Parameters",id:"parameters-113",level:4},{value:"Returns",id:"returns-162",level:4},{value:'reportSpam()
restricted
',id:"reportspam-restricted",level:3},{value:"Parameters",id:"parameters-114",level:4},{value:"Returns",id:"returns-163",level:4},{value:"resizePage()",id:"resizepage",level:3},{value:"Parameters",id:"parameters-115",level:4},{value:"Returns",id:"returns-164",level:4},{value:"revokeGroupInviteLink()",id:"revokegroupinvitelink",level:3},{value:"Parameters",id:"parameters-116",level:4},{value:"Returns",id:"returns-165",level:4},{value:"sendAdvancedButtons()",id:"sendadvancedbuttons",level:3},{value:"Parameters",id:"parameters-117",level:4},{value:"Returns",id:"returns-166",level:4},{value:"Deprecated",id:"deprecated-2",level:4},{value:"sendAudio()",id:"sendaudio",level:3},{value:"Parameters",id:"parameters-118",level:4},{value:"Returns",id:"returns-167",level:4},{value:"sendBanner()",id:"sendbanner",level:3},{value:"Parameters",id:"parameters-119",level:4},{value:"Returns",id:"returns-168",level:4},{value:"sendButtons()",id:"sendbuttons",level:3},{value:"Parameters",id:"parameters-120",level:4},{value:"Returns",id:"returns-169",level:4},{value:"Deprecated",id:"deprecated-3",level:4},{value:"sendContact()",id:"sendcontact",level:3},{value:"Parameters",id:"parameters-121",level:4},{value:"Returns",id:"returns-170",level:4},{value:"sendCustomProduct()",id:"sendcustomproduct",level:3},{value:"Parameters",id:"parameters-122",level:4},{value:"Returns",id:"returns-171",level:4},{value:"Deprecated",id:"deprecated-4",level:4},{value:"sendEmoji()",id:"sendemoji",level:3},{value:"Parameters",id:"parameters-123",level:4},{value:"Returns",id:"returns-172",level:4},{value:"sendFile()",id:"sendfile",level:3},{value:"Parameters",id:"parameters-124",level:4},{value:"Returns",id:"returns-173",level:4},{value:"sendFileFromUrl()",id:"sendfilefromurl",level:3},{value:"Parameters",id:"parameters-125",level:4},{value:"Returns",id:"returns-174",level:4},{value:"sendGiphy()",id:"sendgiphy",level:3},{value:"Parameters",id:"parameters-126",level:4},{value:"Returns",id:"returns-175",level:4},{value:"sendGiphyAsSticker()",id:"sendgiphyassticker",level:3},{value:"Parameters",id:"parameters-127",level:4},{value:"Returns",id:"returns-176",level:4},{value:"sendImage()",id:"sendimage",level:3},{value:"Parameters",id:"parameters-128",level:4},{value:"Returns",id:"returns-177",level:4},{value:"sendImageAsSticker()",id:"sendimageassticker",level:3},{value:"Parameters",id:"parameters-129",level:4},{value:"Returns",id:"returns-178",level:4},{value:'sendImageAsStickerAsReply()
insiders
',id:"sendimageasstickerasreply-insiders",level:3},{value:"Parameters",id:"parameters-130",level:4},{value:"Returns",id:"returns-179",level:4},{value:"sendImageWithProduct()",id:"sendimagewithproduct",level:3},{value:"Parameters",id:"parameters-131",level:4},{value:"Returns",id:"returns-180",level:4},{value:"sendLinkWithAutoPreview()",id:"sendlinkwithautopreview",level:3},{value:"Parameters",id:"parameters-132",level:4},{value:"Returns",id:"returns-181",level:4},{value:"sendListMessage()",id:"sendlistmessage",level:3},{value:"Parameters",id:"parameters-133",level:4},{value:"Returns",id:"returns-182",level:4},{value:"Deprecated",id:"deprecated-5",level:4},{value:"sendLocation()",id:"sendlocation",level:3},{value:"Parameters",id:"parameters-134",level:4},{value:"Returns",id:"returns-183",level:4},{value:"sendMessageWithThumb()",id:"sendmessagewiththumb",level:3},{value:"Parameters",id:"parameters-135",level:4},{value:"Returns",id:"returns-184",level:4},{value:"sendMp4AsSticker()",id:"sendmp4assticker",level:3},{value:"Parameters",id:"parameters-136",level:4},{value:"Returns",id:"returns-185",level:4},{value:'sendMultipleContacts()
insiders
',id:"sendmultiplecontacts-insiders",level:3},{value:"Parameters",id:"parameters-137",level:4},{value:"Returns",id:"returns-186",level:4},{value:"sendPaymentRequest()",id:"sendpaymentrequest",level:3},{value:"Parameters",id:"parameters-138",level:4},{value:"Returns",id:"returns-187",level:4},{value:"sendPoll()",id:"sendpoll",level:3},{value:"Parameters",id:"parameters-139",level:4},{value:"Returns",id:"returns-188",level:4},{value:'sendProduct()
insiders
',id:"sendproduct-insiders",level:3},{value:"Parameters",id:"parameters-140",level:4},{value:"Returns",id:"returns-189",level:4},{value:"sendPtt()",id:"sendptt",level:3},{value:"Parameters",id:"parameters-141",level:4},{value:"Returns",id:"returns-190",level:4},{value:"sendRawWebpAsSticker()",id:"sendrawwebpassticker",level:3},{value:"Parameters",id:"parameters-142",level:4},{value:"Returns",id:"returns-191",level:4},{value:'sendRawWebpAsStickerAsReply()
insiders
',id:"sendrawwebpasstickerasreply-insiders",level:3},{value:"Parameters",id:"parameters-143",level:4},{value:"Returns",id:"returns-192",level:4},{value:"sendReplyWithMentions()",id:"sendreplywithmentions",level:3},{value:"Parameters",id:"parameters-144",level:4},{value:"Returns",id:"returns-193",level:4},{value:"sendSeen()",id:"sendseen",level:3},{value:"Parameters",id:"parameters-145",level:4},{value:"Returns",id:"returns-194",level:4},{value:"sendStickerfromUrl()",id:"sendstickerfromurl",level:3},{value:"Parameters",id:"parameters-146",level:4},{value:"Returns",id:"returns-195",level:4},{value:'sendStickerfromUrlAsReply()
insiders
',id:"sendstickerfromurlasreply-insiders",level:3},{value:"Parameters",id:"parameters-147",level:4},{value:"Returns",id:"returns-196",level:4},{value:'sendText()
restricted
',id:"sendtext-restricted",level:3},{value:"Parameters",id:"parameters-148",level:4},{value:"Returns",id:"returns-197",level:4},{value:"sendTextWithMentions()",id:"sendtextwithmentions",level:3},{value:"Parameters",id:"parameters-149",level:4},{value:"Returns",id:"returns-198",level:4},{value:"sendVCard()",id:"sendvcard",level:3},{value:"Parameters",id:"parameters-150",level:4},{value:"Returns",id:"returns-199",level:4},{value:"sendVideoAsGif()",id:"sendvideoasgif",level:3},{value:"Parameters",id:"parameters-151",level:4},{value:"Returns",id:"returns-200",level:4},{value:"sendYoutubeLink()",id:"sendyoutubelink",level:3},{value:"Parameters",id:"parameters-152",level:4},{value:"Returns",id:"returns-201",level:4},{value:'setChatBackgroundColourHex()
insiders
',id:"setchatbackgroundcolourhex-insiders",level:3},{value:"Parameters",id:"parameters-153",level:4},{value:"Returns",id:"returns-202",level:4},{value:'setChatEphemeral()
insiders
',id:"setchatephemeral-insiders",level:3},{value:"Parameters",id:"parameters-154",level:4},{value:"Returns",id:"returns-203",level:4},{value:"setChatState()",id:"setchatstate",level:3},{value:"Parameters",id:"parameters-155",level:4},{value:"Returns",id:"returns-204",level:4},{value:"setGroupApprovalMode()",id:"setgroupapprovalmode",level:3},{value:"Parameters",id:"parameters-156",level:4},{value:"Returns",id:"returns-205",level:4},{value:"setGroupDescription()",id:"setgroupdescription",level:3},{value:"Parameters",id:"parameters-157",level:4},{value:"Returns",id:"returns-206",level:4},{value:"setGroupEditToAdminsOnly()",id:"setgroupedittoadminsonly",level:3},{value:"Parameters",id:"parameters-158",level:4},{value:"Returns",id:"returns-207",level:4},{value:"setGroupIcon()",id:"setgroupicon",level:3},{value:"Parameters",id:"parameters-159",level:4},{value:"Returns",id:"returns-208",level:4},{value:"setGroupIconByUrl()",id:"setgroupiconbyurl",level:3},{value:"Parameters",id:"parameters-160",level:4},{value:"Returns",id:"returns-209",level:4},{value:'setGroupTitle()
insiders
',id:"setgrouptitle-insiders",level:3},{value:"Parameters",id:"parameters-161",level:4},{value:"Returns",id:"returns-210",level:4},{value:"setGroupToAdminsOnly()",id:"setgrouptoadminsonly",level:3},{value:"Parameters",id:"parameters-162",level:4},{value:"Returns",id:"returns-211",level:4},{value:"setMyName()",id:"setmyname",level:3},{value:"Parameters",id:"parameters-163",level:4},{value:"Returns",id:"returns-212",level:4},{value:"setMyStatus()",id:"setmystatus",level:3},{value:"Parameters",id:"parameters-164",level:4},{value:"Returns",id:"returns-213",level:4},{value:"setPresence()",id:"setpresence",level:3},{value:"Parameters",id:"parameters-165",level:4},{value:"Returns",id:"returns-214",level:4},{value:"setProfilePic()",id:"setprofilepic",level:3},{value:"Parameters",id:"parameters-166",level:4},{value:"Returns",id:"returns-215",level:4},{value:"simulateRecording()",id:"simulaterecording",level:3},{value:"Parameters",id:"parameters-167",level:4},{value:"Returns",id:"returns-216",level:4},{value:"simulateTyping()",id:"simulatetyping",level:3},{value:"Parameters",id:"parameters-168",level:4},{value:"Returns",id:"returns-217",level:4},{value:"starMessage()",id:"starmessage",level:3},{value:"Parameters",id:"parameters-169",level:4},{value:"Returns",id:"returns-218",level:4},{value:"syncContacts()",id:"synccontacts",level:3},{value:"Returns",id:"returns-219",level:4},{value:'tagEveryone()
insiders
',id:"tageveryone-insiders",level:3},{value:"Parameters",id:"parameters-170",level:4},{value:"Returns",id:"returns-220",level:4},{value:"Mention",id:"mention",level:4},{value:"Default",id:"default",level:4},{value:"testButtons()",id:"testbuttons",level:3},{value:"Parameters",id:"parameters-171",level:4},{value:"Returns",id:"returns-221",level:4},{value:"Deprecated",id:"deprecated-6",level:4},{value:"testCallback()",id:"testcallback",level:3},{value:"Parameters",id:"parameters-172",level:4},{value:"Returns",id:"returns-222",level:4},{value:'unmuteChat()
insiders
',id:"unmutechat-insiders",level:3},{value:"Parameters",id:"parameters-173",level:4},{value:"Returns",id:"returns-223",level:4},{value:"unstarMessage()",id:"unstarmessage",level:3},{value:"Parameters",id:"parameters-174",level:4},{value:"Returns",id:"returns-224",level:4},{value:"updateWebhook()",id:"updatewebhook",level:3},{value:"Parameters",id:"parameters-175",level:4},{value:"Returns",id:"returns-225",level:4},{value:"waitAllQEmpty()",id:"waitallqempty",level:3},{value:"Returns",id:"returns-226",level:4},{value:"waitWhQIdle()",id:"waitwhqidle",level:3},{value:"Returns",id:"returns-227",level:4},{value:"Events",id:"events",level:2},{value:"onAck()",id:"onack-1",level:3},{value:"Parameters",id:"parameters-176",level:4},{value:"Returns",id:"returns-228",level:4},{value:"onAddedToGroup()",id:"onaddedtogroup-1",level:3},{value:"Parameters",id:"parameters-177",level:4},{value:"Returns",id:"returns-229",level:4},{value:"onAnyMessage()",id:"onanymessage-1",level:3},{value:"Parameters",id:"parameters-178",level:4},{value:"Returns",id:"returns-230",level:4},{value:"Fires",id:"fires",level:4},{value:"onBattery()",id:"onbattery-1",level:3},{value:"Parameters",id:"parameters-179",level:4},{value:"Returns",id:"returns-231",level:4},{value:"Deprecated",id:"deprecated-7",level:4},{value:"Fires",id:"fires-1",level:4},{value:"onBroadcast()",id:"onbroadcast-1",level:3},{value:"Parameters",id:"parameters-180",level:4},{value:"Returns",id:"returns-232",level:4},{value:"Fires",id:"fires-2",level:4},{value:"onButton()",id:"onbutton-1",level:3},{value:"Parameters",id:"parameters-181",level:4},{value:"Returns",id:"returns-233",level:4},{value:"Fires",id:"fires-3",level:4},{value:"onCallState()",id:"oncallstate-1",level:3},{value:"Parameters",id:"parameters-182",level:4},{value:"Returns",id:"returns-234",level:4},{value:"onChatDeleted()",id:"onchatdeleted-1",level:3},{value:"Parameters",id:"parameters-183",level:4},{value:"Returns",id:"returns-235",level:4},{value:"Fires",id:"fires-4",level:4},{value:'onChatOpened()
insiders
',id:"onchatopened-insiders",level:3},{value:"Parameters",id:"parameters-184",level:4},{value:"Returns",id:"returns-236",level:4},{value:'onChatState()
insiders
',id:"onchatstate-insiders",level:3},{value:"Parameters",id:"parameters-185",level:4},{value:"Returns",id:"returns-237",level:4},{value:"Fires",id:"fires-5",level:4},{value:'onContactAdded()
insiders
',id:"oncontactadded-insiders",level:3},{value:"Parameters",id:"parameters-186",level:4},{value:"Returns",id:"returns-238",level:4},{value:"onGlobalParticipantsChanged()",id:"onglobalparticipantschanged-1",level:3},{value:"Parameters",id:"parameters-187",level:4},{value:"Returns",id:"returns-239",level:4},{value:"onGroupApprovalRequest()",id:"ongroupapprovalrequest-1",level:3},{value:"Parameters",id:"parameters-188",level:4},{value:"Returns",id:"returns-240",level:4},{value:"onGroupChange()",id:"ongroupchange-1",level:3},{value:"Parameters",id:"parameters-189",level:4},{value:"Returns",id:"returns-241",level:4},{value:"onIncomingCall()",id:"onincomingcall-1",level:3},{value:"Parameters",id:"parameters-190",level:4},{value:"Returns",id:"returns-242",level:4},{value:"onLabel()",id:"onlabel-1",level:3},{value:"Parameters",id:"parameters-191",level:4},{value:"Returns",id:"returns-243",level:4},{value:"Fires",id:"fires-6",level:4},{value:"onLiveLocation()",id:"onlivelocation",level:3},{value:"Parameters",id:"parameters-192",level:4},{value:"Returns",id:"returns-244",level:4},{value:"Emits",id:"emits",level:4},{value:"onLogout()",id:"onlogout-1",level:3},{value:"Parameters",id:"parameters-193",level:4},{value:"Returns",id:"returns-245",level:4},{value:"Fires",id:"fires-7",level:4},{value:"onMessage()",id:"onmessage-1",level:3},{value:"Parameters",id:"parameters-194",level:4},{value:"Returns",id:"returns-246",level:4},{value:"Fires",id:"fires-8",level:4},{value:"onMessageDeleted()",id:"onmessagedeleted-1",level:3},{value:"Parameters",id:"parameters-195",level:4},{value:"Returns",id:"returns-247",level:4},{value:"Fires",id:"fires-9",level:4},{value:"onParticipantsChanged()",id:"onparticipantschanged",level:3},{value:"Parameters",id:"parameters-196",level:4},{value:"Returns",id:"returns-248",level:4},{value:"onPlugged()",id:"onplugged-1",level:3},{value:"Parameters",id:"parameters-197",level:4},{value:"Returns",id:"returns-249",level:4},{value:"Fires",id:"fires-10",level:4},{value:"onPollVote()",id:"onpollvote-1",level:3},{value:"Parameters",id:"parameters-198",level:4},{value:"Returns",id:"returns-250",level:4},{value:"Fires",id:"fires-11",level:4},{value:'onReaction()
insiders
',id:"onreaction-insiders",level:3},{value:"Parameters",id:"parameters-199",level:4},{value:"Returns",id:"returns-251",level:4},{value:"Fires",id:"fires-12",level:4},{value:'onRemovedFromGroup()
insiders
',id:"onremovedfromgroup-insiders",level:3},{value:"Parameters",id:"parameters-200",level:4},{value:"Returns",id:"returns-252",level:4},{value:"onStateChanged()",id:"onstatechanged-1",level:3},{value:"Parameters",id:"parameters-201",level:4},{value:"Returns",id:"returns-253",level:4},{value:"Fires",id:"fires-13",level:4},{value:'onStory()
restricted
',id:"onstory-restricted",level:3},{value:"Parameters",id:"parameters-202",level:4},{value:"Returns",id:"returns-254",level:4},{value:"Fires",id:"fires-14",level:4}];function o(e){const s={a:"a",admonition:"admonition",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"class-client",children:"Class: Client"})}),"\n",(0,r.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsxs)(s.h3,{id:"b-insiders",children:["B() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"B"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"payload"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.admonition,{type:"danger",children:(0,r.jsx)(s.p,{children:"Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA."})}),"\n",(0,r.jsx)(s.p,{children:"Use a raw payload within your open-wa session"}),"\n",(0,r.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"payload"})]}),"\n",(0,r.jsx)(s.p,{children:"returns: MessageId"}),"\n",(0,r.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"example",children:"Example"}),"\n",(0,r.jsx)(s.p,{children:"If there is a code block, then both TypeDoc and VSCode will treat\ntext outside of the code block as regular text."}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ts",children:"await B('44123456789@c.us', {\n test: 1\n})\n"})}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/Client/classes/Client#loadallearliermessages",children:"loadAllEarlierMessages"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"acceptgroupjoinrequest",children:"acceptGroupJoinRequest()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"acceptGroupJoinRequest"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Accepts a request from a recipient to join a group. Takes the message ID of the request message."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"addlabel",children:"addLabel()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"addLabel"}),"(",(0,r.jsx)(s.code,{children:"label"}),", ",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Adds label from chat, message or contact. Only for business accounts."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"label"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"addparticipant",children:"addParticipant()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"addParticipant"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"participantId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Add participant to Group"}),"\n",(0,r.jsxs)(s.p,{children:["If not a group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_GROUP_CHAT"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If the chat does not exist, returns ",(0,r.jsx)(s.code,{children:"GROUP_DOES_NOT_EXIST"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the participantId does not exist in the contacts, returns ",(0,r.jsx)(s.code,{children:"NOT_A_CONTACT"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the host account is not an administrator, returns ",(0,r.jsx)(s.code,{children:"INSUFFICIENT_PERMISSIONS"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"participantId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"approvegroupjoinrequest",children:"approveGroupJoinRequest()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"approveGroupJoinRequest"}),"(",(0,r.jsx)(s.code,{children:"groupChatId"}),", ",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Approves a group join request"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupChatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The group chat id"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The contact id of the person who is requesting to join the group"}),"\n",(0,r.jsx)(s.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"archivechat",children:"archiveChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"archiveChat"}),"(",(0,r.jsx)(s.code,{children:"id"}),", ",(0,r.jsx)(s.code,{children:"archive"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the conversation"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"archive"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean true => archive, false => unarchive"}),"\n",(0,r.jsx)(s.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true: worked, false: didnt work (probably already in desired state)"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"autoreject",children:"autoReject()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"autoReject"}),"(",(0,r.jsx)(s.code,{children:"message"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Automatically reject calls on the host account device. Please note that the device that is calling you will continue to ring."}),"\n",(0,r.jsx)(s.p,{children:"Update: Due to the nature of MD, the host account will continue ringing."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"optional message to send to the calling account when their call is detected and rejected"}),"\n",(0,r.jsx)(s.h4,{id:"returns-6",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"awaitmessages",children:"awaitMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"awaitMessages"}),"(",(0,r.jsx)(s.code,{children:"c"}),", ",(0,r.jsx)(s.code,{children:"filter"}),", ",(0,r.jsx)(s.code,{children:"options"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:(0,r.jsx)(s.code,{children:"Collection"})}),"<",(0,r.jsx)(s.code,{children:"string"}),", ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"[FROM DISCORDJS]\nSimilar to createMessageCollector but in promise form.\nResolves with a collection of messages that pass the specified filter."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"c"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})})]}),"\n",(0,r.jsx)(s.p,{children:"The Mesasge/Chat or Chat Id to base this message colletor on"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filter"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/type-aliases/CollectorFilter",children:(0,r.jsx)(s.code,{children:"CollectorFilter"})}),"<[",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"]>"]}),"\n",(0,r.jsx)(s.p,{children:"The filter function to use"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"options?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions",children:(0,r.jsx)(s.code,{children:"AwaitMessagesOptions"})})," = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsx)(s.p,{children:"Optional options to pass to the internal collector"}),"\n",(0,r.jsx)(s.h4,{id:"returns-7",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:(0,r.jsx)(s.code,{children:"Collection"})}),"<",(0,r.jsx)(s.code,{children:"string"}),", ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">>"]}),"\n",(0,r.jsx)(s.h4,{id:"example-1",children:"Example"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"// Await !vote messages\nconst filter = m => m.body.startsWith('!vote');\n// Errors: ['time'] treats ending because of the time limit as an error\nchannel.awaitMessages(filter, { max: 4, time: 60000, errors: ['time'] })\n .then(collected => console.log(collected.size))\n .catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`));\n"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"checknumberstatus",children:"checkNumberStatus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"checkNumberStatus"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/NumberCheck",children:(0,r.jsx)(s.code,{children:"NumberCheck"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Checks if a number is a valid WA number"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-8",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/NumberCheck",children:(0,r.jsx)(s.code,{children:"NumberCheck"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"checkreadreceipts-insiders",children:["checkReadReceipts() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"checkReadReceipts"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Check if a recipient has read receipts on."}),"\n",(0,r.jsx)(s.p,{children:"This will only work if you have chats sent back and forth between you and the contact 1-1."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The Id of the contact with which you have an existing conversation with messages already."}),"\n",(0,r.jsx)(s.h4,{id:"returns-9",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," true or false or a string with an explaintaion of why it wasn't able to determine the read receipts."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"clearallchats",children:"clearAllChats()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"clearAllChats"}),"(",(0,r.jsx)(s.code,{children:"ts"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Clears all chats of all messages. This does not delete chats. Please be careful with this as it will remove all messages from whatsapp web and the host device. This feature is great for privacy focussed bots."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"ts?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"number A chat that has had a message after ts (epoch timestamp) will not be cleared."}),"\n",(0,r.jsx)(s.h4,{id:"returns-10",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"clearchat",children:"clearChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"clearChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Delete all messages from the chat."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-11",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-11",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"contactblock",children:"contactBlock()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"contactBlock"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Block contact"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-12",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-12",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"contactunblock",children:"contactUnblock()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"contactUnblock"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Unblock contact"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-13",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-13",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"createcommunity-insiders",children:["createCommunity() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"createCommunity"}),"(",(0,r.jsx)(s.code,{children:"communityName"}),", ",(0,r.jsx)(s.code,{children:"communitySubject"}),", ",(0,r.jsx)(s.code,{children:"icon"}),", ",(0,r.jsx)(s.code,{children:"existingGroups"}),", ",(0,r.jsx)(s.code,{children:"newGroups"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<`${number}@g.us`>"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Create a new community"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-14",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityName"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The community name"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communitySubject"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"icon"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsx)(s.p,{children:"DataURL of a 1:1 ratio jpeg for the community icon"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"existingGroups"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})}),"[] = ",(0,r.jsx)(s.code,{children:"[]"})]}),"\n",(0,r.jsx)(s.p,{children:"An array of existing group IDs, that are not already part of a community, to add to this new community."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"newGroups?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup",children:(0,r.jsx)(s.code,{children:"NewCommunityGroup"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"An array of new group objects that"}),"\n",(0,r.jsx)(s.h4,{id:"returns-14",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<`${number}@g.us`>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"creategroup",children:"createGroup()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"createGroup"}),"(",(0,r.jsx)(s.code,{children:"groupName"}),", ",(0,r.jsx)(s.code,{children:"contacts"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse",children:(0,r.jsx)(s.code,{children:"GroupChatCreationResponse"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Create a group and add contacts to it"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-15",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupName"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"group name: 'New group'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contacts"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-15",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse",children:(0,r.jsx)(s.code,{children:"GroupChatCreationResponse"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"createlabel-insiders",children:["createLabel() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"createLabel"}),"(",(0,r.jsx)(s.code,{children:"label"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Adds label from chat, message or contact. Only for business accounts."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-16",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"label"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-16",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"false"})," if something went wrong, or the id (usually a number as a string) of the new label (for example ",(0,r.jsx)(s.code,{children:'"58"'}),")"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"createmessagecollector",children:"createMessageCollector()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"createMessageCollector"}),"(",(0,r.jsx)(s.code,{children:"c"}),", ",(0,r.jsx)(s.code,{children:"filter"}),", ",(0,r.jsx)(s.code,{children:"options"}),"): ",(0,r.jsx)(s.a,{href:"/docs/reference/structures/MessageCollector/classes/MessageCollector",children:(0,r.jsx)(s.code,{children:"MessageCollector"})})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns a new message collector for the chat which is related to the first parameter c"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-17",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"c"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})})]}),"\n",(0,r.jsx)(s.p,{children:"The Mesasge/Chat or Chat Id to base this message colletor on"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filter"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/type-aliases/CollectorFilter",children:(0,r.jsx)(s.code,{children:"CollectorFilter"})}),"<[",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"]>"]}),"\n",(0,r.jsx)(s.p,{children:"A function that consumes a [Message] and returns a boolean which determines whether or not the message shall be collected."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"options"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,r.jsx)(s.code,{children:"CollectorOptions"})})]}),"\n",(0,r.jsx)(s.p,{children:"The options for the collector. For example, how long the collector shall run for, how many messages it should collect, how long between messages before timing out, etc."}),"\n",(0,r.jsx)(s.h4,{id:"returns-17",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/docs/reference/structures/MessageCollector/classes/MessageCollector",children:(0,r.jsx)(s.code,{children:"MessageCollector"})})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"createnewproduct-insiders",children:["createNewProduct() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"createNewProduct"}),"(",(0,r.jsx)(s.code,{children:"name"}),", ",(0,r.jsx)(s.code,{children:"price"}),", ",(0,r.jsx)(s.code,{children:"currency"}),", ",(0,r.jsx)(s.code,{children:"images"}),", ",(0,r.jsx)(s.code,{children:"description"}),", ",(0,r.jsx)(s.code,{children:"url"}),"?, ",(0,r.jsx)(s.code,{children:"internalId"}),"?, ",(0,r.jsx)(s.code,{children:"isHidden"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:(0,r.jsx)(s.code,{children:"Product"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Add a product to your catalog"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-18",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"name"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The name of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"price"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"The price of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"currency"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The 3-letter currenct code for the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"images"}),": ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"An array of dataurl or base64 strings of product images, the first image will be used as the main image. At least one image is required."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"description"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"optional, the description of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The url of the product for more information"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"internalId?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The internal/backoffice id of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"isHidden?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Whether or not the product is shown publicly in your catalog"}),"\n",(0,r.jsx)(s.h4,{id:"returns-18",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:(0,r.jsx)(s.code,{children:"Product"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"product object"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"cutchatcache",children:"cutChatCache()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"cutChatCache"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["This simple function halves the amount of chats in your session message cache. This does not delete messages off your phone. If over a day you've processed 4000 messages this will possibly result in 4000 messages being present in your session.\nCalling this method will cut the message cache as much as possible, reducing the memory usage of your process.\nYou should use this in conjunction with ",(0,r.jsx)(s.code,{children:"getAmountOfLoadedMessages"})," to intelligently control the session message cache."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-19",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n",(0,r.jsx)(s.h5,{id:"after",children:"after"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"after"}),": ",(0,r.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"afterchats",children:"after.chats"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"chats"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"aftermsgs",children:"after.msgs"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"msgs"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"before",children:"before"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"before"}),": ",(0,r.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"beforechats",children:"before.chats"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"chats"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"beforemsgs",children:"before.msgs"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"msgs"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"cutmsgcache",children:"cutMsgCache()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"cutMsgCache"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["This simple function halves the amount of messages in your session message cache. This does not delete messages off your phone. If over a day you've processed 4000 messages this will possibly result in 4000 messages being present in your session.\nCalling this method will cut the message cache to 2000 messages, therefore reducing the memory usage of your process.\nYou should use this in conjunction with ",(0,r.jsx)(s.code,{children:"getAmountOfLoadedMessages"})," to intelligently control the session message cache."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-20",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"darkmode",children:"darkMode()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"darkMode"}),"(",(0,r.jsx)(s.code,{children:"activate"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Start dark mode [NOW GENERALLY AVAILABLE]"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-19",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"activate"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"true to activate dark mode, false to deactivate"}),"\n",(0,r.jsx)(s.h4,{id:"returns-21",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"decryptmedia",children:"decryptMedia()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"decryptMedia"}),"(",(0,r.jsx)(s.code,{children:"message"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Decrypts a media message."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-20",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})})]}),"\n",(0,r.jsx)(s.p,{children:"This can be the serialized [[MessageId]] or the whole [[Message]] object. It is advised to just use the serialized message ID."}),"\n",(0,r.jsx)(s.h4,{id:"returns-22",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise<[[DataURL]]>"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"deleteallstatus",children:"deleteAllStatus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteAllStatus"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Alias for deleteStory"}),"\n",(0,r.jsx)(s.h4,{id:"returns-23",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"deleteallstories-restricted",children:["deleteAllStories() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteAllStories"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Deletes all your existing stories."}),"\n",(0,r.jsx)(s.h4,{id:"returns-24",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean. True if it worked."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"deletechat",children:"deleteChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Delete the conversation from your WA"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-21",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-25",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"deletemessage",children:"deleteMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteMessage"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"onlyLocal"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Deletes message of given message id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-22",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The chat id from which to delete the message."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"The specific message id of the message to be deleted"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"onlyLocal"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.p,{children:"If it should only delete locally (message remains on the other recipienct's phone). Defaults to false."}),"\n",(0,r.jsx)(s.h4,{id:"returns-26",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"nothing"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"deletestalechats",children:"deleteStaleChats()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteStaleChats"}),"(",(0,r.jsx)(s.code,{children:"startingFrom"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Deletes chats from a certain index (default 1000). E.g if this startingFrom param is ",(0,r.jsx)(s.code,{children:"100"})," then all chats from index ",(0,r.jsx)(s.code,{children:"100"})," onwards will be deleted."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-23",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"startingFrom?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsxs)(s.p,{children:["the chat index to start from. Please do not set this to anything less than 10 @default: ",(0,r.jsx)(s.code,{children:"1000"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-27",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"deletestatus",children:"deleteStatus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteStatus"}),"(",(0,r.jsx)(s.code,{children:"statusesToDelete"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Alias for deleteStory"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-24",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"statusesToDelete"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-28",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"deletestory-restricted",children:["deleteStory() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteStory"}),"(",(0,r.jsx)(s.code,{children:"statusesToDelete"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Consumes a list of id strings of stories to delete."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-25",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"statusesToDelete"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"string [] | string an array of ids of stories to delete."}),"\n",(0,r.jsx)(s.h4,{id:"returns-29",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean. True if it worked."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"demoteparticipant",children:"demoteParticipant()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"demoteParticipant"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"participantId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Demote Admin of Group"}),"\n",(0,r.jsxs)(s.p,{children:["If not a group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_GROUP_CHAT"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If the chat does not exist, returns ",(0,r.jsx)(s.code,{children:"GROUP_DOES_NOT_EXIST"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the participantId does not exist in the group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_PARTICIPANT"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the host account is not an administrator, returns ",(0,r.jsx)(s.code,{children:"INSUFFICIENT_PERMISSIONS"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-26",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"participantId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-30",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"download",children:"download()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"download"}),"(",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"optionsOverride"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"A convinience method to download the [[DataURL]] of a file"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-27",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The url"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"optionsOverride"}),": ",(0,r.jsx)(s.code,{children:"any"})," = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:["You can use this to override the ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"axios request config"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-31",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"downloadfilewithcredentials",children:"downloadFileWithCredentials()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"downloadFileWithCredentials"}),"(",(0,r.jsx)(s.code,{children:"url"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Download via the browsers authenticated session via URL."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-28",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-32",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"base64 string (non-data url)"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"downloadprofilepicfrommessage",children:"downloadProfilePicFromMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"downloadProfilePicFromMessage"}),"(",(0,r.jsx)(s.code,{children:"message"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Download profile pics from the message object."}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:" const filename = `profilepic_${message.from}.jpeg`;\n const data = await client.downloadProfilePicFromMessage(message);\n const dataUri = `data:image/jpeg;base64,${data}`;\n fs.writeFile(filename, mData, 'base64', function(err) {\n if (err) {\n return console.log(err);\n }\n console.log('The file was saved!');\n });\n"})}),"\n",(0,r.jsx)(s.h4,{id:"parameters-29",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-33",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"editmessage",children:"editMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"editMessage"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"text"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"NOTE: This is experimental, most accounts do not have access to this feature in their apps."}),"\n",(0,r.jsx)(s.p,{children:"Edit an existing message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-30",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The message ID to edit"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The new text content"}),"\n",(0,r.jsx)(s.h4,{id:"returns-34",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"editproduct-insiders",children:["editProduct() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"editProduct"}),"(",(0,r.jsx)(s.code,{children:"productId"}),", ",(0,r.jsx)(s.code,{children:"name"}),"?, ",(0,r.jsx)(s.code,{children:"price"}),"?, ",(0,r.jsx)(s.code,{children:"currency"}),"?, ",(0,r.jsx)(s.code,{children:"images"}),"?, ",(0,r.jsx)(s.code,{children:"description"}),"?, ",(0,r.jsx)(s.code,{children:"url"}),"?, ",(0,r.jsx)(s.code,{children:"internalId"}),"?, ",(0,r.jsx)(s.code,{children:"isHidden"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:(0,r.jsx)(s.code,{children:"Product"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Edit a product in your catalog"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-31",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"productId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The catalog ID of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"name?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The name of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"price?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"The price of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"currency?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The 3-letter currenct code for the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"images?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"An array of dataurl or base64 strings of product images, the first image will be used as the main image. At least one image is required."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"description?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"optional, the description of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The url of the product for more information"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"internalId?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The internal/backoffice id of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"isHidden?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Whether or not the product is shown publicly in your catalog"}),"\n",(0,r.jsx)(s.h4,{id:"returns-35",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:(0,r.jsx)(s.code,{children:"Product"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"product object"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"emitunreadmessages",children:"emitUnreadMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"emitUnreadMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Fires all unread messages to the onMessage listener.\nMake sure to call this AFTER setting your listeners."}),"\n",(0,r.jsx)(s.h4,{id:"returns-36",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of message IDs"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"forcerefocus",children:"forceRefocus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"forceRefocus"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["This is a convinient method to click the ",(0,r.jsx)(s.code,{children:"Use Here"})," button in the WA web session."]}),"\n",(0,r.jsxs)(s.p,{children:["Use this when [[STATE]] is ",(0,r.jsx)(s.code,{children:"CONFLICT"}),". You can read more about managing state here:"]}),"\n",(0,r.jsx)(s.p,{children:"[[Detecting Logouts]]"}),"\n",(0,r.jsx)(s.h4,{id:"returns-37",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"forcestalemediaupdate-insiders",children:["forceStaleMediaUpdate() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"forceStaleMediaUpdate"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"If a file is old enough, it will 404 if you try to decrypt it. This will allow you to force the host account to re upload the file and return a decryptable message."}),"\n",(0,r.jsx)(s.p,{children:"if you run this without a valid insiders key, it will return false and cause an error upon decryption."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-32",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-38",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["[[Message]] OR ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"forceupdateconnectionstate",children:"forceUpdateConnectionState()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"forceUpdateConnectionState"}),"(",(0,r.jsx)(s.code,{children:"killBeforeReconnect"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/enumerations/STATE",children:(0,r.jsx)(s.code,{children:"STATE"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Forces the session to update the connection state."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-33",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"killBeforeReconnect?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-39",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/enumerations/STATE",children:(0,r.jsx)(s.code,{children:"STATE"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"updated connection state"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"forceupdatelivelocation",children:"forceUpdateLiveLocation()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"forceUpdateLiveLocation"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent",children:(0,r.jsx)(s.code,{children:"LiveLocationChangedEvent"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"A list of participants in the chat who have their live location on. If the chat does not exist, or the chat does not have any contacts actively sharing their live locations, it will return false. If it's a chat with a single contact, there will be only 1 value in the array if the contact has their livelocation on.\nPlease note. This should only be called once every 30 or so seconds. This forces the phone to grab the latest live location data for the number. This can be used in conjunction with onLiveLocation (this will trigger onLiveLocation)."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-34",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"string Id of the chat you want to force the phone to get the livelocation data for."}),"\n",(0,r.jsx)(s.h4,{id:"returns-40",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent",children:(0,r.jsx)(s.code,{children:"LiveLocationChangedEvent"})}),"[]>"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," | boolean"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"forwardmessages",children:"forwardMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"forwardMessages"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"messages"}),", ",(0,r.jsx)(s.code,{children:"skipMyMessages"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Forward an array of messages to a specific chat using the message ids or Objects"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-35",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messages"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"this can be any mixture of message ids or message objects"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"skipMyMessages"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"This indicates whether or not to skip your own messages from the array"}),"\n",(0,r.jsx)(s.h4,{id:"returns-41",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"gc",children:"gc()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"gc"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"It calls the JavaScript garbage collector"}),"\n",(0,r.jsx)(s.h4,{id:"returns-42",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Nothing."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallchatids",children:"getAllChatIds()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllChatIds"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"retrieves all Chat Ids"}),"\n",(0,r.jsx)(s.h4,{id:"returns-43",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of [ChatId]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallchats",children:"getAllChats()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllChats"}),"(",(0,r.jsx)(s.code,{children:"withNewMessageOnly"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all chats"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-36",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withNewMessageOnly"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-44",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of [Chat]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallchatswithmessages",children:(0,r.jsx)(s.del,{children:"getAllChatsWithMessages()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllChatsWithMessages"}),"(",(0,r.jsx)(s.code,{children:"withNewMessageOnly"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-37",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withNewMessageOnly"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-45",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of [Chat]"}),"\n",(0,r.jsx)(s.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all chats with messages"}),"\n",(0,r.jsxs)(s.p,{children:["Please use ",(0,r.jsx)(s.code,{children:"getAllUnreadMessages"})," instead of this to see all messages indicated by the green dots in the chat."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallcommunities",children:"getAllCommunities()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllCommunities"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<`${number}@g.us`[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieve all commmunity Ids"}),"\n",(0,r.jsx)(s.h4,{id:"returns-46",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<`${number}@g.us`[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of group ids"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallcontacts",children:"getAllContacts()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllContacts"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all contacts"}),"\n",(0,r.jsx)(s.h4,{id:"returns-47",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of [Contact]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallgroups",children:"getAllGroups()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllGroups"}),"(",(0,r.jsx)(s.code,{children:"withNewMessagesOnly"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieve all groups"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-38",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withNewMessagesOnly"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-48",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of groups"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getalllabels",children:"getAllLabels()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllLabels"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/label/interfaces/Label",children:(0,r.jsx)(s.code,{children:"Label"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns all labels and the corresponding tagged items."}),"\n",(0,r.jsx)(s.h4,{id:"returns-49",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/label/interfaces/Label",children:(0,r.jsx)(s.code,{children:"Label"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallmessagesinchat",children:"getAllMessagesInChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllMessagesInChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"includeMe"}),", ",(0,r.jsx)(s.code,{children:"includeNotifications"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all Messages in a chat that have been loaded within the WA web instance."}),"\n",(0,r.jsx)(s.p,{children:"This does not load every single message in the chat history."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-39",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeMe"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeNotifications"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-50",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"Message[]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallnewmessages",children:"getAllNewMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllNewMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all new Messages. where isNewMsg==true"}),"\n",(0,r.jsx)(s.h4,{id:"returns-51",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"list of messages"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallunreadmessages",children:"getAllUnreadMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllUnreadMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all unread Messages. where ack==-1"}),"\n",(0,r.jsx)(s.h4,{id:"returns-52",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"list of messages"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getamountofloadedmessages",children:"getAmountOfLoadedMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAmountOfLoadedMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Easily get the amount of messages loaded up in the session. This will allow you to determine when to clear chats/cache."}),"\n",(0,r.jsx)(s.h4,{id:"returns-53",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getbatterylevel",children:"getBatteryLevel()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getBatteryLevel"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves Battery Level"}),"\n",(0,r.jsx)(s.h4,{id:"returns-54",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Number"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getblockedids",children:"getBlockedIds()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getBlockedIds"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"retrieves an array of IDs of accounts blocked by the host account."}),"\n",(0,r.jsx)(s.h4,{id:"returns-55",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getbusinessprofile",children:"getBusinessProfile()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getBusinessProfile"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessProfile",children:(0,r.jsx)(s.code,{children:"BusinessProfile"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the business info of a given contact id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-40",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"id of business profile (i.e the number with @c.us)"}),"\n",(0,r.jsx)(s.h4,{id:"returns-56",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessProfile",children:(0,r.jsx)(s.code,{children:"BusinessProfile"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"None"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getbusinessprofilesproducts",children:"getBusinessProfilesProducts()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getBusinessProfilesProducts"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Find any product listings of the given number. Use this to query a catalog"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-41",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"id of business profile (i.e the number with @c.us)"}),"\n",(0,r.jsx)(s.h4,{id:"returns-57",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"None"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getchat",children:"getChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getChat"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves chat object of given contact id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-42",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-58",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"contact detial as promise"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getchatbyid",children:"getChatById()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getChatById"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves chat object of given contact id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-43",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-59",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"contact detial as promise"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getchatwithnoncontacts",children:"getChatWithNonContacts()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getChatWithNonContacts"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns a list of contact with whom the host number has an existing chat who are also not contacts."}),"\n",(0,r.jsx)(s.h4,{id:"returns-60",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getchatsbylabel",children:"getChatsByLabel()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getChatsByLabel"}),"(",(0,r.jsx)(s.code,{children:"label"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:'Get an array of chats that match the label parameter. For example, if you want to get an array of chat objects that have the label "New customer".'}),"\n",(0,r.jsx)(s.p,{children:"This method is case insenstive and only works on business host accounts."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-44",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"label"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-61",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n",(0,r.jsx)(s.h4,{id:"label",children:"Label"}),"\n",(0,r.jsx)(s.p,{children:"The label name"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"getcommongroups-insiders",children:["getCommonGroups() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommonGroups"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Retrieves the groups that you have in common with a contact"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-45",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-62",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcommunityadminids",children:"getCommunityAdminIds()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommunityAdminIds"}),"(",(0,r.jsx)(s.code,{children:"communityId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves community admin Ids"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-46",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"community id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-63",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcommunityadmins",children:"getCommunityAdmins()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommunityAdmins"}),"(",(0,r.jsx)(s.code,{children:"communityId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves community admins as Contact objects"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-47",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"community id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-64",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcommunityinfo",children:"getCommunityInfo()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommunityInfo"}),"(",(0,r.jsx)(s.code,{children:"communityId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",children:(0,r.jsx)(s.code,{children:"GroupMetadata"})})," & ",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Returns the community metadata. Like group metadata but with a ",(0,r.jsx)(s.code,{children:"subGroups"})," property which is the group metadata of the community subgroups."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-48",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"community id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-65",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",children:(0,r.jsx)(s.code,{children:"GroupMetadata"})})," & ",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcommunityparticipantids",children:"getCommunityParticipantIds()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommunityParticipantIds"}),"(",(0,r.jsx)(s.code,{children:"communityId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves community members Ids"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-49",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"community id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-66",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcommunityparticipants",children:"getCommunityParticipants()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommunityParticipants"}),"(",(0,r.jsx)(s.code,{children:"communityId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves community members as Contact objects"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-50",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"community id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-67",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getconfig",children:"getConfig()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getConfig"}),"(): ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/ConfigObject",children:(0,r.jsx)(s.code,{children:"ConfigObject"})})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the config which was used to set up the client. Sensitive details (like devTools username and password, and browserWSEndpoint) are scrubbed"}),"\n",(0,r.jsx)(s.h4,{id:"returns-68",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/ConfigObject",children:(0,r.jsx)(s.code,{children:"ConfigObject"})})}),"\n",(0,r.jsx)(s.p,{children:"SessionInfo"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getconnectionstate",children:"getConnectionState()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getConnectionState"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/enumerations/STATE",children:(0,r.jsx)(s.code,{children:"STATE"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns the connection state"}),"\n",(0,r.jsx)(s.h4,{id:"returns-69",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/enumerations/STATE",children:(0,r.jsx)(s.code,{children:"STATE"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcontact",children:"getContact()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getContact"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves contact detail object of given contact id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-51",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-70",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"contact detial as promise"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"geteventsignature",children:"getEventSignature()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getEventSignature"}),"(",(0,r.jsx)(s.code,{children:"simpleListener"}),"?): ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-52",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"simpleListener?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-71",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"string"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getfeatures",children:"getFeatures()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getFeatures"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns an object with properties of internal features and boolean values that represent if the respective feature is enabled or not."}),"\n",(0,r.jsx)(s.h4,{id:"returns-72",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgenerateduseragent",children:"getGeneratedUserAgent()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGeneratedUserAgent"}),"(",(0,r.jsx)(s.code,{children:"userA"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the generated user agent, this is so you can send it to the decryption module."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-53",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"userA?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-73",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"String useragent of wa-web session"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgptarray",children:"getGptArray()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGptArray"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"last"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns a properly formatted array of messages from to send to the openai api"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-54",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"last"}),": ",(0,r.jsx)(s.code,{children:"number"})," = ",(0,r.jsx)(s.code,{children:"10"})]}),"\n",(0,r.jsx)(s.p,{children:"The amount of previous messages to retrieve. Defaults to 10"}),"\n",(0,r.jsx)(s.h4,{id:"returns-74",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupadmins",children:"getGroupAdmins()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupAdmins"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get Admins of a Group"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-55",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-75",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupapprovalrequests",children:"getGroupApprovalRequests()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupApprovalRequests"}),"(",(0,r.jsx)(s.code,{children:"groupChatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Gets the contact IDs of members requesting approval to join the group"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-56",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupChatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-76",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupinfo",children:"getGroupInfo()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupInfo"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns the title and description of a given group id."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-57",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"group id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-77",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupinvitelink",children:"getGroupInviteLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupInviteLink"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves an invite link for a group chat. returns false if chat is not a group."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-58",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-78",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupmembers",children:"getGroupMembers()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupMembers"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns group members [Contact] objects"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-59",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-79",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupmembersid",children:"getGroupMembersId()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupMembersId"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves group members as [Id] objects"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-60",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"group id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-80",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"gethostnumber",children:"getHostNumber()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getHostNumber"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves the host device number. Use this number when registering for a license key"}),"\n",(0,r.jsx)(s.h4,{id:"returns-81",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Number"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getindicatednewmessages",children:"getIndicatedNewMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getIndicatedNewMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all unread Messages as indicated by the red dots in WA web. This returns an array of objects and are structured like so:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:'[{\n"id": "000000000000@g.us", //the id of the chat\n"indicatedNewMessages": [] //array of messages, not including any messages by the host phone\n}]\n'})}),"\n",(0,r.jsx)(s.h4,{id:"returns-82",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"list of messages"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getinstanceid",children:"getInstanceId()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getInstanceId"}),"(): ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the INSTANCE_ID of the current session"}),"\n",(0,r.jsx)(s.h4,{id:"returns-83",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"string"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getisplugged",children:"getIsPlugged()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getIsPlugged"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves whether or not phone is plugged in (i.e on charge)"}),"\n",(0,r.jsx)(s.h4,{id:"returns-84",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Number"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getissuelink",children:"getIssueLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getIssueLink"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Generate a pre-filled github issue link to easily report a bug"}),"\n",(0,r.jsx)(s.h4,{id:"returns-85",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getkickedgroups",children:"getKickedGroups()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getKickedGroups"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns an array of group ids where the host account has been kicked"}),"\n",(0,r.jsx)(s.h4,{id:"returns-86",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getlastmsgtimestamps",children:"getLastMsgTimestamps()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getLastMsgTimestamps"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get an array of chatIds with their respective last message's timestamp."}),"\n",(0,r.jsx)(s.p,{children:"This is useful for determining what chats are old/stale and need to be deleted."}),"\n",(0,r.jsx)(s.h4,{id:"returns-87",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getlastseen",children:"getLastSeen()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getLastSeen"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves the epoch timestamp of the time the contact was last seen. This will not work if:"}),"\n",(0,r.jsxs)(s.ol,{children:["\n",(0,r.jsx)(s.li,{children:"They have set it so you cannot see their last seen via privacy settings."}),"\n",(0,r.jsx)(s.li,{children:"You do not have an existing chat with the contact."}),"\n",(0,r.jsx)(s.li,{children:"The chatId is for a group\nIn both of those instances this method will return undefined."}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-61",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the chat."}),"\n",(0,r.jsx)(s.h4,{id:"returns-88",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"number timestamp when chat was last online or undefined."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getlicenselink",children:"getLicenseLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getLicenseLink"}),"(",(0,r.jsx)(s.code,{children:"params"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Generate a license link"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-62",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"params?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-89",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getlicensetype",children:"getLicenseType()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getLicenseType"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/enumerations/LicenseType",children:(0,r.jsx)(s.code,{children:"LicenseType"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns the the type of license key used by the session."}),"\n",(0,r.jsx)(s.h4,{id:"returns-90",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/enumerations/LicenseType",children:(0,r.jsx)(s.code,{children:"LicenseType"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getlistenerqueues",children:"getListenerQueues()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getListenerQueues"}),"(): ",(0,r.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["If you have set ",(0,r.jsx)(s.code,{children:"onAnyMessage"})," or ",(0,r.jsx)(s.code,{children:"onMessage"})," with the second parameter (PQueue options) then you may want to inspect their respective PQueue's."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-91",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"object"})}),"\n",(0,r.jsx)(s.h5,{id:"onack",children:"onAck"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAck"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onaddedtogroup",children:"onAddedToGroup"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAddedToGroup"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onanymessage",children:"onAnyMessage"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAnyMessage"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onbattery",children:"onBattery"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onBattery"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onbroadcast",children:"onBroadcast"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onBroadcast"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onbutton",children:"onButton"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onButton"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"oncallstate",children:"onCallState"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onCallState"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onchatdeleted",children:"onChatDeleted"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatDeleted"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onchatopened",children:"onChatOpened"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatOpened"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onchatstate",children:"onChatState"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatState"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"oncontactadded",children:"onContactAdded"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onContactAdded"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onglobalparticipantschanged",children:"onGlobalParticipantsChanged"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGlobalParticipantsChanged"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"ongroupapprovalrequest",children:"onGroupApprovalRequest"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGroupApprovalRequest"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"ongroupchange",children:"onGroupChange"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGroupChange"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onincomingcall",children:"onIncomingCall"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onIncomingCall"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onlabel",children:"onLabel"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onLabel"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onlogout",children:"onLogout"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onLogout"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onmessage",children:"onMessage"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onMessage"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onmessagedeleted",children:"onMessageDeleted"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onMessageDeleted"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onnewproduct",children:"onNewProduct"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onNewProduct"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onorder",children:"onOrder"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onOrder"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onplugged",children:"onPlugged"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onPlugged"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onpollvote",children:"onPollVote"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onPollVote"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onreaction",children:"onReaction"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onReaction"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onremovedfromgroup",children:"onRemovedFromGroup"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onRemovedFromGroup"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onstatechanged",children:"onStateChanged"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onStateChanged"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onstory",children:"onStory"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onStory"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getme",children:"getMe()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMe"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns an object with all of your host device details"}),"\n",(0,r.jsx)(s.h4,{id:"returns-92",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getmessagebyid",children:"getMessageById()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMessageById"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves message object of given message id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-63",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-93",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"message object"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"getmessageinfo-insiders",children:["getMessageInfo() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMessageInfo"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfo",children:(0,r.jsx)(s.code,{children:"MessageInfo"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Get the detailed message info for a group message sent out by the host account."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-64",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The message Id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-94",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfo",children:(0,r.jsx)(s.code,{children:"MessageInfo"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getmessagereaders",children:"getMessageReaders()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMessageReaders"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Returns an array of contacts that have read the message. If the message does not exist, it will return an empty array. If the host account has disabled read receipts this may not work!\nEach of these contact objects have a property ",(0,r.jsx)(s.code,{children:"t"})," which represents the time at which that contact read the message."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-65",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The message id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-95",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getmylastmessage",children:"getMyLastMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMyLastMessage"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves the last message sent by the host account in any given chat or globally."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-66",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"This is optional. If no chat Id is set then the last message sent by the host account will be returned."}),"\n",(0,r.jsx)(s.h4,{id:"returns-96",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["message object or ",(0,r.jsx)(s.code,{children:"undefined"})," if the host account's last message could not be found."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getmystatusarray",children:"getMyStatusArray()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMyStatusArray"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Alias for deleteStory"}),"\n",(0,r.jsx)(s.h4,{id:"returns-97",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"getmystoryarray-restricted",children:["getMyStoryArray() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMyStoryArray"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all existing stories."}),"\n",(0,r.jsx)(s.p,{children:"Only works with a Story License Key"}),"\n",(0,r.jsx)(s.h4,{id:"returns-98",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"getorder-insiders",children:["getOrder() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getOrder"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Order",children:(0,r.jsx)(s.code,{children:"Order"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Retrieves an order object"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-67",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-99",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Order",children:(0,r.jsx)(s.code,{children:"Order"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"order object"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getpage",children:"getPage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getPage"}),"(): ",(0,r.jsx)(s.code,{children:"Page"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-100",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Page"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getpolldata",children:"getPollData()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getPollData"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollData",children:(0,r.jsx)(s.code,{children:"PollData"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns poll data including results and votes."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-68",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The message id of the Poll"}),"\n",(0,r.jsx)(s.h4,{id:"returns-101",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollData",children:(0,r.jsx)(s.code,{children:"PollData"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getprocessstats",children:"getProcessStats()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getProcessStats"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the stats of the current process and the corresponding browser process."}),"\n",(0,r.jsx)(s.h4,{id:"returns-102",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getprofilepicfromserver",children:"getProfilePicFromServer()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getProfilePicFromServer"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves chat picture"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-69",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-103",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Url of the chat picture or undefined if there is no picture for the chat."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getsessionid",children:"getSessionId()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getSessionId"}),"(): ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-104",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"string"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getsessioninfo",children:"getSessionInfo()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getSessionInfo"}),"(): ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo",children:(0,r.jsx)(s.code,{children:"SessionInfo"})})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the session info"}),"\n",(0,r.jsx)(s.h4,{id:"returns-105",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo",children:(0,r.jsx)(s.code,{children:"SessionInfo"})})}),"\n",(0,r.jsx)(s.p,{children:"SessionInfo"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getsingleproperty",children:"getSingleProperty()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getSingleProperty"}),"(",(0,r.jsx)(s.code,{children:"namespace"}),", ",(0,r.jsx)(s.code,{children:"id"}),", ",(0,r.jsx)(s.code,{children:"property"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"This allows you to get a single property of a single object from the session. This limints the amouunt of data you need to sift through, reduces congestion between your process and the session and the flexibility to build your own specific getters."}),"\n",(0,r.jsx)(s.p,{children:"Example - get message read state (ack):"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"const ack = await client.getSingleProperty('Msg',\"true_12345678912@c.us_9C4D0965EA5C09D591334AB6BDB07FEB\",'ack')\n"})}),"\n",(0,r.jsx)(s.h4,{id:"parameters-70",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"namespace"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/Client/enumerations/namespace",children:(0,r.jsx)(s.code,{children:"namespace"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"id of the object to get from the specific namespace"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"property"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"the single property key to get from the object."}),"\n",(0,r.jsx)(s.h4,{id:"returns-106",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"any If the property or the id cannot be found, it will return a 404"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getsnapshot",children:"getSnapshot()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getSnapshot"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"?, ",(0,r.jsx)(s.code,{children:"width"}),"?, ",(0,r.jsx)(s.code,{children:"height"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns a PNG DataURL screenshot of the session"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-71",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"Chat ID to open before taking a snapshot"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"width?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"Width of the viewport for the snapshot. Height also required if you want to resize."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"height?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"Height of the viewport for the snapshot. Width also required if you want to resize."}),"\n",(0,r.jsx)(s.h4,{id:"returns-107",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getstarredmessages",children:"getStarredMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getStarredMessages"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves the starred messages in a given chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-72",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"Chat ID to filter starred messages by"}),"\n",(0,r.jsx)(s.h4,{id:"returns-108",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"message object"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getstatus",children:"getStatus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getStatus"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the status of a contact"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-73",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["to '",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-109",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n",(0,r.jsx)(s.h5,{id:"id",children:"id"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"status",children:"status"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"status"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getstickerdecryptable",children:(0,r.jsx)(s.del,{children:"getStickerDecryptable()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getStickerDecryptable"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-74",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["The message ID ",(0,r.jsx)(s.code,{children:"message.id"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-110",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["message object OR ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-1",children:"Deprecated"}),"\n",(0,r.jsx)(s.p,{children:"Retrieves a message object which results in a valid sticker instead of a blank one. This also works with animated stickers."}),"\n",(0,r.jsx)(s.p,{children:"If you run this without a valid insiders key, it will return false and cause an error upon decryption."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"getstoryviewers-restricted",children:["getStoryViewers() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getStoryViewers"}),"(",(0,r.jsx)(s.code,{children:"id"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[] | ",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Retrieves an array of user ids that have 'read' your story."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-75",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string The id of the story"}),"\n",(0,r.jsx)(s.h4,{id:"returns-111",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[] | ",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"gettunnelcode",children:"getTunnelCode()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getTunnelCode"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"The EASY API uses this string to secure a subdomain on the openwa public tunnel service."}),"\n",(0,r.jsx)(s.h4,{id:"returns-112",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getunreadmessages",children:"getUnreadMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getUnreadMessages"}),"(",(0,r.jsx)(s.code,{children:"includeMe"}),", ",(0,r.jsx)(s.code,{children:"includeNotifications"}),", ",(0,r.jsx)(s.code,{children:"use_unread_count"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})})," & ",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all unread Messages"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-76",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeMe"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeNotifications"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"use_unread_count"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-113",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})})," & ",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"any"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getunsentmessages",children:"getUnsentMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getUnsentMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retreive an array of messages that are not yet sent to the recipient via the host account device (i.e no ticks)"}),"\n",(0,r.jsx)(s.h4,{id:"returns-114",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getvcards",children:"getVCards()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getVCards"}),"(",(0,r.jsx)(s.code,{children:"msgId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),"[]>"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Extracts vcards from a message.This works on messages of typ ",(0,r.jsx)(s.code,{children:"vcard"})," or ",(0,r.jsx)(s.code,{children:"multi_vcard"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-77",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"msgId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"string id of the message to extract the vcards from"}),"\n",(0,r.jsx)(s.h4,{id:"returns-115",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"[vcard]"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{children:'[\n{\ndisplayName:"Contact name",\nvcard: "loong vcard string"\n}\n]\n'})}),"\n",(0,r.jsx)(s.p,{children:"or false if no valid vcards found."}),"\n",(0,r.jsxs)(s.p,{children:["Please use ",(0,r.jsx)(s.a,{href:"https://www.npmjs.com/package/vcf",children:"vcf"})," to convert a vcard string into a json object"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getwaversion",children:"getWAVersion()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getWAVersion"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-116",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"ghostforward",children:"ghostForward()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"ghostForward"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Ghost forwarding is like a normal forward but as if it were sent from the host phone [i.e it doesn't show up as forwarded.]\nAny potential abuse of this method will see it become paywalled."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-78",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-117",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"healthcheck",children:"healthCheck()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"healthCheck"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck",children:(0,r.jsx)(s.code,{children:"HealthCheck"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Runs a health check to help you determine if/when is an appropiate time to restart/refresh the session."}),"\n",(0,r.jsx)(s.h4,{id:"returns-118",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck",children:(0,r.jsx)(s.code,{children:"HealthCheck"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"iamadmin",children:"iAmAdmin()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"iAmAdmin"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns an array of group ids where the host account is admin"}),"\n",(0,r.jsx)(s.h4,{id:"returns-119",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"inviteinfo",children:"inviteInfo()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"inviteInfo"}),"(",(0,r.jsx)(s.code,{children:"link"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the details of a group through the invite link"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-79",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"link"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"This can be an invite link or invite code"}),"\n",(0,r.jsx)(s.h4,{id:"returns-120",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"ischatmuted",children:"isChatMuted()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isChatMuted"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Checks if a chat is muted"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-80",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the chat you want to check"}),"\n",(0,r.jsx)(s.h4,{id:"returns-121",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["boolean. ",(0,r.jsx)(s.code,{children:"false"})," if the chat does not exist."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"ischatonline",children:"isChatOnline()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isChatOnline"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Checks if a chat contact is online. Not entirely sure if this works with groups."}),"\n",(0,r.jsxs)(s.p,{children:["It will return ",(0,r.jsx)(s.code,{children:"true"})," if the chat is ",(0,r.jsx)(s.code,{children:"online"}),", ",(0,r.jsx)(s.code,{children:"false"})," if the chat is ",(0,r.jsx)(s.code,{children:"offline"}),", ",(0,r.jsx)(s.code,{children:"PRIVATE"})," if the privacy settings of the contact do not allow you to see their status and ",(0,r.jsx)(s.code,{children:"NO_CHAT"})," if you do not currently have a chat with that contact."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-81",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-122",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"isconnected",children:"isConnected()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isConnected"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves if the phone is online. Please note that this may not be real time."}),"\n",(0,r.jsx)(s.h4,{id:"returns-123",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"isgroupidunsafe-insiders",children:["isGroupIdUnsafe() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isGroupIdUnsafe"}),"(",(0,r.jsx)(s.code,{children:"groupChatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Checks whether or not the group id provided is known to be unsafe by the contributors of the library."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-82",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupChatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The group chat you want to deteremine is unsafe"}),"\n",(0,r.jsx)(s.h4,{id:"returns-124",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise "})," This will either return a boolean indiciating whether this group chat id is considered unsafe or an error message as a string"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"isphonedisconnected",children:"isPhoneDisconnected()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isPhoneDisconnected"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:['Check if the "Phone not Cconnected" message is showing in the browser. If it is showing, then this will return ',(0,r.jsx)(s.code,{children:"true"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-125",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"boolean"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"joingroupvialink",children:"joinGroupViaLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"joinGroupViaLink"}),"(",(0,r.jsx)(s.code,{children:"link"}),", ",(0,r.jsx)(s.code,{children:"returnChatObj"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Joins a group via the invite link, code, or message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-83",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"link"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"This param is the string which includes the invite link or code. The following work:"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:["Follow this link to join my WA group: ",(0,r.jsx)(s.a,{href:"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ",children:"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ"})]}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ",children:"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ"})}),"\n",(0,r.jsx)(s.li,{children:"DHTGJUfFJAV9MxOpZO1fBZ"}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["If you have been removed from the group previously, it will return ",(0,r.jsx)(s.code,{children:"401"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"returnChatObj?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean When this is set to true and if the group was joined successfully, it will return a serialzed Chat object which includes group information and metadata. This is useful when you want to immediately do something with group metadata."}),"\n",(0,r.jsx)(s.h4,{id:"returns-126",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," Either false if it didn't work, or the group id."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"joinwebbeta",children:"joinWebBeta()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"joinWebBeta"}),"(",(0,r.jsx)(s.code,{children:"join"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Join or leave the wa web beta program. Will return true of operation was successful."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-84",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"join"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"true to join the beta, false to leave"}),"\n",(0,r.jsx)(s.h4,{id:"returns-127",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"kill",children:"kill()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"kill"}),"(",(0,r.jsx)(s.code,{children:"reason"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Shuts down the page and browser"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-85",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"reason"}),": ",(0,r.jsx)(s.code,{children:"string"})," = ",(0,r.jsx)(s.code,{children:'"MANUALLY_KILLED"'})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-128",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"true"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"leavegroup",children:"leaveGroup()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"leaveGroup"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Removes the host device from the group"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-86",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"group id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-129",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"listwebhooks",children:"listWebhooks()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"listWebhooks"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retreives an array of webhook objects"}),"\n",(0,r.jsx)(s.h4,{id:"returns-130",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"loadallearliermessages",children:"loadAllEarlierMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"loadAllEarlierMessages"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Load all messages in chat object from server."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-87",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-131",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"Message[]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"loadandgetallmessagesinchat",children:"loadAndGetAllMessagesInChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"loadAndGetAllMessagesInChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"includeMe"}),", ",(0,r.jsx)(s.code,{children:"includeNotifications"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"loads and Retrieves all Messages in a chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-88",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeMe"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeNotifications"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-132",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"any"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"loadearliermessages",children:"loadEarlierMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"loadEarlierMessages"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Load more messages in chat object from server. Use this in a while loop. This should return up to 50 messages at a time"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-89",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-133",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"Message []"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"loadearliermessagestilldate",children:"loadEarlierMessagesTillDate()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"loadEarlierMessagesTillDate"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),", ",(0,r.jsx)(s.code,{children:"timestamp"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Load all messages until a given timestamp in chat object from server."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-90",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"timestamp"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"in seconds"}),"\n",(0,r.jsx)(s.h4,{id:"returns-134",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"Message[]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"logger",children:"logger()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"logger"}),"(): ",(0,r.jsx)(s.code,{children:"any"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Grab the logger for this session/process"}),"\n",(0,r.jsx)(s.h4,{id:"returns-135",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"any"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"logout",children:"logout()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"logout"}),"(",(0,r.jsx)(s.code,{children:"preserveSessionData"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Logs out from the session."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-91",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"preserveSessionData"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.p,{children:"skip session.data.json file invalidation\nPlease be careful when using this as it can exit the whole process depending on your config"}),"\n",(0,r.jsx)(s.h4,{id:"returns-136",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"markallread",children:"markAllRead()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"markAllRead"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Runs sendSeen on all chats"}),"\n",(0,r.jsx)(s.h4,{id:"returns-137",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"markasunread",children:"markAsUnread()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"markAsUnread"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sets a chat status to unread. May be useful to get host's attention"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-92",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-138",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"metrics",children:"metrics()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"metrics"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns some metrics of the session/page."}),"\n",(0,r.jsx)(s.h4,{id:"returns-139",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"middleware",children:"middleware()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"middleware"}),"(",(0,r.jsx)(s.code,{children:"useSessionIdInPath"}),", ",(0,r.jsx)(s.code,{children:"PORT"}),"?): (",(0,r.jsx)(s.code,{children:"req"}),", ",(0,r.jsx)(s.code,{children:"res"}),", ",(0,r.jsx)(s.code,{children:"next"}),") => ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"This exposes a simple express middlware that will allow users to quickly boot up an api based off this client. Checkout demo/index.ts for an example\nHow to use the middleware:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"\nimport { create } from '@open-wa/wa-automate';\nconst express = require('express')\nconst app = express()\napp.use(express.json())\nconst PORT = 8082;\n\nfunction start(client){\n app.use(client.middleware()); //or client.middleware(true) if you require the session id to be part of the path (so localhost:8082/sendText beccomes localhost:8082/sessionId/sendText)\n app.listen(PORT, function () {\n console.log(`\\n\u2022 Listening on port ${PORT}!`);\n });\n ...\n}\n\ncreate({\n sessionId:'session1'\n}).then(start)\n\n"})}),"\n",(0,r.jsxs)(s.p,{children:["All requests need to be ",(0,r.jsx)(s.code,{children:"POST"})," requests. You use the API the same way you would with ",(0,r.jsx)(s.code,{children:"client"}),". The method can be the path or the method param in the post body. The arguments for the method should be properly ordered in the args array in the JSON post body."]}),"\n",(0,r.jsx)(s.p,{children:"Example:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:" await client.sendText('4477777777777@c.us','test')\n //returns \"true_4477777777777@c.us_3EB0645E623D91006252\"\n"})}),"\n",(0,r.jsx)(s.p,{children:"as a request with a path:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"const axios = require('axios').default;\naxios.post('localhost:8082/sendText', {\n args: [\n \"4477777777777@c.us\", \n \"test\" \n ]\n })\n"})}),"\n",(0,r.jsx)(s.p,{children:"or as a request without a path:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"const axios = require('axios').default;\naxios.post('localhost:8082', {\n method:'sendText',\n args: [\n \"4477777777777@c.us\", \n \"test\" \n ]\n})\n"})}),"\n",(0,r.jsx)(s.p,{children:"As of 1.9.69, you can also send the argyments as an object with the keys mirroring the paramater names of the relative client functions"}),"\n",(0,r.jsx)(s.p,{children:"Example:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:'const axios = require(\'axios\').default;\naxios.post(\'localhost:8082\', {\n method:\'sendText\',\n args: {\n "to":"4477777777777@c.us", \n "content":"test" \n }\n})\n'})}),"\n",(0,r.jsx)(s.h4,{id:"parameters-93",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"useSessionIdInPath"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean Set this to true if you want to keep each session in it's own path."}),"\n",(0,r.jsxs)(s.p,{children:["For example, if you have a session with id ",(0,r.jsx)(s.code,{children:"host"})," if you set useSessionIdInPath to true, then all requests will need to be prefixed with the path ",(0,r.jsx)(s.code,{children:"host"}),". E.g ",(0,r.jsx)(s.code,{children:"localhost:8082/sendText"})," becomes ",(0,r.jsx)(s.code,{children:"localhost:8082/host/sendText"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"PORT?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-140",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Function"})}),"\n",(0,r.jsx)(s.h5,{id:"parameters-94",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"req"}),": ",(0,r.jsx)(s.code,{children:"Request"}),"<",(0,r.jsx)(s.code,{children:"ParamsDictionary"}),", ",(0,r.jsx)(s.code,{children:"any"}),", ",(0,r.jsx)(s.code,{children:"any"}),", ",(0,r.jsx)(s.code,{children:"ParsedQs"}),", ",(0,r.jsx)(s.code,{children:"Record"}),"<",(0,r.jsx)(s.code,{children:"string"}),", ",(0,r.jsx)(s.code,{children:"any"}),">>"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"res"}),": ",(0,r.jsx)(s.code,{children:"Response"}),"<",(0,r.jsx)(s.code,{children:"any"}),", ",(0,r.jsx)(s.code,{children:"Record"}),"<",(0,r.jsx)(s.code,{children:"string"}),", ",(0,r.jsx)(s.code,{children:"any"}),">>"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"next"}),": ",(0,r.jsx)(s.code,{children:"NextFunction"})]}),"\n",(0,r.jsx)(s.h5,{id:"returns-141",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"mutechat-insiders",children:["muteChat() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"muteChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"muteDuration"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Mutes a conversation for a given duration. If already muted, this will update the muted duration. Mute durations are relative from when the method is called."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-95",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the conversation you want to mute"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"muteDuration"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/enumerations/ChatMuteDuration",children:(0,r.jsx)(s.code,{children:"ChatMuteDuration"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatMuteDuration enum of the time you want this chat to be muted for."}),"\n",(0,r.jsx)(s.h4,{id:"returns-142",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true: worked or error code or message"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onnewproduct-insiders",children:["onNewProduct() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onNewProduct"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Listens to new orders. Only works on business accounts"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-96",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-143",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onorder-insiders",children:["onOrder() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onOrder"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Listens to new orders. Only works on business accounts"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-97",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-144",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"pinchat",children:"pinChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"pinChat"}),"(",(0,r.jsx)(s.code,{children:"id"}),", ",(0,r.jsx)(s.code,{children:"pin"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Pin/Unpin chats"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-98",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the conversation"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"pin"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-145",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true: worked"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"postimagestatus-restricted",children:["postImageStatus() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"postImageStatus"}),"(",(0,r.jsx)(s.code,{children:"data"}),", ",(0,r.jsx)(s.code,{children:"caption"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Posts an image story."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-99",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"data"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsxs)(s.p,{children:["data url string ",(0,r.jsx)(s.code,{children:"data:[][;charset=][;base64],"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The caption for the story"}),"\n",(0,r.jsx)(s.h4,{id:"returns-146",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," returns status id if it worked, false if it didn't"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"posttextstatus-restricted",children:["postTextStatus() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"postTextStatus"}),"(",(0,r.jsx)(s.code,{children:"text"}),", ",(0,r.jsx)(s.code,{children:"textRgba"}),", ",(0,r.jsx)(s.code,{children:"backgroundRgba"}),", ",(0,r.jsx)(s.code,{children:"font"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Sends a formatted text story."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-100",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The text to be displayed in the story"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"textRgba"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:'The colour of the text in the story in hex format, make sure to add the alpha value also. E.g "#FF00F4F2"'}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"backgroundRgba"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:'The colour of the background in the story in hex format, make sure to add the alpha value also. E.g "#4FF31FF2"'}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"font"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsxs)(s.p,{children:["The font of the text to be used in the story. This has to be a number. Each number refers to a specific predetermined font. Here are the fonts you can choose from:\n0: Sans Serif\n1: Serif\n2: ",(0,r.jsx)(s.a,{href:"https://fonts.google.com/specimen/Norican",children:"Norican Regular"}),"\n3: ",(0,r.jsx)(s.a,{href:"https://www.dafontfree.net/freefonts-bryndan-write-f160189.htm",children:"Bryndan Write"}),"\n4: ",(0,r.jsx)(s.a,{href:"https://www.dafont.com/bebas-neue.font",children:"Bebasneue Regular"}),"\n5: ",(0,r.jsx)(s.a,{href:"https://www.fontsquirrel.com/fonts/oswald",children:"Oswald Heavy"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-147",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," returns status id if it worked, false if it didn't"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"postthumbnailstatus-restricted",children:["postThumbnailStatus() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"postThumbnailStatus"}),"(",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"text"}),", ",(0,r.jsx)(s.code,{children:"textRgba"}),", ",(0,r.jsx)(s.code,{children:"backgroundRgba"}),", ",(0,r.jsx)(s.code,{children:"font"}),", ",(0,r.jsx)(s.code,{children:"thumbnail"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Sends a formatted text story with a thumbnail."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-101",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The URL to share in the story"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The text to be displayed in the story"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"textRgba"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:'The colour of the text in the story in hex format, make sure to add the alpha value also. E.g "#FF00F4F2"'}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"backgroundRgba"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:'The colour of the background in the story in hex format, make sure to add the alpha value also. E.g "#4FF31FF2"'}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"font"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"The font of the text to be used in the story. This has to be a number. Each number refers to a specific predetermined font. Here are the fonts you can choose from:"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"thumbnail?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsxs)(s.p,{children:["base64 thumbnail override, if not provided the link server will try to figure it out.\n0: Sans Serif\n1: Serif\n2: ",(0,r.jsx)(s.a,{href:"https://fonts.google.com/specimen/Norican",children:"Norican Regular"}),"\n3: ",(0,r.jsx)(s.a,{href:"https://www.dafontfree.net/freefonts-bryndan-write-f160189.htm",children:"Bryndan Write"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-148",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," returns status id if it worked, false if it didn't"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"postvideostatus-restricted",children:["postVideoStatus() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"postVideoStatus"}),"(",(0,r.jsx)(s.code,{children:"data"}),", ",(0,r.jsx)(s.code,{children:"caption"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Posts a video story."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-102",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"data"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsxs)(s.p,{children:["data url string ",(0,r.jsx)(s.code,{children:"data:[][;charset=][;base64],"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The caption for the story"}),"\n",(0,r.jsx)(s.h4,{id:"returns-149",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," returns status id if it worked, false if it didn't"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"prepeventdata",children:"prepEventData()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"prepEventData"}),"(",(0,r.jsx)(s.code,{children:"data"}),", ",(0,r.jsx)(s.code,{children:"event"}),", ",(0,r.jsx)(s.code,{children:"extras"}),"?): ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/EventPayload",children:(0,r.jsx)(s.code,{children:"EventPayload"})})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-103",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"data"}),": ",(0,r.jsx)(s.code,{children:"JsonObject"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"event"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"extras?"}),": ",(0,r.jsx)(s.code,{children:"JsonObject"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-150",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/EventPayload",children:(0,r.jsx)(s.code,{children:"EventPayload"})})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"promoteparticipant",children:"promoteParticipant()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"promoteParticipant"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"participantId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Promote Participant to Admin in Group"}),"\n",(0,r.jsxs)(s.p,{children:["If not a group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_GROUP_CHAT"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If the chat does not exist, returns ",(0,r.jsx)(s.code,{children:"GROUP_DOES_NOT_EXIST"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the participantId does not exist in the group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_PARTICIPANT"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the host account is not an administrator, returns ",(0,r.jsx)(s.code,{children:"INSUFFICIENT_PERMISSIONS"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-104",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"participantId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-151",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"react",children:"react()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"react"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"emoji"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"React to a message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-105",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"Message ID of the message you want to react to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"emoji"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"1 single emoji to add to the message as a reacion"}),"\n",(0,r.jsx)(s.h4,{id:"returns-152",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"refresh",children:"refresh()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"refresh"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Refreshes the page and reinjects all necessary files. This may be useful for when trying to save memory\nThis will attempt to re register all listeners EXCEPT onLiveLocation and onParticipantChanged"}),"\n",(0,r.jsx)(s.h4,{id:"returns-153",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"registerwebhook",children:"registerWebhook()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"registerWebhook"}),"(",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"events"}),", ",(0,r.jsx)(s.code,{children:"requestConfig"}),", ",(0,r.jsx)(s.code,{children:"concurrency"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"The client can now automatically handle webhooks. Use this method to register webhooks."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-106",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The webhook url"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"events"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})}),"[] | ",(0,r.jsx)(s.code,{children:'"all"'})]}),"\n",(0,r.jsxs)(s.p,{children:["An array of [[SimpleListener]] enums or ",(0,r.jsx)(s.code,{children:"all"})," (to register all possible listeners)"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a post request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"concurrency"}),": ",(0,r.jsx)(s.code,{children:"number"})," = ",(0,r.jsx)(s.code,{children:"5"})]}),"\n",(0,r.jsx)(s.p,{children:"the amount of concurrent requests to be handled by the built in queue. Default is 5."}),"\n",(0,r.jsx)(s.h4,{id:"returns-154",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"A webhook object. This will include a webhook ID and an array of all successfully registered Listeners."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"rejectgroupjoinrequest",children:"rejectGroupJoinRequest()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"rejectGroupJoinRequest"}),"(",(0,r.jsx)(s.code,{children:"groupChatId"}),", ",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Rejects a group join request\n*"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-107",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupChatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The group chat id\n*"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The contact id of the person who is requesting to join the group\n*"}),"\n",(0,r.jsx)(s.h4,{id:"returns-155",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removealllisteners",children:"removeAllListeners()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeAllListeners"}),"(): ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-156",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"boolean"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removelabel",children:"removeLabel()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeLabel"}),"(",(0,r.jsx)(s.code,{children:"label"}),", ",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Removes label from chat, message or contact. Only for business accounts."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-108",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"label"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-157",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removelistener",children:"removeListener()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeListener"}),"(",(0,r.jsx)(s.code,{children:"listener"}),"): ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"//////////////////////// LISTENERS"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-109",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"listener"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-158",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"boolean"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removeparticipant",children:"removeParticipant()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeParticipant"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"participantId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Remove participant of Group"}),"\n",(0,r.jsxs)(s.p,{children:["If not a group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_GROUP_CHAT"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If the chat does not exist, returns ",(0,r.jsx)(s.code,{children:"GROUP_DOES_NOT_EXIST"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the participantId does not exist in the group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_PARTICIPANT"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the host account is not an administrator, returns ",(0,r.jsx)(s.code,{children:"INSUFFICIENT_PERMISSIONS"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-110",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"0000000000-00000000@g.us"})}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"participantId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"000000000000@c.us"})}),"\n",(0,r.jsx)(s.h4,{id:"returns-159",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removeproduct",children:"removeProduct()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeProduct"}),"(",(0,r.jsx)(s.code,{children:"productId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Remove a product from the host account's catalog"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-111",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"productId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the product"}),"\n",(0,r.jsx)(s.h4,{id:"returns-160",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removewebhook",children:"removeWebhook()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeWebhook"}),"(",(0,r.jsx)(s.code,{children:"webhookId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Removes a webhook."}),"\n",(0,r.jsxs)(s.p,{children:["Returns ",(0,r.jsx)(s.code,{children:"true"})," if the webhook was found and removed. ",(0,r.jsx)(s.code,{children:"false"})," if the webhook was not found and therefore could not be removed. This does not unregister any listeners off of other webhooks."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-112",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"webhookId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The ID of the webhook"}),"\n",(0,r.jsx)(s.h4,{id:"returns-161",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"retruns",children:"Retruns"}),"\n",(0,r.jsx)(s.p,{children:"boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"reply",children:"reply()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"reply"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"content"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),", ",(0,r.jsx)(s.code,{children:"sendSeen"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a reply to a given message. Please note, you need to have at least sent one normal message to a contact in order for this to work properly."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-113",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"string chatid"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"content"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string reply text"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"string the msg id to reply to."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"sendSeen?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean If set to true, the chat will 'blue tick' all messages before sending the reply"}),"\n",(0,r.jsx)(s.h4,{id:"returns-162",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," false if didn't work, otherwise returns message id."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"reportspam-restricted",children:["reportSpam() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"reportSpam"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Report a contact for spam, block them and attempt to clear chat."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-114",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-163",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"resizepage",children:"resizePage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"resizePage"}),"(",(0,r.jsx)(s.code,{children:"width"}),", ",(0,r.jsx)(s.code,{children:"height"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Easily resize page on the fly. Useful if you're showing screenshots in a web-app."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-115",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"width"}),": ",(0,r.jsx)(s.code,{children:"number"})," = ",(0,r.jsx)(s.code,{children:"1920"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"height"}),": ",(0,r.jsx)(s.code,{children:"number"})," = ",(0,r.jsx)(s.code,{children:"1080"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-164",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"revokegroupinvitelink",children:"revokeGroupInviteLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"revokeGroupInviteLink"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Revokes the current invite link for a group chat. Any previous links will stop working"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-116",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-165",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendadvancedbuttons",children:(0,r.jsx)(s.del,{children:"sendAdvancedButtons()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendAdvancedButtons"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"body"}),", ",(0,r.jsx)(s.code,{children:"buttons"}),", ",(0,r.jsx)(s.code,{children:"text"}),", ",(0,r.jsx)(s.code,{children:"footer"}),", ",(0,r.jsx)(s.code,{children:"filename"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-117",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"chat id"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"body"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/LocationButtonBody",children:(0,r.jsx)(s.code,{children:"LocationButtonBody"})})]}),"\n",(0,r.jsx)(s.p,{children:"The body of the buttons message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"buttons"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/AdvancedButton",children:(0,r.jsx)(s.code,{children:"AdvancedButton"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"Array of buttons - limit is 3!"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"footer"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The footer of the buttons message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filename"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"Required if body is a file!!"}),"\n",(0,r.jsx)(s.h4,{id:"returns-166",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-2",children:"Deprecated"}),"\n",(0,r.jsxs)(s.admonition,{type:"danger",children:[(0,r.jsx)(s.p,{children:"Template messages (URL & CALL buttons) are broken for the foreseeable future. Please DO NOT get a license solely for access to URL or CALL buttons. They are no longer reliable due to recent changes at WA.\nWA BIZ accounts CANNOT send buttons. This is a WA limitation. DO NOT get a license solely for access to buttons on wa business accounts."}),(0,r.jsx)(s.p,{children:"THIS IS NOT WORKING FOR GROUPS YET."}),(0,r.jsx)(s.p,{children:"ADVANCED ARE DEPRECATED FOR NOW. DO NOT GET A LICENSE TO USE BUTTONS."})]}),"\n",(0,r.jsx)(s.p,{children:"Send advanced buttons with media body. This is an insiders feature for MD accounts."}),"\n",(0,r.jsx)(s.p,{children:"Body can be location, image, video or document. Buttons can be quick reply, url or call buttons."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendaudio",children:"sendAudio()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendAudio"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send an audio file with the default audio player (not PTT/voice message)"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-118",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:(0,r.jsx)(s.code,{children:"AdvancedFile"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB",children:"true_0000000000@c.us_JHB2HB23HJ4B234HJB"})," to send as a reply to a message"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-167",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendbanner",children:"sendBanner()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendBanner"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"base64"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send a banner image"}),"\n",(0,r.jsx)(s.p,{children:"Note this is a bit of hack on top of a location message. During testing it is shown to not work on iPhones."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-119",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"base64"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsx)(s.p,{children:"base64 encoded jpeg"}),"\n",(0,r.jsx)(s.h4,{id:"returns-168",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendbuttons",children:(0,r.jsx)(s.del,{children:"sendButtons()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendButtons"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"body"}),", ",(0,r.jsx)(s.code,{children:"buttons"}),", ",(0,r.jsx)(s.code,{children:"title"}),"?, ",(0,r.jsx)(s.code,{children:"footer"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-120",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"chat id"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"body"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/LocationButtonBody",children:(0,r.jsx)(s.code,{children:"LocationButtonBody"})})]}),"\n",(0,r.jsx)(s.p,{children:"The body of the buttons message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"buttons"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/Button",children:(0,r.jsx)(s.code,{children:"Button"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"Array of buttons - limit is 3!"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"title?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The title/header of the buttons message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"footer?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The footer of the buttons message"}),"\n",(0,r.jsx)(s.h4,{id:"returns-169",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-3",children:"Deprecated"}),"\n",(0,r.jsxs)(s.admonition,{type:"danger",children:[(0,r.jsx)(s.p,{children:"WA BIZ accounts CANNOT send buttons. This is a WA limitation. DO NOT get a license solely for access to buttons on wa business accounts.\nTHIS IS NOT WORKING FOR GROUPS YET."}),(0,r.jsx)(s.p,{children:"BUTTONS ARE DEPRECATED FOR NOW. DO NOT GET A LICENSE TO USE BUTTONS."})]}),"\n",(0,r.jsx)(s.p,{children:"Send generic quick reply buttons. This is an insiders feature for MD accounts."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendcontact",children:"sendContact()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendContact"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends contact card to given chat id. You can use this to send multiple contacts but they will show up as multiple single-contact messages."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-121",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:xxxx@c.us",children:"xxxx@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-170",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendcustomproduct",children:(0,r.jsx)(s.del,{children:"sendCustomProduct()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendCustomProduct"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"image"}),", ",(0,r.jsx)(s.code,{children:"productData"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-122",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"image"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"productData"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/CustomProduct",children:(0,r.jsx)(s.code,{children:"CustomProduct"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-171",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-4",children:"Deprecated"}),"\n",(0,r.jsx)(s.p,{children:"Feature Currently only available with Premium License accounts."}),"\n",(0,r.jsx)(s.p,{children:"Send a custom product to a chat. Please see [[CustomProduct]] for details."}),"\n",(0,r.jsx)(s.p,{children:"Caveats:"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:"URL will not work (unable to click), you will have to send another message with the URL."}),"\n",(0,r.jsx)(s.li,{children:'Recipient will see a thin banner under picture that says "Something went wrong"'}),"\n",(0,r.jsx)(s.li,{children:"This will only work if you have at least 1 product already in your catalog"}),"\n",(0,r.jsx)(s.li,{children:"Only works on Business accounts"}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendemoji",children:"sendEmoji()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendEmoji"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"emojiId"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send a discord emoji to a chat as a sticker"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-123",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatId The chat id you want to send the webp sticker to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"emojiId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["The discord emoji id without indentifying chars. In discord you would write ",(0,r.jsx)(s.code,{children:":who:"}),", here use ",(0,r.jsx)(s.code,{children:"who"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["message id of the message you want this sticker to reply to. @license",":insiders","@"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-172",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendfile",children:"sendFile()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendFile"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"filename"}),", ",(0,r.jsx)(s.code,{children:"caption"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"waitForId"}),"?, ",(0,r.jsx)(s.code,{children:"ptt"}),"?, ",(0,r.jsx)(s.code,{children:"withoutPreview"}),"?, ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"viewOnce"}),"?, ",(0,r.jsx)(s.code,{children:"requestConfig"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a file to given chat, with caption or not, using base64. This is exactly the same as sendImage"}),"\n",(0,r.jsxs)(s.p,{children:["Please note that any file that resolves to mime-type ",(0,r.jsx)(s.code,{children:"octet-stream"})," will, by default, resolve to an MP4 file."]}),"\n",(0,r.jsxs)(s.p,{children:["If you want a specific filetype, then explcitly select the correct mime-type from ",(0,r.jsx)(s.a,{href:"https://www.iana.org/assignments/media-types/media-types.xhtml",children:"https://www.iana.org/assignments/media-types/media-types.xhtml"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-124",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:(0,r.jsx)(s.code,{children:"AdvancedFile"})})]}),"\n",(0,r.jsxs)(s.p,{children:["DataURL data",":image","/xxx;base64,xxx or the RELATIVE (should start with ",(0,r.jsx)(s.code,{children:"./"})," or ",(0,r.jsx)(s.code,{children:"../"}),") path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] ",(0,r.jsx)(s.code,{children:"https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg"}),")."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filename"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string xxxxx With an ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?tier=Insiders%20Program",children:"INSIDERS LICENSE-KEY"})," you can also tag people in groups with ",(0,r.jsx)(s.code,{children:"@[number]"}),". For example if you want to mention the user with the number ",(0,r.jsx)(s.code,{children:"44771234567"}),", just add ",(0,r.jsx)(s.code,{children:"@44771234567"})," in the caption."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB",children:"true_0000000000@c.us_JHB2HB23HJ4B234HJB"})," to send as a reply to a message"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"waitForId?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to wait for the id of the message. By default this is set to false as it will take a few seconds to retrieve to the key of the message and this waiting may not be desirable for the majority of users."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"ptt?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to send the file as a push to talk file."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withoutPreview?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to send the file without a preview (i.e as a file). This is useful for preventing auto downloads on recipient devices."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false [INSIDERS] set this to try silent tag someone in the caption"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"viewOnce?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig?"}),": ",(0,r.jsx)(s.code,{children:"any"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-173",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise "})," This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendfilefromurl",children:"sendFileFromUrl()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendFileFromUrl"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"filename"}),", ",(0,r.jsx)(s.code,{children:"caption"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"requestConfig"}),"?, ",(0,r.jsx)(s.code,{children:"waitForId"}),"?, ",(0,r.jsx)(s.code,{children:"ptt"}),"?, ",(0,r.jsx)(s.code,{children:"withoutPreview"}),"?, ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"viewOnce"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a file by Url or custom options"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-125",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4",children:"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filename"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string 'video.mp4'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB",children:"true_0000000000@c.us_JHB2HB23HJ4B234HJB"})," to send as a reply to a message"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig?"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"waitForId?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to wait for the id of the message. By default this is set to false as it will take a few seconds to retrieve to the key of the message and this waiting may not be desirable for the majority of users."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"ptt?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to send the file as a push to talk file."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withoutPreview?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to send the file without a preview (i.e as a file). This is useful for preventing auto downloads on recipient devices."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"viewOnce?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-174",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendgiphy",children:"sendGiphy()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendGiphy"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"giphyMediaUrl"}),", ",(0,r.jsx)(s.code,{children:"caption"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a video to given chat as a gif by using a giphy link, with caption or not, using base64"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-126",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"giphyMediaUrl"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"https://media.giphy.com/media/oYtVHSxngR3lC/giphy.gif",children:"https://media.giphy.com/media/oYtVHSxngR3lC/giphy.gif"})," => ",(0,r.jsx)(s.a,{href:"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4",children:"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsx)(s.h4,{id:"returns-175",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendgiphyassticker",children:"sendGiphyAsSticker()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendGiphyAsSticker"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"giphyMediaUrl"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send a giphy GIF as an animated sticker."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-127",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatId"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"giphyMediaUrl"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"URL"})]}),"\n",(0,r.jsxs)(s.p,{children:["URL | string This is the giphy media url and has to be in the format ",(0,r.jsx)(s.code,{children:"https://media.giphy.com/media/RJKHjCAdsAfQPn03qQ/source.gif"})," or it can be just the id ",(0,r.jsx)(s.code,{children:"RJKHjCAdsAfQPn03qQ"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-176",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendimage",children:"sendImage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendImage"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"filename"}),", ",(0,r.jsx)(s.code,{children:"caption"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"waitForId"}),"?, ",(0,r.jsx)(s.code,{children:"ptt"}),"?, ",(0,r.jsx)(s.code,{children:"withoutPreview"}),"?, ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"viewOnce"}),"?, ",(0,r.jsx)(s.code,{children:"requestConfig"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a image to given chat, with caption or not, using base64"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-128",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:(0,r.jsx)(s.code,{children:"AdvancedFile"})})]}),"\n",(0,r.jsxs)(s.p,{children:["DataURL data",":image","/xxx;base64,xxx or the RELATIVE (should start with ",(0,r.jsx)(s.code,{children:"./"})," or ",(0,r.jsx)(s.code,{children:"../"}),") path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] ",(0,r.jsx)(s.code,{children:"https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg"}),")."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filename"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"waitForId?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"ptt?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withoutPreview?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false [INSIDERS] set this to try silent tag someone in the caption"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"viewOnce?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig?"}),": ",(0,r.jsx)(s.code,{children:"any"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-177",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise "})," This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendimageassticker",children:"sendImageAsSticker()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendImageAsSticker"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"image"}),", ",(0,r.jsx)(s.code,{children:"stickerMetadata"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"This function takes an image (including animated GIF) and sends it as a sticker to the recipient. This is helpful for sending semi-ephemeral things like QR codes.\nThe advantage is that it will not show up in the recipients gallery. This function automatiicaly converts images to the required webp format."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-129",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"image"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})," | ",(0,r.jsx)(s.code,{children:"Buffer"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"stickerMetadata?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:(0,r.jsx)(s.code,{children:"StickerMetadata"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-178",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendimageasstickerasreply-insiders",children:["sendImageAsStickerAsReply() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendImageAsStickerAsReply"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"image"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"stickerMetadata"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"This function takes an image and sends it as a sticker to the recipient as a reply to another message."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-130",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The recipient id."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"image"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})," | ",(0,r.jsx)(s.code,{children:"Buffer"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the message to reply to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"stickerMetadata?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:(0,r.jsx)(s.code,{children:"StickerMetadata"})})]}),"\n",(0,r.jsx)(s.p,{children:"Sticker metadata"}),"\n",(0,r.jsx)(s.h4,{id:"returns-179",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendimagewithproduct",children:"sendImageWithProduct()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendImageWithProduct"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"image"}),", ",(0,r.jsx)(s.code,{children:"caption"}),", ",(0,r.jsx)(s.code,{children:"bizNumber"}),", ",(0,r.jsx)(s.code,{children:"productId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends product with image to chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-131",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"image"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string the caption you want to add to this message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"bizNumber"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"string the @c.us number of the business account from which you want to grab the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"productId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string the id of the product within the main catalog of the aforementioned business"}),"\n",(0,r.jsx)(s.h4,{id:"returns-180",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendlinkwithautopreview",children:"sendLinkWithAutoPreview()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendLinkWithAutoPreview"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"text"}),"?, ",(0,r.jsx)(s.code,{children:"thumbnail"}),"?, ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"customSize"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Automatically sends a link with the auto generated link preview. You can also add a custom message."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-132",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string A link."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string Custom text as body of the message, this needs to include the link or it will be appended after the link."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"thumbnail?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsx)(s.p,{children:"Base64 of the jpeg/png which will be used to override the automatically generated thumbnail."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Send this link preview message in response to a given quoted message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize?"})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Anchor the size of the thumbnail"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.height?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.width?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-181",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendlistmessage",children:(0,r.jsx)(s.del,{children:"sendListMessage()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendListMessage"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"sections"}),", ",(0,r.jsx)(s.code,{children:"title"}),", ",(0,r.jsx)(s.code,{children:"description"}),", ",(0,r.jsx)(s.code,{children:"actionText"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-133",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"sections"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/Section",children:(0,r.jsx)(s.code,{children:"Section"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"The Sections of rows for the list message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"title"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The title of the list message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"description"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The description of the list message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"actionText"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The action text of the list message"}),"\n",(0,r.jsx)(s.h4,{id:"returns-182",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-5",children:"Deprecated"}),"\n",(0,r.jsxs)(s.admonition,{type:"danger",children:[(0,r.jsx)(s.p,{children:"It is not currently possible to send a listmessage to a group chat. This is a WA limitation.\nPlease DO NOT get a license solely for access to list messages in group chats."}),(0,r.jsx)(s.p,{children:"LIST MESSAGES ARE DEPRECATED TILL FURTHER NOTICE"})]}),"\n",(0,r.jsx)(s.p,{children:"Send a list message. This will not work when being sent from business accounts!"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendlocation",children:"sendLocation()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendLocation"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"lat"}),", ",(0,r.jsx)(s.code,{children:"lng"}),", ",(0,r.jsx)(s.code,{children:"loc"}),", ",(0,r.jsx)(s.code,{children:"address"}),"?, ",(0,r.jsx)(s.code,{children:"url"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Note: ",(0,r.jsx)(s.code,{children:"address"})," and ",(0,r.jsx)(s.code,{children:"url"})," are parameters available to insiders only."]}),"\n",(0,r.jsx)(s.p,{children:"Sends a location message to given chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-134",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"lat"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"latitude: '51.5074'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"lng"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"longitude: '0.1278'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"loc"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"location text: 'LONDON!'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"address?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"address text: '1 Regents Park!'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["address text link: '",(0,r.jsx)(s.a,{href:"https://example.com",children:"https://example.com"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-183",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendmessagewiththumb",children:"sendMessageWithThumb()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendMessageWithThumb"}),"(",(0,r.jsx)(s.code,{children:"thumb"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"title"}),", ",(0,r.jsx)(s.code,{children:"description"}),", ",(0,r.jsx)(s.code,{children:"text"}),", ",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"customSize"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a link to a chat that includes a link preview."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-135",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"thumb"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The base 64 data of the image you want to use as the thunbnail. This should be no more than 200x200px. Note: Dont need data url on this param"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The link you want to send"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"title"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The title of the link"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"description"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The long description of the link preview"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The text you want to inslude in the message section. THIS HAS TO INCLUDE THE URL otherwise the url will be prepended to the text automatically."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The chat you want to send this message to."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Send this link preview message in response to a given quoted message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize?"})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Anchor the size of the thumbnail"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.height?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.width?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-184",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendmp4assticker",children:"sendMp4AsSticker()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendMp4AsSticker"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"processOptions"}),", ",(0,r.jsx)(s.code,{children:"stickerMetadata"}),"?, ",(0,r.jsx)(s.code,{children:"messageId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Use this to send an mp4 file as a sticker. This can also be used to convert GIFs from the chat because GIFs in WA are actually tiny mp4 files."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-136",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatId The chat id you want to send the webp sticker to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})," | ",(0,r.jsx)(s.code,{children:"Buffer"})]}),"\n",(0,r.jsx)(s.p,{children:"[[DataURL]], [[Base64]], URL (string GET), Relative filepath (string), or Buffer of the mp4 file"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"processOptions"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions",children:(0,r.jsx)(s.code,{children:"Mp4StickerConversionProcessOptions"})})," = ",(0,r.jsx)(s.code,{children:"defaultProcessOptions"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"stickerMetadata?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:(0,r.jsx)(s.code,{children:"StickerMetadata"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["message id of the message you want this sticker to reply to. @license",":insiders","@"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-185",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendmultiplecontacts-insiders",children:["sendMultipleContacts() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendMultipleContacts"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"contactIds"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Sends multiple contacts as a single message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-137",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:xxxx@c.us",children:"xxxx@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactIds"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-186",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendpaymentrequest",children:"sendPaymentRequest()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendPaymentRequest"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"amount"}),", ",(0,r.jsx)(s.code,{children:"currency"}),", ",(0,r.jsx)(s.code,{children:"message"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"[UNTESTED - REQUIRES FEEDBACK]\nSends a payment request message to given chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-138",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"amount"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"number the amount to request in 1000 format (e.g \xa310 => 10000)"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"currency"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string The 3 letter currency code"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string optional message to send with the payment request"}),"\n",(0,r.jsx)(s.h4,{id:"returns-187",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendpoll",children:"sendPoll()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendPoll"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"name"}),", ",(0,r.jsx)(s.code,{children:"options"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"allowMultiSelect"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send a poll to a group chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-139",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"chat id - a group chat is required"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"name"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"the name of the poll"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"options"}),": ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"an array of poll options"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"A message to quote when sending the poll"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"allowMultiSelect?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Whether or not to allow multiple selections. default false"}),"\n",(0,r.jsx)(s.h4,{id:"returns-188",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendproduct-insiders",children:["sendProduct() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendProduct"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"productId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Send a product to a chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-140",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The chatId"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"productId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the product"}),"\n",(0,r.jsx)(s.h4,{id:"returns-189",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"MessageID"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendptt",children:"sendPtt()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendPtt"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Attempts to send a file as a voice note. Useful if you want to send an mp3 file."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-141",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:(0,r.jsx)(s.code,{children:"AdvancedFile"})})]}),"\n",(0,r.jsxs)(s.p,{children:["base64 data",":image","/xxx;base64,xxx or the path of the file you want to send."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB",children:"true_0000000000@c.us_JHB2HB23HJ4B234HJB"})," to send as a reply to a message"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-190",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise "})," This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendrawwebpassticker",children:"sendRawWebpAsSticker()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendRawWebpAsSticker"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"webpBase64"}),", ",(0,r.jsx)(s.code,{children:"animated"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"You can use this to send a raw webp file."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-142",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatId The chat id you want to send the webp sticker to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"webpBase64"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsx)(s.p,{children:"Base64 The base64 string of the webp file. Not DataURl"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"animated"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsxs)(s.p,{children:["Boolean Set to true if the webp is animated. Default ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-191",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendrawwebpasstickerasreply-insiders",children:["sendRawWebpAsStickerAsReply() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendRawWebpAsStickerAsReply"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"webpBase64"}),", ",(0,r.jsx)(s.code,{children:"animated"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"You can use this to send a raw webp file."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-143",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatId The chat id you want to send the webp sticker to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"MessageId Message ID of the message to reply to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"webpBase64"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsx)(s.p,{children:"Base64 The base64 string of the webp file. Not DataURl"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"animated"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsxs)(s.p,{children:["Boolean Set to true if the webp is animated. Default ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-192",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendreplywithmentions",children:"sendReplyWithMentions()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendReplyWithMentions"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"content"}),", ",(0,r.jsx)(s.code,{children:"replyMessageId"}),", ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"mentions"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:'Sends a reply to given chat that includes mentions, replying to the provided replyMessageId.\nIn order to use this method correctly you will need to send the text like this:\n"@4474747474747 how are you?"\nBasically, add a @ symbol before the number of the contact you want to mention.'}),"\n",(0,r.jsx)(s.h4,{id:"parameters-144",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"content"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"text message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"replyMessageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"id of message to reply to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Removes all tags within the message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"mentions?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"You can optionally add an array of contact IDs to tag only specific people"}),"\n",(0,r.jsx)(s.h4,{id:"returns-193",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendseen",children:"sendSeen()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendSeen"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sets a chat status to seen. Marks all messages as ack: 3"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-145",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-194",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendstickerfromurl",children:"sendStickerfromUrl()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendStickerfromUrl"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"requestConfig"}),", ",(0,r.jsx)(s.code,{children:"stickerMetadata"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a sticker (including GIF) from a given URL"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-146",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"stickerMetadata?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:(0,r.jsx)(s.code,{children:"StickerMetadata"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-195",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendstickerfromurlasreply-insiders",children:["sendStickerfromUrlAsReply() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendStickerfromUrlAsReply"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"requestConfig"}),", ",(0,r.jsx)(s.code,{children:"stickerMetadata"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Sends a sticker from a given URL"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-147",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The recipient id."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The url of the image"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the message to reply to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"stickerMetadata?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:(0,r.jsx)(s.code,{children:"StickerMetadata"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-196",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendtext-restricted",children:["sendText() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendText"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"content"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Sends a text message to given chat"}),"\n",(0,r.jsxs)(s.p,{children:["A license is ",(0,r.jsx)(s.strong,{children:"NOT"})," required to send messages with existing chats/contacts. A license is only required for starting conversations with new numbers."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-148",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"content"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"text message"}),"\n",(0,r.jsx)(s.h4,{id:"returns-197",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendtextwithmentions",children:"sendTextWithMentions()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendTextWithMentions"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"content"}),", ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"mentions"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:'Sends a text message to given chat that includes mentions.\nIn order to use this method correctly you will need to send the text like this:\n"@4474747474747 how are you?"\nBasically, add a @ symbol before the number of the contact you want to mention.'}),"\n",(0,r.jsx)(s.h4,{id:"parameters-149",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"content"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"text message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Removes all tags within the message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"mentions?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"You can optionally add an array of contact IDs to tag only specific people"}),"\n",(0,r.jsx)(s.h4,{id:"returns-198",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendvcard",children:"sendVCard()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendVCard"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"vcard"}),", ",(0,r.jsx)(s.code,{children:"contactName"}),"?, ",(0,r.jsx)(s.code,{children:"contactNumber"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send VCARD"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-150",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"vcard"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"vcard as a string, you can send multiple contacts vcard also."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactName?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The display name for the contact. Ignored on multiple vcards"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactNumber?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["If supplied, this will be injected into the vcard (VERSION 3 ONLY FROM VCARDJS) with the WA id to make it show up with the correct buttons on WA. The format of this param should be including country code, without any other formating. e.g:\n",(0,r.jsx)(s.code,{children:"4477777777777"}),"\nIgnored on multiple vcards"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-199",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendvideoasgif",children:"sendVideoAsGif()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendVideoAsGif"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"filename"}),", ",(0,r.jsx)(s.code,{children:"caption"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"requestConfig"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a video to given chat as a gif, with caption or not, using base64"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-151",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:(0,r.jsx)(s.code,{children:"AdvancedFile"})})]}),"\n",(0,r.jsxs)(s.p,{children:["DataURL data",":image","/xxx;base64,xxx or the RELATIVE (should start with ",(0,r.jsx)(s.code,{children:"./"})," or ",(0,r.jsx)(s.code,{children:"../"}),") path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] ",(0,r.jsx)(s.code,{children:"https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg"}),")."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filename"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB",children:"true_0000000000@c.us_JHB2HB23HJ4B234HJB"})," to send as a reply to a message"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig?"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-200",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendyoutubelink",children:"sendYoutubeLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendYoutubeLink"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"text"}),", ",(0,r.jsx)(s.code,{children:"thumbnail"}),"?, ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"customSize"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Automatically sends a youtube link with the auto generated link preview. You can also add a custom message."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-152",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string A youtube link."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})," = ",(0,r.jsx)(s.code,{children:"''"})]}),"\n",(0,r.jsx)(s.p,{children:"string Custom text as body of the message, this needs to include the link or it will be appended after the link."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"thumbnail?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsx)(s.p,{children:"string Base64 of the jpeg/png which will be used to override the automatically generated thumbnail."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Send this link preview message in response to a given quoted message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize?"})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Anchor the size of the thumbnail"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.height?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.width?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-201",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"setchatbackgroundcolourhex-insiders",children:["setChatBackgroundColourHex() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setChatBackgroundColourHex"}),"(",(0,r.jsx)(s.code,{children:"hex"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Set the wallpaper background colour"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-153",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hex"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"'#FFF123'"}),"\n",(0,r.jsx)(s.h4,{id:"returns-202",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"setchatephemeral-insiders",children:["setChatEphemeral() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setChatEphemeral"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"ephemeral"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Turn the ephemeral setting in a chat to on or off"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-154",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The ID of the chat"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"ephemeral"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/EphemeralDuration",children:(0,r.jsx)(s.code,{children:"EphemeralDuration"})})]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," to turn on the ephemeral setting to 1 day, ",(0,r.jsx)(s.code,{children:"false"})," to turn off the ephemeral setting. Other options: ",(0,r.jsx)(s.code,{children:"604800 | 7776000"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-203",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," true if the setting was set, ",(0,r.jsx)(s.code,{children:"false"})," if the chat does not exist"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setchatstate",children:"setChatState()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setChatState"}),"(",(0,r.jsx)(s.code,{children:"chatState"}),", ",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sets the chat state"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-155",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatState"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/enumerations/ChatState",children:(0,r.jsx)(s.code,{children:"ChatState"})})]}),"\n",(0,r.jsx)(s.p,{children:"The state you want to set for the chat. Can be TYPING (0), RECRDING (1) or PAUSED (2)."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-204",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgroupapprovalmode",children:"setGroupApprovalMode()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupApprovalMode"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"requireApproval"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Turn on or off the approval requirement for new members to join a group"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-156",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"' the group id."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requireApproval"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"set to true to turn on the approval requirement, false to turn off"}),"\n",(0,r.jsx)(s.h4,{id:"returns-205",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if action completed successfully."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgroupdescription",children:"setGroupDescription()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupDescription"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"description"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Change the group chant description"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-157",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"' the group id."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"description"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string The new group description"}),"\n",(0,r.jsx)(s.h4,{id:"returns-206",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if action completed successfully."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgroupedittoadminsonly",children:"setGroupEditToAdminsOnly()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupEditToAdminsOnly"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"onlyAdmins"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Change who can and cannot edit a groups details"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-158",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"' the group id."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"onlyAdmins"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean set to true if you want only admins to be able to speak in this group. false if you want to allow everyone to speak in the group"}),"\n",(0,r.jsx)(s.h4,{id:"returns-207",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if action completed successfully."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgroupicon",children:"setGroupIcon()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupIcon"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"image"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Change the icon for the group chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-159",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"mailto:123123123123_1312313123@g.us",children:"123123123123_1312313123@g.us"})," The id of the group"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"image"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-208",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if it was set, false if it didn't work. It usually doesn't work if the image file is too big."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgroupiconbyurl",children:"setGroupIconByUrl()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupIconByUrl"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"requestConfig"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Change the icon for the group chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-160",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"mailto:123123123123_1312313123@g.us",children:"123123123123_1312313123@g.us"})," The id of the group"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-209",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if it was set, false if it didn't work. It usually doesn't work if the image file is too big."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"setgrouptitle-insiders",children:["setGroupTitle() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupTitle"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"title"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Change the group chat title"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-161",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"' the group id."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"title"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string The new group title"}),"\n",(0,r.jsx)(s.h4,{id:"returns-210",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if action completed successfully."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgrouptoadminsonly",children:"setGroupToAdminsOnly()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupToAdminsOnly"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"onlyAdmins"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Change who can and cannot speak in a group"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-162",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"' the group id."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"onlyAdmins"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean set to true if you want only admins to be able to speak in this group. false if you want to allow everyone to speak in the group"}),"\n",(0,r.jsx)(s.h4,{id:"returns-211",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if action completed successfully."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setmyname",children:"setMyName()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setMyName"}),"(",(0,r.jsx)(s.code,{children:"newName"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Set your profile name"}),"\n",(0,r.jsx)(s.p,{children:"Please note, this does not work on business accounts!"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-163",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"newName"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"String new name to set for your profile"}),"\n",(0,r.jsx)(s.h4,{id:"returns-212",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setmystatus",children:"setMyStatus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setMyStatus"}),"(",(0,r.jsx)(s.code,{children:"newStatus"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"set your about me"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-164",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"newStatus"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"String new profile status"}),"\n",(0,r.jsx)(s.h4,{id:"returns-213",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setpresence",children:"setPresence()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setPresence"}),"(",(0,r.jsx)(s.code,{children:"available"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Set presence to available or unavailable."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-165",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"available"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"if true it will set your presence to 'online', false will set to unavailable (i.e no 'online' on recipients' phone);"}),"\n",(0,r.jsx)(s.h4,{id:"returns-214",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setprofilepic",children:"setProfilePic()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setProfilePic"}),"(",(0,r.jsx)(s.code,{children:"data"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sets the profile pic of the host number."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-166",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"data"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsx)(s.p,{children:"string data url image string."}),"\n",(0,r.jsx)(s.h4,{id:"returns-215",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," success if true"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"simulaterecording",children:"simulateRecording()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"simulateRecording"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"on"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Simulate '...recording' in chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-167",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:xxxx@c.us",children:"xxxx@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"on"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"turn on similated recording, false to turn it off you need to manually turn this off."}),"\n",(0,r.jsx)(s.h4,{id:"returns-216",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"simulatetyping",children:"simulateTyping()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"simulateTyping"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"on"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Simulate '...typing' in chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-168",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:xxxx@c.us",children:"xxxx@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"on"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"turn on similated typing, false to turn it off you need to manually turn this off."}),"\n",(0,r.jsx)(s.h4,{id:"returns-217",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"starmessage",children:"starMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"starMessage"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Star a message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-169",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"Message ID of the message you want to star"}),"\n",(0,r.jsx)(s.h4,{id:"returns-218",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"true"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"synccontacts",children:"syncContacts()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"syncContacts"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Syncs contacts with phone. This promise does not resolve so it will instantly return true."}),"\n",(0,r.jsx)(s.h4,{id:"returns-219",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"tageveryone-insiders",children:["tagEveryone() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"tagEveryone"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"content"}),", ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"formatting"}),"?, ",(0,r.jsx)(s.code,{children:"messageBeforeTags"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Tags everyone in the group with a message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-170",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["group chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@g.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"content"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"text message to add under all of the tags"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Removes all tags within the message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"formatting?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The formatting of the tags. Use"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageBeforeTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["set to ",(0,r.jsx)(s.code,{children:"true"})," to show the message before all of the tags"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-220",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.h4,{id:"mention",children:"Mention"}),"\n",(0,r.jsx)(s.p,{children:"to indicate the actual tag."}),"\n",(0,r.jsx)(s.h4,{id:"default",children:"Default"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"@mention "})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"testbuttons",children:(0,r.jsx)(s.del,{children:"testButtons()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"testButtons"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-171",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-221",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-6",children:"Deprecated"}),"\n",(0,r.jsx)(s.admonition,{type:"danger",children:(0,r.jsx)(s.p,{children:"Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA."})}),"\n",(0,r.jsx)(s.p,{children:"Test the button commands on MD accounts with an insiders key. This is a temporary feature to help fix issue #2658"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"testcallback",children:"testCallback()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"testCallback"}),"(",(0,r.jsx)(s.code,{children:"callbackToTest"}),", ",(0,r.jsx)(s.code,{children:"testData"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Use this simple command to test firing callback events."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-172",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"callbackToTest"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"testData"}),": ",(0,r.jsx)(s.code,{children:"any"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-222",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"false"})," if the callback was not registered/does not exist"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"unmutechat-insiders",children:["unmuteChat() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"unmuteChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Unmutes a conversation."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-173",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-223",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true: worked or error code or message"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"unstarmessage",children:"unstarMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"unstarMessage"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Unstar a message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-174",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"Message ID of the message you want to unstar"}),"\n",(0,r.jsx)(s.h4,{id:"returns-224",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"true"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"updatewebhook",children:"updateWebhook()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"updateWebhook"}),"(",(0,r.jsx)(s.code,{children:"webhookId"}),", ",(0,r.jsx)(s.code,{children:"events"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Update registered events for a specific webhook. This will override all existing events. If you'd like to remove all listeners from a webhook, consider using [[removeWebhook]]."}),"\n",(0,r.jsx)(s.p,{children:"In order to update authentication details for a webhook, remove it completely and then reregister it with the correct credentials."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-175",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"webhookId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"events"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})}),"[] | ",(0,r.jsx)(s.code,{children:'"all"'})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-225",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"waitallqempty",children:"waitAllQEmpty()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"waitAllQEmpty"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"true"})," | ",(0,r.jsx)(s.code,{children:"void"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Wait for all queues to be empty"}),"\n",(0,r.jsx)(s.h4,{id:"returns-226",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"true"})," | ",(0,r.jsx)(s.code,{children:"void"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"waitwhqidle",children:"waitWhQIdle()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"waitWhQIdle"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"true"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Wait for the webhook queue to become idle. This is useful for ensuring webhooks are cleared before ending a process."}),"\n",(0,r.jsx)(s.h4,{id:"returns-227",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"true"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.h2,{id:"events",children:"Events"}),"\n",(0,r.jsx)(s.h3,{id:"onack-1",children:"onAck()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAck"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to messages acknowledgement Changes"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-176",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[Message]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-228",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onaddedtogroup-1",children:"onAddedToGroup()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAddedToGroup"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Fires callback with Chat object every time the host phone is added to a group."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-177",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[Chat]] (group chat) as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-229",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onanymessage-1",children:"onAnyMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAnyMessage"}),"(",(0,r.jsx)(s.code,{children:"fn"}),", ",(0,r.jsx)(s.code,{children:"queueOptions"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to all new messages"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-178",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"queueOptions?"}),": ",(0,r.jsx)(s.code,{children:"Options"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["PQueue options. Set to ",(0,r.jsx)(s.code,{children:"{}"})," for default PQueue."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-230",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Message]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onbattery-1",children:(0,r.jsx)(s.del,{children:"onBattery()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onBattery"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-179",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-231",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-7",children:"Deprecated"}),"\n",(0,r.jsx)(s.p,{children:"Listens to battery changes"}),"\n",(0,r.jsx)(s.admonition,{type:"caution",children:(0,r.jsx)(s.p,{children:"This will most likely not work with multi-device mode (the only remaining mode) since the session is no longer connected to the phone but directly to WA servers."})}),"\n",(0,r.jsx)(s.h4,{id:"fires-1",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"number"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onbroadcast-1",children:"onBroadcast()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onBroadcast"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to broadcast messages"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-180",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-232",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-2",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Message]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onbutton-1",children:"onButton()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onButton"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to button message responses"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-181",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-233",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-3",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Message]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"oncallstate-1",children:"onCallState()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onCallState"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to changes on call state"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-182",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-234",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Observable stream of call objects"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onchatdeleted-1",children:"onChatDeleted()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatDeleted"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to when a chat is deleted by the host account"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-183",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-235",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-4",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Chat]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onchatopened-insiders",children:["onChatOpened() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatOpened"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Fires callback with the relevant chat id every time the user clicks on a chat. This will only work in headful mode."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-184",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[ChatId]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-236",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onchatstate-insiders",children:["onChatState() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatState"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Listens to chat state, including when a specific user is recording and typing within a group chat."}),"\n",(0,r.jsx)(s.p,{children:"Here is an example of the fired object:"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-185",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-237",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-5",children:"Fires"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:'{\n"chat": "00000000000-1111111111@g.us", //the chat in which this state is occuring\n"user": "22222222222@c.us", //the user that is causing this state\n"state": "composing, //can also be \'available\', \'unavailable\', \'recording\' or \'composing\'\n}\n'})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"oncontactadded-insiders",children:["onContactAdded() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onContactAdded"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Fires callback with contact id when a new contact is added on the host phone."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-186",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[Chat]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-238",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onglobalparticipantschanged-1",children:"onGlobalParticipantsChanged()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGlobalParticipantsChanged"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to add and remove events on Groups on a global level. It is memory efficient and doesn't require a specific group id to listen to."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-187",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[ParticipantChangedEventModel]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-239",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"ongroupapprovalrequest-1",children:"onGroupApprovalRequest()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGroupApprovalRequest"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Listents to group approval requests. Emits a message object. Use it with ",(0,r.jsx)(s.code,{children:"message.isGroupApprovalRequest()"})," to check if it is a group approval request."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-188",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[Message]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-240",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"ongroupchange-1",children:"onGroupChange()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGroupChange"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to all group (gp2) events. This can be useful if you want to catch when a group title, subject or picture is changed."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-189",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[ParticipantChangedEventModel]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-241",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onincomingcall-1",children:"onIncomingCall()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onIncomingCall"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to new incoming calls"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-190",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-242",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Observable stream of call request objects"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onlabel-1",children:"onLabel()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onLabel"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to label change events"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-191",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-243",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-6",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Label]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onlivelocation",children:"onLiveLocation()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onLiveLocation"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to live locations from a chat that already has valid live locations"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-192",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"the chat from which you want to subscribes to live location updates"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback that takes in a LiveLocationChangedEvent"}),"\n",(0,r.jsx)(s.h4,{id:"returns-244",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean, if returns false then there were no valid live locations in the chat of chatId"}),"\n",(0,r.jsx)(s.h4,{id:"emits",children:"Emits"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:""})," LiveLocationChangedEvent"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onlogout-1",children:"onLogout()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onLogout"}),"(",(0,r.jsx)(s.code,{children:"fn"}),", ",(0,r.jsx)(s.code,{children:"priority"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to a log out event"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-193",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"priority?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"A priority of -1 will mean the callback will be triggered after all the non -1 callbacks"}),"\n",(0,r.jsx)(s.h4,{id:"returns-245",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-7",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"true"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onmessage-1",children:"onMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onMessage"}),"(",(0,r.jsx)(s.code,{children:"fn"}),", ",(0,r.jsx)(s.code,{children:"queueOptions"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to incoming messages"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-194",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"queueOptions?"}),": ",(0,r.jsx)(s.code,{children:"Options"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["PQueue options. Set to ",(0,r.jsx)(s.code,{children:"{}"})," for default PQueue."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-246",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-8",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Message]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onmessagedeleted-1",children:"onMessageDeleted()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onMessageDeleted"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to when a message is deleted by a recipient or the host account"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-195",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-247",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-9",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Message]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onparticipantschanged",children:"onParticipantsChanged()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onParticipantsChanged"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"fn"}),", ",(0,r.jsx)(s.code,{children:"legacy"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to add and remove events on Groups. This can no longer determine who commited the action and only reports the following events add, remove, promote, demote"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-196",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["group id: ",(0,r.jsx)(s.a,{href:"mailto:xxxxx-yyyy@c.us",children:"xxxxx-yyyy@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"legacy"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-248",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Observable stream of participantChangedEvent"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onplugged-1",children:"onPlugged()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onPlugged"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to when host device is plugged/unplugged"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-197",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-249",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-10",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"boolean true if plugged, false if unplugged"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onpollvote-1",children:"onPollVote()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onPollVote"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to poll vote events"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-198",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-250",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-11",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[PollData]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onreaction-insiders",children:["onReaction() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onReaction"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Listens to reaction add and change events"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-199",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-251",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-12",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[ReactionEvent]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onremovedfromgroup-insiders",children:["onRemovedFromGroup() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onRemovedFromGroup"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Fires callback with Chat object every time the host phone is removed to a group."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-200",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[Chat]] (group chat) as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-252",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onstatechanged-1",children:"onStateChanged()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onStateChanged"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to changes in state"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-201",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-253",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-13",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"STATE observable sream of states"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onstory-restricted",children:["onStory() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onStory"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Listens to when a contact posts a new story."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-202",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-254",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-14",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"e.g"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"{\nfrom: '123456789@c.us'\nid: 'false_132234234234234@status.broadcast'\n}\n"})})]})}function h(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>l,x:()=>c});var r=n(6540);const i={},d=r.createContext(i);function l(e){const s=r.useContext(d);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),r.createElement(d.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/26af37c4.2cfdf6c1.js b/assets/js/26af37c4.2cfdf6c1.js new file mode 100644 index 000000000..b3fe4f29d --- /dev/null +++ b/assets/js/26af37c4.2cfdf6c1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8745],{8114:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>t,contentTitle:()=>l,default:()=>h,frontMatter:()=>d,metadata:()=>c,toc:()=>a});var r=n(4848),i=n(8453);const d={},l="Class: Client",c={id:"reference/api/Client/classes/Client",title:"Class: Client",description:"Methods",source:"@site/docs/reference/api/Client/classes/Client.md",sourceDirName:"reference/api/Client/classes",slug:"/reference/api/Client/classes/Client",permalink:"/docs/reference/api/Client/classes/Client",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/Client/classes/Client.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"api/Client",permalink:"/docs/reference/api/Client/"},next:{title:"Enumeration: namespace",permalink:"/docs/reference/api/Client/enumerations/namespace"}},t={},a=[{value:"Methods",id:"methods",level:2},{value:'B()
insiders
',id:"b-insiders",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Example",id:"example",level:4},{value:"acceptGroupJoinRequest()",id:"acceptgroupjoinrequest",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"addLabel()",id:"addlabel",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"addParticipant()",id:"addparticipant",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"approveGroupJoinRequest()",id:"approvegroupjoinrequest",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"archiveChat()",id:"archivechat",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"autoReject()",id:"autoreject",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"awaitMessages()",id:"awaitmessages",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Example",id:"example-1",level:4},{value:"checkNumberStatus()",id:"checknumberstatus",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:'checkReadReceipts()
insiders
',id:"checkreadreceipts-insiders",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"clearAllChats()",id:"clearallchats",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"clearChat()",id:"clearchat",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-11",level:4},{value:"contactBlock()",id:"contactblock",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-12",level:4},{value:"contactUnblock()",id:"contactunblock",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-13",level:4},{value:'createCommunity()
insiders
',id:"createcommunity-insiders",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-14",level:4},{value:"createGroup()",id:"creategroup",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-15",level:4},{value:'createLabel()
insiders
',id:"createlabel-insiders",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-16",level:4},{value:"createMessageCollector()",id:"createmessagecollector",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-17",level:4},{value:'createNewProduct()
insiders
',id:"createnewproduct-insiders",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-18",level:4},{value:"cutChatCache()",id:"cutchatcache",level:3},{value:"Returns",id:"returns-19",level:4},{value:"after",id:"after",level:5},{value:"after.chats",id:"afterchats",level:5},{value:"after.msgs",id:"aftermsgs",level:5},{value:"before",id:"before",level:5},{value:"before.chats",id:"beforechats",level:5},{value:"before.msgs",id:"beforemsgs",level:5},{value:"cutMsgCache()",id:"cutmsgcache",level:3},{value:"Returns",id:"returns-20",level:4},{value:"darkMode()",id:"darkmode",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-21",level:4},{value:"decryptMedia()",id:"decryptmedia",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-22",level:4},{value:"deleteAllStatus()",id:"deleteallstatus",level:3},{value:"Returns",id:"returns-23",level:4},{value:'deleteAllStories()
restricted
',id:"deleteallstories-restricted",level:3},{value:"Returns",id:"returns-24",level:4},{value:"deleteChat()",id:"deletechat",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-25",level:4},{value:"deleteMessage()",id:"deletemessage",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-26",level:4},{value:"deleteStaleChats()",id:"deletestalechats",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-27",level:4},{value:"deleteStatus()",id:"deletestatus",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-28",level:4},{value:'deleteStory()
restricted
',id:"deletestory-restricted",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-29",level:4},{value:"demoteParticipant()",id:"demoteparticipant",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-30",level:4},{value:"download()",id:"download",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-31",level:4},{value:"downloadFileWithCredentials()",id:"downloadfilewithcredentials",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-32",level:4},{value:"downloadProfilePicFromMessage()",id:"downloadprofilepicfrommessage",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"Returns",id:"returns-33",level:4},{value:"editMessage()",id:"editmessage",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"Returns",id:"returns-34",level:4},{value:'editProduct()
insiders
',id:"editproduct-insiders",level:3},{value:"Parameters",id:"parameters-31",level:4},{value:"Returns",id:"returns-35",level:4},{value:"emitUnreadMessages()",id:"emitunreadmessages",level:3},{value:"Returns",id:"returns-36",level:4},{value:"forceRefocus()",id:"forcerefocus",level:3},{value:"Returns",id:"returns-37",level:4},{value:'forceStaleMediaUpdate()
insiders
',id:"forcestalemediaupdate-insiders",level:3},{value:"Parameters",id:"parameters-32",level:4},{value:"Returns",id:"returns-38",level:4},{value:"forceUpdateConnectionState()",id:"forceupdateconnectionstate",level:3},{value:"Parameters",id:"parameters-33",level:4},{value:"Returns",id:"returns-39",level:4},{value:"forceUpdateLiveLocation()",id:"forceupdatelivelocation",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"Returns",id:"returns-40",level:4},{value:"forwardMessages()",id:"forwardmessages",level:3},{value:"Parameters",id:"parameters-35",level:4},{value:"Returns",id:"returns-41",level:4},{value:"gc()",id:"gc",level:3},{value:"Returns",id:"returns-42",level:4},{value:"getAllChatIds()",id:"getallchatids",level:3},{value:"Returns",id:"returns-43",level:4},{value:"getAllChats()",id:"getallchats",level:3},{value:"Parameters",id:"parameters-36",level:4},{value:"Returns",id:"returns-44",level:4},{value:"getAllChatsWithMessages()",id:"getallchatswithmessages",level:3},{value:"Parameters",id:"parameters-37",level:4},{value:"Returns",id:"returns-45",level:4},{value:"Deprecated",id:"deprecated",level:4},{value:"getAllCommunities()",id:"getallcommunities",level:3},{value:"Returns",id:"returns-46",level:4},{value:"getAllContacts()",id:"getallcontacts",level:3},{value:"Returns",id:"returns-47",level:4},{value:"getAllGroups()",id:"getallgroups",level:3},{value:"Parameters",id:"parameters-38",level:4},{value:"Returns",id:"returns-48",level:4},{value:"getAllLabels()",id:"getalllabels",level:3},{value:"Returns",id:"returns-49",level:4},{value:"getAllMessagesInChat()",id:"getallmessagesinchat",level:3},{value:"Parameters",id:"parameters-39",level:4},{value:"Returns",id:"returns-50",level:4},{value:"getAllNewMessages()",id:"getallnewmessages",level:3},{value:"Returns",id:"returns-51",level:4},{value:"getAllUnreadMessages()",id:"getallunreadmessages",level:3},{value:"Returns",id:"returns-52",level:4},{value:"getAmountOfLoadedMessages()",id:"getamountofloadedmessages",level:3},{value:"Returns",id:"returns-53",level:4},{value:"getBatteryLevel()",id:"getbatterylevel",level:3},{value:"Returns",id:"returns-54",level:4},{value:"Deprecated",id:"deprecated-1",level:4},{value:"getBlockedIds()",id:"getblockedids",level:3},{value:"Returns",id:"returns-55",level:4},{value:"getBusinessProfile()",id:"getbusinessprofile",level:3},{value:"Parameters",id:"parameters-40",level:4},{value:"Returns",id:"returns-56",level:4},{value:"getBusinessProfilesProducts()",id:"getbusinessprofilesproducts",level:3},{value:"Parameters",id:"parameters-41",level:4},{value:"Returns",id:"returns-57",level:4},{value:"getChat()",id:"getchat",level:3},{value:"Parameters",id:"parameters-42",level:4},{value:"Returns",id:"returns-58",level:4},{value:"getChatById()",id:"getchatbyid",level:3},{value:"Parameters",id:"parameters-43",level:4},{value:"Returns",id:"returns-59",level:4},{value:"getChatWithNonContacts()",id:"getchatwithnoncontacts",level:3},{value:"Returns",id:"returns-60",level:4},{value:"getChatsByLabel()",id:"getchatsbylabel",level:3},{value:"Parameters",id:"parameters-44",level:4},{value:"Returns",id:"returns-61",level:4},{value:"Label",id:"label",level:4},{value:'getCommonGroups()
insiders
',id:"getcommongroups-insiders",level:3},{value:"Parameters",id:"parameters-45",level:4},{value:"Returns",id:"returns-62",level:4},{value:"getCommunityAdminIds()",id:"getcommunityadminids",level:3},{value:"Parameters",id:"parameters-46",level:4},{value:"Returns",id:"returns-63",level:4},{value:"getCommunityAdmins()",id:"getcommunityadmins",level:3},{value:"Parameters",id:"parameters-47",level:4},{value:"Returns",id:"returns-64",level:4},{value:"getCommunityInfo()",id:"getcommunityinfo",level:3},{value:"Parameters",id:"parameters-48",level:4},{value:"Returns",id:"returns-65",level:4},{value:"getCommunityParticipantIds()",id:"getcommunityparticipantids",level:3},{value:"Parameters",id:"parameters-49",level:4},{value:"Returns",id:"returns-66",level:4},{value:"getCommunityParticipants()",id:"getcommunityparticipants",level:3},{value:"Parameters",id:"parameters-50",level:4},{value:"Returns",id:"returns-67",level:4},{value:"getConfig()",id:"getconfig",level:3},{value:"Returns",id:"returns-68",level:4},{value:"getConnectionState()",id:"getconnectionstate",level:3},{value:"Returns",id:"returns-69",level:4},{value:"getContact()",id:"getcontact",level:3},{value:"Parameters",id:"parameters-51",level:4},{value:"Returns",id:"returns-70",level:4},{value:"getEventSignature()",id:"geteventsignature",level:3},{value:"Parameters",id:"parameters-52",level:4},{value:"Returns",id:"returns-71",level:4},{value:"getFeatures()",id:"getfeatures",level:3},{value:"Returns",id:"returns-72",level:4},{value:"getGeneratedUserAgent()",id:"getgenerateduseragent",level:3},{value:"Parameters",id:"parameters-53",level:4},{value:"Returns",id:"returns-73",level:4},{value:"getGptArray()",id:"getgptarray",level:3},{value:"Parameters",id:"parameters-54",level:4},{value:"Returns",id:"returns-74",level:4},{value:"getGroupAdmins()",id:"getgroupadmins",level:3},{value:"Parameters",id:"parameters-55",level:4},{value:"Returns",id:"returns-75",level:4},{value:"getGroupApprovalRequests()",id:"getgroupapprovalrequests",level:3},{value:"Parameters",id:"parameters-56",level:4},{value:"Returns",id:"returns-76",level:4},{value:"getGroupInfo()",id:"getgroupinfo",level:3},{value:"Parameters",id:"parameters-57",level:4},{value:"Returns",id:"returns-77",level:4},{value:"getGroupInviteLink()",id:"getgroupinvitelink",level:3},{value:"Parameters",id:"parameters-58",level:4},{value:"Returns",id:"returns-78",level:4},{value:"getGroupMembers()",id:"getgroupmembers",level:3},{value:"Parameters",id:"parameters-59",level:4},{value:"Returns",id:"returns-79",level:4},{value:"getGroupMembersId()",id:"getgroupmembersid",level:3},{value:"Parameters",id:"parameters-60",level:4},{value:"Returns",id:"returns-80",level:4},{value:"getHostNumber()",id:"gethostnumber",level:3},{value:"Returns",id:"returns-81",level:4},{value:"getIndicatedNewMessages()",id:"getindicatednewmessages",level:3},{value:"Returns",id:"returns-82",level:4},{value:"getInstanceId()",id:"getinstanceid",level:3},{value:"Returns",id:"returns-83",level:4},{value:"getIsPlugged()",id:"getisplugged",level:3},{value:"Returns",id:"returns-84",level:4},{value:"getIssueLink()",id:"getissuelink",level:3},{value:"Returns",id:"returns-85",level:4},{value:"getKickedGroups()",id:"getkickedgroups",level:3},{value:"Returns",id:"returns-86",level:4},{value:"getLastMsgTimestamps()",id:"getlastmsgtimestamps",level:3},{value:"Returns",id:"returns-87",level:4},{value:"getLastSeen()",id:"getlastseen",level:3},{value:"Parameters",id:"parameters-61",level:4},{value:"Returns",id:"returns-88",level:4},{value:"getLicenseLink()",id:"getlicenselink",level:3},{value:"Parameters",id:"parameters-62",level:4},{value:"Returns",id:"returns-89",level:4},{value:"getLicenseType()",id:"getlicensetype",level:3},{value:"Returns",id:"returns-90",level:4},{value:"getListenerQueues()",id:"getlistenerqueues",level:3},{value:"Returns",id:"returns-91",level:4},{value:"onAck",id:"onack",level:5},{value:"onAddedToGroup",id:"onaddedtogroup",level:5},{value:"onAnyMessage",id:"onanymessage",level:5},{value:"onBattery",id:"onbattery",level:5},{value:"onBroadcast",id:"onbroadcast",level:5},{value:"onButton",id:"onbutton",level:5},{value:"onCallState",id:"oncallstate",level:5},{value:"onChatDeleted",id:"onchatdeleted",level:5},{value:"onChatOpened",id:"onchatopened",level:5},{value:"onChatState",id:"onchatstate",level:5},{value:"onContactAdded",id:"oncontactadded",level:5},{value:"onGlobalParticipantsChanged",id:"onglobalparticipantschanged",level:5},{value:"onGroupApprovalRequest",id:"ongroupapprovalrequest",level:5},{value:"onGroupChange",id:"ongroupchange",level:5},{value:"onIncomingCall",id:"onincomingcall",level:5},{value:"onLabel",id:"onlabel",level:5},{value:"onLogout",id:"onlogout",level:5},{value:"onMessage",id:"onmessage",level:5},{value:"onMessageDeleted",id:"onmessagedeleted",level:5},{value:"onNewProduct",id:"onnewproduct",level:5},{value:"onOrder",id:"onorder",level:5},{value:"onPlugged",id:"onplugged",level:5},{value:"onPollVote",id:"onpollvote",level:5},{value:"onReaction",id:"onreaction",level:5},{value:"onRemovedFromGroup",id:"onremovedfromgroup",level:5},{value:"onStateChanged",id:"onstatechanged",level:5},{value:"onStory",id:"onstory",level:5},{value:"getMe()",id:"getme",level:3},{value:"Returns",id:"returns-92",level:4},{value:"getMessageById()",id:"getmessagebyid",level:3},{value:"Parameters",id:"parameters-63",level:4},{value:"Returns",id:"returns-93",level:4},{value:'getMessageInfo()
insiders
',id:"getmessageinfo-insiders",level:3},{value:"Parameters",id:"parameters-64",level:4},{value:"Returns",id:"returns-94",level:4},{value:"getMessageReaders()",id:"getmessagereaders",level:3},{value:"Parameters",id:"parameters-65",level:4},{value:"Returns",id:"returns-95",level:4},{value:"getMyLastMessage()",id:"getmylastmessage",level:3},{value:"Parameters",id:"parameters-66",level:4},{value:"Returns",id:"returns-96",level:4},{value:"getMyStatusArray()",id:"getmystatusarray",level:3},{value:"Returns",id:"returns-97",level:4},{value:'getMyStoryArray()
restricted
',id:"getmystoryarray-restricted",level:3},{value:"Returns",id:"returns-98",level:4},{value:'getOrder()
insiders
',id:"getorder-insiders",level:3},{value:"Parameters",id:"parameters-67",level:4},{value:"Returns",id:"returns-99",level:4},{value:"getPage()",id:"getpage",level:3},{value:"Returns",id:"returns-100",level:4},{value:"getPollData()",id:"getpolldata",level:3},{value:"Parameters",id:"parameters-68",level:4},{value:"Returns",id:"returns-101",level:4},{value:"getProcessStats()",id:"getprocessstats",level:3},{value:"Returns",id:"returns-102",level:4},{value:"getProfilePicFromServer()",id:"getprofilepicfromserver",level:3},{value:"Parameters",id:"parameters-69",level:4},{value:"Returns",id:"returns-103",level:4},{value:"getSessionId()",id:"getsessionid",level:3},{value:"Returns",id:"returns-104",level:4},{value:"getSessionInfo()",id:"getsessioninfo",level:3},{value:"Returns",id:"returns-105",level:4},{value:"getSingleProperty()",id:"getsingleproperty",level:3},{value:"Parameters",id:"parameters-70",level:4},{value:"Returns",id:"returns-106",level:4},{value:"getSnapshot()",id:"getsnapshot",level:3},{value:"Parameters",id:"parameters-71",level:4},{value:"Returns",id:"returns-107",level:4},{value:"getStarredMessages()",id:"getstarredmessages",level:3},{value:"Parameters",id:"parameters-72",level:4},{value:"Returns",id:"returns-108",level:4},{value:"getStatus()",id:"getstatus",level:3},{value:"Parameters",id:"parameters-73",level:4},{value:"Returns",id:"returns-109",level:4},{value:"id",id:"id",level:5},{value:"status",id:"status",level:5},{value:"getStickerDecryptable()",id:"getstickerdecryptable",level:3},{value:"Parameters",id:"parameters-74",level:4},{value:"Returns",id:"returns-110",level:4},{value:"Deprecated",id:"deprecated-2",level:4},{value:'getStoryViewers()
restricted
',id:"getstoryviewers-restricted",level:3},{value:"Parameters",id:"parameters-75",level:4},{value:"Returns",id:"returns-111",level:4},{value:"getTunnelCode()",id:"gettunnelcode",level:3},{value:"Returns",id:"returns-112",level:4},{value:"getUnreadMessages()",id:"getunreadmessages",level:3},{value:"Parameters",id:"parameters-76",level:4},{value:"Returns",id:"returns-113",level:4},{value:"getUnsentMessages()",id:"getunsentmessages",level:3},{value:"Returns",id:"returns-114",level:4},{value:"getVCards()",id:"getvcards",level:3},{value:"Parameters",id:"parameters-77",level:4},{value:"Returns",id:"returns-115",level:4},{value:"getWAVersion()",id:"getwaversion",level:3},{value:"Returns",id:"returns-116",level:4},{value:"ghostForward()",id:"ghostforward",level:3},{value:"Parameters",id:"parameters-78",level:4},{value:"Returns",id:"returns-117",level:4},{value:"healthCheck()",id:"healthcheck",level:3},{value:"Returns",id:"returns-118",level:4},{value:"iAmAdmin()",id:"iamadmin",level:3},{value:"Returns",id:"returns-119",level:4},{value:"inviteInfo()",id:"inviteinfo",level:3},{value:"Parameters",id:"parameters-79",level:4},{value:"Returns",id:"returns-120",level:4},{value:"isChatMuted()",id:"ischatmuted",level:3},{value:"Parameters",id:"parameters-80",level:4},{value:"Returns",id:"returns-121",level:4},{value:"isChatOnline()",id:"ischatonline",level:3},{value:"Parameters",id:"parameters-81",level:4},{value:"Returns",id:"returns-122",level:4},{value:"isConnected()",id:"isconnected",level:3},{value:"Returns",id:"returns-123",level:4},{value:'isGroupIdUnsafe()
insiders
',id:"isgroupidunsafe-insiders",level:3},{value:"Parameters",id:"parameters-82",level:4},{value:"Returns",id:"returns-124",level:4},{value:"isPhoneDisconnected()",id:"isphonedisconnected",level:3},{value:"Returns",id:"returns-125",level:4},{value:"joinGroupViaLink()",id:"joingroupvialink",level:3},{value:"Parameters",id:"parameters-83",level:4},{value:"Returns",id:"returns-126",level:4},{value:"joinWebBeta()",id:"joinwebbeta",level:3},{value:"Parameters",id:"parameters-84",level:4},{value:"Returns",id:"returns-127",level:4},{value:"kill()",id:"kill",level:3},{value:"Parameters",id:"parameters-85",level:4},{value:"Returns",id:"returns-128",level:4},{value:"leaveGroup()",id:"leavegroup",level:3},{value:"Parameters",id:"parameters-86",level:4},{value:"Returns",id:"returns-129",level:4},{value:"listWebhooks()",id:"listwebhooks",level:3},{value:"Returns",id:"returns-130",level:4},{value:"loadAllEarlierMessages()",id:"loadallearliermessages",level:3},{value:"Parameters",id:"parameters-87",level:4},{value:"Returns",id:"returns-131",level:4},{value:"loadAndGetAllMessagesInChat()",id:"loadandgetallmessagesinchat",level:3},{value:"Parameters",id:"parameters-88",level:4},{value:"Returns",id:"returns-132",level:4},{value:"loadEarlierMessages()",id:"loadearliermessages",level:3},{value:"Parameters",id:"parameters-89",level:4},{value:"Returns",id:"returns-133",level:4},{value:"loadEarlierMessagesTillDate()",id:"loadearliermessagestilldate",level:3},{value:"Parameters",id:"parameters-90",level:4},{value:"Returns",id:"returns-134",level:4},{value:"logger()",id:"logger",level:3},{value:"Returns",id:"returns-135",level:4},{value:"logout()",id:"logout",level:3},{value:"Parameters",id:"parameters-91",level:4},{value:"Returns",id:"returns-136",level:4},{value:"markAllRead()",id:"markallread",level:3},{value:"Returns",id:"returns-137",level:4},{value:"markAsUnread()",id:"markasunread",level:3},{value:"Parameters",id:"parameters-92",level:4},{value:"Returns",id:"returns-138",level:4},{value:"metrics()",id:"metrics",level:3},{value:"Returns",id:"returns-139",level:4},{value:"middleware()",id:"middleware",level:3},{value:"Parameters",id:"parameters-93",level:4},{value:"Returns",id:"returns-140",level:4},{value:"Parameters",id:"parameters-94",level:5},{value:"Returns",id:"returns-141",level:5},{value:'muteChat()
insiders
',id:"mutechat-insiders",level:3},{value:"Parameters",id:"parameters-95",level:4},{value:"Returns",id:"returns-142",level:4},{value:'onNewProduct()
insiders
',id:"onnewproduct-insiders",level:3},{value:"Parameters",id:"parameters-96",level:4},{value:"Returns",id:"returns-143",level:4},{value:'onOrder()
insiders
',id:"onorder-insiders",level:3},{value:"Parameters",id:"parameters-97",level:4},{value:"Returns",id:"returns-144",level:4},{value:"pinChat()",id:"pinchat",level:3},{value:"Parameters",id:"parameters-98",level:4},{value:"Returns",id:"returns-145",level:4},{value:'postImageStatus()
restricted
',id:"postimagestatus-restricted",level:3},{value:"Parameters",id:"parameters-99",level:4},{value:"Returns",id:"returns-146",level:4},{value:'postTextStatus()
restricted
',id:"posttextstatus-restricted",level:3},{value:"Parameters",id:"parameters-100",level:4},{value:"Returns",id:"returns-147",level:4},{value:'postThumbnailStatus()
restricted
',id:"postthumbnailstatus-restricted",level:3},{value:"Parameters",id:"parameters-101",level:4},{value:"Returns",id:"returns-148",level:4},{value:'postVideoStatus()
restricted
',id:"postvideostatus-restricted",level:3},{value:"Parameters",id:"parameters-102",level:4},{value:"Returns",id:"returns-149",level:4},{value:"prepEventData()",id:"prepeventdata",level:3},{value:"Parameters",id:"parameters-103",level:4},{value:"Returns",id:"returns-150",level:4},{value:"promoteParticipant()",id:"promoteparticipant",level:3},{value:"Parameters",id:"parameters-104",level:4},{value:"Returns",id:"returns-151",level:4},{value:"react()",id:"react",level:3},{value:"Parameters",id:"parameters-105",level:4},{value:"Returns",id:"returns-152",level:4},{value:"refresh()",id:"refresh",level:3},{value:"Returns",id:"returns-153",level:4},{value:"registerWebhook()",id:"registerwebhook",level:3},{value:"Parameters",id:"parameters-106",level:4},{value:"Returns",id:"returns-154",level:4},{value:"rejectGroupJoinRequest()",id:"rejectgroupjoinrequest",level:3},{value:"Parameters",id:"parameters-107",level:4},{value:"Returns",id:"returns-155",level:4},{value:"removeAllListeners()",id:"removealllisteners",level:3},{value:"Returns",id:"returns-156",level:4},{value:"removeLabel()",id:"removelabel",level:3},{value:"Parameters",id:"parameters-108",level:4},{value:"Returns",id:"returns-157",level:4},{value:"removeListener()",id:"removelistener",level:3},{value:"Parameters",id:"parameters-109",level:4},{value:"Returns",id:"returns-158",level:4},{value:"removeParticipant()",id:"removeparticipant",level:3},{value:"Parameters",id:"parameters-110",level:4},{value:"Returns",id:"returns-159",level:4},{value:"removeProduct()",id:"removeproduct",level:3},{value:"Parameters",id:"parameters-111",level:4},{value:"Returns",id:"returns-160",level:4},{value:"removeWebhook()",id:"removewebhook",level:3},{value:"Parameters",id:"parameters-112",level:4},{value:"Returns",id:"returns-161",level:4},{value:"Retruns",id:"retruns",level:4},{value:"reply()",id:"reply",level:3},{value:"Parameters",id:"parameters-113",level:4},{value:"Returns",id:"returns-162",level:4},{value:'reportSpam()
restricted
',id:"reportspam-restricted",level:3},{value:"Parameters",id:"parameters-114",level:4},{value:"Returns",id:"returns-163",level:4},{value:"resizePage()",id:"resizepage",level:3},{value:"Parameters",id:"parameters-115",level:4},{value:"Returns",id:"returns-164",level:4},{value:"revokeGroupInviteLink()",id:"revokegroupinvitelink",level:3},{value:"Parameters",id:"parameters-116",level:4},{value:"Returns",id:"returns-165",level:4},{value:"sendAdvancedButtons()",id:"sendadvancedbuttons",level:3},{value:"Parameters",id:"parameters-117",level:4},{value:"Returns",id:"returns-166",level:4},{value:"Deprecated",id:"deprecated-3",level:4},{value:"sendAudio()",id:"sendaudio",level:3},{value:"Parameters",id:"parameters-118",level:4},{value:"Returns",id:"returns-167",level:4},{value:"sendBanner()",id:"sendbanner",level:3},{value:"Parameters",id:"parameters-119",level:4},{value:"Returns",id:"returns-168",level:4},{value:"sendButtons()",id:"sendbuttons",level:3},{value:"Parameters",id:"parameters-120",level:4},{value:"Returns",id:"returns-169",level:4},{value:"Deprecated",id:"deprecated-4",level:4},{value:"sendContact()",id:"sendcontact",level:3},{value:"Parameters",id:"parameters-121",level:4},{value:"Returns",id:"returns-170",level:4},{value:"sendCustomProduct()",id:"sendcustomproduct",level:3},{value:"Parameters",id:"parameters-122",level:4},{value:"Returns",id:"returns-171",level:4},{value:"Deprecated",id:"deprecated-5",level:4},{value:"sendEmoji()",id:"sendemoji",level:3},{value:"Parameters",id:"parameters-123",level:4},{value:"Returns",id:"returns-172",level:4},{value:"sendFile()",id:"sendfile",level:3},{value:"Parameters",id:"parameters-124",level:4},{value:"Returns",id:"returns-173",level:4},{value:"sendFileFromUrl()",id:"sendfilefromurl",level:3},{value:"Parameters",id:"parameters-125",level:4},{value:"Returns",id:"returns-174",level:4},{value:"sendGiphy()",id:"sendgiphy",level:3},{value:"Parameters",id:"parameters-126",level:4},{value:"Returns",id:"returns-175",level:4},{value:"sendGiphyAsSticker()",id:"sendgiphyassticker",level:3},{value:"Parameters",id:"parameters-127",level:4},{value:"Returns",id:"returns-176",level:4},{value:"sendImage()",id:"sendimage",level:3},{value:"Parameters",id:"parameters-128",level:4},{value:"Returns",id:"returns-177",level:4},{value:"sendImageAsSticker()",id:"sendimageassticker",level:3},{value:"Parameters",id:"parameters-129",level:4},{value:"Returns",id:"returns-178",level:4},{value:'sendImageAsStickerAsReply()
insiders
',id:"sendimageasstickerasreply-insiders",level:3},{value:"Parameters",id:"parameters-130",level:4},{value:"Returns",id:"returns-179",level:4},{value:"sendImageWithProduct()",id:"sendimagewithproduct",level:3},{value:"Parameters",id:"parameters-131",level:4},{value:"Returns",id:"returns-180",level:4},{value:"sendLinkWithAutoPreview()",id:"sendlinkwithautopreview",level:3},{value:"Parameters",id:"parameters-132",level:4},{value:"Returns",id:"returns-181",level:4},{value:"sendListMessage()",id:"sendlistmessage",level:3},{value:"Parameters",id:"parameters-133",level:4},{value:"Returns",id:"returns-182",level:4},{value:"Deprecated",id:"deprecated-6",level:4},{value:"sendLocation()",id:"sendlocation",level:3},{value:"Parameters",id:"parameters-134",level:4},{value:"Returns",id:"returns-183",level:4},{value:"sendMessageWithThumb()",id:"sendmessagewiththumb",level:3},{value:"Parameters",id:"parameters-135",level:4},{value:"Returns",id:"returns-184",level:4},{value:"sendMp4AsSticker()",id:"sendmp4assticker",level:3},{value:"Parameters",id:"parameters-136",level:4},{value:"Returns",id:"returns-185",level:4},{value:'sendMultipleContacts()
insiders
',id:"sendmultiplecontacts-insiders",level:3},{value:"Parameters",id:"parameters-137",level:4},{value:"Returns",id:"returns-186",level:4},{value:"sendPaymentRequest()",id:"sendpaymentrequest",level:3},{value:"Parameters",id:"parameters-138",level:4},{value:"Returns",id:"returns-187",level:4},{value:"sendPoll()",id:"sendpoll",level:3},{value:"Parameters",id:"parameters-139",level:4},{value:"Returns",id:"returns-188",level:4},{value:'sendProduct()
insiders
',id:"sendproduct-insiders",level:3},{value:"Parameters",id:"parameters-140",level:4},{value:"Returns",id:"returns-189",level:4},{value:"sendPtt()",id:"sendptt",level:3},{value:"Parameters",id:"parameters-141",level:4},{value:"Returns",id:"returns-190",level:4},{value:"sendRawWebpAsSticker()",id:"sendrawwebpassticker",level:3},{value:"Parameters",id:"parameters-142",level:4},{value:"Returns",id:"returns-191",level:4},{value:'sendRawWebpAsStickerAsReply()
insiders
',id:"sendrawwebpasstickerasreply-insiders",level:3},{value:"Parameters",id:"parameters-143",level:4},{value:"Returns",id:"returns-192",level:4},{value:"sendReplyWithMentions()",id:"sendreplywithmentions",level:3},{value:"Parameters",id:"parameters-144",level:4},{value:"Returns",id:"returns-193",level:4},{value:"sendSeen()",id:"sendseen",level:3},{value:"Parameters",id:"parameters-145",level:4},{value:"Returns",id:"returns-194",level:4},{value:"sendStickerfromUrl()",id:"sendstickerfromurl",level:3},{value:"Parameters",id:"parameters-146",level:4},{value:"Returns",id:"returns-195",level:4},{value:'sendStickerfromUrlAsReply()
insiders
',id:"sendstickerfromurlasreply-insiders",level:3},{value:"Parameters",id:"parameters-147",level:4},{value:"Returns",id:"returns-196",level:4},{value:'sendText()
restricted
',id:"sendtext-restricted",level:3},{value:"Parameters",id:"parameters-148",level:4},{value:"Returns",id:"returns-197",level:4},{value:"sendTextWithMentions()",id:"sendtextwithmentions",level:3},{value:"Parameters",id:"parameters-149",level:4},{value:"Returns",id:"returns-198",level:4},{value:"sendVCard()",id:"sendvcard",level:3},{value:"Parameters",id:"parameters-150",level:4},{value:"Returns",id:"returns-199",level:4},{value:"sendVideoAsGif()",id:"sendvideoasgif",level:3},{value:"Parameters",id:"parameters-151",level:4},{value:"Returns",id:"returns-200",level:4},{value:"sendYoutubeLink()",id:"sendyoutubelink",level:3},{value:"Parameters",id:"parameters-152",level:4},{value:"Returns",id:"returns-201",level:4},{value:'setChatBackgroundColourHex()
insiders
',id:"setchatbackgroundcolourhex-insiders",level:3},{value:"Parameters",id:"parameters-153",level:4},{value:"Returns",id:"returns-202",level:4},{value:'setChatEphemeral()
insiders
',id:"setchatephemeral-insiders",level:3},{value:"Parameters",id:"parameters-154",level:4},{value:"Returns",id:"returns-203",level:4},{value:"setChatState()",id:"setchatstate",level:3},{value:"Parameters",id:"parameters-155",level:4},{value:"Returns",id:"returns-204",level:4},{value:"setGroupApprovalMode()",id:"setgroupapprovalmode",level:3},{value:"Parameters",id:"parameters-156",level:4},{value:"Returns",id:"returns-205",level:4},{value:"setGroupDescription()",id:"setgroupdescription",level:3},{value:"Parameters",id:"parameters-157",level:4},{value:"Returns",id:"returns-206",level:4},{value:"setGroupEditToAdminsOnly()",id:"setgroupedittoadminsonly",level:3},{value:"Parameters",id:"parameters-158",level:4},{value:"Returns",id:"returns-207",level:4},{value:"setGroupIcon()",id:"setgroupicon",level:3},{value:"Parameters",id:"parameters-159",level:4},{value:"Returns",id:"returns-208",level:4},{value:"setGroupIconByUrl()",id:"setgroupiconbyurl",level:3},{value:"Parameters",id:"parameters-160",level:4},{value:"Returns",id:"returns-209",level:4},{value:'setGroupTitle()
insiders
',id:"setgrouptitle-insiders",level:3},{value:"Parameters",id:"parameters-161",level:4},{value:"Returns",id:"returns-210",level:4},{value:"setGroupToAdminsOnly()",id:"setgrouptoadminsonly",level:3},{value:"Parameters",id:"parameters-162",level:4},{value:"Returns",id:"returns-211",level:4},{value:"setMyName()",id:"setmyname",level:3},{value:"Parameters",id:"parameters-163",level:4},{value:"Returns",id:"returns-212",level:4},{value:"setMyStatus()",id:"setmystatus",level:3},{value:"Parameters",id:"parameters-164",level:4},{value:"Returns",id:"returns-213",level:4},{value:"setPresence()",id:"setpresence",level:3},{value:"Parameters",id:"parameters-165",level:4},{value:"Returns",id:"returns-214",level:4},{value:"setProfilePic()",id:"setprofilepic",level:3},{value:"Parameters",id:"parameters-166",level:4},{value:"Returns",id:"returns-215",level:4},{value:"simulateRecording()",id:"simulaterecording",level:3},{value:"Parameters",id:"parameters-167",level:4},{value:"Returns",id:"returns-216",level:4},{value:"simulateTyping()",id:"simulatetyping",level:3},{value:"Parameters",id:"parameters-168",level:4},{value:"Returns",id:"returns-217",level:4},{value:"starMessage()",id:"starmessage",level:3},{value:"Parameters",id:"parameters-169",level:4},{value:"Returns",id:"returns-218",level:4},{value:"syncContacts()",id:"synccontacts",level:3},{value:"Returns",id:"returns-219",level:4},{value:'tagEveryone()
insiders
',id:"tageveryone-insiders",level:3},{value:"Parameters",id:"parameters-170",level:4},{value:"Returns",id:"returns-220",level:4},{value:"Mention",id:"mention",level:4},{value:"Default",id:"default",level:4},{value:"testButtons()",id:"testbuttons",level:3},{value:"Parameters",id:"parameters-171",level:4},{value:"Returns",id:"returns-221",level:4},{value:"Deprecated",id:"deprecated-7",level:4},{value:"testCallback()",id:"testcallback",level:3},{value:"Parameters",id:"parameters-172",level:4},{value:"Returns",id:"returns-222",level:4},{value:'unmuteChat()
insiders
',id:"unmutechat-insiders",level:3},{value:"Parameters",id:"parameters-173",level:4},{value:"Returns",id:"returns-223",level:4},{value:"unstarMessage()",id:"unstarmessage",level:3},{value:"Parameters",id:"parameters-174",level:4},{value:"Returns",id:"returns-224",level:4},{value:"updateWebhook()",id:"updatewebhook",level:3},{value:"Parameters",id:"parameters-175",level:4},{value:"Returns",id:"returns-225",level:4},{value:"waitAllQEmpty()",id:"waitallqempty",level:3},{value:"Returns",id:"returns-226",level:4},{value:"waitWhQIdle()",id:"waitwhqidle",level:3},{value:"Returns",id:"returns-227",level:4},{value:"Events",id:"events",level:2},{value:"onAck()",id:"onack-1",level:3},{value:"Parameters",id:"parameters-176",level:4},{value:"Returns",id:"returns-228",level:4},{value:"onAddedToGroup()",id:"onaddedtogroup-1",level:3},{value:"Parameters",id:"parameters-177",level:4},{value:"Returns",id:"returns-229",level:4},{value:"onAnyMessage()",id:"onanymessage-1",level:3},{value:"Parameters",id:"parameters-178",level:4},{value:"Returns",id:"returns-230",level:4},{value:"Fires",id:"fires",level:4},{value:"onBattery()",id:"onbattery-1",level:3},{value:"Parameters",id:"parameters-179",level:4},{value:"Returns",id:"returns-231",level:4},{value:"Deprecated",id:"deprecated-8",level:4},{value:"Fires",id:"fires-1",level:4},{value:"onBroadcast()",id:"onbroadcast-1",level:3},{value:"Parameters",id:"parameters-180",level:4},{value:"Returns",id:"returns-232",level:4},{value:"Fires",id:"fires-2",level:4},{value:"onButton()",id:"onbutton-1",level:3},{value:"Parameters",id:"parameters-181",level:4},{value:"Returns",id:"returns-233",level:4},{value:"Fires",id:"fires-3",level:4},{value:"onCallState()",id:"oncallstate-1",level:3},{value:"Parameters",id:"parameters-182",level:4},{value:"Returns",id:"returns-234",level:4},{value:"onChatDeleted()",id:"onchatdeleted-1",level:3},{value:"Parameters",id:"parameters-183",level:4},{value:"Returns",id:"returns-235",level:4},{value:"Fires",id:"fires-4",level:4},{value:'onChatOpened()
insiders
',id:"onchatopened-insiders",level:3},{value:"Parameters",id:"parameters-184",level:4},{value:"Returns",id:"returns-236",level:4},{value:'onChatState()
insiders
',id:"onchatstate-insiders",level:3},{value:"Parameters",id:"parameters-185",level:4},{value:"Returns",id:"returns-237",level:4},{value:"Fires",id:"fires-5",level:4},{value:'onContactAdded()
insiders
',id:"oncontactadded-insiders",level:3},{value:"Parameters",id:"parameters-186",level:4},{value:"Returns",id:"returns-238",level:4},{value:"onGlobalParticipantsChanged()",id:"onglobalparticipantschanged-1",level:3},{value:"Parameters",id:"parameters-187",level:4},{value:"Returns",id:"returns-239",level:4},{value:"onGroupApprovalRequest()",id:"ongroupapprovalrequest-1",level:3},{value:"Parameters",id:"parameters-188",level:4},{value:"Returns",id:"returns-240",level:4},{value:"onGroupChange()",id:"ongroupchange-1",level:3},{value:"Parameters",id:"parameters-189",level:4},{value:"Returns",id:"returns-241",level:4},{value:"onIncomingCall()",id:"onincomingcall-1",level:3},{value:"Parameters",id:"parameters-190",level:4},{value:"Returns",id:"returns-242",level:4},{value:"onLabel()",id:"onlabel-1",level:3},{value:"Parameters",id:"parameters-191",level:4},{value:"Returns",id:"returns-243",level:4},{value:"Fires",id:"fires-6",level:4},{value:"onLiveLocation()",id:"onlivelocation",level:3},{value:"Parameters",id:"parameters-192",level:4},{value:"Returns",id:"returns-244",level:4},{value:"Emits",id:"emits",level:4},{value:"onLogout()",id:"onlogout-1",level:3},{value:"Parameters",id:"parameters-193",level:4},{value:"Returns",id:"returns-245",level:4},{value:"Fires",id:"fires-7",level:4},{value:"onMessage()",id:"onmessage-1",level:3},{value:"Parameters",id:"parameters-194",level:4},{value:"Returns",id:"returns-246",level:4},{value:"Fires",id:"fires-8",level:4},{value:"onMessageDeleted()",id:"onmessagedeleted-1",level:3},{value:"Parameters",id:"parameters-195",level:4},{value:"Returns",id:"returns-247",level:4},{value:"Fires",id:"fires-9",level:4},{value:"onParticipantsChanged()",id:"onparticipantschanged",level:3},{value:"Parameters",id:"parameters-196",level:4},{value:"Returns",id:"returns-248",level:4},{value:"onPlugged()",id:"onplugged-1",level:3},{value:"Parameters",id:"parameters-197",level:4},{value:"Returns",id:"returns-249",level:4},{value:"Fires",id:"fires-10",level:4},{value:"onPollVote()",id:"onpollvote-1",level:3},{value:"Parameters",id:"parameters-198",level:4},{value:"Returns",id:"returns-250",level:4},{value:"Fires",id:"fires-11",level:4},{value:'onReaction()
insiders
',id:"onreaction-insiders",level:3},{value:"Parameters",id:"parameters-199",level:4},{value:"Returns",id:"returns-251",level:4},{value:"Fires",id:"fires-12",level:4},{value:'onRemovedFromGroup()
insiders
',id:"onremovedfromgroup-insiders",level:3},{value:"Parameters",id:"parameters-200",level:4},{value:"Returns",id:"returns-252",level:4},{value:"onStateChanged()",id:"onstatechanged-1",level:3},{value:"Parameters",id:"parameters-201",level:4},{value:"Returns",id:"returns-253",level:4},{value:"Fires",id:"fires-13",level:4},{value:'onStory()
restricted
',id:"onstory-restricted",level:3},{value:"Parameters",id:"parameters-202",level:4},{value:"Returns",id:"returns-254",level:4},{value:"Fires",id:"fires-14",level:4}];function o(e){const s={a:"a",admonition:"admonition",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"class-client",children:"Class: Client"})}),"\n",(0,r.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsxs)(s.h3,{id:"b-insiders",children:["B() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"B"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"payload"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.admonition,{type:"danger",children:(0,r.jsx)(s.p,{children:"Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA."})}),"\n",(0,r.jsx)(s.p,{children:"Use a raw payload within your open-wa session"}),"\n",(0,r.jsx)(s.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"payload"})]}),"\n",(0,r.jsx)(s.p,{children:"returns: MessageId"}),"\n",(0,r.jsx)(s.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"example",children:"Example"}),"\n",(0,r.jsx)(s.p,{children:"If there is a code block, then both TypeDoc and VSCode will treat\ntext outside of the code block as regular text."}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ts",children:"await B('44123456789@c.us', {\n test: 1\n})\n"})}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/Client/classes/Client#loadallearliermessages",children:"loadAllEarlierMessages"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"acceptgroupjoinrequest",children:"acceptGroupJoinRequest()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"acceptGroupJoinRequest"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Accepts a request from a recipient to join a group. Takes the message ID of the request message."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"addlabel",children:"addLabel()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"addLabel"}),"(",(0,r.jsx)(s.code,{children:"label"}),", ",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Adds label from chat, message or contact. Only for business accounts."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"label"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"addparticipant",children:"addParticipant()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"addParticipant"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"participantId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Add participant to Group"}),"\n",(0,r.jsxs)(s.p,{children:["If not a group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_GROUP_CHAT"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If the chat does not exist, returns ",(0,r.jsx)(s.code,{children:"GROUP_DOES_NOT_EXIST"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the participantId does not exist in the contacts, returns ",(0,r.jsx)(s.code,{children:"NOT_A_CONTACT"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the host account is not an administrator, returns ",(0,r.jsx)(s.code,{children:"INSUFFICIENT_PERMISSIONS"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"participantId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"approvegroupjoinrequest",children:"approveGroupJoinRequest()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"approveGroupJoinRequest"}),"(",(0,r.jsx)(s.code,{children:"groupChatId"}),", ",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Approves a group join request"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupChatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The group chat id"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The contact id of the person who is requesting to join the group"}),"\n",(0,r.jsx)(s.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"archivechat",children:"archiveChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"archiveChat"}),"(",(0,r.jsx)(s.code,{children:"id"}),", ",(0,r.jsx)(s.code,{children:"archive"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the conversation"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"archive"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean true => archive, false => unarchive"}),"\n",(0,r.jsx)(s.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true: worked, false: didnt work (probably already in desired state)"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"autoreject",children:"autoReject()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"autoReject"}),"(",(0,r.jsx)(s.code,{children:"message"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Automatically reject calls on the host account device. Please note that the device that is calling you will continue to ring."}),"\n",(0,r.jsx)(s.p,{children:"Update: Due to the nature of MD, the host account will continue ringing."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"optional message to send to the calling account when their call is detected and rejected"}),"\n",(0,r.jsx)(s.h4,{id:"returns-6",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"awaitmessages",children:"awaitMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"awaitMessages"}),"(",(0,r.jsx)(s.code,{children:"c"}),", ",(0,r.jsx)(s.code,{children:"filter"}),", ",(0,r.jsx)(s.code,{children:"options"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:(0,r.jsx)(s.code,{children:"Collection"})}),"<",(0,r.jsx)(s.code,{children:"string"}),", ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"[FROM DISCORDJS]\nSimilar to createMessageCollector but in promise form.\nResolves with a collection of messages that pass the specified filter."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"c"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})})]}),"\n",(0,r.jsx)(s.p,{children:"The Mesasge/Chat or Chat Id to base this message colletor on"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filter"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/type-aliases/CollectorFilter",children:(0,r.jsx)(s.code,{children:"CollectorFilter"})}),"<[",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"]>"]}),"\n",(0,r.jsx)(s.p,{children:"The filter function to use"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"options?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions",children:(0,r.jsx)(s.code,{children:"AwaitMessagesOptions"})})," = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsx)(s.p,{children:"Optional options to pass to the internal collector"}),"\n",(0,r.jsx)(s.h4,{id:"returns-7",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/classes/Collection",children:(0,r.jsx)(s.code,{children:"Collection"})}),"<",(0,r.jsx)(s.code,{children:"string"}),", ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">>"]}),"\n",(0,r.jsx)(s.h4,{id:"example-1",children:"Example"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"// Await !vote messages\nconst filter = m => m.body.startsWith('!vote');\n// Errors: ['time'] treats ending because of the time limit as an error\nchannel.awaitMessages(filter, { max: 4, time: 60000, errors: ['time'] })\n .then(collected => console.log(collected.size))\n .catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`));\n"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"checknumberstatus",children:"checkNumberStatus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"checkNumberStatus"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/NumberCheck",children:(0,r.jsx)(s.code,{children:"NumberCheck"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Checks if a number is a valid WA number"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-8",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/NumberCheck",children:(0,r.jsx)(s.code,{children:"NumberCheck"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"checkreadreceipts-insiders",children:["checkReadReceipts() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"checkReadReceipts"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Check if a recipient has read receipts on."}),"\n",(0,r.jsx)(s.p,{children:"This will only work if you have chats sent back and forth between you and the contact 1-1."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The Id of the contact with which you have an existing conversation with messages already."}),"\n",(0,r.jsx)(s.h4,{id:"returns-9",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," true or false or a string with an explaintaion of why it wasn't able to determine the read receipts."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"clearallchats",children:"clearAllChats()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"clearAllChats"}),"(",(0,r.jsx)(s.code,{children:"ts"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Clears all chats of all messages. This does not delete chats. Please be careful with this as it will remove all messages from whatsapp web and the host device. This feature is great for privacy focussed bots."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"ts?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"number A chat that has had a message after ts (epoch timestamp) will not be cleared."}),"\n",(0,r.jsx)(s.h4,{id:"returns-10",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"clearchat",children:"clearChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"clearChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Delete all messages from the chat."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-11",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-11",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"contactblock",children:"contactBlock()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"contactBlock"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Block contact"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-12",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-12",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"contactunblock",children:"contactUnblock()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"contactUnblock"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Unblock contact"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-13",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-13",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"createcommunity-insiders",children:["createCommunity() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"createCommunity"}),"(",(0,r.jsx)(s.code,{children:"communityName"}),", ",(0,r.jsx)(s.code,{children:"communitySubject"}),", ",(0,r.jsx)(s.code,{children:"icon"}),", ",(0,r.jsx)(s.code,{children:"existingGroups"}),", ",(0,r.jsx)(s.code,{children:"newGroups"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<`${number}@g.us`>"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Create a new community"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-14",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityName"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The community name"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communitySubject"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"icon"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsx)(s.p,{children:"DataURL of a 1:1 ratio jpeg for the community icon"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"existingGroups"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})}),"[] = ",(0,r.jsx)(s.code,{children:"[]"})]}),"\n",(0,r.jsx)(s.p,{children:"An array of existing group IDs, that are not already part of a community, to add to this new community."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"newGroups?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup",children:(0,r.jsx)(s.code,{children:"NewCommunityGroup"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"An array of new group objects that"}),"\n",(0,r.jsx)(s.h4,{id:"returns-14",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<`${number}@g.us`>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"creategroup",children:"createGroup()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"createGroup"}),"(",(0,r.jsx)(s.code,{children:"groupName"}),", ",(0,r.jsx)(s.code,{children:"contacts"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse",children:(0,r.jsx)(s.code,{children:"GroupChatCreationResponse"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Create a group and add contacts to it"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-15",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupName"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"group name: 'New group'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contacts"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-15",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse",children:(0,r.jsx)(s.code,{children:"GroupChatCreationResponse"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"createlabel-insiders",children:["createLabel() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"createLabel"}),"(",(0,r.jsx)(s.code,{children:"label"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Adds label from chat, message or contact. Only for business accounts."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-16",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"label"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-16",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"false"})," if something went wrong, or the id (usually a number as a string) of the new label (for example ",(0,r.jsx)(s.code,{children:'"58"'}),")"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"createmessagecollector",children:"createMessageCollector()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"createMessageCollector"}),"(",(0,r.jsx)(s.code,{children:"c"}),", ",(0,r.jsx)(s.code,{children:"filter"}),", ",(0,r.jsx)(s.code,{children:"options"}),"): ",(0,r.jsx)(s.a,{href:"/docs/reference/structures/MessageCollector/classes/MessageCollector",children:(0,r.jsx)(s.code,{children:"MessageCollector"})})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns a new message collector for the chat which is related to the first parameter c"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-17",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"c"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})})]}),"\n",(0,r.jsx)(s.p,{children:"The Mesasge/Chat or Chat Id to base this message colletor on"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filter"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/type-aliases/CollectorFilter",children:(0,r.jsx)(s.code,{children:"CollectorFilter"})}),"<[",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"]>"]}),"\n",(0,r.jsx)(s.p,{children:"A function that consumes a [Message] and returns a boolean which determines whether or not the message shall be collected."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"options"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/structures/Collector/interfaces/CollectorOptions",children:(0,r.jsx)(s.code,{children:"CollectorOptions"})})]}),"\n",(0,r.jsx)(s.p,{children:"The options for the collector. For example, how long the collector shall run for, how many messages it should collect, how long between messages before timing out, etc."}),"\n",(0,r.jsx)(s.h4,{id:"returns-17",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/docs/reference/structures/MessageCollector/classes/MessageCollector",children:(0,r.jsx)(s.code,{children:"MessageCollector"})})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"createnewproduct-insiders",children:["createNewProduct() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"createNewProduct"}),"(",(0,r.jsx)(s.code,{children:"name"}),", ",(0,r.jsx)(s.code,{children:"price"}),", ",(0,r.jsx)(s.code,{children:"currency"}),", ",(0,r.jsx)(s.code,{children:"images"}),", ",(0,r.jsx)(s.code,{children:"description"}),", ",(0,r.jsx)(s.code,{children:"url"}),"?, ",(0,r.jsx)(s.code,{children:"internalId"}),"?, ",(0,r.jsx)(s.code,{children:"isHidden"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:(0,r.jsx)(s.code,{children:"Product"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Add a product to your catalog"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-18",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"name"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The name of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"price"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"The price of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"currency"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The 3-letter currenct code for the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"images"}),": ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"An array of dataurl or base64 strings of product images, the first image will be used as the main image. At least one image is required."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"description"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"optional, the description of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The url of the product for more information"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"internalId?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The internal/backoffice id of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"isHidden?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Whether or not the product is shown publicly in your catalog"}),"\n",(0,r.jsx)(s.h4,{id:"returns-18",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:(0,r.jsx)(s.code,{children:"Product"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"product object"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"cutchatcache",children:"cutChatCache()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"cutChatCache"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["This simple function halves the amount of chats in your session message cache. This does not delete messages off your phone. If over a day you've processed 4000 messages this will possibly result in 4000 messages being present in your session.\nCalling this method will cut the message cache as much as possible, reducing the memory usage of your process.\nYou should use this in conjunction with ",(0,r.jsx)(s.code,{children:"getAmountOfLoadedMessages"})," to intelligently control the session message cache."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-19",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n",(0,r.jsx)(s.h5,{id:"after",children:"after"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"after"}),": ",(0,r.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"afterchats",children:"after.chats"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"chats"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"aftermsgs",children:"after.msgs"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"msgs"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"before",children:"before"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"before"}),": ",(0,r.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"beforechats",children:"before.chats"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"chats"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"beforemsgs",children:"before.msgs"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"msgs"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"cutmsgcache",children:"cutMsgCache()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"cutMsgCache"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["This simple function halves the amount of messages in your session message cache. This does not delete messages off your phone. If over a day you've processed 4000 messages this will possibly result in 4000 messages being present in your session.\nCalling this method will cut the message cache to 2000 messages, therefore reducing the memory usage of your process.\nYou should use this in conjunction with ",(0,r.jsx)(s.code,{children:"getAmountOfLoadedMessages"})," to intelligently control the session message cache."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-20",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"darkmode",children:"darkMode()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"darkMode"}),"(",(0,r.jsx)(s.code,{children:"activate"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Start dark mode [NOW GENERALLY AVAILABLE]"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-19",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"activate"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"true to activate dark mode, false to deactivate"}),"\n",(0,r.jsx)(s.h4,{id:"returns-21",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"decryptmedia",children:"decryptMedia()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"decryptMedia"}),"(",(0,r.jsx)(s.code,{children:"message"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Decrypts a media message."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-20",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})})]}),"\n",(0,r.jsx)(s.p,{children:"This can be the serialized [[MessageId]] or the whole [[Message]] object. It is advised to just use the serialized message ID."}),"\n",(0,r.jsx)(s.h4,{id:"returns-22",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise<[[DataURL]]>"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"deleteallstatus",children:"deleteAllStatus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteAllStatus"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Alias for deleteStory"}),"\n",(0,r.jsx)(s.h4,{id:"returns-23",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"deleteallstories-restricted",children:["deleteAllStories() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteAllStories"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Deletes all your existing stories."}),"\n",(0,r.jsx)(s.h4,{id:"returns-24",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean. True if it worked."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"deletechat",children:"deleteChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Delete the conversation from your WA"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-21",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-25",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"deletemessage",children:"deleteMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteMessage"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"onlyLocal"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Deletes message of given message id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-22",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The chat id from which to delete the message."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"The specific message id of the message to be deleted"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"onlyLocal"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.p,{children:"If it should only delete locally (message remains on the other recipienct's phone). Defaults to false."}),"\n",(0,r.jsx)(s.h4,{id:"returns-26",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"nothing"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"deletestalechats",children:"deleteStaleChats()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteStaleChats"}),"(",(0,r.jsx)(s.code,{children:"startingFrom"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Deletes chats from a certain index (default 1000). E.g if this startingFrom param is ",(0,r.jsx)(s.code,{children:"100"})," then all chats from index ",(0,r.jsx)(s.code,{children:"100"})," onwards will be deleted."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-23",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"startingFrom?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsxs)(s.p,{children:["the chat index to start from. Please do not set this to anything less than 10 @default: ",(0,r.jsx)(s.code,{children:"1000"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-27",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"deletestatus",children:"deleteStatus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteStatus"}),"(",(0,r.jsx)(s.code,{children:"statusesToDelete"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Alias for deleteStory"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-24",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"statusesToDelete"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-28",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"deletestory-restricted",children:["deleteStory() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"deleteStory"}),"(",(0,r.jsx)(s.code,{children:"statusesToDelete"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Consumes a list of id strings of stories to delete."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-25",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"statusesToDelete"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"string [] | string an array of ids of stories to delete."}),"\n",(0,r.jsx)(s.h4,{id:"returns-29",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean. True if it worked."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"demoteparticipant",children:"demoteParticipant()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"demoteParticipant"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"participantId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Demote Admin of Group"}),"\n",(0,r.jsxs)(s.p,{children:["If not a group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_GROUP_CHAT"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If the chat does not exist, returns ",(0,r.jsx)(s.code,{children:"GROUP_DOES_NOT_EXIST"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the participantId does not exist in the group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_PARTICIPANT"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the host account is not an administrator, returns ",(0,r.jsx)(s.code,{children:"INSUFFICIENT_PERMISSIONS"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-26",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"participantId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-30",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"download",children:"download()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"download"}),"(",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"optionsOverride"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"A convinience method to download the [[DataURL]] of a file"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-27",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The url"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"optionsOverride"}),": ",(0,r.jsx)(s.code,{children:"any"})," = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:["You can use this to override the ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"axios request config"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-31",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"downloadfilewithcredentials",children:"downloadFileWithCredentials()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"downloadFileWithCredentials"}),"(",(0,r.jsx)(s.code,{children:"url"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Download via the browsers authenticated session via URL."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-28",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-32",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"base64 string (non-data url)"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"downloadprofilepicfrommessage",children:"downloadProfilePicFromMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"downloadProfilePicFromMessage"}),"(",(0,r.jsx)(s.code,{children:"message"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Download profile pics from the message object."}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:" const filename = `profilepic_${message.from}.jpeg`;\n const data = await client.downloadProfilePicFromMessage(message);\n const dataUri = `data:image/jpeg;base64,${data}`;\n fs.writeFile(filename, mData, 'base64', function(err) {\n if (err) {\n return console.log(err);\n }\n console.log('The file was saved!');\n });\n"})}),"\n",(0,r.jsx)(s.h4,{id:"parameters-29",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-33",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"editmessage",children:"editMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"editMessage"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"text"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"NOTE: This is experimental, most accounts do not have access to this feature in their apps."}),"\n",(0,r.jsx)(s.p,{children:"Edit an existing message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-30",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The message ID to edit"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The new text content"}),"\n",(0,r.jsx)(s.h4,{id:"returns-34",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"editproduct-insiders",children:["editProduct() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"editProduct"}),"(",(0,r.jsx)(s.code,{children:"productId"}),", ",(0,r.jsx)(s.code,{children:"name"}),"?, ",(0,r.jsx)(s.code,{children:"price"}),"?, ",(0,r.jsx)(s.code,{children:"currency"}),"?, ",(0,r.jsx)(s.code,{children:"images"}),"?, ",(0,r.jsx)(s.code,{children:"description"}),"?, ",(0,r.jsx)(s.code,{children:"url"}),"?, ",(0,r.jsx)(s.code,{children:"internalId"}),"?, ",(0,r.jsx)(s.code,{children:"isHidden"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:(0,r.jsx)(s.code,{children:"Product"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Edit a product in your catalog"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-31",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"productId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The catalog ID of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"name?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The name of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"price?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"The price of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"currency?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The 3-letter currenct code for the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"images?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"An array of dataurl or base64 strings of product images, the first image will be used as the main image. At least one image is required."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"description?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"optional, the description of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The url of the product for more information"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"internalId?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The internal/backoffice id of the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"isHidden?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Whether or not the product is shown publicly in your catalog"}),"\n",(0,r.jsx)(s.h4,{id:"returns-35",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:(0,r.jsx)(s.code,{children:"Product"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"product object"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"emitunreadmessages",children:"emitUnreadMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"emitUnreadMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Fires all unread messages to the onMessage listener.\nMake sure to call this AFTER setting your listeners."}),"\n",(0,r.jsx)(s.h4,{id:"returns-36",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of message IDs"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"forcerefocus",children:"forceRefocus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"forceRefocus"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["This is a convinient method to click the ",(0,r.jsx)(s.code,{children:"Use Here"})," button in the WA web session."]}),"\n",(0,r.jsxs)(s.p,{children:["Use this when [[STATE]] is ",(0,r.jsx)(s.code,{children:"CONFLICT"}),". You can read more about managing state here:"]}),"\n",(0,r.jsx)(s.p,{children:"[[Detecting Logouts]]"}),"\n",(0,r.jsx)(s.h4,{id:"returns-37",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"forcestalemediaupdate-insiders",children:["forceStaleMediaUpdate() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"forceStaleMediaUpdate"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"If a file is old enough, it will 404 if you try to decrypt it. This will allow you to force the host account to re upload the file and return a decryptable message."}),"\n",(0,r.jsx)(s.p,{children:"if you run this without a valid insiders key, it will return false and cause an error upon decryption."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-32",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-38",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["[[Message]] OR ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"forceupdateconnectionstate",children:"forceUpdateConnectionState()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"forceUpdateConnectionState"}),"(",(0,r.jsx)(s.code,{children:"killBeforeReconnect"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/enumerations/STATE",children:(0,r.jsx)(s.code,{children:"STATE"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Forces the session to update the connection state."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-33",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"killBeforeReconnect?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-39",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/enumerations/STATE",children:(0,r.jsx)(s.code,{children:"STATE"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"updated connection state"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"forceupdatelivelocation",children:"forceUpdateLiveLocation()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"forceUpdateLiveLocation"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent",children:(0,r.jsx)(s.code,{children:"LiveLocationChangedEvent"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"A list of participants in the chat who have their live location on. If the chat does not exist, or the chat does not have any contacts actively sharing their live locations, it will return false. If it's a chat with a single contact, there will be only 1 value in the array if the contact has their livelocation on.\nPlease note. This should only be called once every 30 or so seconds. This forces the phone to grab the latest live location data for the number. This can be used in conjunction with onLiveLocation (this will trigger onLiveLocation)."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-34",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"string Id of the chat you want to force the phone to get the livelocation data for."}),"\n",(0,r.jsx)(s.h4,{id:"returns-40",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent",children:(0,r.jsx)(s.code,{children:"LiveLocationChangedEvent"})}),"[]>"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," | boolean"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"forwardmessages",children:"forwardMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"forwardMessages"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"messages"}),", ",(0,r.jsx)(s.code,{children:"skipMyMessages"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Forward an array of messages to a specific chat using the message ids or Objects"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-35",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messages"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"this can be any mixture of message ids or message objects"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"skipMyMessages"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"This indicates whether or not to skip your own messages from the array"}),"\n",(0,r.jsx)(s.h4,{id:"returns-41",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"gc",children:"gc()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"gc"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"It calls the JavaScript garbage collector"}),"\n",(0,r.jsx)(s.h4,{id:"returns-42",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Nothing."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallchatids",children:"getAllChatIds()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllChatIds"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"retrieves all Chat Ids"}),"\n",(0,r.jsx)(s.h4,{id:"returns-43",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of [ChatId]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallchats",children:"getAllChats()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllChats"}),"(",(0,r.jsx)(s.code,{children:"withNewMessageOnly"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all chats"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-36",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withNewMessageOnly"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-44",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of [Chat]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallchatswithmessages",children:(0,r.jsx)(s.del,{children:"getAllChatsWithMessages()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllChatsWithMessages"}),"(",(0,r.jsx)(s.code,{children:"withNewMessageOnly"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-37",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withNewMessageOnly"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-45",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of [Chat]"}),"\n",(0,r.jsx)(s.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all chats with messages"}),"\n",(0,r.jsxs)(s.p,{children:["Please use ",(0,r.jsx)(s.code,{children:"getAllUnreadMessages"})," instead of this to see all messages indicated by the green dots in the chat."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallcommunities",children:"getAllCommunities()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllCommunities"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<`${number}@g.us`[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieve all commmunity Ids"}),"\n",(0,r.jsx)(s.h4,{id:"returns-46",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<`${number}@g.us`[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of group ids"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallcontacts",children:"getAllContacts()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllContacts"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all contacts"}),"\n",(0,r.jsx)(s.h4,{id:"returns-47",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of [Contact]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallgroups",children:"getAllGroups()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllGroups"}),"(",(0,r.jsx)(s.code,{children:"withNewMessagesOnly"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieve all groups"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-38",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withNewMessagesOnly"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-48",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"array of groups"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getalllabels",children:"getAllLabels()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllLabels"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/label/interfaces/Label",children:(0,r.jsx)(s.code,{children:"Label"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns all labels and the corresponding tagged items."}),"\n",(0,r.jsx)(s.h4,{id:"returns-49",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/label/interfaces/Label",children:(0,r.jsx)(s.code,{children:"Label"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallmessagesinchat",children:"getAllMessagesInChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllMessagesInChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"includeMe"}),", ",(0,r.jsx)(s.code,{children:"includeNotifications"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all Messages in a chat that have been loaded within the WA web instance."}),"\n",(0,r.jsx)(s.p,{children:"This does not load every single message in the chat history."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-39",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeMe"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeNotifications"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-50",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"Message[]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallnewmessages",children:"getAllNewMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllNewMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all new Messages. where isNewMsg==true"}),"\n",(0,r.jsx)(s.h4,{id:"returns-51",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"list of messages"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getallunreadmessages",children:"getAllUnreadMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAllUnreadMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all unread Messages. where ack==-1"}),"\n",(0,r.jsx)(s.h4,{id:"returns-52",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"list of messages"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getamountofloadedmessages",children:"getAmountOfLoadedMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getAmountOfLoadedMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Easily get the amount of messages loaded up in the session. This will allow you to determine when to clear chats/cache."}),"\n",(0,r.jsx)(s.h4,{id:"returns-53",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getbatterylevel",children:(0,r.jsx)(s.del,{children:"getBatteryLevel()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getBatteryLevel"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-54",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Number"}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-1",children:"Deprecated"}),"\n",(0,r.jsx)(s.p,{children:"No longer works due to multi-device changes\nRetrieves Battery Level"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getblockedids",children:"getBlockedIds()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getBlockedIds"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"retrieves an array of IDs of accounts blocked by the host account."}),"\n",(0,r.jsx)(s.h4,{id:"returns-55",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getbusinessprofile",children:"getBusinessProfile()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getBusinessProfile"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessProfile",children:(0,r.jsx)(s.code,{children:"BusinessProfile"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the business info of a given contact id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-40",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"id of business profile (i.e the number with @c.us)"}),"\n",(0,r.jsx)(s.h4,{id:"returns-56",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessProfile",children:(0,r.jsx)(s.code,{children:"BusinessProfile"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"None"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getbusinessprofilesproducts",children:"getBusinessProfilesProducts()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getBusinessProfilesProducts"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Find any product listings of the given number. Use this to query a catalog"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-41",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"id of business profile (i.e the number with @c.us)"}),"\n",(0,r.jsx)(s.h4,{id:"returns-57",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"None"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getchat",children:"getChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getChat"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves chat object of given contact id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-42",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-58",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"contact detial as promise"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getchatbyid",children:"getChatById()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getChatById"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves chat object of given contact id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-43",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-59",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"contact detial as promise"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getchatwithnoncontacts",children:"getChatWithNonContacts()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getChatWithNonContacts"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns a list of contact with whom the host number has an existing chat who are also not contacts."}),"\n",(0,r.jsx)(s.h4,{id:"returns-60",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getchatsbylabel",children:"getChatsByLabel()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getChatsByLabel"}),"(",(0,r.jsx)(s.code,{children:"label"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:'Get an array of chats that match the label parameter. For example, if you want to get an array of chat objects that have the label "New customer".'}),"\n",(0,r.jsx)(s.p,{children:"This method is case insenstive and only works on business host accounts."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-44",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"label"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-61",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),"[]>"]}),"\n",(0,r.jsx)(s.h4,{id:"label",children:"Label"}),"\n",(0,r.jsx)(s.p,{children:"The label name"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"getcommongroups-insiders",children:["getCommonGroups() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommonGroups"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Retrieves the groups that you have in common with a contact"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-45",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-62",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcommunityadminids",children:"getCommunityAdminIds()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommunityAdminIds"}),"(",(0,r.jsx)(s.code,{children:"communityId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves community admin Ids"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-46",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"community id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-63",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcommunityadmins",children:"getCommunityAdmins()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommunityAdmins"}),"(",(0,r.jsx)(s.code,{children:"communityId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves community admins as Contact objects"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-47",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"community id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-64",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcommunityinfo",children:"getCommunityInfo()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommunityInfo"}),"(",(0,r.jsx)(s.code,{children:"communityId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",children:(0,r.jsx)(s.code,{children:"GroupMetadata"})})," & ",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Returns the community metadata. Like group metadata but with a ",(0,r.jsx)(s.code,{children:"subGroups"})," property which is the group metadata of the community subgroups."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-48",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"community id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-65",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",children:(0,r.jsx)(s.code,{children:"GroupMetadata"})})," & ",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcommunityparticipantids",children:"getCommunityParticipantIds()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommunityParticipantIds"}),"(",(0,r.jsx)(s.code,{children:"communityId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves community members Ids"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-49",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"community id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-66",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcommunityparticipants",children:"getCommunityParticipants()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getCommunityParticipants"}),"(",(0,r.jsx)(s.code,{children:"communityId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves community members as Contact objects"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-50",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"communityId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"community id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-67",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getconfig",children:"getConfig()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getConfig"}),"(): ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/ConfigObject",children:(0,r.jsx)(s.code,{children:"ConfigObject"})})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the config which was used to set up the client. Sensitive details (like devTools username and password, and browserWSEndpoint) are scrubbed"}),"\n",(0,r.jsx)(s.h4,{id:"returns-68",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/ConfigObject",children:(0,r.jsx)(s.code,{children:"ConfigObject"})})}),"\n",(0,r.jsx)(s.p,{children:"SessionInfo"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getconnectionstate",children:"getConnectionState()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getConnectionState"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/enumerations/STATE",children:(0,r.jsx)(s.code,{children:"STATE"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns the connection state"}),"\n",(0,r.jsx)(s.h4,{id:"returns-69",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/enumerations/STATE",children:(0,r.jsx)(s.code,{children:"STATE"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getcontact",children:"getContact()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getContact"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves contact detail object of given contact id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-51",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-70",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"contact detial as promise"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"geteventsignature",children:"getEventSignature()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getEventSignature"}),"(",(0,r.jsx)(s.code,{children:"simpleListener"}),"?): ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-52",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"simpleListener?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-71",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"string"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getfeatures",children:"getFeatures()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getFeatures"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns an object with properties of internal features and boolean values that represent if the respective feature is enabled or not."}),"\n",(0,r.jsx)(s.h4,{id:"returns-72",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgenerateduseragent",children:"getGeneratedUserAgent()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGeneratedUserAgent"}),"(",(0,r.jsx)(s.code,{children:"userA"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the generated user agent, this is so you can send it to the decryption module."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-53",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"userA?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-73",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"String useragent of wa-web session"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgptarray",children:"getGptArray()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGptArray"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"last"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns a properly formatted array of messages from to send to the openai api"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-54",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"last"}),": ",(0,r.jsx)(s.code,{children:"number"})," = ",(0,r.jsx)(s.code,{children:"10"})]}),"\n",(0,r.jsx)(s.p,{children:"The amount of previous messages to retrieve. Defaults to 10"}),"\n",(0,r.jsx)(s.h4,{id:"returns-74",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupadmins",children:"getGroupAdmins()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupAdmins"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get Admins of a Group"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-55",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-75",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupapprovalrequests",children:"getGroupApprovalRequests()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupApprovalRequests"}),"(",(0,r.jsx)(s.code,{children:"groupChatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Gets the contact IDs of members requesting approval to join the group"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-56",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupChatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-76",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupinfo",children:"getGroupInfo()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupInfo"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns the title and description of a given group id."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-57",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"group id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-77",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupinvitelink",children:"getGroupInviteLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupInviteLink"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves an invite link for a group chat. returns false if chat is not a group."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-58",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-78",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupmembers",children:"getGroupMembers()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupMembers"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns group members [Contact] objects"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-59",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-79",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getgroupmembersid",children:"getGroupMembersId()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getGroupMembersId"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves group members as [Id] objects"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-60",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"group id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-80",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"gethostnumber",children:"getHostNumber()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getHostNumber"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves the host device number. Use this number when registering for a license key"}),"\n",(0,r.jsx)(s.h4,{id:"returns-81",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Number"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getindicatednewmessages",children:"getIndicatedNewMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getIndicatedNewMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all unread Messages as indicated by the red dots in WA web. This returns an array of objects and are structured like so:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:'[{\n"id": "000000000000@g.us", //the id of the chat\n"indicatedNewMessages": [] //array of messages, not including any messages by the host phone\n}]\n'})}),"\n",(0,r.jsx)(s.h4,{id:"returns-82",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"list of messages"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getinstanceid",children:"getInstanceId()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getInstanceId"}),"(): ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the INSTANCE_ID of the current session"}),"\n",(0,r.jsx)(s.h4,{id:"returns-83",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"string"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getisplugged",children:"getIsPlugged()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getIsPlugged"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves whether or not phone is plugged in (i.e on charge)"}),"\n",(0,r.jsx)(s.h4,{id:"returns-84",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Number"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getissuelink",children:"getIssueLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getIssueLink"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Generate a pre-filled github issue link to easily report a bug"}),"\n",(0,r.jsx)(s.h4,{id:"returns-85",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getkickedgroups",children:"getKickedGroups()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getKickedGroups"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns an array of group ids where the host account has been kicked"}),"\n",(0,r.jsx)(s.h4,{id:"returns-86",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getlastmsgtimestamps",children:"getLastMsgTimestamps()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getLastMsgTimestamps"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get an array of chatIds with their respective last message's timestamp."}),"\n",(0,r.jsx)(s.p,{children:"This is useful for determining what chats are old/stale and need to be deleted."}),"\n",(0,r.jsx)(s.h4,{id:"returns-87",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getlastseen",children:"getLastSeen()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getLastSeen"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves the epoch timestamp of the time the contact was last seen. This will not work if:"}),"\n",(0,r.jsxs)(s.ol,{children:["\n",(0,r.jsx)(s.li,{children:"They have set it so you cannot see their last seen via privacy settings."}),"\n",(0,r.jsx)(s.li,{children:"You do not have an existing chat with the contact."}),"\n",(0,r.jsx)(s.li,{children:"The chatId is for a group\nIn both of those instances this method will return undefined."}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-61",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the chat."}),"\n",(0,r.jsx)(s.h4,{id:"returns-88",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"number timestamp when chat was last online or undefined."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getlicenselink",children:"getLicenseLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getLicenseLink"}),"(",(0,r.jsx)(s.code,{children:"params"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Generate a license link"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-62",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"params?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-89",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getlicensetype",children:"getLicenseType()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getLicenseType"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/enumerations/LicenseType",children:(0,r.jsx)(s.code,{children:"LicenseType"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns the the type of license key used by the session."}),"\n",(0,r.jsx)(s.h4,{id:"returns-90",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/enumerations/LicenseType",children:(0,r.jsx)(s.code,{children:"LicenseType"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getlistenerqueues",children:"getListenerQueues()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getListenerQueues"}),"(): ",(0,r.jsx)(s.code,{children:"object"})]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["If you have set ",(0,r.jsx)(s.code,{children:"onAnyMessage"})," or ",(0,r.jsx)(s.code,{children:"onMessage"})," with the second parameter (PQueue options) then you may want to inspect their respective PQueue's."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-91",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"object"})}),"\n",(0,r.jsx)(s.h5,{id:"onack",children:"onAck"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAck"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onaddedtogroup",children:"onAddedToGroup"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAddedToGroup"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onanymessage",children:"onAnyMessage"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAnyMessage"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onbattery",children:"onBattery"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onBattery"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onbroadcast",children:"onBroadcast"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onBroadcast"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onbutton",children:"onButton"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onButton"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"oncallstate",children:"onCallState"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onCallState"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onchatdeleted",children:"onChatDeleted"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatDeleted"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onchatopened",children:"onChatOpened"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatOpened"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onchatstate",children:"onChatState"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatState"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"oncontactadded",children:"onContactAdded"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onContactAdded"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onglobalparticipantschanged",children:"onGlobalParticipantsChanged"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGlobalParticipantsChanged"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"ongroupapprovalrequest",children:"onGroupApprovalRequest"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGroupApprovalRequest"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"ongroupchange",children:"onGroupChange"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGroupChange"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onincomingcall",children:"onIncomingCall"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onIncomingCall"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onlabel",children:"onLabel"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onLabel"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onlogout",children:"onLogout"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onLogout"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onmessage",children:"onMessage"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onMessage"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onmessagedeleted",children:"onMessageDeleted"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onMessageDeleted"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onnewproduct",children:"onNewProduct"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onNewProduct"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onorder",children:"onOrder"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onOrder"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onplugged",children:"onPlugged"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onPlugged"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onpollvote",children:"onPollVote"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onPollVote"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onreaction",children:"onReaction"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onReaction"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onremovedfromgroup",children:"onRemovedFromGroup"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onRemovedFromGroup"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onstatechanged",children:"onStateChanged"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onStateChanged"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"onstory",children:"onStory"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onStory"}),": ",(0,r.jsx)(s.code,{children:"PQueue"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getme",children:"getMe()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMe"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns an object with all of your host device details"}),"\n",(0,r.jsx)(s.h4,{id:"returns-92",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getmessagebyid",children:"getMessageById()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMessageById"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves message object of given message id"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-63",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-93",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"message object"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"getmessageinfo-insiders",children:["getMessageInfo() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMessageInfo"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfo",children:(0,r.jsx)(s.code,{children:"MessageInfo"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Get the detailed message info for a group message sent out by the host account."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-64",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The message Id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-94",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfo",children:(0,r.jsx)(s.code,{children:"MessageInfo"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getmessagereaders",children:"getMessageReaders()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMessageReaders"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Returns an array of contacts that have read the message. If the message does not exist, it will return an empty array. If the host account has disabled read receipts this may not work!\nEach of these contact objects have a property ",(0,r.jsx)(s.code,{children:"t"})," which represents the time at which that contact read the message."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-65",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The message id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-95",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:(0,r.jsx)(s.code,{children:"Contact"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getmylastmessage",children:"getMyLastMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMyLastMessage"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves the last message sent by the host account in any given chat or globally."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-66",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"This is optional. If no chat Id is set then the last message sent by the host account will be returned."}),"\n",(0,r.jsx)(s.h4,{id:"returns-96",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["message object or ",(0,r.jsx)(s.code,{children:"undefined"})," if the host account's last message could not be found."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getmystatusarray",children:"getMyStatusArray()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMyStatusArray"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Alias for deleteStory"}),"\n",(0,r.jsx)(s.h4,{id:"returns-97",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"getmystoryarray-restricted",children:["getMyStoryArray() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getMyStoryArray"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all existing stories."}),"\n",(0,r.jsx)(s.p,{children:"Only works with a Story License Key"}),"\n",(0,r.jsx)(s.h4,{id:"returns-98",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"getorder-insiders",children:["getOrder() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getOrder"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Order",children:(0,r.jsx)(s.code,{children:"Order"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Retrieves an order object"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-67",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-99",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/Order",children:(0,r.jsx)(s.code,{children:"Order"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"order object"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getpage",children:"getPage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getPage"}),"(): ",(0,r.jsx)(s.code,{children:"Page"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-100",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Page"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getpolldata",children:"getPollData()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getPollData"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollData",children:(0,r.jsx)(s.code,{children:"PollData"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns poll data including results and votes."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-68",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The message id of the Poll"}),"\n",(0,r.jsx)(s.h4,{id:"returns-101",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollData",children:(0,r.jsx)(s.code,{children:"PollData"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getprocessstats",children:"getProcessStats()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getProcessStats"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the stats of the current process and the corresponding browser process."}),"\n",(0,r.jsx)(s.h4,{id:"returns-102",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getprofilepicfromserver",children:"getProfilePicFromServer()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getProfilePicFromServer"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves chat picture"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-69",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-103",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Url of the chat picture or undefined if there is no picture for the chat."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getsessionid",children:"getSessionId()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getSessionId"}),"(): ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-104",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"string"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getsessioninfo",children:"getSessionInfo()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getSessionInfo"}),"(): ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo",children:(0,r.jsx)(s.code,{children:"SessionInfo"})})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the session info"}),"\n",(0,r.jsx)(s.h4,{id:"returns-105",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo",children:(0,r.jsx)(s.code,{children:"SessionInfo"})})}),"\n",(0,r.jsx)(s.p,{children:"SessionInfo"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getsingleproperty",children:"getSingleProperty()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getSingleProperty"}),"(",(0,r.jsx)(s.code,{children:"namespace"}),", ",(0,r.jsx)(s.code,{children:"id"}),", ",(0,r.jsx)(s.code,{children:"property"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"This allows you to get a single property of a single object from the session. This limints the amouunt of data you need to sift through, reduces congestion between your process and the session and the flexibility to build your own specific getters."}),"\n",(0,r.jsx)(s.p,{children:"Example - get message read state (ack):"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"const ack = await client.getSingleProperty('Msg',\"true_12345678912@c.us_9C4D0965EA5C09D591334AB6BDB07FEB\",'ack')\n"})}),"\n",(0,r.jsx)(s.h4,{id:"parameters-70",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"namespace"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/Client/enumerations/namespace",children:(0,r.jsx)(s.code,{children:"namespace"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"id of the object to get from the specific namespace"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"property"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"the single property key to get from the object."}),"\n",(0,r.jsx)(s.h4,{id:"returns-106",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"any If the property or the id cannot be found, it will return a 404"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getsnapshot",children:"getSnapshot()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getSnapshot"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"?, ",(0,r.jsx)(s.code,{children:"width"}),"?, ",(0,r.jsx)(s.code,{children:"height"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns a PNG DataURL screenshot of the session"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-71",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"Chat ID to open before taking a snapshot"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"width?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"Width of the viewport for the snapshot. Height also required if you want to resize."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"height?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"Height of the viewport for the snapshot. Width also required if you want to resize."}),"\n",(0,r.jsx)(s.h4,{id:"returns-107",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getstarredmessages",children:"getStarredMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getStarredMessages"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves the starred messages in a given chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-72",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"Chat ID to filter starred messages by"}),"\n",(0,r.jsx)(s.h4,{id:"returns-108",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"message object"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getstatus",children:"getStatus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getStatus"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the status of a contact"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-73",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["to '",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-109",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n",(0,r.jsx)(s.h5,{id:"id",children:"id"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.h5,{id:"status",children:"status"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"status"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getstickerdecryptable",children:(0,r.jsx)(s.del,{children:"getStickerDecryptable()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getStickerDecryptable"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-74",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["The message ID ",(0,r.jsx)(s.code,{children:"message.id"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-110",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["message object OR ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-2",children:"Deprecated"}),"\n",(0,r.jsx)(s.p,{children:"Retrieves a message object which results in a valid sticker instead of a blank one. This also works with animated stickers."}),"\n",(0,r.jsx)(s.p,{children:"If you run this without a valid insiders key, it will return false and cause an error upon decryption."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"getstoryviewers-restricted",children:["getStoryViewers() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getStoryViewers"}),"(",(0,r.jsx)(s.code,{children:"id"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[] | ",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Retrieves an array of user ids that have 'read' your story."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-75",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string The id of the story"}),"\n",(0,r.jsx)(s.h4,{id:"returns-111",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[] | ",(0,r.jsx)(s.code,{children:"object"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"gettunnelcode",children:"getTunnelCode()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getTunnelCode"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"The EASY API uses this string to secure a subdomain on the openwa public tunnel service."}),"\n",(0,r.jsx)(s.h4,{id:"returns-112",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getunreadmessages",children:"getUnreadMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getUnreadMessages"}),"(",(0,r.jsx)(s.code,{children:"includeMe"}),", ",(0,r.jsx)(s.code,{children:"includeNotifications"}),", ",(0,r.jsx)(s.code,{children:"use_unread_count"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})})," & ",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves all unread Messages"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-76",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeMe"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeNotifications"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"use_unread_count"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-113",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})})," & ",(0,r.jsx)(s.code,{children:"object"}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"any"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getunsentmessages",children:"getUnsentMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getUnsentMessages"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retreive an array of messages that are not yet sent to the recipient via the host account device (i.e no ticks)"}),"\n",(0,r.jsx)(s.h4,{id:"returns-114",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getvcards",children:"getVCards()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getVCards"}),"(",(0,r.jsx)(s.code,{children:"msgId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),"[]>"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Extracts vcards from a message.This works on messages of typ ",(0,r.jsx)(s.code,{children:"vcard"})," or ",(0,r.jsx)(s.code,{children:"multi_vcard"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-77",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"msgId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"string id of the message to extract the vcards from"}),"\n",(0,r.jsx)(s.h4,{id:"returns-115",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"[vcard]"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{children:'[\n{\ndisplayName:"Contact name",\nvcard: "loong vcard string"\n}\n]\n'})}),"\n",(0,r.jsx)(s.p,{children:"or false if no valid vcards found."}),"\n",(0,r.jsxs)(s.p,{children:["Please use ",(0,r.jsx)(s.a,{href:"https://www.npmjs.com/package/vcf",children:"vcf"})," to convert a vcard string into a json object"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"getwaversion",children:"getWAVersion()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"getWAVersion"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-116",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"ghostforward",children:"ghostForward()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"ghostForward"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Ghost forwarding is like a normal forward but as if it were sent from the host phone [i.e it doesn't show up as forwarded.]\nAny potential abuse of this method will see it become paywalled."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-78",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-117",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"healthcheck",children:"healthCheck()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"healthCheck"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck",children:(0,r.jsx)(s.code,{children:"HealthCheck"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Runs a health check to help you determine if/when is an appropiate time to restart/refresh the session."}),"\n",(0,r.jsx)(s.h4,{id:"returns-118",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck",children:(0,r.jsx)(s.code,{children:"HealthCheck"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"iamadmin",children:"iAmAdmin()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"iAmAdmin"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns an array of group ids where the host account is admin"}),"\n",(0,r.jsx)(s.h4,{id:"returns-119",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"inviteinfo",children:"inviteInfo()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"inviteInfo"}),"(",(0,r.jsx)(s.code,{children:"link"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Get the details of a group through the invite link"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-79",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"link"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"This can be an invite link or invite code"}),"\n",(0,r.jsx)(s.h4,{id:"returns-120",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"ischatmuted",children:"isChatMuted()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isChatMuted"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Checks if a chat is muted"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-80",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the chat you want to check"}),"\n",(0,r.jsx)(s.h4,{id:"returns-121",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["boolean. ",(0,r.jsx)(s.code,{children:"false"})," if the chat does not exist."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"ischatonline",children:"isChatOnline()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isChatOnline"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Checks if a chat contact is online. Not entirely sure if this works with groups."}),"\n",(0,r.jsxs)(s.p,{children:["It will return ",(0,r.jsx)(s.code,{children:"true"})," if the chat is ",(0,r.jsx)(s.code,{children:"online"}),", ",(0,r.jsx)(s.code,{children:"false"})," if the chat is ",(0,r.jsx)(s.code,{children:"offline"}),", ",(0,r.jsx)(s.code,{children:"PRIVATE"})," if the privacy settings of the contact do not allow you to see their status and ",(0,r.jsx)(s.code,{children:"NO_CHAT"})," if you do not currently have a chat with that contact."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-81",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-122",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"isconnected",children:"isConnected()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isConnected"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retrieves if the phone is online. Please note that this may not be real time."}),"\n",(0,r.jsx)(s.h4,{id:"returns-123",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"isgroupidunsafe-insiders",children:["isGroupIdUnsafe() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isGroupIdUnsafe"}),"(",(0,r.jsx)(s.code,{children:"groupChatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Checks whether or not the group id provided is known to be unsafe by the contributors of the library."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-82",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupChatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The group chat you want to deteremine is unsafe"}),"\n",(0,r.jsx)(s.h4,{id:"returns-124",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise "})," This will either return a boolean indiciating whether this group chat id is considered unsafe or an error message as a string"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"isphonedisconnected",children:"isPhoneDisconnected()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"isPhoneDisconnected"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:['Check if the "Phone not Cconnected" message is showing in the browser. If it is showing, then this will return ',(0,r.jsx)(s.code,{children:"true"}),"."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-125",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"boolean"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"joingroupvialink",children:"joinGroupViaLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"joinGroupViaLink"}),"(",(0,r.jsx)(s.code,{children:"link"}),", ",(0,r.jsx)(s.code,{children:"returnChatObj"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Joins a group via the invite link, code, or message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-83",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"link"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"This param is the string which includes the invite link or code. The following work:"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsxs)(s.li,{children:["Follow this link to join my WA group: ",(0,r.jsx)(s.a,{href:"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ",children:"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ"})]}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ",children:"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ"})}),"\n",(0,r.jsx)(s.li,{children:"DHTGJUfFJAV9MxOpZO1fBZ"}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["If you have been removed from the group previously, it will return ",(0,r.jsx)(s.code,{children:"401"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"returnChatObj?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean When this is set to true and if the group was joined successfully, it will return a serialzed Chat object which includes group information and metadata. This is useful when you want to immediately do something with group metadata."}),"\n",(0,r.jsx)(s.h4,{id:"returns-126",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:(0,r.jsx)(s.code,{children:"Chat"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," Either false if it didn't work, or the group id."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"joinwebbeta",children:"joinWebBeta()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"joinWebBeta"}),"(",(0,r.jsx)(s.code,{children:"join"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Join or leave the wa web beta program. Will return true of operation was successful."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-84",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"join"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"true to join the beta, false to leave"}),"\n",(0,r.jsx)(s.h4,{id:"returns-127",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"kill",children:"kill()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"kill"}),"(",(0,r.jsx)(s.code,{children:"reason"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Shuts down the page and browser"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-85",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"reason"}),": ",(0,r.jsx)(s.code,{children:"string"})," = ",(0,r.jsx)(s.code,{children:'"MANUALLY_KILLED"'})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-128",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"true"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"leavegroup",children:"leaveGroup()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"leaveGroup"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Removes the host device from the group"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-86",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"group id"}),"\n",(0,r.jsx)(s.h4,{id:"returns-129",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"listwebhooks",children:"listWebhooks()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"listWebhooks"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Retreives an array of webhook objects"}),"\n",(0,r.jsx)(s.h4,{id:"returns-130",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"loadallearliermessages",children:"loadAllEarlierMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"loadAllEarlierMessages"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Load all messages in chat object from server."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-87",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-131",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"Message[]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"loadandgetallmessagesinchat",children:"loadAndGetAllMessagesInChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"loadAndGetAllMessagesInChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"includeMe"}),", ",(0,r.jsx)(s.code,{children:"includeNotifications"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"loads and Retrieves all Messages in a chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-88",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeMe"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"includeNotifications"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-132",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"any"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"loadearliermessages",children:"loadEarlierMessages()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"loadEarlierMessages"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Load more messages in chat object from server. Use this in a while loop. This should return up to 50 messages at a time"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-89",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-133",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"Message []"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"loadearliermessagestilldate",children:"loadEarlierMessagesTillDate()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"loadEarlierMessagesTillDate"}),"(",(0,r.jsx)(s.code,{children:"contactId"}),", ",(0,r.jsx)(s.code,{children:"timestamp"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Load all messages until a given timestamp in chat object from server."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-90",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"timestamp"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"in seconds"}),"\n",(0,r.jsx)(s.h4,{id:"returns-134",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:(0,r.jsx)(s.code,{children:"Message"})}),"[]>"]}),"\n",(0,r.jsx)(s.p,{children:"Message[]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"logger",children:"logger()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"logger"}),"(): ",(0,r.jsx)(s.code,{children:"any"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Grab the logger for this session/process"}),"\n",(0,r.jsx)(s.h4,{id:"returns-135",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"any"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"logout",children:"logout()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"logout"}),"(",(0,r.jsx)(s.code,{children:"preserveSessionData"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Logs out from the session."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-91",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"preserveSessionData"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.p,{children:"skip session.data.json file invalidation\nPlease be careful when using this as it can exit the whole process depending on your config"}),"\n",(0,r.jsx)(s.h4,{id:"returns-136",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"markallread",children:"markAllRead()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"markAllRead"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Runs sendSeen on all chats"}),"\n",(0,r.jsx)(s.h4,{id:"returns-137",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"markasunread",children:"markAsUnread()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"markAsUnread"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sets a chat status to unread. May be useful to get host's attention"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-92",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-138",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"metrics",children:"metrics()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"metrics"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Returns some metrics of the session/page."}),"\n",(0,r.jsx)(s.h4,{id:"returns-139",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"middleware",children:"middleware()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"middleware"}),"(",(0,r.jsx)(s.code,{children:"useSessionIdInPath"}),", ",(0,r.jsx)(s.code,{children:"PORT"}),"?): (",(0,r.jsx)(s.code,{children:"req"}),", ",(0,r.jsx)(s.code,{children:"res"}),", ",(0,r.jsx)(s.code,{children:"next"}),") => ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"This exposes a simple express middlware that will allow users to quickly boot up an api based off this client. Checkout demo/index.ts for an example\nHow to use the middleware:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"\nimport { create } from '@open-wa/wa-automate';\nconst express = require('express')\nconst app = express()\napp.use(express.json())\nconst PORT = 8082;\n\nfunction start(client){\n app.use(client.middleware()); //or client.middleware(true) if you require the session id to be part of the path (so localhost:8082/sendText beccomes localhost:8082/sessionId/sendText)\n app.listen(PORT, function () {\n console.log(`\\n\u2022 Listening on port ${PORT}!`);\n });\n ...\n}\n\ncreate({\n sessionId:'session1'\n}).then(start)\n\n"})}),"\n",(0,r.jsxs)(s.p,{children:["All requests need to be ",(0,r.jsx)(s.code,{children:"POST"})," requests. You use the API the same way you would with ",(0,r.jsx)(s.code,{children:"client"}),". The method can be the path or the method param in the post body. The arguments for the method should be properly ordered in the args array in the JSON post body."]}),"\n",(0,r.jsx)(s.p,{children:"Example:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:" await client.sendText('4477777777777@c.us','test')\n //returns \"true_4477777777777@c.us_3EB0645E623D91006252\"\n"})}),"\n",(0,r.jsx)(s.p,{children:"as a request with a path:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"const axios = require('axios').default;\naxios.post('localhost:8082/sendText', {\n args: [\n \"4477777777777@c.us\", \n \"test\" \n ]\n })\n"})}),"\n",(0,r.jsx)(s.p,{children:"or as a request without a path:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"const axios = require('axios').default;\naxios.post('localhost:8082', {\n method:'sendText',\n args: [\n \"4477777777777@c.us\", \n \"test\" \n ]\n})\n"})}),"\n",(0,r.jsx)(s.p,{children:"As of 1.9.69, you can also send the argyments as an object with the keys mirroring the paramater names of the relative client functions"}),"\n",(0,r.jsx)(s.p,{children:"Example:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:'const axios = require(\'axios\').default;\naxios.post(\'localhost:8082\', {\n method:\'sendText\',\n args: {\n "to":"4477777777777@c.us", \n "content":"test" \n }\n})\n'})}),"\n",(0,r.jsx)(s.h4,{id:"parameters-93",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"useSessionIdInPath"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean Set this to true if you want to keep each session in it's own path."}),"\n",(0,r.jsxs)(s.p,{children:["For example, if you have a session with id ",(0,r.jsx)(s.code,{children:"host"})," if you set useSessionIdInPath to true, then all requests will need to be prefixed with the path ",(0,r.jsx)(s.code,{children:"host"}),". E.g ",(0,r.jsx)(s.code,{children:"localhost:8082/sendText"})," becomes ",(0,r.jsx)(s.code,{children:"localhost:8082/host/sendText"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"PORT?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-140",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Function"})}),"\n",(0,r.jsx)(s.h5,{id:"parameters-94",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"req"}),": ",(0,r.jsx)(s.code,{children:"Request"}),"<",(0,r.jsx)(s.code,{children:"ParamsDictionary"}),", ",(0,r.jsx)(s.code,{children:"any"}),", ",(0,r.jsx)(s.code,{children:"any"}),", ",(0,r.jsx)(s.code,{children:"ParsedQs"}),", ",(0,r.jsx)(s.code,{children:"Record"}),"<",(0,r.jsx)(s.code,{children:"string"}),", ",(0,r.jsx)(s.code,{children:"any"}),">>"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"res"}),": ",(0,r.jsx)(s.code,{children:"Response"}),"<",(0,r.jsx)(s.code,{children:"any"}),", ",(0,r.jsx)(s.code,{children:"Record"}),"<",(0,r.jsx)(s.code,{children:"string"}),", ",(0,r.jsx)(s.code,{children:"any"}),">>"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"next"}),": ",(0,r.jsx)(s.code,{children:"NextFunction"})]}),"\n",(0,r.jsx)(s.h5,{id:"returns-141",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"mutechat-insiders",children:["muteChat() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"muteChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"muteDuration"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Mutes a conversation for a given duration. If already muted, this will update the muted duration. Mute durations are relative from when the method is called."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-95",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the conversation you want to mute"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"muteDuration"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/enumerations/ChatMuteDuration",children:(0,r.jsx)(s.code,{children:"ChatMuteDuration"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatMuteDuration enum of the time you want this chat to be muted for."}),"\n",(0,r.jsx)(s.h4,{id:"returns-142",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true: worked or error code or message"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onnewproduct-insiders",children:["onNewProduct() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onNewProduct"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Listens to new orders. Only works on business accounts"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-96",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-143",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onorder-insiders",children:["onOrder() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onOrder"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Listens to new orders. Only works on business accounts"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-97",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-144",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"pinchat",children:"pinChat()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"pinChat"}),"(",(0,r.jsx)(s.code,{children:"id"}),", ",(0,r.jsx)(s.code,{children:"pin"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Pin/Unpin chats"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-98",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the conversation"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"pin"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-145",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true: worked"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"postimagestatus-restricted",children:["postImageStatus() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"postImageStatus"}),"(",(0,r.jsx)(s.code,{children:"data"}),", ",(0,r.jsx)(s.code,{children:"caption"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Posts an image story."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-99",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"data"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsxs)(s.p,{children:["data url string ",(0,r.jsx)(s.code,{children:"data:[][;charset=][;base64],"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The caption for the story"}),"\n",(0,r.jsx)(s.h4,{id:"returns-146",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," returns status id if it worked, false if it didn't"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"posttextstatus-restricted",children:["postTextStatus() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"postTextStatus"}),"(",(0,r.jsx)(s.code,{children:"text"}),", ",(0,r.jsx)(s.code,{children:"textRgba"}),", ",(0,r.jsx)(s.code,{children:"backgroundRgba"}),", ",(0,r.jsx)(s.code,{children:"font"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Sends a formatted text story."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-100",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The text to be displayed in the story"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"textRgba"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:'The colour of the text in the story in hex format, make sure to add the alpha value also. E.g "#FF00F4F2"'}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"backgroundRgba"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:'The colour of the background in the story in hex format, make sure to add the alpha value also. E.g "#4FF31FF2"'}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"font"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsxs)(s.p,{children:["The font of the text to be used in the story. This has to be a number. Each number refers to a specific predetermined font. Here are the fonts you can choose from:\n0: Sans Serif\n1: Serif\n2: ",(0,r.jsx)(s.a,{href:"https://fonts.google.com/specimen/Norican",children:"Norican Regular"}),"\n3: ",(0,r.jsx)(s.a,{href:"https://www.dafontfree.net/freefonts-bryndan-write-f160189.htm",children:"Bryndan Write"}),"\n4: ",(0,r.jsx)(s.a,{href:"https://www.dafont.com/bebas-neue.font",children:"Bebasneue Regular"}),"\n5: ",(0,r.jsx)(s.a,{href:"https://www.fontsquirrel.com/fonts/oswald",children:"Oswald Heavy"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-147",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," returns status id if it worked, false if it didn't"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"postthumbnailstatus-restricted",children:["postThumbnailStatus() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"postThumbnailStatus"}),"(",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"text"}),", ",(0,r.jsx)(s.code,{children:"textRgba"}),", ",(0,r.jsx)(s.code,{children:"backgroundRgba"}),", ",(0,r.jsx)(s.code,{children:"font"}),", ",(0,r.jsx)(s.code,{children:"thumbnail"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Sends a formatted text story with a thumbnail."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-101",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The URL to share in the story"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The text to be displayed in the story"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"textRgba"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:'The colour of the text in the story in hex format, make sure to add the alpha value also. E.g "#FF00F4F2"'}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"backgroundRgba"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:'The colour of the background in the story in hex format, make sure to add the alpha value also. E.g "#4FF31FF2"'}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"font"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"The font of the text to be used in the story. This has to be a number. Each number refers to a specific predetermined font. Here are the fonts you can choose from:"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"thumbnail?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsxs)(s.p,{children:["base64 thumbnail override, if not provided the link server will try to figure it out.\n0: Sans Serif\n1: Serif\n2: ",(0,r.jsx)(s.a,{href:"https://fonts.google.com/specimen/Norican",children:"Norican Regular"}),"\n3: ",(0,r.jsx)(s.a,{href:"https://www.dafontfree.net/freefonts-bryndan-write-f160189.htm",children:"Bryndan Write"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-148",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," returns status id if it worked, false if it didn't"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"postvideostatus-restricted",children:["postVideoStatus() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"postVideoStatus"}),"(",(0,r.jsx)(s.code,{children:"data"}),", ",(0,r.jsx)(s.code,{children:"caption"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Posts a video story."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-102",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"data"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsxs)(s.p,{children:["data url string ",(0,r.jsx)(s.code,{children:"data:[][;charset=][;base64],"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The caption for the story"}),"\n",(0,r.jsx)(s.h4,{id:"returns-149",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," returns status id if it worked, false if it didn't"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"prepeventdata",children:"prepEventData()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"prepEventData"}),"(",(0,r.jsx)(s.code,{children:"data"}),", ",(0,r.jsx)(s.code,{children:"event"}),", ",(0,r.jsx)(s.code,{children:"extras"}),"?): ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/EventPayload",children:(0,r.jsx)(s.code,{children:"EventPayload"})})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-103",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"data"}),": ",(0,r.jsx)(s.code,{children:"JsonObject"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"event"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"extras?"}),": ",(0,r.jsx)(s.code,{children:"JsonObject"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-150",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/EventPayload",children:(0,r.jsx)(s.code,{children:"EventPayload"})})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"promoteparticipant",children:"promoteParticipant()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"promoteParticipant"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"participantId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Promote Participant to Admin in Group"}),"\n",(0,r.jsxs)(s.p,{children:["If not a group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_GROUP_CHAT"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If the chat does not exist, returns ",(0,r.jsx)(s.code,{children:"GROUP_DOES_NOT_EXIST"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the participantId does not exist in the group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_PARTICIPANT"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the host account is not an administrator, returns ",(0,r.jsx)(s.code,{children:"INSUFFICIENT_PERMISSIONS"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-104",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"participantId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-151",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"react",children:"react()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"react"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"emoji"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"React to a message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-105",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"Message ID of the message you want to react to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"emoji"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"1 single emoji to add to the message as a reacion"}),"\n",(0,r.jsx)(s.h4,{id:"returns-152",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"refresh",children:"refresh()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"refresh"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Refreshes the page and reinjects all necessary files. This may be useful for when trying to save memory\nThis will attempt to re register all listeners EXCEPT onLiveLocation and onParticipantChanged"}),"\n",(0,r.jsx)(s.h4,{id:"returns-153",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"registerwebhook",children:"registerWebhook()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"registerWebhook"}),"(",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"events"}),", ",(0,r.jsx)(s.code,{children:"requestConfig"}),", ",(0,r.jsx)(s.code,{children:"concurrency"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"The client can now automatically handle webhooks. Use this method to register webhooks."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-106",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The webhook url"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"events"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})}),"[] | ",(0,r.jsx)(s.code,{children:'"all"'})]}),"\n",(0,r.jsxs)(s.p,{children:["An array of [[SimpleListener]] enums or ",(0,r.jsx)(s.code,{children:"all"})," (to register all possible listeners)"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a post request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"concurrency"}),": ",(0,r.jsx)(s.code,{children:"number"})," = ",(0,r.jsx)(s.code,{children:"5"})]}),"\n",(0,r.jsx)(s.p,{children:"the amount of concurrent requests to be handled by the built in queue. Default is 5."}),"\n",(0,r.jsx)(s.h4,{id:"returns-154",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"A webhook object. This will include a webhook ID and an array of all successfully registered Listeners."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"rejectgroupjoinrequest",children:"rejectGroupJoinRequest()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"rejectGroupJoinRequest"}),"(",(0,r.jsx)(s.code,{children:"groupChatId"}),", ",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Rejects a group join request\n*"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-107",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupChatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The group chat id\n*"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The contact id of the person who is requesting to join the group\n*"}),"\n",(0,r.jsx)(s.h4,{id:"returns-155",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removealllisteners",children:"removeAllListeners()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeAllListeners"}),"(): ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-156",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"boolean"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removelabel",children:"removeLabel()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeLabel"}),"(",(0,r.jsx)(s.code,{children:"label"}),", ",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Removes label from chat, message or contact. Only for business accounts."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-108",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"label"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-157",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removelistener",children:"removeListener()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeListener"}),"(",(0,r.jsx)(s.code,{children:"listener"}),"): ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"//////////////////////// LISTENERS"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-109",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"listener"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-158",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"boolean"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removeparticipant",children:"removeParticipant()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeParticipant"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"participantId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Remove participant of Group"}),"\n",(0,r.jsxs)(s.p,{children:["If not a group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_GROUP_CHAT"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["If the chat does not exist, returns ",(0,r.jsx)(s.code,{children:"GROUP_DOES_NOT_EXIST"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the participantId does not exist in the group chat, returns ",(0,r.jsx)(s.code,{children:"NOT_A_PARTICIPANT"})]}),"\n",(0,r.jsxs)(s.p,{children:["If the host account is not an administrator, returns ",(0,r.jsx)(s.code,{children:"INSUFFICIENT_PERMISSIONS"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-110",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"0000000000-00000000@g.us"})}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"participantId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"000000000000@c.us"})}),"\n",(0,r.jsx)(s.h4,{id:"returns-159",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removeproduct",children:"removeProduct()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeProduct"}),"(",(0,r.jsx)(s.code,{children:"productId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Remove a product from the host account's catalog"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-111",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"productId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the product"}),"\n",(0,r.jsx)(s.h4,{id:"returns-160",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"removewebhook",children:"removeWebhook()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"removeWebhook"}),"(",(0,r.jsx)(s.code,{children:"webhookId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Removes a webhook."}),"\n",(0,r.jsxs)(s.p,{children:["Returns ",(0,r.jsx)(s.code,{children:"true"})," if the webhook was found and removed. ",(0,r.jsx)(s.code,{children:"false"})," if the webhook was not found and therefore could not be removed. This does not unregister any listeners off of other webhooks."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-112",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"webhookId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The ID of the webhook"}),"\n",(0,r.jsx)(s.h4,{id:"returns-161",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"retruns",children:"Retruns"}),"\n",(0,r.jsx)(s.p,{children:"boolean"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"reply",children:"reply()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"reply"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"content"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),", ",(0,r.jsx)(s.code,{children:"sendSeen"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a reply to a given message. Please note, you need to have at least sent one normal message to a contact in order for this to work properly."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-113",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"string chatid"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"content"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string reply text"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"string the msg id to reply to."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"sendSeen?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean If set to true, the chat will 'blue tick' all messages before sending the reply"}),"\n",(0,r.jsx)(s.h4,{id:"returns-162",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," false if didn't work, otherwise returns message id."]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"reportspam-restricted",children:["reportSpam() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"reportSpam"}),"(",(0,r.jsx)(s.code,{children:"id"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Report a contact for spam, block them and attempt to clear chat."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-114",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"id"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-163",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"resizepage",children:"resizePage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"resizePage"}),"(",(0,r.jsx)(s.code,{children:"width"}),", ",(0,r.jsx)(s.code,{children:"height"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Easily resize page on the fly. Useful if you're showing screenshots in a web-app."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-115",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"width"}),": ",(0,r.jsx)(s.code,{children:"number"})," = ",(0,r.jsx)(s.code,{children:"1920"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"height"}),": ",(0,r.jsx)(s.code,{children:"number"})," = ",(0,r.jsx)(s.code,{children:"1080"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-164",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"revokegroupinvitelink",children:"revokeGroupInviteLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"revokeGroupInviteLink"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Revokes the current invite link for a group chat. Any previous links will stop working"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-116",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-165",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendadvancedbuttons",children:(0,r.jsx)(s.del,{children:"sendAdvancedButtons()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendAdvancedButtons"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"body"}),", ",(0,r.jsx)(s.code,{children:"buttons"}),", ",(0,r.jsx)(s.code,{children:"text"}),", ",(0,r.jsx)(s.code,{children:"footer"}),", ",(0,r.jsx)(s.code,{children:"filename"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-117",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"chat id"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"body"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/LocationButtonBody",children:(0,r.jsx)(s.code,{children:"LocationButtonBody"})})]}),"\n",(0,r.jsx)(s.p,{children:"The body of the buttons message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"buttons"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/AdvancedButton",children:(0,r.jsx)(s.code,{children:"AdvancedButton"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"Array of buttons - limit is 3!"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"footer"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The footer of the buttons message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filename"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"Required if body is a file!!"}),"\n",(0,r.jsx)(s.h4,{id:"returns-166",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-3",children:"Deprecated"}),"\n",(0,r.jsxs)(s.admonition,{type:"danger",children:[(0,r.jsx)(s.p,{children:"Template messages (URL & CALL buttons) are broken for the foreseeable future. Please DO NOT get a license solely for access to URL or CALL buttons. They are no longer reliable due to recent changes at WA.\nWA BIZ accounts CANNOT send buttons. This is a WA limitation. DO NOT get a license solely for access to buttons on wa business accounts."}),(0,r.jsx)(s.p,{children:"THIS IS NOT WORKING FOR GROUPS YET."}),(0,r.jsx)(s.p,{children:"ADVANCED ARE DEPRECATED FOR NOW. DO NOT GET A LICENSE TO USE BUTTONS."})]}),"\n",(0,r.jsx)(s.p,{children:"Send advanced buttons with media body. This is an insiders feature for MD accounts."}),"\n",(0,r.jsx)(s.p,{children:"Body can be location, image, video or document. Buttons can be quick reply, url or call buttons."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendaudio",children:"sendAudio()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendAudio"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send an audio file with the default audio player (not PTT/voice message)"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-118",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:(0,r.jsx)(s.code,{children:"AdvancedFile"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB",children:"true_0000000000@c.us_JHB2HB23HJ4B234HJB"})," to send as a reply to a message"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-167",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendbanner",children:"sendBanner()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendBanner"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"base64"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send a banner image"}),"\n",(0,r.jsx)(s.p,{children:"Note this is a bit of hack on top of a location message. During testing it is shown to not work on iPhones."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-119",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"base64"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsx)(s.p,{children:"base64 encoded jpeg"}),"\n",(0,r.jsx)(s.h4,{id:"returns-168",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendbuttons",children:(0,r.jsx)(s.del,{children:"sendButtons()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendButtons"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"body"}),", ",(0,r.jsx)(s.code,{children:"buttons"}),", ",(0,r.jsx)(s.code,{children:"title"}),"?, ",(0,r.jsx)(s.code,{children:"footer"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-120",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"chat id"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"body"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/LocationButtonBody",children:(0,r.jsx)(s.code,{children:"LocationButtonBody"})})]}),"\n",(0,r.jsx)(s.p,{children:"The body of the buttons message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"buttons"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/Button",children:(0,r.jsx)(s.code,{children:"Button"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"Array of buttons - limit is 3!"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"title?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The title/header of the buttons message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"footer?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The footer of the buttons message"}),"\n",(0,r.jsx)(s.h4,{id:"returns-169",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-4",children:"Deprecated"}),"\n",(0,r.jsxs)(s.admonition,{type:"danger",children:[(0,r.jsx)(s.p,{children:"WA BIZ accounts CANNOT send buttons. This is a WA limitation. DO NOT get a license solely for access to buttons on wa business accounts.\nTHIS IS NOT WORKING FOR GROUPS YET."}),(0,r.jsx)(s.p,{children:"BUTTONS ARE DEPRECATED FOR NOW. DO NOT GET A LICENSE TO USE BUTTONS."})]}),"\n",(0,r.jsx)(s.p,{children:"Send generic quick reply buttons. This is an insiders feature for MD accounts."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendcontact",children:"sendContact()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendContact"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"contactId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends contact card to given chat id. You can use this to send multiple contacts but they will show up as multiple single-contact messages."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-121",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:xxxx@c.us",children:"xxxx@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-170",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendcustomproduct",children:(0,r.jsx)(s.del,{children:"sendCustomProduct()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendCustomProduct"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"image"}),", ",(0,r.jsx)(s.code,{children:"productData"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-122",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"image"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"productData"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/product/interfaces/CustomProduct",children:(0,r.jsx)(s.code,{children:"CustomProduct"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-171",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-5",children:"Deprecated"}),"\n",(0,r.jsx)(s.p,{children:"Feature Currently only available with Premium License accounts."}),"\n",(0,r.jsx)(s.p,{children:"Send a custom product to a chat. Please see [[CustomProduct]] for details."}),"\n",(0,r.jsx)(s.p,{children:"Caveats:"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:"URL will not work (unable to click), you will have to send another message with the URL."}),"\n",(0,r.jsx)(s.li,{children:'Recipient will see a thin banner under picture that says "Something went wrong"'}),"\n",(0,r.jsx)(s.li,{children:"This will only work if you have at least 1 product already in your catalog"}),"\n",(0,r.jsx)(s.li,{children:"Only works on Business accounts"}),"\n"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendemoji",children:"sendEmoji()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendEmoji"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"emojiId"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send a discord emoji to a chat as a sticker"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-123",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatId The chat id you want to send the webp sticker to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"emojiId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["The discord emoji id without indentifying chars. In discord you would write ",(0,r.jsx)(s.code,{children:":who:"}),", here use ",(0,r.jsx)(s.code,{children:"who"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["message id of the message you want this sticker to reply to. @license",":insiders","@"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-172",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendfile",children:"sendFile()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendFile"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"filename"}),", ",(0,r.jsx)(s.code,{children:"caption"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"waitForId"}),"?, ",(0,r.jsx)(s.code,{children:"ptt"}),"?, ",(0,r.jsx)(s.code,{children:"withoutPreview"}),"?, ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"viewOnce"}),"?, ",(0,r.jsx)(s.code,{children:"requestConfig"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a file to given chat, with caption or not, using base64. This is exactly the same as sendImage"}),"\n",(0,r.jsxs)(s.p,{children:["Please note that any file that resolves to mime-type ",(0,r.jsx)(s.code,{children:"octet-stream"})," will, by default, resolve to an MP4 file."]}),"\n",(0,r.jsxs)(s.p,{children:["If you want a specific filetype, then explcitly select the correct mime-type from ",(0,r.jsx)(s.a,{href:"https://www.iana.org/assignments/media-types/media-types.xhtml",children:"https://www.iana.org/assignments/media-types/media-types.xhtml"})]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-124",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:(0,r.jsx)(s.code,{children:"AdvancedFile"})})]}),"\n",(0,r.jsxs)(s.p,{children:["DataURL data",":image","/xxx;base64,xxx or the RELATIVE (should start with ",(0,r.jsx)(s.code,{children:"./"})," or ",(0,r.jsx)(s.code,{children:"../"}),") path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] ",(0,r.jsx)(s.code,{children:"https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg"}),")."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filename"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string xxxxx With an ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?tier=Insiders%20Program",children:"INSIDERS LICENSE-KEY"})," you can also tag people in groups with ",(0,r.jsx)(s.code,{children:"@[number]"}),". For example if you want to mention the user with the number ",(0,r.jsx)(s.code,{children:"44771234567"}),", just add ",(0,r.jsx)(s.code,{children:"@44771234567"})," in the caption."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB",children:"true_0000000000@c.us_JHB2HB23HJ4B234HJB"})," to send as a reply to a message"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"waitForId?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to wait for the id of the message. By default this is set to false as it will take a few seconds to retrieve to the key of the message and this waiting may not be desirable for the majority of users."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"ptt?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to send the file as a push to talk file."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withoutPreview?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to send the file without a preview (i.e as a file). This is useful for preventing auto downloads on recipient devices."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false [INSIDERS] set this to try silent tag someone in the caption"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"viewOnce?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig?"}),": ",(0,r.jsx)(s.code,{children:"any"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-173",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise "})," This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendfilefromurl",children:"sendFileFromUrl()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendFileFromUrl"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"filename"}),", ",(0,r.jsx)(s.code,{children:"caption"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"requestConfig"}),"?, ",(0,r.jsx)(s.code,{children:"waitForId"}),"?, ",(0,r.jsx)(s.code,{children:"ptt"}),"?, ",(0,r.jsx)(s.code,{children:"withoutPreview"}),"?, ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"viewOnce"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a file by Url or custom options"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-125",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4",children:"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filename"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string 'video.mp4'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB",children:"true_0000000000@c.us_JHB2HB23HJ4B234HJB"})," to send as a reply to a message"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig?"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"waitForId?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to wait for the id of the message. By default this is set to false as it will take a few seconds to retrieve to the key of the message and this waiting may not be desirable for the majority of users."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"ptt?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to send the file as a push to talk file."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withoutPreview?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false set this to true if you want to send the file without a preview (i.e as a file). This is useful for preventing auto downloads on recipient devices."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"viewOnce?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-174",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendgiphy",children:"sendGiphy()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendGiphy"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"giphyMediaUrl"}),", ",(0,r.jsx)(s.code,{children:"caption"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a video to given chat as a gif by using a giphy link, with caption or not, using base64"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-126",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"giphyMediaUrl"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"https://media.giphy.com/media/oYtVHSxngR3lC/giphy.gif",children:"https://media.giphy.com/media/oYtVHSxngR3lC/giphy.gif"})," => ",(0,r.jsx)(s.a,{href:"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4",children:"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsx)(s.h4,{id:"returns-175",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendgiphyassticker",children:"sendGiphyAsSticker()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendGiphyAsSticker"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"giphyMediaUrl"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send a giphy GIF as an animated sticker."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-127",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatId"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"giphyMediaUrl"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"URL"})]}),"\n",(0,r.jsxs)(s.p,{children:["URL | string This is the giphy media url and has to be in the format ",(0,r.jsx)(s.code,{children:"https://media.giphy.com/media/RJKHjCAdsAfQPn03qQ/source.gif"})," or it can be just the id ",(0,r.jsx)(s.code,{children:"RJKHjCAdsAfQPn03qQ"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-176",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendimage",children:"sendImage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendImage"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"filename"}),", ",(0,r.jsx)(s.code,{children:"caption"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"waitForId"}),"?, ",(0,r.jsx)(s.code,{children:"ptt"}),"?, ",(0,r.jsx)(s.code,{children:"withoutPreview"}),"?, ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"viewOnce"}),"?, ",(0,r.jsx)(s.code,{children:"requestConfig"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a image to given chat, with caption or not, using base64"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-128",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:(0,r.jsx)(s.code,{children:"AdvancedFile"})})]}),"\n",(0,r.jsxs)(s.p,{children:["DataURL data",":image","/xxx;base64,xxx or the RELATIVE (should start with ",(0,r.jsx)(s.code,{children:"./"})," or ",(0,r.jsx)(s.code,{children:"../"}),") path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] ",(0,r.jsx)(s.code,{children:"https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg"}),")."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filename"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"waitForId?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"ptt?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"withoutPreview?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean default: false [INSIDERS] set this to try silent tag someone in the caption"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"viewOnce?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig?"}),": ",(0,r.jsx)(s.code,{children:"any"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-177",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise "})," This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendimageassticker",children:"sendImageAsSticker()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendImageAsSticker"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"image"}),", ",(0,r.jsx)(s.code,{children:"stickerMetadata"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"This function takes an image (including animated GIF) and sends it as a sticker to the recipient. This is helpful for sending semi-ephemeral things like QR codes.\nThe advantage is that it will not show up in the recipients gallery. This function automatiicaly converts images to the required webp format."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-129",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"image"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})," | ",(0,r.jsx)(s.code,{children:"Buffer"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"stickerMetadata?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:(0,r.jsx)(s.code,{children:"StickerMetadata"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-178",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendimageasstickerasreply-insiders",children:["sendImageAsStickerAsReply() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendImageAsStickerAsReply"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"image"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"stickerMetadata"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"This function takes an image and sends it as a sticker to the recipient as a reply to another message."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-130",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The recipient id."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"image"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})," | ",(0,r.jsx)(s.code,{children:"Buffer"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the message to reply to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"stickerMetadata?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:(0,r.jsx)(s.code,{children:"StickerMetadata"})})]}),"\n",(0,r.jsx)(s.p,{children:"Sticker metadata"}),"\n",(0,r.jsx)(s.h4,{id:"returns-179",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendimagewithproduct",children:"sendImageWithProduct()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendImageWithProduct"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"image"}),", ",(0,r.jsx)(s.code,{children:"caption"}),", ",(0,r.jsx)(s.code,{children:"bizNumber"}),", ",(0,r.jsx)(s.code,{children:"productId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends product with image to chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-131",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"image"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string the caption you want to add to this message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"bizNumber"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})})]}),"\n",(0,r.jsx)(s.p,{children:"string the @c.us number of the business account from which you want to grab the product"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"productId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string the id of the product within the main catalog of the aforementioned business"}),"\n",(0,r.jsx)(s.h4,{id:"returns-180",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendlinkwithautopreview",children:"sendLinkWithAutoPreview()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendLinkWithAutoPreview"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"text"}),"?, ",(0,r.jsx)(s.code,{children:"thumbnail"}),"?, ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"customSize"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Automatically sends a link with the auto generated link preview. You can also add a custom message."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-132",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string A link."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string Custom text as body of the message, this needs to include the link or it will be appended after the link."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"thumbnail?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsx)(s.p,{children:"Base64 of the jpeg/png which will be used to override the automatically generated thumbnail."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Send this link preview message in response to a given quoted message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize?"})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Anchor the size of the thumbnail"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.height?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.width?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-181",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendlistmessage",children:(0,r.jsx)(s.del,{children:"sendListMessage()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendListMessage"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"sections"}),", ",(0,r.jsx)(s.code,{children:"title"}),", ",(0,r.jsx)(s.code,{children:"description"}),", ",(0,r.jsx)(s.code,{children:"actionText"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-133",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"sections"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/button/interfaces/Section",children:(0,r.jsx)(s.code,{children:"Section"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"The Sections of rows for the list message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"title"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The title of the list message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"description"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The description of the list message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"actionText"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The action text of the list message"}),"\n",(0,r.jsx)(s.h4,{id:"returns-182",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-6",children:"Deprecated"}),"\n",(0,r.jsxs)(s.admonition,{type:"danger",children:[(0,r.jsx)(s.p,{children:"It is not currently possible to send a listmessage to a group chat. This is a WA limitation.\nPlease DO NOT get a license solely for access to list messages in group chats."}),(0,r.jsx)(s.p,{children:"LIST MESSAGES ARE DEPRECATED TILL FURTHER NOTICE"})]}),"\n",(0,r.jsx)(s.p,{children:"Send a list message. This will not work when being sent from business accounts!"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendlocation",children:"sendLocation()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendLocation"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"lat"}),", ",(0,r.jsx)(s.code,{children:"lng"}),", ",(0,r.jsx)(s.code,{children:"loc"}),", ",(0,r.jsx)(s.code,{children:"address"}),"?, ",(0,r.jsx)(s.code,{children:"url"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Note: ",(0,r.jsx)(s.code,{children:"address"})," and ",(0,r.jsx)(s.code,{children:"url"})," are parameters available to insiders only."]}),"\n",(0,r.jsx)(s.p,{children:"Sends a location message to given chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-134",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"lat"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"latitude: '51.5074'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"lng"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"longitude: '0.1278'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"loc"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"location text: 'LONDON!'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"address?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"address text: '1 Regents Park!'"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["address text link: '",(0,r.jsx)(s.a,{href:"https://example.com",children:"https://example.com"}),"'"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-183",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendmessagewiththumb",children:"sendMessageWithThumb()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendMessageWithThumb"}),"(",(0,r.jsx)(s.code,{children:"thumb"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"title"}),", ",(0,r.jsx)(s.code,{children:"description"}),", ",(0,r.jsx)(s.code,{children:"text"}),", ",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"customSize"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a link to a chat that includes a link preview."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-135",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"thumb"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The base 64 data of the image you want to use as the thunbnail. This should be no more than 200x200px. Note: Dont need data url on this param"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The link you want to send"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"title"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The title of the link"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"description"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The long description of the link preview"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"The text you want to inslude in the message section. THIS HAS TO INCLUDE THE URL otherwise the url will be prepended to the text automatically."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The chat you want to send this message to."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Send this link preview message in response to a given quoted message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize?"})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Anchor the size of the thumbnail"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.height?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.width?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-184",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendmp4assticker",children:"sendMp4AsSticker()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendMp4AsSticker"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"processOptions"}),", ",(0,r.jsx)(s.code,{children:"stickerMetadata"}),"?, ",(0,r.jsx)(s.code,{children:"messageId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Use this to send an mp4 file as a sticker. This can also be used to convert GIFs from the chat because GIFs in WA are actually tiny mp4 files."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-136",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatId The chat id you want to send the webp sticker to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})," | ",(0,r.jsx)(s.code,{children:"Buffer"})]}),"\n",(0,r.jsx)(s.p,{children:"[[DataURL]], [[Base64]], URL (string GET), Relative filepath (string), or Buffer of the mp4 file"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"processOptions"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions",children:(0,r.jsx)(s.code,{children:"Mp4StickerConversionProcessOptions"})})," = ",(0,r.jsx)(s.code,{children:"defaultProcessOptions"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"stickerMetadata?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:(0,r.jsx)(s.code,{children:"StickerMetadata"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["message id of the message you want this sticker to reply to. @license",":insiders","@"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-185",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendmultiplecontacts-insiders",children:["sendMultipleContacts() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendMultipleContacts"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"contactIds"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Sends multiple contacts as a single message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-137",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:xxxx@c.us",children:"xxxx@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactIds"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-186",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendpaymentrequest",children:"sendPaymentRequest()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendPaymentRequest"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"amount"}),", ",(0,r.jsx)(s.code,{children:"currency"}),", ",(0,r.jsx)(s.code,{children:"message"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"[UNTESTED - REQUIRES FEEDBACK]\nSends a payment request message to given chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-138",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"amount"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"number the amount to request in 1000 format (e.g \xa310 => 10000)"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"currency"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string The 3 letter currency code"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"message?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string optional message to send with the payment request"}),"\n",(0,r.jsx)(s.h4,{id:"returns-187",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendpoll",children:"sendPoll()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendPoll"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"name"}),", ",(0,r.jsx)(s.code,{children:"options"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"allowMultiSelect"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send a poll to a group chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-139",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"chat id - a group chat is required"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"name"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"the name of the poll"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"options"}),": ",(0,r.jsx)(s.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"an array of poll options"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"A message to quote when sending the poll"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"allowMultiSelect?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Whether or not to allow multiple selections. default false"}),"\n",(0,r.jsx)(s.h4,{id:"returns-188",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendproduct-insiders",children:["sendProduct() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendProduct"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"productId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Send a product to a chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-140",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The chatId"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"productId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the product"}),"\n",(0,r.jsx)(s.h4,{id:"returns-189",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:"MessageID"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendptt",children:"sendPtt()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendPtt"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Attempts to send a file as a voice note. Useful if you want to send an mp3 file."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-141",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:(0,r.jsx)(s.code,{children:"AdvancedFile"})})]}),"\n",(0,r.jsxs)(s.p,{children:["base64 data",":image","/xxx;base64,xxx or the path of the file you want to send."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB",children:"true_0000000000@c.us_JHB2HB23HJ4B234HJB"})," to send as a reply to a message"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-190",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise "})," This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendrawwebpassticker",children:"sendRawWebpAsSticker()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendRawWebpAsSticker"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"webpBase64"}),", ",(0,r.jsx)(s.code,{children:"animated"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"You can use this to send a raw webp file."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-142",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatId The chat id you want to send the webp sticker to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"webpBase64"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsx)(s.p,{children:"Base64 The base64 string of the webp file. Not DataURl"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"animated"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsxs)(s.p,{children:["Boolean Set to true if the webp is animated. Default ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-191",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendrawwebpasstickerasreply-insiders",children:["sendRawWebpAsStickerAsReply() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendRawWebpAsStickerAsReply"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"webpBase64"}),", ",(0,r.jsx)(s.code,{children:"animated"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"You can use this to send a raw webp file."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-143",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"ChatId The chat id you want to send the webp sticker to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"MessageId Message ID of the message to reply to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"webpBase64"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsx)(s.p,{children:"Base64 The base64 string of the webp file. Not DataURl"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"animated"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsxs)(s.p,{children:["Boolean Set to true if the webp is animated. Default ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-192",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendreplywithmentions",children:"sendReplyWithMentions()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendReplyWithMentions"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"content"}),", ",(0,r.jsx)(s.code,{children:"replyMessageId"}),", ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"mentions"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:'Sends a reply to given chat that includes mentions, replying to the provided replyMessageId.\nIn order to use this method correctly you will need to send the text like this:\n"@4474747474747 how are you?"\nBasically, add a @ symbol before the number of the contact you want to mention.'}),"\n",(0,r.jsx)(s.h4,{id:"parameters-144",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"content"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"text message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"replyMessageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"id of message to reply to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Removes all tags within the message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"mentions?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"You can optionally add an array of contact IDs to tag only specific people"}),"\n",(0,r.jsx)(s.h4,{id:"returns-193",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendseen",children:"sendSeen()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendSeen"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sets a chat status to seen. Marks all messages as ack: 3"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-145",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-194",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendstickerfromurl",children:"sendStickerfromUrl()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendStickerfromUrl"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"requestConfig"}),", ",(0,r.jsx)(s.code,{children:"stickerMetadata"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a sticker (including GIF) from a given URL"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-146",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"stickerMetadata?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:(0,r.jsx)(s.code,{children:"StickerMetadata"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-195",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendstickerfromurlasreply-insiders",children:["sendStickerfromUrlAsReply() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendStickerfromUrlAsReply"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"messageId"}),", ",(0,r.jsx)(s.code,{children:"requestConfig"}),", ",(0,r.jsx)(s.code,{children:"stickerMetadata"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Sends a sticker from a given URL"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-147",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The recipient id."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The url of the image"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The id of the message to reply to"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"stickerMetadata?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:(0,r.jsx)(s.code,{children:"StickerMetadata"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-196",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"sendtext-restricted",children:["sendText() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendText"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"content"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Sends a text message to given chat"}),"\n",(0,r.jsxs)(s.p,{children:["A license is ",(0,r.jsx)(s.strong,{children:"NOT"})," required to send messages with existing chats/contacts. A license is only required for starting conversations with new numbers."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-148",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"content"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"text message"}),"\n",(0,r.jsx)(s.h4,{id:"returns-197",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendtextwithmentions",children:"sendTextWithMentions()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendTextWithMentions"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"content"}),", ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"mentions"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:'Sends a text message to given chat that includes mentions.\nIn order to use this method correctly you will need to send the text like this:\n"@4474747474747 how are you?"\nBasically, add a @ symbol before the number of the contact you want to mention.'}),"\n",(0,r.jsx)(s.h4,{id:"parameters-149",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"content"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"text message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Removes all tags within the message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"mentions?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(s.code,{children:"ContactId"})}),"[]"]}),"\n",(0,r.jsx)(s.p,{children:"You can optionally add an array of contact IDs to tag only specific people"}),"\n",(0,r.jsx)(s.h4,{id:"returns-198",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendvcard",children:"sendVCard()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendVCard"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"vcard"}),", ",(0,r.jsx)(s.code,{children:"contactName"}),"?, ",(0,r.jsx)(s.code,{children:"contactNumber"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Send VCARD"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-150",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:000000000000@c.us",children:"000000000000@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"vcard"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"vcard as a string, you can send multiple contacts vcard also."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactName?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The display name for the contact. Ignored on multiple vcards"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"contactNumber?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["If supplied, this will be injected into the vcard (VERSION 3 ONLY FROM VCARDJS) with the WA id to make it show up with the correct buttons on WA. The format of this param should be including country code, without any other formating. e.g:\n",(0,r.jsx)(s.code,{children:"4477777777777"}),"\nIgnored on multiple vcards"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-199",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendvideoasgif",children:"sendVideoAsGif()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendVideoAsGif"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"file"}),", ",(0,r.jsx)(s.code,{children:"filename"}),", ",(0,r.jsx)(s.code,{children:"caption"}),", ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"requestConfig"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sends a video to given chat as a gif, with caption or not, using base64"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-151",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["chat id ",(0,r.jsx)(s.code,{children:"xxxxx@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"file"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:(0,r.jsx)(s.code,{children:"AdvancedFile"})})]}),"\n",(0,r.jsxs)(s.p,{children:["DataURL data",":image","/xxx;base64,xxx or the RELATIVE (should start with ",(0,r.jsx)(s.code,{children:"./"})," or ",(0,r.jsx)(s.code,{children:"../"}),") path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] ",(0,r.jsx)(s.code,{children:"https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg"}),")."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"filename"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"caption"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"string xxxxx"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["string ",(0,r.jsx)(s.a,{href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB",children:"true_0000000000@c.us_JHB2HB23HJ4B234HJB"})," to send as a reply to a message"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig?"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-200",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"sendyoutubelink",children:"sendYoutubeLink()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"sendYoutubeLink"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"text"}),", ",(0,r.jsx)(s.code,{children:"thumbnail"}),"?, ",(0,r.jsx)(s.code,{children:"quotedMsgId"}),"?, ",(0,r.jsx)(s.code,{children:"customSize"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Automatically sends a youtube link with the auto generated link preview. You can also add a custom message."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-152",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string A youtube link."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"text"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})," = ",(0,r.jsx)(s.code,{children:"''"})]}),"\n",(0,r.jsx)(s.p,{children:"string Custom text as body of the message, this needs to include the link or it will be appended after the link."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"thumbnail?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:(0,r.jsx)(s.code,{children:"Base64"})})]}),"\n",(0,r.jsx)(s.p,{children:"string Base64 of the jpeg/png which will be used to override the automatically generated thumbnail."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"quotedMsgId?"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Send this link preview message in response to a given quoted message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize?"})]}),"\n",(0,r.jsx)(s.p,{children:"[INSIDERS] Anchor the size of the thumbnail"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.height?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"customSize.width?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-201",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"setchatbackgroundcolourhex-insiders",children:["setChatBackgroundColourHex() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setChatBackgroundColourHex"}),"(",(0,r.jsx)(s.code,{children:"hex"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Set the wallpaper background colour"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-153",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hex"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"'#FFF123'"}),"\n",(0,r.jsx)(s.h4,{id:"returns-202",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"setchatephemeral-insiders",children:["setChatEphemeral() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setChatEphemeral"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"ephemeral"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Turn the ephemeral setting in a chat to on or off"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-154",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"The ID of the chat"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"ephemeral"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/type-aliases/EphemeralDuration",children:(0,r.jsx)(s.code,{children:"EphemeralDuration"})})]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," to turn on the ephemeral setting to 1 day, ",(0,r.jsx)(s.code,{children:"false"})," to turn off the ephemeral setting. Other options: ",(0,r.jsx)(s.code,{children:"604800 | 7776000"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-203",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," true if the setting was set, ",(0,r.jsx)(s.code,{children:"false"})," if the chat does not exist"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setchatstate",children:"setChatState()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setChatState"}),"(",(0,r.jsx)(s.code,{children:"chatState"}),", ",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sets the chat state"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-155",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatState"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/chat/enumerations/ChatState",children:(0,r.jsx)(s.code,{children:"ChatState"})})]}),"\n",(0,r.jsx)(s.p,{children:"The state you want to set for the chat. Can be TYPING (0), RECRDING (1) or PAUSED (2)."}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-204",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgroupapprovalmode",children:"setGroupApprovalMode()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupApprovalMode"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"requireApproval"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Turn on or off the approval requirement for new members to join a group"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-156",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"' the group id."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requireApproval"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"set to true to turn on the approval requirement, false to turn off"}),"\n",(0,r.jsx)(s.h4,{id:"returns-205",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if action completed successfully."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgroupdescription",children:"setGroupDescription()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupDescription"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"description"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Change the group chant description"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-157",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"' the group id."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"description"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string The new group description"}),"\n",(0,r.jsx)(s.h4,{id:"returns-206",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if action completed successfully."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgroupedittoadminsonly",children:"setGroupEditToAdminsOnly()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupEditToAdminsOnly"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"onlyAdmins"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Change who can and cannot edit a groups details"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-158",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"' the group id."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"onlyAdmins"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean set to true if you want only admins to be able to speak in this group. false if you want to allow everyone to speak in the group"}),"\n",(0,r.jsx)(s.h4,{id:"returns-207",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if action completed successfully."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgroupicon",children:"setGroupIcon()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupIcon"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"image"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Change the icon for the group chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-159",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"mailto:123123123123_1312313123@g.us",children:"123123123123_1312313123@g.us"})," The id of the group"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"image"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-208",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if it was set, false if it didn't work. It usually doesn't work if the image file is too big."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgroupiconbyurl",children:"setGroupIconByUrl()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupIconByUrl"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"url"}),", ",(0,r.jsx)(s.code,{children:"requestConfig"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Change the icon for the group chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-160",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"mailto:123123123123_1312313123@g.us",children:"123123123123_1312313123@g.us"})," The id of the group"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"url"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"requestConfig"}),": ",(0,r.jsx)(s.code,{children:"AxiosRequestConfig"}),"<",(0,r.jsx)(s.code,{children:"any"}),"> = ",(0,r.jsx)(s.code,{children:"{}"})]}),"\n",(0,r.jsxs)(s.p,{children:[" By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.jsx)(s.a,{href:"https://github.com/axios/axios#request-config",children:"https://github.com/axios/axios#request-config"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-209",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if it was set, false if it didn't work. It usually doesn't work if the image file is too big."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"setgrouptitle-insiders",children:["setGroupTitle() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupTitle"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"title"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Change the group chat title"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-161",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"' the group id."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"title"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"string The new group title"}),"\n",(0,r.jsx)(s.h4,{id:"returns-210",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if action completed successfully."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setgrouptoadminsonly",children:"setGroupToAdminsOnly()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setGroupToAdminsOnly"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"onlyAdmins"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Change who can and cannot speak in a group"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-162",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:0000000000-00000000@g.us",children:"0000000000-00000000@g.us"}),"' the group id."]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"onlyAdmins"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"boolean set to true if you want only admins to be able to speak in this group. false if you want to allow everyone to speak in the group"}),"\n",(0,r.jsx)(s.h4,{id:"returns-211",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true if action completed successfully."}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setmyname",children:"setMyName()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setMyName"}),"(",(0,r.jsx)(s.code,{children:"newName"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Set your profile name"}),"\n",(0,r.jsx)(s.p,{children:"Please note, this does not work on business accounts!"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-163",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"newName"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"String new name to set for your profile"}),"\n",(0,r.jsx)(s.h4,{id:"returns-212",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setmystatus",children:"setMyStatus()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setMyStatus"}),"(",(0,r.jsx)(s.code,{children:"newStatus"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"set your about me"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-164",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"newStatus"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"String new profile status"}),"\n",(0,r.jsx)(s.h4,{id:"returns-213",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setpresence",children:"setPresence()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setPresence"}),"(",(0,r.jsx)(s.code,{children:"available"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Set presence to available or unavailable."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-165",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"available"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"if true it will set your presence to 'online', false will set to unavailable (i.e no 'online' on recipients' phone);"}),"\n",(0,r.jsx)(s.h4,{id:"returns-214",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"setprofilepic",children:"setProfilePic()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"setProfilePic"}),"(",(0,r.jsx)(s.code,{children:"data"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Sets the profile pic of the host number."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-166",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"data"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:(0,r.jsx)(s.code,{children:"DataURL"})})]}),"\n",(0,r.jsx)(s.p,{children:"string data url image string."}),"\n",(0,r.jsx)(s.h4,{id:"returns-215",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"})," success if true"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"simulaterecording",children:"simulateRecording()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"simulateRecording"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"on"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Simulate '...recording' in chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-167",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:xxxx@c.us",children:"xxxx@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"on"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"turn on similated recording, false to turn it off you need to manually turn this off."}),"\n",(0,r.jsx)(s.h4,{id:"returns-216",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"simulatetyping",children:"simulateTyping()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"simulateTyping"}),"(",(0,r.jsx)(s.code,{children:"to"}),", ",(0,r.jsx)(s.code,{children:"on"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Simulate '...typing' in chat"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-168",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"to"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["'",(0,r.jsx)(s.a,{href:"mailto:xxxx@c.us",children:"xxxx@c.us"}),"'"]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"on"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"turn on similated typing, false to turn it off you need to manually turn this off."}),"\n",(0,r.jsx)(s.h4,{id:"returns-217",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"starmessage",children:"starMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"starMessage"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Star a message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-169",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"Message ID of the message you want to star"}),"\n",(0,r.jsx)(s.h4,{id:"returns-218",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"true"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"synccontacts",children:"syncContacts()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"syncContacts"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Syncs contacts with phone. This promise does not resolve so it will instantly return true."}),"\n",(0,r.jsx)(s.h4,{id:"returns-219",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"tageveryone-insiders",children:["tagEveryone() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"tagEveryone"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"content"}),", ",(0,r.jsx)(s.code,{children:"hideTags"}),"?, ",(0,r.jsx)(s.code,{children:"formatting"}),"?, ",(0,r.jsx)(s.code,{children:"messageBeforeTags"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Tags everyone in the group with a message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-170",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["group chat id: ",(0,r.jsx)(s.code,{children:"xxxxx@g.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"content"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:(0,r.jsx)(s.code,{children:"Content"})})]}),"\n",(0,r.jsx)(s.p,{children:"text message to add under all of the tags"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"hideTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsx)(s.p,{children:"Removes all tags within the message"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"formatting?"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsx)(s.p,{children:"The formatting of the tags. Use"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageBeforeTags?"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\n",(0,r.jsxs)(s.p,{children:["set to ",(0,r.jsx)(s.code,{children:"true"})," to show the message before all of the tags"]}),"\n",(0,r.jsx)(s.h4,{id:"returns-220",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Promise"})}),"\n",(0,r.jsx)(s.h4,{id:"mention",children:"Mention"}),"\n",(0,r.jsx)(s.p,{children:"to indicate the actual tag."}),"\n",(0,r.jsx)(s.h4,{id:"default",children:"Default"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"@mention "})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"testbuttons",children:(0,r.jsx)(s.del,{children:"testButtons()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"testButtons"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-171",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-221",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"any"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-7",children:"Deprecated"}),"\n",(0,r.jsx)(s.admonition,{type:"danger",children:(0,r.jsx)(s.p,{children:"Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA."})}),"\n",(0,r.jsx)(s.p,{children:"Test the button commands on MD accounts with an insiders key. This is a temporary feature to help fix issue #2658"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"testcallback",children:"testCallback()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"testCallback"}),"(",(0,r.jsx)(s.code,{children:"callbackToTest"}),", ",(0,r.jsx)(s.code,{children:"testData"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Use this simple command to test firing callback events."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-172",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"callbackToTest"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"testData"}),": ",(0,r.jsx)(s.code,{children:"any"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-222",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"false"})," if the callback was not registered/does not exist"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"unmutechat-insiders",children:["unmuteChat() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"unmuteChat"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Unmutes a conversation."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-173",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-223",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"string"})," | ",(0,r.jsx)(s.code,{children:"number"})," | ",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true: worked or error code or message"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"unstarmessage",children:"unstarMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"unstarMessage"}),"(",(0,r.jsx)(s.code,{children:"messageId"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Unstar a message"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-174",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"messageId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(s.code,{children:"MessageId"})})]}),"\n",(0,r.jsx)(s.p,{children:"Message ID of the message you want to unstar"}),"\n",(0,r.jsx)(s.h4,{id:"returns-224",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"true"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"updatewebhook",children:"updateWebhook()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"updateWebhook"}),"(",(0,r.jsx)(s.code,{children:"webhookId"}),", ",(0,r.jsx)(s.code,{children:"events"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Update registered events for a specific webhook. This will override all existing events. If you'd like to remove all listeners from a webhook, consider using [[removeWebhook]]."}),"\n",(0,r.jsx)(s.p,{children:"In order to update authentication details for a webhook, remove it completely and then reregister it with the correct credentials."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-175",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"webhookId"}),": ",(0,r.jsx)(s.code,{children:"string"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"events"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:(0,r.jsx)(s.code,{children:"SimpleListener"})}),"[] | ",(0,r.jsx)(s.code,{children:'"all"'})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-225",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"false"})," | ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:(0,r.jsx)(s.code,{children:"Webhook"})}),">"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"waitallqempty",children:"waitAllQEmpty()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"waitAllQEmpty"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"true"})," | ",(0,r.jsx)(s.code,{children:"void"}),"[]>"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Wait for all queues to be empty"}),"\n",(0,r.jsx)(s.h4,{id:"returns-226",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"true"})," | ",(0,r.jsx)(s.code,{children:"void"}),"[]>"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"waitwhqidle",children:"waitWhQIdle()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"waitWhQIdle"}),"(): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"true"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Wait for the webhook queue to become idle. This is useful for ensuring webhooks are cleared before ending a process."}),"\n",(0,r.jsx)(s.h4,{id:"returns-227",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"true"})," | ",(0,r.jsx)(s.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(s.h2,{id:"events",children:"Events"}),"\n",(0,r.jsx)(s.h3,{id:"onack-1",children:"onAck()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAck"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to messages acknowledgement Changes"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-176",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[Message]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-228",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onaddedtogroup-1",children:"onAddedToGroup()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAddedToGroup"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Fires callback with Chat object every time the host phone is added to a group."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-177",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[Chat]] (group chat) as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-229",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onanymessage-1",children:"onAnyMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onAnyMessage"}),"(",(0,r.jsx)(s.code,{children:"fn"}),", ",(0,r.jsx)(s.code,{children:"queueOptions"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to all new messages"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-178",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"queueOptions?"}),": ",(0,r.jsx)(s.code,{children:"Options"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["PQueue options. Set to ",(0,r.jsx)(s.code,{children:"{}"})," for default PQueue."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-230",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Message]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onbattery-1",children:(0,r.jsx)(s.del,{children:"onBattery()"})}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onBattery"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-179",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-231",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"deprecated-8",children:"Deprecated"}),"\n",(0,r.jsx)(s.p,{children:"Listens to battery changes"}),"\n",(0,r.jsx)(s.admonition,{type:"caution",children:(0,r.jsx)(s.p,{children:"This will most likely not work with multi-device mode (the only remaining mode) since the session is no longer connected to the phone but directly to WA servers."})}),"\n",(0,r.jsx)(s.h4,{id:"fires-1",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"number"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onbroadcast-1",children:"onBroadcast()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onBroadcast"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to broadcast messages"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-180",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-232",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-2",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Message]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onbutton-1",children:"onButton()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onButton"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to button message responses"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-181",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-233",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-3",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Message]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"oncallstate-1",children:"onCallState()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onCallState"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to changes on call state"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-182",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-234",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Observable stream of call objects"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onchatdeleted-1",children:"onChatDeleted()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatDeleted"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to when a chat is deleted by the host account"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-183",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-235",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-4",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Chat]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onchatopened-insiders",children:["onChatOpened() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatOpened"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Fires callback with the relevant chat id every time the user clicks on a chat. This will only work in headful mode."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-184",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[ChatId]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-236",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onchatstate-insiders",children:["onChatState() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onChatState"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Listens to chat state, including when a specific user is recording and typing within a group chat."}),"\n",(0,r.jsx)(s.p,{children:"Here is an example of the fired object:"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-185",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-237",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-5",children:"Fires"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:'{\n"chat": "00000000000-1111111111@g.us", //the chat in which this state is occuring\n"user": "22222222222@c.us", //the user that is causing this state\n"state": "composing, //can also be \'available\', \'unavailable\', \'recording\' or \'composing\'\n}\n'})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"oncontactadded-insiders",children:["onContactAdded() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onContactAdded"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Fires callback with contact id when a new contact is added on the host phone."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-186",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[Chat]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-238",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onglobalparticipantschanged-1",children:"onGlobalParticipantsChanged()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGlobalParticipantsChanged"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to add and remove events on Groups on a global level. It is memory efficient and doesn't require a specific group id to listen to."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-187",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[ParticipantChangedEventModel]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-239",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"ongroupapprovalrequest-1",children:"onGroupApprovalRequest()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGroupApprovalRequest"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsxs)(s.p,{children:["Listents to group approval requests. Emits a message object. Use it with ",(0,r.jsx)(s.code,{children:"message.isGroupApprovalRequest()"})," to check if it is a group approval request."]}),"\n",(0,r.jsx)(s.h4,{id:"parameters-188",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[Message]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-240",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"ongroupchange-1",children:"onGroupChange()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onGroupChange"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to all group (gp2) events. This can be useful if you want to catch when a group title, subject or picture is changed."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-189",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[ParticipantChangedEventModel]] as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-241",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onincomingcall-1",children:"onIncomingCall()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onIncomingCall"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to new incoming calls"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-190",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-242",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Observable stream of call request objects"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onlabel-1",children:"onLabel()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onLabel"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to label change events"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-191",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-243",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-6",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Label]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onlivelocation",children:"onLiveLocation()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onLiveLocation"}),"(",(0,r.jsx)(s.code,{children:"chatId"}),", ",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to live locations from a chat that already has valid live locations"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-192",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"chatId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:(0,r.jsx)(s.code,{children:"ChatId"})})]}),"\n",(0,r.jsx)(s.p,{children:"the chat from which you want to subscribes to live location updates"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback that takes in a LiveLocationChangedEvent"}),"\n",(0,r.jsx)(s.h4,{id:"returns-244",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean, if returns false then there were no valid live locations in the chat of chatId"}),"\n",(0,r.jsx)(s.h4,{id:"emits",children:"Emits"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:""})," LiveLocationChangedEvent"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onlogout-1",children:"onLogout()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onLogout"}),"(",(0,r.jsx)(s.code,{children:"fn"}),", ",(0,r.jsx)(s.code,{children:"priority"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to a log out event"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-193",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"priority?"}),": ",(0,r.jsx)(s.code,{children:"number"})]}),"\n",(0,r.jsx)(s.p,{children:"A priority of -1 will mean the callback will be triggered after all the non -1 callbacks"}),"\n",(0,r.jsx)(s.h4,{id:"returns-245",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-7",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"true"})}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onmessage-1",children:"onMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onMessage"}),"(",(0,r.jsx)(s.code,{children:"fn"}),", ",(0,r.jsx)(s.code,{children:"queueOptions"}),"?): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to incoming messages"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-194",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"queueOptions?"}),": ",(0,r.jsx)(s.code,{children:"Options"}),"<",(0,r.jsx)(s.code,{children:"PriorityQueue"}),", ",(0,r.jsx)(s.code,{children:"DefaultAddOptions"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:["PQueue options. Set to ",(0,r.jsx)(s.code,{children:"{}"})," for default PQueue."]}),"\n",(0,r.jsx)(s.h4,{id:"returns-246",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-8",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Message]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onmessagedeleted-1",children:"onMessageDeleted()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onMessageDeleted"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to when a message is deleted by a recipient or the host account"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-195",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-247",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-9",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[Message]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onparticipantschanged",children:"onParticipantsChanged()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onParticipantsChanged"}),"(",(0,r.jsx)(s.code,{children:"groupId"}),", ",(0,r.jsx)(s.code,{children:"fn"}),", ",(0,r.jsx)(s.code,{children:"legacy"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to add and remove events on Groups. This can no longer determine who commited the action and only reports the following events add, remove, promote, demote"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-196",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"groupId"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:(0,r.jsx)(s.code,{children:"GroupChatId"})})]}),"\n",(0,r.jsxs)(s.p,{children:["group id: ",(0,r.jsx)(s.a,{href:"mailto:xxxxx-yyyy@c.us",children:"xxxxx-yyyy@c.us"})]}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"legacy"}),": ",(0,r.jsx)(s.code,{children:"boolean"})," = ",(0,r.jsx)(s.code,{children:"false"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-248",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"Observable stream of participantChangedEvent"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onplugged-1",children:"onPlugged()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onPlugged"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to when host device is plugged/unplugged"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-197",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-249",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-10",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"boolean true if plugged, false if unplugged"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onpollvote-1",children:"onPollVote()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onPollVote"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to poll vote events"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-198",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-250",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-11",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[PollData]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onreaction-insiders",children:["onReaction() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onReaction"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Listens to reaction add and change events"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-199",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-251",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-12",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"[[ReactionEvent]]"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onremovedfromgroup-insiders",children:["onRemovedFromGroup() ",(0,r.jsx)("div",{class:"label license insiders",children:"insiders"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onRemovedFromGroup"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require insiders license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Fires callback with Chat object every time the host phone is removed to a group."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-200",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback function that handles a [[Chat]] (group chat) as the first and only parameter."}),"\n",(0,r.jsx)(s.h4,{id:"returns-252",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"true"})," if the callback was registered"]}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"onstatechanged-1",children:"onStateChanged()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onStateChanged"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Listens to changes in state"}),"\n",(0,r.jsx)(s.h4,{id:"parameters-201",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.h4,{id:"returns-253",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-13",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"STATE observable sream of states"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsxs)(s.h3,{id:"onstory-restricted",children:["onStory() ",(0,r.jsx)("div",{class:"label license restricted",children:"restricted"})]}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"onStory"}),"(",(0,r.jsx)(s.code,{children:"fn"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.admonition,{title:"May require restricted license",type:"license",children:(0,r.jsxs)(s.p,{children:["Use this link to get the ",(0,r.jsx)(s.a,{href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License",children:"correct license"}),"."]})}),"\n",(0,r.jsx)(s.p,{children:"Listens to when a contact posts a new story."}),"\n",(0,r.jsx)(s.h4,{id:"parameters-202",children:"Parameters"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"fn"})]}),"\n",(0,r.jsx)(s.p,{children:"callback"}),"\n",(0,r.jsx)(s.h4,{id:"returns-254",children:"Returns"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"})," | ",(0,r.jsx)(s.code,{children:"Listener"}),">"]}),"\n",(0,r.jsx)(s.h4,{id:"fires-14",children:"Fires"}),"\n",(0,r.jsx)(s.p,{children:"e.g"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-javascript",children:"{\nfrom: '123456789@c.us'\nid: 'false_132234234234234@status.broadcast'\n}\n"})})]})}function h(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>l,x:()=>c});var r=n(6540);const i={},d=r.createContext(i);function l(e){const s=r.useContext(d);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),r.createElement(d.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6f5ae7fe.fc992260.js b/assets/js/6f5ae7fe.b3815040.js similarity index 97% rename from assets/js/6f5ae7fe.fc992260.js rename to assets/js/6f5ae7fe.b3815040.js index 088dfb85c..8f8e581f8 100644 --- a/assets/js/6f5ae7fe.fc992260.js +++ b/assets/js/6f5ae7fe.b3815040.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[998],{8642:(e,o,r)=>{r.r(o),r.d(o,{assets:()=>d,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>i,toc:()=>c});var t=r(4848),n=r(8453);const s={},a="Proxying your session",i={id:"how-to/use-a-proxy",title:"Proxying your session",description:"It is extremely simple to use a proxy with @open-wa. Once you have your proxy protocol, address, port, username and password you just need to set the [[proxyServerCredentials]] and @open-wa will connect your session via the proxy. For example, if your proxy details are:",source:"@site/docs/how-to/use-a-proxy.md",sourceDirName:"how-to",slug:"/how-to/use-a-proxy",permalink:"/docs/how-to/use-a-proxy",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/use-a-proxy.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"SendFile",permalink:"/docs/how-to/sendfile"},next:{title:"@open-wa/wa-automate v4.72.5",permalink:"/docs/reference/"}},d={},c=[];function p(e){const o={code:"code",h1:"h1",header:"header",p:"p",pre:"pre",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(o.header,{children:(0,t.jsx)(o.h1,{id:"proxying-your-session",children:"Proxying your session"})}),"\n",(0,t.jsx)(o.p,{children:"It is extremely simple to use a proxy with @open-wa. Once you have your proxy protocol, address, port, username and password you just need to set the [[proxyServerCredentials]] and @open-wa will connect your session via the proxy. For example, if your proxy details are:"}),"\n",(0,t.jsx)(o.pre,{children:(0,t.jsx)(o.code,{className:"language-text",children:"//this is dummy data\n\nprotocol: http\naddress: proxyaddress.abc\nport: 1234\nusername: open-wa\npassword: antidote\n"})}),"\n",(0,t.jsx)(o.p,{children:"then your config will look something like this:"}),"\n",(0,t.jsx)(o.pre,{children:(0,t.jsx)(o.code,{className:"language-javascript",children:"create({\n proxyServerCredentials: {\n address: 'http://proxyaddress.abc:1234',\n username: 'open-wa',\n password: 'antidote'\n }\n}).then(client => start(client));\n"})})]})}function u(e={}){const{wrapper:o}={...(0,n.R)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},8453:(e,o,r)=>{r.d(o,{R:()=>a,x:()=>i});var t=r(6540);const n={},s=t.createContext(n);function a(e){const o=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function i(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),t.createElement(s.Provider,{value:o},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[998],{8642:(e,o,r)=>{r.r(o),r.d(o,{assets:()=>d,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>i,toc:()=>c});var t=r(4848),n=r(8453);const s={},a="Proxying your session",i={id:"how-to/use-a-proxy",title:"Proxying your session",description:"It is extremely simple to use a proxy with @open-wa. Once you have your proxy protocol, address, port, username and password you just need to set the [[proxyServerCredentials]] and @open-wa will connect your session via the proxy. For example, if your proxy details are:",source:"@site/docs/how-to/use-a-proxy.md",sourceDirName:"how-to",slug:"/how-to/use-a-proxy",permalink:"/docs/how-to/use-a-proxy",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/how-to/use-a-proxy.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"SendFile",permalink:"/docs/how-to/sendfile"},next:{title:"@open-wa/wa-automate v4.74.0",permalink:"/docs/reference/"}},d={},c=[];function p(e){const o={code:"code",h1:"h1",header:"header",p:"p",pre:"pre",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(o.header,{children:(0,t.jsx)(o.h1,{id:"proxying-your-session",children:"Proxying your session"})}),"\n",(0,t.jsx)(o.p,{children:"It is extremely simple to use a proxy with @open-wa. Once you have your proxy protocol, address, port, username and password you just need to set the [[proxyServerCredentials]] and @open-wa will connect your session via the proxy. For example, if your proxy details are:"}),"\n",(0,t.jsx)(o.pre,{children:(0,t.jsx)(o.code,{className:"language-text",children:"//this is dummy data\n\nprotocol: http\naddress: proxyaddress.abc\nport: 1234\nusername: open-wa\npassword: antidote\n"})}),"\n",(0,t.jsx)(o.p,{children:"then your config will look something like this:"}),"\n",(0,t.jsx)(o.pre,{children:(0,t.jsx)(o.code,{className:"language-javascript",children:"create({\n proxyServerCredentials: {\n address: 'http://proxyaddress.abc:1234',\n username: 'open-wa',\n password: 'antidote'\n }\n}).then(client => start(client));\n"})})]})}function u(e={}){const{wrapper:o}={...(0,n.R)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}},8453:(e,o,r)=>{r.d(o,{R:()=>a,x:()=>i});var t=r(6540);const n={},s=t.createContext(n);function a(e){const o=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function i(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),t.createElement(s.Provider,{value:o},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.40e5d088.js b/assets/js/runtime~main.eaafe143.js similarity index 97% rename from assets/js/runtime~main.40e5d088.js rename to assets/js/runtime~main.eaafe143.js index 8050f6ad4..7135654f0 100644 --- a/assets/js/runtime~main.40e5d088.js +++ b/assets/js/runtime~main.eaafe143.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,b,f,c,d={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var b=t[e]={id:e,loaded:!1,exports:{}};return d[e].call(b.exports,b,b.exports,r),b.loaded=!0,b.exports}r.m=d,r.c=t,e=[],r.O=(a,b,f,c)=>{if(!b){var d=1/0;for(i=0;i=c)&&Object.keys(r.O).every((e=>r.O[e](b[o])))?b.splice(o--,1):(t=!1,c0&&e[i-1][2]>c;i--)e[i]=e[i-1];e[i]=[b,f,c]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},b=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var c=Object.create(null);r.r(c);var d={};a=a||[null,b({}),b([]),b(b)];for(var t=2&f&&e;"object"==typeof t&&!~a.indexOf(t);t=b(t))Object.getOwnPropertyNames(t).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,r.d(c,d),c},r.d=(e,a)=>{for(var b in a)r.o(a,b)&&!r.o(e,b)&&Object.defineProperty(e,b,{enumerable:!0,get:a[b]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,b)=>(r.f[b](e,a),a)),[])),r.u=e=>"assets/js/"+({16:"0e0f73c7",52:"f3fdb01a",57:"1df732fe",70:"bb20bb94",86:"58bfaad8",143:"b868a84c",240:"18336523",283:"155c8334",314:"1454731d",452:"d42a3ae7",487:"2b136cef",488:"98c048de",493:"4b6dedc4",523:"b8787afe",583:"f22ab3cc",594:"5e8c322a",599:"0d1f64ba",626:"20288d3d",707:"5fd2b997",727:"70bd31a0",730:"2fc4fc5f",747:"29b289c3",809:"150e319f",815:"428f4992",843:"20fe70bf",845:"c8a4e95a",849:"0058b4c6",858:"2eaaacd8",907:"5cc50a6c",957:"c141421f",974:"18ad8d0a",986:"29fec1eb",990:"0d185c55",998:"6f5ae7fe",1082:"d6466469",1121:"745741e5",1124:"4a1784a5",1128:"b35003cc",1181:"3d3a9b6d",1207:"1025625c",1235:"a7456010",1237:"a485a49d",1302:"901c4e03",1359:"45205a09",1397:"8997cb84",1399:"eff1717c",1422:"b0030a2c",1425:"edb57414",1482:"0057296d",1530:"1c28c6e3",1536:"7803af04",1543:"0673617b",1619:"f47e5abf",1623:"71e949d7",1642:"64bd8bad",1695:"5e01f171",1724:"dff1c289",1743:"5ee7b1bc",1800:"8ebd32b9",1808:"8a376d68",1831:"b8b00aea",1865:"037298f3",1903:"acecf23e",1939:"4689dc6f",1953:"1e4232ab",1972:"73664a40",1974:"5c868d36",2007:"402fd8ec",2040:"82a3a055",2081:"ea673145",2119:"7e283186",2138:"1a4e3797",2147:"57a2de75",2166:"28a4b851",2193:"b998fb11",2254:"52eba09e",2392:"91a766d9",2419:"0730592b",2426:"792432d4",2484:"c9540765",2513:"c7b94894",2534:"a0ef4106",2711:"9e4087bc",2748:"822bd8ab",2801:"3edf7b61",2848:"d88d39d7",2866:"2ca4460e",2884:"f1169565",2910:"9d5f1ccb",2987:"6cdb92a9",3003:"3486d072",3098:"533a09ca",3128:"9ab3d06b",3177:"29a49838",3249:"ccc49370",3268:"465af148",3272:"437a86f0",3276:"e5aefb32",3354:"9bd6a0c8",3370:"b764c1e9",3371:"ed88e295",3534:"2f74e3d4",3605:"b123e85d",3637:"f4f34a3a",3689:"9403ec86",3694:"8717b14a",3703:"9aa93c82",3755:"0b9397d6",3795:"72bcfeeb",3809:"6b7169bc",3814:"5f617a4c",3976:"0e384e19",4014:"c37329a9",4113:"fd96faf0",4125:"d47ac4be",4134:"393be207",4171:"ef89b32c",4212:"621db11d",4332:"27075183",4424:"00f29cf5",4453:"fbf304ed",4508:"099caee3",4583:"1df93b7f",4584:"f82cd581",4696:"8a0e406a",4711:"54d2ec5f",4736:"e44a2883",4813:"6875c492",4940:"1061d0cb",4941:"f5760147",4994:"b182beed",5003:"e60aee91",5029:"081c0950",5107:"edc18652",5136:"f4e478b9",5181:"d23fc473",5235:"a3711c17",5293:"6bd61230",5341:"2d4ad45f",5352:"73d41d19",5384:"d58e3925",5438:"dbe3b6b9",5451:"eaab7dd2",5557:"d9f32620",5626:"279c9f30",5653:"171e0138",5742:"aba21aa0",5939:"e4469e1d",5972:"73c627ad",6002:"60b52a9d",6052:"f38ef2c2",6061:"1f391b9e",6067:"7628d2f1",6155:"6f941ca8",6262:"a8e44dab",6283:"f2171f78",6290:"6afe94c3",6315:"468b357e",6336:"846f0159",6377:"0274794e",6403:"0bf84b24",6463:"fb1af417",6482:"b898f833",6496:"54b7f2e2",6521:"6de276b4",6555:"80965edc",6611:"be8c3764",6629:"dee01960",6647:"6679ae86",6724:"5471f4ea",6785:"b2cda8ff",6851:"79bb96de",6854:"bc6fb640",6909:"bd5628fe",6934:"ee112ecc",6956:"484e5a84",6969:"14eb3368",7098:"a7bd4aaa",7157:"7d55d1f2",7180:"11347dcd",7347:"b4b23ab8",7472:"814f3328",7492:"ae1c8c73",7513:"c26b1eba",7569:"fb5cf5eb",7615:"5ebba8c8",7643:"a6aa9e1f",7657:"6844db42",7746:"a08b55b4",7807:"6922041d",7856:"6dda1eb8",7898:"acb0ea1f",8025:"5e90a9b3",8121:"3a2db09e",8130:"f81c1134",8146:"c15d9823",8209:"01a85c17",8223:"3bb4bcf6",8283:"52c02df4",8394:"e541f69e",8401:"17896441",8405:"c939f76a",8437:"a4a33699",8444:"60a6a9a9",8462:"3217192f",8512:"4640f537",8518:"6bb166bd",8563:"8ee4cc26",8609:"925b3f96",8629:"fc7d6c3b",8726:"7c769d76",8737:"7661071f",8745:"26af37c4",8773:"6b55e007",8860:"b7596626",8863:"f55d3e7a",8867:"4197358a",8924:"f3df8bb0",8947:"ef8b811a",8976:"83d3b456",9048:"a94703ab",9094:"ffc4ade8",9099:"9a514765",9153:"95628813",9160:"146bd2aa",9178:"3de6a3bc",9223:"4bc6cdf6",9242:"1a3c9b31",9262:"18c41134",9306:"cdd11b4d",9325:"59362658",9328:"e273c56f",9457:"b27ebe52",9466:"ce48d423",9486:"b430c9d2",9498:"cce945f2",9544:"0a59a0e8",9571:"0523356b",9584:"f0def62b",9596:"8fbd3a7f",9647:"5e95c892",9745:"c1aedf5a",9761:"c1f86f2f",9772:"af80f1f3",9837:"00c93e1e",9850:"5f2ffadc",9858:"36994c47",9940:"eaeca54c",9969:"cb21221e"}[e]||e)+"."+{16:"5ad660fc",52:"7e871094",57:"3ac3c63e",70:"d9831f34",86:"b1767845",143:"6de28be0",240:"da53d01f",283:"0c549f4f",314:"e1b179c1",416:"5a82d981",452:"77f151d7",487:"9a5aa647",488:"acf0ff25",493:"4712b340",523:"2392845d",583:"5719f9c8",594:"d63c5195",599:"16192ef7",626:"3673aca5",707:"96eb9701",727:"f04fd0d6",730:"6ba2bf88",747:"2ae081f3",809:"19180b4d",815:"939b9cd9",843:"4e532bcd",845:"c31ced0d",849:"15fd0581",858:"60a283f8",907:"ce595156",957:"faee654a",974:"a3fb4b8e",986:"309c211d",990:"7116f975",998:"fc992260",1082:"4b1210e8",1121:"2d19b10b",1124:"66793c62",1128:"7c9aaba5",1181:"c397b34f",1207:"d2a2c419",1235:"5f9bbb01",1237:"9ecb4ad7",1302:"d86f43a0",1359:"6ba92497",1397:"2b30ece9",1399:"77b72d3d",1422:"3c725206",1425:"e7aa6c9f",1482:"1980830c",1530:"be8a3dc0",1536:"59242b76",1543:"ee9cc9b2",1619:"aef40189",1623:"c6634281",1642:"53e0b372",1695:"06ef2318",1724:"73eb9fd9",1743:"39dd45a6",1800:"dede4af1",1808:"2b5faabb",1831:"a4e761ec",1865:"7553f4a9",1903:"28f9a35b",1939:"f387a73a",1953:"b0295233",1972:"9cfceefb",1974:"3a87f299",2007:"2a92274b",2040:"f88e227f",2081:"679a643c",2100:"f13739dd",2119:"b751a54a",2138:"02b74727",2147:"0d0a825e",2166:"f353467f",2193:"61639bbe",2237:"d04cc86f",2254:"4c178fd9",2392:"b753baa1",2419:"4ac101ff",2426:"a3d18f27",2484:"e38e5f19",2513:"fdd048b9",2534:"5522adde",2711:"16fcacde",2748:"85ed4075",2801:"8e14edf3",2848:"c132566b",2866:"84324a86",2884:"fca6f86d",2910:"8fc0cc25",2987:"b36632c4",3003:"35bab741",3098:"49d34c80",3128:"7123835a",3177:"d5ac135d",3249:"7c7835f3",3268:"5e619ea8",3272:"14700e56",3276:"33ae4d86",3347:"84a47663",3354:"46c7e544",3370:"bdb80b5b",3371:"f90d3f45",3534:"fd5601b8",3605:"080a741c",3637:"4b29f9eb",3689:"0ab4953e",3694:"f7bc5287",3703:"0bff8758",3755:"e34a1d30",3795:"cabe5abe",3809:"8db70c62",3814:"66e75767",3976:"ba1fb42e",4014:"c36b1777",4113:"b042e38b",4125:"39498563",4134:"2acfc4f8",4171:"da99c7e9",4212:"341497fe",4332:"92347087",4424:"7a0dcdd3",4453:"f6e788fb",4508:"374cc4e2",4583:"8004974f",4584:"c160cd7f",4696:"3e5885ab",4711:"1c9453c5",4736:"8fd63ee4",4813:"a128b6b9",4940:"31cb50a5",4941:"af8bd080",4994:"56541c81",5003:"d19463e9",5029:"57f463bf",5107:"de95958c",5136:"0a57b1bd",5181:"1fcf6734",5235:"a78d151a",5293:"d3c0ee7b",5341:"24a9ec9c",5352:"da269f44",5384:"c4d1b65e",5438:"496fb1b0",5451:"75a458ed",5557:"aff62161",5626:"0b9ae964",5653:"e960842a",5742:"ed09cce9",5939:"2ce84520",5972:"610d16b0",6002:"77934ac5",6052:"db37bc96",6061:"c8f48283",6067:"6ea6096a",6155:"1395f5c1",6262:"a0444047",6283:"f9ee9fb5",6290:"8f2cd245",6315:"d4659f6f",6336:"4cf5f151",6377:"11ea20e1",6403:"2959e6cc",6463:"385f2e7a",6482:"858d2f74",6496:"1f7f3a9c",6521:"77777957",6555:"7ac73897",6611:"a5fb93a7",6629:"4b4e298f",6647:"26e55848",6724:"507f3066",6785:"2fcc78bf",6851:"a40a46d6",6854:"0a03c761",6909:"8f7aafe3",6934:"7c0096a2",6956:"be42c8e7",6969:"de016bf0",7098:"652b26b5",7157:"352f6aa2",7180:"53e5a85c",7347:"f5f08a1b",7472:"c006fd3d",7492:"414adc65",7513:"3d17a7ca",7569:"f8677f77",7615:"b0f328c5",7643:"b4bffb9d",7657:"fd2f680d",7746:"5d84fe8c",7807:"56e82e81",7856:"ab42b8ef",7898:"83caf7e2",8025:"111c581f",8121:"39dab5fe",8130:"06ae688e",8146:"a40c7001",8158:"988a33bb",8209:"c9b7e3d3",8223:"40529326",8283:"fa1f6eb9",8307:"561aafc9",8394:"fcea3fbe",8401:"1f139e5a",8405:"2572ef50",8437:"6836815f",8444:"2a5c11e4",8462:"f67096cb",8512:"e01f4009",8518:"ff0a2245",8563:"a5cff998",8609:"7a10af78",8629:"be712c6c",8726:"eb690d6c",8737:"0c27915b",8745:"17b0cee8",8773:"d0dcbeeb",8860:"827e88f9",8863:"4ed244b5",8867:"68e80e67",8913:"64e5ee35",8924:"ebe2b092",8947:"59f84152",8976:"58fd577f",9048:"33ca7509",9094:"df3ec751",9099:"557cdb64",9153:"855b7d85",9160:"7bb58db7",9178:"879d8e03",9223:"ba06eb86",9242:"635b2b30",9262:"ab323e10",9306:"4b76fa77",9325:"2b3b4a54",9328:"ed8c55c1",9457:"6f81f2dc",9466:"412a62ed",9486:"99d9e928",9498:"0b73c9ef",9544:"b4ded237",9571:"db81533b",9584:"16f049ad",9596:"78c6e3ec",9647:"021b48f6",9745:"e363ee7d",9761:"9f85142a",9772:"2d454e9c",9837:"24856d6e",9850:"aec42721",9858:"337a7516",9940:"bd7f869d",9969:"e50fd5c8"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},c="docs:",r.l=(e,a,b,d)=>{if(f[e])f[e].push(a);else{var t,o;if(void 0!==b)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var c=f[e];if(delete f[e],t.parentNode&&t.parentNode.removeChild(t),c&&c.forEach((e=>e(b))),a)return a(b)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=l.bind(null,t.onerror),t.onload=l.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.p="/",r.gca=function(e){return e={17896441:"8401",18336523:"240",27075183:"4332",59362658:"9325",95628813:"9153","0e0f73c7":"16",f3fdb01a:"52","1df732fe":"57",bb20bb94:"70","58bfaad8":"86",b868a84c:"143","155c8334":"283","1454731d":"314",d42a3ae7:"452","2b136cef":"487","98c048de":"488","4b6dedc4":"493",b8787afe:"523",f22ab3cc:"583","5e8c322a":"594","0d1f64ba":"599","20288d3d":"626","5fd2b997":"707","70bd31a0":"727","2fc4fc5f":"730","29b289c3":"747","150e319f":"809","428f4992":"815","20fe70bf":"843",c8a4e95a:"845","0058b4c6":"849","2eaaacd8":"858","5cc50a6c":"907",c141421f:"957","18ad8d0a":"974","29fec1eb":"986","0d185c55":"990","6f5ae7fe":"998",d6466469:"1082","745741e5":"1121","4a1784a5":"1124",b35003cc:"1128","3d3a9b6d":"1181","1025625c":"1207",a7456010:"1235",a485a49d:"1237","901c4e03":"1302","45205a09":"1359","8997cb84":"1397",eff1717c:"1399",b0030a2c:"1422",edb57414:"1425","0057296d":"1482","1c28c6e3":"1530","7803af04":"1536","0673617b":"1543",f47e5abf:"1619","71e949d7":"1623","64bd8bad":"1642","5e01f171":"1695",dff1c289:"1724","5ee7b1bc":"1743","8ebd32b9":"1800","8a376d68":"1808",b8b00aea:"1831","037298f3":"1865",acecf23e:"1903","4689dc6f":"1939","1e4232ab":"1953","73664a40":"1972","5c868d36":"1974","402fd8ec":"2007","82a3a055":"2040",ea673145:"2081","7e283186":"2119","1a4e3797":"2138","57a2de75":"2147","28a4b851":"2166",b998fb11:"2193","52eba09e":"2254","91a766d9":"2392","0730592b":"2419","792432d4":"2426",c9540765:"2484",c7b94894:"2513",a0ef4106:"2534","9e4087bc":"2711","822bd8ab":"2748","3edf7b61":"2801",d88d39d7:"2848","2ca4460e":"2866",f1169565:"2884","9d5f1ccb":"2910","6cdb92a9":"2987","3486d072":"3003","533a09ca":"3098","9ab3d06b":"3128","29a49838":"3177",ccc49370:"3249","465af148":"3268","437a86f0":"3272",e5aefb32:"3276","9bd6a0c8":"3354",b764c1e9:"3370",ed88e295:"3371","2f74e3d4":"3534",b123e85d:"3605",f4f34a3a:"3637","9403ec86":"3689","8717b14a":"3694","9aa93c82":"3703","0b9397d6":"3755","72bcfeeb":"3795","6b7169bc":"3809","5f617a4c":"3814","0e384e19":"3976",c37329a9:"4014",fd96faf0:"4113",d47ac4be:"4125","393be207":"4134",ef89b32c:"4171","621db11d":"4212","00f29cf5":"4424",fbf304ed:"4453","099caee3":"4508","1df93b7f":"4583",f82cd581:"4584","8a0e406a":"4696","54d2ec5f":"4711",e44a2883:"4736","6875c492":"4813","1061d0cb":"4940",f5760147:"4941",b182beed:"4994",e60aee91:"5003","081c0950":"5029",edc18652:"5107",f4e478b9:"5136",d23fc473:"5181",a3711c17:"5235","6bd61230":"5293","2d4ad45f":"5341","73d41d19":"5352",d58e3925:"5384",dbe3b6b9:"5438",eaab7dd2:"5451",d9f32620:"5557","279c9f30":"5626","171e0138":"5653",aba21aa0:"5742",e4469e1d:"5939","73c627ad":"5972","60b52a9d":"6002",f38ef2c2:"6052","1f391b9e":"6061","7628d2f1":"6067","6f941ca8":"6155",a8e44dab:"6262",f2171f78:"6283","6afe94c3":"6290","468b357e":"6315","846f0159":"6336","0274794e":"6377","0bf84b24":"6403",fb1af417:"6463",b898f833:"6482","54b7f2e2":"6496","6de276b4":"6521","80965edc":"6555",be8c3764:"6611",dee01960:"6629","6679ae86":"6647","5471f4ea":"6724",b2cda8ff:"6785","79bb96de":"6851",bc6fb640:"6854",bd5628fe:"6909",ee112ecc:"6934","484e5a84":"6956","14eb3368":"6969",a7bd4aaa:"7098","7d55d1f2":"7157","11347dcd":"7180",b4b23ab8:"7347","814f3328":"7472",ae1c8c73:"7492",c26b1eba:"7513",fb5cf5eb:"7569","5ebba8c8":"7615",a6aa9e1f:"7643","6844db42":"7657",a08b55b4:"7746","6922041d":"7807","6dda1eb8":"7856",acb0ea1f:"7898","5e90a9b3":"8025","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","01a85c17":"8209","3bb4bcf6":"8223","52c02df4":"8283",e541f69e:"8394",c939f76a:"8405",a4a33699:"8437","60a6a9a9":"8444","3217192f":"8462","4640f537":"8512","6bb166bd":"8518","8ee4cc26":"8563","925b3f96":"8609",fc7d6c3b:"8629","7c769d76":"8726","7661071f":"8737","26af37c4":"8745","6b55e007":"8773",b7596626:"8860",f55d3e7a:"8863","4197358a":"8867",f3df8bb0:"8924",ef8b811a:"8947","83d3b456":"8976",a94703ab:"9048",ffc4ade8:"9094","9a514765":"9099","146bd2aa":"9160","3de6a3bc":"9178","4bc6cdf6":"9223","1a3c9b31":"9242","18c41134":"9262",cdd11b4d:"9306",e273c56f:"9328",b27ebe52:"9457",ce48d423:"9466",b430c9d2:"9486",cce945f2:"9498","0a59a0e8":"9544","0523356b":"9571",f0def62b:"9584","8fbd3a7f":"9596","5e95c892":"9647",c1aedf5a:"9745",c1f86f2f:"9761",af80f1f3:"9772","00c93e1e":"9837","5f2ffadc":"9850","36994c47":"9858",eaeca54c:"9940",cb21221e:"9969"}[e]||e,r.p+r.u(e)},(()=>{var e={5354:0,1869:0};r.f.j=(a,b)=>{var f=r.o(e,a)?e[a]:void 0;if(0!==f)if(f)b.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var c=new Promise(((b,c)=>f=e[a]=[b,c]));b.push(f[2]=c);var d=r.p+r.u(a),t=new Error;r.l(d,(b=>{if(r.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var c=b&&("load"===b.type?"missing":b.type),d=b&&b.target&&b.target.src;t.message="Loading chunk "+a+" failed.\n("+c+": "+d+")",t.name="ChunkLoadError",t.type=c,t.request=d,f[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,b)=>{var f,c,d=b[0],t=b[1],o=b[2],n=0;if(d.some((a=>0!==e[a]))){for(f in t)r.o(t,f)&&(r.m[f]=t[f]);if(o)var i=o(r)}for(a&&a(b);n{"use strict";var e,a,b,f,c,d={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var b=t[e]={id:e,loaded:!1,exports:{}};return d[e].call(b.exports,b,b.exports,r),b.loaded=!0,b.exports}r.m=d,r.c=t,e=[],r.O=(a,b,f,c)=>{if(!b){var d=1/0;for(i=0;i=c)&&Object.keys(r.O).every((e=>r.O[e](b[o])))?b.splice(o--,1):(t=!1,c0&&e[i-1][2]>c;i--)e[i]=e[i-1];e[i]=[b,f,c]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},b=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var c=Object.create(null);r.r(c);var d={};a=a||[null,b({}),b([]),b(b)];for(var t=2&f&&e;"object"==typeof t&&!~a.indexOf(t);t=b(t))Object.getOwnPropertyNames(t).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,r.d(c,d),c},r.d=(e,a)=>{for(var b in a)r.o(a,b)&&!r.o(e,b)&&Object.defineProperty(e,b,{enumerable:!0,get:a[b]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,b)=>(r.f[b](e,a),a)),[])),r.u=e=>"assets/js/"+({16:"0e0f73c7",52:"f3fdb01a",57:"1df732fe",70:"bb20bb94",86:"58bfaad8",143:"b868a84c",240:"18336523",283:"155c8334",314:"1454731d",452:"d42a3ae7",487:"2b136cef",488:"98c048de",493:"4b6dedc4",523:"b8787afe",583:"f22ab3cc",594:"5e8c322a",599:"0d1f64ba",626:"20288d3d",707:"5fd2b997",727:"70bd31a0",730:"2fc4fc5f",747:"29b289c3",809:"150e319f",815:"428f4992",843:"20fe70bf",845:"c8a4e95a",849:"0058b4c6",858:"2eaaacd8",907:"5cc50a6c",957:"c141421f",974:"18ad8d0a",986:"29fec1eb",990:"0d185c55",998:"6f5ae7fe",1082:"d6466469",1121:"745741e5",1124:"4a1784a5",1128:"b35003cc",1181:"3d3a9b6d",1207:"1025625c",1235:"a7456010",1237:"a485a49d",1302:"901c4e03",1359:"45205a09",1397:"8997cb84",1399:"eff1717c",1422:"b0030a2c",1425:"edb57414",1482:"0057296d",1530:"1c28c6e3",1536:"7803af04",1543:"0673617b",1619:"f47e5abf",1623:"71e949d7",1642:"64bd8bad",1695:"5e01f171",1724:"dff1c289",1743:"5ee7b1bc",1800:"8ebd32b9",1808:"8a376d68",1831:"b8b00aea",1865:"037298f3",1903:"acecf23e",1939:"4689dc6f",1953:"1e4232ab",1972:"73664a40",1974:"5c868d36",2007:"402fd8ec",2040:"82a3a055",2081:"ea673145",2119:"7e283186",2138:"1a4e3797",2147:"57a2de75",2166:"28a4b851",2193:"b998fb11",2254:"52eba09e",2392:"91a766d9",2419:"0730592b",2426:"792432d4",2484:"c9540765",2513:"c7b94894",2534:"a0ef4106",2711:"9e4087bc",2748:"822bd8ab",2801:"3edf7b61",2848:"d88d39d7",2866:"2ca4460e",2884:"f1169565",2910:"9d5f1ccb",2987:"6cdb92a9",3003:"3486d072",3098:"533a09ca",3128:"9ab3d06b",3177:"29a49838",3249:"ccc49370",3268:"465af148",3272:"437a86f0",3276:"e5aefb32",3354:"9bd6a0c8",3370:"b764c1e9",3371:"ed88e295",3534:"2f74e3d4",3605:"b123e85d",3637:"f4f34a3a",3689:"9403ec86",3694:"8717b14a",3703:"9aa93c82",3755:"0b9397d6",3795:"72bcfeeb",3809:"6b7169bc",3814:"5f617a4c",3976:"0e384e19",4014:"c37329a9",4113:"fd96faf0",4125:"d47ac4be",4134:"393be207",4171:"ef89b32c",4212:"621db11d",4332:"27075183",4424:"00f29cf5",4453:"fbf304ed",4508:"099caee3",4583:"1df93b7f",4584:"f82cd581",4696:"8a0e406a",4711:"54d2ec5f",4736:"e44a2883",4813:"6875c492",4940:"1061d0cb",4941:"f5760147",4994:"b182beed",5003:"e60aee91",5029:"081c0950",5107:"edc18652",5136:"f4e478b9",5181:"d23fc473",5235:"a3711c17",5293:"6bd61230",5341:"2d4ad45f",5352:"73d41d19",5384:"d58e3925",5438:"dbe3b6b9",5451:"eaab7dd2",5557:"d9f32620",5626:"279c9f30",5653:"171e0138",5742:"aba21aa0",5939:"e4469e1d",5972:"73c627ad",6002:"60b52a9d",6052:"f38ef2c2",6061:"1f391b9e",6067:"7628d2f1",6155:"6f941ca8",6262:"a8e44dab",6283:"f2171f78",6290:"6afe94c3",6315:"468b357e",6336:"846f0159",6377:"0274794e",6403:"0bf84b24",6463:"fb1af417",6482:"b898f833",6496:"54b7f2e2",6521:"6de276b4",6555:"80965edc",6611:"be8c3764",6629:"dee01960",6647:"6679ae86",6724:"5471f4ea",6785:"b2cda8ff",6851:"79bb96de",6854:"bc6fb640",6909:"bd5628fe",6934:"ee112ecc",6956:"484e5a84",6969:"14eb3368",7098:"a7bd4aaa",7157:"7d55d1f2",7180:"11347dcd",7347:"b4b23ab8",7472:"814f3328",7492:"ae1c8c73",7513:"c26b1eba",7569:"fb5cf5eb",7615:"5ebba8c8",7643:"a6aa9e1f",7657:"6844db42",7746:"a08b55b4",7807:"6922041d",7856:"6dda1eb8",7898:"acb0ea1f",8025:"5e90a9b3",8121:"3a2db09e",8130:"f81c1134",8146:"c15d9823",8209:"01a85c17",8223:"3bb4bcf6",8283:"52c02df4",8394:"e541f69e",8401:"17896441",8405:"c939f76a",8437:"a4a33699",8444:"60a6a9a9",8462:"3217192f",8512:"4640f537",8518:"6bb166bd",8563:"8ee4cc26",8609:"925b3f96",8629:"fc7d6c3b",8726:"7c769d76",8737:"7661071f",8745:"26af37c4",8773:"6b55e007",8860:"b7596626",8863:"f55d3e7a",8867:"4197358a",8924:"f3df8bb0",8947:"ef8b811a",8976:"83d3b456",9048:"a94703ab",9094:"ffc4ade8",9099:"9a514765",9153:"95628813",9160:"146bd2aa",9178:"3de6a3bc",9223:"4bc6cdf6",9242:"1a3c9b31",9262:"18c41134",9306:"cdd11b4d",9325:"59362658",9328:"e273c56f",9457:"b27ebe52",9466:"ce48d423",9486:"b430c9d2",9498:"cce945f2",9544:"0a59a0e8",9571:"0523356b",9584:"f0def62b",9596:"8fbd3a7f",9647:"5e95c892",9745:"c1aedf5a",9761:"c1f86f2f",9772:"af80f1f3",9837:"00c93e1e",9850:"5f2ffadc",9858:"36994c47",9940:"eaeca54c",9969:"cb21221e"}[e]||e)+"."+{16:"5ad660fc",52:"7e871094",57:"3ac3c63e",70:"d9831f34",86:"b1767845",143:"6de28be0",240:"da53d01f",283:"0c549f4f",314:"e1b179c1",416:"5a82d981",452:"77f151d7",487:"9a5aa647",488:"acf0ff25",493:"4712b340",523:"2392845d",583:"5719f9c8",594:"d63c5195",599:"16192ef7",626:"3673aca5",707:"96eb9701",727:"f04fd0d6",730:"6ba2bf88",747:"2ae081f3",809:"19180b4d",815:"939b9cd9",843:"4e532bcd",845:"c31ced0d",849:"f392e14b",858:"60a283f8",907:"ce595156",957:"faee654a",974:"a3fb4b8e",986:"309c211d",990:"7116f975",998:"b3815040",1082:"4b1210e8",1121:"2d19b10b",1124:"66793c62",1128:"7c9aaba5",1181:"c397b34f",1207:"d2a2c419",1235:"5f9bbb01",1237:"9ecb4ad7",1302:"d86f43a0",1359:"6ba92497",1397:"2b30ece9",1399:"77b72d3d",1422:"3c725206",1425:"e7aa6c9f",1482:"1980830c",1530:"be8a3dc0",1536:"59242b76",1543:"ee9cc9b2",1619:"aef40189",1623:"c6634281",1642:"53e0b372",1695:"06ef2318",1724:"73eb9fd9",1743:"39dd45a6",1800:"dede4af1",1808:"2b5faabb",1831:"a4e761ec",1865:"7553f4a9",1903:"28f9a35b",1939:"f387a73a",1953:"b0295233",1972:"9cfceefb",1974:"3a87f299",2007:"2a92274b",2040:"f88e227f",2081:"679a643c",2100:"f13739dd",2119:"b751a54a",2138:"02b74727",2147:"0d0a825e",2166:"f353467f",2193:"61639bbe",2237:"d04cc86f",2254:"4c178fd9",2392:"b753baa1",2419:"4ac101ff",2426:"a3d18f27",2484:"e38e5f19",2513:"fdd048b9",2534:"5522adde",2711:"16fcacde",2748:"85ed4075",2801:"8e14edf3",2848:"c132566b",2866:"84324a86",2884:"fca6f86d",2910:"8fc0cc25",2987:"b36632c4",3003:"35bab741",3098:"49d34c80",3128:"7123835a",3177:"d5ac135d",3249:"7c7835f3",3268:"5e619ea8",3272:"14700e56",3276:"33ae4d86",3347:"84a47663",3354:"46c7e544",3370:"bdb80b5b",3371:"f90d3f45",3534:"fd5601b8",3605:"080a741c",3637:"4b29f9eb",3689:"0ab4953e",3694:"f7bc5287",3703:"0bff8758",3755:"e34a1d30",3795:"cabe5abe",3809:"8db70c62",3814:"66e75767",3976:"ba1fb42e",4014:"c36b1777",4113:"b042e38b",4125:"39498563",4134:"2acfc4f8",4171:"da99c7e9",4212:"341497fe",4332:"92347087",4424:"7a0dcdd3",4453:"f6e788fb",4508:"374cc4e2",4583:"8004974f",4584:"c160cd7f",4696:"3e5885ab",4711:"1c9453c5",4736:"8fd63ee4",4813:"a128b6b9",4940:"31cb50a5",4941:"af8bd080",4994:"56541c81",5003:"d19463e9",5029:"57f463bf",5107:"de95958c",5136:"0a57b1bd",5181:"1fcf6734",5235:"a78d151a",5293:"d3c0ee7b",5341:"24a9ec9c",5352:"da269f44",5384:"c4d1b65e",5438:"496fb1b0",5451:"75a458ed",5557:"aff62161",5626:"0b9ae964",5653:"e960842a",5742:"ed09cce9",5939:"2ce84520",5972:"610d16b0",6002:"77934ac5",6052:"db37bc96",6061:"c8f48283",6067:"6ea6096a",6155:"1395f5c1",6262:"a0444047",6283:"f9ee9fb5",6290:"8f2cd245",6315:"d4659f6f",6336:"4cf5f151",6377:"c7d6f30b",6403:"2959e6cc",6463:"385f2e7a",6482:"858d2f74",6496:"1f7f3a9c",6521:"77777957",6555:"7ac73897",6611:"a5fb93a7",6629:"4b4e298f",6647:"26e55848",6724:"507f3066",6785:"2fcc78bf",6851:"a40a46d6",6854:"0a03c761",6909:"8f7aafe3",6934:"7c0096a2",6956:"be42c8e7",6969:"de016bf0",7098:"652b26b5",7157:"352f6aa2",7180:"53e5a85c",7347:"f5f08a1b",7472:"c006fd3d",7492:"414adc65",7513:"3d17a7ca",7569:"f8677f77",7615:"b0f328c5",7643:"b4bffb9d",7657:"fd2f680d",7746:"5d84fe8c",7807:"56e82e81",7856:"ab42b8ef",7898:"83caf7e2",8025:"111c581f",8121:"39dab5fe",8130:"06ae688e",8146:"a40c7001",8158:"988a33bb",8209:"c9b7e3d3",8223:"40529326",8283:"fa1f6eb9",8307:"561aafc9",8394:"fcea3fbe",8401:"1f139e5a",8405:"2572ef50",8437:"6836815f",8444:"2a5c11e4",8462:"f67096cb",8512:"e01f4009",8518:"ff0a2245",8563:"a5cff998",8609:"7a10af78",8629:"be712c6c",8726:"eb690d6c",8737:"0c27915b",8745:"2cfdf6c1",8773:"d0dcbeeb",8860:"827e88f9",8863:"4ed244b5",8867:"68e80e67",8913:"64e5ee35",8924:"ebe2b092",8947:"59f84152",8976:"58fd577f",9048:"33ca7509",9094:"df3ec751",9099:"557cdb64",9153:"855b7d85",9160:"7bb58db7",9178:"879d8e03",9223:"ba06eb86",9242:"f2e512af",9262:"ab323e10",9306:"4b76fa77",9325:"2b3b4a54",9328:"ed8c55c1",9457:"6f81f2dc",9466:"412a62ed",9486:"99d9e928",9498:"0b73c9ef",9544:"b4ded237",9571:"db81533b",9584:"16f049ad",9596:"78c6e3ec",9647:"021b48f6",9745:"e363ee7d",9761:"9f85142a",9772:"2d454e9c",9837:"24856d6e",9850:"aec42721",9858:"337a7516",9940:"bd7f869d",9969:"e50fd5c8"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},c="docs:",r.l=(e,a,b,d)=>{if(f[e])f[e].push(a);else{var t,o;if(void 0!==b)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var c=f[e];if(delete f[e],t.parentNode&&t.parentNode.removeChild(t),c&&c.forEach((e=>e(b))),a)return a(b)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=l.bind(null,t.onerror),t.onload=l.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.p="/",r.gca=function(e){return e={17896441:"8401",18336523:"240",27075183:"4332",59362658:"9325",95628813:"9153","0e0f73c7":"16",f3fdb01a:"52","1df732fe":"57",bb20bb94:"70","58bfaad8":"86",b868a84c:"143","155c8334":"283","1454731d":"314",d42a3ae7:"452","2b136cef":"487","98c048de":"488","4b6dedc4":"493",b8787afe:"523",f22ab3cc:"583","5e8c322a":"594","0d1f64ba":"599","20288d3d":"626","5fd2b997":"707","70bd31a0":"727","2fc4fc5f":"730","29b289c3":"747","150e319f":"809","428f4992":"815","20fe70bf":"843",c8a4e95a:"845","0058b4c6":"849","2eaaacd8":"858","5cc50a6c":"907",c141421f:"957","18ad8d0a":"974","29fec1eb":"986","0d185c55":"990","6f5ae7fe":"998",d6466469:"1082","745741e5":"1121","4a1784a5":"1124",b35003cc:"1128","3d3a9b6d":"1181","1025625c":"1207",a7456010:"1235",a485a49d:"1237","901c4e03":"1302","45205a09":"1359","8997cb84":"1397",eff1717c:"1399",b0030a2c:"1422",edb57414:"1425","0057296d":"1482","1c28c6e3":"1530","7803af04":"1536","0673617b":"1543",f47e5abf:"1619","71e949d7":"1623","64bd8bad":"1642","5e01f171":"1695",dff1c289:"1724","5ee7b1bc":"1743","8ebd32b9":"1800","8a376d68":"1808",b8b00aea:"1831","037298f3":"1865",acecf23e:"1903","4689dc6f":"1939","1e4232ab":"1953","73664a40":"1972","5c868d36":"1974","402fd8ec":"2007","82a3a055":"2040",ea673145:"2081","7e283186":"2119","1a4e3797":"2138","57a2de75":"2147","28a4b851":"2166",b998fb11:"2193","52eba09e":"2254","91a766d9":"2392","0730592b":"2419","792432d4":"2426",c9540765:"2484",c7b94894:"2513",a0ef4106:"2534","9e4087bc":"2711","822bd8ab":"2748","3edf7b61":"2801",d88d39d7:"2848","2ca4460e":"2866",f1169565:"2884","9d5f1ccb":"2910","6cdb92a9":"2987","3486d072":"3003","533a09ca":"3098","9ab3d06b":"3128","29a49838":"3177",ccc49370:"3249","465af148":"3268","437a86f0":"3272",e5aefb32:"3276","9bd6a0c8":"3354",b764c1e9:"3370",ed88e295:"3371","2f74e3d4":"3534",b123e85d:"3605",f4f34a3a:"3637","9403ec86":"3689","8717b14a":"3694","9aa93c82":"3703","0b9397d6":"3755","72bcfeeb":"3795","6b7169bc":"3809","5f617a4c":"3814","0e384e19":"3976",c37329a9:"4014",fd96faf0:"4113",d47ac4be:"4125","393be207":"4134",ef89b32c:"4171","621db11d":"4212","00f29cf5":"4424",fbf304ed:"4453","099caee3":"4508","1df93b7f":"4583",f82cd581:"4584","8a0e406a":"4696","54d2ec5f":"4711",e44a2883:"4736","6875c492":"4813","1061d0cb":"4940",f5760147:"4941",b182beed:"4994",e60aee91:"5003","081c0950":"5029",edc18652:"5107",f4e478b9:"5136",d23fc473:"5181",a3711c17:"5235","6bd61230":"5293","2d4ad45f":"5341","73d41d19":"5352",d58e3925:"5384",dbe3b6b9:"5438",eaab7dd2:"5451",d9f32620:"5557","279c9f30":"5626","171e0138":"5653",aba21aa0:"5742",e4469e1d:"5939","73c627ad":"5972","60b52a9d":"6002",f38ef2c2:"6052","1f391b9e":"6061","7628d2f1":"6067","6f941ca8":"6155",a8e44dab:"6262",f2171f78:"6283","6afe94c3":"6290","468b357e":"6315","846f0159":"6336","0274794e":"6377","0bf84b24":"6403",fb1af417:"6463",b898f833:"6482","54b7f2e2":"6496","6de276b4":"6521","80965edc":"6555",be8c3764:"6611",dee01960:"6629","6679ae86":"6647","5471f4ea":"6724",b2cda8ff:"6785","79bb96de":"6851",bc6fb640:"6854",bd5628fe:"6909",ee112ecc:"6934","484e5a84":"6956","14eb3368":"6969",a7bd4aaa:"7098","7d55d1f2":"7157","11347dcd":"7180",b4b23ab8:"7347","814f3328":"7472",ae1c8c73:"7492",c26b1eba:"7513",fb5cf5eb:"7569","5ebba8c8":"7615",a6aa9e1f:"7643","6844db42":"7657",a08b55b4:"7746","6922041d":"7807","6dda1eb8":"7856",acb0ea1f:"7898","5e90a9b3":"8025","3a2db09e":"8121",f81c1134:"8130",c15d9823:"8146","01a85c17":"8209","3bb4bcf6":"8223","52c02df4":"8283",e541f69e:"8394",c939f76a:"8405",a4a33699:"8437","60a6a9a9":"8444","3217192f":"8462","4640f537":"8512","6bb166bd":"8518","8ee4cc26":"8563","925b3f96":"8609",fc7d6c3b:"8629","7c769d76":"8726","7661071f":"8737","26af37c4":"8745","6b55e007":"8773",b7596626:"8860",f55d3e7a:"8863","4197358a":"8867",f3df8bb0:"8924",ef8b811a:"8947","83d3b456":"8976",a94703ab:"9048",ffc4ade8:"9094","9a514765":"9099","146bd2aa":"9160","3de6a3bc":"9178","4bc6cdf6":"9223","1a3c9b31":"9242","18c41134":"9262",cdd11b4d:"9306",e273c56f:"9328",b27ebe52:"9457",ce48d423:"9466",b430c9d2:"9486",cce945f2:"9498","0a59a0e8":"9544","0523356b":"9571",f0def62b:"9584","8fbd3a7f":"9596","5e95c892":"9647",c1aedf5a:"9745",c1f86f2f:"9761",af80f1f3:"9772","00c93e1e":"9837","5f2ffadc":"9850","36994c47":"9858",eaeca54c:"9940",cb21221e:"9969"}[e]||e,r.p+r.u(e)},(()=>{var e={5354:0,1869:0};r.f.j=(a,b)=>{var f=r.o(e,a)?e[a]:void 0;if(0!==f)if(f)b.push(f[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var c=new Promise(((b,c)=>f=e[a]=[b,c]));b.push(f[2]=c);var d=r.p+r.u(a),t=new Error;r.l(d,(b=>{if(r.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var c=b&&("load"===b.type?"missing":b.type),d=b&&b.target&&b.target.src;t.message="Loading chunk "+a+" failed.\n("+c+": "+d+")",t.name="ChunkLoadError",t.type=c,t.request=d,f[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,b)=>{var f,c,d=b[0],t=b[1],o=b[2],n=0;if(d.some((a=>0!==e[a]))){for(f in t)r.o(t,f)&&(r.m[f]=t[f]);if(o)var i=o(r)}for(a&&a(b);n - + diff --git a/blog/archive.html b/blog/archive.html index 745556543..9840e78d8 100644 --- a/blog/archive.html +++ b/blog/archive.html @@ -16,7 +16,7 @@ - + diff --git a/blog/authors.html b/blog/authors.html index ed29ec24c..666355d03 100644 --- a/blog/authors.html +++ b/blog/authors.html @@ -16,7 +16,7 @@ - + diff --git a/blog/first-blog-post.html b/blog/first-blog-post.html index 3af0cce7a..436e9dbd5 100644 --- a/blog/first-blog-post.html +++ b/blog/first-blog-post.html @@ -16,7 +16,7 @@ - + diff --git a/blog/long-blog-post.html b/blog/long-blog-post.html index 9cd60df13..884c98533 100644 --- a/blog/long-blog-post.html +++ b/blog/long-blog-post.html @@ -16,7 +16,7 @@ - + diff --git a/blog/mdx-blog-post.html b/blog/mdx-blog-post.html index a3aaabb57..1c0975967 100644 --- a/blog/mdx-blog-post.html +++ b/blog/mdx-blog-post.html @@ -16,7 +16,7 @@ - + diff --git a/blog/tags.html b/blog/tags.html index e5a06b7ba..e7328c1d7 100644 --- a/blog/tags.html +++ b/blog/tags.html @@ -16,7 +16,7 @@ - + diff --git a/blog/tags/docusaurus.html b/blog/tags/docusaurus.html index 3e39101c9..38824d325 100644 --- a/blog/tags/docusaurus.html +++ b/blog/tags/docusaurus.html @@ -16,7 +16,7 @@ - + diff --git a/blog/tags/facebook.html b/blog/tags/facebook.html index ddb49c020..2b76b1b8f 100644 --- a/blog/tags/facebook.html +++ b/blog/tags/facebook.html @@ -16,7 +16,7 @@ - + diff --git a/blog/tags/hello.html b/blog/tags/hello.html index 0d9f673b6..e098983c3 100644 --- a/blog/tags/hello.html +++ b/blog/tags/hello.html @@ -16,7 +16,7 @@ - + diff --git a/blog/tags/hola.html b/blog/tags/hola.html index f361ac0c3..b2729ec43 100644 --- a/blog/tags/hola.html +++ b/blog/tags/hola.html @@ -16,7 +16,7 @@ - + diff --git a/blog/welcome.html b/blog/welcome.html index 30b1db257..f8dfad285 100644 --- a/blog/welcome.html +++ b/blog/welcome.html @@ -16,7 +16,7 @@ - + diff --git a/docs/Integrations/chatwoot.html b/docs/Integrations/chatwoot.html index d202cc599..a401cd148 100644 --- a/docs/Integrations/chatwoot.html +++ b/docs/Integrations/chatwoot.html @@ -16,11 +16,11 @@ - + -

Chatwoot integrations

you can directly integrate open-wa/wa-automate directly using the easy-api or docker

+

Chatwoot integrations

you can directly integrate open-wa/wa-automate directly using the easy-api or docker