From 34c8f3466cdb8c8948eddbbe2252e98329fcbd53 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sun, 22 Dec 2024 17:02:34 +0000 Subject: [PATCH] Deploy website - based on c1d2e7400627e3cf3db7fd261bea1648096d92d9 --- 404.html | 4 +- assets/js/0058b4c6.095e5578.js | 1 + assets/js/0058b4c6.8f6b3915.js | 1 - ...4794e.88922a2a.js => 0274794e.6da2b6d9.js} | 2 +- ...c9b31.a3a86c1b.js => 1a3c9b31.7f447152.js} | 2 +- assets/js/26af37c4.2cfdf6c1.js | 1 - assets/js/26af37c4.a98abb3b.js | 1 + assets/js/60a6a671.a11ac1c8.js | 1 + ...ae7fe.3696e579.js => 6f5ae7fe.5c6077ae.js} | 2 +- assets/js/73d41d19.d15ff4ab.js | 1 + assets/js/73d41d19.da269f44.js | 1 - assets/js/83d3b456.0f2d33ad.js | 1 + assets/js/83d3b456.58fd577f.js | 1 - assets/js/a8e44dab.a0444047.js | 1 - assets/js/a8e44dab.d386da81.js | 1 + assets/js/d23fc473.1fcf6734.js | 1 - assets/js/d23fc473.201892b5.js | 1 + assets/js/main.6263ff4e.js | 2 - assets/js/main.d18e5779.js | 2 + ...CENSE.txt => main.d18e5779.js.LICENSE.txt} | 0 assets/js/runtime~main.0e0fc88b.js | 1 + assets/js/runtime~main.998addbc.js | 1 - blog.html | 4 +- blog/archive.html | 4 +- blog/authors.html | 4 +- blog/first-blog-post.html | 4 +- blog/long-blog-post.html | 4 +- blog/mdx-blog-post.html | 4 +- blog/tags.html | 4 +- blog/tags/docusaurus.html | 4 +- blog/tags/facebook.html | 4 +- blog/tags/hello.html | 4 +- blog/tags/hola.html | 4 +- blog/welcome.html | 4 +- docs/Integrations/chatwoot.html | 6 +- docs/advanced/best-practices.html | 6 +- docs/api.html | 6 +- docs/category/tutorial---basics.html | 6 +- docs/category/tutorial---extras.html | 6 +- docs/concepts/glossary.html | 6 +- docs/concepts/how-it-works.html | 6 +- docs/configuration/capture-qr.html | 6 +- docs/configuration/capture-sd.html | 6 +- docs/configuration/command-line-options.html | 6 +- docs/configuration/config-object.html | 6 +- docs/configuration/launch-events.html | 6 +- docs/configuration/licensed-features.html | 6 +- docs/configuration/multiple-sessions.html | 6 +- docs/configuration/the-client.html | 6 +- docs/get-started/docker.html | 6 +- docs/get-started/installation.html | 6 +- docs/get-started/link-code.html | 6 +- docs/get-started/quick-run.html | 6 +- docs/get-started/socketmode.html | 6 +- docs/how-to/create-api.html | 6 +- docs/how-to/decrypt-media.html | 6 +- docs/how-to/detect-logout.html | 6 +- docs/how-to/groups.html | 6 +- docs/how-to/handle-errors.html | 6 +- docs/how-to/incoming-calls.html | 6 +- docs/how-to/location.html | 6 +- docs/how-to/manage-participants.html | 6 +- docs/how-to/misc.html | 6 +- docs/how-to/react-to-group-events.html | 6 +- docs/how-to/read-state.html | 6 +- docs/how-to/receive-files.html | 6 +- docs/how-to/receive-messages.html | 6 +- docs/how-to/send-files.html | 6 +- docs/how-to/send-messages.html | 6 +- docs/how-to/send-videos.html | 6 +- docs/how-to/sendfile.html | 6 +- docs/how-to/use-a-proxy.html | 8 +- docs/intro.html | 6 +- docs/reference.html | 8 +- docs/reference/api/Client.html | 8 +- docs/reference/api/Client/classes/Client.html | 528 +++++++++--------- .../api/Client/enumerations/namespace.html | 6 +- .../api/Client/variables/useragent.html | 6 +- .../reference/api/functions/exposed.enum.html | 6 +- .../exposed.enum/enumerations/ExposedFn.html | 6 +- docs/reference/api/model.html | 11 +- docs/reference/api/model/aliases.html | 6 +- .../aliases/type-aliases/AccountNumber.html | 6 +- .../aliases/type-aliases/AdvancedFile.html | 6 +- .../model/aliases/type-aliases/Base64.html | 6 +- .../model/aliases/type-aliases/ChatId.html | 6 +- .../aliases/type-aliases/ChatServer.html | 6 +- .../model/aliases/type-aliases/ContactId.html | 6 +- .../model/aliases/type-aliases/Content.html | 6 +- .../aliases/type-aliases/CountryCode.html | 6 +- .../model/aliases/type-aliases/DataURL.html | 6 +- .../model/aliases/type-aliases/FilePath.html | 6 +- .../model/aliases/type-aliases/GetURL.html | 6 +- .../aliases/type-aliases/GroupChatId.html | 6 +- .../aliases/type-aliases/GroupChatServer.html | 6 +- .../model/aliases/type-aliases/GroupId.html | 6 +- .../model/aliases/type-aliases/MessageId.html | 6 +- .../aliases/type-aliases/NonSerializedId.html | 6 +- .../model/aliases/type-aliases/WaServers.html | 6 +- docs/reference/api/model/button.html | 6 +- .../button/interfaces/AdvancedButton.html | 6 +- .../api/model/button/interfaces/Button.html | 6 +- .../button/interfaces/LocationButtonBody.html | 6 +- .../api/model/button/interfaces/Row.html | 6 +- .../api/model/button/interfaces/Section.html | 6 +- docs/reference/api/model/call.html | 6 +- .../model/call/enumerations/CallState.html | 6 +- .../api/model/call/interfaces/Call.html | 6 +- docs/reference/api/model/chat.html | 6 +- .../chat/enumerations/ChatMuteDuration.html | 6 +- .../model/chat/enumerations/ChatState.html | 6 +- .../model/chat/enumerations/ChatTypes.html | 6 +- .../api/model/chat/interfaces/BaseChat.html | 6 +- .../api/model/chat/interfaces/GroupChat.html | 6 +- ...oupChatCreationParticipantAddResponse.html | 6 +- .../interfaces/GroupChatCreationResponse.html | 6 +- .../interfaces/LiveLocationChangedEvent.html | 6 +- .../api/model/chat/interfaces/SingleChat.html | 6 +- .../api/model/chat/type-aliases/Chat.html | 6 +- .../chat/type-aliases/EphemeralDuration.html | 6 +- docs/reference/api/model/config.html | 6 +- .../config/enumerations/CLOUD_PROVIDERS.html | 6 +- .../enumerations/DIRECTORY_STRATEGY.html | 6 +- .../config/enumerations/LicenseType.html | 6 +- .../enumerations/NotificationLanguage.html | 6 +- .../model/config/enumerations/OnError.html | 6 +- .../model/config/enumerations/QRFormat.html | 6 +- .../model/config/enumerations/QRQuality.html | 6 +- .../model/config/interfaces/ConfigObject.html | 6 +- .../api/model/config/interfaces/DevTools.html | 6 +- .../model/config/interfaces/EventPayload.html | 6 +- .../interfaces/ProxyServerCredentials.html | 6 +- .../model/config/interfaces/SessionData.html | 6 +- .../api/model/config/interfaces/Webhook.html | 6 +- .../config/type-aliases/AdvancedConfig.html | 6 +- docs/reference/api/model/contact.html | 6 +- .../model/contact/interfaces/BizCategory.html | 6 +- .../contact/interfaces/BizProfileOptions.html | 6 +- .../contact/interfaces/BusinessHours.html | 6 +- .../contact/interfaces/BusinessProfile.html | 6 +- .../api/model/contact/interfaces/Contact.html | 6 +- .../model/contact/interfaces/NumberCheck.html | 6 +- .../api/model/enumerations/Events.html | 6 +- .../api/model/enumerations/STATE.html | 6 +- .../api/model/enumerations/Status.html | 6 +- docs/reference/api/model/errors.html | 6 +- .../errors/classes/AddParticipantError.html | 6 +- .../api/model/errors/classes/CustomError.html | 6 +- .../errors/classes/PageEvaluationTimeout.html | 6 +- .../errors/classes/SessionExpiredError.html | 6 +- .../AddParticipantErrorStatusCode.html | 6 +- .../model/errors/enumerations/ERROR_NAME.html | 6 +- docs/reference/api/model/events.html | 6 +- .../events/enumerations/SimpleListener.html | 6 +- docs/reference/api/model/group-metadata.html | 6 +- .../enumerations/GroupNotificationTypes.html | 6 +- .../enumerations/groupChangeEvent.html | 6 +- .../interfaces/GenericGroupChangeEvent.html | 6 +- .../interfaces/GroupMetadata.html | 6 +- .../interfaces/NewCommunityGroup.html | 6 +- .../interfaces/Participant.html | 6 +- .../ParticipantChangedEventModel.html | 6 +- docs/reference/api/model/id.html | 6 +- .../reference/api/model/id/interfaces/Id.html | 6 +- docs/reference/api/model/label.html | 6 +- .../api/model/label/interfaces/Label.html | 6 +- docs/reference/api/model/media.html | 6 +- .../Mp4StickerConversionProcessOptions.html | 6 +- .../media/type-aliases/StickerMetadata.html | 6 +- .../variables/defaultProcessOptions.html | 6 +- docs/reference/api/model/message.html | 12 +- .../message/enumerations/MessageAck.html | 6 +- .../message/enumerations/MessageTypes.html | 6 +- .../api/model/message/interfaces/Message.html | 8 +- .../model/message/interfaces/MessageInfo.html | 6 +- .../interfaces/MessageInfoInteraction.html | 6 +- .../model/message/interfaces/PollData.html | 6 +- .../model/message/interfaces/PollOption.html | 6 +- .../model/message/interfaces/PollVote.html | 6 +- .../model/message/interfaces/QuoteMap.html | 6 +- .../message/interfaces/ReactionSender.html | 8 +- .../type-aliases/MessagePinDuration.html | 28 + docs/reference/api/model/product.html | 8 +- .../model/product/interfaces/CartItem.html | 6 +- .../product/interfaces/CustomProduct.html | 6 +- .../api/model/product/interfaces/Order.html | 6 +- .../api/model/product/interfaces/Product.html | 6 +- docs/reference/api/model/reactions.html | 6 +- .../reactions/type-aliases/Reaction.html | 6 +- .../reactions/type-aliases/ReactionEvent.html | 6 +- .../type-aliases/ReactionRecord.html | 6 +- docs/reference/api/model/sessionInfo.html | 6 +- .../sessionInfo/interfaces/HealthCheck.html | 6 +- .../sessionInfo/interfaces/SessionInfo.html | 6 +- .../model/type-aliases/EasyApiResponse.html | 6 +- docs/reference/controllers/events.html | 6 +- .../controllers/events/variables/ev.html | 6 +- docs/reference/controllers/init_patch.html | 6 +- docs/reference/controllers/initializer.html | 6 +- .../initializer/functions/create.html | 6 +- .../initializer/functions/timeout.html | 6 +- .../variables/configWithCases.html | 6 +- .../initializer/variables/pkg.html | 6 +- .../initializer/variables/screenshot.html | 6 +- docs/reference/controllers/patch_manager.html | 6 +- .../functions/earlyInjectionCheck.html | 6 +- .../functions/getAndInjectLicense.html | 6 +- docs/reference/logging/custom_transport.html | 6 +- .../classes/LogToEvTransport.html | 6 +- .../classes/NoOpTransport.html | 6 +- docs/reference/logging/logging.html | 6 +- .../functions/addRotateFileLogTransport.html | 6 +- .../type-aliases/ConfigLogTransport.html | 6 +- .../logging/logging/variables/log.html | 6 +- docs/reference/structures/Collector.html | 6 +- .../Collector/classes/Collection.html | 6 +- .../Collector/classes/Collector.html | 6 +- .../interfaces/AwaitMessagesOptions.html | 6 +- .../interfaces/CollectorOptions.html | 6 +- .../type-aliases/CollectorFilter.html | 6 +- docs/reference/structures/Dialog.html | 6 +- .../Dialog/enumerations/ValidationType.html | 6 +- .../Dialog/interfaces/CurrentDialogProps.html | 6 +- .../Dialog/interfaces/DialogButtons.html | 6 +- .../interfaces/DialogListMessageRow.html | 6 +- .../interfaces/DialogListMessageSection.html | 6 +- .../Dialog/interfaces/DialogProperty.html | 6 +- .../Dialog/interfaces/DialogState.html | 6 +- .../Dialog/interfaces/DialogTemplate.html | 6 +- .../Dialog/interfaces/DialogValidation.html | 6 +- .../Dialog/type-aliases/CheckFunction.html | 6 +- .../structures/MessageCollector.html | 6 +- .../classes/MessageCollector.html | 6 +- docs/reference/structures/preProcessors.html | 6 +- .../enumerations/PREPROCESSORS.html | 6 +- .../type-aliases/MPConfigType.html | 6 +- .../type-aliases/MessagePreProcessor.html | 6 +- .../variables/MessagePreprocessors.html | 6 +- docs/tutorial-basics/congratulations.html | 6 +- docs/tutorial-basics/create-a-blog-post.html | 6 +- docs/tutorial-basics/create-a-document.html | 6 +- docs/tutorial-basics/create-a-page.html | 6 +- docs/tutorial-basics/deploy-your-site.html | 6 +- docs/tutorial-basics/markdown-features.html | 6 +- .../tutorial-extras/manage-docs-versions.html | 6 +- docs/tutorial-extras/translate-your-site.html | 6 +- index.html | 4 +- markdown-page.html | 4 +- search.html | 4 +- sitemap.xml | 2 +- 250 files changed, 998 insertions(+), 932 deletions(-) create mode 100644 assets/js/0058b4c6.095e5578.js delete mode 100644 assets/js/0058b4c6.8f6b3915.js rename assets/js/{0274794e.88922a2a.js => 0274794e.6da2b6d9.js} (97%) rename assets/js/{1a3c9b31.a3a86c1b.js => 1a3c9b31.7f447152.js} (95%) delete mode 100644 assets/js/26af37c4.2cfdf6c1.js create mode 100644 assets/js/26af37c4.a98abb3b.js create mode 100644 assets/js/60a6a671.a11ac1c8.js rename assets/js/{6f5ae7fe.3696e579.js => 6f5ae7fe.5c6077ae.js} (97%) create mode 100644 assets/js/73d41d19.d15ff4ab.js delete mode 100644 assets/js/73d41d19.da269f44.js create mode 100644 assets/js/83d3b456.0f2d33ad.js delete mode 100644 assets/js/83d3b456.58fd577f.js delete mode 100644 assets/js/a8e44dab.a0444047.js create mode 100644 assets/js/a8e44dab.d386da81.js delete mode 100644 assets/js/d23fc473.1fcf6734.js create mode 100644 assets/js/d23fc473.201892b5.js delete mode 100644 assets/js/main.6263ff4e.js create mode 100644 assets/js/main.d18e5779.js rename assets/js/{main.6263ff4e.js.LICENSE.txt => main.d18e5779.js.LICENSE.txt} (100%) create mode 100644 assets/js/runtime~main.0e0fc88b.js delete mode 100644 assets/js/runtime~main.998addbc.js create mode 100644 docs/reference/api/model/message/type-aliases/MessagePinDuration.html diff --git a/404.html b/404.html index fa511c176e..6898b33d08 100644 --- a/404.html +++ b/404.html @@ -16,8 +16,8 @@ - - + +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

diff --git a/assets/js/0058b4c6.095e5578.js b/assets/js/0058b4c6.095e5578.js new file mode 100644 index 0000000000..c5a545d9a3 --- /dev/null +++ b/assets/js/0058b4c6.095e5578.js @@ -0,0 +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":"Quick Start","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.75.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}]},{"type":"category","label":"type-aliases","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Type Alias: MessagePinDuration","href":"/docs/reference/api/model/message/type-aliases/MessagePinDuration","docId":"reference/api/model/message/type-aliases/MessagePinDuration","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":"Quick Start Guide - wa-automate EASY API","description":"A comprehensive guide to quickly set up wa-automate and create a Open-wa EASY API with zero installation requirements.","sidebar":"tutorialSidebar"},"get-started/socketmode":{"id":"get-started/socketmode","title":"Socket Mode","description":"Learn how to use Socket Mode to develop WhatsApp automation solutions with enhanced flexibility and development experience.","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/message/type-aliases/MessagePinDuration":{"id":"reference/api/model/message/type-aliases/MessagePinDuration","title":"Type Alias: MessagePinDuration","description":"MessagePinDuration: \\"FifteenSeconds\\" \\\\| \\"FiveSeconds\\" \\\\| \\"OneDay\\" \\\\| \\"OneMinute\\" \\\\| \\"SevenDays\\" \\\\| \\"ThirtyDays\\"","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.75.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/0058b4c6.8f6b3915.js b/assets/js/0058b4c6.8f6b3915.js deleted file mode 100644 index 7779cf94ba..0000000000 --- a/assets/js/0058b4c6.8f6b3915.js +++ /dev/null @@ -1 +0,0 @@ -"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":"Quick Start","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.2","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":"Quick Start Guide - wa-automate EASY API","description":"A comprehensive guide to quickly set up wa-automate and create a Open-wa EASY API with zero installation requirements.","sidebar":"tutorialSidebar"},"get-started/socketmode":{"id":"get-started/socketmode","title":"Socket Mode","description":"Learn how to use Socket Mode to develop WhatsApp automation solutions with enhanced flexibility and development experience.","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.2","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.88922a2a.js b/assets/js/0274794e.6da2b6d9.js similarity index 97% rename from assets/js/0274794e.88922a2a.js rename to assets/js/0274794e.6da2b6d9.js index 7ee6e2b25a..7adb8a808e 100644 --- a/assets/js/0274794e.88922a2a.js +++ b/assets/js/0274794e.6da2b6d9.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.74.2",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.75.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.a3a86c1b.js b/assets/js/1a3c9b31.7f447152.js similarity index 95% rename from assets/js/1a3c9b31.a3a86c1b.js rename to assets/js/1a3c9b31.7f447152.js index 696686e22b..b859366ce6 100644 --- a/assets/js/1a3c9b31.a3a86c1b.js +++ b/assets/js/1a3c9b31.7f447152.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.74.2",o={id:"reference/index",title:"@open-wa/wa-automate v4.74.2",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-v4742",children:"@open-wa/wa-automate v4.74.2"})}),"\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.75.0",o={id:"reference/index",title:"@open-wa/wa-automate v4.75.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-v4750",children:"@open-wa/wa-automate v4.75.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.2cfdf6c1.js b/assets/js/26af37c4.2cfdf6c1.js deleted file mode 100644 index b3fe4f29d2..0000000000 --- a/assets/js/26af37c4.2cfdf6c1.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:"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/26af37c4.a98abb3b.js b/assets/js/26af37c4.a98abb3b.js new file mode 100644 index 0000000000..2350774f85 --- /dev/null +++ b/assets/js/26af37c4.a98abb3b.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:"keepMessage()",id:"keepmessage",level:3},{value:"Parameters",id:"parameters-85",level:4},{value:"Returns",id:"returns-128",level:4},{value:"kill()",id:"kill",level:3},{value:"Parameters",id:"parameters-86",level:4},{value:"Returns",id:"returns-129",level:4},{value:"leaveGroup()",id:"leavegroup",level:3},{value:"Parameters",id:"parameters-87",level:4},{value:"Returns",id:"returns-130",level:4},{value:"listWebhooks()",id:"listwebhooks",level:3},{value:"Returns",id:"returns-131",level:4},{value:"loadAllEarlierMessages()",id:"loadallearliermessages",level:3},{value:"Parameters",id:"parameters-88",level:4},{value:"Returns",id:"returns-132",level:4},{value:"loadAndGetAllMessagesInChat()",id:"loadandgetallmessagesinchat",level:3},{value:"Parameters",id:"parameters-89",level:4},{value:"Returns",id:"returns-133",level:4},{value:"loadEarlierMessages()",id:"loadearliermessages",level:3},{value:"Parameters",id:"parameters-90",level:4},{value:"Returns",id:"returns-134",level:4},{value:"loadEarlierMessagesTillDate()",id:"loadearliermessagestilldate",level:3},{value:"Parameters",id:"parameters-91",level:4},{value:"Returns",id:"returns-135",level:4},{value:"logger()",id:"logger",level:3},{value:"Returns",id:"returns-136",level:4},{value:"logout()",id:"logout",level:3},{value:"Parameters",id:"parameters-92",level:4},{value:"Returns",id:"returns-137",level:4},{value:"markAllRead()",id:"markallread",level:3},{value:"Returns",id:"returns-138",level:4},{value:"markAsUnread()",id:"markasunread",level:3},{value:"Parameters",id:"parameters-93",level:4},{value:"Returns",id:"returns-139",level:4},{value:"metrics()",id:"metrics",level:3},{value:"Returns",id:"returns-140",level:4},{value:"middleware()",id:"middleware",level:3},{value:"Parameters",id:"parameters-94",level:4},{value:"Returns",id:"returns-141",level:4},{value:"Parameters",id:"parameters-95",level:5},{value:"Returns",id:"returns-142",level:5},{value:'muteChat()
insiders
',id:"mutechat-insiders",level:3},{value:"Parameters",id:"parameters-96",level:4},{value:"Returns",id:"returns-143",level:4},{value:'onNewProduct()
insiders
',id:"onnewproduct-insiders",level:3},{value:"Parameters",id:"parameters-97",level:4},{value:"Returns",id:"returns-144",level:4},{value:'onOrder()
insiders
',id:"onorder-insiders",level:3},{value:"Parameters",id:"parameters-98",level:4},{value:"Returns",id:"returns-145",level:4},{value:"pinChat()",id:"pinchat",level:3},{value:"Parameters",id:"parameters-99",level:4},{value:"Returns",id:"returns-146",level:4},{value:"pinMessage()",id:"pinmessage",level:3},{value:"Parameters",id:"parameters-100",level:4},{value:"Returns",id:"returns-147",level:4},{value:'postImageStatus()
restricted
',id:"postimagestatus-restricted",level:3},{value:"Parameters",id:"parameters-101",level:4},{value:"Returns",id:"returns-148",level:4},{value:'postTextStatus()
restricted
',id:"posttextstatus-restricted",level:3},{value:"Parameters",id:"parameters-102",level:4},{value:"Returns",id:"returns-149",level:4},{value:'postThumbnailStatus()
restricted
',id:"postthumbnailstatus-restricted",level:3},{value:"Parameters",id:"parameters-103",level:4},{value:"Returns",id:"returns-150",level:4},{value:'postVideoStatus()
restricted
',id:"postvideostatus-restricted",level:3},{value:"Parameters",id:"parameters-104",level:4},{value:"Returns",id:"returns-151",level:4},{value:"prepEventData()",id:"prepeventdata",level:3},{value:"Parameters",id:"parameters-105",level:4},{value:"Returns",id:"returns-152",level:4},{value:"promoteParticipant()",id:"promoteparticipant",level:3},{value:"Parameters",id:"parameters-106",level:4},{value:"Returns",id:"returns-153",level:4},{value:"react()",id:"react",level:3},{value:"Parameters",id:"parameters-107",level:4},{value:"Returns",id:"returns-154",level:4},{value:"refresh()",id:"refresh",level:3},{value:"Returns",id:"returns-155",level:4},{value:"registerWebhook()",id:"registerwebhook",level:3},{value:"Parameters",id:"parameters-108",level:4},{value:"Returns",id:"returns-156",level:4},{value:"rejectGroupJoinRequest()",id:"rejectgroupjoinrequest",level:3},{value:"Parameters",id:"parameters-109",level:4},{value:"Returns",id:"returns-157",level:4},{value:"removeAllListeners()",id:"removealllisteners",level:3},{value:"Returns",id:"returns-158",level:4},{value:"removeLabel()",id:"removelabel",level:3},{value:"Parameters",id:"parameters-110",level:4},{value:"Returns",id:"returns-159",level:4},{value:"removeListener()",id:"removelistener",level:3},{value:"Parameters",id:"parameters-111",level:4},{value:"Returns",id:"returns-160",level:4},{value:"removeParticipant()",id:"removeparticipant",level:3},{value:"Parameters",id:"parameters-112",level:4},{value:"Returns",id:"returns-161",level:4},{value:"removeProduct()",id:"removeproduct",level:3},{value:"Parameters",id:"parameters-113",level:4},{value:"Returns",id:"returns-162",level:4},{value:"removeWebhook()",id:"removewebhook",level:3},{value:"Parameters",id:"parameters-114",level:4},{value:"Returns",id:"returns-163",level:4},{value:"Retruns",id:"retruns",level:4},{value:"reply()",id:"reply",level:3},{value:"Parameters",id:"parameters-115",level:4},{value:"Returns",id:"returns-164",level:4},{value:'reportSpam()
restricted
',id:"reportspam-restricted",level:3},{value:"Parameters",id:"parameters-116",level:4},{value:"Returns",id:"returns-165",level:4},{value:"resizePage()",id:"resizepage",level:3},{value:"Parameters",id:"parameters-117",level:4},{value:"Returns",id:"returns-166",level:4},{value:"revokeGroupInviteLink()",id:"revokegroupinvitelink",level:3},{value:"Parameters",id:"parameters-118",level:4},{value:"Returns",id:"returns-167",level:4},{value:"sendAdvancedButtons()",id:"sendadvancedbuttons",level:3},{value:"Parameters",id:"parameters-119",level:4},{value:"Returns",id:"returns-168",level:4},{value:"Deprecated",id:"deprecated-3",level:4},{value:"sendAudio()",id:"sendaudio",level:3},{value:"Parameters",id:"parameters-120",level:4},{value:"Returns",id:"returns-169",level:4},{value:"sendBanner()",id:"sendbanner",level:3},{value:"Parameters",id:"parameters-121",level:4},{value:"Returns",id:"returns-170",level:4},{value:"sendButtons()",id:"sendbuttons",level:3},{value:"Parameters",id:"parameters-122",level:4},{value:"Returns",id:"returns-171",level:4},{value:"Deprecated",id:"deprecated-4",level:4},{value:"sendContact()",id:"sendcontact",level:3},{value:"Parameters",id:"parameters-123",level:4},{value:"Returns",id:"returns-172",level:4},{value:"sendCustomProduct()",id:"sendcustomproduct",level:3},{value:"Parameters",id:"parameters-124",level:4},{value:"Returns",id:"returns-173",level:4},{value:"Deprecated",id:"deprecated-5",level:4},{value:"sendEmoji()",id:"sendemoji",level:3},{value:"Parameters",id:"parameters-125",level:4},{value:"Returns",id:"returns-174",level:4},{value:"sendFile()",id:"sendfile",level:3},{value:"Parameters",id:"parameters-126",level:4},{value:"Returns",id:"returns-175",level:4},{value:"sendFileFromUrl()",id:"sendfilefromurl",level:3},{value:"Parameters",id:"parameters-127",level:4},{value:"Returns",id:"returns-176",level:4},{value:"sendGiphy()",id:"sendgiphy",level:3},{value:"Parameters",id:"parameters-128",level:4},{value:"Returns",id:"returns-177",level:4},{value:"sendGiphyAsSticker()",id:"sendgiphyassticker",level:3},{value:"Parameters",id:"parameters-129",level:4},{value:"Returns",id:"returns-178",level:4},{value:"sendImage()",id:"sendimage",level:3},{value:"Parameters",id:"parameters-130",level:4},{value:"Returns",id:"returns-179",level:4},{value:"sendImageAsSticker()",id:"sendimageassticker",level:3},{value:"Parameters",id:"parameters-131",level:4},{value:"Returns",id:"returns-180",level:4},{value:'sendImageAsStickerAsReply()
insiders
',id:"sendimageasstickerasreply-insiders",level:3},{value:"Parameters",id:"parameters-132",level:4},{value:"Returns",id:"returns-181",level:4},{value:"sendImageWithProduct()",id:"sendimagewithproduct",level:3},{value:"Parameters",id:"parameters-133",level:4},{value:"Returns",id:"returns-182",level:4},{value:"sendLinkWithAutoPreview()",id:"sendlinkwithautopreview",level:3},{value:"Parameters",id:"parameters-134",level:4},{value:"Returns",id:"returns-183",level:4},{value:"sendListMessage()",id:"sendlistmessage",level:3},{value:"Parameters",id:"parameters-135",level:4},{value:"Returns",id:"returns-184",level:4},{value:"Deprecated",id:"deprecated-6",level:4},{value:"sendLocation()",id:"sendlocation",level:3},{value:"Parameters",id:"parameters-136",level:4},{value:"Returns",id:"returns-185",level:4},{value:"sendMessageWithThumb()",id:"sendmessagewiththumb",level:3},{value:"Parameters",id:"parameters-137",level:4},{value:"Returns",id:"returns-186",level:4},{value:"sendMp4AsSticker()",id:"sendmp4assticker",level:3},{value:"Parameters",id:"parameters-138",level:4},{value:"Returns",id:"returns-187",level:4},{value:'sendMultipleContacts()
insiders
',id:"sendmultiplecontacts-insiders",level:3},{value:"Parameters",id:"parameters-139",level:4},{value:"Returns",id:"returns-188",level:4},{value:"sendPaymentRequest()",id:"sendpaymentrequest",level:3},{value:"Parameters",id:"parameters-140",level:4},{value:"Returns",id:"returns-189",level:4},{value:"sendPoll()",id:"sendpoll",level:3},{value:"Parameters",id:"parameters-141",level:4},{value:"Returns",id:"returns-190",level:4},{value:'sendProduct()
insiders
',id:"sendproduct-insiders",level:3},{value:"Parameters",id:"parameters-142",level:4},{value:"Returns",id:"returns-191",level:4},{value:"sendPtt()",id:"sendptt",level:3},{value:"Parameters",id:"parameters-143",level:4},{value:"Returns",id:"returns-192",level:4},{value:"sendRawWebpAsSticker()",id:"sendrawwebpassticker",level:3},{value:"Parameters",id:"parameters-144",level:4},{value:"Returns",id:"returns-193",level:4},{value:'sendRawWebpAsStickerAsReply()
insiders
',id:"sendrawwebpasstickerasreply-insiders",level:3},{value:"Parameters",id:"parameters-145",level:4},{value:"Returns",id:"returns-194",level:4},{value:"sendReplyWithMentions()",id:"sendreplywithmentions",level:3},{value:"Parameters",id:"parameters-146",level:4},{value:"Returns",id:"returns-195",level:4},{value:"sendSeen()",id:"sendseen",level:3},{value:"Parameters",id:"parameters-147",level:4},{value:"Returns",id:"returns-196",level:4},{value:"sendStickerfromUrl()",id:"sendstickerfromurl",level:3},{value:"Parameters",id:"parameters-148",level:4},{value:"Returns",id:"returns-197",level:4},{value:'sendStickerfromUrlAsReply()
insiders
',id:"sendstickerfromurlasreply-insiders",level:3},{value:"Parameters",id:"parameters-149",level:4},{value:"Returns",id:"returns-198",level:4},{value:'sendText()
restricted
',id:"sendtext-restricted",level:3},{value:"Parameters",id:"parameters-150",level:4},{value:"Returns",id:"returns-199",level:4},{value:"sendTextWithMentions()",id:"sendtextwithmentions",level:3},{value:"Parameters",id:"parameters-151",level:4},{value:"Returns",id:"returns-200",level:4},{value:"sendVCard()",id:"sendvcard",level:3},{value:"Parameters",id:"parameters-152",level:4},{value:"Returns",id:"returns-201",level:4},{value:"sendVideoAsGif()",id:"sendvideoasgif",level:3},{value:"Parameters",id:"parameters-153",level:4},{value:"Returns",id:"returns-202",level:4},{value:"sendYoutubeLink()",id:"sendyoutubelink",level:3},{value:"Parameters",id:"parameters-154",level:4},{value:"Returns",id:"returns-203",level:4},{value:'setChatBackgroundColourHex()
insiders
',id:"setchatbackgroundcolourhex-insiders",level:3},{value:"Parameters",id:"parameters-155",level:4},{value:"Returns",id:"returns-204",level:4},{value:'setChatEphemeral()
insiders
',id:"setchatephemeral-insiders",level:3},{value:"Parameters",id:"parameters-156",level:4},{value:"Returns",id:"returns-205",level:4},{value:"setChatState()",id:"setchatstate",level:3},{value:"Parameters",id:"parameters-157",level:4},{value:"Returns",id:"returns-206",level:4},{value:"setGroupApprovalMode()",id:"setgroupapprovalmode",level:3},{value:"Parameters",id:"parameters-158",level:4},{value:"Returns",id:"returns-207",level:4},{value:"setGroupDescription()",id:"setgroupdescription",level:3},{value:"Parameters",id:"parameters-159",level:4},{value:"Returns",id:"returns-208",level:4},{value:"setGroupEditToAdminsOnly()",id:"setgroupedittoadminsonly",level:3},{value:"Parameters",id:"parameters-160",level:4},{value:"Returns",id:"returns-209",level:4},{value:"setGroupIcon()",id:"setgroupicon",level:3},{value:"Parameters",id:"parameters-161",level:4},{value:"Returns",id:"returns-210",level:4},{value:"setGroupIconByUrl()",id:"setgroupiconbyurl",level:3},{value:"Parameters",id:"parameters-162",level:4},{value:"Returns",id:"returns-211",level:4},{value:'setGroupTitle()
insiders
',id:"setgrouptitle-insiders",level:3},{value:"Parameters",id:"parameters-163",level:4},{value:"Returns",id:"returns-212",level:4},{value:"setGroupToAdminsOnly()",id:"setgrouptoadminsonly",level:3},{value:"Parameters",id:"parameters-164",level:4},{value:"Returns",id:"returns-213",level:4},{value:"setMyName()",id:"setmyname",level:3},{value:"Parameters",id:"parameters-165",level:4},{value:"Returns",id:"returns-214",level:4},{value:"setMyStatus()",id:"setmystatus",level:3},{value:"Parameters",id:"parameters-166",level:4},{value:"Returns",id:"returns-215",level:4},{value:"setPresence()",id:"setpresence",level:3},{value:"Parameters",id:"parameters-167",level:4},{value:"Returns",id:"returns-216",level:4},{value:"setProfilePic()",id:"setprofilepic",level:3},{value:"Parameters",id:"parameters-168",level:4},{value:"Returns",id:"returns-217",level:4},{value:"simulateRecording()",id:"simulaterecording",level:3},{value:"Parameters",id:"parameters-169",level:4},{value:"Returns",id:"returns-218",level:4},{value:"simulateTyping()",id:"simulatetyping",level:3},{value:"Parameters",id:"parameters-170",level:4},{value:"Returns",id:"returns-219",level:4},{value:"starMessage()",id:"starmessage",level:3},{value:"Parameters",id:"parameters-171",level:4},{value:"Returns",id:"returns-220",level:4},{value:"syncContacts()",id:"synccontacts",level:3},{value:"Returns",id:"returns-221",level:4},{value:'tagEveryone()
insiders
',id:"tageveryone-insiders",level:3},{value:"Parameters",id:"parameters-172",level:4},{value:"Returns",id:"returns-222",level:4},{value:"Mention",id:"mention",level:4},{value:"Default",id:"default",level:4},{value:"testButtons()",id:"testbuttons",level:3},{value:"Parameters",id:"parameters-173",level:4},{value:"Returns",id:"returns-223",level:4},{value:"Deprecated",id:"deprecated-7",level:4},{value:"testCallback()",id:"testcallback",level:3},{value:"Parameters",id:"parameters-174",level:4},{value:"Returns",id:"returns-224",level:4},{value:'unmuteChat()
insiders
',id:"unmutechat-insiders",level:3},{value:"Parameters",id:"parameters-175",level:4},{value:"Returns",id:"returns-225",level:4},{value:"unstarMessage()",id:"unstarmessage",level:3},{value:"Parameters",id:"parameters-176",level:4},{value:"Returns",id:"returns-226",level:4},{value:"updateWebhook()",id:"updatewebhook",level:3},{value:"Parameters",id:"parameters-177",level:4},{value:"Returns",id:"returns-227",level:4},{value:"waitAllQEmpty()",id:"waitallqempty",level:3},{value:"Returns",id:"returns-228",level:4},{value:"waitWhQIdle()",id:"waitwhqidle",level:3},{value:"Returns",id:"returns-229",level:4},{value:"Events",id:"events",level:2},{value:"onAck()",id:"onack-1",level:3},{value:"Parameters",id:"parameters-178",level:4},{value:"Returns",id:"returns-230",level:4},{value:"onAddedToGroup()",id:"onaddedtogroup-1",level:3},{value:"Parameters",id:"parameters-179",level:4},{value:"Returns",id:"returns-231",level:4},{value:"onAnyMessage()",id:"onanymessage-1",level:3},{value:"Parameters",id:"parameters-180",level:4},{value:"Returns",id:"returns-232",level:4},{value:"Fires",id:"fires",level:4},{value:"onBattery()",id:"onbattery-1",level:3},{value:"Parameters",id:"parameters-181",level:4},{value:"Returns",id:"returns-233",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-182",level:4},{value:"Returns",id:"returns-234",level:4},{value:"Fires",id:"fires-2",level:4},{value:"onButton()",id:"onbutton-1",level:3},{value:"Parameters",id:"parameters-183",level:4},{value:"Returns",id:"returns-235",level:4},{value:"Fires",id:"fires-3",level:4},{value:"onCallState()",id:"oncallstate-1",level:3},{value:"Parameters",id:"parameters-184",level:4},{value:"Returns",id:"returns-236",level:4},{value:"onChatDeleted()",id:"onchatdeleted-1",level:3},{value:"Parameters",id:"parameters-185",level:4},{value:"Returns",id:"returns-237",level:4},{value:"Fires",id:"fires-4",level:4},{value:'onChatOpened()
insiders
',id:"onchatopened-insiders",level:3},{value:"Parameters",id:"parameters-186",level:4},{value:"Returns",id:"returns-238",level:4},{value:'onChatState()
insiders
',id:"onchatstate-insiders",level:3},{value:"Parameters",id:"parameters-187",level:4},{value:"Returns",id:"returns-239",level:4},{value:"Fires",id:"fires-5",level:4},{value:'onContactAdded()
insiders
',id:"oncontactadded-insiders",level:3},{value:"Parameters",id:"parameters-188",level:4},{value:"Returns",id:"returns-240",level:4},{value:"onGlobalParticipantsChanged()",id:"onglobalparticipantschanged-1",level:3},{value:"Parameters",id:"parameters-189",level:4},{value:"Returns",id:"returns-241",level:4},{value:"onGroupApprovalRequest()",id:"ongroupapprovalrequest-1",level:3},{value:"Parameters",id:"parameters-190",level:4},{value:"Returns",id:"returns-242",level:4},{value:"onGroupChange()",id:"ongroupchange-1",level:3},{value:"Parameters",id:"parameters-191",level:4},{value:"Returns",id:"returns-243",level:4},{value:"onIncomingCall()",id:"onincomingcall-1",level:3},{value:"Parameters",id:"parameters-192",level:4},{value:"Returns",id:"returns-244",level:4},{value:"onLabel()",id:"onlabel-1",level:3},{value:"Parameters",id:"parameters-193",level:4},{value:"Returns",id:"returns-245",level:4},{value:"Fires",id:"fires-6",level:4},{value:"onLiveLocation()",id:"onlivelocation",level:3},{value:"Parameters",id:"parameters-194",level:4},{value:"Returns",id:"returns-246",level:4},{value:"Emits",id:"emits",level:4},{value:"onLogout()",id:"onlogout-1",level:3},{value:"Parameters",id:"parameters-195",level:4},{value:"Returns",id:"returns-247",level:4},{value:"Fires",id:"fires-7",level:4},{value:"onMessage()",id:"onmessage-1",level:3},{value:"Parameters",id:"parameters-196",level:4},{value:"Returns",id:"returns-248",level:4},{value:"Fires",id:"fires-8",level:4},{value:"onMessageDeleted()",id:"onmessagedeleted-1",level:3},{value:"Parameters",id:"parameters-197",level:4},{value:"Returns",id:"returns-249",level:4},{value:"Fires",id:"fires-9",level:4},{value:"onParticipantsChanged()",id:"onparticipantschanged",level:3},{value:"Parameters",id:"parameters-198",level:4},{value:"Returns",id:"returns-250",level:4},{value:"onPlugged()",id:"onplugged-1",level:3},{value:"Parameters",id:"parameters-199",level:4},{value:"Returns",id:"returns-251",level:4},{value:"Fires",id:"fires-10",level:4},{value:"onPollVote()",id:"onpollvote-1",level:3},{value:"Parameters",id:"parameters-200",level:4},{value:"Returns",id:"returns-252",level:4},{value:"Fires",id:"fires-11",level:4},{value:'onReaction()
insiders
',id:"onreaction-insiders",level:3},{value:"Parameters",id:"parameters-201",level:4},{value:"Returns",id:"returns-253",level:4},{value:"Fires",id:"fires-12",level:4},{value:'onRemovedFromGroup()
insiders
',id:"onremovedfromgroup-insiders",level:3},{value:"Parameters",id:"parameters-202",level:4},{value:"Returns",id:"returns-254",level:4},{value:"onStateChanged()",id:"onstatechanged-1",level:3},{value:"Parameters",id:"parameters-203",level:4},{value:"Returns",id:"returns-255",level:4},{value:"Fires",id:"fires-13",level:4},{value:'onStory()
restricted
',id:"onstory-restricted",level:3},{value:"Parameters",id:"parameters-204",level:4},{value:"Returns",id:"returns-256",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:"keepmessage",children:"keepMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"keepMessage"}),"(",(0,r.jsx)(s.code,{children:"id"}),", ",(0,r.jsx)(s.code,{children:"keep"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Keep a message inside an ephemeral chat"}),"\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:"id"}),": ",(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"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"keep"}),": ",(0,r.jsx)(s.code,{children:"boolean"})]}),"\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:"boolean true: worked"}),"\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-86",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-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.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-87",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-130",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-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/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-88",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-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:"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-89",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-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:"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-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.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:"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-91",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-135",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-136",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-92",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-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:"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-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:"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-93",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-139",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-140",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-94",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-141",children:"Returns"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"Function"})}),"\n",(0,r.jsx)(s.h5,{id:"parameters-95",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-142",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-96",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-143",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-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.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-98",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-145",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-99",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.p,{children:"boolean true => pin, false => unpin"}),"\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:"boolean"}),">"]}),"\n",(0,r.jsx)(s.p,{children:"boolean true: worked"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.jsx)(s.h3,{id:"pinmessage",children:"pinMessage()"}),"\n",(0,r.jsxs)(s.blockquote,{children:["\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"pinMessage"}),"(",(0,r.jsx)(s.code,{children:"id"}),", ",(0,r.jsx)(s.code,{children:"pin"}),", ",(0,r.jsx)(s.code,{children:"pinDuration"}),"): ",(0,r.jsx)(s.code,{children:"Promise"}),"<",(0,r.jsx)(s.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,r.jsx)(s.p,{children:"Pin/Unpin message"}),"\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:"id"}),": ",(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"}),"\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.p,{children:"boolean true => pin, false => unpin"}),"\n",(0,r.jsxs)(s.p,{children:["\u2022 ",(0,r.jsx)(s.strong,{children:"pinDuration"}),": ",(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/type-aliases/MessagePinDuration",children:(0,r.jsx)(s.code,{children:"MessagePinDuration"})})," = ",(0,r.jsx)(s.code,{children:'"ThirtyDays"'})]}),"\n",(0,r.jsxs)(s.p,{children:["The length of time to pin the message. Default ",(0,r.jsx)(s.code,{children:"ThirtyDays"})]}),"\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:"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-101",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-148",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-102",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-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.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-103",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-150",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-104",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-151",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-105",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-152",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-106",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-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:"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-107",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-154",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-155",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-108",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-156",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-109",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-157",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-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:"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-110",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-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:"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-111",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-160",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-112",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-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.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-113",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-162",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-114",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-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.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-115",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-164",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-116",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-165",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-117",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-166",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-118",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-167",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-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.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-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.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-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.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-169",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-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:["\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-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:"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-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.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-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.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-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.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-172",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-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:["\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-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.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-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.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-174",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-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:"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-175",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-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.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-176",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-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:"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-177",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-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.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-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.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-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.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-179",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-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.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-180",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-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.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-181",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-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:"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-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.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-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:["\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-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:"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-135",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-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.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-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.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-185",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-137",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-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:"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-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.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-187",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-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/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-188",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-140",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-189",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-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/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-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.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-142",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-191",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-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.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-192",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-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.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-193",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-145",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-194",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-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:["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-195",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-147",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-196",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-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:["\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-197",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-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.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-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.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-150",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-199",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-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:"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-200",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-152",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-201",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-153",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-202",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-154",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-203",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-155",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-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.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-156",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-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.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-157",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-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.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-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:"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-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:"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-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: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-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 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-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: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-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 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-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: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-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 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-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: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-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 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-163",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-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.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-164",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-213",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-165",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-214",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-166",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-215",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-167",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-216",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-168",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-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.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-169",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-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.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-170",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-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.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-171",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-220",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-221",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-172",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-222",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-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:"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-174",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-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.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-175",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-225",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-176",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-226",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-177",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-227",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-228",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-229",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-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 function that handles a [[Message]] as the first and only parameter."}),"\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.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-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 function that handles a [[Chat]] (group chat) as the first and only parameter."}),"\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.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-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.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-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",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-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:"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-182",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-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.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-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-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-184",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-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.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-185",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-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-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-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 [[ChatId]] 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.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-187",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-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.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-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 [[Chat]] 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:"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-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:"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-190",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-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.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-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 function that handles a [[ParticipantChangedEventModel]] as the first and only parameter."}),"\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.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-192",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-244",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-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.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"})," | ",(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-194",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-246",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-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.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-247",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-196",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-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.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-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-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-198",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-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.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-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-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-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"}),"\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.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-201",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-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-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-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 function that handles a [[Chat]] (group chat) as the first and only parameter."}),"\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.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-203",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-255",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-204",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-256",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/60a6a671.a11ac1c8.js b/assets/js/60a6a671.a11ac1c8.js new file mode 100644 index 0000000000..1ed4bb786b --- /dev/null +++ b/assets/js/60a6a671.a11ac1c8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[9593],{5114:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>r,metadata:()=>o,toc:()=>d});var t=n(4848),a=n(8453);const r={},i="Type Alias: MessagePinDuration",o={id:"reference/api/model/message/type-aliases/MessagePinDuration",title:"Type Alias: MessagePinDuration",description:'MessagePinDuration: "FifteenSeconds" \\| "FiveSeconds" \\| "OneDay" \\| "OneMinute" \\| "SevenDays" \\| "ThirtyDays"',source:"@site/docs/reference/api/model/message/type-aliases/MessagePinDuration.md",sourceDirName:"reference/api/model/message/type-aliases",slug:"/reference/api/model/message/type-aliases/MessagePinDuration",permalink:"/docs/reference/api/model/message/type-aliases/MessagePinDuration",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/type-aliases/MessagePinDuration.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: ReactionSender",permalink:"/docs/reference/api/model/message/interfaces/ReactionSender"},next:{title:"api/model/product",permalink:"/docs/reference/api/model/product/"}},c={},d=[];function l(e){const s={blockquote:"blockquote",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"type-alias-messagepinduration",children:"Type Alias: MessagePinDuration"})}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"MessagePinDuration"}),": ",(0,t.jsx)(s.code,{children:'"FifteenSeconds"'})," | ",(0,t.jsx)(s.code,{children:'"FiveSeconds"'})," | ",(0,t.jsx)(s.code,{children:'"OneDay"'})," | ",(0,t.jsx)(s.code,{children:'"OneMinute"'})," | ",(0,t.jsx)(s.code,{children:'"SevenDays"'})," | ",(0,t.jsx)(s.code,{children:'"ThirtyDays"'})]}),"\n"]})]})}function u(e={}){const{wrapper:s}={...(0,a.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>i,x:()=>o});var t=n(6540);const a={},r=t.createContext(a);function i(e){const s=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),t.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6f5ae7fe.3696e579.js b/assets/js/6f5ae7fe.5c6077ae.js similarity index 97% rename from assets/js/6f5ae7fe.3696e579.js rename to assets/js/6f5ae7fe.5c6077ae.js index 958cef2013..3396e1856b 100644 --- a/assets/js/6f5ae7fe.3696e579.js +++ b/assets/js/6f5ae7fe.5c6077ae.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.74.2",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.75.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/73d41d19.d15ff4ab.js b/assets/js/73d41d19.d15ff4ab.js new file mode 100644 index 0000000000..b218f1760b --- /dev/null +++ b/assets/js/73d41d19.d15ff4ab.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5352],{2970:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>o,contentTitle:()=>l,default:()=>h,frontMatter:()=>a,metadata:()=>d,toc:()=>c});var n=s(4848),i=s(8453);const a={},l="api/model",d={id:"reference/api/model/index",title:"api/model",description:"Index",source:"@site/docs/reference/api/model/index.md",sourceDirName:"reference/api/model",slug:"/reference/api/model/",permalink:"/docs/reference/api/model/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: ExposedFn",permalink:"/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn"},next:{title:"api/model/aliases",permalink:"/docs/reference/api/model/aliases/"}},o={},c=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Type Aliases",id:"type-aliases",level:3},{value:"References",id:"references",level:2},{value:"AccountNumber",id:"accountnumber",level:3},{value:"AddParticipantError",id:"addparticipanterror",level:3},{value:"AddParticipantErrorStatusCode",id:"addparticipanterrorstatuscode",level:3},{value:"AdvancedConfig",id:"advancedconfig",level:3},{value:"AdvancedFile",id:"advancedfile",level:3},{value:"Base64",id:"base64",level:3},{value:"BaseChat",id:"basechat",level:3},{value:"BizCategory",id:"bizcategory",level:3},{value:"BizProfileOptions",id:"bizprofileoptions",level:3},{value:"BusinessHours",id:"businesshours",level:3},{value:"BusinessProfile",id:"businessprofile",level:3},{value:"CLOUD_PROVIDERS",id:"cloud_providers",level:3},{value:"Call",id:"call",level:3},{value:"CallState",id:"callstate",level:3},{value:"CartItem",id:"cartitem",level:3},{value:"Chat",id:"chat",level:3},{value:"ChatId",id:"chatid",level:3},{value:"ChatMuteDuration",id:"chatmuteduration",level:3},{value:"ChatServer",id:"chatserver",level:3},{value:"ChatState",id:"chatstate",level:3},{value:"ChatTypes",id:"chattypes",level:3},{value:"ConfigObject",id:"configobject",level:3},{value:"Contact",id:"contact",level:3},{value:"ContactId",id:"contactid",level:3},{value:"Content",id:"content",level:3},{value:"CountryCode",id:"countrycode",level:3},{value:"CustomError",id:"customerror",level:3},{value:"CustomProduct",id:"customproduct",level:3},{value:"DIRECTORY_STRATEGY",id:"directory_strategy",level:3},{value:"DataURL",id:"dataurl",level:3},{value:"DevTools",id:"devtools",level:3},{value:"ERROR_NAME",id:"error_name",level:3},{value:"EphemeralDuration",id:"ephemeralduration",level:3},{value:"EventPayload",id:"eventpayload",level:3},{value:"FilePath",id:"filepath",level:3},{value:"GetURL",id:"geturl",level:3},{value:"GroupChat",id:"groupchat",level:3},{value:"GroupChatCreationParticipantAddResponse",id:"groupchatcreationparticipantaddresponse",level:3},{value:"GroupChatCreationResponse",id:"groupchatcreationresponse",level:3},{value:"GroupChatId",id:"groupchatid",level:3},{value:"GroupChatServer",id:"groupchatserver",level:3},{value:"GroupId",id:"groupid",level:3},{value:"Label",id:"label",level:3},{value:"LicenseType",id:"licensetype",level:3},{value:"LiveLocationChangedEvent",id:"livelocationchangedevent",level:3},{value:"Message",id:"message",level:3},{value:"MessageAck",id:"messageack",level:3},{value:"MessageId",id:"messageid",level:3},{value:"MessageInfo",id:"messageinfo",level:3},{value:"MessageInfoInteraction",id:"messageinfointeraction",level:3},{value:"MessagePinDuration",id:"messagepinduration",level:3},{value:"MessageTypes",id:"messagetypes",level:3},{value:"Mp4StickerConversionProcessOptions",id:"mp4stickerconversionprocessoptions",level:3},{value:"NonSerializedId",id:"nonserializedid",level:3},{value:"NotificationLanguage",id:"notificationlanguage",level:3},{value:"NumberCheck",id:"numbercheck",level:3},{value:"OnError",id:"onerror",level:3},{value:"Order",id:"order",level:3},{value:"PageEvaluationTimeout",id:"pageevaluationtimeout",level:3},{value:"PollData",id:"polldata",level:3},{value:"PollOption",id:"polloption",level:3},{value:"PollVote",id:"pollvote",level:3},{value:"Product",id:"product",level:3},{value:"ProxyServerCredentials",id:"proxyservercredentials",level:3},{value:"QRFormat",id:"qrformat",level:3},{value:"QRQuality",id:"qrquality",level:3},{value:"QuoteMap",id:"quotemap",level:3},{value:"Reaction",id:"reaction",level:3},{value:"ReactionEvent",id:"reactionevent",level:3},{value:"ReactionRecord",id:"reactionrecord",level:3},{value:"ReactionSender",id:"reactionsender",level:3},{value:"SessionData",id:"sessiondata",level:3},{value:"SessionExpiredError",id:"sessionexpirederror",level:3},{value:"SimpleListener",id:"simplelistener",level:3},{value:"SingleChat",id:"singlechat",level:3},{value:"StickerMetadata",id:"stickermetadata",level:3},{value:"WaServers",id:"waservers",level:3},{value:"Webhook",id:"webhook",level:3},{value:"defaultProcessOptions",id:"defaultprocessoptions",level:3}];function t(e){const r={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",li:"li",p:"p",ul:"ul",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"apimodel",children:"api/model"})}),"\n",(0,n.jsx)(r.h2,{id:"index",children:"Index"}),"\n",(0,n.jsx)(r.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/enumerations/Events",children:"Events"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/enumerations/STATE",children:"STATE"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/enumerations/Status",children:"Status"})}),"\n"]}),"\n",(0,n.jsx)(r.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/type-aliases/EasyApiResponse",children:"EasyApiResponse"})}),"\n"]}),"\n",(0,n.jsx)(r.h2,{id:"references",children:"References"}),"\n",(0,n.jsx)(r.h3,{id:"accountnumber",children:"AccountNumber"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/AccountNumber",children:"AccountNumber"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"addparticipanterror",children:"AddParticipantError"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/AddParticipantError",children:"AddParticipantError"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"addparticipanterrorstatuscode",children:"AddParticipantErrorStatusCode"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode",children:"AddParticipantErrorStatusCode"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"advancedconfig",children:"AdvancedConfig"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/type-aliases/AdvancedConfig",children:"AdvancedConfig"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"advancedfile",children:"AdvancedFile"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:"AdvancedFile"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"base64",children:"Base64"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:"Base64"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"basechat",children:"BaseChat"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:"BaseChat"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"bizcategory",children:"BizCategory"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/BizCategory",children:"BizCategory"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"bizprofileoptions",children:"BizProfileOptions"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/BizProfileOptions",children:"BizProfileOptions"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"businesshours",children:"BusinessHours"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessHours",children:"BusinessHours"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"businessprofile",children:"BusinessProfile"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessProfile",children:"BusinessProfile"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"cloud_providers",children:"CLOUD_PROVIDERS"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS",children:"CLOUD_PROVIDERS"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"call",children:"Call"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/call/interfaces/Call",children:"Call"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"callstate",children:"CallState"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/call/enumerations/CallState",children:"CallState"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"cartitem",children:"CartItem"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/CartItem",children:"CartItem"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chat",children:"Chat"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:"Chat"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chatid",children:"ChatId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:"ChatId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chatmuteduration",children:"ChatMuteDuration"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/enumerations/ChatMuteDuration",children:"ChatMuteDuration"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chatserver",children:"ChatServer"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatServer",children:"ChatServer"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chatstate",children:"ChatState"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/enumerations/ChatState",children:"ChatState"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chattypes",children:"ChatTypes"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/enumerations/ChatTypes",children:"ChatTypes"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"configobject",children:"ConfigObject"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/ConfigObject",children:"ConfigObject"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"contact",children:"Contact"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:"Contact"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"contactid",children:"ContactId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:"ContactId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"content",children:"Content"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:"Content"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"countrycode",children:"CountryCode"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/CountryCode",children:"CountryCode"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"customerror",children:"CustomError"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/CustomError",children:"CustomError"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"customproduct",children:"CustomProduct"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/CustomProduct",children:"CustomProduct"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"directory_strategy",children:"DIRECTORY_STRATEGY"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY",children:"DIRECTORY_STRATEGY"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"dataurl",children:"DataURL"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:"DataURL"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"devtools",children:"DevTools"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/DevTools",children:"DevTools"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"error_name",children:"ERROR_NAME"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/enumerations/ERROR_NAME",children:"ERROR_NAME"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"ephemeralduration",children:"EphemeralDuration"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/type-aliases/EphemeralDuration",children:"EphemeralDuration"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"eventpayload",children:"EventPayload"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/EventPayload",children:"EventPayload"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"filepath",children:"FilePath"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/FilePath",children:"FilePath"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"geturl",children:"GetURL"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/GetURL",children:"GetURL"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupchat",children:"GroupChat"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChat",children:"GroupChat"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupchatcreationparticipantaddresponse",children:"GroupChatCreationParticipantAddResponse"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse",children:"GroupChatCreationParticipantAddResponse"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupchatcreationresponse",children:"GroupChatCreationResponse"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse",children:"GroupChatCreationResponse"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupchatid",children:"GroupChatId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:"GroupChatId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupchatserver",children:"GroupChatServer"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatServer",children:"GroupChatServer"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupid",children:"GroupId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupId",children:"GroupId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"label",children:"Label"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/label/interfaces/Label",children:"Label"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"licensetype",children:"LicenseType"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/LicenseType",children:"LicenseType"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"livelocationchangedevent",children:"LiveLocationChangedEvent"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent",children:"LiveLocationChangedEvent"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"message",children:"Message"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:"Message"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messageack",children:"MessageAck"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/enumerations/MessageAck",children:"MessageAck"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messageid",children:"MessageId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:"MessageId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messageinfo",children:"MessageInfo"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfo",children:"MessageInfo"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messageinfointeraction",children:"MessageInfoInteraction"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction",children:"MessageInfoInteraction"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messagepinduration",children:"MessagePinDuration"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/type-aliases/MessagePinDuration",children:"MessagePinDuration"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messagetypes",children:"MessageTypes"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/enumerations/MessageTypes",children:"MessageTypes"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"mp4stickerconversionprocessoptions",children:"Mp4StickerConversionProcessOptions"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions",children:"Mp4StickerConversionProcessOptions"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"nonserializedid",children:"NonSerializedId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/NonSerializedId",children:"NonSerializedId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"notificationlanguage",children:"NotificationLanguage"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/NotificationLanguage",children:"NotificationLanguage"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"numbercheck",children:"NumberCheck"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/NumberCheck",children:"NumberCheck"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"onerror",children:"OnError"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/OnError",children:"OnError"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"order",children:"Order"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/Order",children:"Order"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"pageevaluationtimeout",children:"PageEvaluationTimeout"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/PageEvaluationTimeout",children:"PageEvaluationTimeout"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"polldata",children:"PollData"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/PollData",children:"PollData"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"polloption",children:"PollOption"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/PollOption",children:"PollOption"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"pollvote",children:"PollVote"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/PollVote",children:"PollVote"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"product",children:"Product"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:"Product"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"proxyservercredentials",children:"ProxyServerCredentials"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/ProxyServerCredentials",children:"ProxyServerCredentials"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"qrformat",children:"QRFormat"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/QRFormat",children:"QRFormat"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"qrquality",children:"QRQuality"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/QRQuality",children:"QRQuality"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"quotemap",children:"QuoteMap"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/QuoteMap",children:"QuoteMap"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"reaction",children:"Reaction"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/reactions/type-aliases/Reaction",children:"Reaction"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"reactionevent",children:"ReactionEvent"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/reactions/type-aliases/ReactionEvent",children:"ReactionEvent"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"reactionrecord",children:"ReactionRecord"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/reactions/type-aliases/ReactionRecord",children:"ReactionRecord"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"reactionsender",children:"ReactionSender"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/ReactionSender",children:"ReactionSender"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"sessiondata",children:"SessionData"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/SessionData",children:"SessionData"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"sessionexpirederror",children:"SessionExpiredError"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/SessionExpiredError",children:"SessionExpiredError"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"simplelistener",children:"SimpleListener"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:"SimpleListener"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"singlechat",children:"SingleChat"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/SingleChat",children:"SingleChat"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"stickermetadata",children:"StickerMetadata"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:"StickerMetadata"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"waservers",children:"WaServers"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/WaServers",children:"WaServers"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"webhook",children:"Webhook"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:"Webhook"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"defaultprocessoptions",children:"defaultProcessOptions"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/media/variables/defaultProcessOptions",children:"defaultProcessOptions"})]})]})}function h(e={}){const{wrapper:r}={...(0,i.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(t,{...e})}):t(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>l,x:()=>d});var n=s(6540);const i={},a=n.createContext(i);function l(e){const r=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function d(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(a.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/73d41d19.da269f44.js b/assets/js/73d41d19.da269f44.js deleted file mode 100644 index 792167c9a8..0000000000 --- a/assets/js/73d41d19.da269f44.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5352],{2970:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>o,contentTitle:()=>l,default:()=>h,frontMatter:()=>a,metadata:()=>d,toc:()=>c});var n=s(4848),i=s(8453);const a={},l="api/model",d={id:"reference/api/model/index",title:"api/model",description:"Index",source:"@site/docs/reference/api/model/index.md",sourceDirName:"reference/api/model",slug:"/reference/api/model/",permalink:"/docs/reference/api/model/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Enumeration: ExposedFn",permalink:"/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn"},next:{title:"api/model/aliases",permalink:"/docs/reference/api/model/aliases/"}},o={},c=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Type Aliases",id:"type-aliases",level:3},{value:"References",id:"references",level:2},{value:"AccountNumber",id:"accountnumber",level:3},{value:"AddParticipantError",id:"addparticipanterror",level:3},{value:"AddParticipantErrorStatusCode",id:"addparticipanterrorstatuscode",level:3},{value:"AdvancedConfig",id:"advancedconfig",level:3},{value:"AdvancedFile",id:"advancedfile",level:3},{value:"Base64",id:"base64",level:3},{value:"BaseChat",id:"basechat",level:3},{value:"BizCategory",id:"bizcategory",level:3},{value:"BizProfileOptions",id:"bizprofileoptions",level:3},{value:"BusinessHours",id:"businesshours",level:3},{value:"BusinessProfile",id:"businessprofile",level:3},{value:"CLOUD_PROVIDERS",id:"cloud_providers",level:3},{value:"Call",id:"call",level:3},{value:"CallState",id:"callstate",level:3},{value:"CartItem",id:"cartitem",level:3},{value:"Chat",id:"chat",level:3},{value:"ChatId",id:"chatid",level:3},{value:"ChatMuteDuration",id:"chatmuteduration",level:3},{value:"ChatServer",id:"chatserver",level:3},{value:"ChatState",id:"chatstate",level:3},{value:"ChatTypes",id:"chattypes",level:3},{value:"ConfigObject",id:"configobject",level:3},{value:"Contact",id:"contact",level:3},{value:"ContactId",id:"contactid",level:3},{value:"Content",id:"content",level:3},{value:"CountryCode",id:"countrycode",level:3},{value:"CustomError",id:"customerror",level:3},{value:"CustomProduct",id:"customproduct",level:3},{value:"DIRECTORY_STRATEGY",id:"directory_strategy",level:3},{value:"DataURL",id:"dataurl",level:3},{value:"DevTools",id:"devtools",level:3},{value:"ERROR_NAME",id:"error_name",level:3},{value:"EphemeralDuration",id:"ephemeralduration",level:3},{value:"EventPayload",id:"eventpayload",level:3},{value:"FilePath",id:"filepath",level:3},{value:"GetURL",id:"geturl",level:3},{value:"GroupChat",id:"groupchat",level:3},{value:"GroupChatCreationParticipantAddResponse",id:"groupchatcreationparticipantaddresponse",level:3},{value:"GroupChatCreationResponse",id:"groupchatcreationresponse",level:3},{value:"GroupChatId",id:"groupchatid",level:3},{value:"GroupChatServer",id:"groupchatserver",level:3},{value:"GroupId",id:"groupid",level:3},{value:"Label",id:"label",level:3},{value:"LicenseType",id:"licensetype",level:3},{value:"LiveLocationChangedEvent",id:"livelocationchangedevent",level:3},{value:"Message",id:"message",level:3},{value:"MessageAck",id:"messageack",level:3},{value:"MessageId",id:"messageid",level:3},{value:"MessageInfo",id:"messageinfo",level:3},{value:"MessageInfoInteraction",id:"messageinfointeraction",level:3},{value:"MessageTypes",id:"messagetypes",level:3},{value:"Mp4StickerConversionProcessOptions",id:"mp4stickerconversionprocessoptions",level:3},{value:"NonSerializedId",id:"nonserializedid",level:3},{value:"NotificationLanguage",id:"notificationlanguage",level:3},{value:"NumberCheck",id:"numbercheck",level:3},{value:"OnError",id:"onerror",level:3},{value:"Order",id:"order",level:3},{value:"PageEvaluationTimeout",id:"pageevaluationtimeout",level:3},{value:"PollData",id:"polldata",level:3},{value:"PollOption",id:"polloption",level:3},{value:"PollVote",id:"pollvote",level:3},{value:"Product",id:"product",level:3},{value:"ProxyServerCredentials",id:"proxyservercredentials",level:3},{value:"QRFormat",id:"qrformat",level:3},{value:"QRQuality",id:"qrquality",level:3},{value:"QuoteMap",id:"quotemap",level:3},{value:"Reaction",id:"reaction",level:3},{value:"ReactionEvent",id:"reactionevent",level:3},{value:"ReactionRecord",id:"reactionrecord",level:3},{value:"ReactionSender",id:"reactionsender",level:3},{value:"SessionData",id:"sessiondata",level:3},{value:"SessionExpiredError",id:"sessionexpirederror",level:3},{value:"SimpleListener",id:"simplelistener",level:3},{value:"SingleChat",id:"singlechat",level:3},{value:"StickerMetadata",id:"stickermetadata",level:3},{value:"WaServers",id:"waservers",level:3},{value:"Webhook",id:"webhook",level:3},{value:"defaultProcessOptions",id:"defaultprocessoptions",level:3}];function t(e){const r={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",li:"li",p:"p",ul:"ul",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"apimodel",children:"api/model"})}),"\n",(0,n.jsx)(r.h2,{id:"index",children:"Index"}),"\n",(0,n.jsx)(r.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/enumerations/Events",children:"Events"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/enumerations/STATE",children:"STATE"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/enumerations/Status",children:"Status"})}),"\n"]}),"\n",(0,n.jsx)(r.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/type-aliases/EasyApiResponse",children:"EasyApiResponse"})}),"\n"]}),"\n",(0,n.jsx)(r.h2,{id:"references",children:"References"}),"\n",(0,n.jsx)(r.h3,{id:"accountnumber",children:"AccountNumber"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/AccountNumber",children:"AccountNumber"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"addparticipanterror",children:"AddParticipantError"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/AddParticipantError",children:"AddParticipantError"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"addparticipanterrorstatuscode",children:"AddParticipantErrorStatusCode"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode",children:"AddParticipantErrorStatusCode"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"advancedconfig",children:"AdvancedConfig"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/type-aliases/AdvancedConfig",children:"AdvancedConfig"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"advancedfile",children:"AdvancedFile"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",children:"AdvancedFile"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"base64",children:"Base64"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/Base64",children:"Base64"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"basechat",children:"BaseChat"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/BaseChat",children:"BaseChat"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"bizcategory",children:"BizCategory"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/BizCategory",children:"BizCategory"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"bizprofileoptions",children:"BizProfileOptions"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/BizProfileOptions",children:"BizProfileOptions"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"businesshours",children:"BusinessHours"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessHours",children:"BusinessHours"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"businessprofile",children:"BusinessProfile"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/BusinessProfile",children:"BusinessProfile"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"cloud_providers",children:"CLOUD_PROVIDERS"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS",children:"CLOUD_PROVIDERS"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"call",children:"Call"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/call/interfaces/Call",children:"Call"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"callstate",children:"CallState"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/call/enumerations/CallState",children:"CallState"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"cartitem",children:"CartItem"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/CartItem",children:"CartItem"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chat",children:"Chat"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/type-aliases/Chat",children:"Chat"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chatid",children:"ChatId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatId",children:"ChatId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chatmuteduration",children:"ChatMuteDuration"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/enumerations/ChatMuteDuration",children:"ChatMuteDuration"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chatserver",children:"ChatServer"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/ChatServer",children:"ChatServer"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chatstate",children:"ChatState"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/enumerations/ChatState",children:"ChatState"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"chattypes",children:"ChatTypes"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/enumerations/ChatTypes",children:"ChatTypes"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"configobject",children:"ConfigObject"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/ConfigObject",children:"ConfigObject"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"contact",children:"Contact"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/Contact",children:"Contact"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"contactid",children:"ContactId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:"ContactId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"content",children:"Content"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/Content",children:"Content"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"countrycode",children:"CountryCode"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/CountryCode",children:"CountryCode"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"customerror",children:"CustomError"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/CustomError",children:"CustomError"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"customproduct",children:"CustomProduct"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/CustomProduct",children:"CustomProduct"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"directory_strategy",children:"DIRECTORY_STRATEGY"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY",children:"DIRECTORY_STRATEGY"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"dataurl",children:"DataURL"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/DataURL",children:"DataURL"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"devtools",children:"DevTools"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/DevTools",children:"DevTools"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"error_name",children:"ERROR_NAME"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/enumerations/ERROR_NAME",children:"ERROR_NAME"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"ephemeralduration",children:"EphemeralDuration"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/type-aliases/EphemeralDuration",children:"EphemeralDuration"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"eventpayload",children:"EventPayload"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/EventPayload",children:"EventPayload"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"filepath",children:"FilePath"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/FilePath",children:"FilePath"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"geturl",children:"GetURL"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/GetURL",children:"GetURL"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupchat",children:"GroupChat"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChat",children:"GroupChat"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupchatcreationparticipantaddresponse",children:"GroupChatCreationParticipantAddResponse"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse",children:"GroupChatCreationParticipantAddResponse"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupchatcreationresponse",children:"GroupChatCreationResponse"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse",children:"GroupChatCreationResponse"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupchatid",children:"GroupChatId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",children:"GroupChatId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupchatserver",children:"GroupChatServer"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupChatServer",children:"GroupChatServer"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"groupid",children:"GroupId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/GroupId",children:"GroupId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"label",children:"Label"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/label/interfaces/Label",children:"Label"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"licensetype",children:"LicenseType"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/LicenseType",children:"LicenseType"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"livelocationchangedevent",children:"LiveLocationChangedEvent"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent",children:"LiveLocationChangedEvent"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"message",children:"Message"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:"Message"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messageack",children:"MessageAck"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/enumerations/MessageAck",children:"MessageAck"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messageid",children:"MessageId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:"MessageId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messageinfo",children:"MessageInfo"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfo",children:"MessageInfo"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messageinfointeraction",children:"MessageInfoInteraction"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction",children:"MessageInfoInteraction"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"messagetypes",children:"MessageTypes"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/enumerations/MessageTypes",children:"MessageTypes"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"mp4stickerconversionprocessoptions",children:"Mp4StickerConversionProcessOptions"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions",children:"Mp4StickerConversionProcessOptions"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"nonserializedid",children:"NonSerializedId"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/NonSerializedId",children:"NonSerializedId"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"notificationlanguage",children:"NotificationLanguage"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/NotificationLanguage",children:"NotificationLanguage"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"numbercheck",children:"NumberCheck"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/contact/interfaces/NumberCheck",children:"NumberCheck"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"onerror",children:"OnError"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/OnError",children:"OnError"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"order",children:"Order"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/Order",children:"Order"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"pageevaluationtimeout",children:"PageEvaluationTimeout"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/PageEvaluationTimeout",children:"PageEvaluationTimeout"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"polldata",children:"PollData"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/PollData",children:"PollData"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"polloption",children:"PollOption"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/PollOption",children:"PollOption"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"pollvote",children:"PollVote"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/PollVote",children:"PollVote"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"product",children:"Product"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:"Product"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"proxyservercredentials",children:"ProxyServerCredentials"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/ProxyServerCredentials",children:"ProxyServerCredentials"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"qrformat",children:"QRFormat"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/QRFormat",children:"QRFormat"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"qrquality",children:"QRQuality"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/enumerations/QRQuality",children:"QRQuality"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"quotemap",children:"QuoteMap"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/QuoteMap",children:"QuoteMap"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"reaction",children:"Reaction"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/reactions/type-aliases/Reaction",children:"Reaction"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"reactionevent",children:"ReactionEvent"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/reactions/type-aliases/ReactionEvent",children:"ReactionEvent"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"reactionrecord",children:"ReactionRecord"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/reactions/type-aliases/ReactionRecord",children:"ReactionRecord"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"reactionsender",children:"ReactionSender"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/message/interfaces/ReactionSender",children:"ReactionSender"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"sessiondata",children:"SessionData"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/SessionData",children:"SessionData"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"sessionexpirederror",children:"SessionExpiredError"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/errors/classes/SessionExpiredError",children:"SessionExpiredError"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"simplelistener",children:"SimpleListener"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/events/enumerations/SimpleListener",children:"SimpleListener"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"singlechat",children:"SingleChat"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/chat/interfaces/SingleChat",children:"SingleChat"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"stickermetadata",children:"StickerMetadata"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/media/type-aliases/StickerMetadata",children:"StickerMetadata"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"waservers",children:"WaServers"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/aliases/type-aliases/WaServers",children:"WaServers"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"webhook",children:"Webhook"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/config/interfaces/Webhook",children:"Webhook"})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"defaultprocessoptions",children:"defaultProcessOptions"}),"\n",(0,n.jsxs)(r.p,{children:["Re-exports ",(0,n.jsx)(r.a,{href:"/docs/reference/api/model/media/variables/defaultProcessOptions",children:"defaultProcessOptions"})]})]})}function h(e={}){const{wrapper:r}={...(0,i.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(t,{...e})}):t(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>l,x:()=>d});var n=s(6540);const i={},a=n.createContext(i);function l(e){const r=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function d(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(a.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/83d3b456.0f2d33ad.js b/assets/js/83d3b456.0f2d33ad.js new file mode 100644 index 0000000000..ec3b56d0ab --- /dev/null +++ b/assets/js/83d3b456.0f2d33ad.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8976],{678:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>d,metadata:()=>i,toc:()=>a});var n=t(4848),c=t(8453);const d={},o="api/model/product",i={id:"reference/api/model/product/index",title:"api/model/product",description:"Index",source:"@site/docs/reference/api/model/product/index.md",sourceDirName:"reference/api/model/product",slug:"/reference/api/model/product/",permalink:"/docs/reference/api/model/product/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/product/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Type Alias: MessagePinDuration",permalink:"/docs/reference/api/model/message/type-aliases/MessagePinDuration"},next:{title:"Interface: CartItem",permalink:"/docs/reference/api/model/product/interfaces/CartItem"}},s={},a=[{value:"Index",id:"index",level:2},{value:"Interfaces",id:"interfaces",level:3}];function l(e){const r={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,c.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"apimodelproduct",children:"api/model/product"})}),"\n",(0,n.jsx)(r.h2,{id:"index",children:"Index"}),"\n",(0,n.jsx)(r.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/CartItem",children:"CartItem"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/CustomProduct",children:"CustomProduct"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/Order",children:"Order"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:"Product"})}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,c.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>o,x:()=>i});var n=t(6540);const c={},d=n.createContext(c);function o(e){const r=n.useContext(d);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),n.createElement(d.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/83d3b456.58fd577f.js b/assets/js/83d3b456.58fd577f.js deleted file mode 100644 index 560c671546..0000000000 --- a/assets/js/83d3b456.58fd577f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8976],{678:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>d,metadata:()=>i,toc:()=>a});var n=t(4848),c=t(8453);const d={},o="api/model/product",i={id:"reference/api/model/product/index",title:"api/model/product",description:"Index",source:"@site/docs/reference/api/model/product/index.md",sourceDirName:"reference/api/model/product",slug:"/reference/api/model/product/",permalink:"/docs/reference/api/model/product/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/product/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: ReactionSender",permalink:"/docs/reference/api/model/message/interfaces/ReactionSender"},next:{title:"Interface: CartItem",permalink:"/docs/reference/api/model/product/interfaces/CartItem"}},s={},a=[{value:"Index",id:"index",level:2},{value:"Interfaces",id:"interfaces",level:3}];function l(e){const r={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,c.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"apimodelproduct",children:"api/model/product"})}),"\n",(0,n.jsx)(r.h2,{id:"index",children:"Index"}),"\n",(0,n.jsx)(r.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/CartItem",children:"CartItem"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/CustomProduct",children:"CustomProduct"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/Order",children:"Order"})}),"\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/reference/api/model/product/interfaces/Product",children:"Product"})}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,c.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>o,x:()=>i});var n=t(6540);const c={},d=n.createContext(c);function o(e){const r=n.useContext(d);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:o(e.components),n.createElement(d.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a8e44dab.a0444047.js b/assets/js/a8e44dab.a0444047.js deleted file mode 100644 index 7d7226ecff..0000000000 --- a/assets/js/a8e44dab.a0444047.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6262],{9225:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>d,metadata:()=>t,toc:()=>o});var r=s(4848),i=s(8453);const d={},c="Interface: ReactionSender",t={id:"reference/api/model/message/interfaces/ReactionSender",title:"Interface: ReactionSender",description:"Properties",source:"@site/docs/reference/api/model/message/interfaces/ReactionSender.md",sourceDirName:"reference/api/model/message/interfaces",slug:"/reference/api/model/message/interfaces/ReactionSender",permalink:"/docs/reference/api/model/message/interfaces/ReactionSender",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/interfaces/ReactionSender.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: QuoteMap",permalink:"/docs/reference/api/model/message/interfaces/QuoteMap"},next:{title:"api/model/product",permalink:"/docs/reference/api/model/product/"}},a={},o=[{value:"Properties",id:"properties",level:2},{value:"ack?",id:"ack",level:3},{value:"id",id:"id",level:3},{value:"isSendFailure",id:"issendfailure",level:3},{value:"msgKey",id:"msgkey",level:3},{value:"orphan",id:"orphan",level:3},{value:"parentMsgKey",id:"parentmsgkey",level:3},{value:"reactionText",id:"reactiontext",level:3},{value:"read",id:"read",level:3},{value:"senderUserJid",id:"senderuserjid",level:3},{value:"t?",id:"t",level:3},{value:"timestamp",id:"timestamp",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-reactionsender",children:"Interface: ReactionSender"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"ack",children:"ack?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"ack"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(n.code,{children:"MessageId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The message ID of the reaction itself"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"issendfailure",children:"isSendFailure"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"isSendFailure"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"msgkey",children:"msgKey"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"msgKey"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(n.code,{children:"MessageId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The message ID of the reaction itself"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"orphan",children:"orphan"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"orphan"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"parentmsgkey",children:"parentMsgKey"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"parentMsgKey"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(n.code,{children:"MessageId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The ID of the message being reacted to"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"reactiontext",children:"reactionText"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"reactionText"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The text of the reaction"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"read",children:"read"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"read"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"If the reaction was seen/read"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"senderuserjid",children:"senderUserJid"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"senderUserJid"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(n.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The contact ID of the sender of the reaction"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"t",children:"t?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"t"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The timestamp of the reaction"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"timestamp",children:"timestamp"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"timestamp"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The timestamp of the reaction"})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>c,x:()=>t});var r=s(6540);const i={},d=r.createContext(i);function c(e){const n=r.useContext(d);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a8e44dab.d386da81.js b/assets/js/a8e44dab.d386da81.js new file mode 100644 index 0000000000..301eb4bff5 --- /dev/null +++ b/assets/js/a8e44dab.d386da81.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[6262],{9225:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>t,toc:()=>o});var r=s(4848),i=s(8453);const c={},d="Interface: ReactionSender",t={id:"reference/api/model/message/interfaces/ReactionSender",title:"Interface: ReactionSender",description:"Properties",source:"@site/docs/reference/api/model/message/interfaces/ReactionSender.md",sourceDirName:"reference/api/model/message/interfaces",slug:"/reference/api/model/message/interfaces/ReactionSender",permalink:"/docs/reference/api/model/message/interfaces/ReactionSender",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/interfaces/ReactionSender.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Interface: QuoteMap",permalink:"/docs/reference/api/model/message/interfaces/QuoteMap"},next:{title:"Type Alias: MessagePinDuration",permalink:"/docs/reference/api/model/message/type-aliases/MessagePinDuration"}},a={},o=[{value:"Properties",id:"properties",level:2},{value:"ack?",id:"ack",level:3},{value:"id",id:"id",level:3},{value:"isSendFailure",id:"issendfailure",level:3},{value:"msgKey",id:"msgkey",level:3},{value:"orphan",id:"orphan",level:3},{value:"parentMsgKey",id:"parentmsgkey",level:3},{value:"reactionText",id:"reactiontext",level:3},{value:"read",id:"read",level:3},{value:"senderUserJid",id:"senderuserjid",level:3},{value:"t?",id:"t",level:3},{value:"timestamp",id:"timestamp",level:3}];function l(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"interface-reactionsender",children:"Interface: ReactionSender"})}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"ack",children:"ack?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"ack"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(n.code,{children:"MessageId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The message ID of the reaction itself"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"issendfailure",children:"isSendFailure"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"isSendFailure"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"msgkey",children:"msgKey"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"msgKey"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(n.code,{children:"MessageId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The message ID of the reaction itself"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"orphan",children:"orphan"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"orphan"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"parentmsgkey",children:"parentMsgKey"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"parentMsgKey"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/MessageId",children:(0,r.jsx)(n.code,{children:"MessageId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The ID of the message being reacted to"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"reactiontext",children:"reactionText"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"reactionText"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The text of the reaction"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"read",children:"read"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"read"}),": ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"If the reaction was seen/read"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"senderuserjid",children:"senderUserJid"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"senderUserJid"}),": ",(0,r.jsx)(n.a,{href:"/docs/reference/api/model/aliases/type-aliases/ContactId",children:(0,r.jsx)(n.code,{children:"ContactId"})})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The contact ID of the sender of the reaction"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"t",children:"t?"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"optional"})," ",(0,r.jsx)(n.strong,{children:"t"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The timestamp of the reaction"}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"timestamp",children:"timestamp"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"timestamp"}),": ",(0,r.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"The timestamp of the reaction"})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>d,x:()=>t});var r=s(6540);const i={},c=r.createContext(i);function d(e){const n=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),r.createElement(c.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d23fc473.1fcf6734.js b/assets/js/d23fc473.1fcf6734.js deleted file mode 100644 index bcc0d1dad9..0000000000 --- a/assets/js/d23fc473.1fcf6734.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5181],{2814:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>t,contentTitle:()=>c,default:()=>m,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var r=n(4848),a=n(8453);const i={},c="api/model/message",o={id:"reference/api/model/message/index",title:"api/model/message",description:"Index",source:"@site/docs/reference/api/model/message/index.md",sourceDirName:"reference/api/model/message",slug:"/reference/api/model/message/",permalink:"/docs/reference/api/model/message/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Variable: defaultProcessOptions",permalink:"/docs/reference/api/model/media/variables/defaultProcessOptions"},next:{title:"Enumeration: MessageAck",permalink:"/docs/reference/api/model/message/enumerations/MessageAck"}},t={},l=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Interfaces",id:"interfaces",level:3}];function d(e){const s={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"apimodelmessage",children:"api/model/message"})}),"\n",(0,r.jsx)(s.h2,{id:"index",children:"Index"}),"\n",(0,r.jsx)(s.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/enumerations/MessageAck",children:"MessageAck"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/enumerations/MessageTypes",children:"MessageTypes"})}),"\n"]}),"\n",(0,r.jsx)(s.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:"Message"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfo",children:"MessageInfo"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction",children:"MessageInfoInteraction"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollData",children:"PollData"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollOption",children:"PollOption"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollVote",children:"PollVote"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/QuoteMap",children:"QuoteMap"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/ReactionSender",children:"ReactionSender"})}),"\n"]})]})}function m(e={}){const{wrapper:s}={...(0,a.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>c,x:()=>o});var r=n(6540);const a={},i=r.createContext(a);function c(e){const s=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:c(e.components),r.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d23fc473.201892b5.js b/assets/js/d23fc473.201892b5.js new file mode 100644 index 0000000000..1fa488e43d --- /dev/null +++ b/assets/js/d23fc473.201892b5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5181],{2814:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>o,contentTitle:()=>c,default:()=>m,frontMatter:()=>i,metadata:()=>l,toc:()=>t});var r=n(4848),a=n(8453);const i={},c="api/model/message",l={id:"reference/api/model/message/index",title:"api/model/message",description:"Index",source:"@site/docs/reference/api/model/message/index.md",sourceDirName:"reference/api/model/message",slug:"/reference/api/model/message/",permalink:"/docs/reference/api/model/message/",draft:!1,unlisted:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/reference/api/model/message/index.md",tags:[],version:"current",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"Variable: defaultProcessOptions",permalink:"/docs/reference/api/model/media/variables/defaultProcessOptions"},next:{title:"Enumeration: MessageAck",permalink:"/docs/reference/api/model/message/enumerations/MessageAck"}},o={},t=[{value:"Index",id:"index",level:2},{value:"Enumerations",id:"enumerations",level:3},{value:"Interfaces",id:"interfaces",level:3},{value:"Type Aliases",id:"type-aliases",level:3}];function d(e){const s={a:"a",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ul:"ul",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"apimodelmessage",children:"api/model/message"})}),"\n",(0,r.jsx)(s.h2,{id:"index",children:"Index"}),"\n",(0,r.jsx)(s.h3,{id:"enumerations",children:"Enumerations"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/enumerations/MessageAck",children:"MessageAck"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/enumerations/MessageTypes",children:"MessageTypes"})}),"\n"]}),"\n",(0,r.jsx)(s.h3,{id:"interfaces",children:"Interfaces"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/Message",children:"Message"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfo",children:"MessageInfo"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction",children:"MessageInfoInteraction"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollData",children:"PollData"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollOption",children:"PollOption"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/PollVote",children:"PollVote"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/QuoteMap",children:"QuoteMap"})}),"\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/interfaces/ReactionSender",children:"ReactionSender"})}),"\n"]}),"\n",(0,r.jsx)(s.h3,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,r.jsxs)(s.ul,{children:["\n",(0,r.jsx)(s.li,{children:(0,r.jsx)(s.a,{href:"/docs/reference/api/model/message/type-aliases/MessagePinDuration",children:"MessagePinDuration"})}),"\n"]})]})}function m(e={}){const{wrapper:s}={...(0,a.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>c,x:()=>l});var r=n(6540);const a={},i=r.createContext(a);function c(e){const s=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:c(e.components),r.createElement(i.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/main.6263ff4e.js b/assets/js/main.6263ff4e.js deleted file mode 100644 index c5e950bfbe..0000000000 --- a/assets/js/main.6263ff4e.js +++ /dev/null @@ -1,2 +0,0 @@ -/*! For license information please see main.6263ff4e.js.LICENSE.txt */ -(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[8792],{3219:(e,t,n)=>{"use strict";n.d(t,{Bc:()=>g,E8:()=>qn,a1:()=>$n});var r=n(6540);n(961);function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}function c(e,t){return function(e){if(Array.isArray(e))return e}(e)||function(e,t){var n=null==e?null:"undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(null!=n){var r,o,a=[],i=!0,s=!1;try{for(n=n.call(e);!(i=(r=n.next()).done)&&(a.push(r.value),!t||a.length!==t);i=!0);}catch(e){s=!0,o=e}finally{try{i||null==n.return||n.return()}finally{if(s)throw o}}return a}}(e,t)||d(e,t)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function u(e){return function(e){if(Array.isArray(e))return p(e)}(e)||function(e){if("undefined"!=typeof Symbol&&null!=e[Symbol.iterator]||null!=e["@@iterator"])return Array.from(e)}(e)||d(e)||function(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function d(e,t){if(e){if("string"==typeof e)return p(e,t);var n=Object.prototype.toString.call(e).slice(8,-1);return"Object"===n&&e.constructor&&(n=e.constructor.name),"Map"===n||"Set"===n?Array.from(e):"Arguments"===n||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)?p(e,t):void 0}}function p(e,t){(null==t||t>e.length)&&(t=e.length);for(var n=0,r=new Array(t);ne.length)&&(t=e.length);for(var n=0,r=new Array(t);ne.length)&&(t=e.length);for(var n=0,r=new Array(t);n=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}function D(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function L(e){for(var t=1;t=3||2===n&&r>=4||1===n&&r>=10);function a(t,n,r){if(o&&void 0!==r){var a=r[0].__autocomplete_algoliaCredentials,i={"X-Algolia-Application-Id":a.appId,"X-Algolia-API-Key":a.apiKey};e.apply(void 0,[t].concat(j(n),[{headers:i}]))}else e.apply(void 0,[t].concat(j(n)))}return{init:function(t,n){e("init",{appId:t,apiKey:n})},setUserToken:function(t){e("setUserToken",t)},clickedObjectIDsAfterSearch:function(){for(var e=arguments.length,t=new Array(e),n=0;n0&&a("clickedObjectIDsAfterSearch",M(t),t[0].items)},clickedObjectIDs:function(){for(var e=arguments.length,t=new Array(e),n=0;n0&&a("clickedObjectIDs",M(t),t[0].items)},clickedFilters:function(){for(var t=arguments.length,n=new Array(t),r=0;r0&&e.apply(void 0,["clickedFilters"].concat(n))},convertedObjectIDsAfterSearch:function(){for(var e=arguments.length,t=new Array(e),n=0;n0&&a("convertedObjectIDsAfterSearch",M(t),t[0].items)},convertedObjectIDs:function(){for(var e=arguments.length,t=new Array(e),n=0;n0&&a("convertedObjectIDs",M(t),t[0].items)},convertedFilters:function(){for(var t=arguments.length,n=new Array(t),r=0;r0&&e.apply(void 0,["convertedFilters"].concat(n))},viewedObjectIDs:function(){for(var e=arguments.length,t=new Array(e),n=0;n0&&t.reduce((function(e,t){var n=t.items,r=I(t,T);return[].concat(j(e),j(function(e){for(var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:20,n=[],r=0;r0&&e.apply(void 0,["viewedFilters"].concat(n))}}}function B(e){var t=e.items.reduce((function(e,t){var n;return e[t.__autocomplete_indexName]=(null!==(n=e[t.__autocomplete_indexName])&&void 0!==n?n:[]).concat(t),e}),{});return Object.keys(t).map((function(e){return{index:e,items:t[e],algoliaSource:["autocomplete"]}}))}function z(e){return e.objectID&&e.__autocomplete_indexName&&e.__autocomplete_queryID}function U(e){return U="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},U(e)}function $(e){return function(e){if(Array.isArray(e))return q(e)}(e)||function(e){if("undefined"!=typeof Symbol&&null!=e[Symbol.iterator]||null!=e["@@iterator"])return Array.from(e)}(e)||function(e,t){if(e){if("string"==typeof e)return q(e,t);var n=Object.prototype.toString.call(e).slice(8,-1);return"Object"===n&&e.constructor&&(n=e.constructor.name),"Map"===n||"Set"===n?Array.from(e):"Arguments"===n||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)?q(e,t):void 0}}(e)||function(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function q(e,t){(null==t||t>e.length)&&(t=e.length);for(var n=0,r=new Array(t);n0&&K({onItemsChange:r,items:n,insights:s,state:t}))}}),0);return{name:"aa.algoliaInsightsPlugin",subscribe:function(e){var t=e.setContext,n=e.onSelect,r=e.onActive;i("addAlgoliaAgent","insights-plugin"),t({algoliaInsightsPlugin:{__algoliaSearchParameters:{clickAnalytics:!0},insights:s}}),n((function(e){var t=e.item,n=e.state,r=e.event;z(t)&&o({state:n,event:r,insights:s,item:t,insightsEvents:[G({eventName:"Item Selected"},C({item:t,items:l.current}))]})})),r((function(e){var t=e.item,n=e.state,r=e.event;z(t)&&a({state:n,event:r,insights:s,item:t,insightsEvents:[G({eventName:"Item Active"},C({item:t,items:l.current}))]})}))},onStateChange:function(e){var t=e.state;c({state:t})},__autocomplete_pluginOptions:e}}function Y(e,t){var n=t;return{then:function(t,r){return Y(e.then(J(t,n,e),J(r,n,e)),n)},catch:function(t){return Y(e.catch(J(t,n,e)),n)},finally:function(t){return t&&n.onCancelList.push(t),Y(e.finally(J(t&&function(){return n.onCancelList=[],t()},n,e)),n)},cancel:function(){n.isCanceled=!0;var e=n.onCancelList;n.onCancelList=[],e.forEach((function(e){e()}))},isCanceled:function(){return!0===n.isCanceled}}}function Z(e){return Y(e,{isCanceled:!1,onCancelList:[]})}function J(e,t,n){return e?function(n){return t.isCanceled?n:e(n)}:n}function X(e,t,n,r){if(!n)return null;if(e<0&&(null===t||null!==r&&0===t))return n+e;var o=(null===t?-1:t)+e;return o<=-1||o>=n?null===r?null:0:o}function ee(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function te(e){for(var t=1;te.length)&&(t=e.length);for(var n=0,r=new Array(t);n0},reshape:function(e){return e.sources}},e),{},{id:null!==(n=e.id)&&void 0!==n?n:"autocomplete-".concat(w++),plugins:o,initialState:ge({activeItemId:null,query:"",completion:null,collections:[],isOpen:!1,status:"idle",context:{}},e.initialState),onStateChange:function(t){var n;null===(n=e.onStateChange)||void 0===n||n.call(e,t),o.forEach((function(e){var n;return null===(n=e.onStateChange)||void 0===n?void 0:n.call(e,t)}))},onSubmit:function(t){var n;null===(n=e.onSubmit)||void 0===n||n.call(e,t),o.forEach((function(e){var n;return null===(n=e.onSubmit)||void 0===n?void 0:n.call(e,t)}))},onReset:function(t){var n;null===(n=e.onReset)||void 0===n||n.call(e,t),o.forEach((function(e){var n;return null===(n=e.onReset)||void 0===n?void 0:n.call(e,t)}))},getSources:function(n){return Promise.all([].concat(function(e){return function(e){if(Array.isArray(e))return me(e)}(e)||function(e){if("undefined"!=typeof Symbol&&null!=e[Symbol.iterator]||null!=e["@@iterator"])return Array.from(e)}(e)||function(e,t){if(e){if("string"==typeof e)return me(e,t);var n=Object.prototype.toString.call(e).slice(8,-1);return"Object"===n&&e.constructor&&(n=e.constructor.name),"Map"===n||"Set"===n?Array.from(e):"Arguments"===n||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)?me(e,t):void 0}}(e)||function(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}(o.map((function(e){return e.getSources}))),[e.getSources]).filter(Boolean).map((function(e){return function(e,t){var n=[];return Promise.resolve(e(t)).then((function(e){return Promise.all(e.filter((function(e){return Boolean(e)})).map((function(e){if(e.sourceId,n.includes(e.sourceId))throw new Error("[Autocomplete] The `sourceId` ".concat(JSON.stringify(e.sourceId)," is not unique."));n.push(e.sourceId);var t={getItemInputValue:function(e){return e.state.query},getItemUrl:function(){},onSelect:function(e){(0,e.setIsOpen)(!1)},onActive:_,onResolve:_};Object.keys(t).forEach((function(e){t[e].__default=!0}));var r=te(te({},t),e);return Promise.resolve(r)})))}))}(e,n)}))).then((function(e){return v(e)})).then((function(e){return e.map((function(e){return ge(ge({},e),{},{onSelect:function(n){e.onSelect(n),t.forEach((function(e){var t;return null===(t=e.onSelect)||void 0===t?void 0:t.call(e,n)}))},onActive:function(n){e.onActive(n),t.forEach((function(e){var t;return null===(t=e.onActive)||void 0===t?void 0:t.call(e,n)}))},onResolve:function(n){e.onResolve(n),t.forEach((function(e){var t;return null===(t=e.onResolve)||void 0===t?void 0:t.call(e,n)}))}})}))}))},navigator:ge({navigate:function(e){var t=e.itemUrl;r.location.assign(t)},navigateNewTab:function(e){var t=e.itemUrl,n=r.open(t,"_blank","noopener");null==n||n.focus()},navigateNewWindow:function(e){var t=e.itemUrl;r.open(t,"_blank","noopener")}},e.navigator)})}function ve(e){return ve="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},ve(e)}function we(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function Se(e){for(var t=1;te.length)&&(t=e.length);for(var n=0,r=new Array(t);n=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}(e,Re);Be&&o.environment.clearTimeout(Be);var c=l.setCollections,u=l.setIsOpen,d=l.setQuery,p=l.setActiveItemId,f=l.setStatus;if(d(a),p(o.defaultActiveItemId),!a&&!1===o.openOnFocus){var m,h=s.getState().collections.map((function(e){return De(De({},e),{},{items:[]})}));f("idle"),c(h),u(null!==(m=r.isOpen)&&void 0!==m?m:o.shouldPanelOpen({state:s.getState()}));var g=Z(ze(h).then((function(){return Promise.resolve()})));return s.pendingRequests.add(g)}f("loading"),Be=o.environment.setTimeout((function(){f("stalled")}),o.stallThreshold);var b=Z(ze(o.getSources(De({query:a,refresh:i,state:s.getState()},l)).then((function(e){return Promise.all(e.map((function(e){return Promise.resolve(e.getItems(De({query:a,refresh:i,state:s.getState()},l))).then((function(t){return function(e,t,n){if(o=e,Boolean(null==o?void 0:o.execute)){var r="algolia"===e.requesterId?Object.assign.apply(Object,[{}].concat(Oe(Object.keys(n.context).map((function(e){var t;return null===(t=n.context[e])||void 0===t?void 0:t.__algoliaSearchParameters}))))):{};return Ee(Ee({},e),{},{requests:e.queries.map((function(n){return{query:"algolia"===e.requesterId?Ee(Ee({},n),{},{params:Ee(Ee({},r),n.params)}):n,sourceId:t,transformResponse:e.transformResponse}}))})}var o;return{items:e,sourceId:t}}(t,e.sourceId,s.getState())}))}))).then(Ae).then((function(t){return function(e,t,n){return t.map((function(t){var r,o=e.filter((function(e){return e.sourceId===t.sourceId})),a=o.map((function(e){return e.items})),i=o[0].transformResponse,s=i?i({results:r=a,hits:r.map((function(e){return e.hits})).filter(Boolean),facetHits:r.map((function(e){var t;return null===(t=e.facetHits)||void 0===t?void 0:t.map((function(e){return{label:e.value,count:e.count,_highlightResult:{label:{value:e.highlighted}}}}))})).filter(Boolean)}):a;return t.onResolve({source:t,results:a,items:s,state:n.getState()}),s.every(Boolean),'The `getItems` function from source "'.concat(t.sourceId,'" must return an array of items but returned ').concat(JSON.stringify(void 0),".\n\nDid you forget to return items?\n\nSee: https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/sources/#param-getitems"),{source:t,items:s}}))}(t,e,s)})).then((function(e){return function(e){var t=e.props,n=e.state,r=e.collections.reduce((function(e,t){return Se(Se({},e),{},ke({},t.source.sourceId,Se(Se({},t.source),{},{getItems:function(){return v(t.items)}})))}),{}),o=t.plugins.reduce((function(e,t){return t.reshape?t.reshape(e):e}),{sourcesBySourceId:r,state:n}).sourcesBySourceId;return v(t.reshape({sourcesBySourceId:o,sources:Object.values(o),state:n})).filter(Boolean).map((function(e){return{source:e,items:e.getItems()}}))}({collections:e,props:o,state:s.getState()})}))})))).then((function(e){var n;f("idle"),c(e);var d=o.shouldPanelOpen({state:s.getState()});u(null!==(n=r.isOpen)&&void 0!==n?n:o.openOnFocus&&!a&&d||d);var p=oe(s.getState());if(null!==s.getState().activeItemId&&p){var m=p.item,h=p.itemInputValue,g=p.itemUrl,b=p.source;b.onActive(De({event:t,item:m,itemInputValue:h,itemUrl:g,refresh:i,source:b,state:s.getState()},l))}})).finally((function(){f("idle"),Be&&o.environment.clearTimeout(Be)}));return s.pendingRequests.add(b)}function $e(e){return $e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},$e(e)}var qe=["event","props","refresh","store"];function He(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function Ge(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}function at(e){var t=e.props,n=e.refresh,r=e.store,o=ot(e,Ke),a=function(e,t){return void 0!==t?"".concat(e,"-").concat(t):e};return{getEnvironmentProps:function(e){var n=e.inputElement,o=e.formElement,a=e.panelElement;function i(e){!r.getState().isOpen&&r.pendingRequests.isEmpty()||e.target===n||!1===[o,a].some((function(t){return(n=t)===(r=e.target)||n.contains(r);var n,r}))&&(r.dispatch("blur",null),t.debug||r.pendingRequests.cancelAll())}return nt({onTouchStart:i,onMouseDown:i,onTouchMove:function(e){!1!==r.getState().isOpen&&n===t.environment.document.activeElement&&e.target!==n&&n.blur()}},ot(e,Qe))},getRootProps:function(e){return nt({role:"combobox","aria-expanded":r.getState().isOpen,"aria-haspopup":"listbox","aria-owns":r.getState().isOpen?"".concat(t.id,"-list"):void 0,"aria-labelledby":"".concat(t.id,"-label")},e)},getFormProps:function(e){return e.inputElement,nt({action:"",noValidate:!0,role:"search",onSubmit:function(a){var i;a.preventDefault(),t.onSubmit(nt({event:a,refresh:n,state:r.getState()},o)),r.dispatch("submit",null),null===(i=e.inputElement)||void 0===i||i.blur()},onReset:function(a){var i;a.preventDefault(),t.onReset(nt({event:a,refresh:n,state:r.getState()},o)),r.dispatch("reset",null),null===(i=e.inputElement)||void 0===i||i.focus()}},ot(e,Ye))},getLabelProps:function(e){var n=e||{},r=n.sourceIndex,o=ot(n,Je);return nt({htmlFor:"".concat(a(t.id,r),"-input"),id:"".concat(a(t.id,r),"-label")},o)},getInputProps:function(e){var a;function i(e){(t.openOnFocus||Boolean(r.getState().query))&&Ue(nt({event:e,props:t,query:r.getState().completion||r.getState().query,refresh:n,store:r},o)),r.dispatch("focus",null)}var s=e||{},l=(s.inputElement,s.maxLength),c=void 0===l?512:l,u=ot(s,Ze),d=oe(r.getState()),p=function(e){return Boolean(e&&e.match(ae))}((null===(a=t.environment.navigator)||void 0===a?void 0:a.userAgent)||""),f=null!=d&&d.itemUrl&&!p?"go":"search";return nt({"aria-autocomplete":"both","aria-activedescendant":r.getState().isOpen&&null!==r.getState().activeItemId?"".concat(t.id,"-item-").concat(r.getState().activeItemId):void 0,"aria-controls":r.getState().isOpen?"".concat(t.id,"-list"):void 0,"aria-labelledby":"".concat(t.id,"-label"),value:r.getState().completion||r.getState().query,id:"".concat(t.id,"-input"),autoComplete:"off",autoCorrect:"off",autoCapitalize:"off",enterKeyHint:f,spellCheck:"false",autoFocus:t.autoFocus,placeholder:t.placeholder,maxLength:c,type:"search",onChange:function(e){Ue(nt({event:e,props:t,query:e.currentTarget.value.slice(0,c),refresh:n,store:r},o))},onKeyDown:function(e){!function(e){var t=e.event,n=e.props,r=e.refresh,o=e.store,a=function(e,t){if(null==e)return{};var n,r,o=function(e,t){if(null==e)return{};var n,r,o={},a=Object.keys(e);for(r=0;r=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}(e,qe);if("ArrowUp"===t.key||"ArrowDown"===t.key){var i=function(){var e=n.environment.document.getElementById("".concat(n.id,"-item-").concat(o.getState().activeItemId));e&&(e.scrollIntoViewIfNeeded?e.scrollIntoViewIfNeeded(!1):e.scrollIntoView(!1))},s=function(){var e=oe(o.getState());if(null!==o.getState().activeItemId&&e){var n=e.item,i=e.itemInputValue,s=e.itemUrl,l=e.source;l.onActive(Ge({event:t,item:n,itemInputValue:i,itemUrl:s,refresh:r,source:l,state:o.getState()},a))}};t.preventDefault(),!1===o.getState().isOpen&&(n.openOnFocus||Boolean(o.getState().query))?Ue(Ge({event:t,props:n,query:o.getState().query,refresh:r,store:o},a)).then((function(){o.dispatch(t.key,{nextActiveItemId:n.defaultActiveItemId}),s(),setTimeout(i,0)})):(o.dispatch(t.key,{}),s(),i())}else if("Escape"===t.key)t.preventDefault(),o.dispatch(t.key,null),o.pendingRequests.cancelAll();else if("Tab"===t.key)o.dispatch("blur",null),o.pendingRequests.cancelAll();else if("Enter"===t.key){if(null===o.getState().activeItemId||o.getState().collections.every((function(e){return 0===e.items.length})))return void(n.debug||o.pendingRequests.cancelAll());t.preventDefault();var l=oe(o.getState()),c=l.item,u=l.itemInputValue,d=l.itemUrl,p=l.source;if(t.metaKey||t.ctrlKey)void 0!==d&&(p.onSelect(Ge({event:t,item:c,itemInputValue:u,itemUrl:d,refresh:r,source:p,state:o.getState()},a)),n.navigator.navigateNewTab({itemUrl:d,item:c,state:o.getState()}));else if(t.shiftKey)void 0!==d&&(p.onSelect(Ge({event:t,item:c,itemInputValue:u,itemUrl:d,refresh:r,source:p,state:o.getState()},a)),n.navigator.navigateNewWindow({itemUrl:d,item:c,state:o.getState()}));else if(t.altKey);else{if(void 0!==d)return p.onSelect(Ge({event:t,item:c,itemInputValue:u,itemUrl:d,refresh:r,source:p,state:o.getState()},a)),void n.navigator.navigate({itemUrl:d,item:c,state:o.getState()});Ue(Ge({event:t,nextState:{isOpen:!1},props:n,query:u,refresh:r,store:o},a)).then((function(){p.onSelect(Ge({event:t,item:c,itemInputValue:u,itemUrl:d,refresh:r,source:p,state:o.getState()},a))}))}}}(nt({event:e,props:t,refresh:n,store:r},o))},onFocus:i,onBlur:_,onClick:function(n){e.inputElement!==t.environment.document.activeElement||r.getState().isOpen||i(n)}},u)},getPanelProps:function(e){return nt({onMouseDown:function(e){e.preventDefault()},onMouseLeave:function(){r.dispatch("mouseleave",null)}},e)},getListProps:function(e){var n=e||{},r=n.sourceIndex,o=ot(n,Xe);return nt({role:"listbox","aria-labelledby":"".concat(a(t.id,r),"-label"),id:"".concat(a(t.id,r),"-list")},o)},getItemProps:function(e){var i=e.item,s=e.source,l=e.sourceIndex,c=ot(e,et);return nt({id:"".concat(a(t.id,l),"-item-").concat(i.__autocomplete_id),role:"option","aria-selected":r.getState().activeItemId===i.__autocomplete_id,onMouseMove:function(e){if(i.__autocomplete_id!==r.getState().activeItemId){r.dispatch("mousemove",i.__autocomplete_id);var t=oe(r.getState());if(null!==r.getState().activeItemId&&t){var a=t.item,s=t.itemInputValue,l=t.itemUrl,c=t.source;c.onActive(nt({event:e,item:a,itemInputValue:s,itemUrl:l,refresh:n,source:c,state:r.getState()},o))}}},onMouseDown:function(e){e.preventDefault()},onClick:function(e){var a=s.getItemInputValue({item:i,state:r.getState()}),l=s.getItemUrl({item:i,state:r.getState()});(l?Promise.resolve():Ue(nt({event:e,nextState:{isOpen:!1},props:t,query:a,refresh:n,store:r},o))).then((function(){s.onSelect(nt({event:e,item:i,itemInputValue:a,itemUrl:l,refresh:n,source:s,state:r.getState()},o))}))}},c)}}}function it(e){return it="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},it(e)}function st(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function lt(e){for(var t=1;t0&&r.createElement("div",{className:"DocSearch-NoResults-Prefill-List"},r.createElement("p",{className:"DocSearch-Help"},c,":"),r.createElement("ul",null,h.slice(0,3).reduce((function(e,t){return[].concat(u(e),[r.createElement("li",{key:t},r.createElement("button",{className:"DocSearch-Prefill",key:t,type:"button",onClick:function(){o.setQuery(t.toLowerCase()+" "),o.refresh(),o.inputRef.current.focus()}},t))])}),[]))),o.getMissingResultsUrl&&r.createElement("p",{className:"DocSearch-Help"},"".concat(p," "),r.createElement("a",{href:o.getMissingResultsUrl({query:o.state.query}),target:"_blank",rel:"noopener noreferrer"},m)))}var zt=["hit","attribute","tagName"];function Ut(e,t){return t.split(".").reduce((function(e,t){return null!=e&&e[t]?e[t]:null}),e)}function $t(e){var t=e.hit,n=e.attribute,o=e.tagName,i=void 0===o?"span":o,s=l(e,zt);return(0,r.createElement)(i,a(a({},s),{},{dangerouslySetInnerHTML:{__html:Ut(t,"_snippetResult.".concat(n,".value"))||Ut(t,n)}}))}function qt(e){return e.collection&&0!==e.collection.items.length?r.createElement("section",{className:"DocSearch-Hits"},r.createElement("div",{className:"DocSearch-Hit-source"},e.title),r.createElement("ul",e.getListProps(),e.collection.items.map((function(t,n){return r.createElement(Ht,s({key:[e.title,t.objectID].join(":"),item:t,index:n},e))})))):null}function Ht(e){var t=e.item,n=e.index,o=e.renderIcon,a=e.renderAction,i=e.getItemProps,l=e.onItemClick,u=e.collection,d=e.hitComponent,p=c(r.useState(!1),2),f=p[0],m=p[1],h=c(r.useState(!1),2),g=h[0],b=h[1],y=r.useRef(null),v=d;return r.createElement("li",s({className:["DocSearch-Hit",t.__docsearch_parent&&"DocSearch-Hit--Child",f&&"DocSearch-Hit--deleting",g&&"DocSearch-Hit--favoriting"].filter(Boolean).join(" "),onTransitionEnd:function(){y.current&&y.current()}},i({item:t,source:u.source,onClick:function(e){l(t,e)}})),r.createElement(v,{hit:t},r.createElement("div",{className:"DocSearch-Hit-Container"},o({item:t,index:n}),t.hierarchy[t.type]&&"lvl1"===t.type&&r.createElement("div",{className:"DocSearch-Hit-content-wrapper"},r.createElement($t,{className:"DocSearch-Hit-title",hit:t,attribute:"hierarchy.lvl1"}),t.content&&r.createElement($t,{className:"DocSearch-Hit-path",hit:t,attribute:"content"})),t.hierarchy[t.type]&&("lvl2"===t.type||"lvl3"===t.type||"lvl4"===t.type||"lvl5"===t.type||"lvl6"===t.type)&&r.createElement("div",{className:"DocSearch-Hit-content-wrapper"},r.createElement($t,{className:"DocSearch-Hit-title",hit:t,attribute:"hierarchy.".concat(t.type)}),r.createElement($t,{className:"DocSearch-Hit-path",hit:t,attribute:"hierarchy.lvl1"})),"content"===t.type&&r.createElement("div",{className:"DocSearch-Hit-content-wrapper"},r.createElement($t,{className:"DocSearch-Hit-title",hit:t,attribute:"content"}),r.createElement($t,{className:"DocSearch-Hit-path",hit:t,attribute:"hierarchy.lvl1"})),a({item:t,runDeleteTransition:function(e){m(!0),y.current=e},runFavoriteTransition:function(e){b(!0),y.current=e}}))))}function Gt(e,t,n){return e.reduce((function(e,r){var o=t(r);return e.hasOwnProperty(o)||(e[o]=[]),e[o].length<(n||5)&&e[o].push(r),e}),{})}function Vt(e){return e}function Wt(e){return 1===e.button||e.altKey||e.ctrlKey||e.metaKey||e.shiftKey}function Kt(){}var Qt=/(|<\/mark>)/g,Yt=RegExp(Qt.source);function Zt(e){var t,n,r=e;if(!r.__docsearch_parent&&!e._highlightResult)return e.hierarchy.lvl0;var o=((r.__docsearch_parent?null===(t=r.__docsearch_parent)||void 0===t||null===(t=t._highlightResult)||void 0===t||null===(t=t.hierarchy)||void 0===t?void 0:t.lvl0:null===(n=e._highlightResult)||void 0===n||null===(n=n.hierarchy)||void 0===n?void 0:n.lvl0)||{}).value;return o&&Yt.test(o)?o.replace(Qt,""):o}function Jt(e){return r.createElement("div",{className:"DocSearch-Dropdown-Container"},e.state.collections.map((function(t){if(0===t.items.length)return null;var n=Zt(t.items[0]);return r.createElement(qt,s({},e,{key:t.source.sourceId,title:n,collection:t,renderIcon:function(e){var n,o=e.item,a=e.index;return r.createElement(r.Fragment,null,o.__docsearch_parent&&r.createElement("svg",{className:"DocSearch-Hit-Tree",viewBox:"0 0 24 54"},r.createElement("g",{stroke:"currentColor",fill:"none",fillRule:"evenodd",strokeLinecap:"round",strokeLinejoin:"round"},o.__docsearch_parent!==(null===(n=t.items[a+1])||void 0===n?void 0:n.__docsearch_parent)?r.createElement("path",{d:"M8 6v21M20 27H8.3"}):r.createElement("path",{d:"M8 6v42M20 27H8.3"}))),r.createElement("div",{className:"DocSearch-Hit-icon"},r.createElement(jt,{type:o.type})))},renderAction:function(){return r.createElement("div",{className:"DocSearch-Hit-action"},r.createElement(Tt,null))}}))})),e.resultsFooterComponent&&r.createElement("section",{className:"DocSearch-HitsFooter"},r.createElement(e.resultsFooterComponent,{state:e.state})))}var Xt=["translations"];function en(e){var t=e.translations,n=void 0===t?{}:t,o=l(e,Xt),a=n.recentSearchesTitle,i=void 0===a?"Recent":a,c=n.noRecentSearchesText,u=void 0===c?"No recent searches":c,d=n.saveRecentSearchButtonTitle,p=void 0===d?"Save this search":d,f=n.removeRecentSearchButtonTitle,m=void 0===f?"Remove this search from history":f,h=n.favoriteSearchesTitle,g=void 0===h?"Favorite":h,b=n.removeFavoriteSearchButtonTitle,y=void 0===b?"Remove this search from favorites":b;return"idle"===o.state.status&&!1===o.hasCollections?o.disableUserPersonalization?null:r.createElement("div",{className:"DocSearch-StartScreen"},r.createElement("p",{className:"DocSearch-Help"},u)):!1===o.hasCollections?null:r.createElement("div",{className:"DocSearch-Dropdown-Container"},r.createElement(qt,s({},o,{title:i,collection:o.state.collections[0],renderIcon:function(){return r.createElement("div",{className:"DocSearch-Hit-icon"},r.createElement(Ot,null))},renderAction:function(e){var t=e.item,n=e.runFavoriteTransition,a=e.runDeleteTransition;return r.createElement(r.Fragment,null,r.createElement("div",{className:"DocSearch-Hit-action"},r.createElement("button",{className:"DocSearch-Hit-action-button",title:p,type:"submit",onClick:function(e){e.preventDefault(),e.stopPropagation(),n((function(){o.favoriteSearches.add(t),o.recentSearches.remove(t),o.refresh()}))}},r.createElement(Dt,null))),r.createElement("div",{className:"DocSearch-Hit-action"},r.createElement("button",{className:"DocSearch-Hit-action-button",title:m,type:"submit",onClick:function(e){e.preventDefault(),e.stopPropagation(),a((function(){o.recentSearches.remove(t),o.refresh()}))}},r.createElement(Pt,null))))}})),r.createElement(qt,s({},o,{title:g,collection:o.state.collections[1],renderIcon:function(){return r.createElement("div",{className:"DocSearch-Hit-icon"},r.createElement(Dt,null))},renderAction:function(e){var t=e.item,n=e.runDeleteTransition;return r.createElement("div",{className:"DocSearch-Hit-action"},r.createElement("button",{className:"DocSearch-Hit-action-button",title:y,type:"submit",onClick:function(e){e.preventDefault(),e.stopPropagation(),n((function(){o.favoriteSearches.remove(t),o.refresh()}))}},r.createElement(Pt,null)))}})))}var tn=["translations"],nn=r.memo((function(e){var t=e.translations,n=void 0===t?{}:t,o=l(e,tn);if("error"===o.state.status)return r.createElement(Mt,{translations:null==n?void 0:n.errorScreen});var a=o.state.collections.some((function(e){return e.items.length>0}));return o.state.query?!1===a?r.createElement(Bt,s({},o,{translations:null==n?void 0:n.noResultsScreen})):r.createElement(Jt,o):r.createElement(en,s({},o,{hasCollections:a,translations:null==n?void 0:n.startScreen}))}),(function(e,t){return"loading"===t.state.status||"stalled"===t.state.status})),rn=["translations"];function on(e){var t=e.translations,n=void 0===t?{}:t,o=l(e,rn),a=n.resetButtonTitle,i=void 0===a?"Clear the query":a,c=n.resetButtonAriaLabel,u=void 0===c?"Clear the query":c,d=n.cancelButtonText,p=void 0===d?"Cancel":d,f=n.cancelButtonAriaLabel,h=void 0===f?"Cancel":f,g=n.searchInputLabel,b=void 0===g?"Search":g,y=o.getFormProps({inputElement:o.inputRef.current}).onReset;return r.useEffect((function(){o.autoFocus&&o.inputRef.current&&o.inputRef.current.focus()}),[o.autoFocus,o.inputRef]),r.useEffect((function(){o.isFromSelection&&o.inputRef.current&&o.inputRef.current.select()}),[o.isFromSelection,o.inputRef]),r.createElement(r.Fragment,null,r.createElement("form",{className:"DocSearch-Form",onSubmit:function(e){e.preventDefault()},onReset:y},r.createElement("label",s({className:"DocSearch-MagnifierLabel"},o.getLabelProps()),r.createElement(m,null),r.createElement("span",{className:"DocSearch-VisuallyHiddenForAccessibility"},b)),r.createElement("div",{className:"DocSearch-LoadingIndicator"},r.createElement(Ct,null)),r.createElement("input",s({className:"DocSearch-Input",ref:o.inputRef},o.getInputProps({inputElement:o.inputRef.current,autoFocus:o.autoFocus,maxLength:64}))),r.createElement("button",{type:"reset",title:i,className:"DocSearch-Reset","aria-label":u,hidden:!o.state.query},r.createElement(Pt,null))),r.createElement("button",{className:"DocSearch-Cancel",type:"reset","aria-label":h,onClick:o.onClose},p))}var an=["_highlightResult","_snippetResult"];function sn(e){var t=e.key,n=e.limit,r=void 0===n?5:n,o=function(e){return!1===function(){var e="__TEST_KEY__";try{return localStorage.setItem(e,""),localStorage.removeItem(e),!0}catch(e){return!1}}()?{setItem:function(){},getItem:function(){return[]}}:{setItem:function(t){return window.localStorage.setItem(e,JSON.stringify(t))},getItem:function(){var t=window.localStorage.getItem(e);return t?JSON.parse(t):[]}}}(t),a=o.getItem().slice(0,r);return{add:function(e){var t=e,n=(t._highlightResult,t._snippetResult,l(t,an)),i=a.findIndex((function(e){return e.objectID===n.objectID}));i>-1&&a.splice(i,1),a.unshift(n),a=a.slice(0,r),o.setItem(a)},remove:function(e){a=a.filter((function(t){return t.objectID!==e.objectID})),o.setItem(a)},getAll:function(){return a}}}function ln(e){const t=`algoliasearch-client-js-${e.key}`;let n;const r=()=>(void 0===n&&(n=e.localStorage||window.localStorage),n),o=()=>JSON.parse(r().getItem(t)||"{}"),a=e=>{r().setItem(t,JSON.stringify(e))};return{get:(t,n,r={miss:()=>Promise.resolve()})=>Promise.resolve().then((()=>{(()=>{const t=e.timeToLive?1e3*e.timeToLive:null,n=o(),r=Object.fromEntries(Object.entries(n).filter((([,e])=>void 0!==e.timestamp)));if(a(r),!t)return;const i=Object.fromEntries(Object.entries(r).filter((([,e])=>{const n=(new Date).getTime();return!(e.timestamp+tPromise.all([e?e.value:n(),void 0!==e]))).then((([e,t])=>Promise.all([e,t||r.miss(e)]))).then((([e])=>e)),set:(e,n)=>Promise.resolve().then((()=>{const a=o();return a[JSON.stringify(e)]={timestamp:(new Date).getTime(),value:n},r().setItem(t,JSON.stringify(a)),n})),delete:e=>Promise.resolve().then((()=>{const n=o();delete n[JSON.stringify(e)],r().setItem(t,JSON.stringify(n))})),clear:()=>Promise.resolve().then((()=>{r().removeItem(t)}))}}function cn(e){const t=[...e.caches],n=t.shift();return void 0===n?{get:(e,t,n={miss:()=>Promise.resolve()})=>t().then((e=>Promise.all([e,n.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve(t),delete:e=>Promise.resolve(),clear:()=>Promise.resolve()}:{get:(e,r,o={miss:()=>Promise.resolve()})=>n.get(e,r,o).catch((()=>cn({caches:t}).get(e,r,o))),set:(e,r)=>n.set(e,r).catch((()=>cn({caches:t}).set(e,r))),delete:e=>n.delete(e).catch((()=>cn({caches:t}).delete(e))),clear:()=>n.clear().catch((()=>cn({caches:t}).clear()))}}function un(e={serializable:!0}){let t={};return{get(n,r,o={miss:()=>Promise.resolve()}){const a=JSON.stringify(n);if(a in t)return Promise.resolve(e.serializable?JSON.parse(t[a]):t[a]);const i=r(),s=o&&o.miss||(()=>Promise.resolve());return i.then((e=>s(e))).then((()=>i))},set:(n,r)=>(t[JSON.stringify(n)]=e.serializable?JSON.stringify(r):r,Promise.resolve(r)),delete:e=>(delete t[JSON.stringify(e)],Promise.resolve()),clear:()=>(t={},Promise.resolve())}}function dn(e){let t=e.length-1;for(;t>0;t--){const n=Math.floor(Math.random()*(t+1)),r=e[t];e[t]=e[n],e[n]=r}return e}function pn(e,t){return t?(Object.keys(t).forEach((n=>{e[n]=t[n](e)})),e):e}function fn(e,...t){let n=0;return e.replace(/%s/g,(()=>encodeURIComponent(t[n++])))}const mn={WithinQueryParameters:0,WithinHeaders:1};function hn(e,t){const n=e||{},r=n.data||{};return Object.keys(n).forEach((e=>{-1===["timeout","headers","queryParameters","data","cacheable"].indexOf(e)&&(r[e]=n[e])})),{data:Object.entries(r).length>0?r:void 0,timeout:n.timeout||t,headers:n.headers||{},queryParameters:n.queryParameters||{},cacheable:n.cacheable}}const gn={Read:1,Write:2,Any:3},bn=1,yn=3;function vn(e,t=bn){return{...e,status:t,lastUpdate:Date.now()}}function wn(e){return"string"==typeof e?{protocol:"https",url:e,accept:gn.Any}:{protocol:e.protocol||"https",url:e.url,accept:e.accept||gn.Any}}const Sn="GET",kn="POST";function xn(e,t,n,r){const o=[],a=function(e,t){if(e.method===Sn||void 0===e.data&&void 0===t.data)return;const n=Array.isArray(e.data)?e.data:{...e.data,...t.data};return JSON.stringify(n)}(n,r),i=function(e,t){const n={...e.headers,...t.headers},r={};return Object.keys(n).forEach((e=>{const t=n[e];r[e.toLowerCase()]=t})),r}(e,r),s=n.method,l=n.method!==Sn?{}:{...n.data,...r.data},c={"x-algolia-agent":e.userAgent.value,...e.queryParameters,...l,...r.queryParameters};let u=0;const d=(t,l)=>{const p=t.pop();if(void 0===p)throw{name:"RetryError",message:"Unreachable hosts - your application id may be incorrect. If the error persists, contact support@algolia.com.",transporterStackTrace:On(o)};const f={data:a,headers:i,method:s,url:En(p,n.path,c),connectTimeout:l(u,e.timeouts.connect),responseTimeout:l(u,r.timeout)},m=e=>{const n={request:f,response:e,host:p,triesLeft:t.length};return o.push(n),n},h={onSuccess:e=>function(e){try{return JSON.parse(e.content)}catch(t){throw function(e,t){return{name:"DeserializationError",message:e,response:t}}(t.message,e)}}(e),onRetry(n){const r=m(n);return n.isTimedOut&&u++,Promise.all([e.logger.info("Retryable failure",Pn(r)),e.hostsCache.set(p,vn(p,n.isTimedOut?yn:2))]).then((()=>d(t,l)))},onFail(e){throw m(e),function({content:e,status:t},n){let r=e;try{r=JSON.parse(e).message}catch(e){}return function(e,t,n){return{name:"ApiError",message:e,status:t,transporterStackTrace:n}}(r,t,n)}(e,On(o))}};return e.requester.send(f).then((e=>((e,t)=>(e=>{const t=e.status;return e.isTimedOut||(({isTimedOut:e,status:t})=>!e&&!~~t)(e)||2!=~~(t/100)&&4!=~~(t/100)})(e)?t.onRetry(e):(({status:e})=>2==~~(e/100))(e)?t.onSuccess(e):t.onFail(e))(e,h)))};return function(e,t){return Promise.all(t.map((t=>e.get(t,(()=>Promise.resolve(vn(t))))))).then((e=>{const n=e.filter((e=>function(e){return e.status===bn||Date.now()-e.lastUpdate>12e4}(e))),r=e.filter((e=>function(e){return e.status===yn&&Date.now()-e.lastUpdate<=12e4}(e))),o=[...n,...r];return{getTimeout:(e,t)=>(0===r.length&&0===e?1:r.length+3+e)*t,statelessHosts:o.length>0?o.map((e=>wn(e))):t}}))}(e.hostsCache,t).then((e=>d([...e.statelessHosts].reverse(),e.getTimeout)))}function _n(e){const t={value:`Algolia for JavaScript (${e})`,add(e){const n=`; ${e.segment}${void 0!==e.version?` (${e.version})`:""}`;return-1===t.value.indexOf(n)&&(t.value=`${t.value}${n}`),t}};return t}function En(e,t,n){const r=Cn(n);let o=`${e.protocol}://${e.url}/${"/"===t.charAt(0)?t.substr(1):t}`;return r.length&&(o+=`?${r}`),o}function Cn(e){return Object.keys(e).map((t=>{return fn("%s=%s",t,(n=e[t],"[object Object]"===Object.prototype.toString.call(n)||"[object Array]"===Object.prototype.toString.call(n)?JSON.stringify(e[t]):e[t]));var n})).join("&")}function On(e){return e.map((e=>Pn(e)))}function Pn(e){const t=e.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return{...e,request:{...e.request,headers:{...e.request.headers,...t}}}}const Tn=e=>{const t=e.appId,n=function(e,t,n){const r={"x-algolia-api-key":n,"x-algolia-application-id":t};return{headers:()=>e===mn.WithinHeaders?r:{},queryParameters:()=>e===mn.WithinQueryParameters?r:{}}}(void 0!==e.authMode?e.authMode:mn.WithinHeaders,t,e.apiKey),r=function(e){const{hostsCache:t,logger:n,requester:r,requestsCache:o,responsesCache:a,timeouts:i,userAgent:s,hosts:l,queryParameters:c,headers:u}=e,d={hostsCache:t,logger:n,requester:r,requestsCache:o,responsesCache:a,timeouts:i,userAgent:s,headers:u,queryParameters:c,hosts:l.map((e=>wn(e))),read(e,t){const n=hn(t,d.timeouts.read),r=()=>xn(d,d.hosts.filter((e=>!!(e.accept&gn.Read))),e,n);if(!0!==(void 0!==n.cacheable?n.cacheable:e.cacheable))return r();const o={request:e,mappedRequestOptions:n,transporter:{queryParameters:d.queryParameters,headers:d.headers}};return d.responsesCache.get(o,(()=>d.requestsCache.get(o,(()=>d.requestsCache.set(o,r()).then((e=>Promise.all([d.requestsCache.delete(o),e])),(e=>Promise.all([d.requestsCache.delete(o),Promise.reject(e)]))).then((([e,t])=>t))))),{miss:e=>d.responsesCache.set(o,e)})},write:(e,t)=>xn(d,d.hosts.filter((e=>!!(e.accept&gn.Write))),e,hn(t,d.timeouts.write))};return d}({hosts:[{url:`${t}-dsn.algolia.net`,accept:gn.Read},{url:`${t}.algolia.net`,accept:gn.Write}].concat(dn([{url:`${t}-1.algolianet.com`},{url:`${t}-2.algolianet.com`},{url:`${t}-3.algolianet.com`}])),...e,headers:{...n.headers(),"content-type":"application/x-www-form-urlencoded",...e.headers},queryParameters:{...n.queryParameters(),...e.queryParameters}}),o={transporter:r,appId:t,addAlgoliaAgent(e,t){r.userAgent.add({segment:e,version:t})},clearCache:()=>Promise.all([r.requestsCache.clear(),r.responsesCache.clear()]).then((()=>{}))};return pn(o,e.methods)},An=e=>(t,n)=>t.method===Sn?e.transporter.read(t,n):e.transporter.write(t,n),jn=e=>(t,n={})=>pn({transporter:e.transporter,appId:e.appId,indexName:t},n.methods),Rn=e=>(t,n)=>{const r=t.map((e=>({...e,params:Cn(e.params||{})})));return e.transporter.read({method:kn,path:"1/indexes/*/queries",data:{requests:r},cacheable:!0},n)},In=e=>(t,n)=>Promise.all(t.map((t=>{const{facetName:r,facetQuery:o,...a}=t.params;return jn(e)(t.indexName,{methods:{searchForFacetValues:Nn}}).searchForFacetValues(r,o,{...n,...a})}))),Dn=e=>(t,n,r)=>e.transporter.read({method:kn,path:fn("1/answers/%s/prediction",e.indexName),data:{query:t,queryLanguages:n},cacheable:!0},r),Ln=e=>(t,n)=>e.transporter.read({method:kn,path:fn("1/indexes/%s/query",e.indexName),data:{query:t},cacheable:!0},n),Nn=e=>(t,n,r)=>e.transporter.read({method:kn,path:fn("1/indexes/%s/facets/%s/query",e.indexName,t),data:{facetQuery:n},cacheable:!0},r),Mn=1,Fn=2,Bn=3;function zn(e,t,n){const r={appId:e,apiKey:t,timeouts:{connect:1,read:2,write:30},requester:{send:e=>new Promise((t=>{const n=new XMLHttpRequest;n.open(e.method,e.url,!0),Object.keys(e.headers).forEach((t=>n.setRequestHeader(t,e.headers[t])));const r=(e,r)=>setTimeout((()=>{n.abort(),t({status:0,content:r,isTimedOut:!0})}),1e3*e),o=r(e.connectTimeout,"Connection timeout");let a;n.onreadystatechange=()=>{n.readyState>n.OPENED&&void 0===a&&(clearTimeout(o),a=r(e.responseTimeout,"Socket timeout"))},n.onerror=()=>{0===n.status&&(clearTimeout(o),clearTimeout(a),t({content:n.responseText||"Network request failed",status:n.status,isTimedOut:!1}))},n.onload=()=>{clearTimeout(o),clearTimeout(a),t({content:n.responseText,status:n.status,isTimedOut:!1})},n.send(e.data)}))},logger:(o=Bn,{debug:(e,t)=>(Mn>=o&&console.debug(e,t),Promise.resolve()),info:(e,t)=>(Fn>=o&&console.info(e,t),Promise.resolve()),error:(e,t)=>(console.error(e,t),Promise.resolve())}),responsesCache:un(),requestsCache:un({serializable:!1}),hostsCache:cn({caches:[ln({key:`4.19.1-${e}`}),un()]}),userAgent:_n("4.19.1").add({segment:"Browser",version:"lite"}),authMode:mn.WithinQueryParameters};var o;return Tn({...r,...n,methods:{search:Rn,searchForFacetValues:In,multipleQueries:Rn,multipleSearchForFacetValues:In,customRequest:An,initIndex:e=>t=>jn(e)(t,{methods:{search:Ln,searchForFacetValues:Nn,findAnswers:Dn}})}})}zn.version="4.19.1";var Un=["footer","searchBox"];function $n(e){var t=e.appId,n=e.apiKey,o=e.indexName,i=e.placeholder,u=void 0===i?"Search docs":i,d=e.searchParameters,p=e.maxResultsPerGroup,f=e.onClose,m=void 0===f?Kt:f,h=e.transformItems,g=void 0===h?Vt:h,b=e.hitComponent,y=void 0===b?Et:b,v=e.resultsFooterComponent,w=void 0===v?function(){return null}:v,S=e.navigator,k=e.initialScrollY,x=void 0===k?0:k,_=e.transformSearchClient,E=void 0===_?Vt:_,C=e.disableUserPersonalization,O=void 0!==C&&C,P=e.initialQuery,T=void 0===P?"":P,A=e.translations,j=void 0===A?{}:A,R=e.getMissingResultsUrl,I=e.insights,D=void 0!==I&&I,L=j.footer,N=j.searchBox,M=l(j,Un),F=c(r.useState({query:"",collections:[],completion:null,context:{},isOpen:!1,activeItemId:null,status:"idle"}),2),B=F[0],z=F[1],U=r.useRef(null),$=r.useRef(null),q=r.useRef(null),H=r.useRef(null),G=r.useRef(null),V=r.useRef(10),W=r.useRef("undefined"!=typeof window?window.getSelection().toString().slice(0,64):"").current,K=r.useRef(T||W).current,Q=function(e,t,n){return r.useMemo((function(){var r=zn(e,t);return r.addAlgoliaAgent("docsearch","3.6.1"),!1===/docsearch.js \(.*\)/.test(r.transporter.userAgent.value)&&r.addAlgoliaAgent("docsearch-react","3.6.1"),n(r)}),[e,t,n])}(t,n,E),Y=r.useRef(sn({key:"__DOCSEARCH_FAVORITE_SEARCHES__".concat(o),limit:10})).current,Z=r.useRef(sn({key:"__DOCSEARCH_RECENT_SEARCHES__".concat(o),limit:0===Y.getAll().length?7:4})).current,J=r.useCallback((function(e){if(!O){var t="content"===e.type?e.__docsearch_parent:e;t&&-1===Y.getAll().findIndex((function(e){return e.objectID===t.objectID}))&&Z.add(t)}}),[Y,Z,O]),X=r.useCallback((function(e){if(B.context.algoliaInsightsPlugin&&e.__autocomplete_id){var t=e,n={eventName:"Item Selected",index:t.__autocomplete_indexName,items:[t],positions:[e.__autocomplete_id],queryID:t.__autocomplete_queryID};B.context.algoliaInsightsPlugin.insights.clickedObjectIDsAfterSearch(n)}}),[B.context.algoliaInsightsPlugin]),ee=r.useMemo((function(){return St({id:"docsearch",defaultActiveItemId:0,placeholder:u,openOnFocus:!0,initialState:{query:K,context:{searchSuggestions:[]}},insights:D,navigator:S,onStateChange:function(e){z(e.state)},getSources:function(e){var r=e.query,i=e.state,s=e.setContext,l=e.setStatus;if(!r)return O?[]:[{sourceId:"recentSearches",onSelect:function(e){var t=e.item,n=e.event;J(t),Wt(n)||m()},getItemUrl:function(e){return e.item.url},getItems:function(){return Z.getAll()}},{sourceId:"favoriteSearches",onSelect:function(e){var t=e.item,n=e.event;J(t),Wt(n)||m()},getItemUrl:function(e){return e.item.url},getItems:function(){return Y.getAll()}}];var c=Boolean(D);return Q.search([{query:r,indexName:o,params:a({attributesToRetrieve:["hierarchy.lvl0","hierarchy.lvl1","hierarchy.lvl2","hierarchy.lvl3","hierarchy.lvl4","hierarchy.lvl5","hierarchy.lvl6","content","type","url"],attributesToSnippet:["hierarchy.lvl1:".concat(V.current),"hierarchy.lvl2:".concat(V.current),"hierarchy.lvl3:".concat(V.current),"hierarchy.lvl4:".concat(V.current),"hierarchy.lvl5:".concat(V.current),"hierarchy.lvl6:".concat(V.current),"content:".concat(V.current)],snippetEllipsisText:"\u2026",highlightPreTag:"",highlightPostTag:"",hitsPerPage:20,clickAnalytics:c},d)}]).catch((function(e){throw"RetryError"===e.name&&l("error"),e})).then((function(e){var r=e.results[0],l=r.hits,u=r.nbHits,d=Gt(l,(function(e){return Zt(e)}),p);i.context.searchSuggestions.length0&&(re(),G.current&&G.current.focus())}),[K,re]),r.useEffect((function(){function e(){if($.current){var e=.01*window.innerHeight;$.current.style.setProperty("--docsearch-vh","".concat(e,"px"))}}return e(),window.addEventListener("resize",e),function(){window.removeEventListener("resize",e)}}),[]),r.createElement("div",s({ref:U},ne({"aria-expanded":!0}),{className:["DocSearch","DocSearch-Container","stalled"===B.status&&"DocSearch-Container--Stalled","error"===B.status&&"DocSearch-Container--Errored"].filter(Boolean).join(" "),role:"button",tabIndex:0,onMouseDown:function(e){e.target===e.currentTarget&&m()}}),r.createElement("div",{className:"DocSearch-Modal",ref:$},r.createElement("header",{className:"DocSearch-SearchBar",ref:q},r.createElement(on,s({},ee,{state:B,autoFocus:0===K.length,inputRef:G,isFromSelection:Boolean(K)&&K===W,translations:N,onClose:m}))),r.createElement("div",{className:"DocSearch-Dropdown",ref:H},r.createElement(nn,s({},ee,{indexName:o,state:B,hitComponent:y,resultsFooterComponent:w,disableUserPersonalization:O,recentSearches:Z,favoriteSearches:Y,inputRef:G,translations:M,getMissingResultsUrl:R,onItemClick:function(e,t){X(e),J(e),Wt(t)||m()}}))),r.createElement("footer",{className:"DocSearch-Footer"},r.createElement(_t,{translations:L}))))}function qn(e){var t=e.isOpen,n=e.onOpen,o=e.onClose,a=e.onInput,i=e.searchButtonRef;r.useEffect((function(){function e(e){var r;(27===e.keyCode&&t||"k"===(null===(r=e.key)||void 0===r?void 0:r.toLowerCase())&&(e.metaKey||e.ctrlKey)||!function(e){var t=e.target,n=t.tagName;return t.isContentEditable||"INPUT"===n||"SELECT"===n||"TEXTAREA"===n}(e)&&"/"===e.key&&!t)&&(e.preventDefault(),t?o():document.body.classList.contains("DocSearch--active")||document.body.classList.contains("DocSearch--active")||n()),i&&i.current===document.activeElement&&a&&/[a-zA-Z0-9]/.test(String.fromCharCode(e.keyCode))&&a(e)}return window.addEventListener("keydown",e),function(){window.removeEventListener("keydown",e)}}),[t,n,o,a,i])}},8328:(e,t,n)=>{"use strict";n.d(t,{A:()=>p});n(6540);var r=n(3259),o=n.n(r),a=n(4054);const i={"0057296d":[()=>n.e(1482).then(n.bind(n,3667)),"@site/docs/how-to/send-messages.md",3667],"0058b4c6":[()=>n.e(849).then(n.t.bind(n,6164,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-175.json",6164],"00c93e1e":[()=>n.e(9837).then(n.bind(n,8397)),"@site/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn.md",8397],"00f29cf5":[()=>n.e(4424).then(n.bind(n,3999)),"@site/docs/reference/controllers/events/index.md",3999],"01a85c17":[()=>Promise.all([n.e(1869),n.e(8209)]).then(n.bind(n,9158)),"@theme/BlogTagsListPage",9158],"0274794e":[()=>n.e(6377).then(n.bind(n,1494)),"@site/docs/reference/api/Client/index.md",1494],"037298f3":[()=>n.e(1865).then(n.bind(n,6200)),"@site/docs/reference/api/model/product/interfaces/Product.md",6200],"0523356b":[()=>n.e(9571).then(n.bind(n,362)),"@site/docs/reference/api/model/chat/interfaces/SingleChat.md",362],"0673617b":[()=>n.e(1543).then(n.bind(n,5010)),"@site/docs/reference/api/model/id/index.md",5010],"0730592b":[()=>n.e(2419).then(n.bind(n,7094)),"@site/docs/reference/controllers/initializer/variables/pkg.md",7094],"081c0950":[()=>n.e(5029).then(n.bind(n,9995)),"@site/docs/reference/api/model/message/enumerations/MessageTypes.md",9995],"099caee3":[()=>n.e(4508).then(n.bind(n,4870)),"@site/docs/reference/api/model/aliases/type-aliases/DataURL.md",4870],"0a59a0e8":[()=>n.e(9544).then(n.bind(n,7499)),"@site/docs/reference/controllers/initializer/functions/timeout.md",7499],"0b9397d6":[()=>n.e(3755).then(n.bind(n,5165)),"@site/docs/reference/api/model/chat/enumerations/ChatState.md",5165],"0bf84b24":[()=>n.e(6403).then(n.bind(n,9909)),"@site/docs/reference/api/model/contact/interfaces/NumberCheck.md",9909],"0d185c55":[()=>n.e(990).then(n.bind(n,5547)),"@site/docs/configuration/command-line-options.md",5547],"0d1f64ba":[()=>n.e(599).then(n.bind(n,3325)),"@site/docs/reference/api/model/config/interfaces/ConfigObject.md",3325],"0e0f73c7":[()=>n.e(16).then(n.bind(n,3136)),"@site/docs/reference/api/model/config/enumerations/QRFormat.md",3136],"0e384e19":[()=>n.e(3976).then(n.bind(n,619)),"@site/docs/intro.md",619],"1025625c":[()=>n.e(1207).then(n.bind(n,1649)),"@site/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse.md",1649],"1061d0cb":[()=>n.e(4940).then(n.bind(n,4744)),"@site/docs/configuration/capture-sd.md",4744],"11347dcd":[()=>n.e(7180).then(n.bind(n,5689)),"@site/docs/reference/api/model/enumerations/Status.md",5689],"1454731d":[()=>n.e(314).then(n.bind(n,5773)),"@site/docs/reference/logging/custom_transport/classes/NoOpTransport.md",5773],"146bd2aa":[()=>n.e(9160).then(n.bind(n,5865)),"@site/docs/reference/api/model/config/enumerations/LicenseType.md",5865],"14eb3368":[()=>Promise.all([n.e(1869),n.e(6969)]).then(n.bind(n,4136)),"@theme/DocCategoryGeneratedIndexPage",4136],"150e319f":[()=>n.e(809).then(n.bind(n,3889)),"@site/docs/reference/api/model/contact/index.md",3889],"155c8334":[()=>n.e(283).then(n.bind(n,4319)),"@site/docs/reference/api/model/config/type-aliases/AdvancedConfig.md",4319],"171e0138":[()=>n.e(5653).then(n.bind(n,809)),"@site/docs/reference/api/model/errors/enumerations/ERROR_NAME.md",809],17896441:[()=>Promise.all([n.e(1869),n.e(8307),n.e(8401)]).then(n.bind(n,833)),"@theme/DocItem",833],18336523:[()=>n.e(240).then(n.bind(n,8895)),"@site/docs/reference/logging/custom_transport/index.md",8895],"18ad8d0a":[()=>n.e(974).then(n.bind(n,4123)),"@site/docs/configuration/launch-events.md",4123],"18c41134":[()=>n.e(9262).then(n.bind(n,3849)),"@site/docs/tutorial-basics/markdown-features.mdx",3849],"1a3c9b31":[()=>n.e(9242).then(n.bind(n,1307)),"@site/docs/reference/index.md",1307],"1a4e3797":[()=>Promise.all([n.e(1869),n.e(2138)]).then(n.bind(n,4604)),"@theme/SearchPage",4604],"1c28c6e3":[()=>n.e(1530).then(n.bind(n,9884)),"@site/docs/get-started/installation.md",9884],"1df732fe":[()=>n.e(57).then(n.bind(n,7725)),"@site/docs/reference/api/model/config/index.md",7725],"1df93b7f":[()=>Promise.all([n.e(1869),n.e(2100),n.e(4583)]).then(n.bind(n,4706)),"@site/src/pages/index.tsx",4706],"1e4232ab":[()=>n.e(1953).then(n.bind(n,3976)),"@site/docs/tutorial-basics/create-a-document.md",3976],"1f391b9e":[()=>Promise.all([n.e(1869),n.e(8307),n.e(6061)]).then(n.bind(n,7973)),"@theme/MDXPage",7973],"20288d3d":[()=>n.e(626).then(n.bind(n,8236)),"@site/docs/reference/api/model/group-metadata/interfaces/Participant.md",8236],"20fe70bf":[()=>n.e(843).then(n.bind(n,4158)),"@site/docs/how-to/decrypt-media.md",4158],"26af37c4":[()=>n.e(8745).then(n.bind(n,8114)),"@site/docs/reference/api/Client/classes/Client.md",8114],27075183:[()=>n.e(4332).then(n.bind(n,3775)),"@site/docs/reference/api/model/config/enumerations/OnError.md",3775],"279c9f30":[()=>n.e(5626).then(n.bind(n,6691)),"@site/docs/reference/logging/logging/variables/log.md",6691],"28a4b851":[()=>n.e(2166).then(n.bind(n,9820)),"@site/docs/how-to/incoming-calls.md",9820],"29a49838":[()=>n.e(3177).then(n.bind(n,412)),"@site/docs/reference/structures/Collector/interfaces/CollectorOptions.md",412],"29b289c3":[()=>n.e(747).then(n.bind(n,3214)),"@site/docs/reference/api/model/media/type-aliases/StickerMetadata.md",3214],"29fec1eb":[()=>n.e(986).then(n.bind(n,2307)),"@site/docs/how-to/send-videos.md",2307],"2b136cef":[()=>n.e(487).then(n.bind(n,5052)),"@site/docs/configuration/capture-qr.md",5052],"2ca4460e":[()=>n.e(2866).then(n.bind(n,5030)),"@site/docs/reference/api/model/aliases/type-aliases/Content.md",5030],"2d4ad45f":[()=>n.e(5341).then(n.bind(n,1538)),"@site/docs/reference/api/model/aliases/type-aliases/ContactId.md",1538],"2eaaacd8":[()=>n.e(858).then(n.bind(n,6546)),"@site/docs/reference/controllers/initializer/variables/screenshot.md",6546],"2f74e3d4":[()=>n.e(3534).then(n.bind(n,2971)),"@site/docs/reference/api/model/product/interfaces/Order.md",2971],"2fc4fc5f":[()=>n.e(730).then(n.bind(n,1619)),"@site/docs/reference/api/model/button/interfaces/Section.md",1619],"3217192f":[()=>n.e(8462).then(n.t.bind(n,8174,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-docusaurus-f20.json",8174],"3486d072":[()=>n.e(3003).then(n.bind(n,7708)),"@site/docs/reference/controllers/patch_manager/index.md",7708],"36994c47":[()=>n.e(9858).then(n.t.bind(n,5516,19)),"@generated/docusaurus-plugin-content-blog/default/__plugin.json",5516],"393be207":[()=>n.e(4134).then(n.bind(n,633)),"@site/src/pages/markdown-page.md",633],"3a2db09e":[()=>n.e(8121).then(n.t.bind(n,8070,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-df9.json",8070],"3bb4bcf6":[()=>n.e(8223).then(n.bind(n,4966)),"@site/docs/reference/api/model/message/interfaces/PollVote.md",4966],"3d3a9b6d":[()=>n.e(1181).then(n.bind(n,3826)),"@site/docs/reference/controllers/initializer/index.md",3826],"3de6a3bc":[()=>n.e(9178).then(n.bind(n,8566)),"@site/docs/reference/api/model/contact/interfaces/Contact.md",8566],"3edf7b61":[()=>n.e(2801).then(n.bind(n,6374)),"@site/docs/reference/api/model/aliases/type-aliases/FilePath.md",6374],"402fd8ec":[()=>n.e(2007).then(n.bind(n,5434)),"@site/docs/reference/api/model/config/enumerations/QRQuality.md",5434],"4197358a":[()=>n.e(8867).then(n.bind(n,6014)),"@site/docs/reference/api/model/events/index.md",6014],"428f4992":[()=>n.e(815).then(n.bind(n,8183)),"@site/docs/reference/api/model/label/index.md",8183],"437a86f0":[()=>n.e(3272).then(n.bind(n,4470)),"@site/docs/reference/api/model/reactions/type-aliases/ReactionEvent.md",4470],"45205a09":[()=>n.e(1359).then(n.bind(n,7112)),"@site/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent.md",7112],"4640f537":[()=>n.e(8512).then(n.bind(n,5951)),"@site/docs/reference/structures/Dialog/interfaces/CurrentDialogProps.md",5951],"465af148":[()=>n.e(3268).then(n.bind(n,1136)),"@site/docs/reference/api/model/aliases/type-aliases/ChatId.md",1136],"4689dc6f":[()=>n.e(1939).then(n.bind(n,3521)),"@site/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent.md",3521],"468b357e":[()=>n.e(6315).then(n.bind(n,5138)),"@site/docs/reference/api/model/aliases/type-aliases/GetURL.md",5138],"484e5a84":[()=>n.e(6956).then(n.bind(n,9188)),"@site/docs/reference/api/model/aliases/type-aliases/CountryCode.md",9188],"4a1784a5":[()=>n.e(1124).then(n.bind(n,4758)),"@site/docs/Integrations/chatwoot.md",4758],"4b6dedc4":[()=>n.e(493).then(n.bind(n,6909)),"@site/docs/reference/api/model/button/interfaces/LocationButtonBody.md",6909],"4bc6cdf6":[()=>n.e(9223).then(n.bind(n,3337)),"@site/docs/reference/structures/Dialog/type-aliases/CheckFunction.md",3337],"52c02df4":[()=>n.e(8283).then(n.bind(n,1802)),"@site/docs/reference/api/model/message/interfaces/MessageInfoInteraction.md",1802],"52eba09e":[()=>n.e(2254).then(n.bind(n,4515)),"@site/docs/reference/api/model/chat/interfaces/GroupChat.md",4515],"533a09ca":[()=>n.e(3098).then(n.bind(n,4700)),"@site/docs/tutorial-basics/create-a-blog-post.md",4700],"5471f4ea":[()=>n.e(6724).then(n.bind(n,6631)),"@site/docs/configuration/the-client.md",6631],"54b7f2e2":[()=>n.e(6496).then(n.bind(n,8892)),"@site/docs/reference/api/model/button/interfaces/Row.md",8892],"54d2ec5f":[()=>n.e(4711).then(n.bind(n,291)),"@site/docs/reference/api/model/config/interfaces/ProxyServerCredentials.md",291],"57a2de75":[()=>n.e(2147).then(n.bind(n,6863)),"@site/docs/reference/controllers/initializer/variables/configWithCases.md",6863],"58bfaad8":[()=>n.e(86).then(n.bind(n,8146)),"@site/docs/reference/api/model/call/interfaces/Call.md",8146],59362658:[()=>n.e(9325).then(n.bind(n,1180)),"@site/blog/2021-08-01-mdx-blog-post.mdx",1180],"5c868d36":[()=>n.e(1974).then(n.bind(n,5254)),"@site/docs/tutorial-basics/create-a-page.md",5254],"5cc50a6c":[()=>n.e(907).then(n.bind(n,952)),"@site/docs/how-to/misc.md",952],"5e01f171":[()=>n.e(1695).then(n.bind(n,3185)),"@site/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY.md",3185],"5e8c322a":[()=>n.e(594).then(n.bind(n,3478)),"@site/docs/api/index.md",3478],"5e90a9b3":[()=>n.e(8025).then(n.t.bind(n,7134,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-hola-73f.json",7134],"5e95c892":[()=>n.e(9647).then(n.bind(n,7121)),"@theme/DocsRoot",7121],"5e9f5e1a":[()=>Promise.resolve().then(n.bind(n,4784)),"@generated/docusaurus.config",4784],"5ebba8c8":[()=>n.e(7615).then(n.bind(n,7892)),"@site/docs/how-to/groups.md",7892],"5ee7b1bc":[()=>n.e(1743).then(n.bind(n,7163)),"@site/docs/concepts/glossary.md",7163],"5f2ffadc":[()=>n.e(9850).then(n.bind(n,8320)),"@site/docs/concepts/how-it-works.md",8320],"5f617a4c":[()=>n.e(3814).then(n.bind(n,6910)),"@site/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck.md",6910],"5fd2b997":[()=>n.e(707).then(n.bind(n,3160)),"@site/docs/reference/logging/logging/functions/addRotateFileLogTransport.md",3160],"60a6a9a9":[()=>n.e(8444).then(n.bind(n,6031)),"@site/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel.md",6031],"60b52a9d":[()=>n.e(6002).then(n.bind(n,3290)),"@site/docs/reference/api/model/enumerations/STATE.md",3290],"621db11d":[()=>Promise.all([n.e(1869),n.e(3347),n.e(4212)]).then(n.bind(n,3250)),"@theme/Blog/Pages/BlogAuthorsListPage",3250],"64bd8bad":[()=>n.e(1642).then(n.bind(n,8807)),"@site/docs/reference/api/model/group-metadata/interfaces/GroupMetadata.md",8807],"6679ae86":[()=>n.e(6647).then(n.bind(n,743)),"@site/docs/reference/structures/Dialog/interfaces/DialogListMessageRow.md",743],"6844db42":[()=>n.e(7657).then(n.bind(n,2060)),"@site/docs/how-to/handle-errors.md",2060],"6875c492":[()=>Promise.all([n.e(1869),n.e(8307),n.e(3347),n.e(4813)]).then(n.bind(n,3069)),"@theme/BlogTagsPostsPage",3069],"6922041d":[()=>n.e(7807).then(n.bind(n,6453)),"@site/docs/reference/api/model/aliases/type-aliases/AccountNumber.md",6453],"6afe94c3":[()=>n.e(6290).then(n.bind(n,492)),"@site/docs/reference/api/model/button/interfaces/AdvancedButton.md",492],"6b55e007":[()=>n.e(8773).then(n.bind(n,6722)),"@site/docs/configuration/config-object.md",6722],"6b7169bc":[()=>n.e(3809).then(n.bind(n,9522)),"@site/docs/reference/structures/preProcessors/variables/MessagePreprocessors.md",9522],"6bb166bd":[()=>n.e(8518).then(n.t.bind(n,3618,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-category-tutorial-extras-128.json",3618],"6bd61230":[()=>n.e(5293).then(n.bind(n,2483)),"@site/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor.md",2483],"6cdb92a9":[()=>n.e(2987).then(n.bind(n,6050)),"@site/docs/get-started/socketmode.md",6050],"6dda1eb8":[()=>n.e(7856).then(n.bind(n,4551)),"@site/docs/reference/api/model/group-metadata/index.md",4551],"6de276b4":[()=>n.e(6521).then(n.bind(n,6363)),"@site/docs/reference/api/model/call/index.md",6363],"6f5ae7fe":[()=>n.e(998).then(n.bind(n,8642)),"@site/docs/how-to/use-a-proxy.md",8642],"6f941ca8":[()=>n.e(6155).then(n.bind(n,3135)),"@site/docs/how-to/location.md",3135],"70bd31a0":[()=>n.e(727).then(n.bind(n,5705)),"@site/docs/reference/api/model/contact/interfaces/BusinessProfile.md",5705],"71e949d7":[()=>n.e(1623).then(n.bind(n,830)),"@site/docs/reference/controllers/events/variables/ev.md",830],"72bcfeeb":[()=>n.e(3795).then(n.bind(n,6506)),"@site/docs/reference/controllers/initializer/functions/create.md",6506],"73664a40":[()=>n.e(1972).then(n.bind(n,9581)),"@site/blog/2019-05-29-long-blog-post.md",9581],"73c627ad":[()=>n.e(5972).then(n.bind(n,4933)),"@site/docs/reference/api/model/product/interfaces/CustomProduct.md",4933],"73d41d19":[()=>n.e(5352).then(n.bind(n,2970)),"@site/docs/reference/api/model/index.md",2970],"745741e5":[()=>n.e(1121).then(n.bind(n,1214)),"@site/docs/reference/api/model/id/interfaces/Id.md",1214],"7628d2f1":[()=>n.e(6067).then(n.bind(n,5468)),"@site/docs/reference/api/Client/enumerations/namespace.md",5468],"7661071f":[()=>n.e(8737).then(n.bind(n,4137)),"@site/blog/2021-08-26-welcome/index.md?truncated=true",4137],"7803af04":[()=>n.e(1536).then(n.bind(n,3958)),"@site/docs/reference/api/model/sessionInfo/interfaces/SessionInfo.md",3958],"792432d4":[()=>n.e(2426).then(n.bind(n,9341)),"@site/docs/reference/api/model/aliases/type-aliases/GroupId.md",9341],"79bb96de":[()=>n.e(6851).then(n.bind(n,4868)),"@site/docs/how-to/receive-messages.md",4868],"7c769d76":[()=>n.e(8726).then(n.bind(n,4662)),"@site/docs/how-to/detect-logout.md",4662],"7d55d1f2":[()=>n.e(7157).then(n.bind(n,7342)),"@site/docs/reference/api/model/label/interfaces/Label.md",7342],"7e283186":[()=>n.e(2119).then(n.bind(n,1040)),"@site/docs/reference/structures/Dialog/interfaces/DialogTemplate.md",1040],"80965edc":[()=>n.e(6555).then(n.bind(n,6794)),"@site/docs/reference/structures/Collector/index.md",6794],"814f3328":[()=>n.e(7472).then(n.t.bind(n,5513,19)),"~blog/default/blog-post-list-prop-default.json",5513],"822bd8ab":[()=>n.e(2748).then(n.bind(n,8611)),"@site/docs/tutorial-basics/congratulations.md",8611],"82a3a055":[()=>n.e(2040).then(n.bind(n,8154)),"@site/docs/reference/structures/Dialog/interfaces/DialogButtons.md",8154],"83d3b456":[()=>n.e(8976).then(n.bind(n,678)),"@site/docs/reference/api/model/product/index.md",678],"846f0159":[()=>n.e(6336).then(n.bind(n,5866)),"@site/docs/reference/api/model/aliases/type-aliases/ChatServer.md",5866],"8717b14a":[()=>n.e(3694).then(n.bind(n,1615)),"@site/blog/2019-05-29-long-blog-post.md?truncated=true",1615],"8997cb84":[()=>n.e(1397).then(n.bind(n,8697)),"@site/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent.md",8697],"8a0e406a":[()=>n.e(4696).then(n.bind(n,9516)),"@site/docs/reference/api/model/chat/type-aliases/EphemeralDuration.md",9516],"8a376d68":[()=>n.e(1808).then(n.bind(n,8086)),"@site/docs/reference/api/model/events/enumerations/SimpleListener.md",8086],"8ebd32b9":[()=>n.e(1800).then(n.bind(n,2594)),"@site/docs/reference/structures/MessageCollector/classes/MessageCollector.md",2594],"8ee4cc26":[()=>n.e(8563).then(n.bind(n,1856)),"@site/docs/reference/structures/preProcessors/type-aliases/MPConfigType.md",1856],"8fbd3a7f":[()=>n.e(9596).then(n.bind(n,6327)),"@site/docs/reference/api/model/chat/interfaces/BaseChat.md",6327],"901c4e03":[()=>n.e(1302).then(n.bind(n,269)),"@site/docs/how-to/create-api.md",269],"91a766d9":[()=>n.e(2392).then(n.bind(n,6522)),"@site/docs/configuration/multiple-sessions.md",6522],"925b3f96":[()=>n.e(8609).then(n.bind(n,5026)),"@site/blog/2019-05-28-first-blog-post.md?truncated=true",5026],"9403ec86":[()=>n.e(3689).then(n.bind(n,1204)),"@site/docs/reference/structures/Dialog/interfaces/DialogListMessageSection.md",1204],95628813:[()=>n.e(9153).then(n.bind(n,648)),"@site/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes.md",648],"98c048de":[()=>n.e(488).then(n.bind(n,7190)),"@site/docs/reference/api/model/config/interfaces/SessionData.md",7190],"9a514765":[()=>n.e(9099).then(n.bind(n,6873)),"@site/docs/reference/api/model/chat/enumerations/ChatTypes.md",6873],"9aa93c82":[()=>n.e(3703).then(n.bind(n,865)),"@site/docs/reference/api/model/media/index.md",865],"9ab3d06b":[()=>n.e(3128).then(n.bind(n,7986)),"@site/docs/reference/api/model/enumerations/Events.md",7986],"9bd6a0c8":[()=>n.e(3354).then(n.bind(n,5315)),"@site/docs/reference/structures/Dialog/interfaces/DialogProperty.md",5315],"9d5f1ccb":[()=>n.e(2910).then(n.bind(n,1203)),"@site/docs/reference/api/model/button/index.md",1203],"9e4087bc":[()=>n.e(2711).then(n.bind(n,9331)),"@theme/BlogArchivePage",9331],a08b55b4:[()=>n.e(7746).then(n.bind(n,7331)),"@site/docs/reference/api/model/aliases/type-aliases/WaServers.md",7331],a0ef4106:[()=>n.e(2534).then(n.bind(n,6280)),"@site/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions.md",6280],a3711c17:[()=>n.e(5235).then(n.bind(n,3544)),"@site/docs/how-to/sendfile.md",3544],a485a49d:[()=>n.e(1237).then(n.bind(n,4449)),"@site/docs/reference/structures/Dialog/interfaces/DialogValidation.md",4449],a4a33699:[()=>n.e(8437).then(n.bind(n,2211)),"@site/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions.md",2211],a6aa9e1f:[()=>Promise.all([n.e(1869),n.e(8307),n.e(3347),n.e(7643)]).then(n.bind(n,5124)),"@theme/BlogListPage",5124],a7456010:[()=>n.e(1235).then(n.t.bind(n,8552,19)),"@generated/docusaurus-plugin-content-pages/default/__plugin.json",8552],a7bd4aaa:[()=>n.e(7098).then(n.bind(n,4532)),"@theme/DocVersionRoot",4532],a8e44dab:[()=>n.e(6262).then(n.bind(n,9225)),"@site/docs/reference/api/model/message/interfaces/ReactionSender.md",9225],a94703ab:[()=>Promise.all([n.e(1869),n.e(9048)]).then(n.bind(n,1377)),"@theme/DocRoot",1377],aba21aa0:[()=>n.e(5742).then(n.t.bind(n,7093,19)),"@generated/docusaurus-plugin-content-docs/default/__plugin.json",7093],acb0ea1f:[()=>n.e(7898).then(n.bind(n,7469)),"@site/docs/reference/controllers/init_patch/index.md",7469],acecf23e:[()=>n.e(1903).then(n.t.bind(n,1912,19)),"~blog/default/blogMetadata-default.json",1912],ae1c8c73:[()=>n.e(7492).then(n.bind(n,1388)),"@site/docs/reference/api/model/aliases/type-aliases/Base64.md",1388],af80f1f3:[()=>n.e(9772).then(n.bind(n,7926)),"@site/docs/reference/api/model/contact/interfaces/BizProfileOptions.md",7926],b0030a2c:[()=>n.e(1422).then(n.bind(n,7606)),"@site/docs/reference/api/model/config/interfaces/DevTools.md",7606],b123e85d:[()=>n.e(3605).then(n.bind(n,1224)),"@site/docs/how-to/send-files.md",1224],b182beed:[()=>n.e(4994).then(n.bind(n,8715)),"@site/docs/reference/api/model/config/interfaces/Webhook.md",8715],b27ebe52:[()=>n.e(9457).then(n.bind(n,4763)),"@site/docs/reference/structures/Dialog/index.md",4763],b2cda8ff:[()=>n.e(6785).then(n.bind(n,3794)),"@site/docs/reference/api/model/product/interfaces/CartItem.md",3794],b35003cc:[()=>n.e(1128).then(n.bind(n,6515)),"@site/docs/reference/api/model/contact/interfaces/BizCategory.md",6515],b430c9d2:[()=>n.e(9486).then(n.bind(n,7054)),"@site/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS.md",7054],b4b23ab8:[()=>n.e(7347).then(n.bind(n,429)),"@site/docs/reference/api/model/aliases/type-aliases/GroupChatServer.md",429],b7596626:[()=>n.e(8860).then(n.bind(n,9787)),"@site/docs/reference/api/model/contact/interfaces/BusinessHours.md",9787],b764c1e9:[()=>n.e(3370).then(n.bind(n,9635)),"@site/docs/reference/api/model/media/variables/defaultProcessOptions.md",9635],b868a84c:[()=>n.e(143).then(n.bind(n,8245)),"@site/docs/reference/api/model/errors/classes/AddParticipantError.md",8245],b8787afe:[()=>n.e(523).then(n.bind(n,8809)),"@site/docs/get-started/quick-run.md",8809],b898f833:[()=>n.e(6482).then(n.bind(n,4364)),"@site/docs/get-started/docker.md",4364],b8b00aea:[()=>n.e(1831).then(n.bind(n,8326)),"@site/docs/reference/api/model/config/interfaces/EventPayload.md",8326],b998fb11:[()=>n.e(2193).then(n.bind(n,4209)),"@site/docs/reference/structures/Dialog/interfaces/DialogState.md",4209],bb20bb94:[()=>n.e(70).then(n.bind(n,8804)),"@site/docs/reference/api/functions/exposed.enum/index.md",8804],bc6fb640:[()=>n.e(6854).then(n.bind(n,1484)),"@site/docs/reference/api/model/errors/index.md",1484],bd5628fe:[()=>n.e(6909).then(n.bind(n,6713)),"@site/docs/reference/structures/MessageCollector/index.md",6713],be8c3764:[()=>n.e(6611).then(n.bind(n,3170)),"@site/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS.md",3170],c141421f:[()=>n.e(957).then(n.t.bind(n,936,19)),"@generated/docusaurus-theme-search-algolia/default/__plugin.json",936],c15d9823:[()=>n.e(8146).then(n.t.bind(n,9328,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-bd9.json",9328],c1aedf5a:[()=>n.e(9745).then(n.bind(n,1701)),"@site/docs/reference/api/model/reactions/type-aliases/ReactionRecord.md",1701],c1f86f2f:[()=>Promise.all([n.e(1869),n.e(9761)]).then(n.bind(n,222)),"@site/docs/configuration/licensed-features.mdx",222],c26b1eba:[()=>n.e(7513).then(n.bind(n,1487)),"@site/docs/reference/logging/logging/index.md",1487],c37329a9:[()=>n.e(4014).then(n.bind(n,7776)),"@site/docs/reference/api/model/message/interfaces/PollData.md",7776],c7b94894:[()=>n.e(2513).then(n.bind(n,6001)),"@site/docs/reference/controllers/patch_manager/functions/getAndInjectLicense.md",6001],c8a4e95a:[()=>n.e(845).then(n.t.bind(n,1549,19)),"@generated/docusaurus-plugin-content-docs/default/p/docs-category-tutorial-basics-ea4.json",1549],c939f76a:[()=>n.e(8405).then(n.bind(n,6015)),"@site/docs/reference/api/model/aliases/type-aliases/GroupChatId.md",6015],c9540765:[()=>n.e(2484).then(n.bind(n,4819)),"@site/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup.md",4819],cb21221e:[()=>n.e(9969).then(n.bind(n,5017)),"@site/docs/reference/api/model/reactions/index.md",5017],ccc49370:[()=>Promise.all([n.e(1869),n.e(8307),n.e(3347),n.e(3249)]).then(n.bind(n,3858)),"@theme/BlogPostPage",3858],cce945f2:[()=>n.e(9498).then(n.bind(n,4882)),"@site/docs/reference/api/model/button/interfaces/Button.md",4882],cdd11b4d:[()=>n.e(9306).then(n.bind(n,6153)),"@site/docs/reference/api/model/aliases/type-aliases/MessageId.md",6153],ce48d423:[()=>n.e(9466).then(n.bind(n,6907)),"@site/docs/how-to/react-to-group-events.md",6907],d23fc473:[()=>n.e(5181).then(n.bind(n,2814)),"@site/docs/reference/api/model/message/index.md",2814],d42a3ae7:[()=>n.e(452).then(n.bind(n,2269)),"@site/docs/reference/api/model/message/interfaces/QuoteMap.md",2269],d47ac4be:[()=>n.e(4125).then(n.bind(n,4809)),"@site/docs/reference/api/model/chat/index.md",4809],d58e3925:[()=>n.e(5384).then(n.bind(n,8013)),"@site/docs/how-to/receive-files.md",8013],d6466469:[()=>n.e(1082).then(n.bind(n,9681)),"@site/docs/reference/api/model/sessionInfo/index.md",9681],d88d39d7:[()=>n.e(2848).then(n.bind(n,5744)),"@site/docs/reference/api/model/aliases/type-aliases/NonSerializedId.md",5744],d9f32620:[()=>n.e(5557).then(n.bind(n,7447)),"@site/blog/2021-08-26-welcome/index.md",7447],dbe3b6b9:[()=>n.e(5438).then(n.bind(n,7067)),"@site/docs/advanced/best-practices.md",7067],dee01960:[()=>n.e(6629).then(n.bind(n,8382)),"@site/docs/reference/api/model/config/enumerations/NotificationLanguage.md",8382],dff1c289:[()=>n.e(1724).then(n.bind(n,8043)),"@site/docs/tutorial-extras/manage-docs-versions.md",8043],e273c56f:[()=>n.e(9328).then(n.bind(n,4014)),"@site/blog/2019-05-28-first-blog-post.md",4014],e4469e1d:[()=>n.e(5939).then(n.bind(n,4780)),"@site/docs/how-to/read-state.md",4780],e44a2883:[()=>n.e(4736).then(n.bind(n,8350)),"@site/docs/tutorial-extras/translate-your-site.md",8350],e541f69e:[()=>n.e(8394).then(n.bind(n,3688)),"@site/docs/reference/api/model/message/interfaces/Message.md",3688],e5aefb32:[()=>n.e(3276).then(n.t.bind(n,8539,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-facebook-f47.json",8539],e60aee91:[()=>n.e(5003).then(n.bind(n,5782)),"@site/docs/reference/api/model/errors/classes/SessionExpiredError.md",5782],ea673145:[()=>n.e(2081).then(n.bind(n,1163)),"@site/docs/reference/api/model/reactions/type-aliases/Reaction.md",1163],eaab7dd2:[()=>n.e(5451).then(n.bind(n,8839)),"@site/docs/reference/structures/Collector/type-aliases/CollectorFilter.md",8839],eaeca54c:[()=>n.e(9940).then(n.bind(n,7753)),"@site/docs/reference/structures/preProcessors/index.md",7753],ed88e295:[()=>n.e(3371).then(n.bind(n,744)),"@site/docs/reference/logging/logging/type-aliases/ConfigLogTransport.md",744],edb57414:[()=>n.e(1425).then(n.bind(n,1777)),"@site/docs/how-to/manage-participants.md",1777],edc18652:[()=>n.e(5107).then(n.bind(n,5257)),"@site/docs/reference/structures/Dialog/enumerations/ValidationType.md",5257],ee112ecc:[()=>n.e(6934).then(n.bind(n,565)),"@site/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse.md",565],ef89b32c:[()=>n.e(4171).then(n.bind(n,7056)),"@site/docs/get-started/link-code.md",7056],ef8b811a:[()=>n.e(8947).then(n.t.bind(n,6600,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-authors-790.json",6600],eff1717c:[()=>n.e(1399).then(n.bind(n,4997)),"@site/docs/reference/api/model/chat/type-aliases/Chat.md",4997],f0def62b:[()=>n.e(9584).then(n.bind(n,720)),"@site/docs/reference/api/model/sessionInfo/interfaces/HealthCheck.md",720],f1169565:[()=>n.e(2884).then(n.bind(n,3411)),"@site/docs/reference/api/model/errors/classes/PageEvaluationTimeout.md",3411],f2171f78:[()=>n.e(6283).then(n.bind(n,1576)),"@site/docs/reference/api/model/message/interfaces/MessageInfo.md",1576],f22ab3cc:[()=>n.e(583).then(n.bind(n,8590)),"@site/docs/reference/structures/Collector/classes/Collector.md",8590],f38ef2c2:[()=>n.e(6052).then(n.bind(n,4500)),"@site/docs/reference/api/Client/variables/useragent.md",4500],f3df8bb0:[()=>n.e(8924).then(n.bind(n,5923)),"@site/docs/reference/api/model/message/enumerations/MessageAck.md",5923],f3fdb01a:[()=>n.e(52).then(n.bind(n,5255)),"@site/docs/reference/api/model/aliases/type-aliases/AdvancedFile.md",5255],f47e5abf:[()=>n.e(1619).then(n.bind(n,9601)),"@site/docs/reference/api/model/call/enumerations/CallState.md",9601],f4e478b9:[()=>n.e(5136).then(n.bind(n,2399)),"@site/docs/reference/api/model/message/interfaces/PollOption.md",2399],f4f34a3a:[()=>n.e(3637).then(n.bind(n,5512)),"@site/blog/2021-08-01-mdx-blog-post.mdx?truncated=true",5512],f55d3e7a:[()=>n.e(8863).then(n.bind(n,745)),"@site/docs/tutorial-basics/deploy-your-site.md",745],f5760147:[()=>n.e(4941).then(n.bind(n,9557)),"@site/docs/reference/api/model/aliases/index.md",9557],f81c1134:[()=>n.e(8130).then(n.t.bind(n,7735,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-archive-f05.json",7735],f82cd581:[()=>n.e(4584).then(n.t.bind(n,4035,19)),"@generated/docusaurus-plugin-content-blog/default/p/blog-tags-hello-f96.json",4035],fb1af417:[()=>n.e(6463).then(n.bind(n,4431)),"@site/docs/reference/api/model/type-aliases/EasyApiResponse.md",4431],fb5cf5eb:[()=>n.e(7569).then(n.bind(n,2344)),"@site/docs/reference/api/model/errors/classes/CustomError.md",2344],fbf304ed:[()=>n.e(4453).then(n.bind(n,1339)),"@site/docs/reference/api/model/chat/enumerations/ChatMuteDuration.md",1339],fc7d6c3b:[()=>n.e(8629).then(n.bind(n,855)),"@site/docs/reference/logging/custom_transport/classes/LogToEvTransport.md",855],fd96faf0:[()=>n.e(4113).then(n.bind(n,877)),"@site/docs/reference/structures/Collector/classes/Collection.md",877],ffc4ade8:[()=>n.e(9094).then(n.bind(n,9100)),"@site/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode.md",9100]};var s=n(4848);function l(e){let{error:t,retry:n,pastDelay:r}=e;return t?(0,s.jsxs)("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"},children:[(0,s.jsx)("p",{children:String(t)}),(0,s.jsx)("div",{children:(0,s.jsx)("button",{type:"button",onClick:n,children:"Retry"})})]}):r?(0,s.jsx)("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"},children:(0,s.jsx)("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb",children:(0,s.jsxs)("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2",children:[(0,s.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,s.jsx)("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,s.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,s.jsx)("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,s.jsx)("circle",{cx:"22",cy:"22",r:"8",children:(0,s.jsx)("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"})})]})})}):null}var c=n(6921),u=n(3102);function d(e,t){if("*"===e)return o()({loading:l,loader:()=>n.e(2237).then(n.bind(n,2237)),modules:["@theme/NotFound"],webpack:()=>[2237],render(e,t){const n=e.default;return(0,s.jsx)(u.W,{value:{plugin:{name:"native",id:"default"}},children:(0,s.jsx)(n,{...t})})}});const r=a[`${e}-${t}`],d={},p=[],f=[],m=(0,c.A)(r);return Object.entries(m).forEach((e=>{let[t,n]=e;const r=i[n];r&&(d[t]=r[0],p.push(r[1]),f.push(r[2]))})),o().Map({loading:l,loader:d,modules:p,webpack:()=>f,render(t,n){const o=JSON.parse(JSON.stringify(r));Object.entries(t).forEach((t=>{let[n,r]=t;const a=r.default;if(!a)throw new Error(`The page component at ${e} doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.`);"object"!=typeof a&&"function"!=typeof a||Object.keys(r).filter((e=>"default"!==e)).forEach((e=>{a[e]=r[e]}));let i=o;const s=n.split(".");s.slice(0,-1).forEach((e=>{i=i[e]})),i[s[s.length-1]]=a}));const a=o.__comp;delete o.__comp;const i=o.__context;delete o.__context;const l=o.__props;return delete o.__props,(0,s.jsx)(u.W,{value:i,children:(0,s.jsx)(a,{...o,...l,...n})})}})}const p=[{path:"/blog",component:d("/blog","b2f"),exact:!0},{path:"/blog/archive",component:d("/blog/archive","182"),exact:!0},{path:"/blog/authors",component:d("/blog/authors","0b7"),exact:!0},{path:"/blog/first-blog-post",component:d("/blog/first-blog-post","89a"),exact:!0},{path:"/blog/long-blog-post",component:d("/blog/long-blog-post","9ad"),exact:!0},{path:"/blog/mdx-blog-post",component:d("/blog/mdx-blog-post","e9f"),exact:!0},{path:"/blog/tags",component:d("/blog/tags","287"),exact:!0},{path:"/blog/tags/docusaurus",component:d("/blog/tags/docusaurus","704"),exact:!0},{path:"/blog/tags/facebook",component:d("/blog/tags/facebook","858"),exact:!0},{path:"/blog/tags/hello",component:d("/blog/tags/hello","299"),exact:!0},{path:"/blog/tags/hola",component:d("/blog/tags/hola","00d"),exact:!0},{path:"/blog/welcome",component:d("/blog/welcome","d2b"),exact:!0},{path:"/markdown-page",component:d("/markdown-page","3d7"),exact:!0},{path:"/search",component:d("/search","5de"),exact:!0},{path:"/docs",component:d("/docs","925"),routes:[{path:"/docs",component:d("/docs","a90"),routes:[{path:"/docs",component:d("/docs","2e8"),routes:[{path:"/docs/advanced/best-practices",component:d("/docs/advanced/best-practices","c77"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api",component:d("/docs/api","413"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/category/tutorial---basics",component:d("/docs/category/tutorial---basics","20e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/category/tutorial---extras",component:d("/docs/category/tutorial---extras","9ad"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/concepts/glossary",component:d("/docs/concepts/glossary","26c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/concepts/how-it-works",component:d("/docs/concepts/how-it-works","132"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/configuration/capture-qr",component:d("/docs/configuration/capture-qr","4b7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/configuration/capture-sd",component:d("/docs/configuration/capture-sd","68c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/configuration/command-line-options",component:d("/docs/configuration/command-line-options","af5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/configuration/config-object",component:d("/docs/configuration/config-object","e5f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/configuration/launch-events",component:d("/docs/configuration/launch-events","ae2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/configuration/licensed-features",component:d("/docs/configuration/licensed-features","156"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/configuration/multiple-sessions",component:d("/docs/configuration/multiple-sessions","bd5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/configuration/the-client",component:d("/docs/configuration/the-client","b63"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/get-started/docker",component:d("/docs/get-started/docker","f9c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/get-started/installation",component:d("/docs/get-started/installation","1f3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/get-started/link-code",component:d("/docs/get-started/link-code","487"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/get-started/quick-run",component:d("/docs/get-started/quick-run","f44"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/get-started/socketmode",component:d("/docs/get-started/socketmode","0bf"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/create-api",component:d("/docs/how-to/create-api","c92"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/decrypt-media",component:d("/docs/how-to/decrypt-media","c3b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/detect-logout",component:d("/docs/how-to/detect-logout","a71"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/groups",component:d("/docs/how-to/groups","b6d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/handle-errors",component:d("/docs/how-to/handle-errors","6d4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/incoming-calls",component:d("/docs/how-to/incoming-calls","c9e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/location",component:d("/docs/how-to/location","9cd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/manage-participants",component:d("/docs/how-to/manage-participants","524"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/misc",component:d("/docs/how-to/misc","12d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/react-to-group-events",component:d("/docs/how-to/react-to-group-events","228"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/read-state",component:d("/docs/how-to/read-state","257"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/receive-files",component:d("/docs/how-to/receive-files","442"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/receive-messages",component:d("/docs/how-to/receive-messages","4cc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/send-files",component:d("/docs/how-to/send-files","c77"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/send-messages",component:d("/docs/how-to/send-messages","d8c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/send-videos",component:d("/docs/how-to/send-videos","401"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/sendfile",component:d("/docs/how-to/sendfile","ce3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/how-to/use-a-proxy",component:d("/docs/how-to/use-a-proxy","3a3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/Integrations/chatwoot",component:d("/docs/Integrations/chatwoot","757"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/intro",component:d("/docs/intro","61d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference",component:d("/docs/reference","435"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/Client",component:d("/docs/reference/api/Client","f1f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/Client/classes/Client",component:d("/docs/reference/api/Client/classes/Client","2e0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/Client/enumerations/namespace",component:d("/docs/reference/api/Client/enumerations/namespace","1d2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/Client/variables/useragent",component:d("/docs/reference/api/Client/variables/useragent","177"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/functions/exposed.enum",component:d("/docs/reference/api/functions/exposed.enum","d93"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn",component:d("/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn","136"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model",component:d("/docs/reference/api/model","35e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases",component:d("/docs/reference/api/model/aliases","2c7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/AccountNumber",component:d("/docs/reference/api/model/aliases/type-aliases/AccountNumber","29d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/AdvancedFile",component:d("/docs/reference/api/model/aliases/type-aliases/AdvancedFile","f39"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/Base64",component:d("/docs/reference/api/model/aliases/type-aliases/Base64","88b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/ChatId",component:d("/docs/reference/api/model/aliases/type-aliases/ChatId","07b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/ChatServer",component:d("/docs/reference/api/model/aliases/type-aliases/ChatServer","2bc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/ContactId",component:d("/docs/reference/api/model/aliases/type-aliases/ContactId","5c7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/Content",component:d("/docs/reference/api/model/aliases/type-aliases/Content","677"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/CountryCode",component:d("/docs/reference/api/model/aliases/type-aliases/CountryCode","877"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/DataURL",component:d("/docs/reference/api/model/aliases/type-aliases/DataURL","f87"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/FilePath",component:d("/docs/reference/api/model/aliases/type-aliases/FilePath","170"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/GetURL",component:d("/docs/reference/api/model/aliases/type-aliases/GetURL","dee"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/GroupChatId",component:d("/docs/reference/api/model/aliases/type-aliases/GroupChatId","ba5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/GroupChatServer",component:d("/docs/reference/api/model/aliases/type-aliases/GroupChatServer","b7f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/GroupId",component:d("/docs/reference/api/model/aliases/type-aliases/GroupId","6be"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/MessageId",component:d("/docs/reference/api/model/aliases/type-aliases/MessageId","bcb"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/NonSerializedId",component:d("/docs/reference/api/model/aliases/type-aliases/NonSerializedId","88f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/aliases/type-aliases/WaServers",component:d("/docs/reference/api/model/aliases/type-aliases/WaServers","85c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/button",component:d("/docs/reference/api/model/button","8b9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/button/interfaces/AdvancedButton",component:d("/docs/reference/api/model/button/interfaces/AdvancedButton","200"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/button/interfaces/Button",component:d("/docs/reference/api/model/button/interfaces/Button","2bf"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/button/interfaces/LocationButtonBody",component:d("/docs/reference/api/model/button/interfaces/LocationButtonBody","2a4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/button/interfaces/Row",component:d("/docs/reference/api/model/button/interfaces/Row","cee"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/button/interfaces/Section",component:d("/docs/reference/api/model/button/interfaces/Section","59d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/call",component:d("/docs/reference/api/model/call","7dd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/call/enumerations/CallState",component:d("/docs/reference/api/model/call/enumerations/CallState","5f3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/call/interfaces/Call",component:d("/docs/reference/api/model/call/interfaces/Call","750"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat",component:d("/docs/reference/api/model/chat","fbd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/enumerations/ChatMuteDuration",component:d("/docs/reference/api/model/chat/enumerations/ChatMuteDuration","b94"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/enumerations/ChatState",component:d("/docs/reference/api/model/chat/enumerations/ChatState","7b9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/enumerations/ChatTypes",component:d("/docs/reference/api/model/chat/enumerations/ChatTypes","868"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/interfaces/BaseChat",component:d("/docs/reference/api/model/chat/interfaces/BaseChat","ee6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/interfaces/GroupChat",component:d("/docs/reference/api/model/chat/interfaces/GroupChat","70d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse",component:d("/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse","728"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse",component:d("/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse","8dd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent",component:d("/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent","bff"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/interfaces/SingleChat",component:d("/docs/reference/api/model/chat/interfaces/SingleChat","f62"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/type-aliases/Chat",component:d("/docs/reference/api/model/chat/type-aliases/Chat","b2c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/chat/type-aliases/EphemeralDuration",component:d("/docs/reference/api/model/chat/type-aliases/EphemeralDuration","2a9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config",component:d("/docs/reference/api/model/config","953"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS",component:d("/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS","a85"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY",component:d("/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY","a95"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/enumerations/LicenseType",component:d("/docs/reference/api/model/config/enumerations/LicenseType","8cc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/enumerations/NotificationLanguage",component:d("/docs/reference/api/model/config/enumerations/NotificationLanguage","fb6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/enumerations/OnError",component:d("/docs/reference/api/model/config/enumerations/OnError","6f7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/enumerations/QRFormat",component:d("/docs/reference/api/model/config/enumerations/QRFormat","ad5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/enumerations/QRQuality",component:d("/docs/reference/api/model/config/enumerations/QRQuality","62f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/interfaces/ConfigObject",component:d("/docs/reference/api/model/config/interfaces/ConfigObject","316"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/interfaces/DevTools",component:d("/docs/reference/api/model/config/interfaces/DevTools","c6d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/interfaces/EventPayload",component:d("/docs/reference/api/model/config/interfaces/EventPayload","148"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/interfaces/ProxyServerCredentials",component:d("/docs/reference/api/model/config/interfaces/ProxyServerCredentials","0d7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/interfaces/SessionData",component:d("/docs/reference/api/model/config/interfaces/SessionData","f70"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/interfaces/Webhook",component:d("/docs/reference/api/model/config/interfaces/Webhook","ca0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/config/type-aliases/AdvancedConfig",component:d("/docs/reference/api/model/config/type-aliases/AdvancedConfig","662"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/contact",component:d("/docs/reference/api/model/contact","b83"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/contact/interfaces/BizCategory",component:d("/docs/reference/api/model/contact/interfaces/BizCategory","0f0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/contact/interfaces/BizProfileOptions",component:d("/docs/reference/api/model/contact/interfaces/BizProfileOptions","931"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/contact/interfaces/BusinessHours",component:d("/docs/reference/api/model/contact/interfaces/BusinessHours","000"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/contact/interfaces/BusinessProfile",component:d("/docs/reference/api/model/contact/interfaces/BusinessProfile","47f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/contact/interfaces/Contact",component:d("/docs/reference/api/model/contact/interfaces/Contact","ed7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/contact/interfaces/NumberCheck",component:d("/docs/reference/api/model/contact/interfaces/NumberCheck","ee0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/enumerations/Events",component:d("/docs/reference/api/model/enumerations/Events","783"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/enumerations/STATE",component:d("/docs/reference/api/model/enumerations/STATE","30f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/enumerations/Status",component:d("/docs/reference/api/model/enumerations/Status","674"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/errors",component:d("/docs/reference/api/model/errors","95c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/errors/classes/AddParticipantError",component:d("/docs/reference/api/model/errors/classes/AddParticipantError","656"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/errors/classes/CustomError",component:d("/docs/reference/api/model/errors/classes/CustomError","2cd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/errors/classes/PageEvaluationTimeout",component:d("/docs/reference/api/model/errors/classes/PageEvaluationTimeout","71f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/errors/classes/SessionExpiredError",component:d("/docs/reference/api/model/errors/classes/SessionExpiredError","f24"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode",component:d("/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode","b86"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/errors/enumerations/ERROR_NAME",component:d("/docs/reference/api/model/errors/enumerations/ERROR_NAME","766"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/events",component:d("/docs/reference/api/model/events","9b9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/events/enumerations/SimpleListener",component:d("/docs/reference/api/model/events/enumerations/SimpleListener","6c8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/group-metadata",component:d("/docs/reference/api/model/group-metadata","48c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent",component:d("/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent","b4d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes",component:d("/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes","708"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent",component:d("/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent","8c1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata",component:d("/docs/reference/api/model/group-metadata/interfaces/GroupMetadata","63a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup",component:d("/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup","93b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/group-metadata/interfaces/Participant",component:d("/docs/reference/api/model/group-metadata/interfaces/Participant","f4c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel",component:d("/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel","fc7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/id",component:d("/docs/reference/api/model/id","f45"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/id/interfaces/Id",component:d("/docs/reference/api/model/id/interfaces/Id","1cd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/label",component:d("/docs/reference/api/model/label","aaf"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/label/interfaces/Label",component:d("/docs/reference/api/model/label/interfaces/Label","174"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/media",component:d("/docs/reference/api/model/media","d9b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions",component:d("/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions","440"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/media/type-aliases/StickerMetadata",component:d("/docs/reference/api/model/media/type-aliases/StickerMetadata","b41"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/media/variables/defaultProcessOptions",component:d("/docs/reference/api/model/media/variables/defaultProcessOptions","763"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message",component:d("/docs/reference/api/model/message","b95"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message/enumerations/MessageAck",component:d("/docs/reference/api/model/message/enumerations/MessageAck","a6b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message/enumerations/MessageTypes",component:d("/docs/reference/api/model/message/enumerations/MessageTypes","1ed"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message/interfaces/Message",component:d("/docs/reference/api/model/message/interfaces/Message","cb9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message/interfaces/MessageInfo",component:d("/docs/reference/api/model/message/interfaces/MessageInfo","b09"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message/interfaces/MessageInfoInteraction",component:d("/docs/reference/api/model/message/interfaces/MessageInfoInteraction","f60"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message/interfaces/PollData",component:d("/docs/reference/api/model/message/interfaces/PollData","2ac"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message/interfaces/PollOption",component:d("/docs/reference/api/model/message/interfaces/PollOption","9b4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message/interfaces/PollVote",component:d("/docs/reference/api/model/message/interfaces/PollVote","1c0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message/interfaces/QuoteMap",component:d("/docs/reference/api/model/message/interfaces/QuoteMap","085"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/message/interfaces/ReactionSender",component:d("/docs/reference/api/model/message/interfaces/ReactionSender","80a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/product",component:d("/docs/reference/api/model/product","c66"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/product/interfaces/CartItem",component:d("/docs/reference/api/model/product/interfaces/CartItem","e69"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/product/interfaces/CustomProduct",component:d("/docs/reference/api/model/product/interfaces/CustomProduct","9f8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/product/interfaces/Order",component:d("/docs/reference/api/model/product/interfaces/Order","2ba"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/product/interfaces/Product",component:d("/docs/reference/api/model/product/interfaces/Product","aba"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/reactions",component:d("/docs/reference/api/model/reactions","b2c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/reactions/type-aliases/Reaction",component:d("/docs/reference/api/model/reactions/type-aliases/Reaction","2ba"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/reactions/type-aliases/ReactionEvent",component:d("/docs/reference/api/model/reactions/type-aliases/ReactionEvent","fe2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/reactions/type-aliases/ReactionRecord",component:d("/docs/reference/api/model/reactions/type-aliases/ReactionRecord","540"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/sessionInfo",component:d("/docs/reference/api/model/sessionInfo","fbd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck",component:d("/docs/reference/api/model/sessionInfo/interfaces/HealthCheck","9cc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo",component:d("/docs/reference/api/model/sessionInfo/interfaces/SessionInfo","e1a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/api/model/type-aliases/EasyApiResponse",component:d("/docs/reference/api/model/type-aliases/EasyApiResponse","cc5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/events",component:d("/docs/reference/controllers/events","d66"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/events/variables/ev",component:d("/docs/reference/controllers/events/variables/ev","2a1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/init_patch",component:d("/docs/reference/controllers/init_patch","461"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/initializer",component:d("/docs/reference/controllers/initializer","a51"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/initializer/functions/create",component:d("/docs/reference/controllers/initializer/functions/create","102"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/initializer/functions/timeout",component:d("/docs/reference/controllers/initializer/functions/timeout","627"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/initializer/variables/configWithCases",component:d("/docs/reference/controllers/initializer/variables/configWithCases","491"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/initializer/variables/pkg",component:d("/docs/reference/controllers/initializer/variables/pkg","31d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/initializer/variables/screenshot",component:d("/docs/reference/controllers/initializer/variables/screenshot","9d8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/patch_manager",component:d("/docs/reference/controllers/patch_manager","8d8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck",component:d("/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck","225"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/controllers/patch_manager/functions/getAndInjectLicense",component:d("/docs/reference/controllers/patch_manager/functions/getAndInjectLicense","587"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/logging/custom_transport",component:d("/docs/reference/logging/custom_transport","130"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/logging/custom_transport/classes/LogToEvTransport",component:d("/docs/reference/logging/custom_transport/classes/LogToEvTransport","e50"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/logging/custom_transport/classes/NoOpTransport",component:d("/docs/reference/logging/custom_transport/classes/NoOpTransport","47d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/logging/logging",component:d("/docs/reference/logging/logging","2a1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/logging/logging/functions/addRotateFileLogTransport",component:d("/docs/reference/logging/logging/functions/addRotateFileLogTransport","251"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/logging/logging/type-aliases/ConfigLogTransport",component:d("/docs/reference/logging/logging/type-aliases/ConfigLogTransport","b0a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/logging/logging/variables/log",component:d("/docs/reference/logging/logging/variables/log","54d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Collector",component:d("/docs/reference/structures/Collector","3e4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Collector/classes/Collection",component:d("/docs/reference/structures/Collector/classes/Collection","4a5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Collector/classes/Collector",component:d("/docs/reference/structures/Collector/classes/Collector","38e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions",component:d("/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions","a21"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Collector/interfaces/CollectorOptions",component:d("/docs/reference/structures/Collector/interfaces/CollectorOptions","5c5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Collector/type-aliases/CollectorFilter",component:d("/docs/reference/structures/Collector/type-aliases/CollectorFilter","a25"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog",component:d("/docs/reference/structures/Dialog","86b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog/enumerations/ValidationType",component:d("/docs/reference/structures/Dialog/enumerations/ValidationType","3ea"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog/interfaces/CurrentDialogProps",component:d("/docs/reference/structures/Dialog/interfaces/CurrentDialogProps","7d0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog/interfaces/DialogButtons",component:d("/docs/reference/structures/Dialog/interfaces/DialogButtons","96d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog/interfaces/DialogListMessageRow",component:d("/docs/reference/structures/Dialog/interfaces/DialogListMessageRow","8d3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog/interfaces/DialogListMessageSection",component:d("/docs/reference/structures/Dialog/interfaces/DialogListMessageSection","13a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog/interfaces/DialogProperty",component:d("/docs/reference/structures/Dialog/interfaces/DialogProperty","602"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog/interfaces/DialogState",component:d("/docs/reference/structures/Dialog/interfaces/DialogState","cc0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog/interfaces/DialogTemplate",component:d("/docs/reference/structures/Dialog/interfaces/DialogTemplate","65b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog/interfaces/DialogValidation",component:d("/docs/reference/structures/Dialog/interfaces/DialogValidation","634"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/Dialog/type-aliases/CheckFunction",component:d("/docs/reference/structures/Dialog/type-aliases/CheckFunction","c68"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/MessageCollector",component:d("/docs/reference/structures/MessageCollector","36d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/MessageCollector/classes/MessageCollector",component:d("/docs/reference/structures/MessageCollector/classes/MessageCollector","009"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/preProcessors",component:d("/docs/reference/structures/preProcessors","396"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS",component:d("/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS","530"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor",component:d("/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor","396"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/preProcessors/type-aliases/MPConfigType",component:d("/docs/reference/structures/preProcessors/type-aliases/MPConfigType","9b2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/reference/structures/preProcessors/variables/MessagePreprocessors",component:d("/docs/reference/structures/preProcessors/variables/MessagePreprocessors","4dd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/tutorial-basics/congratulations",component:d("/docs/tutorial-basics/congratulations","458"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/tutorial-basics/create-a-blog-post",component:d("/docs/tutorial-basics/create-a-blog-post","108"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/tutorial-basics/create-a-document",component:d("/docs/tutorial-basics/create-a-document","8fc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/tutorial-basics/create-a-page",component:d("/docs/tutorial-basics/create-a-page","951"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/tutorial-basics/deploy-your-site",component:d("/docs/tutorial-basics/deploy-your-site","4f5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/tutorial-basics/markdown-features",component:d("/docs/tutorial-basics/markdown-features","b05"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/tutorial-extras/manage-docs-versions",component:d("/docs/tutorial-extras/manage-docs-versions","978"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/tutorial-extras/translate-your-site",component:d("/docs/tutorial-extras/translate-your-site","f9a"),exact:!0,sidebar:"tutorialSidebar"}]}]}]},{path:"/",component:d("/","e5f"),exact:!0},{path:"*",component:d("*")}]},6125:(e,t,n)=>{"use strict";n.d(t,{o:()=>a,x:()=>i});var r=n(6540),o=n(4848);const a=r.createContext(!1);function i(e){let{children:t}=e;const[n,i]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{i(!0)}),[]),(0,o.jsx)(a.Provider,{value:n,children:t})}},8536:(e,t,n)=>{"use strict";var r=n(6540),o=n(5338),a=n(545),i=n(4625),s=n(4784),l=n(8193);const c=[n(119),n(6134),n(6294),n(1043),n(9530)];var u=n(8328),d=n(6347),p=n(2831),f=n(4848);function m(e){let{children:t}=e;return(0,f.jsx)(f.Fragment,{children:t})}var h=n(5260),g=n(4586),b=n(6025),y=n(6342),v=n(5500),w=n(2131),S=n(4090),k=n(2967),x=n(440),_=n(1463);function E(){const{i18n:{currentLocale:e,defaultLocale:t,localeConfigs:n}}=(0,g.A)(),r=(0,w.o)(),o=n[e].htmlLang,a=e=>e.replace("-","_");return(0,f.jsxs)(h.A,{children:[Object.entries(n).map((e=>{let[t,{htmlLang:n}]=e;return(0,f.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:n},t)})),(0,f.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:"x-default"}),(0,f.jsx)("meta",{property:"og:locale",content:a(o)}),Object.values(n).filter((e=>o!==e.htmlLang)).map((e=>(0,f.jsx)("meta",{property:"og:locale:alternate",content:a(e.htmlLang)},`meta-og-${e.htmlLang}`)))]})}function C(e){let{permalink:t}=e;const{siteConfig:{url:n}}=(0,g.A)(),r=function(){const{siteConfig:{url:e,baseUrl:t,trailingSlash:n}}=(0,g.A)(),{pathname:r}=(0,d.zy)();return e+(0,x.Ks)((0,b.Ay)(r),{trailingSlash:n,baseUrl:t})}(),o=t?`${n}${t}`:r;return(0,f.jsxs)(h.A,{children:[(0,f.jsx)("meta",{property:"og:url",content:o}),(0,f.jsx)("link",{rel:"canonical",href:o})]})}function O(){const{i18n:{currentLocale:e}}=(0,g.A)(),{metadata:t,image:n}=(0,y.p)();return(0,f.jsxs)(f.Fragment,{children:[(0,f.jsxs)(h.A,{children:[(0,f.jsx)("meta",{name:"twitter:card",content:"summary_large_image"}),(0,f.jsx)("body",{className:S.w})]}),n&&(0,f.jsx)(v.be,{image:n}),(0,f.jsx)(C,{}),(0,f.jsx)(E,{}),(0,f.jsx)(_.A,{tag:k.C,locale:e}),(0,f.jsx)(h.A,{children:t.map(((e,t)=>(0,f.jsx)("meta",{...e},t)))})]})}const P=new Map;var T=n(6125),A=n(6988),j=n(205);function R(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r{const r=t.default?.[e]??t[e];return r?.(...n)}));return()=>o.forEach((e=>e?.()))}const I=function(e){let{children:t,location:n,previousLocation:r}=e;return(0,j.A)((()=>{r!==n&&(!function(e){let{location:t,previousLocation:n}=e;if(!n)return;const r=t.pathname===n.pathname,o=t.hash===n.hash,a=t.search===n.search;if(r&&o&&!a)return;const{hash:i}=t;if(i){const e=decodeURIComponent(i.substring(1)),t=document.getElementById(e);t?.scrollIntoView()}else window.scrollTo(0,0)}({location:n,previousLocation:r}),R("onRouteDidUpdate",{previousLocation:r,location:n}))}),[r,n]),t};function D(e){const t=Array.from(new Set([e,decodeURI(e)])).map((e=>(0,p.u)(u.A,e))).flat();return Promise.all(t.map((e=>e.route.component.preload?.())))}class L extends r.Component{previousLocation;routeUpdateCleanupCb;constructor(e){super(e),this.previousLocation=null,this.routeUpdateCleanupCb=l.A.canUseDOM?R("onRouteUpdate",{previousLocation:null,location:this.props.location}):()=>{},this.state={nextRouteHasLoaded:!0}}shouldComponentUpdate(e,t){if(e.location===this.props.location)return t.nextRouteHasLoaded;const n=e.location;return this.previousLocation=this.props.location,this.setState({nextRouteHasLoaded:!1}),this.routeUpdateCleanupCb=R("onRouteUpdate",{previousLocation:this.previousLocation,location:n}),D(n.pathname).then((()=>{this.routeUpdateCleanupCb(),this.setState({nextRouteHasLoaded:!0})})).catch((e=>{console.warn(e),window.location.reload()})),!1}render(){const{children:e,location:t}=this.props;return(0,f.jsx)(I,{previousLocation:this.previousLocation,location:t,children:(0,f.jsx)(d.qh,{location:t,render:()=>e})})}}const N=L,M="__docusaurus-base-url-issue-banner-container",F="__docusaurus-base-url-issue-banner",B="__docusaurus-base-url-issue-banner-suggestion-container";function z(e){return`\ndocument.addEventListener('DOMContentLoaded', function maybeInsertBanner() {\n var shouldInsert = typeof window['docusaurus'] === 'undefined';\n shouldInsert && insertBanner();\n});\n\nfunction insertBanner() {\n var bannerContainer = document.createElement('div');\n bannerContainer.id = '${M}';\n var bannerHtml = ${JSON.stringify(function(e){return`\n
\n

Your Docusaurus site did not load properly.

\n

A very common reason is a wrong site baseUrl configuration.

\n

Current configured baseUrl = ${e} ${"/"===e?" (default value)":""}

\n

We suggest trying baseUrl =

\n
\n`}(e)).replace(/{let{route:t}=e;return!0===t.exact})))return P.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return P.set(e.pathname,t),{...e,pathname:t}}((0,d.zy)());return(0,f.jsx)(N,{location:e,children:W})}function Q(){return(0,f.jsx)(H.A,{children:(0,f.jsx)(A.l,{children:(0,f.jsxs)(T.x,{children:[(0,f.jsxs)(m,{children:[(0,f.jsx)(q,{}),(0,f.jsx)(O,{}),(0,f.jsx)($,{}),(0,f.jsx)(K,{})]}),(0,f.jsx)(V,{})]})})})}var Y=n(4054);const Z=function(e){try{return document.createElement("link").relList.supports(e)}catch{return!1}}("prefetch")?function(e){return new Promise(((t,n)=>{if("undefined"==typeof document)return void n();const r=document.createElement("link");r.setAttribute("rel","prefetch"),r.setAttribute("href",e),r.onload=()=>t(),r.onerror=()=>n();const o=document.getElementsByTagName("head")[0]??document.getElementsByName("script")[0]?.parentNode;o?.appendChild(r)}))}:function(e){return new Promise(((t,n)=>{const r=new XMLHttpRequest;r.open("GET",e,!0),r.withCredentials=!0,r.onload=()=>{200===r.status?t():n()},r.send(null)}))};var J=n(6921);const X=new Set,ee=new Set,te=()=>navigator.connection?.effectiveType.includes("2g")||navigator.connection?.saveData,ne={prefetch:e=>{if(!(e=>!te()&&!ee.has(e)&&!X.has(e))(e))return!1;X.add(e);const t=(0,p.u)(u.A,e).flatMap((e=>{return t=e.route.path,Object.entries(Y).filter((e=>{let[n]=e;return n.replace(/-[^-]+$/,"")===t})).flatMap((e=>{let[,t]=e;return Object.values((0,J.A)(t))}));var t}));return Promise.all(t.map((e=>{const t=n.gca(e);return t&&!t.includes("undefined")?Z(t).catch((()=>{})):Promise.resolve()})))},preload:e=>!!(e=>!te()&&!ee.has(e))(e)&&(ee.add(e),D(e))},re=Object.freeze(ne);function oe(e){let{children:t}=e;return"hash"===s.default.future.experimental_router?(0,f.jsx)(i.I9,{children:t}):(0,f.jsx)(i.Kd,{children:t})}const ae=Boolean(!0);if(l.A.canUseDOM){window.docusaurus=re;const e=document.getElementById("__docusaurus"),t=(0,f.jsx)(a.vd,{children:(0,f.jsx)(oe,{children:(0,f.jsx)(Q,{})})}),n=(e,t)=>{console.error("Docusaurus React Root onRecoverableError:",e,t)},i=()=>{if(window.docusaurusRoot)window.docusaurusRoot.render(t);else if(ae)window.docusaurusRoot=o.hydrateRoot(e,t,{onRecoverableError:n});else{const r=o.createRoot(e,{onRecoverableError:n});r.render(t),window.docusaurusRoot=r}};D(window.location.pathname).then((()=>{(0,r.startTransition)(i)}))}},6988:(e,t,n)=>{"use strict";n.d(t,{o:()=>d,l:()=>p});var r=n(6540),o=n(4784);const a=JSON.parse('{"docusaurus-plugin-content-docs":{"default":{"path":"/docs","versions":[{"name":"current","label":"Next","isLast":true,"path":"/docs","mainDocId":"intro","docs":[{"id":"advanced/best-practices","path":"/docs/advanced/best-practices","sidebar":"tutorialSidebar"},{"id":"api/index","path":"/docs/api/","sidebar":"tutorialSidebar"},{"id":"concepts/glossary","path":"/docs/concepts/glossary","sidebar":"tutorialSidebar"},{"id":"concepts/how-it-works","path":"/docs/concepts/how-it-works","sidebar":"tutorialSidebar"},{"id":"configuration/capture-qr","path":"/docs/configuration/capture-qr","sidebar":"tutorialSidebar"},{"id":"configuration/capture-sd","path":"/docs/configuration/capture-sd","sidebar":"tutorialSidebar"},{"id":"configuration/command-line-options","path":"/docs/configuration/command-line-options","sidebar":"tutorialSidebar"},{"id":"configuration/config-object","path":"/docs/configuration/config-object","sidebar":"tutorialSidebar"},{"id":"configuration/launch-events","path":"/docs/configuration/launch-events","sidebar":"tutorialSidebar"},{"id":"configuration/licensed-features","path":"/docs/configuration/licensed-features","sidebar":"tutorialSidebar"},{"id":"configuration/multiple-sessions","path":"/docs/configuration/multiple-sessions","sidebar":"tutorialSidebar"},{"id":"configuration/the-client","path":"/docs/configuration/the-client","sidebar":"tutorialSidebar"},{"id":"get-started/docker","path":"/docs/get-started/docker","sidebar":"tutorialSidebar"},{"id":"get-started/installation","path":"/docs/get-started/installation","sidebar":"tutorialSidebar"},{"id":"get-started/link-code","path":"/docs/get-started/link-code","sidebar":"tutorialSidebar"},{"id":"get-started/quick-run","path":"/docs/get-started/quick-run","sidebar":"tutorialSidebar"},{"id":"get-started/socketmode","path":"/docs/get-started/socketmode","sidebar":"tutorialSidebar"},{"id":"how-to/create-api","path":"/docs/how-to/create-api","sidebar":"tutorialSidebar"},{"id":"how-to/decrypt-media","path":"/docs/how-to/decrypt-media","sidebar":"tutorialSidebar"},{"id":"how-to/detect-logout","path":"/docs/how-to/detect-logout","sidebar":"tutorialSidebar"},{"id":"how-to/groups","path":"/docs/how-to/groups","sidebar":"tutorialSidebar"},{"id":"how-to/handle-errors","path":"/docs/how-to/handle-errors","sidebar":"tutorialSidebar"},{"id":"how-to/incoming-calls","path":"/docs/how-to/incoming-calls","sidebar":"tutorialSidebar"},{"id":"how-to/location","path":"/docs/how-to/location","sidebar":"tutorialSidebar"},{"id":"how-to/manage-participants","path":"/docs/how-to/manage-participants","sidebar":"tutorialSidebar"},{"id":"how-to/misc","path":"/docs/how-to/misc","sidebar":"tutorialSidebar"},{"id":"how-to/react-to-group-events","path":"/docs/how-to/react-to-group-events","sidebar":"tutorialSidebar"},{"id":"how-to/read-state","path":"/docs/how-to/read-state","sidebar":"tutorialSidebar"},{"id":"how-to/receive-files","path":"/docs/how-to/receive-files","sidebar":"tutorialSidebar"},{"id":"how-to/receive-messages","path":"/docs/how-to/receive-messages","sidebar":"tutorialSidebar"},{"id":"how-to/send-files","path":"/docs/how-to/send-files","sidebar":"tutorialSidebar"},{"id":"how-to/send-messages","path":"/docs/how-to/send-messages","sidebar":"tutorialSidebar"},{"id":"how-to/send-videos","path":"/docs/how-to/send-videos","sidebar":"tutorialSidebar"},{"id":"how-to/sendfile","path":"/docs/how-to/sendfile","sidebar":"tutorialSidebar"},{"id":"how-to/use-a-proxy","path":"/docs/how-to/use-a-proxy","sidebar":"tutorialSidebar"},{"id":"Integrations/chatwoot","path":"/docs/Integrations/chatwoot","sidebar":"tutorialSidebar"},{"id":"intro","path":"/docs/intro","sidebar":"tutorialSidebar"},{"id":"reference/api/Client/classes/Client","path":"/docs/reference/api/Client/classes/Client","sidebar":"tutorialSidebar"},{"id":"reference/api/Client/enumerations/namespace","path":"/docs/reference/api/Client/enumerations/namespace","sidebar":"tutorialSidebar"},{"id":"reference/api/Client/index","path":"/docs/reference/api/Client/","sidebar":"tutorialSidebar"},{"id":"reference/api/Client/variables/useragent","path":"/docs/reference/api/Client/variables/useragent","sidebar":"tutorialSidebar"},{"id":"reference/api/functions/exposed.enum/enumerations/ExposedFn","path":"/docs/reference/api/functions/exposed.enum/enumerations/ExposedFn","sidebar":"tutorialSidebar"},{"id":"reference/api/functions/exposed.enum/index","path":"/docs/reference/api/functions/exposed.enum/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/index","path":"/docs/reference/api/model/aliases/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/AccountNumber","path":"/docs/reference/api/model/aliases/type-aliases/AccountNumber","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/AdvancedFile","path":"/docs/reference/api/model/aliases/type-aliases/AdvancedFile","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/Base64","path":"/docs/reference/api/model/aliases/type-aliases/Base64","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/ChatId","path":"/docs/reference/api/model/aliases/type-aliases/ChatId","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/ChatServer","path":"/docs/reference/api/model/aliases/type-aliases/ChatServer","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/ContactId","path":"/docs/reference/api/model/aliases/type-aliases/ContactId","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/Content","path":"/docs/reference/api/model/aliases/type-aliases/Content","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/CountryCode","path":"/docs/reference/api/model/aliases/type-aliases/CountryCode","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/DataURL","path":"/docs/reference/api/model/aliases/type-aliases/DataURL","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/FilePath","path":"/docs/reference/api/model/aliases/type-aliases/FilePath","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/GetURL","path":"/docs/reference/api/model/aliases/type-aliases/GetURL","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/GroupChatId","path":"/docs/reference/api/model/aliases/type-aliases/GroupChatId","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/GroupChatServer","path":"/docs/reference/api/model/aliases/type-aliases/GroupChatServer","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/GroupId","path":"/docs/reference/api/model/aliases/type-aliases/GroupId","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/MessageId","path":"/docs/reference/api/model/aliases/type-aliases/MessageId","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/NonSerializedId","path":"/docs/reference/api/model/aliases/type-aliases/NonSerializedId","sidebar":"tutorialSidebar"},{"id":"reference/api/model/aliases/type-aliases/WaServers","path":"/docs/reference/api/model/aliases/type-aliases/WaServers","sidebar":"tutorialSidebar"},{"id":"reference/api/model/button/index","path":"/docs/reference/api/model/button/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/button/interfaces/AdvancedButton","path":"/docs/reference/api/model/button/interfaces/AdvancedButton","sidebar":"tutorialSidebar"},{"id":"reference/api/model/button/interfaces/Button","path":"/docs/reference/api/model/button/interfaces/Button","sidebar":"tutorialSidebar"},{"id":"reference/api/model/button/interfaces/LocationButtonBody","path":"/docs/reference/api/model/button/interfaces/LocationButtonBody","sidebar":"tutorialSidebar"},{"id":"reference/api/model/button/interfaces/Row","path":"/docs/reference/api/model/button/interfaces/Row","sidebar":"tutorialSidebar"},{"id":"reference/api/model/button/interfaces/Section","path":"/docs/reference/api/model/button/interfaces/Section","sidebar":"tutorialSidebar"},{"id":"reference/api/model/call/enumerations/CallState","path":"/docs/reference/api/model/call/enumerations/CallState","sidebar":"tutorialSidebar"},{"id":"reference/api/model/call/index","path":"/docs/reference/api/model/call/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/call/interfaces/Call","path":"/docs/reference/api/model/call/interfaces/Call","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/enumerations/ChatMuteDuration","path":"/docs/reference/api/model/chat/enumerations/ChatMuteDuration","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/enumerations/ChatState","path":"/docs/reference/api/model/chat/enumerations/ChatState","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/enumerations/ChatTypes","path":"/docs/reference/api/model/chat/enumerations/ChatTypes","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/index","path":"/docs/reference/api/model/chat/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/interfaces/BaseChat","path":"/docs/reference/api/model/chat/interfaces/BaseChat","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/interfaces/GroupChat","path":"/docs/reference/api/model/chat/interfaces/GroupChat","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse","path":"/docs/reference/api/model/chat/interfaces/GroupChatCreationParticipantAddResponse","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/interfaces/GroupChatCreationResponse","path":"/docs/reference/api/model/chat/interfaces/GroupChatCreationResponse","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/interfaces/LiveLocationChangedEvent","path":"/docs/reference/api/model/chat/interfaces/LiveLocationChangedEvent","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/interfaces/SingleChat","path":"/docs/reference/api/model/chat/interfaces/SingleChat","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/type-aliases/Chat","path":"/docs/reference/api/model/chat/type-aliases/Chat","sidebar":"tutorialSidebar"},{"id":"reference/api/model/chat/type-aliases/EphemeralDuration","path":"/docs/reference/api/model/chat/type-aliases/EphemeralDuration","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/enumerations/CLOUD_PROVIDERS","path":"/docs/reference/api/model/config/enumerations/CLOUD_PROVIDERS","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/enumerations/DIRECTORY_STRATEGY","path":"/docs/reference/api/model/config/enumerations/DIRECTORY_STRATEGY","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/enumerations/LicenseType","path":"/docs/reference/api/model/config/enumerations/LicenseType","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/enumerations/NotificationLanguage","path":"/docs/reference/api/model/config/enumerations/NotificationLanguage","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/enumerations/OnError","path":"/docs/reference/api/model/config/enumerations/OnError","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/enumerations/QRFormat","path":"/docs/reference/api/model/config/enumerations/QRFormat","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/enumerations/QRQuality","path":"/docs/reference/api/model/config/enumerations/QRQuality","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/index","path":"/docs/reference/api/model/config/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/interfaces/ConfigObject","path":"/docs/reference/api/model/config/interfaces/ConfigObject","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/interfaces/DevTools","path":"/docs/reference/api/model/config/interfaces/DevTools","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/interfaces/EventPayload","path":"/docs/reference/api/model/config/interfaces/EventPayload","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/interfaces/ProxyServerCredentials","path":"/docs/reference/api/model/config/interfaces/ProxyServerCredentials","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/interfaces/SessionData","path":"/docs/reference/api/model/config/interfaces/SessionData","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/interfaces/Webhook","path":"/docs/reference/api/model/config/interfaces/Webhook","sidebar":"tutorialSidebar"},{"id":"reference/api/model/config/type-aliases/AdvancedConfig","path":"/docs/reference/api/model/config/type-aliases/AdvancedConfig","sidebar":"tutorialSidebar"},{"id":"reference/api/model/contact/index","path":"/docs/reference/api/model/contact/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/contact/interfaces/BizCategory","path":"/docs/reference/api/model/contact/interfaces/BizCategory","sidebar":"tutorialSidebar"},{"id":"reference/api/model/contact/interfaces/BizProfileOptions","path":"/docs/reference/api/model/contact/interfaces/BizProfileOptions","sidebar":"tutorialSidebar"},{"id":"reference/api/model/contact/interfaces/BusinessHours","path":"/docs/reference/api/model/contact/interfaces/BusinessHours","sidebar":"tutorialSidebar"},{"id":"reference/api/model/contact/interfaces/BusinessProfile","path":"/docs/reference/api/model/contact/interfaces/BusinessProfile","sidebar":"tutorialSidebar"},{"id":"reference/api/model/contact/interfaces/Contact","path":"/docs/reference/api/model/contact/interfaces/Contact","sidebar":"tutorialSidebar"},{"id":"reference/api/model/contact/interfaces/NumberCheck","path":"/docs/reference/api/model/contact/interfaces/NumberCheck","sidebar":"tutorialSidebar"},{"id":"reference/api/model/enumerations/Events","path":"/docs/reference/api/model/enumerations/Events","sidebar":"tutorialSidebar"},{"id":"reference/api/model/enumerations/STATE","path":"/docs/reference/api/model/enumerations/STATE","sidebar":"tutorialSidebar"},{"id":"reference/api/model/enumerations/Status","path":"/docs/reference/api/model/enumerations/Status","sidebar":"tutorialSidebar"},{"id":"reference/api/model/errors/classes/AddParticipantError","path":"/docs/reference/api/model/errors/classes/AddParticipantError","sidebar":"tutorialSidebar"},{"id":"reference/api/model/errors/classes/CustomError","path":"/docs/reference/api/model/errors/classes/CustomError","sidebar":"tutorialSidebar"},{"id":"reference/api/model/errors/classes/PageEvaluationTimeout","path":"/docs/reference/api/model/errors/classes/PageEvaluationTimeout","sidebar":"tutorialSidebar"},{"id":"reference/api/model/errors/classes/SessionExpiredError","path":"/docs/reference/api/model/errors/classes/SessionExpiredError","sidebar":"tutorialSidebar"},{"id":"reference/api/model/errors/enumerations/AddParticipantErrorStatusCode","path":"/docs/reference/api/model/errors/enumerations/AddParticipantErrorStatusCode","sidebar":"tutorialSidebar"},{"id":"reference/api/model/errors/enumerations/ERROR_NAME","path":"/docs/reference/api/model/errors/enumerations/ERROR_NAME","sidebar":"tutorialSidebar"},{"id":"reference/api/model/errors/index","path":"/docs/reference/api/model/errors/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/events/enumerations/SimpleListener","path":"/docs/reference/api/model/events/enumerations/SimpleListener","sidebar":"tutorialSidebar"},{"id":"reference/api/model/events/index","path":"/docs/reference/api/model/events/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/group-metadata/enumerations/groupChangeEvent","path":"/docs/reference/api/model/group-metadata/enumerations/groupChangeEvent","sidebar":"tutorialSidebar"},{"id":"reference/api/model/group-metadata/enumerations/GroupNotificationTypes","path":"/docs/reference/api/model/group-metadata/enumerations/GroupNotificationTypes","sidebar":"tutorialSidebar"},{"id":"reference/api/model/group-metadata/index","path":"/docs/reference/api/model/group-metadata/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent","path":"/docs/reference/api/model/group-metadata/interfaces/GenericGroupChangeEvent","sidebar":"tutorialSidebar"},{"id":"reference/api/model/group-metadata/interfaces/GroupMetadata","path":"/docs/reference/api/model/group-metadata/interfaces/GroupMetadata","sidebar":"tutorialSidebar"},{"id":"reference/api/model/group-metadata/interfaces/NewCommunityGroup","path":"/docs/reference/api/model/group-metadata/interfaces/NewCommunityGroup","sidebar":"tutorialSidebar"},{"id":"reference/api/model/group-metadata/interfaces/Participant","path":"/docs/reference/api/model/group-metadata/interfaces/Participant","sidebar":"tutorialSidebar"},{"id":"reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel","path":"/docs/reference/api/model/group-metadata/interfaces/ParticipantChangedEventModel","sidebar":"tutorialSidebar"},{"id":"reference/api/model/id/index","path":"/docs/reference/api/model/id/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/id/interfaces/Id","path":"/docs/reference/api/model/id/interfaces/Id","sidebar":"tutorialSidebar"},{"id":"reference/api/model/index","path":"/docs/reference/api/model/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/label/index","path":"/docs/reference/api/model/label/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/label/interfaces/Label","path":"/docs/reference/api/model/label/interfaces/Label","sidebar":"tutorialSidebar"},{"id":"reference/api/model/media/index","path":"/docs/reference/api/model/media/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions","path":"/docs/reference/api/model/media/type-aliases/Mp4StickerConversionProcessOptions","sidebar":"tutorialSidebar"},{"id":"reference/api/model/media/type-aliases/StickerMetadata","path":"/docs/reference/api/model/media/type-aliases/StickerMetadata","sidebar":"tutorialSidebar"},{"id":"reference/api/model/media/variables/defaultProcessOptions","path":"/docs/reference/api/model/media/variables/defaultProcessOptions","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/enumerations/MessageAck","path":"/docs/reference/api/model/message/enumerations/MessageAck","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/enumerations/MessageTypes","path":"/docs/reference/api/model/message/enumerations/MessageTypes","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/index","path":"/docs/reference/api/model/message/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/interfaces/Message","path":"/docs/reference/api/model/message/interfaces/Message","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/interfaces/MessageInfo","path":"/docs/reference/api/model/message/interfaces/MessageInfo","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/interfaces/MessageInfoInteraction","path":"/docs/reference/api/model/message/interfaces/MessageInfoInteraction","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/interfaces/PollData","path":"/docs/reference/api/model/message/interfaces/PollData","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/interfaces/PollOption","path":"/docs/reference/api/model/message/interfaces/PollOption","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/interfaces/PollVote","path":"/docs/reference/api/model/message/interfaces/PollVote","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/interfaces/QuoteMap","path":"/docs/reference/api/model/message/interfaces/QuoteMap","sidebar":"tutorialSidebar"},{"id":"reference/api/model/message/interfaces/ReactionSender","path":"/docs/reference/api/model/message/interfaces/ReactionSender","sidebar":"tutorialSidebar"},{"id":"reference/api/model/product/index","path":"/docs/reference/api/model/product/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/product/interfaces/CartItem","path":"/docs/reference/api/model/product/interfaces/CartItem","sidebar":"tutorialSidebar"},{"id":"reference/api/model/product/interfaces/CustomProduct","path":"/docs/reference/api/model/product/interfaces/CustomProduct","sidebar":"tutorialSidebar"},{"id":"reference/api/model/product/interfaces/Order","path":"/docs/reference/api/model/product/interfaces/Order","sidebar":"tutorialSidebar"},{"id":"reference/api/model/product/interfaces/Product","path":"/docs/reference/api/model/product/interfaces/Product","sidebar":"tutorialSidebar"},{"id":"reference/api/model/reactions/index","path":"/docs/reference/api/model/reactions/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/reactions/type-aliases/Reaction","path":"/docs/reference/api/model/reactions/type-aliases/Reaction","sidebar":"tutorialSidebar"},{"id":"reference/api/model/reactions/type-aliases/ReactionEvent","path":"/docs/reference/api/model/reactions/type-aliases/ReactionEvent","sidebar":"tutorialSidebar"},{"id":"reference/api/model/reactions/type-aliases/ReactionRecord","path":"/docs/reference/api/model/reactions/type-aliases/ReactionRecord","sidebar":"tutorialSidebar"},{"id":"reference/api/model/sessionInfo/index","path":"/docs/reference/api/model/sessionInfo/","sidebar":"tutorialSidebar"},{"id":"reference/api/model/sessionInfo/interfaces/HealthCheck","path":"/docs/reference/api/model/sessionInfo/interfaces/HealthCheck","sidebar":"tutorialSidebar"},{"id":"reference/api/model/sessionInfo/interfaces/SessionInfo","path":"/docs/reference/api/model/sessionInfo/interfaces/SessionInfo","sidebar":"tutorialSidebar"},{"id":"reference/api/model/type-aliases/EasyApiResponse","path":"/docs/reference/api/model/type-aliases/EasyApiResponse","sidebar":"tutorialSidebar"},{"id":"reference/controllers/events/index","path":"/docs/reference/controllers/events/","sidebar":"tutorialSidebar"},{"id":"reference/controllers/events/variables/ev","path":"/docs/reference/controllers/events/variables/ev","sidebar":"tutorialSidebar"},{"id":"reference/controllers/init_patch/index","path":"/docs/reference/controllers/init_patch/","sidebar":"tutorialSidebar"},{"id":"reference/controllers/initializer/functions/create","path":"/docs/reference/controllers/initializer/functions/create","sidebar":"tutorialSidebar"},{"id":"reference/controllers/initializer/functions/timeout","path":"/docs/reference/controllers/initializer/functions/timeout","sidebar":"tutorialSidebar"},{"id":"reference/controllers/initializer/index","path":"/docs/reference/controllers/initializer/","sidebar":"tutorialSidebar"},{"id":"reference/controllers/initializer/variables/configWithCases","path":"/docs/reference/controllers/initializer/variables/configWithCases","sidebar":"tutorialSidebar"},{"id":"reference/controllers/initializer/variables/pkg","path":"/docs/reference/controllers/initializer/variables/pkg","sidebar":"tutorialSidebar"},{"id":"reference/controllers/initializer/variables/screenshot","path":"/docs/reference/controllers/initializer/variables/screenshot","sidebar":"tutorialSidebar"},{"id":"reference/controllers/patch_manager/functions/earlyInjectionCheck","path":"/docs/reference/controllers/patch_manager/functions/earlyInjectionCheck","sidebar":"tutorialSidebar"},{"id":"reference/controllers/patch_manager/functions/getAndInjectLicense","path":"/docs/reference/controllers/patch_manager/functions/getAndInjectLicense","sidebar":"tutorialSidebar"},{"id":"reference/controllers/patch_manager/index","path":"/docs/reference/controllers/patch_manager/","sidebar":"tutorialSidebar"},{"id":"reference/index","path":"/docs/reference/","sidebar":"tutorialSidebar"},{"id":"reference/logging/custom_transport/classes/LogToEvTransport","path":"/docs/reference/logging/custom_transport/classes/LogToEvTransport","sidebar":"tutorialSidebar"},{"id":"reference/logging/custom_transport/classes/NoOpTransport","path":"/docs/reference/logging/custom_transport/classes/NoOpTransport","sidebar":"tutorialSidebar"},{"id":"reference/logging/custom_transport/index","path":"/docs/reference/logging/custom_transport/","sidebar":"tutorialSidebar"},{"id":"reference/logging/logging/functions/addRotateFileLogTransport","path":"/docs/reference/logging/logging/functions/addRotateFileLogTransport","sidebar":"tutorialSidebar"},{"id":"reference/logging/logging/index","path":"/docs/reference/logging/logging/","sidebar":"tutorialSidebar"},{"id":"reference/logging/logging/type-aliases/ConfigLogTransport","path":"/docs/reference/logging/logging/type-aliases/ConfigLogTransport","sidebar":"tutorialSidebar"},{"id":"reference/logging/logging/variables/log","path":"/docs/reference/logging/logging/variables/log","sidebar":"tutorialSidebar"},{"id":"reference/structures/Collector/classes/Collection","path":"/docs/reference/structures/Collector/classes/Collection","sidebar":"tutorialSidebar"},{"id":"reference/structures/Collector/classes/Collector","path":"/docs/reference/structures/Collector/classes/Collector","sidebar":"tutorialSidebar"},{"id":"reference/structures/Collector/index","path":"/docs/reference/structures/Collector/","sidebar":"tutorialSidebar"},{"id":"reference/structures/Collector/interfaces/AwaitMessagesOptions","path":"/docs/reference/structures/Collector/interfaces/AwaitMessagesOptions","sidebar":"tutorialSidebar"},{"id":"reference/structures/Collector/interfaces/CollectorOptions","path":"/docs/reference/structures/Collector/interfaces/CollectorOptions","sidebar":"tutorialSidebar"},{"id":"reference/structures/Collector/type-aliases/CollectorFilter","path":"/docs/reference/structures/Collector/type-aliases/CollectorFilter","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/enumerations/ValidationType","path":"/docs/reference/structures/Dialog/enumerations/ValidationType","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/index","path":"/docs/reference/structures/Dialog/","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/interfaces/CurrentDialogProps","path":"/docs/reference/structures/Dialog/interfaces/CurrentDialogProps","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/interfaces/DialogButtons","path":"/docs/reference/structures/Dialog/interfaces/DialogButtons","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/interfaces/DialogListMessageRow","path":"/docs/reference/structures/Dialog/interfaces/DialogListMessageRow","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/interfaces/DialogListMessageSection","path":"/docs/reference/structures/Dialog/interfaces/DialogListMessageSection","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/interfaces/DialogProperty","path":"/docs/reference/structures/Dialog/interfaces/DialogProperty","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/interfaces/DialogState","path":"/docs/reference/structures/Dialog/interfaces/DialogState","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/interfaces/DialogTemplate","path":"/docs/reference/structures/Dialog/interfaces/DialogTemplate","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/interfaces/DialogValidation","path":"/docs/reference/structures/Dialog/interfaces/DialogValidation","sidebar":"tutorialSidebar"},{"id":"reference/structures/Dialog/type-aliases/CheckFunction","path":"/docs/reference/structures/Dialog/type-aliases/CheckFunction","sidebar":"tutorialSidebar"},{"id":"reference/structures/MessageCollector/classes/MessageCollector","path":"/docs/reference/structures/MessageCollector/classes/MessageCollector","sidebar":"tutorialSidebar"},{"id":"reference/structures/MessageCollector/index","path":"/docs/reference/structures/MessageCollector/","sidebar":"tutorialSidebar"},{"id":"reference/structures/preProcessors/enumerations/PREPROCESSORS","path":"/docs/reference/structures/preProcessors/enumerations/PREPROCESSORS","sidebar":"tutorialSidebar"},{"id":"reference/structures/preProcessors/index","path":"/docs/reference/structures/preProcessors/","sidebar":"tutorialSidebar"},{"id":"reference/structures/preProcessors/type-aliases/MessagePreProcessor","path":"/docs/reference/structures/preProcessors/type-aliases/MessagePreProcessor","sidebar":"tutorialSidebar"},{"id":"reference/structures/preProcessors/type-aliases/MPConfigType","path":"/docs/reference/structures/preProcessors/type-aliases/MPConfigType","sidebar":"tutorialSidebar"},{"id":"reference/structures/preProcessors/variables/MessagePreprocessors","path":"/docs/reference/structures/preProcessors/variables/MessagePreprocessors","sidebar":"tutorialSidebar"},{"id":"tutorial-basics/congratulations","path":"/docs/tutorial-basics/congratulations","sidebar":"tutorialSidebar"},{"id":"tutorial-basics/create-a-blog-post","path":"/docs/tutorial-basics/create-a-blog-post","sidebar":"tutorialSidebar"},{"id":"tutorial-basics/create-a-document","path":"/docs/tutorial-basics/create-a-document","sidebar":"tutorialSidebar"},{"id":"tutorial-basics/create-a-page","path":"/docs/tutorial-basics/create-a-page","sidebar":"tutorialSidebar"},{"id":"tutorial-basics/deploy-your-site","path":"/docs/tutorial-basics/deploy-your-site","sidebar":"tutorialSidebar"},{"id":"tutorial-basics/markdown-features","path":"/docs/tutorial-basics/markdown-features","sidebar":"tutorialSidebar"},{"id":"tutorial-extras/manage-docs-versions","path":"/docs/tutorial-extras/manage-docs-versions","sidebar":"tutorialSidebar"},{"id":"tutorial-extras/translate-your-site","path":"/docs/tutorial-extras/translate-your-site","sidebar":"tutorialSidebar"},{"id":"/category/tutorial---basics","path":"/docs/category/tutorial---basics","sidebar":"tutorialSidebar"},{"id":"/category/tutorial---extras","path":"/docs/category/tutorial---extras","sidebar":"tutorialSidebar"}],"draftIds":[],"sidebars":{"tutorialSidebar":{"link":{"path":"/docs/intro","label":"intro"}}}}],"breadcrumbs":true}}}'),i=JSON.parse('{"defaultLocale":"en","locales":["en"],"path":"i18n","currentLocale":"en","localeConfigs":{"en":{"label":"English","direction":"ltr","htmlLang":"en","calendar":"gregory","path":"en"}}}');var s=n(2654);const l=JSON.parse('{"docusaurusVersion":"3.5.2","siteVersion":"0.0.0","pluginVersions":{"docusaurus-plugin-content-docs":{"type":"package","name":"@docusaurus/plugin-content-docs","version":"3.5.2"},"docusaurus-plugin-content-blog":{"type":"package","name":"@docusaurus/plugin-content-blog","version":"3.5.2"},"docusaurus-plugin-content-pages":{"type":"package","name":"@docusaurus/plugin-content-pages","version":"3.5.2"},"docusaurus-plugin-sitemap":{"type":"package","name":"@docusaurus/plugin-sitemap","version":"3.5.2"},"docusaurus-theme-classic":{"type":"package","name":"@docusaurus/theme-classic","version":"3.5.2"},"docusaurus-theme-search-algolia":{"type":"package","name":"@docusaurus/theme-search-algolia","version":"3.5.2"},"posthog-docusaurus":{"type":"package","name":"posthog-docusaurus","version":"2.0.1"},"docusaurus-plugin-typedoc":{"type":"package","name":"docusaurus-plugin-typedoc","version":"1.0.3"},"md-placeholder-replacer":{"type":"local"},"tailwind-plugin":{"type":"local"}}}');var c=n(4848);const u={siteConfig:o.default,siteMetadata:l,globalData:a,i18n:i,codeTranslations:s},d=r.createContext(u);function p(e){let{children:t}=e;return(0,c.jsx)(d.Provider,{value:u,children:t})}},7489:(e,t,n)=>{"use strict";n.d(t,{A:()=>h});var r=n(6540),o=n(8193),a=n(5260),i=n(440),s=n(3277),l=n(3102),c=n(4848);function u(e){let{error:t,tryAgain:n}=e;return(0,c.jsxs)("div",{style:{display:"flex",flexDirection:"column",justifyContent:"center",alignItems:"flex-start",minHeight:"100vh",width:"100%",maxWidth:"80ch",fontSize:"20px",margin:"0 auto",padding:"1rem"},children:[(0,c.jsx)("h1",{style:{fontSize:"3rem"},children:"This page crashed"}),(0,c.jsx)("button",{type:"button",onClick:n,style:{margin:"1rem 0",fontSize:"2rem",cursor:"pointer",borderRadius:20,padding:"1rem"},children:"Try again"}),(0,c.jsx)(d,{error:t})]})}function d(e){let{error:t}=e;const n=(0,i.rA)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,c.jsx)("p",{style:{whiteSpace:"pre-wrap"},children:n})}function p(e){let{children:t}=e;return(0,c.jsx)(l.W,{value:{plugin:{name:"docusaurus-core-error-boundary",id:"default"}},children:t})}function f(e){let{error:t,tryAgain:n}=e;return(0,c.jsx)(p,{children:(0,c.jsxs)(h,{fallback:()=>(0,c.jsx)(u,{error:t,tryAgain:n}),children:[(0,c.jsx)(a.A,{children:(0,c.jsx)("title",{children:"Page Error"})}),(0,c.jsx)(s.A,{children:(0,c.jsx)(u,{error:t,tryAgain:n})})]})})}const m=e=>(0,c.jsx)(f,{...e});class h extends r.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){o.A.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){const e={error:t,tryAgain:()=>this.setState({error:null})};return(this.props.fallback??m)(e)}return e??null}}},8193:(e,t,n)=>{"use strict";n.d(t,{A:()=>o});const r="undefined"!=typeof window&&"document"in window&&"createElement"in window.document,o={canUseDOM:r,canUseEventListeners:r&&("addEventListener"in window||"attachEvent"in window),canUseIntersectionObserver:r&&"IntersectionObserver"in window,canUseViewport:r&&"screen"in window}},5260:(e,t,n)=>{"use strict";n.d(t,{A:()=>a});n(6540);var r=n(545),o=n(4848);function a(e){return(0,o.jsx)(r.mg,{...e})}},8774:(e,t,n)=>{"use strict";n.d(t,{A:()=>f});var r=n(6540),o=n(4625),a=n(440),i=n(4586),s=n(6654),l=n(8193),c=n(3427),u=n(6025),d=n(4848);function p(e,t){let{isNavLink:n,to:p,href:f,activeClassName:m,isActive:h,"data-noBrokenLinkCheck":g,autoAddBaseUrl:b=!0,...y}=e;const{siteConfig:v}=(0,i.A)(),{trailingSlash:w,baseUrl:S}=v,k=v.future.experimental_router,{withBaseUrl:x}=(0,u.hH)(),_=(0,c.A)(),E=(0,r.useRef)(null);(0,r.useImperativeHandle)(t,(()=>E.current));const C=p||f;const O=(0,s.A)(C),P=C?.replace("pathname://","");let T=void 0!==P?(A=P,b&&(e=>e.startsWith("/"))(A)?x(A):A):void 0;var A;"hash"===k&&T?.startsWith("./")&&(T=T?.slice(1)),T&&O&&(T=(0,a.Ks)(T,{trailingSlash:w,baseUrl:S}));const j=(0,r.useRef)(!1),R=n?o.k2:o.N_,I=l.A.canUseIntersectionObserver,D=(0,r.useRef)(),L=()=>{j.current||null==T||(window.docusaurus.preload(T),j.current=!0)};(0,r.useEffect)((()=>(!I&&O&&l.A.canUseDOM&&null!=T&&window.docusaurus.prefetch(T),()=>{I&&D.current&&D.current.disconnect()})),[D,T,I,O]);const N=T?.startsWith("#")??!1,M=!y.target||"_self"===y.target,F=!T||!O||!M||N&&"hash"!==k;g||!N&&F||_.collectLink(T),y.id&&_.collectAnchor(y.id);const B={};return F?(0,d.jsx)("a",{ref:E,href:T,...C&&!O&&{target:"_blank",rel:"noopener noreferrer"},...y,...B}):(0,d.jsx)(R,{...y,onMouseEnter:L,onTouchStart:L,innerRef:e=>{E.current=e,I&&e&&O&&(D.current=new window.IntersectionObserver((t=>{t.forEach((t=>{e===t.target&&(t.isIntersecting||t.intersectionRatio>0)&&(D.current.unobserve(e),D.current.disconnect(),null!=T&&window.docusaurus.prefetch(T))}))})),D.current.observe(e))},to:T,...n&&{isActive:h,activeClassName:m},...B})}const f=r.forwardRef(p)},1312:(e,t,n)=>{"use strict";n.d(t,{A:()=>c,T:()=>l});var r=n(6540),o=n(4848);function a(e,t){const n=e.split(/(\{\w+\})/).map(((e,n)=>{if(n%2==1){const n=t?.[e.slice(1,-1)];if(void 0!==n)return n}return e}));return n.some((e=>(0,r.isValidElement)(e)))?n.map(((e,t)=>(0,r.isValidElement)(e)?r.cloneElement(e,{key:t}):e)).filter((e=>""!==e)):n.join("")}var i=n(2654);function s(e){let{id:t,message:n}=e;if(void 0===t&&void 0===n)throw new Error("Docusaurus translation declarations must have at least a translation id or a default translation message");return i[t??n]??n??t}function l(e,t){let{message:n,id:r}=e;return a(s({message:n,id:r}),t)}function c(e){let{children:t,id:n,values:r}=e;if(t&&"string"!=typeof t)throw console.warn("Illegal children",t),new Error("The Docusaurus component only accept simple string values");const i=s({message:t,id:n});return(0,o.jsx)(o.Fragment,{children:a(i,r)})}},7065:(e,t,n)=>{"use strict";n.d(t,{W:()=>r});const r="default"},6654:(e,t,n)=>{"use strict";function r(e){return/^(?:\w*:|\/\/)/.test(e)}function o(e){return void 0!==e&&!r(e)}n.d(t,{A:()=>o,z:()=>r})},6025:(e,t,n)=>{"use strict";n.d(t,{Ay:()=>s,hH:()=>i});var r=n(6540),o=n(4586),a=n(6654);function i(){const{siteConfig:e}=(0,o.A)(),{baseUrl:t,url:n}=e,i=e.future.experimental_router,s=(0,r.useCallback)(((e,r)=>function(e){let{siteUrl:t,baseUrl:n,url:r,options:{forcePrependBaseUrl:o=!1,absolute:i=!1}={},router:s}=e;if(!r||r.startsWith("#")||(0,a.z)(r))return r;if("hash"===s)return r.startsWith("/")?`.${r}`:`./${r}`;if(o)return n+r.replace(/^\//,"");if(r===n.replace(/\/$/,""))return n;const l=r.startsWith(n)?r:n+r.replace(/^\//,"");return i?t+l:l}({siteUrl:n,baseUrl:t,url:e,options:r,router:i})),[n,t,i]);return{withBaseUrl:s}}function s(e,t){void 0===t&&(t={});const{withBaseUrl:n}=i();return n(e,t)}},3427:(e,t,n)=>{"use strict";n.d(t,{A:()=>i});var r=n(6540);n(4848);const o=r.createContext({collectAnchor:()=>{},collectLink:()=>{}}),a=()=>(0,r.useContext)(o);function i(){return a()}},4586:(e,t,n)=>{"use strict";n.d(t,{A:()=>a});var r=n(6540),o=n(6988);function a(){return(0,r.useContext)(o.o)}},2303:(e,t,n)=>{"use strict";n.d(t,{A:()=>a});var r=n(6540),o=n(6125);function a(){return(0,r.useContext)(o.o)}},205:(e,t,n)=>{"use strict";n.d(t,{A:()=>o});var r=n(6540);const o=n(8193).A.canUseDOM?r.useLayoutEffect:r.useEffect},6803:(e,t,n)=>{"use strict";n.d(t,{A:()=>a});var r=n(6540),o=n(3102);function a(){const e=r.useContext(o.o);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}},6921:(e,t,n)=>{"use strict";n.d(t,{A:()=>o});const r=e=>"object"==typeof e&&!!e&&Object.keys(e).length>0;function o(e){const t={};return function e(n,o){Object.entries(n).forEach((n=>{let[a,i]=n;const s=o?`${o}.${a}`:a;r(i)?e(i,s):t[s]=i}))}(e),t}},3102:(e,t,n)=>{"use strict";n.d(t,{W:()=>i,o:()=>a});var r=n(6540),o=n(4848);const a=r.createContext(null);function i(e){let{children:t,value:n}=e;const i=r.useContext(a),s=(0,r.useMemo)((()=>function(e){let{parent:t,value:n}=e;if(!t){if(!n)throw new Error("Unexpected: no Docusaurus route context found");if(!("plugin"in n))throw new Error("Unexpected: Docusaurus topmost route context has no `plugin` attribute");return n}const r={...t.data,...n?.data};return{plugin:t.plugin,data:r}}({parent:i,value:n})),[i,n]);return(0,o.jsx)(a.Provider,{value:s,children:t})}},3886:(e,t,n)=>{"use strict";n.d(t,{VQ:()=>g,XK:()=>v,g1:()=>y});var r=n(6540),o=n(4070),a=n(7065),i=n(6342),s=n(679),l=n(9532),c=n(4848);const u=e=>`docs-preferred-version-${e}`,d={save:(e,t,n)=>{(0,s.Wf)(u(e),{persistence:t}).set(n)},read:(e,t)=>(0,s.Wf)(u(e),{persistence:t}).get(),clear:(e,t)=>{(0,s.Wf)(u(e),{persistence:t}).del()}},p=e=>Object.fromEntries(e.map((e=>[e,{preferredVersionName:null}])));const f=r.createContext(null);function m(){const e=(0,o.Gy)(),t=(0,i.p)().docs.versionPersistence,n=(0,r.useMemo)((()=>Object.keys(e)),[e]),[a,s]=(0,r.useState)((()=>p(n)));(0,r.useEffect)((()=>{s(function(e){let{pluginIds:t,versionPersistence:n,allDocsData:r}=e;function o(e){const t=d.read(e,n);return r[e].versions.some((e=>e.name===t))?{preferredVersionName:t}:(d.clear(e,n),{preferredVersionName:null})}return Object.fromEntries(t.map((e=>[e,o(e)])))}({allDocsData:e,versionPersistence:t,pluginIds:n}))}),[e,t,n]);return[a,(0,r.useMemo)((()=>({savePreferredVersion:function(e,n){d.save(e,t,n),s((t=>({...t,[e]:{preferredVersionName:n}})))}})),[t])]}function h(e){let{children:t}=e;const n=m();return(0,c.jsx)(f.Provider,{value:n,children:t})}function g(e){let{children:t}=e;return(0,c.jsx)(h,{children:t})}function b(){const e=(0,r.useContext)(f);if(!e)throw new l.dV("DocsPreferredVersionContextProvider");return e}function y(e){void 0===e&&(e=a.W);const t=(0,o.ht)(e),[n,i]=b(),{preferredVersionName:s}=n[e];return{preferredVersion:t.versions.find((e=>e.name===s))??null,savePreferredVersionName:(0,r.useCallback)((t=>{i.savePreferredVersion(e,t)}),[i,e])}}function v(){const e=(0,o.Gy)(),[t]=b();function n(n){const r=e[n],{preferredVersionName:o}=t[n];return r.versions.find((e=>e.name===o))??null}const r=Object.keys(e);return Object.fromEntries(r.map((e=>[e,n(e)])))}},2565:(e,t,n)=>{"use strict";n.d(t,{k:()=>a,v:()=>i});var r=n(4070),o=n(3886);function a(e,t){return`docs-${e}-${t}`}function i(){const e=(0,r.Gy)(),t=(0,r.gk)(),n=(0,o.XK)();return[...Object.keys(e).map((function(r){const o=t?.activePlugin.pluginId===r?t.activeVersion:void 0,i=n[r],s=e[r].versions.find((e=>e.isLast));return a(r,(o??i??s).name)}))]}},609:(e,t,n)=>{"use strict";n.d(t,{V:()=>l,t:()=>c});var r=n(6540),o=n(9532),a=n(4848);const i=Symbol("EmptyContext"),s=r.createContext(i);function l(e){let{children:t,name:n,items:o}=e;const i=(0,r.useMemo)((()=>n&&o?{name:n,items:o}:null),[n,o]);return(0,a.jsx)(s.Provider,{value:i,children:t})}function c(){const e=(0,r.useContext)(s);if(e===i)throw new o.dV("DocsSidebarProvider");return e}},6972:(e,t,n)=>{"use strict";n.d(t,{$S:()=>m,B5:()=>E,Nr:()=>f,OF:()=>S,QB:()=>_,Vd:()=>k,Y:()=>v,cC:()=>p,d1:()=>C,fW:()=>x,w8:()=>b});var r=n(6540),o=n(6347),a=n(2831),i=n(4070),s=n(9169),l=n(1682),c=n(3886),u=n(3025),d=n(609);function p(e){const t=(0,u.r)();if(!e)return;const n=t.docs[e];if(!n)throw new Error(`no version doc found by id=${e}`);return n}function f(e){return"link"!==e.type||e.unlisted?"category"===e.type?function(e){if(e.href&&!e.linkUnlisted)return e.href;for(const t of e.items){const e=f(t);if(e)return e}}(e):void 0:e.href}function m(){const{pathname:e}=(0,o.zy)(),t=(0,d.t)();if(!t)throw new Error("Unexpected: cant find current sidebar in context");const n=w({sidebarItems:t.items,pathname:e,onlyCategories:!0}).slice(-1)[0];if(!n)throw new Error(`${e} is not associated with a category. useCurrentSidebarCategory() should only be used on category index pages.`);return n}const h=(e,t)=>void 0!==e&&(0,s.ys)(e,t),g=(e,t)=>e.some((e=>b(e,t)));function b(e,t){return"link"===e.type?h(e.href,t):"category"===e.type&&(h(e.href,t)||g(e.items,t))}function y(e,t){switch(e.type){case"category":return b(e,t)||e.items.some((e=>y(e,t)));case"link":return!e.unlisted||b(e,t);default:return!0}}function v(e,t){return(0,r.useMemo)((()=>e.filter((e=>y(e,t)))),[e,t])}function w(e){let{sidebarItems:t,pathname:n,onlyCategories:r=!1}=e;const o=[];return function e(t){for(const a of t)if("category"===a.type&&((0,s.ys)(a.href,n)||e(a.items))||"link"===a.type&&(0,s.ys)(a.href,n)){return r&&"category"!==a.type||o.unshift(a),!0}return!1}(t),o}function S(){const e=(0,d.t)(),{pathname:t}=(0,o.zy)(),n=(0,i.vT)()?.pluginData.breadcrumbs;return!1!==n&&e?w({sidebarItems:e.items,pathname:t}):null}function k(e){const{activeVersion:t}=(0,i.zK)(e),{preferredVersion:n}=(0,c.g1)(e),o=(0,i.r7)(e);return(0,r.useMemo)((()=>(0,l.sb)([t,n,o].filter(Boolean))),[t,n,o])}function x(e,t){const n=k(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.sidebars?Object.entries(e.sidebars):[])),r=t.find((t=>t[0]===e));if(!r)throw new Error(`Can't find any sidebar with id "${e}" in version${n.length>1?"s":""} ${n.map((e=>e.name)).join(", ")}".\nAvailable sidebar ids are:\n- ${t.map((e=>e[0])).join("\n- ")}`);return r[1]}),[e,n])}function _(e,t){const n=k(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.docs)),r=t.find((t=>t.id===e));if(!r){if(n.flatMap((e=>e.draftIds)).includes(e))return null;throw new Error(`Couldn't find any doc with id "${e}" in version${n.length>1?"s":""} "${n.map((e=>e.name)).join(", ")}".\nAvailable doc ids are:\n- ${(0,l.sb)(t.map((e=>e.id))).join("\n- ")}`)}return r}),[e,n])}function E(e){let{route:t}=e;const n=(0,o.zy)(),r=(0,u.r)(),i=t.routes,s=i.find((e=>(0,o.B6)(n.pathname,e)));if(!s)return null;const l=s.sidebar,c=l?r.docsSidebars[l]:void 0;return{docElement:(0,a.v)(i),sidebarName:l,sidebarItems:c}}function C(e){return e.filter((e=>!("category"===e.type||"link"===e.type)||!!f(e)))}},3025:(e,t,n)=>{"use strict";n.d(t,{n:()=>s,r:()=>l});var r=n(6540),o=n(9532),a=n(4848);const i=r.createContext(null);function s(e){let{children:t,version:n}=e;return(0,a.jsx)(i.Provider,{value:n,children:t})}function l(){const e=(0,r.useContext)(i);if(null===e)throw new o.dV("DocsVersionProvider");return e}},4070:(e,t,n)=>{"use strict";n.d(t,{zK:()=>b,vT:()=>f,gk:()=>m,Gy:()=>d,HW:()=>y,ht:()=>p,r7:()=>g,jh:()=>h});var r=n(6347),o=n(4586),a=n(7065);function i(e,t){void 0===t&&(t={});const n=function(){const{globalData:e}=(0,o.A)();return e}()[e];if(!n&&t.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin.`);return n}const s=e=>e.versions.find((e=>e.isLast));function l(e,t){return[...e.versions].sort(((e,t)=>e.path===t.path?0:e.path.includes(t.path)?-1:t.path.includes(e.path)?1:0)).find((e=>!!(0,r.B6)(t,{path:e.path,exact:!1,strict:!1})))}function c(e,t){const n=l(e,t),o=n?.docs.find((e=>!!(0,r.B6)(t,{path:e.path,exact:!0,strict:!1})));return{activeVersion:n,activeDoc:o,alternateDocVersions:o?function(t){const n={};return e.versions.forEach((e=>{e.docs.forEach((r=>{r.id===t&&(n[e.name]=r)}))})),n}(o.id):{}}}const u={},d=()=>i("docusaurus-plugin-content-docs")??u,p=e=>{try{return function(e,t,n){void 0===t&&(t=a.W),void 0===n&&(n={});const r=i(e),o=r?.[t];if(!o&&n.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin with id "${t}".`);return o}("docusaurus-plugin-content-docs",e,{failfast:!0})}catch(t){throw new Error("You are using a feature of the Docusaurus docs plugin, but this plugin does not seem to be enabled"+("Default"===e?"":` (pluginId=${e}`),{cause:t})}};function f(e){void 0===e&&(e={});const t=d(),{pathname:n}=(0,r.zy)();return function(e,t,n){void 0===n&&(n={});const o=Object.entries(e).sort(((e,t)=>t[1].path.localeCompare(e[1].path))).find((e=>{let[,n]=e;return!!(0,r.B6)(t,{path:n.path,exact:!1,strict:!1})})),a=o?{pluginId:o[0],pluginData:o[1]}:void 0;if(!a&&n.failfast)throw new Error(`Can't find active docs plugin for "${t}" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: ${Object.values(e).map((e=>e.path)).join(", ")}`);return a}(t,n,e)}function m(e){void 0===e&&(e={});const t=f(e),{pathname:n}=(0,r.zy)();if(!t)return;return{activePlugin:t,activeVersion:l(t.pluginData,n)}}function h(e){return p(e).versions}function g(e){const t=p(e);return s(t)}function b(e){const t=p(e),{pathname:n}=(0,r.zy)();return c(t,n)}function y(e){const t=p(e),{pathname:n}=(0,r.zy)();return function(e,t){const n=s(e);return{latestDocSuggestion:c(e,t).alternateDocVersions[n.name],latestVersionSuggestion:n}}(t,n)}},6294:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>a});var r=n(5947),o=n.n(r);o().configure({showSpinner:!1});const a={onRouteUpdate(e){let{location:t,previousLocation:n}=e;if(n&&t.pathname!==n.pathname){const e=window.setTimeout((()=>{o().start()}),200);return()=>window.clearTimeout(e)}},onRouteDidUpdate(){o().done()}}},6134:(e,t,n)=>{"use strict";n.r(t);var r=n(1765),o=n(4784);!function(e){const{themeConfig:{prism:t}}=o.default,{additionalLanguages:r}=t;globalThis.Prism=e,r.forEach((e=>{"php"===e&&n(9700),n(4523)(`./prism-${e}`)})),delete globalThis.Prism}(r.My)},1107:(e,t,n)=>{"use strict";n.d(t,{A:()=>u});n(6540);var r=n(4164),o=n(1312),a=n(6342),i=n(8774),s=n(3427);const l={anchorWithStickyNavbar:"anchorWithStickyNavbar_LWe7",anchorWithHideOnScrollNavbar:"anchorWithHideOnScrollNavbar_WYt5"};var c=n(4848);function u(e){let{as:t,id:n,...u}=e;const d=(0,s.A)(),{navbar:{hideOnScroll:p}}=(0,a.p)();if("h1"===t||!n)return(0,c.jsx)(t,{...u,id:void 0});d.collectAnchor(n);const f=(0,o.T)({id:"theme.common.headingLinkTitle",message:"Direct link to {heading}",description:"Title for link to heading"},{heading:"string"==typeof u.children?u.children:n});return(0,c.jsxs)(t,{...u,className:(0,r.A)("anchor",p?l.anchorWithHideOnScrollNavbar:l.anchorWithStickyNavbar,u.className),id:n,children:[u.children,(0,c.jsx)(i.A,{className:"hash-link",to:`#${n}`,"aria-label":f,title:f,children:"\u200b"})]})}},3186:(e,t,n)=>{"use strict";n.d(t,{A:()=>a});n(6540);const r={iconExternalLink:"iconExternalLink_nPIU"};var o=n(4848);function a(e){let{width:t=13.5,height:n=13.5}=e;return(0,o.jsx)("svg",{width:t,height:n,"aria-hidden":"true",viewBox:"0 0 24 24",className:r.iconExternalLink,children:(0,o.jsx)("path",{fill:"currentColor",d:"M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"})})}},3277:(e,t,n)=>{"use strict";n.d(t,{A:()=>Ct});var r=n(6540),o=n(4164),a=n(7489),i=n(5500),s=n(6347),l=n(1312),c=n(5062),u=n(4848);const d="__docusaurus_skipToContent_fallback";function p(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function f(){const e=(0,r.useRef)(null),{action:t}=(0,s.W6)(),n=(0,r.useCallback)((e=>{e.preventDefault();const t=document.querySelector("main:first-of-type")??document.getElementById(d);t&&p(t)}),[]);return(0,c.$)((n=>{let{location:r}=n;e.current&&!r.hash&&"PUSH"===t&&p(e.current)})),{containerRef:e,onClick:n}}const m=(0,l.T)({id:"theme.common.skipToMainContent",description:"The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation",message:"Skip to main content"});function h(e){const t=e.children??m,{containerRef:n,onClick:r}=f();return(0,u.jsx)("div",{ref:n,role:"region","aria-label":m,children:(0,u.jsx)("a",{...e,href:`#${d}`,onClick:r,children:t})})}var g=n(7559),b=n(4090);const y={skipToContent:"skipToContent_fXgn"};function v(){return(0,u.jsx)(h,{className:y.skipToContent})}var w=n(6342),S=n(5041);function k(e){let{width:t=21,height:n=21,color:r="currentColor",strokeWidth:o=1.2,className:a,...i}=e;return(0,u.jsx)("svg",{viewBox:"0 0 15 15",width:t,height:n,...i,children:(0,u.jsx)("g",{stroke:r,strokeWidth:o,children:(0,u.jsx)("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})})})}const x={closeButton:"closeButton_CVFx"};function _(e){return(0,u.jsx)("button",{type:"button","aria-label":(0,l.T)({id:"theme.AnnouncementBar.closeButtonAriaLabel",message:"Close",description:"The ARIA label for close button of announcement bar"}),...e,className:(0,o.A)("clean-btn close",x.closeButton,e.className),children:(0,u.jsx)(k,{width:14,height:14,strokeWidth:3.1})})}const E={content:"content_knG7"};function C(e){const{announcementBar:t}=(0,w.p)(),{content:n}=t;return(0,u.jsx)("div",{...e,className:(0,o.A)(E.content,e.className),dangerouslySetInnerHTML:{__html:n}})}const O={announcementBar:"announcementBar_mb4j",announcementBarPlaceholder:"announcementBarPlaceholder_vyr4",announcementBarClose:"announcementBarClose_gvF7",announcementBarContent:"announcementBarContent_xLdY"};function P(){const{announcementBar:e}=(0,w.p)(),{isActive:t,close:n}=(0,S.M)();if(!t)return null;const{backgroundColor:r,textColor:o,isCloseable:a}=e;return(0,u.jsxs)("div",{className:O.announcementBar,style:{backgroundColor:r,color:o},role:"banner",children:[a&&(0,u.jsx)("div",{className:O.announcementBarPlaceholder}),(0,u.jsx)(C,{className:O.announcementBarContent}),a&&(0,u.jsx)(_,{onClick:n,className:O.announcementBarClose})]})}var T=n(2069),A=n(3104);var j=n(9532),R=n(5600);const I=r.createContext(null);function D(e){let{children:t}=e;const n=function(){const e=(0,T.M)(),t=(0,R.YL)(),[n,o]=(0,r.useState)(!1),a=null!==t.component,i=(0,j.ZC)(a);return(0,r.useEffect)((()=>{a&&!i&&o(!0)}),[a,i]),(0,r.useEffect)((()=>{a?e.shown||o(!0):o(!1)}),[e.shown,a]),(0,r.useMemo)((()=>[n,o]),[n])}();return(0,u.jsx)(I.Provider,{value:n,children:t})}function L(e){if(e.component){const t=e.component;return(0,u.jsx)(t,{...e.props})}}function N(){const e=(0,r.useContext)(I);if(!e)throw new j.dV("NavbarSecondaryMenuDisplayProvider");const[t,n]=e,o=(0,r.useCallback)((()=>n(!1)),[n]),a=(0,R.YL)();return(0,r.useMemo)((()=>({shown:t,hide:o,content:L(a)})),[o,a,t])}function M(e){let{header:t,primaryMenu:n,secondaryMenu:r}=e;const{shown:a}=N();return(0,u.jsxs)("div",{className:"navbar-sidebar",children:[t,(0,u.jsxs)("div",{className:(0,o.A)("navbar-sidebar__items",{"navbar-sidebar__items--show-secondary":a}),children:[(0,u.jsx)("div",{className:"navbar-sidebar__item menu",children:n}),(0,u.jsx)("div",{className:"navbar-sidebar__item menu",children:r})]})]})}var F=n(5293),B=n(2303);function z(e){return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,u.jsx)("path",{fill:"currentColor",d:"M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"})})}function U(e){return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,u.jsx)("path",{fill:"currentColor",d:"M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"})})}const $={toggle:"toggle_vylO",toggleButton:"toggleButton_gllP",darkToggleIcon:"darkToggleIcon_wfgR",lightToggleIcon:"lightToggleIcon_pyhR",toggleButtonDisabled:"toggleButtonDisabled_aARS"};function q(e){let{className:t,buttonClassName:n,value:r,onChange:a}=e;const i=(0,B.A)(),s=(0,l.T)({message:"Switch between dark and light mode (currently {mode})",id:"theme.colorToggle.ariaLabel",description:"The ARIA label for the navbar color mode toggle"},{mode:"dark"===r?(0,l.T)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"}):(0,l.T)({message:"light mode",id:"theme.colorToggle.ariaLabel.mode.light",description:"The name for the light color mode"})});return(0,u.jsx)("div",{className:(0,o.A)($.toggle,t),children:(0,u.jsxs)("button",{className:(0,o.A)("clean-btn",$.toggleButton,!i&&$.toggleButtonDisabled,n),type:"button",onClick:()=>a("dark"===r?"light":"dark"),disabled:!i,title:s,"aria-label":s,"aria-live":"polite",children:[(0,u.jsx)(z,{className:(0,o.A)($.toggleIcon,$.lightToggleIcon)}),(0,u.jsx)(U,{className:(0,o.A)($.toggleIcon,$.darkToggleIcon)})]})})}const H=r.memo(q),G={darkNavbarColorModeToggle:"darkNavbarColorModeToggle_X3D1"};function V(e){let{className:t}=e;const n=(0,w.p)().navbar.style,r=(0,w.p)().colorMode.disableSwitch,{colorMode:o,setColorMode:a}=(0,F.G)();return r?null:(0,u.jsx)(H,{className:t,buttonClassName:"dark"===n?G.darkNavbarColorModeToggle:void 0,value:o,onChange:a})}var W=n(3465);function K(){return(0,u.jsx)(W.A,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function Q(){const e=(0,T.M)();return(0,u.jsx)("button",{type:"button","aria-label":(0,l.T)({id:"theme.docs.sidebar.closeSidebarButtonAriaLabel",message:"Close navigation bar",description:"The ARIA label for close button of mobile sidebar"}),className:"clean-btn navbar-sidebar__close",onClick:()=>e.toggle(),children:(0,u.jsx)(k,{color:"var(--ifm-color-emphasis-600)"})})}function Y(){return(0,u.jsxs)("div",{className:"navbar-sidebar__brand",children:[(0,u.jsx)(K,{}),(0,u.jsx)(V,{className:"margin-right--md"}),(0,u.jsx)(Q,{})]})}var Z=n(8774),J=n(6025),X=n(6654),ee=n(1252),te=n(3186);function ne(e){let{activeBasePath:t,activeBaseRegex:n,to:r,href:o,label:a,html:i,isDropdownLink:s,prependBaseUrlToHref:l,...c}=e;const d=(0,J.Ay)(r),p=(0,J.Ay)(t),f=(0,J.Ay)(o,{forcePrependBaseUrl:!0}),m=a&&o&&!(0,X.A)(o),h=i?{dangerouslySetInnerHTML:{__html:i}}:{children:(0,u.jsxs)(u.Fragment,{children:[a,m&&(0,u.jsx)(te.A,{...s&&{width:12,height:12}})]})};return o?(0,u.jsx)(Z.A,{href:l?f:o,...c,...h}):(0,u.jsx)(Z.A,{to:d,isNavLink:!0,...(t||n)&&{isActive:(e,t)=>n?(0,ee.G)(n,t.pathname):t.pathname.startsWith(p)},...c,...h})}function re(e){let{className:t,isDropdownItem:n=!1,...r}=e;const a=(0,u.jsx)(ne,{className:(0,o.A)(n?"dropdown__link":"navbar__item navbar__link",t),isDropdownLink:n,...r});return n?(0,u.jsx)("li",{children:a}):a}function oe(e){let{className:t,isDropdownItem:n,...r}=e;return(0,u.jsx)("li",{className:"menu__list-item",children:(0,u.jsx)(ne,{className:(0,o.A)("menu__link",t),...r})})}function ae(e){let{mobile:t=!1,position:n,...r}=e;const o=t?oe:re;return(0,u.jsx)(o,{...r,activeClassName:r.activeClassName??(t?"menu__link--active":"navbar__link--active")})}var ie=n(1422),se=n(9169),le=n(4586);const ce={dropdownNavbarItemMobile:"dropdownNavbarItemMobile_S0Fm"};function ue(e,t){return e.some((e=>function(e,t){return!!(0,se.ys)(e.to,t)||!!(0,ee.G)(e.activeBaseRegex,t)||!(!e.activeBasePath||!t.startsWith(e.activeBasePath))}(e,t)))}function de(e){let{items:t,position:n,className:a,onClick:i,...s}=e;const l=(0,r.useRef)(null),[c,d]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{const e=e=>{l.current&&!l.current.contains(e.target)&&d(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),document.addEventListener("focusin",e),()=>{document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e),document.removeEventListener("focusin",e)}}),[l]),(0,u.jsxs)("div",{ref:l,className:(0,o.A)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===n,"dropdown--show":c}),children:[(0,u.jsx)(ne,{"aria-haspopup":"true","aria-expanded":c,role:"button",href:s.to?void 0:"#",className:(0,o.A)("navbar__link",a),...s,onClick:s.to?void 0:e=>e.preventDefault(),onKeyDown:e=>{"Enter"===e.key&&(e.preventDefault(),d(!c))},children:s.children??s.label}),(0,u.jsx)("ul",{className:"dropdown__menu",children:t.map(((e,t)=>(0,r.createElement)(Fe,{isDropdownItem:!0,activeClassName:"dropdown__link--active",...e,key:t})))})]})}function pe(e){let{items:t,className:n,position:a,onClick:i,...l}=e;const c=function(){const{siteConfig:{baseUrl:e}}=(0,le.A)(),{pathname:t}=(0,s.zy)();return t.replace(e,"/")}(),d=ue(t,c),{collapsed:p,toggleCollapsed:f,setCollapsed:m}=(0,ie.u)({initialState:()=>!d});return(0,r.useEffect)((()=>{d&&m(!d)}),[c,d,m]),(0,u.jsxs)("li",{className:(0,o.A)("menu__list-item",{"menu__list-item--collapsed":p}),children:[(0,u.jsx)(ne,{role:"button",className:(0,o.A)(ce.dropdownNavbarItemMobile,"menu__link menu__link--sublist menu__link--sublist-caret",n),...l,onClick:e=>{e.preventDefault(),f()},children:l.children??l.label}),(0,u.jsx)(ie.N,{lazy:!0,as:"ul",className:"menu__list",collapsed:p,children:t.map(((e,t)=>(0,r.createElement)(Fe,{mobile:!0,isDropdownItem:!0,onClick:i,activeClassName:"menu__link--active",...e,key:t})))})]})}function fe(e){let{mobile:t=!1,...n}=e;const r=t?pe:de;return(0,u.jsx)(r,{...n})}var me=n(2131);function he(e){let{width:t=20,height:n=20,...r}=e;return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:t,height:n,"aria-hidden":!0,...r,children:(0,u.jsx)("path",{fill:"currentColor",d:"M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"})})}const ge="iconLanguage_nlXk";var be=n(961),ye=n(3219),ve=n(5260),we=n(4255),Se=n(1062),ke=n(2967),xe=n(2565);function _e(){return[`language:${(0,le.A)().i18n.currentLocale}`,function(){const e=(0,xe.v)();return[ke.C,...e]}().map((e=>`docusaurus_tag:${e}`))]}const Ee={button:{buttonText:(0,l.T)({id:"theme.SearchBar.label",message:"Search",description:"The ARIA label and placeholder for search button"}),buttonAriaLabel:(0,l.T)({id:"theme.SearchBar.label",message:"Search",description:"The ARIA label and placeholder for search button"})},modal:{searchBox:{resetButtonTitle:(0,l.T)({id:"theme.SearchModal.searchBox.resetButtonTitle",message:"Clear the query",description:"The label and ARIA label for search box reset button"}),resetButtonAriaLabel:(0,l.T)({id:"theme.SearchModal.searchBox.resetButtonTitle",message:"Clear the query",description:"The label and ARIA label for search box reset button"}),cancelButtonText:(0,l.T)({id:"theme.SearchModal.searchBox.cancelButtonText",message:"Cancel",description:"The label and ARIA label for search box cancel button"}),cancelButtonAriaLabel:(0,l.T)({id:"theme.SearchModal.searchBox.cancelButtonText",message:"Cancel",description:"The label and ARIA label for search box cancel button"})},startScreen:{recentSearchesTitle:(0,l.T)({id:"theme.SearchModal.startScreen.recentSearchesTitle",message:"Recent",description:"The title for recent searches"}),noRecentSearchesText:(0,l.T)({id:"theme.SearchModal.startScreen.noRecentSearchesText",message:"No recent searches",description:"The text when no recent searches"}),saveRecentSearchButtonTitle:(0,l.T)({id:"theme.SearchModal.startScreen.saveRecentSearchButtonTitle",message:"Save this search",description:"The label for save recent search button"}),removeRecentSearchButtonTitle:(0,l.T)({id:"theme.SearchModal.startScreen.removeRecentSearchButtonTitle",message:"Remove this search from history",description:"The label for remove recent search button"}),favoriteSearchesTitle:(0,l.T)({id:"theme.SearchModal.startScreen.favoriteSearchesTitle",message:"Favorite",description:"The title for favorite searches"}),removeFavoriteSearchButtonTitle:(0,l.T)({id:"theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle",message:"Remove this search from favorites",description:"The label for remove favorite search button"})},errorScreen:{titleText:(0,l.T)({id:"theme.SearchModal.errorScreen.titleText",message:"Unable to fetch results",description:"The title for error screen of search modal"}),helpText:(0,l.T)({id:"theme.SearchModal.errorScreen.helpText",message:"You might want to check your network connection.",description:"The help text for error screen of search modal"})},footer:{selectText:(0,l.T)({id:"theme.SearchModal.footer.selectText",message:"to select",description:"The explanatory text of the action for the enter key"}),selectKeyAriaLabel:(0,l.T)({id:"theme.SearchModal.footer.selectKeyAriaLabel",message:"Enter key",description:"The ARIA label for the Enter key button that makes the selection"}),navigateText:(0,l.T)({id:"theme.SearchModal.footer.navigateText",message:"to navigate",description:"The explanatory text of the action for the Arrow up and Arrow down key"}),navigateUpKeyAriaLabel:(0,l.T)({id:"theme.SearchModal.footer.navigateUpKeyAriaLabel",message:"Arrow up",description:"The ARIA label for the Arrow up key button that makes the navigation"}),navigateDownKeyAriaLabel:(0,l.T)({id:"theme.SearchModal.footer.navigateDownKeyAriaLabel",message:"Arrow down",description:"The ARIA label for the Arrow down key button that makes the navigation"}),closeText:(0,l.T)({id:"theme.SearchModal.footer.closeText",message:"to close",description:"The explanatory text of the action for Escape key"}),closeKeyAriaLabel:(0,l.T)({id:"theme.SearchModal.footer.closeKeyAriaLabel",message:"Escape key",description:"The ARIA label for the Escape key button that close the modal"}),searchByText:(0,l.T)({id:"theme.SearchModal.footer.searchByText",message:"Search by",description:"The text explain that the search is making by Algolia"})},noResultsScreen:{noResultsText:(0,l.T)({id:"theme.SearchModal.noResultsScreen.noResultsText",message:"No results for",description:"The text explains that there are no results for the following search"}),suggestedQueryText:(0,l.T)({id:"theme.SearchModal.noResultsScreen.suggestedQueryText",message:"Try searching for",description:"The text for the suggested query when no results are found for the following search"}),reportMissingResultsText:(0,l.T)({id:"theme.SearchModal.noResultsScreen.reportMissingResultsText",message:"Believe this query should return results?",description:"The text for the question where the user thinks there are missing results"}),reportMissingResultsLinkText:(0,l.T)({id:"theme.SearchModal.noResultsScreen.reportMissingResultsLinkText",message:"Let us know.",description:"The text for the link to report missing results"})}},placeholder:(0,l.T)({id:"theme.SearchModal.placeholder",message:"Search docs",description:"The placeholder of the input of the DocSearch pop-up modal"})};let Ce=null;function Oe(e){let{hit:t,children:n}=e;return(0,u.jsx)(Z.A,{to:t.url,children:n})}function Pe(e){let{state:t,onClose:n}=e;const r=(0,we.w)();return(0,u.jsx)(Z.A,{to:r(t.query),onClick:n,children:(0,u.jsx)(l.A,{id:"theme.SearchBar.seeAll",values:{count:t.context.nbHits},children:"See all {count} results"})})}function Te(e){let{contextualSearch:t,externalUrlRegex:o,...a}=e;const{siteMetadata:i}=(0,le.A)(),l=(0,Se.C)(),c=_e(),d=a.searchParameters?.facetFilters??[],p=t?function(e,t){const n=e=>"string"==typeof e?[e]:e;return[...n(e),...n(t)]}(c,d):d,f={...a.searchParameters,facetFilters:p},m=(0,s.W6)(),h=(0,r.useRef)(null),g=(0,r.useRef)(null),[b,y]=(0,r.useState)(!1),[v,w]=(0,r.useState)(void 0),S=(0,r.useCallback)((()=>Ce?Promise.resolve():Promise.all([n.e(8158).then(n.bind(n,8158)),Promise.all([n.e(1869),n.e(8913)]).then(n.bind(n,8913)),Promise.all([n.e(1869),n.e(416)]).then(n.bind(n,416))]).then((e=>{let[{DocSearchModal:t}]=e;Ce=t}))),[]),k=(0,r.useCallback)((()=>{if(!h.current){const e=document.createElement("div");h.current=e,document.body.insertBefore(e,document.body.firstChild)}}),[]),x=(0,r.useCallback)((()=>{k(),S().then((()=>y(!0)))}),[S,k]),_=(0,r.useCallback)((()=>{y(!1),g.current?.focus()}),[]),E=(0,r.useCallback)((e=>{"f"===e.key&&(e.metaKey||e.ctrlKey)||(e.preventDefault(),w(e.key),x())}),[x]),C=(0,r.useRef)({navigate(e){let{itemUrl:t}=e;(0,ee.G)(o,t)?window.location.href=t:m.push(t)}}).current,O=(0,r.useRef)((e=>a.transformItems?a.transformItems(e):e.map((e=>({...e,url:l(e.url)}))))).current,P=(0,r.useMemo)((()=>e=>(0,u.jsx)(Pe,{...e,onClose:_})),[_]),T=(0,r.useCallback)((e=>(e.addAlgoliaAgent("docusaurus",i.docusaurusVersion),e)),[i.docusaurusVersion]);return(0,ye.E8)({isOpen:b,onOpen:x,onClose:_,onInput:E,searchButtonRef:g}),(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(ve.A,{children:(0,u.jsx)("link",{rel:"preconnect",href:`https://${a.appId}-dsn.algolia.net`,crossOrigin:"anonymous"})}),(0,u.jsx)(ye.Bc,{onTouchStart:S,onFocus:S,onMouseOver:S,onClick:x,ref:g,translations:Ee.button}),b&&Ce&&h.current&&(0,be.createPortal)((0,u.jsx)(Ce,{onClose:_,initialScrollY:window.scrollY,initialQuery:v,navigator:C,transformItems:O,hitComponent:Oe,transformSearchClient:T,...a.searchPagePath&&{resultsFooterComponent:P},...a,searchParameters:f,placeholder:Ee.placeholder,translations:Ee.modal}),h.current)]})}function Ae(){const{siteConfig:e}=(0,le.A)();return(0,u.jsx)(Te,{...e.themeConfig.algolia})}const je={navbarSearchContainer:"navbarSearchContainer_Bca1"};function Re(e){let{children:t,className:n}=e;return(0,u.jsx)("div",{className:(0,o.A)(n,je.navbarSearchContainer),children:t})}var Ie=n(4070),De=n(6972);var Le=n(3886);function Ne(e,t){return t.alternateDocVersions[e.name]??function(e){return e.docs.find((t=>t.id===e.mainDocId))}(e)}const Me={default:ae,localeDropdown:function(e){let{mobile:t,dropdownItemsBefore:n,dropdownItemsAfter:r,queryString:o="",...a}=e;const{i18n:{currentLocale:i,locales:c,localeConfigs:d}}=(0,le.A)(),p=(0,me.o)(),{search:f,hash:m}=(0,s.zy)(),h=[...n,...c.map((e=>{const n=`${`pathname://${p.createUrl({locale:e,fullyQualified:!1})}`}${f}${m}${o}`;return{label:d[e].label,lang:d[e].htmlLang,to:n,target:"_self",autoAddBaseUrl:!1,className:e===i?t?"menu__link--active":"dropdown__link--active":""}})),...r],g=t?(0,l.T)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):d[i].label;return(0,u.jsx)(fe,{...a,mobile:t,label:(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(he,{className:ge}),g]}),items:h})},search:function(e){let{mobile:t,className:n}=e;return t?null:(0,u.jsx)(Re,{className:n,children:(0,u.jsx)(Ae,{})})},dropdown:fe,html:function(e){let{value:t,className:n,mobile:r=!1,isDropdownItem:a=!1}=e;const i=a?"li":"div";return(0,u.jsx)(i,{className:(0,o.A)({navbar__item:!r&&!a,"menu__list-item":r},n),dangerouslySetInnerHTML:{__html:t}})},doc:function(e){let{docId:t,label:n,docsPluginId:r,...o}=e;const{activeDoc:a}=(0,Ie.zK)(r),i=(0,De.QB)(t,r),s=a?.path===i?.path;return null===i||i.unlisted&&!s?null:(0,u.jsx)(ae,{exact:!0,...o,isActive:()=>s||!!a?.sidebar&&a.sidebar===i.sidebar,label:n??i.id,to:i.path})},docSidebar:function(e){let{sidebarId:t,label:n,docsPluginId:r,...o}=e;const{activeDoc:a}=(0,Ie.zK)(r),i=(0,De.fW)(t,r).link;if(!i)throw new Error(`DocSidebarNavbarItem: Sidebar with ID "${t}" doesn't have anything to be linked to.`);return(0,u.jsx)(ae,{exact:!0,...o,isActive:()=>a?.sidebar===t,label:n??i.label,to:i.path})},docsVersion:function(e){let{label:t,to:n,docsPluginId:r,...o}=e;const a=(0,De.Vd)(r)[0],i=t??a.label,s=n??(e=>e.docs.find((t=>t.id===e.mainDocId)))(a).path;return(0,u.jsx)(ae,{...o,label:i,to:s})},docsVersionDropdown:function(e){let{mobile:t,docsPluginId:n,dropdownActiveClassDisabled:r,dropdownItemsBefore:o,dropdownItemsAfter:a,...i}=e;const{search:c,hash:d}=(0,s.zy)(),p=(0,Ie.zK)(n),f=(0,Ie.jh)(n),{savePreferredVersionName:m}=(0,Le.g1)(n),h=[...o,...f.map((function(e){const t=Ne(e,p);return{label:e.label,to:`${t.path}${c}${d}`,isActive:()=>e===p.activeVersion,onClick:()=>m(e.name)}})),...a],g=(0,De.Vd)(n)[0],b=t&&h.length>1?(0,l.T)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):g.label,y=t&&h.length>1?void 0:Ne(g,p).path;return h.length<=1?(0,u.jsx)(ae,{...i,mobile:t,label:b,to:y,isActive:r?()=>!1:void 0}):(0,u.jsx)(fe,{...i,mobile:t,label:b,to:y,items:h,isActive:r?()=>!1:void 0})},"custom-glnb":()=>(0,u.jsx)("a",{className:"navbar-lic-button",onClick:()=>{window.posthog&&window.posthog.capture("click_checkout")},href:"https://gum.co/BTMt?tier=1%20Restricted%20License",children:"Get License"})};function Fe(e){let{type:t,...n}=e;const r=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(t,n),o=Me[r];if(!o)throw new Error(`No NavbarItem component found for type "${t}".`);return(0,u.jsx)(o,{...n})}function Be(){const e=(0,T.M)(),t=(0,w.p)().navbar.items;return(0,u.jsx)("ul",{className:"menu__list",children:t.map(((t,n)=>(0,r.createElement)(Fe,{mobile:!0,...t,onClick:()=>e.toggle(),key:n})))})}function ze(e){return(0,u.jsx)("button",{...e,type:"button",className:"clean-btn navbar-sidebar__back",children:(0,u.jsx)(l.A,{id:"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel",description:"The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)",children:"\u2190 Back to main menu"})})}function Ue(){const e=0===(0,w.p)().navbar.items.length,t=N();return(0,u.jsxs)(u.Fragment,{children:[!e&&(0,u.jsx)(ze,{onClick:()=>t.hide()}),t.content]})}function $e(){const e=(0,T.M)();var t;return void 0===(t=e.shown)&&(t=!0),(0,r.useEffect)((()=>(document.body.style.overflow=t?"hidden":"visible",()=>{document.body.style.overflow="visible"})),[t]),e.shouldRender?(0,u.jsx)(M,{header:(0,u.jsx)(Y,{}),primaryMenu:(0,u.jsx)(Be,{}),secondaryMenu:(0,u.jsx)(Ue,{})}):null}const qe={navbarHideable:"navbarHideable_m1mJ",navbarHidden:"navbarHidden_jGov"};function He(e){return(0,u.jsx)("div",{role:"presentation",...e,className:(0,o.A)("navbar-sidebar__backdrop",e.className)})}function Ge(e){let{children:t}=e;const{navbar:{hideOnScroll:n,style:a}}=(0,w.p)(),i=(0,T.M)(),{navbarRef:s,isNavbarVisible:d}=function(e){const[t,n]=(0,r.useState)(e),o=(0,r.useRef)(!1),a=(0,r.useRef)(0),i=(0,r.useCallback)((e=>{null!==e&&(a.current=e.getBoundingClientRect().height)}),[]);return(0,A.Mq)(((t,r)=>{let{scrollY:i}=t;if(!e)return;if(i=s?n(!1):i+c{if(!e)return;const r=t.location.hash;if(r?document.getElementById(r.substring(1)):void 0)return o.current=!0,void n(!1);n(!0)})),{navbarRef:i,isNavbarVisible:t}}(n);return(0,u.jsxs)("nav",{ref:s,"aria-label":(0,l.T)({id:"theme.NavBar.navAriaLabel",message:"Main",description:"The ARIA label for the main navigation"}),className:(0,o.A)("navbar","navbar--fixed-top",n&&[qe.navbarHideable,!d&&qe.navbarHidden],{"navbar--dark":"dark"===a,"navbar--primary":"primary"===a,"navbar-sidebar--show":i.shown}),children:[t,(0,u.jsx)(He,{onClick:i.toggle}),(0,u.jsx)($e,{})]})}var Ve=n(440);const We={errorBoundaryError:"errorBoundaryError_a6uf",errorBoundaryFallback:"errorBoundaryFallback_VBag"};function Ke(e){return(0,u.jsx)("button",{type:"button",...e,children:(0,u.jsx)(l.A,{id:"theme.ErrorPageContent.tryAgain",description:"The label of the button to try again rendering when the React error boundary captures an error",children:"Try again"})})}function Qe(e){let{error:t}=e;const n=(0,Ve.rA)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,u.jsx)("p",{className:We.errorBoundaryError,children:n})}class Ye extends r.Component{componentDidCatch(e,t){throw this.props.onError(e,t)}render(){return this.props.children}}const Ze="right";function Je(e){let{width:t=30,height:n=30,className:r,...o}=e;return(0,u.jsx)("svg",{className:r,width:t,height:n,viewBox:"0 0 30 30","aria-hidden":"true",...o,children:(0,u.jsx)("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"})})}function Xe(){const{toggle:e,shown:t}=(0,T.M)();return(0,u.jsx)("button",{onClick:e,"aria-label":(0,l.T)({id:"theme.docs.sidebar.toggleSidebarButtonAriaLabel",message:"Toggle navigation bar",description:"The ARIA label for hamburger menu button of mobile navigation"}),"aria-expanded":t,className:"navbar__toggle clean-btn",type:"button",children:(0,u.jsx)(Je,{})})}const et={colorModeToggle:"colorModeToggle_DEke"};function tt(e){let{items:t}=e;return(0,u.jsx)(u.Fragment,{children:t.map(((e,t)=>(0,u.jsx)(Ye,{onError:t=>new Error(`A theme navbar item failed to render.\nPlease double-check the following navbar item (themeConfig.navbar.items) of your Docusaurus config:\n${JSON.stringify(e,null,2)}`,{cause:t}),children:(0,u.jsx)(Fe,{...e})},t)))})}function nt(e){let{left:t,right:n}=e;return(0,u.jsxs)("div",{className:"navbar__inner",children:[(0,u.jsx)("div",{className:"navbar__items",children:t}),(0,u.jsx)("div",{className:"navbar__items navbar__items--right",children:n})]})}function rt(){const e=(0,T.M)(),t=(0,w.p)().navbar.items,[n,r]=function(e){function t(e){return"left"===(e.position??Ze)}return[e.filter(t),e.filter((e=>!t(e)))]}(t),o=t.find((e=>"search"===e.type));return(0,u.jsx)(nt,{left:(0,u.jsxs)(u.Fragment,{children:[!e.disabled&&(0,u.jsx)(Xe,{}),(0,u.jsx)(K,{}),(0,u.jsx)(tt,{items:n})]}),right:(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(tt,{items:r}),(0,u.jsx)(V,{className:et.colorModeToggle}),!o&&(0,u.jsx)(Re,{children:(0,u.jsx)(Ae,{})})]})})}function ot(){return(0,u.jsx)(Ge,{children:(0,u.jsx)(rt,{})})}function at(e){let{item:t}=e;const{to:n,href:r,label:o,prependBaseUrlToHref:a,...i}=t,s=(0,J.Ay)(n),l=(0,J.Ay)(r,{forcePrependBaseUrl:!0});return(0,u.jsxs)(Z.A,{className:"footer__link-item",...r?{href:a?l:r}:{to:s},...i,children:[o,r&&!(0,X.A)(r)&&(0,u.jsx)(te.A,{})]})}function it(e){let{item:t}=e;return t.html?(0,u.jsx)("li",{className:"footer__item",dangerouslySetInnerHTML:{__html:t.html}}):(0,u.jsx)("li",{className:"footer__item",children:(0,u.jsx)(at,{item:t})},t.href??t.to)}function st(e){let{column:t}=e;return(0,u.jsxs)("div",{className:"col footer__col",children:[(0,u.jsx)("div",{className:"footer__title",children:t.title}),(0,u.jsx)("ul",{className:"footer__items clean-list",children:t.items.map(((e,t)=>(0,u.jsx)(it,{item:e},t)))})]})}function lt(e){let{columns:t}=e;return(0,u.jsx)("div",{className:"row footer__links",children:t.map(((e,t)=>(0,u.jsx)(st,{column:e},t)))})}function ct(){return(0,u.jsx)("span",{className:"footer__link-separator",children:"\xb7"})}function ut(e){let{item:t}=e;return t.html?(0,u.jsx)("span",{className:"footer__link-item",dangerouslySetInnerHTML:{__html:t.html}}):(0,u.jsx)(at,{item:t})}function dt(e){let{links:t}=e;return(0,u.jsx)("div",{className:"footer__links text--center",children:(0,u.jsx)("div",{className:"footer__links",children:t.map(((e,n)=>(0,u.jsxs)(r.Fragment,{children:[(0,u.jsx)(ut,{item:e}),t.length!==n+1&&(0,u.jsx)(ct,{})]},n)))})})}function pt(e){let{links:t}=e;return function(e){return"title"in e[0]}(t)?(0,u.jsx)(lt,{columns:t}):(0,u.jsx)(dt,{links:t})}var ft=n(1122);const mt={footerLogoLink:"footerLogoLink_BH7S"};function ht(e){let{logo:t}=e;const{withBaseUrl:n}=(0,J.hH)(),r={light:n(t.src),dark:n(t.srcDark??t.src)};return(0,u.jsx)(ft.A,{className:(0,o.A)("footer__logo",t.className),alt:t.alt,sources:r,width:t.width,height:t.height,style:t.style})}function gt(e){let{logo:t}=e;return t.href?(0,u.jsx)(Z.A,{href:t.href,className:mt.footerLogoLink,target:t.target,children:(0,u.jsx)(ht,{logo:t})}):(0,u.jsx)(ht,{logo:t})}function bt(e){let{copyright:t}=e;return(0,u.jsx)("div",{className:"footer__copyright",dangerouslySetInnerHTML:{__html:t}})}function yt(e){let{style:t,links:n,logo:r,copyright:a}=e;return(0,u.jsx)("footer",{className:(0,o.A)("footer",{"footer--dark":"dark"===t}),children:(0,u.jsxs)("div",{className:"container container-fluid",children:[n,(r||a)&&(0,u.jsxs)("div",{className:"footer__bottom text--center",children:[r&&(0,u.jsx)("div",{className:"margin-bottom--sm",children:r}),a]})]})})}function vt(){const{footer:e}=(0,w.p)();if(!e)return null;const{copyright:t,links:n,logo:r,style:o}=e;return(0,u.jsx)(yt,{style:o,links:n&&n.length>0&&(0,u.jsx)(pt,{links:n}),logo:r&&(0,u.jsx)(gt,{logo:r}),copyright:t&&(0,u.jsx)(bt,{copyright:t})})}const wt=r.memo(vt),St=(0,j.fM)([F.a,S.o,A.Tv,Le.VQ,i.Jx,function(e){let{children:t}=e;return(0,u.jsx)(R.y_,{children:(0,u.jsx)(T.e,{children:(0,u.jsx)(D,{children:t})})})}]);function kt(e){let{children:t}=e;return(0,u.jsx)(St,{children:t})}var xt=n(1107);function _t(e){let{error:t,tryAgain:n}=e;return(0,u.jsx)("main",{className:"container margin-vert--xl",children:(0,u.jsx)("div",{className:"row",children:(0,u.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,u.jsx)(xt.A,{as:"h1",className:"hero__title",children:(0,u.jsx)(l.A,{id:"theme.ErrorPageContent.title",description:"The title of the fallback page when the page crashed",children:"This page crashed."})}),(0,u.jsx)("div",{className:"margin-vert--lg",children:(0,u.jsx)(Ke,{onClick:n,className:"button button--primary shadow--lw"})}),(0,u.jsx)("hr",{}),(0,u.jsx)("div",{className:"margin-vert--md",children:(0,u.jsx)(Qe,{error:t})})]})})})}const Et={mainWrapper:"mainWrapper_z2l0"};function Ct(e){const{children:t,noFooter:n,wrapperClassName:r,title:s,description:l}=e;return(0,b.J)(),(0,u.jsxs)(kt,{children:[(0,u.jsx)(i.be,{title:s,description:l}),(0,u.jsx)(v,{}),(0,u.jsx)(P,{}),(0,u.jsx)(ot,{}),(0,u.jsx)("div",{id:d,className:(0,o.A)(g.G.wrapper.main,Et.mainWrapper,r),children:(0,u.jsx)(a.A,{fallback:e=>(0,u.jsx)(_t,{...e}),children:t})}),!n&&(0,u.jsx)(wt,{})]})}},3465:(e,t,n)=>{"use strict";n.d(t,{A:()=>u});n(6540);var r=n(8774),o=n(6025),a=n(4586),i=n(6342),s=n(1122),l=n(4848);function c(e){let{logo:t,alt:n,imageClassName:r}=e;const a={light:(0,o.Ay)(t.src),dark:(0,o.Ay)(t.srcDark||t.src)},i=(0,l.jsx)(s.A,{className:t.className,sources:a,height:t.height,width:t.width,alt:n,style:t.style});return r?(0,l.jsx)("div",{className:r,children:i}):i}function u(e){const{siteConfig:{title:t}}=(0,a.A)(),{navbar:{title:n,logo:s}}=(0,i.p)(),{imageClassName:u,titleClassName:d,...p}=e,f=(0,o.Ay)(s?.href||"/"),m=n?"":t,h=s?.alt??m;return(0,l.jsxs)(r.A,{to:f,...p,...s?.target&&{target:s.target},children:[s&&(0,l.jsx)(c,{logo:s,alt:h,imageClassName:u}),null!=n&&(0,l.jsx)("b",{className:d,children:n})]})}},1463:(e,t,n)=>{"use strict";n.d(t,{A:()=>a});n(6540);var r=n(5260),o=n(4848);function a(e){let{locale:t,version:n,tag:a}=e;const i=t;return(0,o.jsxs)(r.A,{children:[t&&(0,o.jsx)("meta",{name:"docusaurus_locale",content:t}),n&&(0,o.jsx)("meta",{name:"docusaurus_version",content:n}),a&&(0,o.jsx)("meta",{name:"docusaurus_tag",content:a}),i&&(0,o.jsx)("meta",{name:"docsearch:language",content:i}),n&&(0,o.jsx)("meta",{name:"docsearch:version",content:n}),a&&(0,o.jsx)("meta",{name:"docsearch:docusaurus_tag",content:a})]})}},1122:(e,t,n)=>{"use strict";n.d(t,{A:()=>u});var r=n(6540),o=n(4164),a=n(2303),i=n(5293);const s={themedComponent:"themedComponent_mlkZ","themedComponent--light":"themedComponent--light_NVdE","themedComponent--dark":"themedComponent--dark_xIcU"};var l=n(4848);function c(e){let{className:t,children:n}=e;const c=(0,a.A)(),{colorMode:u}=(0,i.G)();return(0,l.jsx)(l.Fragment,{children:(c?"dark"===u?["dark"]:["light"]:["light","dark"]).map((e=>{const a=n({theme:e,className:(0,o.A)(t,s.themedComponent,s[`themedComponent--${e}`])});return(0,l.jsx)(r.Fragment,{children:a},e)}))})}function u(e){const{sources:t,className:n,alt:r,...o}=e;return(0,l.jsx)(c,{className:n,children:e=>{let{theme:n,className:a}=e;return(0,l.jsx)("img",{src:t[n],alt:r,className:a,...o})}})}},1422:(e,t,n)=>{"use strict";n.d(t,{N:()=>b,u:()=>c});var r=n(6540),o=n(8193),a=n(205),i=n(3109),s=n(4848);const l="ease-in-out";function c(e){let{initialState:t}=e;const[n,o]=(0,r.useState)(t??!1),a=(0,r.useCallback)((()=>{o((e=>!e))}),[]);return{collapsed:n,setCollapsed:o,toggleCollapsed:a}}const u={display:"none",overflow:"hidden",height:"0px"},d={display:"block",overflow:"visible",height:"auto"};function p(e,t){const n=t?u:d;e.style.display=n.display,e.style.overflow=n.overflow,e.style.height=n.height}function f(e){let{collapsibleRef:t,collapsed:n,animation:o}=e;const a=(0,r.useRef)(!1);(0,r.useEffect)((()=>{const e=t.current;function r(){const t=e.scrollHeight,n=o?.duration??function(e){if((0,i.O)())return 1;const t=e/36;return Math.round(10*(4+15*t**.25+t/5))}(t);return{transition:`height ${n}ms ${o?.easing??l}`,height:`${t}px`}}function s(){const t=r();e.style.transition=t.transition,e.style.height=t.height}if(!a.current)return p(e,n),void(a.current=!0);return e.style.willChange="height",function(){const t=requestAnimationFrame((()=>{n?(s(),requestAnimationFrame((()=>{e.style.height=u.height,e.style.overflow=u.overflow}))):(e.style.display="block",requestAnimationFrame((()=>{s()})))}));return()=>cancelAnimationFrame(t)}()}),[t,n,o])}function m(e){if(!o.A.canUseDOM)return e?u:d}function h(e){let{as:t="div",collapsed:n,children:o,animation:a,onCollapseTransitionEnd:i,className:l,disableSSRStyle:c}=e;const u=(0,r.useRef)(null);return f({collapsibleRef:u,collapsed:n,animation:a}),(0,s.jsx)(t,{ref:u,style:c?void 0:m(n),onTransitionEnd:e=>{"height"===e.propertyName&&(p(u.current,n),i?.(n))},className:l,children:o})}function g(e){let{collapsed:t,...n}=e;const[o,i]=(0,r.useState)(!t),[l,c]=(0,r.useState)(t);return(0,a.A)((()=>{t||i(!0)}),[t]),(0,a.A)((()=>{o&&c(t)}),[o,t]),o?(0,s.jsx)(h,{...n,collapsed:l}):null}function b(e){let{lazy:t,...n}=e;const r=t?g:h;return(0,s.jsx)(r,{...n})}},5041:(e,t,n)=>{"use strict";n.d(t,{M:()=>h,o:()=>m});var r=n(6540),o=n(2303),a=n(679),i=n(9532),s=n(6342),l=n(4848);const c=(0,a.Wf)("docusaurus.announcement.dismiss"),u=(0,a.Wf)("docusaurus.announcement.id"),d=()=>"true"===c.get(),p=e=>c.set(String(e)),f=r.createContext(null);function m(e){let{children:t}=e;const n=function(){const{announcementBar:e}=(0,s.p)(),t=(0,o.A)(),[n,a]=(0,r.useState)((()=>!!t&&d()));(0,r.useEffect)((()=>{a(d())}),[]);const i=(0,r.useCallback)((()=>{p(!0),a(!0)}),[]);return(0,r.useEffect)((()=>{if(!e)return;const{id:t}=e;let n=u.get();"annoucement-bar"===n&&(n="announcement-bar");const r=t!==n;u.set(t),r&&p(!1),!r&&d()||a(!1)}),[e]),(0,r.useMemo)((()=>({isActive:!!e&&!n,close:i})),[e,n,i])}();return(0,l.jsx)(f.Provider,{value:n,children:t})}function h(){const e=(0,r.useContext)(f);if(!e)throw new i.dV("AnnouncementBarProvider");return e}},5293:(e,t,n)=>{"use strict";n.d(t,{G:()=>b,a:()=>g});var r=n(6540),o=n(8193),a=n(9532),i=n(679),s=n(6342),l=n(4848);const c=r.createContext(void 0),u="theme",d=(0,i.Wf)(u),p={light:"light",dark:"dark"},f=e=>e===p.dark?p.dark:p.light,m=e=>o.A.canUseDOM?f(document.documentElement.getAttribute("data-theme")):f(e),h=e=>{d.set(f(e))};function g(e){let{children:t}=e;const n=function(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:n}}=(0,s.p)(),[o,a]=(0,r.useState)(m(e));(0,r.useEffect)((()=>{t&&d.del()}),[t]);const i=(0,r.useCallback)((function(t,r){void 0===r&&(r={});const{persist:o=!0}=r;t?(a(t),o&&h(t)):(a(n?window.matchMedia("(prefers-color-scheme: dark)").matches?p.dark:p.light:e),d.del())}),[n,e]);(0,r.useEffect)((()=>{document.documentElement.setAttribute("data-theme",f(o))}),[o]),(0,r.useEffect)((()=>{if(t)return;const e=e=>{if(e.key!==u)return;const t=d.get();null!==t&&i(f(t))};return window.addEventListener("storage",e),()=>window.removeEventListener("storage",e)}),[t,i]);const l=(0,r.useRef)(!1);return(0,r.useEffect)((()=>{if(t&&!n)return;const e=window.matchMedia("(prefers-color-scheme: dark)"),r=()=>{window.matchMedia("print").matches||l.current?l.current=window.matchMedia("print").matches:i(null)};return e.addListener(r),()=>e.removeListener(r)}),[i,t,n]),(0,r.useMemo)((()=>({colorMode:o,setColorMode:i,get isDarkTheme(){return o===p.dark},setLightTheme(){i(p.light)},setDarkTheme(){i(p.dark)}})),[o,i])}();return(0,l.jsx)(c.Provider,{value:n,children:t})}function b(){const e=(0,r.useContext)(c);if(null==e)throw new a.dV("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},2069:(e,t,n)=>{"use strict";n.d(t,{M:()=>f,e:()=>p});var r=n(6540),o=n(5600),a=n(4581),i=n(7485),s=n(6342),l=n(9532),c=n(4848);const u=r.createContext(void 0);function d(){const e=function(){const e=(0,o.YL)(),{items:t}=(0,s.p)().navbar;return 0===t.length&&!e.component}(),t=(0,a.l)(),n=!e&&"mobile"===t,[l,c]=(0,r.useState)(!1);(0,i.$Z)((()=>{if(l)return c(!1),!1}));const u=(0,r.useCallback)((()=>{c((e=>!e))}),[]);return(0,r.useEffect)((()=>{"desktop"===t&&c(!1)}),[t]),(0,r.useMemo)((()=>({disabled:e,shouldRender:n,toggle:u,shown:l})),[e,n,u,l])}function p(e){let{children:t}=e;const n=d();return(0,c.jsx)(u.Provider,{value:n,children:t})}function f(){const e=r.useContext(u);if(void 0===e)throw new l.dV("NavbarMobileSidebarProvider");return e}},5600:(e,t,n)=>{"use strict";n.d(t,{GX:()=>c,YL:()=>l,y_:()=>s});var r=n(6540),o=n(9532),a=n(4848);const i=r.createContext(null);function s(e){let{children:t}=e;const n=(0,r.useState)({component:null,props:null});return(0,a.jsx)(i.Provider,{value:n,children:t})}function l(){const e=(0,r.useContext)(i);if(!e)throw new o.dV("NavbarSecondaryMenuContentProvider");return e[0]}function c(e){let{component:t,props:n}=e;const a=(0,r.useContext)(i);if(!a)throw new o.dV("NavbarSecondaryMenuContentProvider");const[,s]=a,l=(0,o.Be)(n);return(0,r.useEffect)((()=>{s({component:t,props:l})}),[s,t,l]),(0,r.useEffect)((()=>()=>s({component:null,props:null})),[s]),null}},4090:(e,t,n)=>{"use strict";n.d(t,{w:()=>o,J:()=>a});var r=n(6540);const o="navigation-with-keyboard";function a(){(0,r.useEffect)((()=>{function e(e){"keydown"===e.type&&"Tab"===e.key&&document.body.classList.add(o),"mousedown"===e.type&&document.body.classList.remove(o)}return document.addEventListener("keydown",e),document.addEventListener("mousedown",e),()=>{document.body.classList.remove(o),document.removeEventListener("keydown",e),document.removeEventListener("mousedown",e)}}),[])}},4255:(e,t,n)=>{"use strict";n.d(t,{b:()=>s,w:()=>l});var r=n(6540),o=n(4586),a=n(7485);const i="q";function s(){return(0,a.l)(i)}function l(){const{siteConfig:{baseUrl:e,themeConfig:t}}=(0,o.A)(),{algolia:{searchPagePath:n}}=t;return(0,r.useCallback)((t=>`${e}${n}?${i}=${encodeURIComponent(t)}`),[e,n])}},4581:(e,t,n)=>{"use strict";n.d(t,{l:()=>s});var r=n(6540),o=n(8193);const a={desktop:"desktop",mobile:"mobile",ssr:"ssr"},i=996;function s(e){let{desktopBreakpoint:t=i}=void 0===e?{}:e;const[n,s]=(0,r.useState)((()=>"ssr"));return(0,r.useEffect)((()=>{function e(){s(function(e){if(!o.A.canUseDOM)throw new Error("getWindowSize() should only be called after React hydration");return window.innerWidth>e?a.desktop:a.mobile}(t))}return e(),window.addEventListener("resize",e),()=>{window.removeEventListener("resize",e)}}),[t]),n}},7559:(e,t,n)=>{"use strict";n.d(t,{G:()=>r});const r={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",blogAuthorsListPage:"blog-authors-list-page",blogAuthorsPostsPage:"blog-authors-posts-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",unlistedBanner:"theme-unlisted-banner",draftBanner:"theme-draft-banner",admonitionType:e=>`theme-admonition-${e}`},layout:{},docs:{docVersionBanner:"theme-doc-version-banner",docVersionBadge:"theme-doc-version-badge",docBreadcrumbs:"theme-doc-breadcrumbs",docMarkdown:"theme-doc-markdown",docTocMobile:"theme-doc-toc-mobile",docTocDesktop:"theme-doc-toc-desktop",docFooter:"theme-doc-footer",docFooterTagsRow:"theme-doc-footer-tags-row",docFooterEditMetaRow:"theme-doc-footer-edit-meta-row",docSidebarContainer:"theme-doc-sidebar-container",docSidebarMenu:"theme-doc-sidebar-menu",docSidebarItemCategory:"theme-doc-sidebar-item-category",docSidebarItemLink:"theme-doc-sidebar-item-link",docSidebarItemCategoryLevel:e=>`theme-doc-sidebar-item-category-level-${e}`,docSidebarItemLinkLevel:e=>`theme-doc-sidebar-item-link-level-${e}`},blog:{blogFooterTagsRow:"theme-blog-footer-tags-row",blogFooterEditMetaRow:"theme-blog-footer-edit-meta-row"},pages:{pageFooterEditMetaRow:"theme-pages-footer-edit-meta-row"}}},3109:(e,t,n)=>{"use strict";function r(){return window.matchMedia("(prefers-reduced-motion: reduce)").matches}n.d(t,{O:()=>r})},481:(e,t,n)=>{"use strict";n.d(t,{s:()=>o});var r=n(4586);function o(e){const{siteConfig:t}=(0,r.A)(),{title:n,titleDelimiter:o}=t;return e?.trim().length?`${e.trim()} ${o} ${n}`:n}},7485:(e,t,n)=>{"use strict";n.d(t,{$Z:()=>i,aZ:()=>l,l:()=>c});var r=n(6540),o=n(6347),a=n(9532);function i(e){!function(e){const t=(0,o.W6)(),n=(0,a._q)(e);(0,r.useEffect)((()=>t.block(((e,t)=>n(e,t)))),[t,n])}(((t,n)=>{if("POP"===n)return e(t,n)}))}function s(e){const t=(0,o.W6)();return(0,r.useSyncExternalStore)(t.listen,(()=>e(t)),(()=>e(t)))}function l(e){return s((t=>null===e?null:new URLSearchParams(t.location.search).get(e)))}function c(e){const t=l(e)??"",n=function(e){const t=(0,o.W6)();return(0,r.useCallback)(((n,r)=>{const o=new URLSearchParams(t.location.search);n?o.set(e,n):o.delete(e),(r?.push?t.push:t.replace)({search:o.toString()})}),[e,t])}(e);return[t,n]}},1682:(e,t,n)=>{"use strict";function r(e,t){return void 0===t&&(t=(e,t)=>e===t),e.filter(((n,r)=>e.findIndex((e=>t(e,n)))!==r))}function o(e){return Array.from(new Set(e))}function a(e,t){const n={};let r=0;for(const o of e){const e=t(o,r);n[e]??=[],n[e].push(o),r+=1}return n}n.d(t,{$z:()=>a,XI:()=>r,sb:()=>o})},5500:(e,t,n)=>{"use strict";n.d(t,{Jx:()=>f,be:()=>u,e3:()=>p});var r=n(6540),o=n(4164),a=n(5260),i=n(6803),s=n(6025),l=n(481),c=n(4848);function u(e){let{title:t,description:n,keywords:r,image:o,children:i}=e;const u=(0,l.s)(t),{withBaseUrl:d}=(0,s.hH)(),p=o?d(o,{absolute:!0}):void 0;return(0,c.jsxs)(a.A,{children:[t&&(0,c.jsx)("title",{children:u}),t&&(0,c.jsx)("meta",{property:"og:title",content:u}),n&&(0,c.jsx)("meta",{name:"description",content:n}),n&&(0,c.jsx)("meta",{property:"og:description",content:n}),r&&(0,c.jsx)("meta",{name:"keywords",content:Array.isArray(r)?r.join(","):r}),p&&(0,c.jsx)("meta",{property:"og:image",content:p}),p&&(0,c.jsx)("meta",{name:"twitter:image",content:p}),i]})}const d=r.createContext(void 0);function p(e){let{className:t,children:n}=e;const i=r.useContext(d),s=(0,o.A)(i,t);return(0,c.jsxs)(d.Provider,{value:s,children:[(0,c.jsx)(a.A,{children:(0,c.jsx)("html",{className:s})}),n]})}function f(e){let{children:t}=e;const n=(0,i.A)(),r=`plugin-${n.plugin.name.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi,"")}`;const a=`plugin-id-${n.plugin.id}`;return(0,c.jsx)(p,{className:(0,o.A)(r,a),children:t})}},9532:(e,t,n)=>{"use strict";n.d(t,{Be:()=>c,ZC:()=>s,_q:()=>i,dV:()=>l,fM:()=>u});var r=n(6540),o=n(205),a=n(4848);function i(e){const t=(0,r.useRef)(e);return(0,o.A)((()=>{t.current=e}),[e]),(0,r.useCallback)((function(){return t.current(...arguments)}),[])}function s(e){const t=(0,r.useRef)();return(0,o.A)((()=>{t.current=e})),t.current}class l extends Error{constructor(e,t){super(),this.name="ReactContextError",this.message=`Hook ${this.stack?.split("\n")[1]?.match(/at (?:\w+\.)?(?\w+)/)?.groups.name??""} is called outside the <${e}>. ${t??""}`}}function c(e){const t=Object.entries(e);return t.sort(((e,t)=>e[0].localeCompare(t[0]))),(0,r.useMemo)((()=>e),t.flat())}function u(e){return t=>{let{children:n}=t;return(0,a.jsx)(a.Fragment,{children:e.reduceRight(((e,t)=>(0,a.jsx)(t,{children:e})),n)})}}},1252:(e,t,n)=>{"use strict";function r(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}n.d(t,{G:()=>r})},9169:(e,t,n)=>{"use strict";n.d(t,{Dt:()=>s,ys:()=>i});var r=n(6540),o=n(8328),a=n(4586);function i(e,t){const n=e=>(!e||e.endsWith("/")?e:`${e}/`)?.toLowerCase();return n(e)===n(t)}function s(){const{baseUrl:e}=(0,a.A)().siteConfig;return(0,r.useMemo)((()=>function(e){let{baseUrl:t,routes:n}=e;function r(e){return e.path===t&&!0===e.exact}function o(e){return e.path===t&&!e.exact}return function e(t){if(0===t.length)return;return t.find(r)||e(t.filter(o).flatMap((e=>e.routes??[])))}(n)}({routes:o.A,baseUrl:e})),[e])}},3104:(e,t,n)=>{"use strict";n.d(t,{Mq:()=>f,Tv:()=>u,a_:()=>m,gk:()=>h});var r=n(6540),o=n(8193),a=n(2303),i=n(205),s=n(9532),l=n(4848);const c=r.createContext(void 0);function u(e){let{children:t}=e;const n=function(){const e=(0,r.useRef)(!0);return(0,r.useMemo)((()=>({scrollEventsEnabledRef:e,enableScrollEvents:()=>{e.current=!0},disableScrollEvents:()=>{e.current=!1}})),[])}();return(0,l.jsx)(c.Provider,{value:n,children:t})}function d(){const e=(0,r.useContext)(c);if(null==e)throw new s.dV("ScrollControllerProvider");return e}const p=()=>o.A.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null;function f(e,t){void 0===t&&(t=[]);const{scrollEventsEnabledRef:n}=d(),o=(0,r.useRef)(p()),a=(0,s._q)(e);(0,r.useEffect)((()=>{const e=()=>{if(!n.current)return;const e=p();a(e,o.current),o.current=e},t={passive:!0};return e(),window.addEventListener("scroll",e,t),()=>window.removeEventListener("scroll",e,t)}),[a,n,...t])}function m(){const e=d(),t=function(){const e=(0,r.useRef)({elem:null,top:0}),t=(0,r.useCallback)((t=>{e.current={elem:t,top:t.getBoundingClientRect().top}}),[]),n=(0,r.useCallback)((()=>{const{current:{elem:t,top:n}}=e;if(!t)return{restored:!1};const r=t.getBoundingClientRect().top-n;return r&&window.scrollBy({left:0,top:r}),e.current={elem:null,top:0},{restored:0!==r}}),[]);return(0,r.useMemo)((()=>({save:t,restore:n})),[n,t])}(),n=(0,r.useRef)(void 0),o=(0,r.useCallback)((r=>{t.save(r),e.disableScrollEvents(),n.current=()=>{const{restored:r}=t.restore();if(n.current=void 0,r){const t=()=>{e.enableScrollEvents(),window.removeEventListener("scroll",t)};window.addEventListener("scroll",t)}else e.enableScrollEvents()}}),[e,t]);return(0,i.A)((()=>{queueMicrotask((()=>n.current?.()))})),{blockElementScrollPositionUntilNextRender:o}}function h(){const e=(0,r.useRef)(null),t=(0,a.A)()&&"smooth"===getComputedStyle(document.documentElement).scrollBehavior;return{startScroll:n=>{e.current=t?function(e){return window.scrollTo({top:e,behavior:"smooth"}),()=>{}}(n):function(e){let t=null;const n=document.documentElement.scrollTop>e;return function r(){const o=document.documentElement.scrollTop;(n&&o>e||!n&&ot&&cancelAnimationFrame(t)}(n)},cancelScroll:()=>e.current?.()}}},2967:(e,t,n)=>{"use strict";n.d(t,{C:()=>r});const r="default"},679:(e,t,n)=>{"use strict";n.d(t,{Wf:()=>u,Dv:()=>d});var r=n(6540);const o=JSON.parse('{"N":"localStorage","M":""}'),a=o.N;function i(e){let{key:t,oldValue:n,newValue:r,storage:o}=e;if(n===r)return;const a=document.createEvent("StorageEvent");a.initStorageEvent("storage",!1,!1,t,n,r,window.location.href,o),window.dispatchEvent(a)}function s(e){if(void 0===e&&(e=a),"undefined"==typeof window)throw new Error("Browser storage is not available on Node.js/Docusaurus SSR process.");if("none"===e)return null;try{return window[e]}catch(n){return t=n,l||(console.warn("Docusaurus browser storage is not available.\nPossible reasons: running Docusaurus in an iframe, in an incognito browser session, or using too strict browser privacy settings.",t),l=!0),null}var t}let l=!1;const c={get:()=>null,set:()=>{},del:()=>{},listen:()=>()=>{}};function u(e,t){const n=`${e}${o.M}`;if("undefined"==typeof window)return function(e){function t(){throw new Error(`Illegal storage API usage for storage key "${e}".\nDocusaurus storage APIs are not supposed to be called on the server-rendering process.\nPlease only call storage APIs in effects and event handlers.`)}return{get:t,set:t,del:t,listen:t}}(n);const r=s(t?.persistence);return null===r?c:{get:()=>{try{return r.getItem(n)}catch(e){return console.error(`Docusaurus storage error, can't get key=${n}`,e),null}},set:e=>{try{const t=r.getItem(n);r.setItem(n,e),i({key:n,oldValue:t,newValue:e,storage:r})}catch(t){console.error(`Docusaurus storage error, can't set ${n}=${e}`,t)}},del:()=>{try{const e=r.getItem(n);r.removeItem(n),i({key:n,oldValue:e,newValue:null,storage:r})}catch(e){console.error(`Docusaurus storage error, can't delete key=${n}`,e)}},listen:e=>{try{const t=t=>{t.storageArea===r&&t.key===n&&e(t)};return window.addEventListener("storage",t),()=>window.removeEventListener("storage",t)}catch(t){return console.error(`Docusaurus storage error, can't listen for changes of key=${n}`,t),()=>{}}}}}function d(e,t){const n=(0,r.useRef)((()=>null===e?c:u(e,t))).current(),o=(0,r.useCallback)((e=>"undefined"==typeof window?()=>{}:n.listen(e)),[n]);return[(0,r.useSyncExternalStore)(o,(()=>"undefined"==typeof window?null:n.get()),(()=>null)),n]}},2131:(e,t,n)=>{"use strict";n.d(t,{o:()=>i});var r=n(4586),o=n(6347),a=n(440);function i(){const{siteConfig:{baseUrl:e,url:t,trailingSlash:n},i18n:{defaultLocale:i,currentLocale:s}}=(0,r.A)(),{pathname:l}=(0,o.zy)(),c=(0,a.Ks)(l,{trailingSlash:n,baseUrl:e}),u=s===i?e:e.replace(`/${s}/`,"/"),d=c.replace(e,"");return{createUrl:function(e){let{locale:n,fullyQualified:r}=e;return`${r?t:""}${function(e){return e===i?`${u}`:`${u}${e}/`}(n)}${d}`}}}},5062:(e,t,n)=>{"use strict";n.d(t,{$:()=>i});var r=n(6540),o=n(6347),a=n(9532);function i(e){const t=(0,o.zy)(),n=(0,a.ZC)(t),i=(0,a._q)(e);(0,r.useEffect)((()=>{n&&t!==n&&i({location:t,previousLocation:n})}),[i,t,n])}},6342:(e,t,n)=>{"use strict";n.d(t,{p:()=>o});var r=n(4586);function o(){return(0,r.A)().siteConfig.themeConfig}},8126:(e,t,n)=>{"use strict";n.d(t,{c:()=>o});var r=n(4586);function o(){const{siteConfig:{themeConfig:e}}=(0,r.A)();return e}},1062:(e,t,n)=>{"use strict";n.d(t,{C:()=>s});var r=n(6540),o=n(1252),a=n(6025),i=n(8126);function s(){const{withBaseUrl:e}=(0,a.hH)(),{algolia:{externalUrlRegex:t,replaceSearchResultPathname:n}}=(0,i.c)();return(0,r.useCallback)((r=>{const a=new URL(r);if((0,o.G)(t,a.href))return r;const i=`${a.pathname+a.hash}`;return e(function(e,t){return t?e.replaceAll(new RegExp(t.from,"g"),t.to):e}(i,n))}),[e,t,n])}},2983:(e,t,n)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.addTrailingSlash=o,t.default=function(e,t){const{trailingSlash:n,baseUrl:r}=t;if(e.startsWith("#"))return e;if(void 0===n)return e;const[i]=e.split(/[#?]/),s="/"===i||i===r?i:(l=i,c=n,c?o(l):a(l));var l,c;return e.replace(i,s)},t.addLeadingSlash=function(e){return(0,r.addPrefix)(e,"/")},t.removeTrailingSlash=a;const r=n(2566);function o(e){return e.endsWith("/")?e:`${e}/`}function a(e){return(0,r.removeSuffix)(e,"/")}},253:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=function e(t){if(t.cause)return[t,...e(t.cause)];return[t]}},440:(e,t,n)=>{"use strict";t.rA=t.Ks=t.LU=void 0;const r=n(1635);t.LU="__blog-post-container";var o=n(2983);Object.defineProperty(t,"Ks",{enumerable:!0,get:function(){return r.__importDefault(o).default}});var a=n(2566);var i=n(253);Object.defineProperty(t,"rA",{enumerable:!0,get:function(){return i.getErrorCausalChain}})},2566:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.addPrefix=function(e,t){return e.startsWith(t)?e:`${t}${e}`},t.removeSuffix=function(e,t){if(""===t)return e;return e.endsWith(t)?e.slice(0,-t.length):e},t.addSuffix=function(e,t){return e.endsWith(t)?e:`${e}${t}`},t.removePrefix=function(e,t){return e.startsWith(t)?e.slice(t.length):e}},9530:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>r});const r=n(8193).A.canUseDOM?{onRouteUpdate(){window.posthog.capture("$pageview")}}:null},1513:(e,t,n)=>{"use strict";n.d(t,{zR:()=>w,TM:()=>C,yJ:()=>f,sC:()=>P,AO:()=>p});var r=n(8168);function o(e){return"/"===e.charAt(0)}function a(e,t){for(var n=t,r=n+1,o=e.length;r=0;p--){var f=i[p];"."===f?a(i,p):".."===f?(a(i,p),d++):d&&(a(i,p),d--)}if(!c)for(;d--;d)i.unshift("..");!c||""===i[0]||i[0]&&o(i[0])||i.unshift("");var m=i.join("/");return n&&"/"!==m.substr(-1)&&(m+="/"),m};var s=n(1561);function l(e){return"/"===e.charAt(0)?e:"/"+e}function c(e){return"/"===e.charAt(0)?e.substr(1):e}function u(e,t){return function(e,t){return 0===e.toLowerCase().indexOf(t.toLowerCase())&&-1!=="/?#".indexOf(e.charAt(t.length))}(e,t)?e.substr(t.length):e}function d(e){return"/"===e.charAt(e.length-1)?e.slice(0,-1):e}function p(e){var t=e.pathname,n=e.search,r=e.hash,o=t||"/";return n&&"?"!==n&&(o+="?"===n.charAt(0)?n:"?"+n),r&&"#"!==r&&(o+="#"===r.charAt(0)?r:"#"+r),o}function f(e,t,n,o){var a;"string"==typeof e?(a=function(e){var t=e||"/",n="",r="",o=t.indexOf("#");-1!==o&&(r=t.substr(o),t=t.substr(0,o));var a=t.indexOf("?");return-1!==a&&(n=t.substr(a),t=t.substr(0,a)),{pathname:t,search:"?"===n?"":n,hash:"#"===r?"":r}}(e),a.state=t):(void 0===(a=(0,r.A)({},e)).pathname&&(a.pathname=""),a.search?"?"!==a.search.charAt(0)&&(a.search="?"+a.search):a.search="",a.hash?"#"!==a.hash.charAt(0)&&(a.hash="#"+a.hash):a.hash="",void 0!==t&&void 0===a.state&&(a.state=t));try{a.pathname=decodeURI(a.pathname)}catch(s){throw s instanceof URIError?new URIError('Pathname "'+a.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):s}return n&&(a.key=n),o?a.pathname?"/"!==a.pathname.charAt(0)&&(a.pathname=i(a.pathname,o.pathname)):a.pathname=o.pathname:a.pathname||(a.pathname="/"),a}function m(){var e=null;var t=[];return{setPrompt:function(t){return e=t,function(){e===t&&(e=null)}},confirmTransitionTo:function(t,n,r,o){if(null!=e){var a="function"==typeof e?e(t,n):e;"string"==typeof a?"function"==typeof r?r(a,o):o(!0):o(!1!==a)}else o(!0)},appendListener:function(e){var n=!0;function r(){n&&e.apply(void 0,arguments)}return t.push(r),function(){n=!1,t=t.filter((function(e){return e!==r}))}},notifyListeners:function(){for(var e=arguments.length,n=new Array(e),r=0;rt?n.splice(t,n.length-t,o):n.push(o),d({action:r,location:o,index:t,entries:n})}}))},replace:function(e,t){var r="REPLACE",o=f(e,t,h(),w.location);u.confirmTransitionTo(o,r,n,(function(e){e&&(w.entries[w.index]=o,d({action:r,location:o}))}))},go:v,goBack:function(){v(-1)},goForward:function(){v(1)},canGo:function(e){var t=w.index+e;return t>=0&&t{"use strict";var r=n(4363),o={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},a={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},i={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},s={};function l(e){return r.isMemo(e)?i:s[e.$$typeof]||o}s[r.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},s[r.Memo]=i;var c=Object.defineProperty,u=Object.getOwnPropertyNames,d=Object.getOwnPropertySymbols,p=Object.getOwnPropertyDescriptor,f=Object.getPrototypeOf,m=Object.prototype;e.exports=function e(t,n,r){if("string"!=typeof n){if(m){var o=f(n);o&&o!==m&&e(t,o,r)}var i=u(n);d&&(i=i.concat(d(n)));for(var s=l(t),h=l(n),g=0;g{"use strict";e.exports=function(e,t,n,r,o,a,i,s){if(!e){var l;if(void 0===t)l=new Error("Minified exception occurred; use the non-minified dev environment for the full error message and additional helpful warnings.");else{var c=[n,r,o,a,i,s],u=0;(l=new Error(t.replace(/%s/g,(function(){return c[u++]})))).name="Invariant Violation"}throw l.framesToPop=1,l}}},4634:e=>{e.exports=Array.isArray||function(e){return"[object Array]"==Object.prototype.toString.call(e)}},119:(e,t,n)=>{"use strict";n.r(t)},1043:(e,t,n)=>{"use strict";n.r(t)},5947:function(e,t,n){var r,o;r=function(){var e,t,n={version:"0.2.0"},r=n.settings={minimum:.08,easing:"ease",positionUsing:"",speed:200,trickle:!0,trickleRate:.02,trickleSpeed:800,showSpinner:!0,barSelector:'[role="bar"]',spinnerSelector:'[role="spinner"]',parent:"body",template:'
'};function o(e,t,n){return en?n:e}function a(e){return 100*(-1+e)}function i(e,t,n){var o;return(o="translate3d"===r.positionUsing?{transform:"translate3d("+a(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+a(e)+"%,0)"}:{"margin-left":a(e)+"%"}).transition="all "+t+"ms "+n,o}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=o(e,r.minimum,1),n.status=1===e?null:e;var a=n.render(!t),c=a.querySelector(r.barSelector),u=r.speed,d=r.easing;return a.offsetWidth,s((function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),l(c,i(e,u,d)),1===e?(l(a,{transition:"none",opacity:1}),a.offsetWidth,setTimeout((function(){l(a,{transition:"all "+u+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),u)}),u)):setTimeout(t,u)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout((function(){n.status&&(n.trickle(),e())}),r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*o(Math.random()*t,.1,.95)),t=o(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always((function(){0==--t?(e=0,n.done()):n.set((e-t)/e)})),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var o,i=t.querySelector(r.barSelector),s=e?"-100":a(n.status||0),c=document.querySelector(r.parent);return l(i,{transition:"all 0 linear",transform:"translate3d("+s+"%,0,0)"}),r.showSpinner||(o=t.querySelector(r.spinnerSelector))&&f(o),c!=document.body&&u(c,"nprogress-custom-parent"),c.appendChild(t),t},n.remove=function(){d(document.documentElement,"nprogress-busy"),d(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&f(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var s=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),l=function(){var e=["Webkit","O","Moz","ms"],t={};function n(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()}))}function r(t){var n=document.body.style;if(t in n)return t;for(var r,o=e.length,a=t.charAt(0).toUpperCase()+t.slice(1);o--;)if((r=e[o]+a)in n)return r;return t}function o(e){return e=n(e),t[e]||(t[e]=r(e))}function a(e,t,n){t=o(t),e.style[t]=n}return function(e,t){var n,r,o=arguments;if(2==o.length)for(n in t)void 0!==(r=t[n])&&t.hasOwnProperty(n)&&a(e,n,r);else a(e,o[1],o[2])}}();function c(e,t){return("string"==typeof e?e:p(e)).indexOf(" "+t+" ")>=0}function u(e,t){var n=p(e),r=n+t;c(n,t)||(e.className=r.substring(1))}function d(e,t){var n,r=p(e);c(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function p(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function f(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n},void 0===(o="function"==typeof r?r.call(t,n,t,e):r)||(e.exports=o)},5302:(e,t,n)=>{var r=n(4634);e.exports=f,e.exports.parse=a,e.exports.compile=function(e,t){return s(a(e,t),t)},e.exports.tokensToFunction=s,e.exports.tokensToRegExp=p;var o=new RegExp(["(\\\\.)","([\\/.])?(?:(?:\\:(\\w+)(?:\\(((?:\\\\.|[^\\\\()])+)\\))?|\\(((?:\\\\.|[^\\\\()])+)\\))([+*?])?|(\\*))"].join("|"),"g");function a(e,t){for(var n,r=[],a=0,i=0,s="",u=t&&t.delimiter||"/";null!=(n=o.exec(e));){var d=n[0],p=n[1],f=n.index;if(s+=e.slice(i,f),i=f+d.length,p)s+=p[1];else{var m=e[i],h=n[2],g=n[3],b=n[4],y=n[5],v=n[6],w=n[7];s&&(r.push(s),s="");var S=null!=h&&null!=m&&m!==h,k="+"===v||"*"===v,x="?"===v||"*"===v,_=n[2]||u,E=b||y;r.push({name:g||a++,prefix:h||"",delimiter:_,optional:x,repeat:k,partial:S,asterisk:!!w,pattern:E?c(E):w?".*":"[^"+l(_)+"]+?"})}}return i{e.exports&&(e.exports={core:{meta:{path:"components/prism-core.js",option:"mandatory"},core:"Core"},themes:{meta:{path:"themes/{id}.css",link:"index.html?theme={id}",exclusive:!0},prism:{title:"Default",option:"default"},"prism-dark":"Dark","prism-funky":"Funky","prism-okaidia":{title:"Okaidia",owner:"ocodia"},"prism-twilight":{title:"Twilight",owner:"remybach"},"prism-coy":{title:"Coy",owner:"tshedor"},"prism-solarizedlight":{title:"Solarized Light",owner:"hectormatos2011 "},"prism-tomorrow":{title:"Tomorrow Night",owner:"Rosey"}},languages:{meta:{path:"components/prism-{id}",noCSS:!0,examplesPath:"examples/prism-{id}",addCheckAll:!0},markup:{title:"Markup",alias:["html","xml","svg","mathml","ssml","atom","rss"],aliasTitles:{html:"HTML",xml:"XML",svg:"SVG",mathml:"MathML",ssml:"SSML",atom:"Atom",rss:"RSS"},option:"default"},css:{title:"CSS",option:"default",modify:"markup"},clike:{title:"C-like",option:"default"},javascript:{title:"JavaScript",require:"clike",modify:"markup",optional:"regex",alias:"js",option:"default"},abap:{title:"ABAP",owner:"dellagustin"},abnf:{title:"ABNF",owner:"RunDevelopment"},actionscript:{title:"ActionScript",require:"javascript",modify:"markup",owner:"Golmote"},ada:{title:"Ada",owner:"Lucretia"},agda:{title:"Agda",owner:"xy-ren"},al:{title:"AL",owner:"RunDevelopment"},antlr4:{title:"ANTLR4",alias:"g4",owner:"RunDevelopment"},apacheconf:{title:"Apache Configuration",owner:"GuiTeK"},apex:{title:"Apex",require:["clike","sql"],owner:"RunDevelopment"},apl:{title:"APL",owner:"ngn"},applescript:{title:"AppleScript",owner:"Golmote"},aql:{title:"AQL",owner:"RunDevelopment"},arduino:{title:"Arduino",require:"cpp",alias:"ino",owner:"dkern"},arff:{title:"ARFF",owner:"Golmote"},armasm:{title:"ARM Assembly",alias:"arm-asm",owner:"RunDevelopment"},arturo:{title:"Arturo",alias:"art",optional:["bash","css","javascript","markup","markdown","sql"],owner:"drkameleon"},asciidoc:{alias:"adoc",title:"AsciiDoc",owner:"Golmote"},aspnet:{title:"ASP.NET (C#)",require:["markup","csharp"],owner:"nauzilus"},asm6502:{title:"6502 Assembly",owner:"kzurawel"},asmatmel:{title:"Atmel AVR Assembly",owner:"cerkit"},autohotkey:{title:"AutoHotkey",owner:"aviaryan"},autoit:{title:"AutoIt",owner:"Golmote"},avisynth:{title:"AviSynth",alias:"avs",owner:"Zinfidel"},"avro-idl":{title:"Avro IDL",alias:"avdl",owner:"RunDevelopment"},awk:{title:"AWK",alias:"gawk",aliasTitles:{gawk:"GAWK"},owner:"RunDevelopment"},bash:{title:"Bash",alias:["sh","shell"],aliasTitles:{sh:"Shell",shell:"Shell"},owner:"zeitgeist87"},basic:{title:"BASIC",owner:"Golmote"},batch:{title:"Batch",owner:"Golmote"},bbcode:{title:"BBcode",alias:"shortcode",aliasTitles:{shortcode:"Shortcode"},owner:"RunDevelopment"},bbj:{title:"BBj",owner:"hyyan"},bicep:{title:"Bicep",owner:"johnnyreilly"},birb:{title:"Birb",require:"clike",owner:"Calamity210"},bison:{title:"Bison",require:"c",owner:"Golmote"},bnf:{title:"BNF",alias:"rbnf",aliasTitles:{rbnf:"RBNF"},owner:"RunDevelopment"},bqn:{title:"BQN",owner:"yewscion"},brainfuck:{title:"Brainfuck",owner:"Golmote"},brightscript:{title:"BrightScript",owner:"RunDevelopment"},bro:{title:"Bro",owner:"wayward710"},bsl:{title:"BSL (1C:Enterprise)",alias:"oscript",aliasTitles:{oscript:"OneScript"},owner:"Diversus23"},c:{title:"C",require:"clike",owner:"zeitgeist87"},csharp:{title:"C#",require:"clike",alias:["cs","dotnet"],owner:"mvalipour"},cpp:{title:"C++",require:"c",owner:"zeitgeist87"},cfscript:{title:"CFScript",require:"clike",alias:"cfc",owner:"mjclemente"},chaiscript:{title:"ChaiScript",require:["clike","cpp"],owner:"RunDevelopment"},cil:{title:"CIL",owner:"sbrl"},cilkc:{title:"Cilk/C",require:"c",alias:"cilk-c",owner:"OpenCilk"},cilkcpp:{title:"Cilk/C++",require:"cpp",alias:["cilk-cpp","cilk"],owner:"OpenCilk"},clojure:{title:"Clojure",owner:"troglotit"},cmake:{title:"CMake",owner:"mjrogozinski"},cobol:{title:"COBOL",owner:"RunDevelopment"},coffeescript:{title:"CoffeeScript",require:"javascript",alias:"coffee",owner:"R-osey"},concurnas:{title:"Concurnas",alias:"conc",owner:"jasontatton"},csp:{title:"Content-Security-Policy",owner:"ScottHelme"},cooklang:{title:"Cooklang",owner:"ahue"},coq:{title:"Coq",owner:"RunDevelopment"},crystal:{title:"Crystal",require:"ruby",owner:"MakeNowJust"},"css-extras":{title:"CSS Extras",require:"css",modify:"css",owner:"milesj"},csv:{title:"CSV",owner:"RunDevelopment"},cue:{title:"CUE",owner:"RunDevelopment"},cypher:{title:"Cypher",owner:"RunDevelopment"},d:{title:"D",require:"clike",owner:"Golmote"},dart:{title:"Dart",require:"clike",owner:"Golmote"},dataweave:{title:"DataWeave",owner:"machaval"},dax:{title:"DAX",owner:"peterbud"},dhall:{title:"Dhall",owner:"RunDevelopment"},diff:{title:"Diff",owner:"uranusjr"},django:{title:"Django/Jinja2",require:"markup-templating",alias:"jinja2",owner:"romanvm"},"dns-zone-file":{title:"DNS zone file",owner:"RunDevelopment",alias:"dns-zone"},docker:{title:"Docker",alias:"dockerfile",owner:"JustinBeckwith"},dot:{title:"DOT (Graphviz)",alias:"gv",optional:"markup",owner:"RunDevelopment"},ebnf:{title:"EBNF",owner:"RunDevelopment"},editorconfig:{title:"EditorConfig",owner:"osipxd"},eiffel:{title:"Eiffel",owner:"Conaclos"},ejs:{title:"EJS",require:["javascript","markup-templating"],owner:"RunDevelopment",alias:"eta",aliasTitles:{eta:"Eta"}},elixir:{title:"Elixir",owner:"Golmote"},elm:{title:"Elm",owner:"zwilias"},etlua:{title:"Embedded Lua templating",require:["lua","markup-templating"],owner:"RunDevelopment"},erb:{title:"ERB",require:["ruby","markup-templating"],owner:"Golmote"},erlang:{title:"Erlang",owner:"Golmote"},"excel-formula":{title:"Excel Formula",alias:["xlsx","xls"],owner:"RunDevelopment"},fsharp:{title:"F#",require:"clike",owner:"simonreynolds7"},factor:{title:"Factor",owner:"catb0t"},false:{title:"False",owner:"edukisto"},"firestore-security-rules":{title:"Firestore security rules",require:"clike",owner:"RunDevelopment"},flow:{title:"Flow",require:"javascript",owner:"Golmote"},fortran:{title:"Fortran",owner:"Golmote"},ftl:{title:"FreeMarker Template Language",require:"markup-templating",owner:"RunDevelopment"},gml:{title:"GameMaker Language",alias:"gamemakerlanguage",require:"clike",owner:"LiarOnce"},gap:{title:"GAP (CAS)",owner:"RunDevelopment"},gcode:{title:"G-code",owner:"RunDevelopment"},gdscript:{title:"GDScript",owner:"RunDevelopment"},gedcom:{title:"GEDCOM",owner:"Golmote"},gettext:{title:"gettext",alias:"po",owner:"RunDevelopment"},gherkin:{title:"Gherkin",owner:"hason"},git:{title:"Git",owner:"lgiraudel"},glsl:{title:"GLSL",require:"c",owner:"Golmote"},gn:{title:"GN",alias:"gni",owner:"RunDevelopment"},"linker-script":{title:"GNU Linker Script",alias:"ld",owner:"RunDevelopment"},go:{title:"Go",require:"clike",owner:"arnehormann"},"go-module":{title:"Go module",alias:"go-mod",owner:"RunDevelopment"},gradle:{title:"Gradle",require:"clike",owner:"zeabdelkhalek-badido18"},graphql:{title:"GraphQL",optional:"markdown",owner:"Golmote"},groovy:{title:"Groovy",require:"clike",owner:"robfletcher"},haml:{title:"Haml",require:"ruby",optional:["css","css-extras","coffeescript","erb","javascript","less","markdown","scss","textile"],owner:"Golmote"},handlebars:{title:"Handlebars",require:"markup-templating",alias:["hbs","mustache"],aliasTitles:{mustache:"Mustache"},owner:"Golmote"},haskell:{title:"Haskell",alias:"hs",owner:"bholst"},haxe:{title:"Haxe",require:"clike",optional:"regex",owner:"Golmote"},hcl:{title:"HCL",owner:"outsideris"},hlsl:{title:"HLSL",require:"c",owner:"RunDevelopment"},hoon:{title:"Hoon",owner:"matildepark"},http:{title:"HTTP",optional:["csp","css","hpkp","hsts","javascript","json","markup","uri"],owner:"danielgtaylor"},hpkp:{title:"HTTP Public-Key-Pins",owner:"ScottHelme"},hsts:{title:"HTTP Strict-Transport-Security",owner:"ScottHelme"},ichigojam:{title:"IchigoJam",owner:"BlueCocoa"},icon:{title:"Icon",owner:"Golmote"},"icu-message-format":{title:"ICU Message Format",owner:"RunDevelopment"},idris:{title:"Idris",alias:"idr",owner:"KeenS",require:"haskell"},ignore:{title:".ignore",owner:"osipxd",alias:["gitignore","hgignore","npmignore"],aliasTitles:{gitignore:".gitignore",hgignore:".hgignore",npmignore:".npmignore"}},inform7:{title:"Inform 7",owner:"Golmote"},ini:{title:"Ini",owner:"aviaryan"},io:{title:"Io",owner:"AlesTsurko"},j:{title:"J",owner:"Golmote"},java:{title:"Java",require:"clike",owner:"sherblot"},javadoc:{title:"JavaDoc",require:["markup","java","javadoclike"],modify:"java",optional:"scala",owner:"RunDevelopment"},javadoclike:{title:"JavaDoc-like",modify:["java","javascript","php"],owner:"RunDevelopment"},javastacktrace:{title:"Java stack trace",owner:"RunDevelopment"},jexl:{title:"Jexl",owner:"czosel"},jolie:{title:"Jolie",require:"clike",owner:"thesave"},jq:{title:"JQ",owner:"RunDevelopment"},jsdoc:{title:"JSDoc",require:["javascript","javadoclike","typescript"],modify:"javascript",optional:["actionscript","coffeescript"],owner:"RunDevelopment"},"js-extras":{title:"JS Extras",require:"javascript",modify:"javascript",optional:["actionscript","coffeescript","flow","n4js","typescript"],owner:"RunDevelopment"},json:{title:"JSON",alias:"webmanifest",aliasTitles:{webmanifest:"Web App Manifest"},owner:"CupOfTea696"},json5:{title:"JSON5",require:"json",owner:"RunDevelopment"},jsonp:{title:"JSONP",require:"json",owner:"RunDevelopment"},jsstacktrace:{title:"JS stack trace",owner:"sbrl"},"js-templates":{title:"JS Templates",require:"javascript",modify:"javascript",optional:["css","css-extras","graphql","markdown","markup","sql"],owner:"RunDevelopment"},julia:{title:"Julia",owner:"cdagnino"},keepalived:{title:"Keepalived Configure",owner:"dev-itsheng"},keyman:{title:"Keyman",owner:"mcdurdin"},kotlin:{title:"Kotlin",alias:["kt","kts"],aliasTitles:{kts:"Kotlin Script"},require:"clike",owner:"Golmote"},kumir:{title:"KuMir (\u041a\u0443\u041c\u0438\u0440)",alias:"kum",owner:"edukisto"},kusto:{title:"Kusto",owner:"RunDevelopment"},latex:{title:"LaTeX",alias:["tex","context"],aliasTitles:{tex:"TeX",context:"ConTeXt"},owner:"japborst"},latte:{title:"Latte",require:["clike","markup-templating","php"],owner:"nette"},less:{title:"Less",require:"css",optional:"css-extras",owner:"Golmote"},lilypond:{title:"LilyPond",require:"scheme",alias:"ly",owner:"RunDevelopment"},liquid:{title:"Liquid",require:"markup-templating",owner:"cinhtau"},lisp:{title:"Lisp",alias:["emacs","elisp","emacs-lisp"],owner:"JuanCaicedo"},livescript:{title:"LiveScript",owner:"Golmote"},llvm:{title:"LLVM IR",owner:"porglezomp"},log:{title:"Log file",optional:"javastacktrace",owner:"RunDevelopment"},lolcode:{title:"LOLCODE",owner:"Golmote"},lua:{title:"Lua",owner:"Golmote"},magma:{title:"Magma (CAS)",owner:"RunDevelopment"},makefile:{title:"Makefile",owner:"Golmote"},markdown:{title:"Markdown",require:"markup",optional:"yaml",alias:"md",owner:"Golmote"},"markup-templating":{title:"Markup templating",require:"markup",owner:"Golmote"},mata:{title:"Mata",owner:"RunDevelopment"},matlab:{title:"MATLAB",owner:"Golmote"},maxscript:{title:"MAXScript",owner:"RunDevelopment"},mel:{title:"MEL",owner:"Golmote"},mermaid:{title:"Mermaid",owner:"RunDevelopment"},metafont:{title:"METAFONT",owner:"LaeriExNihilo"},mizar:{title:"Mizar",owner:"Golmote"},mongodb:{title:"MongoDB",owner:"airs0urce",require:"javascript"},monkey:{title:"Monkey",owner:"Golmote"},moonscript:{title:"MoonScript",alias:"moon",owner:"RunDevelopment"},n1ql:{title:"N1QL",owner:"TMWilds"},n4js:{title:"N4JS",require:"javascript",optional:"jsdoc",alias:"n4jsd",owner:"bsmith-n4"},"nand2tetris-hdl":{title:"Nand To Tetris HDL",owner:"stephanmax"},naniscript:{title:"Naninovel Script",owner:"Elringus",alias:"nani"},nasm:{title:"NASM",owner:"rbmj"},neon:{title:"NEON",owner:"nette"},nevod:{title:"Nevod",owner:"nezaboodka"},nginx:{title:"nginx",owner:"volado"},nim:{title:"Nim",owner:"Golmote"},nix:{title:"Nix",owner:"Golmote"},nsis:{title:"NSIS",owner:"idleberg"},objectivec:{title:"Objective-C",require:"c",alias:"objc",owner:"uranusjr"},ocaml:{title:"OCaml",owner:"Golmote"},odin:{title:"Odin",owner:"edukisto"},opencl:{title:"OpenCL",require:"c",modify:["c","cpp"],owner:"Milania1"},openqasm:{title:"OpenQasm",alias:"qasm",owner:"RunDevelopment"},oz:{title:"Oz",owner:"Golmote"},parigp:{title:"PARI/GP",owner:"Golmote"},parser:{title:"Parser",require:"markup",owner:"Golmote"},pascal:{title:"Pascal",alias:"objectpascal",aliasTitles:{objectpascal:"Object Pascal"},owner:"Golmote"},pascaligo:{title:"Pascaligo",owner:"DefinitelyNotAGoat"},psl:{title:"PATROL Scripting Language",owner:"bertysentry"},pcaxis:{title:"PC-Axis",alias:"px",owner:"RunDevelopment"},peoplecode:{title:"PeopleCode",alias:"pcode",owner:"RunDevelopment"},perl:{title:"Perl",owner:"Golmote"},php:{title:"PHP",require:"markup-templating",owner:"milesj"},phpdoc:{title:"PHPDoc",require:["php","javadoclike"],modify:"php",owner:"RunDevelopment"},"php-extras":{title:"PHP Extras",require:"php",modify:"php",owner:"milesj"},"plant-uml":{title:"PlantUML",alias:"plantuml",owner:"RunDevelopment"},plsql:{title:"PL/SQL",require:"sql",owner:"Golmote"},powerquery:{title:"PowerQuery",alias:["pq","mscript"],owner:"peterbud"},powershell:{title:"PowerShell",owner:"nauzilus"},processing:{title:"Processing",require:"clike",owner:"Golmote"},prolog:{title:"Prolog",owner:"Golmote"},promql:{title:"PromQL",owner:"arendjr"},properties:{title:".properties",owner:"Golmote"},protobuf:{title:"Protocol Buffers",require:"clike",owner:"just-boris"},pug:{title:"Pug",require:["markup","javascript"],optional:["coffeescript","ejs","handlebars","less","livescript","markdown","scss","stylus","twig"],owner:"Golmote"},puppet:{title:"Puppet",owner:"Golmote"},pure:{title:"Pure",optional:["c","cpp","fortran"],owner:"Golmote"},purebasic:{title:"PureBasic",require:"clike",alias:"pbfasm",owner:"HeX0R101"},purescript:{title:"PureScript",require:"haskell",alias:"purs",owner:"sriharshachilakapati"},python:{title:"Python",alias:"py",owner:"multipetros"},qsharp:{title:"Q#",require:"clike",alias:"qs",owner:"fedonman"},q:{title:"Q (kdb+ database)",owner:"Golmote"},qml:{title:"QML",require:"javascript",owner:"RunDevelopment"},qore:{title:"Qore",require:"clike",owner:"temnroegg"},r:{title:"R",owner:"Golmote"},racket:{title:"Racket",require:"scheme",alias:"rkt",owner:"RunDevelopment"},cshtml:{title:"Razor C#",alias:"razor",require:["markup","csharp"],optional:["css","css-extras","javascript","js-extras"],owner:"RunDevelopment"},jsx:{title:"React JSX",require:["markup","javascript"],optional:["jsdoc","js-extras","js-templates"],owner:"vkbansal"},tsx:{title:"React TSX",require:["jsx","typescript"]},reason:{title:"Reason",require:"clike",owner:"Golmote"},regex:{title:"Regex",owner:"RunDevelopment"},rego:{title:"Rego",owner:"JordanSh"},renpy:{title:"Ren'py",alias:"rpy",owner:"HyuchiaDiego"},rescript:{title:"ReScript",alias:"res",owner:"vmarcosp"},rest:{title:"reST (reStructuredText)",owner:"Golmote"},rip:{title:"Rip",owner:"ravinggenius"},roboconf:{title:"Roboconf",owner:"Golmote"},robotframework:{title:"Robot Framework",alias:"robot",owner:"RunDevelopment"},ruby:{title:"Ruby",require:"clike",alias:"rb",owner:"samflores"},rust:{title:"Rust",owner:"Golmote"},sas:{title:"SAS",optional:["groovy","lua","sql"],owner:"Golmote"},sass:{title:"Sass (Sass)",require:"css",optional:"css-extras",owner:"Golmote"},scss:{title:"Sass (SCSS)",require:"css",optional:"css-extras",owner:"MoOx"},scala:{title:"Scala",require:"java",owner:"jozic"},scheme:{title:"Scheme",owner:"bacchus123"},"shell-session":{title:"Shell session",require:"bash",alias:["sh-session","shellsession"],owner:"RunDevelopment"},smali:{title:"Smali",owner:"RunDevelopment"},smalltalk:{title:"Smalltalk",owner:"Golmote"},smarty:{title:"Smarty",require:"markup-templating",optional:"php",owner:"Golmote"},sml:{title:"SML",alias:"smlnj",aliasTitles:{smlnj:"SML/NJ"},owner:"RunDevelopment"},solidity:{title:"Solidity (Ethereum)",alias:"sol",require:"clike",owner:"glachaud"},"solution-file":{title:"Solution file",alias:"sln",owner:"RunDevelopment"},soy:{title:"Soy (Closure Template)",require:"markup-templating",owner:"Golmote"},sparql:{title:"SPARQL",require:"turtle",owner:"Triply-Dev",alias:"rq"},"splunk-spl":{title:"Splunk SPL",owner:"RunDevelopment"},sqf:{title:"SQF: Status Quo Function (Arma 3)",require:"clike",owner:"RunDevelopment"},sql:{title:"SQL",owner:"multipetros"},squirrel:{title:"Squirrel",require:"clike",owner:"RunDevelopment"},stan:{title:"Stan",owner:"RunDevelopment"},stata:{title:"Stata Ado",require:["mata","java","python"],owner:"RunDevelopment"},iecst:{title:"Structured Text (IEC 61131-3)",owner:"serhioromano"},stylus:{title:"Stylus",owner:"vkbansal"},supercollider:{title:"SuperCollider",alias:"sclang",owner:"RunDevelopment"},swift:{title:"Swift",owner:"chrischares"},systemd:{title:"Systemd configuration file",owner:"RunDevelopment"},"t4-templating":{title:"T4 templating",owner:"RunDevelopment"},"t4-cs":{title:"T4 Text Templates (C#)",require:["t4-templating","csharp"],alias:"t4",owner:"RunDevelopment"},"t4-vb":{title:"T4 Text Templates (VB)",require:["t4-templating","vbnet"],owner:"RunDevelopment"},tap:{title:"TAP",owner:"isaacs",require:"yaml"},tcl:{title:"Tcl",owner:"PeterChaplin"},tt2:{title:"Template Toolkit 2",require:["clike","markup-templating"],owner:"gflohr"},textile:{title:"Textile",require:"markup",optional:"css",owner:"Golmote"},toml:{title:"TOML",owner:"RunDevelopment"},tremor:{title:"Tremor",alias:["trickle","troy"],owner:"darach",aliasTitles:{trickle:"trickle",troy:"troy"}},turtle:{title:"Turtle",alias:"trig",aliasTitles:{trig:"TriG"},owner:"jakubklimek"},twig:{title:"Twig",require:"markup-templating",owner:"brandonkelly"},typescript:{title:"TypeScript",require:"javascript",optional:"js-templates",alias:"ts",owner:"vkbansal"},typoscript:{title:"TypoScript",alias:"tsconfig",aliasTitles:{tsconfig:"TSConfig"},owner:"dkern"},unrealscript:{title:"UnrealScript",alias:["uscript","uc"],owner:"RunDevelopment"},uorazor:{title:"UO Razor Script",owner:"jaseowns"},uri:{title:"URI",alias:"url",aliasTitles:{url:"URL"},owner:"RunDevelopment"},v:{title:"V",require:"clike",owner:"taggon"},vala:{title:"Vala",require:"clike",optional:"regex",owner:"TemplarVolk"},vbnet:{title:"VB.Net",require:"basic",owner:"Bigsby"},velocity:{title:"Velocity",require:"markup",owner:"Golmote"},verilog:{title:"Verilog",owner:"a-rey"},vhdl:{title:"VHDL",owner:"a-rey"},vim:{title:"vim",owner:"westonganger"},"visual-basic":{title:"Visual Basic",alias:["vb","vba"],aliasTitles:{vba:"VBA"},owner:"Golmote"},warpscript:{title:"WarpScript",owner:"RunDevelopment"},wasm:{title:"WebAssembly",owner:"Golmote"},"web-idl":{title:"Web IDL",alias:"webidl",owner:"RunDevelopment"},wgsl:{title:"WGSL",owner:"Dr4gonthree"},wiki:{title:"Wiki markup",require:"markup",owner:"Golmote"},wolfram:{title:"Wolfram language",alias:["mathematica","nb","wl"],aliasTitles:{mathematica:"Mathematica",nb:"Mathematica Notebook"},owner:"msollami"},wren:{title:"Wren",owner:"clsource"},xeora:{title:"Xeora",require:"markup",alias:"xeoracube",aliasTitles:{xeoracube:"XeoraCube"},owner:"freakmaxi"},"xml-doc":{title:"XML doc (.net)",require:"markup",modify:["csharp","fsharp","vbnet"],owner:"RunDevelopment"},xojo:{title:"Xojo (REALbasic)",owner:"Golmote"},xquery:{title:"XQuery",require:"markup",owner:"Golmote"},yaml:{title:"YAML",alias:"yml",owner:"hason"},yang:{title:"YANG",owner:"RunDevelopment"},zig:{title:"Zig",owner:"RunDevelopment"}},plugins:{meta:{path:"plugins/{id}/prism-{id}",link:"plugins/{id}/"},"line-highlight":{title:"Line Highlight",description:"Highlights specific lines and/or line ranges."},"line-numbers":{title:"Line Numbers",description:"Line number at the beginning of code lines.",owner:"kuba-kubula"},"show-invisibles":{title:"Show Invisibles",description:"Show hidden characters such as tabs and line breaks.",optional:["autolinker","data-uri-highlight"]},autolinker:{title:"Autolinker",description:"Converts URLs and emails in code to clickable links. Parses Markdown links in comments."},wpd:{title:"WebPlatform Docs",description:'Makes tokens link to WebPlatform.org documentation. The links open in a new tab.'},"custom-class":{title:"Custom Class",description:"This plugin allows you to prefix Prism's default classes (.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},8722:(e,t,n)=>{const r=n(6969),o=n(8380),a=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...a,...Object.keys(Prism.languages)];o(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(3157).resolve(t)],delete Prism.languages[e],n(3157)(t),a.add(e)}))}i.silent=!1,e.exports=i},9700:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,o,a){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(o,(function(e){if("function"==typeof a&&!a(e))return e;for(var o,s=i.length;-1!==n.code.indexOf(o=t(r,s));)++s;return i[s]=e,o})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var o=0,a=Object.keys(n.tokenStack);!function i(s){for(var l=0;l=a.length);l++){var c=s[l];if("string"==typeof c||c.content&&"string"==typeof c.content){var u=a[o],d=n.tokenStack[u],p="string"==typeof c?c:c.content,f=t(r,u),m=p.indexOf(f);if(m>-1){++o;var h=p.substring(0,m),g=new e.Token(r,e.tokenize(d,n.grammar),"language-"+r,d),b=p.substring(m+f.length),y=[];h&&y.push.apply(y,i([h])),y.push(g),b&&y.push.apply(y,i([b])),"string"==typeof c?s.splice.apply(s,[l,1].concat(y)):c.content=y}}else c.content&&i(c.content)}return s}(n.tokens)}}}})}(Prism)},4523:(e,t,n)=>{var r={"./":8722};function o(e){var t=a(e);return n(t)}function a(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}o.keys=function(){return Object.keys(r)},o.resolve=a,e.exports=o,o.id=4523},3157:(e,t,n)=>{var r={"./":8722};function o(e){var t=a(e);return n(t)}function a(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}o.keys=function(){return Object.keys(r)},o.resolve=a,e.exports=o,o.id=3157},8380:e=>{"use strict";var t=function(){var e=function(){};function t(e,t){Array.isArray(e)?e.forEach(t):null!=e&&t(e,0)}function n(e){for(var t={},n=0,r=e.length;n "));var s={},l=e[r];if(l){function c(t){if(!(t in e))throw new Error(r+" depends on an unknown component "+t);if(!(t in s))for(var i in o(t,a),s[t]=!0,n[t])s[i]=!0}t(l.require,c),t(l.optional,c),t(l.modify,c)}n[r]=s,a.pop()}}return function(e){var t=n[e];return t||(o(e,r),t=n[e]),t}}function o(e){for(var t in e)return!0;return!1}return function(a,i,s){var l=function(e){var t={};for(var n in e){var r=e[n];for(var o in r)if("meta"!=o){var a=r[o];t[o]="string"==typeof a?{title:a}:a}}return t}(a),c=function(e){var n;return function(r){if(r in e)return r;if(!n)for(var o in n={},e){var a=e[o];t(a&&a.alias,(function(t){if(t in n)throw new Error(t+" cannot be alias for both "+o+" and "+n[t]);if(t in e)throw new Error(t+" cannot be alias of "+o+" because it is a component.");n[t]=o}))}return n[r]||r}}(l);i=i.map(c),s=(s||[]).map(c);var u=n(i),d=n(s);i.forEach((function e(n){var r=l[n];t(r&&r.require,(function(t){t in d||(u[t]=!0,e(t))}))}));for(var p,f=r(l),m=u;o(m);){for(var h in p={},m){var g=l[h];t(g&&g.modify,(function(e){e in d&&(p[e]=!0)}))}for(var b in d)if(!(b in u))for(var y in f(b))if(y in u){p[b]=!0;break}for(var v in m=p)u[v]=!0}var w={getIds:function(){var e=[];return w.load((function(t){e.push(t)})),e},load:function(t,n){return function(t,n,r,o){var a=o?o.series:void 0,i=o?o.parallel:e,s={},l={};function c(e){if(e in s)return s[e];l[e]=!0;var o,u=[];for(var d in t(e))d in n&&u.push(d);if(0===u.length)o=r(e);else{var p=i(u.map((function(e){var t=c(e);return delete l[e],t})));a?o=a(p,(function(){return r(e)})):r(e)}return s[e]=o}for(var u in n)c(u);var d=[];for(var p in l)d.push(s[p]);return i(d)}(f,u,t,n)}};return w}}();e.exports=t},2694:(e,t,n)=>{"use strict";var r=n(6925);function o(){}function a(){}a.resetWarningCache=o,e.exports=function(){function e(e,t,n,o,a,i){if(i!==r){var s=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw s.name="Invariant Violation",s}}function t(){return e}e.isRequired=e;var n={array:e,bigint:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:a,resetWarningCache:o};return n.PropTypes=n,n}},5556:(e,t,n)=>{e.exports=n(2694)()},6925:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},2551:(e,t,n)=>{"use strict";var r=n(6540),o=n(9982);function a(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n