# Baileys API Documentation

*Extraído de https://baileys.wiki/docs/api/ em 2026-04-04T16:35:50.205Z*

## Table of Contents

1. [baileys](#baileys)
2. [Class: BinaryInfo](#class-binaryinfo)
3. [Class: MessageRetryManager](#class-messageretrymanager)
4. [Class: USyncContactProtocol](#class-usynccontactprotocol)
5. [Class: USyncDeviceProtocol](#class-usyncdeviceprotocol)
6. [Class: USyncDisappearingModeProtocol](#class-usyncdisappearingmodeprotocol)
7. [Class: USyncQuery](#class-usyncquery)
8. [Class: USyncStatusProtocol](#class-usyncstatusprotocol)
9. [Class: USyncUser](#class-usyncuser)
10. [Enumeration: DisconnectReason](#enumeration-disconnectreason)
11. [Enumeration: QueryIds](#enumeration-queryids)
12. [Enumeration: RetryReason](#enumeration-retryreason)
13. [Enumeration: SyncState](#enumeration-syncstate)
14. [Enumeration: WAJIDDomains](#enumeration-wajiddomains)
15. [Enumeration: WAMessageAddressingMode](#enumeration-wamessageaddressingmode)
16. [Enumeration: XWAPaths](#enumeration-xwapaths)
17. [Function: addTransactionCapability()](#function-addtransactioncapability-)
18. [Function: aesDecrypt()](#function-aesdecrypt-)
19. [Function: aesDecryptCTR()](#function-aesdecryptctr-)
20. [Function: aesDecryptGCM()](#function-aesdecryptgcm-)
21. [Function: aesDecryptWithIV()](#function-aesdecryptwithiv-)
22. [Function: aesEncrypWithIV()](#function-aesencrypwithiv-)
23. [Function: aesEncrypt()](#function-aesencrypt-)
24. [Function: aesEncryptCTR()](#function-aesencryptctr-)
25. [Function: aesEncryptGCM()](#function-aesencryptgcm-)
26. [Function: aggregateMessageKeysNotFromMe()](#function-aggregatemessagekeysnotfromme-)
27. [Function: areJidsSameUser()](#function-arejidssameuser-)
28. [Function: assertMediaContent()](#function-assertmediacontent-)
29. [Function: assertNodeErrorFree()](#function-assertnodeerrorfree-)
30. [Function: binaryNodeToString()](#function-binarynodetostring-)
31. [Function: bindWaitForConnectionUpdate()](#function-bindwaitforconnectionupdate-)
32. [Function: bindWaitForEvent()](#function-bindwaitforevent-)
33. [Function: buildAckStanza()](#function-buildackstanza-)
34. [Function: bytesToCrockford()](#function-bytestocrockford-)
35. [Function: chatModificationToAppPatch()](#function-chatmodificationtoapppatch-)
36. [Function: cleanMessage()](#function-cleanmessage-)
37. [Function: configureSuccessfulPairing()](#function-configuresuccessfulpairing-)
38. [Function: createSignalIdentity()](#function-createsignalidentity-)
39. [Function: debouncedTimeout()](#function-debouncedtimeout-)
40. [Function: decodeBinaryNode()](#function-decodebinarynode-)
41. [Function: decodeDecompressedBinaryNode()](#function-decodedecompressedbinarynode-)
42. [Function: decodeMediaRetryNode()](#function-decodemediaretrynode-)
43. [Function: decodeMessageNode()](#function-decodemessagenode-)
44. [Function: decodePatches()](#function-decodepatches-)
45. [Function: decodeSyncdMutations()](#function-decodesyncdmutations-)
46. [Function: decodeSyncdPatch()](#function-decodesyncdpatch-)
47. [Function: decodeSyncdSnapshot()](#function-decodesyncdsnapshot-)
48. [Function: decompressingIfRequired()](#function-decompressingifrequired-)
49. [Function: decryptEventResponse()](#function-decrypteventresponse-)
50. [Function: decryptMediaRetryData()](#function-decryptmediaretrydata-)
51. [Function: decryptMessageNode()](#function-decryptmessagenode-)
52. [Function: decryptPollVote()](#function-decryptpollvote-)
53. [Function: delay()](#function-delay-)
54. [Function: delayCancellable()](#function-delaycancellable-)
55. [Function: derivePairingCodeKey()](#function-derivepairingcodekey-)
56. [Function: downloadAndProcessHistorySyncNotification()](#function-downloadandprocesshistorysyncnotification-)
57. [Function: downloadContentFromMessage()](#function-downloadcontentfrommessage-)
58. [Function: downloadEncryptedContent()](#function-downloadencryptedcontent-)
59. [Function: downloadExternalBlob()](#function-downloadexternalblob-)
60. [Function: downloadExternalPatch()](#function-downloadexternalpatch-)
61. [Function: downloadHistory()](#function-downloadhistory-)
62. [Function: downloadMediaMessage()](#function-downloadmediamessage-)
63. [Function: encodeBase64EncodedStringForUpload()](#function-encodebase64encodedstringforupload-)
64. [Function: encodeBigEndian()](#function-encodebigendian-)
65. [Function: encodeBinaryNode()](#function-encodebinarynode-)
66. [Function: encodeNewsletterMessage()](#function-encodenewslettermessage-)
67. [Function: encodeSignedDeviceIdentity()](#function-encodesigneddeviceidentity-)
68. [Function: encodeSyncdPatch()](#function-encodesyncdpatch-)
69. [Function: encodeWAM()](#function-encodewam-)
70. [Function: encodeWAMessage()](#function-encodewamessage-)
71. [Function: encryptMediaRetryRequest()](#function-encryptmediaretryrequest-)
72. [Function: encryptedStream()](#function-encryptedstream-)
73. [Function: extensionForMediaMessage()](#function-extensionformediamessage-)
74. [Function: extractAddressingContext()](#function-extractaddressingcontext-)
75. [Function: extractDeviceJids()](#function-extractdevicejids-)
76. [Function: extractImageThumb()](#function-extractimagethumb-)
77. [Function: extractMessageContent()](#function-extractmessagecontent-)
78. [Function: extractSyncdPatches()](#function-extractsyncdpatches-)
79. [Function: extractUrlFromText()](#function-extracturlfromtext-)
80. [Function: fetchLatestBaileysVersion()](#function-fetchlatestbaileysversion-)
81. [Function: fetchLatestWaWebVersion()](#function-fetchlatestwawebversion-)
82. [Function: generateForwardMessageContent()](#function-generateforwardmessagecontent-)
83. [Function: generateLinkPreviewIfRequired()](#function-generatelinkpreviewifrequired-)
84. [Function: generateLoginNode()](#function-generateloginnode-)
85. [Function: generateMdTagPrefix()](#function-generatemdtagprefix-)
86. [Function: generateMessageID()](#function-generatemessageid-)
87. [Function: generateMessageIDV2()](#function-generatemessageidv2-)
88. [Function: generateOrGetPreKeys()](#function-generateorgetprekeys-)
89. [Function: generateParticipantHashV2()](#function-generateparticipanthashv2-)
90. [Function: generateProfilePicture()](#function-generateprofilepicture-)
91. [Function: generateRegistrationId()](#function-generateregistrationid-)
92. [Function: generateRegistrationNode()](#function-generateregistrationnode-)
93. [Function: generateSignalPubKey()](#function-generatesignalpubkey-)
94. [Function: generateThumbnail()](#function-generatethumbnail-)
95. [Function: generateWAMessage()](#function-generatewamessage-)
96. [Function: generateWAMessageContent()](#function-generatewamessagecontent-)
97. [Function: generateWAMessageFromContent()](#function-generatewamessagefromcontent-)
98. [Function: getAggregateResponsesInEventMessage()](#function-getaggregateresponsesineventmessage-)
99. [Function: getAggregateVotesInPollMessage()](#function-getaggregatevotesinpollmessage-)
100. [Function: getAllBinaryNodeChildren()](#function-getallbinarynodechildren-)
101. [Function: getAudioDuration()](#function-getaudioduration-)
102. [Function: getAudioWaveform()](#function-getaudiowaveform-)
103. [Function: getBinaryNodeChild()](#function-getbinarynodechild-)
104. [Function: getBinaryNodeChildBuffer()](#function-getbinarynodechildbuffer-)
105. [Function: getBinaryNodeChildString()](#function-getbinarynodechildstring-)
106. [Function: getBinaryNodeChildUInt()](#function-getbinarynodechilduint-)
107. [Function: getBinaryNodeChildren()](#function-getbinarynodechildren-)
108. [Function: getBinaryNodeMessages()](#function-getbinarynodemessages-)
109. [Function: getCallStatusFromNode()](#function-getcallstatusfromnode-)
110. [Function: getChatId()](#function-getchatid-)
111. [Function: getCodeFromWSError()](#function-getcodefromwserror-)
112. [Function: getContentType()](#function-getcontenttype-)
113. [Function: getDecryptionJid()](#function-getdecryptionjid-)
114. [Function: getDevice()](#function-getdevice-)
115. [Function: getErrorCodeFromStreamError()](#function-geterrorcodefromstreamerror-)
116. [Function: getHistoryMsg()](#function-gethistorymsg-)
117. [Function: getHttpStream()](#function-gethttpstream-)
118. [Function: getKeyAuthor()](#function-getkeyauthor-)
119. [Function: getMediaKeys()](#function-getmediakeys-)
120. [Function: getNextPreKeys()](#function-getnextprekeys-)
121. [Function: getNextPreKeysNode()](#function-getnextprekeysnode-)
122. [Function: getPlatformId()](#function-getplatformid-)
123. [Function: getPreKeys()](#function-getprekeys-)
124. [Function: getRawMediaUploadData()](#function-getrawmediauploaddata-)
125. [Function: getServerFromDomainType()](#function-getserverfromdomaintype-)
126. [Function: getStatusCodeForMediaRetry()](#function-getstatuscodeformediaretry-)
127. [Function: getStatusFromReceiptType()](#function-getstatusfromreceipttype-)
128. [Function: getStream()](#function-getstream-)
129. [Function: getUrlFromDirectPath()](#function-geturlfromdirectpath-)
130. [Function: getUrlInfo()](#function-geturlinfo-)
131. [Function: getWAUploadToServer()](#function-getwauploadtoserver-)
132. [Function: handleIdentityChange()](#function-handleidentitychange-)
133. [Function: hasNonNullishProperty()](#function-hasnonnullishproperty-)
134. [Function: hkdfInfoKey()](#function-hkdfinfokey-)
135. [Function: hmacSign()](#function-hmacsign-)
136. [Function: initAuthCreds()](#function-initauthcreds-)
137. [Function: isHostedLidUser()](#function-ishostedliduser-)
138. [Function: isHostedPnUser()](#function-ishostedpnuser-)
139. [Function: isJidBot()](#function-isjidbot-)
140. [Function: isJidBroadcast()](#function-isjidbroadcast-)
141. [Function: isJidGroup()](#function-isjidgroup-)
142. [Function: isJidMetaAI()](#function-isjidmetaai-)
143. [Function: isJidNewsletter()](#function-isjidnewsletter-)
144. [Function: isJidStatusBroadcast()](#function-isjidstatusbroadcast-)
145. [Function: isLidUser()](#function-isliduser-)
146. [Function: isPnUser()](#function-ispnuser-)
147. [Function: isRealMessage()](#function-isrealmessage-)
148. [Function: isStringNullOrEmpty()](#function-isstringnullorempty-)
149. [Function: isWABusinessPlatform()](#function-iswabusinessplatform-)
150. [Function: jidDecode()](#function-jiddecode-)
151. [Function: jidEncode()](#function-jidencode-)
152. [Function: jidNormalizedUser()](#function-jidnormalizeduser-)
153. [Function: makeCacheableSignalKeyStore()](#function-makecacheablesignalkeystore-)
154. [Function: makeEventBuffer()](#function-makeeventbuffer-)
155. [Function: makeNoiseHandler()](#function-makenoisehandler-)
156. [Function: makeWASocket()](#function-makewasocket-)
157. [Function: mediaMessageSHA256B64()](#function-mediamessagesha256b64-)
158. [Function: newLTHashState()](#function-newlthashstate-)
159. [Function: normalizeMessageContent()](#function-normalizemessagecontent-)
160. [Function: parseAndInjectE2ESessions()](#function-parseandinjecte2esessions-)
161. [Function: prepareDisappearingMessageSettingContent()](#function-preparedisappearingmessagesettingcontent-)
162. [Function: prepareWAMessageMedia()](#function-preparewamessagemedia-)
163. [Function: processHistoryMessage()](#function-processhistorymessage-)
164. [Function: processSyncAction()](#function-processsyncaction-)
165. [Function: promiseTimeout()](#function-promisetimeout-)
166. [Function: reduceBinaryNodeToDictionary()](#function-reducebinarynodetodictionary-)
167. [Function: sha256()](#function-sha256-)
168. [Function: shouldIncrementChatUnread()](#function-shouldincrementchatunread-)
169. [Function: signedKeyPair()](#function-signedkeypair-)
170. [Function: toBuffer()](#function-tobuffer-)
171. [Function: toNumber()](#function-tonumber-)
172. [Function: toReadable()](#function-toreadable-)
173. [Function: transferDevice()](#function-transferdevice-)
174. [Function: trimUndefined()](#function-trimundefined-)
175. [Function: unixTimestampSeconds()](#function-unixtimestampseconds-)
176. [Function: unpadRandomMax16()](#function-unpadrandommax16-)
177. [Function: updateMessageWithEventResponse()](#function-updatemessagewitheventresponse-)
178. [Function: updateMessageWithPollUpdate()](#function-updatemessagewithpollupdate-)
179. [Function: updateMessageWithReaction()](#function-updatemessagewithreaction-)
180. [Function: updateMessageWithReceipt()](#function-updatemessagewithreceipt-)
181. [Function: uploadWithNodeHttp()](#function-uploadwithnodehttp-)
182. [Function: useMultiFileAuthState()](#function-usemultifileauthstate-)
183. [Function: writeRandomPadMax16()](#function-writerandompadmax16-)
184. [Function: xmppPreKey()](#function-xmppprekey-)
185. [Function: xmppSignedPreKey()](#function-xmppsignedprekey-)
186. [Interface: BaileysEventEmitter](#interface-baileyseventemitter)
187. [Interface: Contact](#interface-contact)
188. [Interface: GroupMetadata](#interface-groupmetadata)
189. [Interface: GroupModificationResponse](#interface-groupmodificationresponse)
190. [Interface: NewsletterCreateResponse](#interface-newslettercreateresponse)
191. [Interface: NewsletterMetadata](#interface-newslettermetadata)
192. [Interface: PresenceData](#interface-presencedata)
193. [Interface: RecentMessage](#interface-recentmessage)
194. [Interface: RecentMessageKey](#interface-recentmessagekey)
195. [Interface: RetryCounter](#interface-retrycounter)
196. [Interface: RetryStatistics](#interface-retrystatistics)
197. [Interface: SessionRecreateHistory](#interface-sessionrecreatehistory)
198. [Interface: SignalRepositoryWithLIDStore](#interface-signalrepositorywithlidstore)
199. [Interface: WAGroupCreateResponse](#interface-wagroupcreateresponse)
200. [Interface: WAUrlInfo](#interface-waurlinfo)
201. [proto](#proto)
202. [Class: ADVDeviceIdentity](#class-advdeviceidentity)
203. [Class: ADVKeyIndexList](#class-advkeyindexlist)
204. [Class: ADVSignedDeviceIdentity](#class-advsigneddeviceidentity)
205. [Class: ADVSignedDeviceIdentityHMAC](#class-advsigneddeviceidentityhmac)
206. [Class: ADVSignedKeyIndexList](#class-advsignedkeyindexlist)
207. [Class: AIHomeState](#class-aihomestate)
208. [Class: AIQueryFanout](#class-aiqueryfanout)
209. [Class: AIRegenerateMetadata](#class-airegeneratemetadata)
210. [Class: AIRichResponseCodeMetadata](#class-airichresponsecodemetadata)
211. [Class: AIRichResponseContentItemsMetadata](#class-airichresponsecontentitemsmetadata)
212. [Class: AIRichResponseDynamicMetadata](#class-airichresponsedynamicmetadata)
213. [Class: AIRichResponseGridImageMetadata](#class-airichresponsegridimagemetadata)
214. [Class: AIRichResponseImageURL](#class-airichresponseimageurl)
215. [Class: AIRichResponseInlineImageMetadata](#class-airichresponseinlineimagemetadata)
216. [Class: AIRichResponseLatexMetadata](#class-airichresponselatexmetadata)
217. [Class: AIRichResponseMapMetadata](#class-airichresponsemapmetadata)
218. [Class: AIRichResponseMessage](#class-airichresponsemessage)
219. [Class: AIRichResponseSubMessage](#class-airichresponsesubmessage)
220. [Class: AIRichResponseTableMetadata](#class-airichresponsetablemetadata)
221. [Class: AIRichResponseUnifiedResponse](#class-airichresponseunifiedresponse)
222. [Class: AIThreadInfo](#class-aithreadinfo)
223. [Class: Account](#class-account)
224. [Class: ActionLink](#class-actionlink)
225. [Class: AutoDownloadSettings](#class-autodownloadsettings)
226. [Class: AvatarUserSettings](#class-avatarusersettings)
227. [Class: BizAccountLinkInfo](#class-bizaccountlinkinfo)
228. [Class: BizAccountPayload](#class-bizaccountpayload)
229. [Class: BizIdentityInfo](#class-bizidentityinfo)
230. [Class: BotAgeCollectionMetadata](#class-botagecollectionmetadata)
231. [Class: BotAvatarMetadata](#class-botavatarmetadata)
232. [Class: BotCapabilityMetadata](#class-botcapabilitymetadata)
233. [Class: BotFeedbackMessage](#class-botfeedbackmessage)
234. [Class: BotImagineMetadata](#class-botimaginemetadata)
235. [Class: BotLinkedAccount](#class-botlinkedaccount)
236. [Class: BotLinkedAccountsMetadata](#class-botlinkedaccountsmetadata)
237. [Class: BotMediaMetadata](#class-botmediametadata)
238. [Class: BotMemoryFact](#class-botmemoryfact)
239. [Class: BotMemoryMetadata](#class-botmemorymetadata)
240. [Class: BotMemuMetadata](#class-botmemumetadata)
241. [Class: BotMessageOrigin](#class-botmessageorigin)
242. [Class: BotMessageOriginMetadata](#class-botmessageoriginmetadata)
243. [Class: BotMessageSharingInfo](#class-botmessagesharinginfo)
244. [Class: BotMetadata](#class-botmetadata)
245. [Class: BotMetricsMetadata](#class-botmetricsmetadata)
246. [Class: BotModeSelectionMetadata](#class-botmodeselectionmetadata)
247. [Class: BotModelMetadata](#class-botmodelmetadata)
248. [Class: BotPluginMetadata](#class-botpluginmetadata)
249. [Class: BotProgressIndicatorMetadata](#class-botprogressindicatormetadata)
250. [Class: BotPromotionMessageMetadata](#class-botpromotionmessagemetadata)
251. [Class: BotPromptSuggestion](#class-botpromptsuggestion)
252. [Class: BotPromptSuggestions](#class-botpromptsuggestions)
253. [Class: BotQuotaMetadata](#class-botquotametadata)
254. [Class: BotReminderMetadata](#class-botremindermetadata)
255. [Class: BotRenderingMetadata](#class-botrenderingmetadata)
256. [Class: BotSessionMetadata](#class-botsessionmetadata)
257. [Class: BotSignatureVerificationMetadata](#class-botsignatureverificationmetadata)
258. [Class: BotSignatureVerificationUseCaseProof](#class-botsignatureverificationusecaseproof)
259. [Class: BotSourcesMetadata](#class-botsourcesmetadata)
260. [Class: BotSuggestedPromptMetadata](#class-botsuggestedpromptmetadata)
261. [Class: BotUnifiedResponseMutation](#class-botunifiedresponsemutation)
262. [Class: CallLogRecord](#class-calllogrecord)
263. [Class: CertChain](#class-certchain)
264. [Class: ChatLockSettings](#class-chatlocksettings)
265. [Class: ChatRowOpaqueData](#class-chatrowopaquedata)
266. [Class: Citation](#class-citation)
267. [Class: ClientPairingProps](#class-clientpairingprops)
268. [Class: ClientPayload](#class-clientpayload)
269. [Class: CommentMetadata](#class-commentmetadata)
270. [Class: CompanionCommitment](#class-companioncommitment)
271. [Class: CompanionEphemeralIdentity](#class-companionephemeralidentity)
272. [Class: Config](#class-config)
273. [Class: ContextInfo](#class-contextinfo)
274. [Class: Conversation](#class-conversation)
275. [Class: DeviceCapabilities](#class-devicecapabilities)
276. [Class: DeviceConsistencyCodeMessage](#class-deviceconsistencycodemessage)
277. [Class: DeviceListMetadata](#class-devicelistmetadata)
278. [Class: DeviceProps](#class-deviceprops)
279. [Class: DisappearingMode](#class-disappearingmode)
280. [Class: EmbeddedContent](#class-embeddedcontent)
281. [Class: EmbeddedMessage](#class-embeddedmessage)
282. [Class: EmbeddedMusic](#class-embeddedmusic)
283. [Class: EncryptedPairingRequest](#class-encryptedpairingrequest)
284. [Class: EphemeralSetting](#class-ephemeralsetting)
285. [Class: EventAdditionalMetadata](#class-eventadditionalmetadata)
286. [Class: EventResponse](#class-eventresponse)
287. [Class: ExitCode](#class-exitcode)
288. [Class: ExternalBlobReference](#class-externalblobreference)
289. [Class: Field](#class-field)
290. [Class: ForwardedAIBotMessageInfo](#class-forwardedaibotmessageinfo)
291. [Class: GlobalSettings](#class-globalsettings)
292. [Class: GroupHistoryBundleInfo](#class-grouphistorybundleinfo)
293. [Class: GroupHistoryIndividualMessageInfo](#class-grouphistoryindividualmessageinfo)
294. [Class: GroupMention](#class-groupmention)
295. [Class: GroupParticipant](#class-groupparticipant)
296. [Class: HandshakeMessage](#class-handshakemessage)
297. [Class: HistorySync](#class-historysync)
298. [Class: HistorySyncMsg](#class-historysyncmsg)
299. [Class: HydratedTemplateButton](#class-hydratedtemplatebutton)
300. [Class: IdentityKeyPairStructure](#class-identitykeypairstructure)
301. [Class: InThreadSurveyMetadata](#class-inthreadsurveymetadata)
302. [Class: InteractiveAnnotation](#class-interactiveannotation)
303. [Class: InteractiveMessageAdditionalMetadata](#class-interactivemessageadditionalmetadata)
304. [Class: KeepInChat](#class-keepinchat)
305. [Class: KeyExchangeMessage](#class-keyexchangemessage)
306. [Class: KeyId](#class-keyid)
307. [Class: LIDMigrationMapping](#class-lidmigrationmapping)
308. [Class: LIDMigrationMappingSyncMessage](#class-lidmigrationmappingsyncmessage)
309. [Class: LIDMigrationMappingSyncPayload](#class-lidmigrationmappingsyncpayload)
310. [Class: LegacyMessage](#class-legacymessage)
311. [Class: LimitSharing](#class-limitsharing)
312. [Class: LocalizedName](#class-localizedname)
313. [Class: Location](#class-location)
314. [Class: MediaData](#class-mediadata)
315. [Class: MediaNotifyMessage](#class-medianotifymessage)
316. [Class: MediaRetryNotification](#class-mediaretrynotification)
317. [Class: MemberLabel](#class-memberlabel)
318. [Class: Message](#class-message)
319. [Class: MessageAddOn](#class-messageaddon)
320. [Class: MessageAddOnContextInfo](#class-messageaddoncontextinfo)
321. [Class: MessageAssociation](#class-messageassociation)
322. [Class: MessageContextInfo](#class-messagecontextinfo)
323. [Class: MessageKey](#class-messagekey)
324. [Class: MessageSecretMessage](#class-messagesecretmessage)
325. [Class: Money](#class-money)
326. [Class: MsgOpaqueData](#class-msgopaquedata)
327. [Class: MsgRowOpaqueData](#class-msgrowopaquedata)
328. [Class: NoiseCertificate](#class-noisecertificate)
329. [Class: NotificationMessageInfo](#class-notificationmessageinfo)
330. [Class: NotificationSettings](#class-notificationsettings)
331. [Class: PairingRequest](#class-pairingrequest)
332. [Class: PastParticipant](#class-pastparticipant)
333. [Class: PastParticipants](#class-pastparticipants)
334. [Class: PatchDebugData](#class-patchdebugdata)
335. [Class: PaymentBackground](#class-paymentbackground)
336. [Class: PaymentInfo](#class-paymentinfo)
337. [Class: PhoneNumberToLIDMapping](#class-phonenumbertolidmapping)
338. [Class: PhotoChange](#class-photochange)
339. [Class: PinInChat](#class-pininchat)
340. [Class: Point](#class-point)
341. [Class: PollAdditionalMetadata](#class-polladditionalmetadata)
342. [Class: PollEncValue](#class-pollencvalue)
343. [Class: PollUpdate](#class-pollupdate)
344. [Class: PreKeyRecordStructure](#class-prekeyrecordstructure)
345. [Class: PreKeySignalMessage](#class-prekeysignalmessage)
346. [Class: PremiumMessageInfo](#class-premiummessageinfo)
347. [Class: PrimaryEphemeralIdentity](#class-primaryephemeralidentity)
348. [Class: ProcessedVideo](#class-processedvideo)
349. [Class: ProloguePayload](#class-prologuepayload)
350. [Class: Pushname](#class-pushname)
351. [Class: QuarantinedMessage](#class-quarantinedmessage)
352. [Class: Reaction](#class-reaction)
353. [Class: RecentEmojiWeight](#class-recentemojiweight)
354. [Class: RecordStructure](#class-recordstructure)
355. [Class: Reportable](#class-reportable)
356. [Class: ReportingTokenInfo](#class-reportingtokeninfo)
357. [Class: SenderKeyDistributionMessage](#class-senderkeydistributionmessage)
358. [Class: SenderKeyMessage](#class-senderkeymessage)
359. [Class: SenderKeyRecordStructure](#class-senderkeyrecordstructure)
360. [Class: SenderKeyStateStructure](#class-senderkeystatestructure)
361. [Class: ServerErrorReceipt](#class-servererrorreceipt)
362. [Class: SessionStructure](#class-sessionstructure)
363. [Class: SessionTransparencyMetadata](#class-sessiontransparencymetadata)
364. [Class: SignalMessage](#class-signalmessage)
365. [Class: SignedPreKeyRecordStructure](#class-signedprekeyrecordstructure)
366. [Class: StatusAttribution](#class-statusattribution)
367. [Class: StatusMentionMessage](#class-statusmentionmessage)
368. [Class: StatusPSA](#class-statuspsa)
369. [Class: StickerMetadata](#class-stickermetadata)
370. [Class: SyncActionData](#class-syncactiondata)
371. [Class: SyncActionValue](#class-syncactionvalue)
372. [Class: SyncdIndex](#class-syncdindex)
373. [Class: SyncdMutation](#class-syncdmutation)
374. [Class: SyncdMutations](#class-syncdmutations)
375. [Class: SyncdPatch](#class-syncdpatch)
376. [Class: SyncdRecord](#class-syncdrecord)
377. [Class: SyncdSnapshot](#class-syncdsnapshot)
378. [Class: SyncdValue](#class-syncdvalue)
379. [Class: SyncdVersion](#class-syncdversion)
380. [Class: TapLinkAction](#class-taplinkaction)
381. [Class: TemplateButton](#class-templatebutton)
382. [Class: ThreadID](#class-threadid)
383. [Class: UrlTrackingMap](#class-urltrackingmap)
384. [Class: UserPassword](#class-userpassword)
385. [Class: UserReceipt](#class-userreceipt)
386. [Class: VerifiedNameCertificate](#class-verifiednamecertificate)
387. [Class: WallpaperSettings](#class-wallpapersettings)
388. [Class: WebFeatures](#class-webfeatures)
389. [Class: WebMessageInfo](#class-webmessageinfo)
390. [Class: WebNotificationsInfo](#class-webnotificationsinfo)
391. [Enumeration: ADVEncryptionType](#enumeration-advencryptiontype)
392. [Enumeration: AIRichResponseMessageType](#enumeration-airichresponsemessagetype)
393. [Enumeration: AIRichResponseSubMessageType](#enumeration-airichresponsesubmessagetype)
394. [Enumeration: BotMetricsEntryPoint](#enumeration-botmetricsentrypoint)
395. [Enumeration: BotMetricsThreadEntryPoint](#enumeration-botmetricsthreadentrypoint)
396. [Enumeration: BotSessionSource](#enumeration-botsessionsource)
397. [Enumeration: CollectionName](#enumeration-collectionname)
398. [Enumeration: KeepType](#enumeration-keeptype)
399. [Enumeration: MediaVisibility](#enumeration-mediavisibility)
400. [Enumeration: MutationProps](#enumeration-mutationprops)
401. [Enumeration: PrivacySystemMessage](#enumeration-privacysystemmessage)
402. [Enumeration: SessionTransparencyType](#enumeration-sessiontransparencytype)
403. [Enumeration: WebLinkRenderConfig](#enumeration-weblinkrenderconfig)
404. [Interface: IADVDeviceIdentity](#interface-iadvdeviceidentity)
405. [Interface: IADVKeyIndexList](#interface-iadvkeyindexlist)
406. [Interface: IADVSignedDeviceIdentity](#interface-iadvsigneddeviceidentity)
407. [Interface: IADVSignedDeviceIdentityHMAC](#interface-iadvsigneddeviceidentityhmac)
408. [Interface: IADVSignedKeyIndexList](#interface-iadvsignedkeyindexlist)
409. [Interface: IAIHomeState](#interface-iaihomestate)
410. [Interface: IAIQueryFanout](#interface-iaiqueryfanout)
411. [Interface: IAIRegenerateMetadata](#interface-iairegeneratemetadata)
412. [Interface: IAIRichResponseCodeMetadata](#interface-iairichresponsecodemetadata)
413. [Interface: IAIRichResponseContentItemsMetadata](#interface-iairichresponsecontentitemsmetadata)
414. [Interface: IAIRichResponseDynamicMetadata](#interface-iairichresponsedynamicmetadata)
415. [Interface: IAIRichResponseGridImageMetadata](#interface-iairichresponsegridimagemetadata)
416. [Interface: IAIRichResponseImageURL](#interface-iairichresponseimageurl)
417. [Interface: IAIRichResponseInlineImageMetadata](#interface-iairichresponseinlineimagemetadata)
418. [Interface: IAIRichResponseLatexMetadata](#interface-iairichresponselatexmetadata)
419. [Interface: IAIRichResponseMapMetadata](#interface-iairichresponsemapmetadata)
420. [Interface: IAIRichResponseMessage](#interface-iairichresponsemessage)
421. [Interface: IAIRichResponseSubMessage](#interface-iairichresponsesubmessage)
422. [Interface: IAIRichResponseTableMetadata](#interface-iairichresponsetablemetadata)
423. [Interface: IAIRichResponseUnifiedResponse](#interface-iairichresponseunifiedresponse)
424. [Interface: IAIThreadInfo](#interface-iaithreadinfo)
425. [Interface: IAccount](#interface-iaccount)
426. [Interface: IActionLink](#interface-iactionlink)
427. [Interface: IAutoDownloadSettings](#interface-iautodownloadsettings)
428. [Interface: IAvatarUserSettings](#interface-iavatarusersettings)
429. [Interface: IBizAccountLinkInfo](#interface-ibizaccountlinkinfo)
430. [Interface: IBizAccountPayload](#interface-ibizaccountpayload)
431. [Interface: IBizIdentityInfo](#interface-ibizidentityinfo)
432. [Interface: IBotAgeCollectionMetadata](#interface-ibotagecollectionmetadata)
433. [Interface: IBotAvatarMetadata](#interface-ibotavatarmetadata)
434. [Interface: IBotCapabilityMetadata](#interface-ibotcapabilitymetadata)
435. [Interface: IBotFeedbackMessage](#interface-ibotfeedbackmessage)
436. [Interface: IBotImagineMetadata](#interface-ibotimaginemetadata)
437. [Interface: IBotLinkedAccount](#interface-ibotlinkedaccount)
438. [Interface: IBotLinkedAccountsMetadata](#interface-ibotlinkedaccountsmetadata)
439. [Interface: IBotMediaMetadata](#interface-ibotmediametadata)
440. [Interface: IBotMemoryFact](#interface-ibotmemoryfact)
441. [Interface: IBotMemoryMetadata](#interface-ibotmemorymetadata)
442. [Interface: IBotMemuMetadata](#interface-ibotmemumetadata)
443. [Interface: IBotMessageOrigin](#interface-ibotmessageorigin)
444. [Interface: IBotMessageOriginMetadata](#interface-ibotmessageoriginmetadata)
445. [Interface: IBotMessageSharingInfo](#interface-ibotmessagesharinginfo)
446. [Interface: IBotMetadata](#interface-ibotmetadata)
447. [Interface: IBotMetricsMetadata](#interface-ibotmetricsmetadata)
448. [Interface: IBotModeSelectionMetadata](#interface-ibotmodeselectionmetadata)
449. [Interface: IBotModelMetadata](#interface-ibotmodelmetadata)
450. [Interface: IBotPluginMetadata](#interface-ibotpluginmetadata)
451. [Interface: IBotProgressIndicatorMetadata](#interface-ibotprogressindicatormetadata)
452. [Interface: IBotPromotionMessageMetadata](#interface-ibotpromotionmessagemetadata)
453. [Interface: IBotPromptSuggestion](#interface-ibotpromptsuggestion)
454. [Interface: IBotPromptSuggestions](#interface-ibotpromptsuggestions)
455. [Interface: IBotQuotaMetadata](#interface-ibotquotametadata)
456. [Interface: IBotReminderMetadata](#interface-ibotremindermetadata)
457. [Interface: IBotRenderingMetadata](#interface-ibotrenderingmetadata)
458. [Interface: IBotSessionMetadata](#interface-ibotsessionmetadata)
459. [Interface: IBotSignatureVerificationMetadata](#interface-ibotsignatureverificationmetadata)
460. [Interface: IBotSignatureVerificationUseCaseProof](#interface-ibotsignatureverificationusecaseproof)
461. [Interface: IBotSourcesMetadata](#interface-ibotsourcesmetadata)
462. [Interface: IBotSuggestedPromptMetadata](#interface-ibotsuggestedpromptmetadata)
463. [Interface: IBotUnifiedResponseMutation](#interface-ibotunifiedresponsemutation)
464. [Interface: ICallLogRecord](#interface-icalllogrecord)
465. [Interface: ICertChain](#interface-icertchain)
466. [Interface: IChatLockSettings](#interface-ichatlocksettings)
467. [Interface: IChatRowOpaqueData](#interface-ichatrowopaquedata)
468. [Interface: ICitation](#interface-icitation)
469. [Interface: IClientPairingProps](#interface-iclientpairingprops)
470. [Interface: IClientPayload](#interface-iclientpayload)
471. [Interface: ICommentMetadata](#interface-icommentmetadata)
472. [Interface: ICompanionCommitment](#interface-icompanioncommitment)
473. [Interface: ICompanionEphemeralIdentity](#interface-icompanionephemeralidentity)
474. [Interface: IConfig](#interface-iconfig)
475. [Interface: IContextInfo](#interface-icontextinfo)
476. [Interface: IConversation](#interface-iconversation)
477. [Interface: IDeviceCapabilities](#interface-idevicecapabilities)
478. [Interface: IDeviceConsistencyCodeMessage](#interface-ideviceconsistencycodemessage)
479. [Interface: IDeviceListMetadata](#interface-idevicelistmetadata)
480. [Interface: IDeviceProps](#interface-ideviceprops)
481. [Interface: IDisappearingMode](#interface-idisappearingmode)
482. [Interface: IEmbeddedContent](#interface-iembeddedcontent)
483. [Interface: IEmbeddedMessage](#interface-iembeddedmessage)
484. [Interface: IEmbeddedMusic](#interface-iembeddedmusic)
485. [Interface: IEncryptedPairingRequest](#interface-iencryptedpairingrequest)
486. [Interface: IEphemeralSetting](#interface-iephemeralsetting)
487. [Interface: IEventAdditionalMetadata](#interface-ieventadditionalmetadata)
488. [Interface: IEventResponse](#interface-ieventresponse)
489. [Interface: IExitCode](#interface-iexitcode)
490. [Interface: IExternalBlobReference](#interface-iexternalblobreference)
491. [Interface: IField](#interface-ifield)
492. [Interface: IForwardedAIBotMessageInfo](#interface-iforwardedaibotmessageinfo)
493. [Interface: IGlobalSettings](#interface-iglobalsettings)
494. [Interface: IGroupHistoryBundleInfo](#interface-igrouphistorybundleinfo)
495. [Interface: IGroupHistoryIndividualMessageInfo](#interface-igrouphistoryindividualmessageinfo)
496. [Interface: IGroupMention](#interface-igroupmention)
497. [Interface: IGroupParticipant](#interface-igroupparticipant)
498. [Interface: IHandshakeMessage](#interface-ihandshakemessage)
499. [Interface: IHistorySync](#interface-ihistorysync)
500. [Interface: IHistorySyncMsg](#interface-ihistorysyncmsg)
501. [Interface: IHydratedTemplateButton](#interface-ihydratedtemplatebutton)
502. [Interface: IIdentityKeyPairStructure](#interface-iidentitykeypairstructure)
503. [Interface: IInThreadSurveyMetadata](#interface-iinthreadsurveymetadata)
504. [Interface: IInteractiveAnnotation](#interface-iinteractiveannotation)
505. [Interface: IInteractiveMessageAdditionalMetadata](#interface-iinteractivemessageadditionalmetadata)
506. [Interface: IKeepInChat](#interface-ikeepinchat)
507. [Interface: IKeyExchangeMessage](#interface-ikeyexchangemessage)
508. [Interface: IKeyId](#interface-ikeyid)
509. [Interface: ILIDMigrationMapping](#interface-ilidmigrationmapping)
510. [Interface: ILIDMigrationMappingSyncMessage](#interface-ilidmigrationmappingsyncmessage)
511. [Interface: ILIDMigrationMappingSyncPayload](#interface-ilidmigrationmappingsyncpayload)
512. [Interface: ILegacyMessage](#interface-ilegacymessage)
513. [Interface: ILimitSharing](#interface-ilimitsharing)
514. [Interface: ILocalizedName](#interface-ilocalizedname)
515. [Interface: ILocation](#interface-ilocation)
516. [Interface: IMediaData](#interface-imediadata)
517. [Interface: IMediaNotifyMessage](#interface-imedianotifymessage)
518. [Interface: IMediaRetryNotification](#interface-imediaretrynotification)
519. [Interface: IMemberLabel](#interface-imemberlabel)
520. [Interface: IMessage](#interface-imessage)
521. [Interface: IMessageAddOn](#interface-imessageaddon)
522. [Interface: IMessageAddOnContextInfo](#interface-imessageaddoncontextinfo)
523. [Interface: IMessageAssociation](#interface-imessageassociation)
524. [Interface: IMessageContextInfo](#interface-imessagecontextinfo)
525. [Interface: IMessageKey](#interface-imessagekey)
526. [Interface: IMessageSecretMessage](#interface-imessagesecretmessage)
527. [Interface: IMoney](#interface-imoney)
528. [Interface: IMsgOpaqueData](#interface-imsgopaquedata)
529. [Interface: IMsgRowOpaqueData](#interface-imsgrowopaquedata)
530. [Interface: INoiseCertificate](#interface-inoisecertificate)
531. [Interface: INotificationMessageInfo](#interface-inotificationmessageinfo)
532. [Interface: INotificationSettings](#interface-inotificationsettings)
533. [Interface: IPairingRequest](#interface-ipairingrequest)
534. [Interface: IPastParticipant](#interface-ipastparticipant)
535. [Interface: IPastParticipants](#interface-ipastparticipants)
536. [Interface: IPatchDebugData](#interface-ipatchdebugdata)
537. [Interface: IPaymentBackground](#interface-ipaymentbackground)
538. [Interface: IPaymentInfo](#interface-ipaymentinfo)
539. [Interface: IPhoneNumberToLIDMapping](#interface-iphonenumbertolidmapping)
540. [Interface: IPhotoChange](#interface-iphotochange)
541. [Interface: IPinInChat](#interface-ipininchat)
542. [Interface: IPoint](#interface-ipoint)
543. [Interface: IPollAdditionalMetadata](#interface-ipolladditionalmetadata)
544. [Interface: IPollEncValue](#interface-ipollencvalue)
545. [Interface: IPollUpdate](#interface-ipollupdate)
546. [Interface: IPreKeyRecordStructure](#interface-iprekeyrecordstructure)
547. [Interface: IPreKeySignalMessage](#interface-iprekeysignalmessage)
548. [Interface: IPremiumMessageInfo](#interface-ipremiummessageinfo)
549. [Interface: IPrimaryEphemeralIdentity](#interface-iprimaryephemeralidentity)
550. [Interface: IProcessedVideo](#interface-iprocessedvideo)
551. [Interface: IProloguePayload](#interface-iprologuepayload)
552. [Interface: IPushname](#interface-ipushname)
553. [Interface: IQuarantinedMessage](#interface-iquarantinedmessage)
554. [Interface: IReaction](#interface-ireaction)
555. [Interface: IRecentEmojiWeight](#interface-irecentemojiweight)
556. [Interface: IRecordStructure](#interface-irecordstructure)
557. [Interface: IReportable](#interface-ireportable)
558. [Interface: IReportingTokenInfo](#interface-ireportingtokeninfo)
559. [Interface: ISenderKeyDistributionMessage](#interface-isenderkeydistributionmessage)
560. [Interface: ISenderKeyMessage](#interface-isenderkeymessage)
561. [Interface: ISenderKeyRecordStructure](#interface-isenderkeyrecordstructure)
562. [Interface: ISenderKeyStateStructure](#interface-isenderkeystatestructure)
563. [Interface: IServerErrorReceipt](#interface-iservererrorreceipt)
564. [Interface: ISessionStructure](#interface-isessionstructure)
565. [Interface: ISessionTransparencyMetadata](#interface-isessiontransparencymetadata)
566. [Interface: ISignalMessage](#interface-isignalmessage)
567. [Interface: ISignedPreKeyRecordStructure](#interface-isignedprekeyrecordstructure)
568. [Interface: IStatusAttribution](#interface-istatusattribution)
569. [Interface: IStatusMentionMessage](#interface-istatusmentionmessage)
570. [Interface: IStatusPSA](#interface-istatuspsa)
571. [Interface: IStickerMetadata](#interface-istickermetadata)
572. [Interface: ISyncActionData](#interface-isyncactiondata)
573. [Interface: ISyncActionValue](#interface-isyncactionvalue)
574. [Interface: ISyncdIndex](#interface-isyncdindex)
575. [Interface: ISyncdMutation](#interface-isyncdmutation)
576. [Interface: ISyncdMutations](#interface-isyncdmutations)
577. [Interface: ISyncdPatch](#interface-isyncdpatch)
578. [Interface: ISyncdRecord](#interface-isyncdrecord)
579. [Interface: ISyncdSnapshot](#interface-isyncdsnapshot)
580. [Interface: ISyncdValue](#interface-isyncdvalue)
581. [Interface: ISyncdVersion](#interface-isyncdversion)
582. [Interface: ITapLinkAction](#interface-itaplinkaction)
583. [Interface: ITemplateButton](#interface-itemplatebutton)
584. [Interface: IThreadID](#interface-ithreadid)
585. [Interface: IUrlTrackingMap](#interface-iurltrackingmap)
586. [Interface: IUserPassword](#interface-iuserpassword)
587. [Interface: IUserReceipt](#interface-iuserreceipt)
588. [Interface: IVerifiedNameCertificate](#interface-iverifiednamecertificate)
589. [Interface: IWallpaperSettings](#interface-iwallpapersettings)
590. [Interface: IWebFeatures](#interface-iwebfeatures)
591. [Interface: IWebMessageInfo](#interface-iwebmessageinfo)
592. [Interface: IWebNotificationsInfo](#interface-iwebnotificationsinfo)
593. [AIHomeState](#aihomestate)
594. [Class: AIHomeOption](#class-aihomeoption)
595. [Interface: IAIHomeOption](#interface-iaihomeoption)
596. [AIHomeOption](#aihomeoption)
597. [Enumeration: AIHomeActionType](#enumeration-aihomeactiontype)
598. [AIRichResponseCodeMetadata](#airichresponsecodemetadata)
599. [Class: AIRichResponseCodeBlock](#class-airichresponsecodeblock)
600. [Enumeration: AIRichResponseCodeHighlightType](#enumeration-airichresponsecodehighlighttype)
601. [Interface: IAIRichResponseCodeBlock](#interface-iairichresponsecodeblock)
602. [AIRichResponseContentItemsMetadata](#airichresponsecontentitemsmetadata)
603. [Class: AIRichResponseContentItemMetadata](#class-airichresponsecontentitemmetadata)
604. [Class: AIRichResponseReelItem](#class-airichresponsereelitem)
605. [Enumeration: ContentType](#enumeration-contenttype)
606. [Interface: IAIRichResponseContentItemMetadata](#interface-iairichresponsecontentitemmetadata)
607. [Interface: IAIRichResponseReelItem](#interface-iairichresponsereelitem)
608. [AIRichResponseDynamicMetadata](#airichresponsedynamicmetadata)
609. [Enumeration: AIRichResponseDynamicMetadataType](#enumeration-airichresponsedynamicmetadatatype)
610. [AIRichResponseInlineImageMetadata](#airichresponseinlineimagemetadata)
611. [Enumeration: AIRichResponseImageAlignment](#enumeration-airichresponseimagealignment)
612. [AIRichResponseLatexMetadata](#airichresponselatexmetadata)
613. [Class: AIRichResponseLatexExpression](#class-airichresponselatexexpression)
614. [Interface: IAIRichResponseLatexExpression](#interface-iairichresponselatexexpression)
615. [AIRichResponseMapMetadata](#airichresponsemapmetadata)
616. [Class: AIRichResponseMapAnnotation](#class-airichresponsemapannotation)
617. [Interface: IAIRichResponseMapAnnotation](#interface-iairichresponsemapannotation)
618. [AIRichResponseTableMetadata](#airichresponsetablemetadata)
619. [Class: AIRichResponseTableRow](#class-airichresponsetablerow)
620. [Interface: IAIRichResponseTableRow](#interface-iairichresponsetablerow)
621. [AIThreadInfo](#aithreadinfo)
622. [Class: AIThreadClientInfo](#class-aithreadclientinfo)
623. [Class: AIThreadServerInfo](#class-aithreadserverinfo)
624. [Interface: IAIThreadClientInfo](#interface-iaithreadclientinfo)
625. [Interface: IAIThreadServerInfo](#interface-iaithreadserverinfo)
626. [AIThreadClientInfo](#aithreadclientinfo)
627. [Enumeration: AIThreadType](#enumeration-aithreadtype)
628. [BizAccountLinkInfo](#bizaccountlinkinfo)
629. [Enumeration: AccountType](#enumeration-accounttype)
630. [Enumeration: HostStorageType](#enumeration-hoststoragetype)
631. [BizIdentityInfo](#bizidentityinfo)
632. [Enumeration: ActualActorsType](#enumeration-actualactorstype)
633. [Enumeration: HostStorageType](#enumeration-hoststoragetype)
634. [Enumeration: VerifiedLevelValue](#enumeration-verifiedlevelvalue)
635. [BotAgeCollectionMetadata](#botagecollectionmetadata)
636. [Enumeration: AgeCollectionType](#enumeration-agecollectiontype)
637. [BotCapabilityMetadata](#botcapabilitymetadata)
638. [Enumeration: BotCapabilityType](#enumeration-botcapabilitytype)
639. [BotFeedbackMessage](#botfeedbackmessage)
640. [Class: SideBySideSurveyMetadata](#class-sidebysidesurveymetadata)
641. [Enumeration: BotFeedbackKind](#enumeration-botfeedbackkind)
642. [Enumeration: BotFeedbackKindMultipleNegative](#enumeration-botfeedbackkindmultiplenegative)
643. [Enumeration: BotFeedbackKindMultiplePositive](#enumeration-botfeedbackkindmultiplepositive)
644. [Enumeration: ReportKind](#enumeration-reportkind)
645. [Interface: ISideBySideSurveyMetadata](#interface-isidebysidesurveymetadata)
646. [SideBySideSurveyMetadata](#sidebysidesurveymetadata)
647. [Class: SideBySideSurveyAnalyticsData](#class-sidebysidesurveyanalyticsdata)
648. [Class: SidebySideSurveyMetaAiAnalyticsData](#class-sidebysidesurveymetaaianalyticsdata)
649. [Interface: ISideBySideSurveyAnalyticsData](#interface-isidebysidesurveyanalyticsdata)
650. [Interface: ISidebySideSurveyMetaAiAnalyticsData](#interface-isidebysidesurveymetaaianalyticsdata)
651. [SidebySideSurveyMetaAiAnalyticsData](#sidebysidesurveymetaaianalyticsdata)
652. [Class: SideBySideSurveyAbandonEventData](#class-sidebysidesurveyabandoneventdata)
653. [Class: SideBySideSurveyCTAClickEventData](#class-sidebysidesurveyctaclickeventdata)
654. [Class: SideBySideSurveyCTAImpressionEventData](#class-sidebysidesurveyctaimpressioneventdata)
655. [Class: SideBySideSurveyCardImpressionEventData](#class-sidebysidesurveycardimpressioneventdata)
656. [Class: SideBySideSurveyResponseEventData](#class-sidebysidesurveyresponseeventdata)
657. [Interface: ISideBySideSurveyAbandonEventData](#interface-isidebysidesurveyabandoneventdata)
658. [Interface: ISideBySideSurveyCTAClickEventData](#interface-isidebysidesurveyctaclickeventdata)
659. [Interface: ISideBySideSurveyCTAImpressionEventData](#interface-isidebysidesurveyctaimpressioneventdata)
660. [Interface: ISideBySideSurveyCardImpressionEventData](#interface-isidebysidesurveycardimpressioneventdata)
661. [Interface: ISideBySideSurveyResponseEventData](#interface-isidebysidesurveyresponseeventdata)
662. [BotImagineMetadata](#botimaginemetadata)
663. [Enumeration: ImagineType](#enumeration-imaginetype)
664. [BotLinkedAccount](#botlinkedaccount)
665. [Enumeration: BotLinkedAccountType](#enumeration-botlinkedaccounttype)
666. [BotMediaMetadata](#botmediametadata)
667. [Enumeration: OrientationType](#enumeration-orientationtype)
668. [BotMessageOrigin](#botmessageorigin)
669. [Enumeration: BotMessageOriginType](#enumeration-botmessageorigintype)
670. [BotModeSelectionMetadata](#botmodeselectionmetadata)
671. [Enumeration: BotUserSelectionMode](#enumeration-botuserselectionmode)
672. [BotModelMetadata](#botmodelmetadata)
673. [Enumeration: ModelType](#enumeration-modeltype)
674. [Enumeration: PremiumModelStatus](#enumeration-premiummodelstatus)
675. [BotPluginMetadata](#botpluginmetadata)
676. [Enumeration: PluginType](#enumeration-plugintype)
677. [Enumeration: SearchProvider](#enumeration-searchprovider)
678. [BotProgressIndicatorMetadata](#botprogressindicatormetadata)
679. [Class: BotPlanningStepMetadata](#class-botplanningstepmetadata)
680. [Interface: IBotPlanningStepMetadata](#interface-ibotplanningstepmetadata)
681. [BotPlanningStepMetadata](#botplanningstepmetadata)
682. [Class: BotPlanningSearchSourceMetadata](#class-botplanningsearchsourcemetadata)
683. [Class: BotPlanningSearchSourcesMetadata](#class-botplanningsearchsourcesmetadata)
684. [Class: BotPlanningStepSectionMetadata](#class-botplanningstepsectionmetadata)
685. [Enumeration: BotSearchSourceProvider](#enumeration-botsearchsourceprovider)
686. [Enumeration: PlanningStepStatus](#enumeration-planningstepstatus)
687. [Interface: IBotPlanningSearchSourceMetadata](#interface-ibotplanningsearchsourcemetadata)
688. [Interface: IBotPlanningSearchSourcesMetadata](#interface-ibotplanningsearchsourcesmetadata)
689. [Interface: IBotPlanningStepSectionMetadata](#interface-ibotplanningstepsectionmetadata)
690. [BotPlanningSearchSourcesMetadata](#botplanningsearchsourcesmetadata)
691. [Enumeration: BotPlanningSearchSourceProvider](#enumeration-botplanningsearchsourceprovider)
692. [BotPromotionMessageMetadata](#botpromotionmessagemetadata)
693. [Enumeration: BotPromotionType](#enumeration-botpromotiontype)
694. [BotQuotaMetadata](#botquotametadata)
695. [Class: BotFeatureQuotaMetadata](#class-botfeaturequotametadata)
696. [Interface: IBotFeatureQuotaMetadata](#interface-ibotfeaturequotametadata)
697. [BotFeatureQuotaMetadata](#botfeaturequotametadata)
698. [Enumeration: BotFeatureType](#enumeration-botfeaturetype)
699. [BotReminderMetadata](#botremindermetadata)
700. [Enumeration: ReminderAction](#enumeration-reminderaction)
701. [Enumeration: ReminderFrequency](#enumeration-reminderfrequency)
702. [BotRenderingMetadata](#botrenderingmetadata)
703. [Class: Keyword](#class-keyword)
704. [Interface: IKeyword](#interface-ikeyword)
705. [BotSignatureVerificationUseCaseProof](#botsignatureverificationusecaseproof)
706. [Enumeration: BotSignatureUseCase](#enumeration-botsignatureusecase)
707. [BotSourcesMetadata](#botsourcesmetadata)
708. [Class: BotSourceItem](#class-botsourceitem)
709. [Interface: IBotSourceItem](#interface-ibotsourceitem)
710. [BotSourceItem](#botsourceitem)
711. [Enumeration: SourceProvider](#enumeration-sourceprovider)
712. [BotUnifiedResponseMutation](#botunifiedresponsemutation)
713. [Class: MediaDetailsMetadata](#class-mediadetailsmetadata)
714. [Class: SideBySideMetadata](#class-sidebysidemetadata)
715. [Interface: IMediaDetailsMetadata](#interface-imediadetailsmetadata)
716. [Interface: ISideBySideMetadata](#interface-isidebysidemetadata)
717. [CallLogRecord](#calllogrecord)
718. [Class: ParticipantInfo](#class-participantinfo)
719. [Enumeration: CallResult](#enumeration-callresult)
720. [Enumeration: CallType](#enumeration-calltype)
721. [Enumeration: SilenceReason](#enumeration-silencereason)
722. [Interface: IParticipantInfo](#interface-iparticipantinfo)
723. [CertChain](#certchain)
724. [Class: NoiseCertificate](#class-noisecertificate)
725. [Interface: INoiseCertificate](#interface-inoisecertificate)
726. [NoiseCertificate](#noisecertificate)
727. [Class: Details](#class-details)
728. [Interface: IDetails](#interface-idetails)
729. [ChatRowOpaqueData](#chatrowopaquedata)
730. [Class: DraftMessage](#class-draftmessage)
731. [Interface: IDraftMessage](#interface-idraftmessage)
732. [DraftMessage](#draftmessage)
733. [Class: CtwaContextData](#class-ctwacontextdata)
734. [Class: CtwaContextLinkData](#class-ctwacontextlinkdata)
735. [Interface: ICtwaContextData](#interface-ictwacontextdata)
736. [Interface: ICtwaContextLinkData](#interface-ictwacontextlinkdata)
737. [CtwaContextData](#ctwacontextdata)
738. [Enumeration: ContextInfoExternalAdReplyInfoMediaType](#enumeration-contextinfoexternaladreplyinfomediatype)
739. [ClientPayload](#clientpayload)
740. [Class: DNSSource](#class-dnssource)
741. [Class: DevicePairingRegistrationData](#class-devicepairingregistrationdata)
742. [Class: InteropData](#class-interopdata)
743. [Class: UserAgent](#class-useragent)
744. [Class: WebInfo](#class-webinfo)
745. [Enumeration: AccountType](#enumeration-accounttype)
746. [Enumeration: ConnectReason](#enumeration-connectreason)
747. [Enumeration: ConnectType](#enumeration-connecttype)
748. [Enumeration: IOSAppExtension](#enumeration-iosappextension)
749. [Enumeration: Product](#enumeration-product)
750. [Enumeration: TrafficAnonymization](#enumeration-trafficanonymization)
751. [Interface: IDNSSource](#interface-idnssource)
752. [Interface: IDevicePairingRegistrationData](#interface-idevicepairingregistrationdata)
753. [Interface: IInteropData](#interface-iinteropdata)
754. [Interface: IUserAgent](#interface-iuseragent)
755. [Interface: IWebInfo](#interface-iwebinfo)
756. [DNSSource](#dnssource)
757. [Enumeration: DNSResolutionMethod](#enumeration-dnsresolutionmethod)
758. [UserAgent](#useragent)
759. [Class: AppVersion](#class-appversion)
760. [Enumeration: DeviceType](#enumeration-devicetype)
761. [Enumeration: Platform](#enumeration-platform)
762. [Enumeration: ReleaseChannel](#enumeration-releasechannel)
763. [Interface: IAppVersion](#interface-iappversion)
764. [WebInfo](#webinfo)
765. [Class: WebdPayload](#class-webdpayload)
766. [Enumeration: WebSubPlatform](#enumeration-websubplatform)
767. [Interface: IWebdPayload](#interface-iwebdpayload)
768. [ContextInfo](#contextinfo)
769. [Class: AdReplyInfo](#class-adreplyinfo)
770. [Class: BusinessMessageForwardInfo](#class-businessmessageforwardinfo)
771. [Class: DataSharingContext](#class-datasharingcontext)
772. [Class: ExternalAdReplyInfo](#class-externaladreplyinfo)
773. [Class: FeatureEligibilities](#class-featureeligibilities)
774. [Class: ForwardedNewsletterMessageInfo](#class-forwardednewslettermessageinfo)
775. [Class: QuestionReplyQuotedMessage](#class-questionreplyquotedmessage)
776. [Class: StatusAudienceMetadata](#class-statusaudiencemetadata)
777. [Class: UTMInfo](#class-utminfo)
778. [Enumeration: ForwardOrigin](#enumeration-forwardorigin)
779. [Enumeration: PairedMediaType](#enumeration-pairedmediatype)
780. [Enumeration: QuotedType](#enumeration-quotedtype)
781. [Enumeration: StatusAttributionType](#enumeration-statusattributiontype)
782. [Enumeration: StatusSourceType](#enumeration-statussourcetype)
783. [Interface: IAdReplyInfo](#interface-iadreplyinfo)
784. [Interface: IBusinessMessageForwardInfo](#interface-ibusinessmessageforwardinfo)
785. [Interface: IDataSharingContext](#interface-idatasharingcontext)
786. [Interface: IExternalAdReplyInfo](#interface-iexternaladreplyinfo)
787. [Interface: IFeatureEligibilities](#interface-ifeatureeligibilities)
788. [Interface: IForwardedNewsletterMessageInfo](#interface-iforwardednewslettermessageinfo)
789. [Interface: IQuestionReplyQuotedMessage](#interface-iquestionreplyquotedmessage)
790. [Interface: IStatusAudienceMetadata](#interface-istatusaudiencemetadata)
791. [Interface: IUTMInfo](#interface-iutminfo)
792. [AdReplyInfo](#adreplyinfo)
793. [Enumeration: MediaType](#enumeration-mediatype)
794. [DataSharingContext](#datasharingcontext)
795. [Class: Parameters](#class-parameters)
796. [Enumeration: DataSharingFlags](#enumeration-datasharingflags)
797. [Interface: IParameters](#interface-iparameters)
798. [ExternalAdReplyInfo](#externaladreplyinfo)
799. [Enumeration: AdType](#enumeration-adtype)
800. [Enumeration: MediaType](#enumeration-mediatype)
801. [ForwardedNewsletterMessageInfo](#forwardednewslettermessageinfo)
802. [Enumeration: ContentType](#enumeration-contenttype)
803. [StatusAudienceMetadata](#statusaudiencemetadata)
804. [Enumeration: AudienceType](#enumeration-audiencetype)
805. [Conversation](#conversation)
806. [Enumeration: EndOfHistoryTransferType](#enumeration-endofhistorytransfertype)
807. [DeviceCapabilities](#devicecapabilities)
808. [Class: BusinessBroadcast](#class-businessbroadcast)
809. [Class: LIDMigration](#class-lidmigration)
810. [Class: UserHasAvatar](#class-userhasavatar)
811. [Enumeration: ChatLockSupportLevel](#enumeration-chatlocksupportlevel)
812. [Enumeration: MemberNameTagPrimarySupport](#enumeration-membernametagprimarysupport)
813. [Interface: IBusinessBroadcast](#interface-ibusinessbroadcast)
814. [Interface: ILIDMigration](#interface-ilidmigration)
815. [Interface: IUserHasAvatar](#interface-iuserhasavatar)
816. [DeviceProps](#deviceprops)
817. [Class: AppVersion](#class-appversion)
818. [Class: HistorySyncConfig](#class-historysyncconfig)
819. [Enumeration: PlatformType](#enumeration-platformtype)
820. [Interface: IAppVersion](#interface-iappversion)
821. [Interface: IHistorySyncConfig](#interface-ihistorysyncconfig)
822. [DisappearingMode](#disappearingmode)
823. [Enumeration: Initiator](#enumeration-initiator)
824. [Enumeration: Trigger](#enumeration-trigger)
825. [GroupHistoryBundleInfo](#grouphistorybundleinfo)
826. [Enumeration: ProcessState](#enumeration-processstate)
827. [GroupParticipant](#groupparticipant)
828. [Enumeration: Rank](#enumeration-rank)
829. [HandshakeMessage](#handshakemessage)
830. [Class: ClientFinish](#class-clientfinish)
831. [Class: ClientHello](#class-clienthello)
832. [Class: ServerHello](#class-serverhello)
833. [Interface: IClientFinish](#interface-iclientfinish)
834. [Interface: IClientHello](#interface-iclienthello)
835. [Interface: IServerHello](#interface-iserverhello)
836. [HistorySync](#historysync)
837. [Enumeration: BotAIWaitListState](#enumeration-botaiwaitliststate)
838. [Enumeration: HistorySyncType](#enumeration-historysynctype)
839. [HydratedTemplateButton](#hydratedtemplatebutton)
840. [Class: HydratedCallButton](#class-hydratedcallbutton)
841. [Class: HydratedQuickReplyButton](#class-hydratedquickreplybutton)
842. [Class: HydratedURLButton](#class-hydratedurlbutton)
843. [Interface: IHydratedCallButton](#interface-ihydratedcallbutton)
844. [Interface: IHydratedQuickReplyButton](#interface-ihydratedquickreplybutton)
845. [Interface: IHydratedURLButton](#interface-ihydratedurlbutton)
846. [HydratedURLButton](#hydratedurlbutton)
847. [Enumeration: WebviewPresentationType](#enumeration-webviewpresentationtype)
848. [InThreadSurveyMetadata](#inthreadsurveymetadata)
849. [Class: InThreadSurveyOption](#class-inthreadsurveyoption)
850. [Class: InThreadSurveyPrivacyStatementPart](#class-inthreadsurveyprivacystatementpart)
851. [Class: InThreadSurveyQuestion](#class-inthreadsurveyquestion)
852. [Interface: IInThreadSurveyOption](#interface-iinthreadsurveyoption)
853. [Interface: IInThreadSurveyPrivacyStatementPart](#interface-iinthreadsurveyprivacystatementpart)
854. [Interface: IInThreadSurveyQuestion](#interface-iinthreadsurveyquestion)
855. [InteractiveAnnotation](#interactiveannotation)
856. [Enumeration: StatusLinkType](#enumeration-statuslinktype)
857. [LimitSharing](#limitsharing)
858. [Enumeration: TriggerType](#enumeration-triggertype)
859. [MediaRetryNotification](#mediaretrynotification)
860. [Enumeration: ResultType](#enumeration-resulttype)
861. [Message](#message)
862. [Class: AlbumMessage](#class-albummessage)
863. [Class: AppStateFatalExceptionNotification](#class-appstatefatalexceptionnotification)
864. [Class: AppStateSyncKey](#class-appstatesynckey)
865. [Class: AppStateSyncKeyData](#class-appstatesynckeydata)
866. [Class: AppStateSyncKeyFingerprint](#class-appstatesynckeyfingerprint)
867. [Class: AppStateSyncKeyId](#class-appstatesynckeyid)
868. [Class: AppStateSyncKeyRequest](#class-appstatesynckeyrequest)
869. [Class: AppStateSyncKeyShare](#class-appstatesynckeyshare)
870. [Class: AudioMessage](#class-audiomessage)
871. [Class: BCallMessage](#class-bcallmessage)
872. [Class: ButtonsMessage](#class-buttonsmessage)
873. [Class: ButtonsResponseMessage](#class-buttonsresponsemessage)
874. [Class: Call](#class-call)
875. [Class: CallLogMessage](#class-calllogmessage)
876. [Class: CancelPaymentRequestMessage](#class-cancelpaymentrequestmessage)
877. [Class: Chat](#class-chat)
878. [Class: CloudAPIThreadControlNotification](#class-cloudapithreadcontrolnotification)
879. [Class: CommentMessage](#class-commentmessage)
880. [Class: ContactMessage](#class-contactmessage)
881. [Class: ContactsArrayMessage](#class-contactsarraymessage)
882. [Class: DeclinePaymentRequestMessage](#class-declinepaymentrequestmessage)
883. [Class: DeviceSentMessage](#class-devicesentmessage)
884. [Class: DocumentMessage](#class-documentmessage)
885. [Class: EncCommentMessage](#class-enccommentmessage)
886. [Class: EncEventResponseMessage](#class-enceventresponsemessage)
887. [Class: EncReactionMessage](#class-encreactionmessage)
888. [Class: EventMessage](#class-eventmessage)
889. [Class: EventResponseMessage](#class-eventresponsemessage)
890. [Class: ExtendedTextMessage](#class-extendedtextmessage)
891. [Class: FullHistorySyncOnDemandRequestMetadata](#class-fullhistorysyncondemandrequestmetadata)
892. [Class: FutureProofMessage](#class-futureproofmessage)
893. [Class: GroupInviteMessage](#class-groupinvitemessage)
894. [Class: HighlyStructuredMessage](#class-highlystructuredmessage)
895. [Class: HistorySyncMessageAccessStatus](#class-historysyncmessageaccessstatus)
896. [Class: HistorySyncNotification](#class-historysyncnotification)
897. [Class: ImageMessage](#class-imagemessage)
898. [Class: InitialSecurityNotificationSettingSync](#class-initialsecuritynotificationsettingsync)
899. [Class: InteractiveMessage](#class-interactivemessage)
900. [Class: InteractiveResponseMessage](#class-interactiveresponsemessage)
901. [Class: InvoiceMessage](#class-invoicemessage)
902. [Class: KeepInChatMessage](#class-keepinchatmessage)
903. [Class: LinkPreviewMetadata](#class-linkpreviewmetadata)
904. [Class: ListMessage](#class-listmessage)
905. [Class: ListResponseMessage](#class-listresponsemessage)
906. [Class: LiveLocationMessage](#class-livelocationmessage)
907. [Class: LocationMessage](#class-locationmessage)
908. [Class: MMSThumbnailMetadata](#class-mmsthumbnailmetadata)
909. [Class: MessageHistoryBundle](#class-messagehistorybundle)
910. [Class: MessageHistoryMetadata](#class-messagehistorymetadata)
911. [Class: MessageHistoryNotice](#class-messagehistorynotice)
912. [Class: NewsletterAdminInviteMessage](#class-newsletteradmininvitemessage)
913. [Class: NewsletterFollowerInviteMessage](#class-newsletterfollowerinvitemessage)
914. [Class: OrderMessage](#class-ordermessage)
915. [Class: PaymentExtendedMetadata](#class-paymentextendedmetadata)
916. [Class: PaymentInviteMessage](#class-paymentinvitemessage)
917. [Class: PaymentLinkMetadata](#class-paymentlinkmetadata)
918. [Class: PeerDataOperationRequestMessage](#class-peerdataoperationrequestmessage)
919. [Class: PeerDataOperationRequestResponseMessage](#class-peerdataoperationrequestresponsemessage)
920. [Class: PinInChatMessage](#class-pininchatmessage)
921. [Class: PlaceholderMessage](#class-placeholdermessage)
922. [Class: PollCreationMessage](#class-pollcreationmessage)
923. [Class: PollEncValue](#class-pollencvalue)
924. [Class: PollResultSnapshotMessage](#class-pollresultsnapshotmessage)
925. [Class: PollUpdateMessage](#class-pollupdatemessage)
926. [Class: PollUpdateMessageMetadata](#class-pollupdatemessagemetadata)
927. [Class: PollVoteMessage](#class-pollvotemessage)
928. [Class: ProductMessage](#class-productmessage)
929. [Class: ProtocolMessage](#class-protocolmessage)
930. [Class: QuestionResponseMessage](#class-questionresponsemessage)
931. [Class: ReactionMessage](#class-reactionmessage)
932. [Class: RequestPaymentMessage](#class-requestpaymentmessage)
933. [Class: RequestPhoneNumberMessage](#class-requestphonenumbermessage)
934. [Class: RequestWelcomeMessageMetadata](#class-requestwelcomemessagemetadata)
935. [Class: ScheduledCallCreationMessage](#class-scheduledcallcreationmessage)
936. [Class: ScheduledCallEditMessage](#class-scheduledcalleditmessage)
937. [Class: SecretEncryptedMessage](#class-secretencryptedmessage)
938. [Class: SendPaymentMessage](#class-sendpaymentmessage)
939. [Class: SenderKeyDistributionMessage](#class-senderkeydistributionmessage)
940. [Class: StatusNotificationMessage](#class-statusnotificationmessage)
941. [Class: StatusQuestionAnswerMessage](#class-statusquestionanswermessage)
942. [Class: StatusQuotedMessage](#class-statusquotedmessage)
943. [Class: StatusStickerInteractionMessage](#class-statusstickerinteractionmessage)
944. [Class: StickerMessage](#class-stickermessage)
945. [Class: StickerPackMessage](#class-stickerpackmessage)
946. [Class: StickerSyncRMRMessage](#class-stickersyncrmrmessage)
947. [Class: TemplateButtonReplyMessage](#class-templatebuttonreplymessage)
948. [Class: TemplateMessage](#class-templatemessage)
949. [Class: URLMetadata](#class-urlmetadata)
950. [Class: VideoEndCard](#class-videoendcard)
951. [Class: VideoMessage](#class-videomessage)
952. [Enumeration: HistorySyncType](#enumeration-historysynctype)
953. [Enumeration: MediaKeyDomain](#enumeration-mediakeydomain)
954. [Enumeration: PeerDataOperationRequestType](#enumeration-peerdataoperationrequesttype)
955. [Enumeration: PollContentType](#enumeration-pollcontenttype)
956. [Enumeration: PollType](#enumeration-polltype)
957. [Interface: IAlbumMessage](#interface-ialbummessage)
958. [Interface: IAppStateFatalExceptionNotification](#interface-iappstatefatalexceptionnotification)
959. [Interface: IAppStateSyncKey](#interface-iappstatesynckey)
960. [Interface: IAppStateSyncKeyData](#interface-iappstatesynckeydata)
961. [Interface: IAppStateSyncKeyFingerprint](#interface-iappstatesynckeyfingerprint)
962. [Interface: IAppStateSyncKeyId](#interface-iappstatesynckeyid)
963. [Interface: IAppStateSyncKeyRequest](#interface-iappstatesynckeyrequest)
964. [Interface: IAppStateSyncKeyShare](#interface-iappstatesynckeyshare)
965. [Interface: IAudioMessage](#interface-iaudiomessage)
966. [Interface: IBCallMessage](#interface-ibcallmessage)
967. [Interface: IButtonsMessage](#interface-ibuttonsmessage)
968. [Interface: IButtonsResponseMessage](#interface-ibuttonsresponsemessage)
969. [Interface: ICall](#interface-icall)
970. [Interface: ICallLogMessage](#interface-icalllogmessage)
971. [Interface: ICancelPaymentRequestMessage](#interface-icancelpaymentrequestmessage)
972. [Interface: IChat](#interface-ichat)
973. [Interface: ICloudAPIThreadControlNotification](#interface-icloudapithreadcontrolnotification)
974. [Interface: ICommentMessage](#interface-icommentmessage)
975. [Interface: IContactMessage](#interface-icontactmessage)
976. [Interface: IContactsArrayMessage](#interface-icontactsarraymessage)
977. [Interface: IDeclinePaymentRequestMessage](#interface-ideclinepaymentrequestmessage)
978. [Interface: IDeviceSentMessage](#interface-idevicesentmessage)
979. [Interface: IDocumentMessage](#interface-idocumentmessage)
980. [Interface: IEncCommentMessage](#interface-ienccommentmessage)
981. [Interface: IEncEventResponseMessage](#interface-ienceventresponsemessage)
982. [Interface: IEncReactionMessage](#interface-iencreactionmessage)
983. [Interface: IEventMessage](#interface-ieventmessage)
984. [Interface: IEventResponseMessage](#interface-ieventresponsemessage)
985. [Interface: IExtendedTextMessage](#interface-iextendedtextmessage)
986. [Interface: IFullHistorySyncOnDemandRequestMetadata](#interface-ifullhistorysyncondemandrequestmetadata)
987. [Interface: IFutureProofMessage](#interface-ifutureproofmessage)
988. [Interface: IGroupInviteMessage](#interface-igroupinvitemessage)
989. [Interface: IHighlyStructuredMessage](#interface-ihighlystructuredmessage)
990. [Interface: IHistorySyncMessageAccessStatus](#interface-ihistorysyncmessageaccessstatus)
991. [Interface: IHistorySyncNotification](#interface-ihistorysyncnotification)
992. [Interface: IImageMessage](#interface-iimagemessage)
993. [Interface: IInitialSecurityNotificationSettingSync](#interface-iinitialsecuritynotificationsettingsync)
994. [Interface: IInteractiveMessage](#interface-iinteractivemessage)
995. [Interface: IInteractiveResponseMessage](#interface-iinteractiveresponsemessage)
996. [Interface: IInvoiceMessage](#interface-iinvoicemessage)
997. [Interface: IKeepInChatMessage](#interface-ikeepinchatmessage)
998. [Interface: ILinkPreviewMetadata](#interface-ilinkpreviewmetadata)
999. [Interface: IListMessage](#interface-ilistmessage)
1000. [Interface: IListResponseMessage](#interface-ilistresponsemessage)
1001. [Interface: ILiveLocationMessage](#interface-ilivelocationmessage)
1002. [Interface: ILocationMessage](#interface-ilocationmessage)
1003. [Interface: IMMSThumbnailMetadata](#interface-immsthumbnailmetadata)
1004. [Interface: IMessageHistoryBundle](#interface-imessagehistorybundle)
1005. [Interface: IMessageHistoryMetadata](#interface-imessagehistorymetadata)
1006. [Interface: IMessageHistoryNotice](#interface-imessagehistorynotice)
1007. [Interface: INewsletterAdminInviteMessage](#interface-inewsletteradmininvitemessage)
1008. [Interface: INewsletterFollowerInviteMessage](#interface-inewsletterfollowerinvitemessage)
1009. [Interface: IOrderMessage](#interface-iordermessage)
1010. [Interface: IPaymentExtendedMetadata](#interface-ipaymentextendedmetadata)
1011. [Interface: IPaymentInviteMessage](#interface-ipaymentinvitemessage)
1012. [Interface: IPaymentLinkMetadata](#interface-ipaymentlinkmetadata)
1013. [Interface: IPeerDataOperationRequestMessage](#interface-ipeerdataoperationrequestmessage)
1014. [Interface: IPeerDataOperationRequestResponseMessage](#interface-ipeerdataoperationrequestresponsemessage)
1015. [Interface: IPinInChatMessage](#interface-ipininchatmessage)
1016. [Interface: IPlaceholderMessage](#interface-iplaceholdermessage)
1017. [Interface: IPollCreationMessage](#interface-ipollcreationmessage)
1018. [Interface: IPollEncValue](#interface-ipollencvalue)
1019. [Interface: IPollResultSnapshotMessage](#interface-ipollresultsnapshotmessage)
1020. [Interface: IPollUpdateMessage](#interface-ipollupdatemessage)
1021. [Interface: IPollUpdateMessageMetadata](#interface-ipollupdatemessagemetadata)
1022. [Interface: IPollVoteMessage](#interface-ipollvotemessage)
1023. [Interface: IProductMessage](#interface-iproductmessage)
1024. [Interface: IProtocolMessage](#interface-iprotocolmessage)
1025. [Interface: IQuestionResponseMessage](#interface-iquestionresponsemessage)
1026. [Interface: IReactionMessage](#interface-ireactionmessage)
1027. [Interface: IRequestPaymentMessage](#interface-irequestpaymentmessage)
1028. [Interface: IRequestPhoneNumberMessage](#interface-irequestphonenumbermessage)
1029. [Interface: IRequestWelcomeMessageMetadata](#interface-irequestwelcomemessagemetadata)
1030. [Interface: IScheduledCallCreationMessage](#interface-ischeduledcallcreationmessage)
1031. [Interface: IScheduledCallEditMessage](#interface-ischeduledcalleditmessage)
1032. [Interface: ISecretEncryptedMessage](#interface-isecretencryptedmessage)
1033. [Interface: ISendPaymentMessage](#interface-isendpaymentmessage)
1034. [Interface: ISenderKeyDistributionMessage](#interface-isenderkeydistributionmessage)
1035. [Interface: IStatusNotificationMessage](#interface-istatusnotificationmessage)
1036. [Interface: IStatusQuestionAnswerMessage](#interface-istatusquestionanswermessage)
1037. [Interface: IStatusQuotedMessage](#interface-istatusquotedmessage)
1038. [Interface: IStatusStickerInteractionMessage](#interface-istatusstickerinteractionmessage)
1039. [Interface: IStickerMessage](#interface-istickermessage)
1040. [Interface: IStickerPackMessage](#interface-istickerpackmessage)
1041. [Interface: IStickerSyncRMRMessage](#interface-istickersyncrmrmessage)
1042. [Interface: ITemplateButtonReplyMessage](#interface-itemplatebuttonreplymessage)
1043. [Interface: ITemplateMessage](#interface-itemplatemessage)
1044. [Interface: IURLMetadata](#interface-iurlmetadata)
1045. [Interface: IVideoEndCard](#interface-ivideoendcard)
1046. [Interface: IVideoMessage](#interface-ivideomessage)
1047. [BCallMessage](#bcallmessage)
1048. [Enumeration: MediaType](#enumeration-mediatype)
1049. [ButtonsMessage](#buttonsmessage)
1050. [Class: Button](#class-button)
1051. [Enumeration: HeaderType](#enumeration-headertype)
1052. [Interface: IButton](#interface-ibutton)
1053. [Button](#button)
1054. [Class: ButtonText](#class-buttontext)
1055. [Class: NativeFlowInfo](#class-nativeflowinfo)
1056. [Enumeration: Type](#enumeration-type)
1057. [Interface: IButtonText](#interface-ibuttontext)
1058. [Interface: INativeFlowInfo](#interface-inativeflowinfo)
1059. [ButtonsResponseMessage](#buttonsresponsemessage)
1060. [Enumeration: Type](#enumeration-type)
1061. [CallLogMessage](#calllogmessage)
1062. [Class: CallParticipant](#class-callparticipant)
1063. [Enumeration: CallOutcome](#enumeration-calloutcome)
1064. [Enumeration: CallType](#enumeration-calltype)
1065. [Interface: ICallParticipant](#interface-icallparticipant)
1066. [CloudAPIThreadControlNotification](#cloudapithreadcontrolnotification)
1067. [Class: CloudAPIThreadControlNotificationContent](#class-cloudapithreadcontrolnotificationcontent)
1068. [Enumeration: CloudAPIThreadControl](#enumeration-cloudapithreadcontrol)
1069. [Interface: ICloudAPIThreadControlNotificationContent](#interface-icloudapithreadcontrolnotificationcontent)
1070. [EventResponseMessage](#eventresponsemessage)
1071. [Enumeration: EventResponseType](#enumeration-eventresponsetype)
1072. [ExtendedTextMessage](#extendedtextmessage)
1073. [Enumeration: FontType](#enumeration-fonttype)
1074. [Enumeration: InviteLinkGroupType](#enumeration-invitelinkgrouptype)
1075. [Enumeration: PreviewType](#enumeration-previewtype)
1076. [GroupInviteMessage](#groupinvitemessage)
1077. [Enumeration: GroupType](#enumeration-grouptype)
1078. [HighlyStructuredMessage](#highlystructuredmessage)
1079. [Class: HSMLocalizableParameter](#class-hsmlocalizableparameter)
1080. [Interface: IHSMLocalizableParameter](#interface-ihsmlocalizableparameter)
1081. [HSMLocalizableParameter](#hsmlocalizableparameter)
1082. [Class: HSMCurrency](#class-hsmcurrency)
1083. [Class: HSMDateTime](#class-hsmdatetime)
1084. [Interface: IHSMCurrency](#interface-ihsmcurrency)
1085. [Interface: IHSMDateTime](#interface-ihsmdatetime)
1086. [HSMDateTime](#hsmdatetime)
1087. [Class: HSMDateTimeComponent](#class-hsmdatetimecomponent)
1088. [Class: HSMDateTimeUnixEpoch](#class-hsmdatetimeunixepoch)
1089. [Interface: IHSMDateTimeComponent](#interface-ihsmdatetimecomponent)
1090. [Interface: IHSMDateTimeUnixEpoch](#interface-ihsmdatetimeunixepoch)
1091. [HSMDateTimeComponent](#hsmdatetimecomponent)
1092. [Enumeration: CalendarType](#enumeration-calendartype)
1093. [Enumeration: DayOfWeekType](#enumeration-dayofweektype)
1094. [ImageMessage](#imagemessage)
1095. [Enumeration: ImageSourceType](#enumeration-imagesourcetype)
1096. [InteractiveMessage](#interactivemessage)
1097. [Class: Body](#class-body)
1098. [Class: CarouselMessage](#class-carouselmessage)
1099. [Class: CollectionMessage](#class-collectionmessage)
1100. [Class: Footer](#class-footer)
1101. [Class: Header](#class-header)
1102. [Class: NativeFlowMessage](#class-nativeflowmessage)
1103. [Class: ShopMessage](#class-shopmessage)
1104. [Interface: IBody](#interface-ibody)
1105. [Interface: ICarouselMessage](#interface-icarouselmessage)
1106. [Interface: ICollectionMessage](#interface-icollectionmessage)
1107. [Interface: IFooter](#interface-ifooter)
1108. [Interface: IHeader](#interface-iheader)
1109. [Interface: INativeFlowMessage](#interface-inativeflowmessage)
1110. [Interface: IShopMessage](#interface-ishopmessage)
1111. [CarouselMessage](#carouselmessage)
1112. [Enumeration: CarouselCardType](#enumeration-carouselcardtype)
1113. [NativeFlowMessage](#nativeflowmessage)
1114. [Class: NativeFlowButton](#class-nativeflowbutton)
1115. [Interface: INativeFlowButton](#interface-inativeflowbutton)
1116. [ShopMessage](#shopmessage)
1117. [Enumeration: Surface](#enumeration-surface)
1118. [InteractiveResponseMessage](#interactiveresponsemessage)
1119. [Class: Body](#class-body)
1120. [Class: NativeFlowResponseMessage](#class-nativeflowresponsemessage)
1121. [Interface: IBody](#interface-ibody)
1122. [Interface: INativeFlowResponseMessage](#interface-inativeflowresponsemessage)
1123. [Body](#body)
1124. [Enumeration: Format](#enumeration-format)
1125. [InvoiceMessage](#invoicemessage)
1126. [Enumeration: AttachmentType](#enumeration-attachmenttype)
1127. [LinkPreviewMetadata](#linkpreviewmetadata)
1128. [Enumeration: SocialMediaPostType](#enumeration-socialmediaposttype)
1129. [ListMessage](#listmessage)
1130. [Class: Product](#class-product)
1131. [Class: ProductListHeaderImage](#class-productlistheaderimage)
1132. [Class: ProductListInfo](#class-productlistinfo)
1133. [Class: ProductSection](#class-productsection)
1134. [Class: Row](#class-row)
1135. [Class: Section](#class-section)
1136. [Enumeration: ListType](#enumeration-listtype)
1137. [Interface: IProduct](#interface-iproduct)
1138. [Interface: IProductListHeaderImage](#interface-iproductlistheaderimage)
1139. [Interface: IProductListInfo](#interface-iproductlistinfo)
1140. [Interface: IProductSection](#interface-iproductsection)
1141. [Interface: IRow](#interface-irow)
1142. [Interface: ISection](#interface-isection)
1143. [ListResponseMessage](#listresponsemessage)
1144. [Class: SingleSelectReply](#class-singleselectreply)
1145. [Enumeration: ListType](#enumeration-listtype)
1146. [Interface: ISingleSelectReply](#interface-isingleselectreply)
1147. [OrderMessage](#ordermessage)
1148. [Enumeration: OrderStatus](#enumeration-orderstatus)
1149. [Enumeration: OrderSurface](#enumeration-ordersurface)
1150. [PaymentInviteMessage](#paymentinvitemessage)
1151. [Enumeration: ServiceType](#enumeration-servicetype)
1152. [PaymentLinkMetadata](#paymentlinkmetadata)
1153. [Class: PaymentLinkButton](#class-paymentlinkbutton)
1154. [Class: PaymentLinkHeader](#class-paymentlinkheader)
1155. [Class: PaymentLinkProvider](#class-paymentlinkprovider)
1156. [Interface: IPaymentLinkButton](#interface-ipaymentlinkbutton)
1157. [Interface: IPaymentLinkHeader](#interface-ipaymentlinkheader)
1158. [Interface: IPaymentLinkProvider](#interface-ipaymentlinkprovider)
1159. [PaymentLinkHeader](#paymentlinkheader)
1160. [Enumeration: PaymentLinkHeaderType](#enumeration-paymentlinkheadertype)
1161. [PeerDataOperationRequestMessage](#peerdataoperationrequestmessage)
1162. [Class: FullHistorySyncOnDemandRequest](#class-fullhistorysyncondemandrequest)
1163. [Class: GalaxyFlowAction](#class-galaxyflowaction)
1164. [Class: HistorySyncChunkRetryRequest](#class-historysyncchunkretryrequest)
1165. [Class: HistorySyncOnDemandRequest](#class-historysyncondemandrequest)
1166. [Class: PlaceholderMessageResendRequest](#class-placeholdermessageresendrequest)
1167. [Class: RequestStickerReupload](#class-requeststickerreupload)
1168. [Class: RequestUrlPreview](#class-requesturlpreview)
1169. [Class: SyncDCollectionFatalRecoveryRequest](#class-syncdcollectionfatalrecoveryrequest)
1170. [Interface: IFullHistorySyncOnDemandRequest](#interface-ifullhistorysyncondemandrequest)
1171. [Interface: IGalaxyFlowAction](#interface-igalaxyflowaction)
1172. [Interface: IHistorySyncChunkRetryRequest](#interface-ihistorysyncchunkretryrequest)
1173. [Interface: IHistorySyncOnDemandRequest](#interface-ihistorysyncondemandrequest)
1174. [Interface: IPlaceholderMessageResendRequest](#interface-iplaceholdermessageresendrequest)
1175. [Interface: IRequestStickerReupload](#interface-irequeststickerreupload)
1176. [Interface: IRequestUrlPreview](#interface-irequesturlpreview)
1177. [Interface: ISyncDCollectionFatalRecoveryRequest](#interface-isyncdcollectionfatalrecoveryrequest)
1178. [GalaxyFlowAction](#galaxyflowaction)
1179. [Enumeration: GalaxyFlowActionType](#enumeration-galaxyflowactiontype)
1180. [PeerDataOperationRequestResponseMessage](#peerdataoperationrequestresponsemessage)
1181. [Class: PeerDataOperationResult](#class-peerdataoperationresult)
1182. [Interface: IPeerDataOperationResult](#interface-ipeerdataoperationresult)
1183. [PeerDataOperationResult](#peerdataoperationresult)
1184. [Class: CompanionCanonicalUserNonceFetchResponse](#class-companioncanonicalusernoncefetchresponse)
1185. [Class: CompanionMetaNonceFetchResponse](#class-companionmetanoncefetchresponse)
1186. [Class: FullHistorySyncOnDemandRequestResponse](#class-fullhistorysyncondemandrequestresponse)
1187. [Class: HistorySyncChunkRetryResponse](#class-historysyncchunkretryresponse)
1188. [Class: LinkPreviewResponse](#class-linkpreviewresponse)
1189. [Class: PlaceholderMessageResendResponse](#class-placeholdermessageresendresponse)
1190. [Class: SyncDSnapshotFatalRecoveryResponse](#class-syncdsnapshotfatalrecoveryresponse)
1191. [Class: WaffleNonceFetchResponse](#class-wafflenoncefetchresponse)
1192. [Enumeration: FullHistorySyncOnDemandResponseCode](#enumeration-fullhistorysyncondemandresponsecode)
1193. [Enumeration: HistorySyncChunkRetryResponseCode](#enumeration-historysyncchunkretryresponsecode)
1194. [Interface: ICompanionCanonicalUserNonceFetchResponse](#interface-icompanioncanonicalusernoncefetchresponse)
1195. [Interface: ICompanionMetaNonceFetchResponse](#interface-icompanionmetanoncefetchresponse)
1196. [Interface: IFullHistorySyncOnDemandRequestResponse](#interface-ifullhistorysyncondemandrequestresponse)
1197. [Interface: IHistorySyncChunkRetryResponse](#interface-ihistorysyncchunkretryresponse)
1198. [Interface: ILinkPreviewResponse](#interface-ilinkpreviewresponse)
1199. [Interface: IPlaceholderMessageResendResponse](#interface-iplaceholdermessageresendresponse)
1200. [Interface: ISyncDSnapshotFatalRecoveryResponse](#interface-isyncdsnapshotfatalrecoveryresponse)
1201. [Interface: IWaffleNonceFetchResponse](#interface-iwafflenoncefetchresponse)
1202. [LinkPreviewResponse](#linkpreviewresponse)
1203. [Class: LinkPreviewHighQualityThumbnail](#class-linkpreviewhighqualitythumbnail)
1204. [Class: PaymentLinkPreviewMetadata](#class-paymentlinkpreviewmetadata)
1205. [Interface: ILinkPreviewHighQualityThumbnail](#interface-ilinkpreviewhighqualitythumbnail)
1206. [Interface: IPaymentLinkPreviewMetadata](#interface-ipaymentlinkpreviewmetadata)
1207. [PinInChatMessage](#pininchatmessage)
1208. [Enumeration: Type](#enumeration-type)
1209. [PlaceholderMessage](#placeholdermessage)
1210. [Enumeration: PlaceholderType](#enumeration-placeholdertype)
1211. [PollCreationMessage](#pollcreationmessage)
1212. [Class: Option](#class-option)
1213. [Interface: IOption](#interface-ioption)
1214. [PollResultSnapshotMessage](#pollresultsnapshotmessage)
1215. [Class: PollVote](#class-pollvote)
1216. [Interface: IPollVote](#interface-ipollvote)
1217. [ProductMessage](#productmessage)
1218. [Class: CatalogSnapshot](#class-catalogsnapshot)
1219. [Class: ProductSnapshot](#class-productsnapshot)
1220. [Interface: ICatalogSnapshot](#interface-icatalogsnapshot)
1221. [ProtocolMessage](#protocolmessage)
1222. [RequestWelcomeMessageMetadata](#requestwelcomemessagemetadata)
1223. [Enumeration: LocalChatState](#enumeration-localchatstate)
1224. [ScheduledCallCreationMessage](#scheduledcallcreationmessage)
1225. [Enumeration: CallType](#enumeration-calltype)
1226. [ScheduledCallEditMessage](#scheduledcalleditmessage)
1227. [SecretEncryptedMessage](#secretencryptedmessage)
1228. [Enumeration: SecretEncType](#enumeration-secretenctype)
1229. [StatusNotificationMessage](#statusnotificationmessage)
1230. [Enumeration: StatusNotificationType](#enumeration-statusnotificationtype)
1231. [StatusQuotedMessage](#statusquotedmessage)
1232. [Enumeration: StatusQuotedMessageType](#enumeration-statusquotedmessagetype)
1233. [StatusStickerInteractionMessage](#statusstickerinteractionmessage)
1234. [Enumeration: StatusStickerType](#enumeration-statusstickertype)
1235. [Interface: ISticker](#interface-isticker)
1236. [TemplateMessage](#templatemessage)
1237. [Class: FourRowTemplate](#class-fourrowtemplate)
1238. [Class: HydratedFourRowTemplate](#class-hydratedfourrowtemplate)
1239. [Interface: IFourRowTemplate](#interface-ifourrowtemplate)
1240. [Interface: IHydratedFourRowTemplate](#interface-ihydratedfourrowtemplate)
1241. [VideoMessage](#videomessage)
1242. [Enumeration: Attribution](#enumeration-attribution)
1243. [Enumeration: VideoSourceType](#enumeration-videosourcetype)
1244. [MessageAddOn](#messageaddon)
1245. [Enumeration: MessageAddOnType](#enumeration-messageaddontype)
1246. [MessageAssociation](#messageassociation)
1247. [Enumeration: AssociationType](#enumeration-associationtype)
1248. [MessageContextInfo](#messagecontextinfo)
1249. [Enumeration: MessageAddonExpiryType](#enumeration-messageaddonexpirytype)
1250. [MsgOpaqueData](#msgopaquedata)
1251. [Class: EventLocation](#class-eventlocation)
1252. [Class: PollOption](#class-polloption)
1253. [Class: PollVoteSnapshot](#class-pollvotesnapshot)
1254. [Class: PollVotesSnapshot](#class-pollvotessnapshot)
1255. [Enumeration: PollContentType](#enumeration-pollcontenttype)
1256. [Enumeration: PollType](#enumeration-polltype)
1257. [Interface: IEventLocation](#interface-ieventlocation)
1258. [Interface: IPollOption](#interface-ipolloption)
1259. [Interface: IPollVoteSnapshot](#interface-ipollvotesnapshot)
1260. [Interface: IPollVotesSnapshot](#interface-ipollvotessnapshot)
1261. [NoiseCertificate](#noisecertificate)
1262. [Class: Details](#class-details)
1263. [Interface: IDetails](#interface-idetails)
1264. [PastParticipant](#pastparticipant)
1265. [Enumeration: LeaveReason](#enumeration-leavereason)
1266. [PatchDebugData](#patchdebugdata)
1267. [Enumeration: Platform](#enumeration-platform)
1268. [PaymentBackground](#paymentbackground)
1269. [Class: MediaData](#class-mediadata)
1270. [Enumeration: Type](#enumeration-type)
1271. [Interface: IMediaData](#interface-imediadata)
1272. [PaymentInfo](#paymentinfo)
1273. [Enumeration: Currency](#enumeration-currency)
1274. [Enumeration: Status](#enumeration-status)
1275. [Enumeration: TxnStatus](#enumeration-txnstatus)
1276. [PinInChat](#pininchat)
1277. [Enumeration: Type](#enumeration-type)
1278. [ProcessedVideo](#processedvideo)
1279. [Enumeration: VideoQuality](#enumeration-videoquality)
1280. [SenderKeyStateStructure](#senderkeystatestructure)
1281. [Class: SenderChainKey](#class-senderchainkey)
1282. [Class: SenderMessageKey](#class-sendermessagekey)
1283. [Class: SenderSigningKey](#class-sendersigningkey)
1284. [Interface: ISenderChainKey](#interface-isenderchainkey)
1285. [Interface: ISenderMessageKey](#interface-isendermessagekey)
1286. [Interface: ISenderSigningKey](#interface-isendersigningkey)
1287. [SessionStructure](#sessionstructure)
1288. [Class: Chain](#class-chain)
1289. [Class: PendingKeyExchange](#class-pendingkeyexchange)
1290. [Class: PendingPreKey](#class-pendingprekey)
1291. [Interface: IChain](#interface-ichain)
1292. [Interface: IPendingKeyExchange](#interface-ipendingkeyexchange)
1293. [Interface: IPendingPreKey](#interface-ipendingprekey)
1294. [Chain](#chain)
1295. [Class: ChainKey](#class-chainkey)
1296. [Class: MessageKey](#class-messagekey)
1297. [Interface: IChainKey](#interface-ichainkey)
1298. [Interface: IMessageKey](#interface-imessagekey)
1299. [StatusAttribution](#statusattribution)
1300. [Class: AiCreatedAttribution](#class-aicreatedattribution)
1301. [Class: ExternalShare](#class-externalshare)
1302. [Class: GroupStatus](#class-groupstatus)
1303. [Class: Music](#class-music)
1304. [Class: RLAttribution](#class-rlattribution)
1305. [Class: StatusReshare](#class-statusreshare)
1306. [Enumeration: Type](#enumeration-type)
1307. [Interface: IAiCreatedAttribution](#interface-iaicreatedattribution)
1308. [Interface: IExternalShare](#interface-iexternalshare)
1309. [Interface: IGroupStatus](#interface-igroupstatus)
1310. [Interface: IMusic](#interface-imusic)
1311. [Interface: IRLAttribution](#interface-irlattribution)
1312. [Interface: IStatusReshare](#interface-istatusreshare)
1313. [AiCreatedAttribution](#aicreatedattribution)
1314. [Enumeration: Source](#enumeration-source)
1315. [ExternalShare](#externalshare)
1316. [Enumeration: Source](#enumeration-source)
1317. [RLAttribution](#rlattribution)
1318. [Enumeration: Source](#enumeration-source)
1319. [StatusReshare](#statusreshare)
1320. [Class: Metadata](#class-metadata)
1321. [Enumeration: Source](#enumeration-source)
1322. [Interface: IMetadata](#interface-imetadata)
1323. [SyncActionValue](#syncactionvalue)
1324. [Class: AgentAction](#class-agentaction)
1325. [Class: AiThreadRenameAction](#class-aithreadrenameaction)
1326. [Class: AndroidUnsupportedActions](#class-androidunsupportedactions)
1327. [Class: ArchiveChatAction](#class-archivechataction)
1328. [Class: AvatarUpdatedAction](#class-avatarupdatedaction)
1329. [Class: BotWelcomeRequestAction](#class-botwelcomerequestaction)
1330. [Class: BroadcastListParticipant](#class-broadcastlistparticipant)
1331. [Class: BusinessBroadcastAssociationAction](#class-businessbroadcastassociationaction)
1332. [Class: BusinessBroadcastListAction](#class-businessbroadcastlistaction)
1333. [Class: CallLogAction](#class-calllogaction)
1334. [Class: ChatAssignmentAction](#class-chatassignmentaction)
1335. [Class: ChatAssignmentOpenedStatusAction](#class-chatassignmentopenedstatusaction)
1336. [Class: ClearChatAction](#class-clearchataction)
1337. [Class: ContactAction](#class-contactaction)
1338. [Class: CtwaPerCustomerDataSharingAction](#class-ctwapercustomerdatasharingaction)
1339. [Class: CustomPaymentMethod](#class-custompaymentmethod)
1340. [Class: CustomPaymentMethodMetadata](#class-custompaymentmethodmetadata)
1341. [Class: CustomPaymentMethodsAction](#class-custompaymentmethodsaction)
1342. [Class: DeleteChatAction](#class-deletechataction)
1343. [Class: DeleteIndividualCallLogAction](#class-deleteindividualcalllogaction)
1344. [Class: DeleteMessageForMeAction](#class-deletemessageformeaction)
1345. [Class: DetectedOutcomesStatusAction](#class-detectedoutcomesstatusaction)
1346. [Class: ExternalWebBetaAction](#class-externalwebbetaaction)
1347. [Class: FavoritesAction](#class-favoritesaction)
1348. [Class: InteractiveMessageAction](#class-interactivemessageaction)
1349. [Class: KeyExpiration](#class-keyexpiration)
1350. [Class: LabelAssociationAction](#class-labelassociationaction)
1351. [Class: LabelEditAction](#class-labeleditaction)
1352. [Class: LabelReorderingAction](#class-labelreorderingaction)
1353. [Class: LidContactAction](#class-lidcontactaction)
1354. [Class: LocaleSetting](#class-localesetting)
1355. [Class: LockChatAction](#class-lockchataction)
1356. [Class: MaibaAIFeaturesControlAction](#class-maibaaifeaturescontrolaction)
1357. [Class: MarkChatAsReadAction](#class-markchatasreadaction)
1358. [Class: MarketingMessageAction](#class-marketingmessageaction)
1359. [Class: MarketingMessageBroadcastAction](#class-marketingmessagebroadcastaction)
1360. [Class: MerchantPaymentPartnerAction](#class-merchantpaymentpartneraction)
1361. [Class: MusicUserIdAction](#class-musicuseridaction)
1362. [Class: MuteAction](#class-muteaction)
1363. [Class: NewsletterSavedInterestsAction](#class-newslettersavedinterestsaction)
1364. [Class: NoteEditAction](#class-noteeditaction)
1365. [Class: NotificationActivitySettingAction](#class-notificationactivitysettingaction)
1366. [Class: NuxAction](#class-nuxaction)
1367. [Class: PaymentInfoAction](#class-paymentinfoaction)
1368. [Class: PaymentTosAction](#class-paymenttosaction)
1369. [Class: PinAction](#class-pinaction)
1370. [Class: PnForLidChatAction](#class-pnforlidchataction)
1371. [Class: PrimaryFeature](#class-primaryfeature)
1372. [Class: PrimaryVersionAction](#class-primaryversionaction)
1373. [Class: PrivacySettingChannelsPersonalisedRecommendationAction](#class-privacysettingchannelspersonalisedrecommendationaction)
1374. [Class: PrivacySettingDisableLinkPreviewsAction](#class-privacysettingdisablelinkpreviewsaction)
1375. [Class: PrivacySettingRelayAllCalls](#class-privacysettingrelayallcalls)
1376. [Class: PrivateProcessingSettingAction](#class-privateprocessingsettingaction)
1377. [Class: PushNameSetting](#class-pushnamesetting)
1378. [Class: QuickReplyAction](#class-quickreplyaction)
1379. [Class: RecentEmojiWeightsAction](#class-recentemojiweightsaction)
1380. [Class: RemoveRecentStickerAction](#class-removerecentstickeraction)
1381. [Class: StarAction](#class-staraction)
1382. [Class: StatusPostOptInNotificationPreferencesAction](#class-statuspostoptinnotificationpreferencesaction)
1383. [Class: StatusPrivacyAction](#class-statusprivacyaction)
1384. [Class: StickerAction](#class-stickeraction)
1385. [Class: SubscriptionAction](#class-subscriptionaction)
1386. [Class: SyncActionMessage](#class-syncactionmessage)
1387. [Class: SyncActionMessageRange](#class-syncactionmessagerange)
1388. [Class: TimeFormatAction](#class-timeformataction)
1389. [Class: UGCBot](#class-ugcbot)
1390. [Class: UnarchiveChatsSetting](#class-unarchivechatssetting)
1391. [Class: UserStatusMuteAction](#class-userstatusmuteaction)
1392. [Class: UsernameChatStartModeAction](#class-usernamechatstartmodeaction)
1393. [Class: WaffleAccountLinkStateAction](#class-waffleaccountlinkstateaction)
1394. [Class: WamoUserIdentifierAction](#class-wamouseridentifieraction)
1395. [Interface: IAgentAction](#interface-iagentaction)
1396. [Interface: IAiThreadRenameAction](#interface-iaithreadrenameaction)
1397. [Interface: IAndroidUnsupportedActions](#interface-iandroidunsupportedactions)
1398. [Interface: IArchiveChatAction](#interface-iarchivechataction)
1399. [Interface: IAvatarUpdatedAction](#interface-iavatarupdatedaction)
1400. [Interface: IBotWelcomeRequestAction](#interface-ibotwelcomerequestaction)
1401. [Interface: IBroadcastListParticipant](#interface-ibroadcastlistparticipant)
1402. [Interface: IBusinessBroadcastAssociationAction](#interface-ibusinessbroadcastassociationaction)
1403. [Interface: IBusinessBroadcastListAction](#interface-ibusinessbroadcastlistaction)
1404. [Interface: ICallLogAction](#interface-icalllogaction)
1405. [Interface: IChatAssignmentAction](#interface-ichatassignmentaction)
1406. [Interface: IChatAssignmentOpenedStatusAction](#interface-ichatassignmentopenedstatusaction)
1407. [Interface: IClearChatAction](#interface-iclearchataction)
1408. [Interface: IContactAction](#interface-icontactaction)
1409. [Interface: ICtwaPerCustomerDataSharingAction](#interface-ictwapercustomerdatasharingaction)
1410. [Interface: ICustomPaymentMethod](#interface-icustompaymentmethod)
1411. [Interface: ICustomPaymentMethodMetadata](#interface-icustompaymentmethodmetadata)
1412. [Interface: ICustomPaymentMethodsAction](#interface-icustompaymentmethodsaction)
1413. [Interface: IDeleteChatAction](#interface-ideletechataction)
1414. [Interface: IDeleteIndividualCallLogAction](#interface-ideleteindividualcalllogaction)
1415. [Interface: IDeleteMessageForMeAction](#interface-ideletemessageformeaction)
1416. [Interface: IDetectedOutcomesStatusAction](#interface-idetectedoutcomesstatusaction)
1417. [Interface: IExternalWebBetaAction](#interface-iexternalwebbetaaction)
1418. [Interface: IFavoritesAction](#interface-ifavoritesaction)
1419. [Interface: IInteractiveMessageAction](#interface-iinteractivemessageaction)
1420. [Interface: IKeyExpiration](#interface-ikeyexpiration)
1421. [Interface: ILabelAssociationAction](#interface-ilabelassociationaction)
1422. [Interface: ILabelEditAction](#interface-ilabeleditaction)
1423. [Interface: ILabelReorderingAction](#interface-ilabelreorderingaction)
1424. [Interface: ILidContactAction](#interface-ilidcontactaction)
1425. [Interface: ILocaleSetting](#interface-ilocalesetting)
1426. [Interface: ILockChatAction](#interface-ilockchataction)
1427. [Interface: IMaibaAIFeaturesControlAction](#interface-imaibaaifeaturescontrolaction)
1428. [Interface: IMarkChatAsReadAction](#interface-imarkchatasreadaction)
1429. [Interface: IMarketingMessageAction](#interface-imarketingmessageaction)
1430. [Interface: IMarketingMessageBroadcastAction](#interface-imarketingmessagebroadcastaction)
1431. [Interface: IMerchantPaymentPartnerAction](#interface-imerchantpaymentpartneraction)
1432. [Interface: IMusicUserIdAction](#interface-imusicuseridaction)
1433. [Interface: IMuteAction](#interface-imuteaction)
1434. [Interface: INewsletterSavedInterestsAction](#interface-inewslettersavedinterestsaction)
1435. [Interface: INoteEditAction](#interface-inoteeditaction)
1436. [Interface: INotificationActivitySettingAction](#interface-inotificationactivitysettingaction)
1437. [Interface: INuxAction](#interface-inuxaction)
1438. [Interface: IPaymentInfoAction](#interface-ipaymentinfoaction)
1439. [Interface: IPaymentTosAction](#interface-ipaymenttosaction)
1440. [Interface: IPinAction](#interface-ipinaction)
1441. [Interface: IPnForLidChatAction](#interface-ipnforlidchataction)
1442. [Interface: IPrimaryFeature](#interface-iprimaryfeature)
1443. [Interface: IPrimaryVersionAction](#interface-iprimaryversionaction)
1444. [Interface: IPrivacySettingChannelsPersonalisedRecommendationAction](#interface-iprivacysettingchannelspersonalisedrecommendationaction)
1445. [Interface: IPrivacySettingDisableLinkPreviewsAction](#interface-iprivacysettingdisablelinkpreviewsaction)
1446. [Interface: IPrivacySettingRelayAllCalls](#interface-iprivacysettingrelayallcalls)
1447. [Interface: IPrivateProcessingSettingAction](#interface-iprivateprocessingsettingaction)
1448. [Interface: IPushNameSetting](#interface-ipushnamesetting)
1449. [Interface: IQuickReplyAction](#interface-iquickreplyaction)
1450. [Interface: IRecentEmojiWeightsAction](#interface-irecentemojiweightsaction)
1451. [Interface: IRemoveRecentStickerAction](#interface-iremoverecentstickeraction)
1452. [Interface: IStarAction](#interface-istaraction)
1453. [Interface: IStatusPostOptInNotificationPreferencesAction](#interface-istatuspostoptinnotificationpreferencesaction)
1454. [Interface: IStatusPrivacyAction](#interface-istatusprivacyaction)
1455. [Interface: IStickerAction](#interface-istickeraction)
1456. [Interface: ISubscriptionAction](#interface-isubscriptionaction)
1457. [Interface: ISyncActionMessage](#interface-isyncactionmessage)
1458. [Interface: ISyncActionMessageRange](#interface-isyncactionmessagerange)
1459. [Interface: ITimeFormatAction](#interface-itimeformataction)
1460. [Interface: IUGCBot](#interface-iugcbot)
1461. [Interface: IUnarchiveChatsSetting](#interface-iunarchivechatssetting)
1462. [Interface: IUserStatusMuteAction](#interface-iuserstatusmuteaction)
1463. [Interface: IUsernameChatStartModeAction](#interface-iusernamechatstartmodeaction)
1464. [Interface: IWaffleAccountLinkStateAction](#interface-iwaffleaccountlinkstateaction)
1465. [Interface: IWamoUserIdentifierAction](#interface-iwamouseridentifieraction)
1466. [AvatarUpdatedAction](#avatarupdatedaction)
1467. [Enumeration: AvatarEventType](#enumeration-avatareventtype)
1468. [FavoritesAction](#favoritesaction)
1469. [Class: Favorite](#class-favorite)
1470. [Interface: IFavorite](#interface-ifavorite)
1471. [InteractiveMessageAction](#interactivemessageaction)
1472. [Enumeration: InteractiveMessageActionMode](#enumeration-interactivemessageactionmode)
1473. [LabelEditAction](#labeleditaction)
1474. [Enumeration: ListType](#enumeration-listtype)
1475. [MaibaAIFeaturesControlAction](#maibaaifeaturescontrolaction)
1476. [Enumeration: MaibaAIFeatureStatus](#enumeration-maibaaifeaturestatus)
1477. [MarketingMessageAction](#marketingmessageaction)
1478. [Enumeration: MarketingMessagePrototypeType](#enumeration-marketingmessageprototypetype)
1479. [MerchantPaymentPartnerAction](#merchantpaymentpartneraction)
1480. [Enumeration: Status](#enumeration-status)
1481. [NoteEditAction](#noteeditaction)
1482. [Enumeration: NoteType](#enumeration-notetype)
1483. [NotificationActivitySettingAction](#notificationactivitysettingaction)
1484. [Enumeration: NotificationActivitySetting](#enumeration-notificationactivitysetting)
1485. [PaymentTosAction](#paymenttosaction)
1486. [Enumeration: PaymentNotice](#enumeration-paymentnotice)
1487. [PrivateProcessingSettingAction](#privateprocessingsettingaction)
1488. [Enumeration: PrivateProcessingStatus](#enumeration-privateprocessingstatus)
1489. [StatusPrivacyAction](#statusprivacyaction)
1490. [Enumeration: StatusDistributionMode](#enumeration-statusdistributionmode)
1491. [UsernameChatStartModeAction](#usernamechatstartmodeaction)
1492. [Enumeration: ChatStartMode](#enumeration-chatstartmode)
1493. [WaffleAccountLinkStateAction](#waffleaccountlinkstateaction)
1494. [Enumeration: AccountLinkState](#enumeration-accountlinkstate)
1495. [SyncdMutation](#syncdmutation)
1496. [Enumeration: SyncdOperation](#enumeration-syncdoperation)
1497. [TemplateButton](#templatebutton)
1498. [Class: CallButton](#class-callbutton)
1499. [Class: QuickReplyButton](#class-quickreplybutton)
1500. [Class: URLButton](#class-urlbutton)
1501. [Interface: ICallButton](#interface-icallbutton)
1502. [Interface: IQuickReplyButton](#interface-iquickreplybutton)
1503. [Interface: IURLButton](#interface-iurlbutton)
1504. [ThreadID](#threadid)
1505. [Enumeration: ThreadType](#enumeration-threadtype)
1506. [UrlTrackingMap](#urltrackingmap)
1507. [Class: UrlTrackingMapElement](#class-urltrackingmapelement)
1508. [Interface: IUrlTrackingMapElement](#interface-iurltrackingmapelement)
1509. [UserPassword](#userpassword)
1510. [Class: TransformerArg](#class-transformerarg)
1511. [Enumeration: Encoding](#enumeration-encoding)
1512. [Enumeration: Transformer](#enumeration-transformer)
1513. [Interface: ITransformerArg](#interface-itransformerarg)
1514. [TransformerArg](#transformerarg)
1515. [Class: Value](#class-value)
1516. [Interface: IValue](#interface-ivalue)
1517. [VerifiedNameCertificate](#verifiednamecertificate)
1518. [Class: Details](#class-details)
1519. [Interface: IDetails](#interface-idetails)
1520. [WebFeatures](#webfeatures)
1521. [Enumeration: Flag](#enumeration-flag)
1522. [WebMessageInfo](#webmessageinfo)
1523. [Enumeration: BizPrivacyStatus](#enumeration-bizprivacystatus)
1524. [Enumeration: Status](#enumeration-status)
1525. [Enumeration: StubType](#enumeration-stubtype)
1526. [Type Alias: AccountSettings](#type-alias-accountsettings)
1527. [Type Alias: AnyMediaMessageContent](#type-alias-anymediamessagecontent)
1528. [Type Alias: AnyMessageContent](#type-alias-anymessagecontent)
1529. [Type Alias: AnyRegularMessageContent](#type-alias-anyregularmessagecontent)
1530. [Type Alias: AuthenticationCreds](#type-alias-authenticationcreds)
1531. [Type Alias: AuthenticationState](#type-alias-authenticationstate)
1532. [Type Alias: BaileysEvent](#type-alias-baileysevent)
1533. [Type Alias: BaileysEventMap](#type-alias-baileyseventmap)
1534. [Type Alias: BinaryNode](#type-alias-binarynode)
1535. [Type Alias: BinaryNodeAttributes](#type-alias-binarynodeattributes)
1536. [Type Alias: BinaryNodeCodingOptions](#type-alias-binarynodecodingoptions)
1537. [Type Alias: BinaryNodeData](#type-alias-binarynodedata)
1538. [Type Alias: BotListInfo](#type-alias-botlistinfo)
1539. [Type Alias: BrowsersMap](#type-alias-browsersmap)
1540. [Type Alias: BufferedEventData](#type-alias-bufferedeventdata)
1541. [Type Alias: ButtonReplyInfo](#type-alias-buttonreplyinfo)
1542. [Type Alias: CacheStore](#type-alias-cachestore)
1543. [Type Alias: CatalogCollection](#type-alias-catalogcollection)
1544. [Type Alias: CatalogCursor](#type-alias-catalogcursor)
1545. [Type Alias: CatalogResult](#type-alias-catalogresult)
1546. [Type Alias: CatalogStatus](#type-alias-catalogstatus)
1547. [Type Alias: Chat](#type-alias-chat)
1548. [Type Alias: ChatModification](#type-alias-chatmodification)
1549. [Type Alias: ChatMutation](#type-alias-chatmutation)
1550. [Type Alias: ChatMutationMap](#type-alias-chatmutationmap)
1551. [Type Alias: ChatUpdate](#type-alias-chatupdate)
1552. [Type Alias: ConnectionState](#type-alias-connectionstate)
1553. [Type Alias: CurveKeyPair](#type-alias-curvekeypair)
1554. [Type Alias: DebouncedTimeout](#type-alias-debouncedtimeout)
1555. [Type Alias: DeviceListData](#type-alias-devicelistdata)
1556. [Type Alias: DisappearingModeData](#type-alias-disappearingmodedata)
1557. [Type Alias: DownloadableMessage](#type-alias-downloadablemessage)
1558. [Type Alias: Event](#type-alias-event)
1559. [Type Alias: EventInputType](#type-alias-eventinputtype)
1560. [Type Alias: EventMessageOptions](#type-alias-eventmessageoptions)
1561. [Type Alias: FullJid](#type-alias-fulljid)
1562. [Type Alias: GetCatalogOptions](#type-alias-getcatalogoptions)
1563. [Type Alias: Global](#type-alias-global)
1564. [Type Alias: GroupInviteInfo](#type-alias-groupinviteinfo)
1565. [Type Alias: GroupMetadataParticipants](#type-alias-groupmetadataparticipants)
1566. [Type Alias: GroupParticipant](#type-alias-groupparticipant)
1567. [Type Alias: IdentityChangeContext](#type-alias-identitychangecontext)
1568. [Type Alias: IdentityChangeResult](#type-alias-identitychangeresult)
1569. [Type Alias: InitialAppStateSyncOptions](#type-alias-initialappstatesyncoptions)
1570. [Type Alias: InitialReceivedChatsState](#type-alias-initialreceivedchatsstate)
1571. [Type Alias: JidServer](#type-alias-jidserver)
1572. [Type Alias: JidWithDevice](#type-alias-jidwithdevice)
1573. [Type Alias: KeyIndexData](#type-alias-keyindexdata)
1574. [Type Alias: KeyPair](#type-alias-keypair)
1575. [Type Alias: LIDMapping](#type-alias-lidmapping)
1576. [Type Alias: LTHashState](#type-alias-lthashstate)
1577. [Type Alias: LastMessageList](#type-alias-lastmessagelist)
1578. [Type Alias: MediaConnInfo](#type-alias-mediaconninfo)
1579. [Type Alias: MediaDecryptionKeyInfo](#type-alias-mediadecryptionkeyinfo)
1580. [Type Alias: MediaDownloadOptions](#type-alias-mediadownloadoptions)
1581. [Type Alias: MediaGenerationOptions](#type-alias-mediagenerationoptions)
1582. [Type Alias: MediaType](#type-alias-mediatype)
1583. [Type Alias: MessageContentGenerationOptions](#type-alias-messagecontentgenerationoptions)
1584. [Type Alias: MessageGenerationOptions](#type-alias-messagegenerationoptions)
1585. [Type Alias: MessageGenerationOptionsFromContent](#type-alias-messagegenerationoptionsfromcontent)
1586. [Type Alias: MessageReceiptType](#type-alias-messagereceipttype)
1587. [Type Alias: MessageRelayOptions](#type-alias-messagerelayoptions)
1588. [Type Alias: MessageType](#type-alias-messagetype)
1589. [Type Alias: MessageUpsertType](#type-alias-messageupserttype)
1590. [Type Alias: MessageUserReceipt](#type-alias-messageuserreceipt)
1591. [Type Alias: MessageUserReceiptUpdate](#type-alias-messageuserreceiptupdate)
1592. [Type Alias: MessageWithContextInfo](#type-alias-messagewithcontextinfo)
1593. [Type Alias: MinimalMessage](#type-alias-minimalmessage)
1594. [Type Alias: MiscMessageGenerationOptions](#type-alias-miscmessagegenerationoptions)
1595. [Type Alias: NewsletterUpdate](#type-alias-newsletterupdate)
1596. [Type Alias: NewsletterViewRole](#type-alias-newsletterviewrole)
1597. [Type Alias: OrderDetails](#type-alias-orderdetails)
1598. [Type Alias: OrderPrice](#type-alias-orderprice)
1599. [Type Alias: OrderProduct](#type-alias-orderproduct)
1600. [Type Alias: ParsedDeviceInfo](#type-alias-parseddeviceinfo)
1601. [Type Alias: ParticipantAction](#type-alias-participantaction)
1602. [Type Alias: PatchedMessageWithRecipientJID](#type-alias-patchedmessagewithrecipientjid)
1603. [Type Alias: PendingPhoneRequest](#type-alias-pendingphonerequest)
1604. [Type Alias: PollMessageOptions](#type-alias-pollmessageoptions)
1605. [Type Alias: PossiblyExtendedCacheStore](#type-alias-possiblyextendedcachestore)
1606. [Type Alias: Product](#type-alias-product)
1607. [Type Alias: ProductAvailability](#type-alias-productavailability)
1608. [Type Alias: ProductBase](#type-alias-productbase)
1609. [Type Alias: ProductCreate](#type-alias-productcreate)
1610. [Type Alias: ProductCreateResult](#type-alias-productcreateresult)
1611. [Type Alias: ProductUpdate](#type-alias-productupdate)
1612. [Type Alias: ProtocolAddress](#type-alias-protocoladdress)
1613. [Type Alias: RequestJoinAction](#type-alias-requestjoinaction)
1614. [Type Alias: RequestJoinMethod](#type-alias-requestjoinmethod)
1615. [Type Alias: SignalAuthState](#type-alias-signalauthstate)
1616. [Type Alias: SignalCreds](#type-alias-signalcreds)
1617. [Type Alias: SignalDataSet](#type-alias-signaldataset)
1618. [Type Alias: SignalDataTypeMap](#type-alias-signaldatatypemap)
1619. [Type Alias: SignalIdentity](#type-alias-signalidentity)
1620. [Type Alias: SignalKeyStore](#type-alias-signalkeystore)
1621. [Type Alias: SignalKeyStoreWithTransaction](#type-alias-signalkeystorewithtransaction)
1622. [Type Alias: SignalRepository](#type-alias-signalrepository)
1623. [Type Alias: SignedKeyPair](#type-alias-signedkeypair)
1624. [Type Alias: SocketConfig](#type-alias-socketconfig)
1625. [Type Alias: StatusData](#type-alias-statusdata)
1626. [Type Alias: TransactionCapabilityOptions](#type-alias-transactioncapabilityoptions)
1627. [Type Alias: URLGenerationOptions](#type-alias-urlgenerationoptions)
1628. [Type Alias: USyncQueryResult](#type-alias-usyncqueryresult)
1629. [Type Alias: USyncQueryResultList](#type-alias-usyncqueryresultlist)
1630. [Type Alias: UploadParams](#type-alias-uploadparams)
1631. [Type Alias: UserFacingSocketConfig](#type-alias-userfacingsocketconfig)
1632. [Type Alias: Value](#type-alias-value)
1633. [Type Alias: WABrowserDescription](#type-alias-wabrowserdescription)
1634. [Type Alias: WABusinessHoursConfig](#type-alias-wabusinesshoursconfig)
1635. [Type Alias: WABusinessProfile](#type-alias-wabusinessprofile)
1636. [Type Alias: WACallEvent](#type-alias-wacallevent)
1637. [Type Alias: WACallUpdateType](#type-alias-wacallupdatetype)
1638. [Type Alias: WAConnectionState](#type-alias-waconnectionstate)
1639. [Type Alias: WAContactMessage](#type-alias-wacontactmessage)
1640. [Type Alias: WAContactsArrayMessage](#type-alias-wacontactsarraymessage)
1641. [Type Alias: WAContextInfo](#type-alias-wacontextinfo)
1642. [Type Alias: WAGenericMediaMessage](#type-alias-wagenericmediamessage)
1643. [Type Alias: WAInitResponse](#type-alias-wainitresponse)
1644. [Type Alias: WALocationMessage](#type-alias-walocationmessage)
1645. [Type Alias: WAMediaPayloadStream](#type-alias-wamediapayloadstream)
1646. [Type Alias: WAMediaPayloadURL](#type-alias-wamediapayloadurl)
1647. [Type Alias: WAMediaUpload](#type-alias-wamediaupload)
1648. [Type Alias: WAMediaUploadFunction()](#type-alias-wamediauploadfunction-)
1649. [Type Alias: WAMessage](#type-alias-wamessage)
1650. [Type Alias: WAMessageContent](#type-alias-wamessagecontent)
1651. [Type Alias: WAMessageCursor](#type-alias-wamessagecursor)
1652. [Type Alias: WAMessageKey](#type-alias-wamessagekey)
1653. [Type Alias: WAMessageUpdate](#type-alias-wamessageupdate)
1654. [Type Alias: WAPatchCreate](#type-alias-wapatchcreate)
1655. [Type Alias: WAPatchName](#type-alias-wapatchname)
1656. [Type Alias: WAPresence](#type-alias-wapresence)
1657. [Type Alias: WAPrivacyCallValue](#type-alias-waprivacycallvalue)
1658. [Type Alias: WAPrivacyGroupAddValue](#type-alias-waprivacygroupaddvalue)
1659. [Type Alias: WAPrivacyMessagesValue](#type-alias-waprivacymessagesvalue)
1660. [Type Alias: WAPrivacyOnlineValue](#type-alias-waprivacyonlinevalue)
1661. [Type Alias: WAPrivacyValue](#type-alias-waprivacyvalue)
1662. [Type Alias: WAReadReceiptsValue](#type-alias-wareadreceiptsvalue)
1663. [Type Alias: WASendableProduct](#type-alias-wasendableproduct)
1664. [Type Alias: WASocket](#type-alias-wasocket)
1665. [Type Alias: WATextMessage](#type-alias-watextmessage)
1666. [Type Alias: WAVersion](#type-alias-waversion)
1667. [Variable: ALL\_WA\_PATCH\_NAMES](#variable-all-_wa-_patch-_names)
1668. [Variable: Browsers](#variable-browsers)
1669. [Variable: BufferJSON](#variable-bufferjson)
1670. [Variable: CALL\_AUDIO\_PREFIX](#variable-call-_audio-_prefix)
1671. [Variable: CALL\_VIDEO\_PREFIX](#variable-call-_video-_prefix)
1672. [Variable: Curve](#variable-curve)
1673. [Variable: DECRYPTION\_RETRY\_CONFIG](#variable-decryption-_retry-_config)
1674. [Variable: DEFAULT\_CACHE\_TTLS](#variable-default-_cache-_ttls)
1675. [Variable: DEFAULT\_CONNECTION\_CONFIG](#variable-default-_connection-_config)
1676. [Variable: DEFAULT\_ORIGIN](#variable-default-_origin)
1677. [Variable: DEF\_CALLBACK\_PREFIX](#variable-def-_callback-_prefix)
1678. [Variable: DEF\_TAG\_PREFIX](#variable-def-_tag-_prefix)
1679. [Variable: DICT\_VERSION](#variable-dict-_version)
1680. [Variable: FLAG\_BYTE](#variable-flag-_byte)
1681. [Variable: FLAG\_EVENT](#variable-flag-_event)
1682. [Variable: FLAG\_EXTENDED](#variable-flag-_extended)
1683. [Variable: FLAG\_FIELD](#variable-flag-_field)
1684. [Variable: FLAG\_GLOBAL](#variable-flag-_global)
1685. [Variable: INITIAL\_PREKEY\_COUNT](#variable-initial-_prekey-_count)
1686. [Variable: KEY\_BUNDLE\_TYPE](#variable-key-_bundle-_type)
1687. [Variable: LT\_HASH\_ANTI\_TAMPERING](#variable-lt-_hash-_anti-_tampering)
1688. [Variable: MEDIA\_HKDF\_KEY\_MAPPING](#variable-media-_hkdf-_key-_mapping)
1689. [Variable: MEDIA\_KEYS](#variable-media-_keys)
1690. [Variable: MEDIA\_PATH\_MAP](#variable-media-_path-_map)
1691. [Variable: META\_AI\_JID](#variable-meta-_ai-_jid)
1692. [Variable: MIN\_PREKEY\_COUNT](#variable-min-_prekey-_count)
1693. [Variable: MIN\_UPLOAD\_INTERVAL](#variable-min-_upload-_interval)
1694. [Variable: MISSING\_KEYS\_ERROR\_TEXT](#variable-missing-_keys-_error-_text)
1695. [Variable: NACK\_REASONS](#variable-nack-_reasons)
1696. [Variable: NOISE\_MODE](#variable-noise-_mode)
1697. [Variable: NOISE\_WA\_HEADER](#variable-noise-_wa-_header)
1698. [Variable: NO\_MESSAGE\_FOUND\_ERROR\_TEXT](#variable-no-_message-_found-_error-_text)
1699. [Variable: OFFICIAL\_BIZ\_JID](#variable-official-_biz-_jid)
1700. [Variable: PHONE\_CONNECTION\_CB](#variable-phone-_connection-_cb)
1701. [Variable: PLACEHOLDER\_MAX\_AGE\_SECONDS](#variable-placeholder-_max-_age-_seconds)
1702. [Variable: PROCESSABLE\_HISTORY\_TYPES](#variable-processable-_history-_types)
1703. [Variable: PSA\_WID](#variable-psa-_wid)
1704. [Variable: SERVER\_JID](#variable-server-_jid)
1705. [Variable: STATUS\_EXPIRY\_SECONDS](#variable-status-_expiry-_seconds)
1706. [Variable: STORIES\_JID](#variable-stories-_jid)
1707. [Variable: S\_WHATSAPP\_NET](#variable-s-_whatsapp-_net)
1708. [Variable: TimeMs](#variable-timems)
1709. [Variable: UNAUTHORIZED\_CODES](#variable-unauthorized-_codes)
1710. [Variable: UPLOAD\_TIMEOUT](#variable-upload-_timeout)
1711. [Variable: URL\_REGEX](#variable-url-_regex)
1712. [Variable: WAMessageStatus](#variable-wamessagestatus)
1713. [Variable: WAMessageStubType](#variable-wamessagestubtype)
1714. [Variable: WA\_ADV\_ACCOUNT\_SIG\_PREFIX](#variable-wa-_adv-_account-_sig-_prefix)
1715. [Variable: WA\_ADV\_DEVICE\_SIG\_PREFIX](#variable-wa-_adv-_device-_sig-_prefix)
1716. [Variable: WA\_ADV\_HOSTED\_ACCOUNT\_SIG\_PREFIX](#variable-wa-_adv-_hosted-_account-_sig-_prefix)
1717. [Variable: WA\_ADV\_HOSTED\_DEVICE\_SIG\_PREFIX](#variable-wa-_adv-_hosted-_device-_sig-_prefix)
1718. [Variable: WA\_CERT\_DETAILS](#variable-wa-_cert-_details)
1719. [Variable: WA\_DEFAULT\_EPHEMERAL](#variable-wa-_default-_ephemeral)
1720. [Variable: WEB\_EVENTS](#variable-web-_events)
1721. [Variable: WEB\_GLOBALS](#variable-web-_globals)
1722. [Socket](#socket)

---


<a name="baileys"></a>

> Source: [https://baileys.wiki/docs/api/](https://baileys.wiki/docs/api/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [proto](/docs/api/namespaces/proto/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [DisconnectReason](/docs/api/enumerations/DisconnectReason)
*   [QueryIds](/docs/api/enumerations/QueryIds)
*   [RetryReason](/docs/api/enumerations/RetryReason)
*   [SyncState](/docs/api/enumerations/SyncState)
*   [WAJIDDomains](/docs/api/enumerations/WAJIDDomains)
*   [WAMessageAddressingMode](/docs/api/enumerations/WAMessageAddressingMode)
*   [XWAPaths](/docs/api/enumerations/XWAPaths)

## Classes[​](#classes "Direct link to Classes")

*   [BinaryInfo](/docs/api/classes/BinaryInfo)
*   [MessageRetryManager](/docs/api/classes/MessageRetryManager)
*   [USyncContactProtocol](/docs/api/classes/USyncContactProtocol)
*   [USyncDeviceProtocol](/docs/api/classes/USyncDeviceProtocol)
*   [USyncDisappearingModeProtocol](/docs/api/classes/USyncDisappearingModeProtocol)
*   [USyncQuery](/docs/api/classes/USyncQuery)
*   [USyncStatusProtocol](/docs/api/classes/USyncStatusProtocol)
*   [USyncUser](/docs/api/classes/USyncUser)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [BaileysEventEmitter](/docs/api/interfaces/BaileysEventEmitter)
*   [Contact](/docs/api/interfaces/Contact)
*   [GroupMetadata](/docs/api/interfaces/GroupMetadata)
*   [GroupModificationResponse](/docs/api/interfaces/GroupModificationResponse)
*   [NewsletterCreateResponse](/docs/api/interfaces/NewsletterCreateResponse)
*   [NewsletterMetadata](/docs/api/interfaces/NewsletterMetadata)
*   [PresenceData](/docs/api/interfaces/PresenceData)
*   [RecentMessage](/docs/api/interfaces/RecentMessage)
*   [RecentMessageKey](/docs/api/interfaces/RecentMessageKey)
*   [RetryCounter](/docs/api/interfaces/RetryCounter)
*   [RetryStatistics](/docs/api/interfaces/RetryStatistics)
*   [SessionRecreateHistory](/docs/api/interfaces/SessionRecreateHistory)
*   [SignalRepositoryWithLIDStore](/docs/api/interfaces/SignalRepositoryWithLIDStore)
*   [WAGroupCreateResponse](/docs/api/interfaces/WAGroupCreateResponse)
*   [WAUrlInfo](/docs/api/interfaces/WAUrlInfo)

## Type Aliases[​](#type-aliases "Direct link to Type Aliases")

*   [AccountSettings](/docs/api/type-aliases/AccountSettings)
*   [AnyMediaMessageContent](/docs/api/type-aliases/AnyMediaMessageContent)
*   [AnyMessageContent](/docs/api/type-aliases/AnyMessageContent)
*   [AnyRegularMessageContent](/docs/api/type-aliases/AnyRegularMessageContent)
*   [AuthenticationCreds](/docs/api/type-aliases/AuthenticationCreds)
*   [AuthenticationState](/docs/api/type-aliases/AuthenticationState)
*   [BaileysEvent](/docs/api/type-aliases/BaileysEvent)
*   [BaileysEventMap](/docs/api/type-aliases/BaileysEventMap)
*   [BinaryNode](/docs/api/type-aliases/BinaryNode)
*   [BinaryNodeAttributes](/docs/api/type-aliases/BinaryNodeAttributes)
*   [BinaryNodeCodingOptions](/docs/api/type-aliases/BinaryNodeCodingOptions)
*   [BinaryNodeData](/docs/api/type-aliases/BinaryNodeData)
*   [BotListInfo](/docs/api/type-aliases/BotListInfo)
*   [BrowsersMap](/docs/api/type-aliases/BrowsersMap)
*   [BufferedEventData](/docs/api/type-aliases/BufferedEventData)
*   [ButtonReplyInfo](/docs/api/type-aliases/ButtonReplyInfo)
*   [CacheStore](/docs/api/type-aliases/CacheStore)
*   [CatalogCollection](/docs/api/type-aliases/CatalogCollection)
*   [CatalogCursor](/docs/api/type-aliases/CatalogCursor)
*   [CatalogResult](/docs/api/type-aliases/CatalogResult)
*   [CatalogStatus](/docs/api/type-aliases/CatalogStatus)
*   [Chat](/docs/api/type-aliases/Chat)
*   [ChatModification](/docs/api/type-aliases/ChatModification)
*   [ChatMutation](/docs/api/type-aliases/ChatMutation)
*   [ChatMutationMap](/docs/api/type-aliases/ChatMutationMap)
*   [ChatUpdate](/docs/api/type-aliases/ChatUpdate)
*   [ConnectionState](/docs/api/type-aliases/ConnectionState)
*   [CurveKeyPair](/docs/api/type-aliases/CurveKeyPair)
*   [DebouncedTimeout](/docs/api/type-aliases/DebouncedTimeout)
*   [DeviceListData](/docs/api/type-aliases/DeviceListData)
*   [DisappearingModeData](/docs/api/type-aliases/DisappearingModeData)
*   [DownloadableMessage](/docs/api/type-aliases/DownloadableMessage)
*   [Event](/docs/api/type-aliases/Event)
*   [EventInputType](/docs/api/type-aliases/EventInputType)
*   [EventMessageOptions](/docs/api/type-aliases/EventMessageOptions)
*   [FullJid](/docs/api/type-aliases/FullJid)
*   [GetCatalogOptions](/docs/api/type-aliases/GetCatalogOptions)
*   [Global](/docs/api/type-aliases/Global)
*   [GroupInviteInfo](/docs/api/type-aliases/GroupInviteInfo)
*   [GroupMetadataParticipants](/docs/api/type-aliases/GroupMetadataParticipants)
*   [GroupParticipant](/docs/api/type-aliases/GroupParticipant)
*   [IdentityChangeContext](/docs/api/type-aliases/IdentityChangeContext)
*   [IdentityChangeResult](/docs/api/type-aliases/IdentityChangeResult)
*   [InitialAppStateSyncOptions](/docs/api/type-aliases/InitialAppStateSyncOptions)
*   [InitialReceivedChatsState](/docs/api/type-aliases/InitialReceivedChatsState)
*   [JidServer](/docs/api/type-aliases/JidServer)
*   [JidWithDevice](/docs/api/type-aliases/JidWithDevice)
*   [KeyIndexData](/docs/api/type-aliases/KeyIndexData)
*   [KeyPair](/docs/api/type-aliases/KeyPair)
*   [LastMessageList](/docs/api/type-aliases/LastMessageList)
*   [LIDMapping](/docs/api/type-aliases/LIDMapping)
*   [LTHashState](/docs/api/type-aliases/LTHashState)
*   [MediaConnInfo](/docs/api/type-aliases/MediaConnInfo)
*   [MediaDecryptionKeyInfo](/docs/api/type-aliases/MediaDecryptionKeyInfo)
*   [MediaDownloadOptions](/docs/api/type-aliases/MediaDownloadOptions)
*   [MediaGenerationOptions](/docs/api/type-aliases/MediaGenerationOptions)
*   [MediaType](/docs/api/type-aliases/MediaType)
*   [MessageContentGenerationOptions](/docs/api/type-aliases/MessageContentGenerationOptions)
*   [MessageGenerationOptions](/docs/api/type-aliases/MessageGenerationOptions)
*   [MessageGenerationOptionsFromContent](/docs/api/type-aliases/MessageGenerationOptionsFromContent)
*   [MessageReceiptType](/docs/api/type-aliases/MessageReceiptType)
*   [MessageRelayOptions](/docs/api/type-aliases/MessageRelayOptions)
*   [MessageType](/docs/api/type-aliases/MessageType)
*   [MessageUpsertType](/docs/api/type-aliases/MessageUpsertType)
*   [MessageUserReceipt](/docs/api/type-aliases/MessageUserReceipt)
*   [MessageUserReceiptUpdate](/docs/api/type-aliases/MessageUserReceiptUpdate)
*   [MessageWithContextInfo](/docs/api/type-aliases/MessageWithContextInfo)
*   [MinimalMessage](/docs/api/type-aliases/MinimalMessage)
*   [MiscMessageGenerationOptions](/docs/api/type-aliases/MiscMessageGenerationOptions)
*   [NewsletterUpdate](/docs/api/type-aliases/NewsletterUpdate)
*   [NewsletterViewRole](/docs/api/type-aliases/NewsletterViewRole)
*   [OrderDetails](/docs/api/type-aliases/OrderDetails)
*   [OrderPrice](/docs/api/type-aliases/OrderPrice)
*   [OrderProduct](/docs/api/type-aliases/OrderProduct)
*   [ParsedDeviceInfo](/docs/api/type-aliases/ParsedDeviceInfo)
*   [ParticipantAction](/docs/api/type-aliases/ParticipantAction)
*   [PatchedMessageWithRecipientJID](/docs/api/type-aliases/PatchedMessageWithRecipientJID)
*   [PendingPhoneRequest](/docs/api/type-aliases/PendingPhoneRequest)
*   [PollMessageOptions](/docs/api/type-aliases/PollMessageOptions)
*   [PossiblyExtendedCacheStore](/docs/api/type-aliases/PossiblyExtendedCacheStore)
*   [Product](/docs/api/type-aliases/Product)
*   [ProductAvailability](/docs/api/type-aliases/ProductAvailability)
*   [ProductBase](/docs/api/type-aliases/ProductBase)
*   [ProductCreate](/docs/api/type-aliases/ProductCreate)
*   [ProductCreateResult](/docs/api/type-aliases/ProductCreateResult)
*   [ProductUpdate](/docs/api/type-aliases/ProductUpdate)
*   [ProtocolAddress](/docs/api/type-aliases/ProtocolAddress)
*   [RequestJoinAction](/docs/api/type-aliases/RequestJoinAction)
*   [RequestJoinMethod](/docs/api/type-aliases/RequestJoinMethod)
*   [SignalAuthState](/docs/api/type-aliases/SignalAuthState)
*   [SignalCreds](/docs/api/type-aliases/SignalCreds)
*   [SignalDataSet](/docs/api/type-aliases/SignalDataSet)
*   [SignalDataTypeMap](/docs/api/type-aliases/SignalDataTypeMap)
*   [SignalIdentity](/docs/api/type-aliases/SignalIdentity)
*   [SignalKeyStore](/docs/api/type-aliases/SignalKeyStore)
*   [SignalKeyStoreWithTransaction](/docs/api/type-aliases/SignalKeyStoreWithTransaction)
*   [SignalRepository](/docs/api/type-aliases/SignalRepository)
*   [SignedKeyPair](/docs/api/type-aliases/SignedKeyPair)
*   [SocketConfig](/docs/api/type-aliases/SocketConfig)
*   [StatusData](/docs/api/type-aliases/StatusData)
*   [TransactionCapabilityOptions](/docs/api/type-aliases/TransactionCapabilityOptions)
*   [UploadParams](/docs/api/type-aliases/UploadParams)
*   [URLGenerationOptions](/docs/api/type-aliases/URLGenerationOptions)
*   [UserFacingSocketConfig](/docs/api/type-aliases/UserFacingSocketConfig)
*   [USyncQueryResult](/docs/api/type-aliases/USyncQueryResult)
*   [USyncQueryResultList](/docs/api/type-aliases/USyncQueryResultList)
*   [Value](/docs/api/type-aliases/Value)
*   [WABrowserDescription](/docs/api/type-aliases/WABrowserDescription)
*   [WABusinessHoursConfig](/docs/api/type-aliases/WABusinessHoursConfig)
*   [WABusinessProfile](/docs/api/type-aliases/WABusinessProfile)
*   [WACallEvent](/docs/api/type-aliases/WACallEvent)
*   [WACallUpdateType](/docs/api/type-aliases/WACallUpdateType)
*   [WAConnectionState](/docs/api/type-aliases/WAConnectionState)
*   [WAContactMessage](/docs/api/type-aliases/WAContactMessage)
*   [WAContactsArrayMessage](/docs/api/type-aliases/WAContactsArrayMessage)
*   [WAContextInfo](/docs/api/type-aliases/WAContextInfo)
*   [WAGenericMediaMessage](/docs/api/type-aliases/WAGenericMediaMessage)
*   [WAInitResponse](/docs/api/type-aliases/WAInitResponse)
*   [WALocationMessage](/docs/api/type-aliases/WALocationMessage)
*   [WAMediaPayloadStream](/docs/api/type-aliases/WAMediaPayloadStream)
*   [WAMediaPayloadURL](/docs/api/type-aliases/WAMediaPayloadURL)
*   [WAMediaUpload](/docs/api/type-aliases/WAMediaUpload)
*   [WAMediaUploadFunction](/docs/api/type-aliases/WAMediaUploadFunction)
*   [WAMessage](/docs/api/type-aliases/WAMessage)
*   [WAMessageContent](/docs/api/type-aliases/WAMessageContent)
*   [WAMessageCursor](/docs/api/type-aliases/WAMessageCursor)
*   [WAMessageKey](/docs/api/type-aliases/WAMessageKey)
*   [WAMessageUpdate](/docs/api/type-aliases/WAMessageUpdate)
*   [WAPatchCreate](/docs/api/type-aliases/WAPatchCreate)
*   [WAPatchName](/docs/api/type-aliases/WAPatchName)
*   [WAPresence](/docs/api/type-aliases/WAPresence)
*   [WAPrivacyCallValue](/docs/api/type-aliases/WAPrivacyCallValue)
*   [WAPrivacyGroupAddValue](/docs/api/type-aliases/WAPrivacyGroupAddValue)
*   [WAPrivacyMessagesValue](/docs/api/type-aliases/WAPrivacyMessagesValue)
*   [WAPrivacyOnlineValue](/docs/api/type-aliases/WAPrivacyOnlineValue)
*   [WAPrivacyValue](/docs/api/type-aliases/WAPrivacyValue)
*   [WAReadReceiptsValue](/docs/api/type-aliases/WAReadReceiptsValue)
*   [WASendableProduct](/docs/api/type-aliases/WASendableProduct)
*   [WASocket](/docs/api/type-aliases/WASocket)
*   [WATextMessage](/docs/api/type-aliases/WATextMessage)
*   [WAVersion](/docs/api/type-aliases/WAVersion)

## Variables[​](#variables "Direct link to Variables")

*   [ALL\_WA\_PATCH\_NAMES](/docs/api/variables/ALL_WA_PATCH_NAMES)
*   [Browsers](/docs/api/variables/Browsers)
*   [BufferJSON](/docs/api/variables/BufferJSON)
*   [CALL\_AUDIO\_PREFIX](/docs/api/variables/CALL_AUDIO_PREFIX)
*   [CALL\_VIDEO\_PREFIX](/docs/api/variables/CALL_VIDEO_PREFIX)
*   [Curve](/docs/api/variables/Curve)
*   [DECRYPTION\_RETRY\_CONFIG](/docs/api/variables/DECRYPTION_RETRY_CONFIG)
*   [DEF\_CALLBACK\_PREFIX](/docs/api/variables/DEF_CALLBACK_PREFIX)
*   [DEF\_TAG\_PREFIX](/docs/api/variables/DEF_TAG_PREFIX)
*   [DEFAULT\_CACHE\_TTLS](/docs/api/variables/DEFAULT_CACHE_TTLS)
*   [DEFAULT\_CONNECTION\_CONFIG](/docs/api/variables/DEFAULT_CONNECTION_CONFIG)
*   [DEFAULT\_ORIGIN](/docs/api/variables/DEFAULT_ORIGIN)
*   [DICT\_VERSION](/docs/api/variables/DICT_VERSION)
*   [FLAG\_BYTE](/docs/api/variables/FLAG_BYTE)
*   [FLAG\_EVENT](/docs/api/variables/FLAG_EVENT)
*   [FLAG\_EXTENDED](/docs/api/variables/FLAG_EXTENDED)
*   [FLAG\_FIELD](/docs/api/variables/FLAG_FIELD)
*   [FLAG\_GLOBAL](/docs/api/variables/FLAG_GLOBAL)
*   [INITIAL\_PREKEY\_COUNT](/docs/api/variables/INITIAL_PREKEY_COUNT)
*   [KEY\_BUNDLE\_TYPE](/docs/api/variables/KEY_BUNDLE_TYPE)
*   [LT\_HASH\_ANTI\_TAMPERING](/docs/api/variables/LT_HASH_ANTI_TAMPERING)
*   [MEDIA\_HKDF\_KEY\_MAPPING](/docs/api/variables/MEDIA_HKDF_KEY_MAPPING)
*   [MEDIA\_KEYS](/docs/api/variables/MEDIA_KEYS)
*   [MEDIA\_PATH\_MAP](/docs/api/variables/MEDIA_PATH_MAP)
*   [META\_AI\_JID](/docs/api/variables/META_AI_JID)
*   [MIN\_PREKEY\_COUNT](/docs/api/variables/MIN_PREKEY_COUNT)
*   [MIN\_UPLOAD\_INTERVAL](/docs/api/variables/MIN_UPLOAD_INTERVAL)
*   [MISSING\_KEYS\_ERROR\_TEXT](/docs/api/variables/MISSING_KEYS_ERROR_TEXT)
*   [NACK\_REASONS](/docs/api/variables/NACK_REASONS)
*   [NO\_MESSAGE\_FOUND\_ERROR\_TEXT](/docs/api/variables/NO_MESSAGE_FOUND_ERROR_TEXT)
*   [NOISE\_MODE](/docs/api/variables/NOISE_MODE)
*   [NOISE\_WA\_HEADER](/docs/api/variables/NOISE_WA_HEADER)
*   [OFFICIAL\_BIZ\_JID](/docs/api/variables/OFFICIAL_BIZ_JID)
*   [PHONE\_CONNECTION\_CB](/docs/api/variables/PHONE_CONNECTION_CB)
*   [PLACEHOLDER\_MAX\_AGE\_SECONDS](/docs/api/variables/PLACEHOLDER_MAX_AGE_SECONDS)
*   [PROCESSABLE\_HISTORY\_TYPES](/docs/api/variables/PROCESSABLE_HISTORY_TYPES)
*   [PSA\_WID](/docs/api/variables/PSA_WID)
*   [S\_WHATSAPP\_NET](/docs/api/variables/S_WHATSAPP_NET)
*   [SERVER\_JID](/docs/api/variables/SERVER_JID)
*   [STATUS\_EXPIRY\_SECONDS](/docs/api/variables/STATUS_EXPIRY_SECONDS)
*   [STORIES\_JID](/docs/api/variables/STORIES_JID)
*   [TimeMs](/docs/api/variables/TimeMs)
*   [UNAUTHORIZED\_CODES](/docs/api/variables/UNAUTHORIZED_CODES)
*   [UPLOAD\_TIMEOUT](/docs/api/variables/UPLOAD_TIMEOUT)
*   [URL\_REGEX](/docs/api/variables/URL_REGEX)
*   [WA\_ADV\_ACCOUNT\_SIG\_PREFIX](/docs/api/variables/WA_ADV_ACCOUNT_SIG_PREFIX)
*   [WA\_ADV\_DEVICE\_SIG\_PREFIX](/docs/api/variables/WA_ADV_DEVICE_SIG_PREFIX)
*   [WA\_ADV\_HOSTED\_ACCOUNT\_SIG\_PREFIX](/docs/api/variables/WA_ADV_HOSTED_ACCOUNT_SIG_PREFIX)
*   [WA\_ADV\_HOSTED\_DEVICE\_SIG\_PREFIX](/docs/api/variables/WA_ADV_HOSTED_DEVICE_SIG_PREFIX)
*   [WA\_CERT\_DETAILS](/docs/api/variables/WA_CERT_DETAILS)
*   [WA\_DEFAULT\_EPHEMERAL](/docs/api/variables/WA_DEFAULT_EPHEMERAL)
*   [WAMessageStatus](/docs/api/variables/WAMessageStatus)
*   [WAMessageStubType](/docs/api/variables/WAMessageStubType)
*   [WEB\_EVENTS](/docs/api/variables/WEB_EVENTS)
*   [WEB\_GLOBALS](/docs/api/variables/WEB_GLOBALS)

## Functions[​](#functions "Direct link to Functions")

*   [addTransactionCapability](/docs/api/functions/addTransactionCapability)
*   [aesDecrypt](/docs/api/functions/aesDecrypt)
*   [aesDecryptCTR](/docs/api/functions/aesDecryptCTR)
*   [aesDecryptGCM](/docs/api/functions/aesDecryptGCM)
*   [aesDecryptWithIV](/docs/api/functions/aesDecryptWithIV)
*   [aesEncrypt](/docs/api/functions/aesEncrypt)
*   [aesEncryptCTR](/docs/api/functions/aesEncryptCTR)
*   [aesEncryptGCM](/docs/api/functions/aesEncryptGCM)
*   [aesEncrypWithIV](/docs/api/functions/aesEncrypWithIV)
*   [aggregateMessageKeysNotFromMe](/docs/api/functions/aggregateMessageKeysNotFromMe)
*   [areJidsSameUser](/docs/api/functions/areJidsSameUser)
*   [assertMediaContent](/docs/api/functions/assertMediaContent)
*   [assertNodeErrorFree](/docs/api/functions/assertNodeErrorFree)
*   [binaryNodeToString](/docs/api/functions/binaryNodeToString)
*   [bindWaitForConnectionUpdate](/docs/api/functions/bindWaitForConnectionUpdate)
*   [bindWaitForEvent](/docs/api/functions/bindWaitForEvent)
*   [buildAckStanza](/docs/api/functions/buildAckStanza)
*   [bytesToCrockford](/docs/api/functions/bytesToCrockford)
*   [chatModificationToAppPatch](/docs/api/functions/chatModificationToAppPatch)
*   [cleanMessage](/docs/api/functions/cleanMessage)
*   [configureSuccessfulPairing](/docs/api/functions/configureSuccessfulPairing)
*   [createSignalIdentity](/docs/api/functions/createSignalIdentity)
*   [debouncedTimeout](/docs/api/functions/debouncedTimeout)
*   [decodeBinaryNode](/docs/api/functions/decodeBinaryNode)
*   [decodeDecompressedBinaryNode](/docs/api/functions/decodeDecompressedBinaryNode)
*   [decodeMediaRetryNode](/docs/api/functions/decodeMediaRetryNode)
*   [decodeMessageNode](/docs/api/functions/decodeMessageNode)
*   [decodePatches](/docs/api/functions/decodePatches)
*   [decodeSyncdMutations](/docs/api/functions/decodeSyncdMutations)
*   [decodeSyncdPatch](/docs/api/functions/decodeSyncdPatch)
*   [decodeSyncdSnapshot](/docs/api/functions/decodeSyncdSnapshot)
*   [decompressingIfRequired](/docs/api/functions/decompressingIfRequired)
*   [decryptEventResponse](/docs/api/functions/decryptEventResponse)
*   [decryptMediaRetryData](/docs/api/functions/decryptMediaRetryData)
*   [decryptMessageNode](/docs/api/functions/decryptMessageNode)
*   [decryptPollVote](/docs/api/functions/decryptPollVote)
*   [delay](/docs/api/functions/delay)
*   [delayCancellable](/docs/api/functions/delayCancellable)
*   [derivePairingCodeKey](/docs/api/functions/derivePairingCodeKey)
*   [downloadAndProcessHistorySyncNotification](/docs/api/functions/downloadAndProcessHistorySyncNotification)
*   [downloadContentFromMessage](/docs/api/functions/downloadContentFromMessage)
*   [downloadEncryptedContent](/docs/api/functions/downloadEncryptedContent)
*   [downloadExternalBlob](/docs/api/functions/downloadExternalBlob)
*   [downloadExternalPatch](/docs/api/functions/downloadExternalPatch)
*   [downloadHistory](/docs/api/functions/downloadHistory)
*   [downloadMediaMessage](/docs/api/functions/downloadMediaMessage)
*   [encodeBase64EncodedStringForUpload](/docs/api/functions/encodeBase64EncodedStringForUpload)
*   [encodeBigEndian](/docs/api/functions/encodeBigEndian)
*   [encodeBinaryNode](/docs/api/functions/encodeBinaryNode)
*   [encodeNewsletterMessage](/docs/api/functions/encodeNewsletterMessage)
*   [encodeSignedDeviceIdentity](/docs/api/functions/encodeSignedDeviceIdentity)
*   [encodeSyncdPatch](/docs/api/functions/encodeSyncdPatch)
*   [encodeWAM](/docs/api/functions/encodeWAM)
*   [encodeWAMessage](/docs/api/functions/encodeWAMessage)
*   [encryptedStream](/docs/api/functions/encryptedStream)
*   [encryptMediaRetryRequest](/docs/api/functions/encryptMediaRetryRequest)
*   [extensionForMediaMessage](/docs/api/functions/extensionForMediaMessage)
*   [extractAddressingContext](/docs/api/functions/extractAddressingContext)
*   [extractDeviceJids](/docs/api/functions/extractDeviceJids)
*   [extractImageThumb](/docs/api/functions/extractImageThumb)
*   [extractMessageContent](/docs/api/functions/extractMessageContent)
*   [extractSyncdPatches](/docs/api/functions/extractSyncdPatches)
*   [extractUrlFromText](/docs/api/functions/extractUrlFromText)
*   [fetchLatestBaileysVersion](/docs/api/functions/fetchLatestBaileysVersion)
*   [fetchLatestWaWebVersion](/docs/api/functions/fetchLatestWaWebVersion)
*   [generateForwardMessageContent](/docs/api/functions/generateForwardMessageContent)
*   [generateLinkPreviewIfRequired](/docs/api/functions/generateLinkPreviewIfRequired)
*   [generateLoginNode](/docs/api/functions/generateLoginNode)
*   [generateMdTagPrefix](/docs/api/functions/generateMdTagPrefix)
*   [generateMessageID](/docs/api/functions/generateMessageID)
*   [generateMessageIDV2](/docs/api/functions/generateMessageIDV2)
*   [generateOrGetPreKeys](/docs/api/functions/generateOrGetPreKeys)
*   [generateParticipantHashV2](/docs/api/functions/generateParticipantHashV2)
*   [generateProfilePicture](/docs/api/functions/generateProfilePicture)
*   [generateRegistrationId](/docs/api/functions/generateRegistrationId)
*   [generateRegistrationNode](/docs/api/functions/generateRegistrationNode)
*   [generateSignalPubKey](/docs/api/functions/generateSignalPubKey)
*   [generateThumbnail](/docs/api/functions/generateThumbnail)
*   [generateWAMessage](/docs/api/functions/generateWAMessage)
*   [generateWAMessageContent](/docs/api/functions/generateWAMessageContent)
*   [generateWAMessageFromContent](/docs/api/functions/generateWAMessageFromContent)
*   [getAggregateResponsesInEventMessage](/docs/api/functions/getAggregateResponsesInEventMessage)
*   [getAggregateVotesInPollMessage](/docs/api/functions/getAggregateVotesInPollMessage)
*   [getAllBinaryNodeChildren](/docs/api/functions/getAllBinaryNodeChildren)
*   [getAudioDuration](/docs/api/functions/getAudioDuration)
*   [getAudioWaveform](/docs/api/functions/getAudioWaveform)
*   [getBinaryNodeChild](/docs/api/functions/getBinaryNodeChild)
*   [getBinaryNodeChildBuffer](/docs/api/functions/getBinaryNodeChildBuffer)
*   [getBinaryNodeChildren](/docs/api/functions/getBinaryNodeChildren)
*   [getBinaryNodeChildString](/docs/api/functions/getBinaryNodeChildString)
*   [getBinaryNodeChildUInt](/docs/api/functions/getBinaryNodeChildUInt)
*   [getBinaryNodeMessages](/docs/api/functions/getBinaryNodeMessages)
*   [getCallStatusFromNode](/docs/api/functions/getCallStatusFromNode)
*   [getChatId](/docs/api/functions/getChatId)
*   [getCodeFromWSError](/docs/api/functions/getCodeFromWSError)
*   [getContentType](/docs/api/functions/getContentType)
*   [getDecryptionJid](/docs/api/functions/getDecryptionJid)
*   [getDevice](/docs/api/functions/getDevice)
*   [getErrorCodeFromStreamError](/docs/api/functions/getErrorCodeFromStreamError)
*   [getHistoryMsg](/docs/api/functions/getHistoryMsg)
*   [getHttpStream](/docs/api/functions/getHttpStream)
*   [getKeyAuthor](/docs/api/functions/getKeyAuthor)
*   [getMediaKeys](/docs/api/functions/getMediaKeys)
*   [getNextPreKeys](/docs/api/functions/getNextPreKeys)
*   [getNextPreKeysNode](/docs/api/functions/getNextPreKeysNode)
*   [getPlatformId](/docs/api/functions/getPlatformId)
*   [getPreKeys](/docs/api/functions/getPreKeys)
*   [getRawMediaUploadData](/docs/api/functions/getRawMediaUploadData)
*   [getServerFromDomainType](/docs/api/functions/getServerFromDomainType)
*   [getStatusCodeForMediaRetry](/docs/api/functions/getStatusCodeForMediaRetry)
*   [getStatusFromReceiptType](/docs/api/functions/getStatusFromReceiptType)
*   [getStream](/docs/api/functions/getStream)
*   [getUrlFromDirectPath](/docs/api/functions/getUrlFromDirectPath)
*   [getUrlInfo](/docs/api/functions/getUrlInfo)
*   [getWAUploadToServer](/docs/api/functions/getWAUploadToServer)
*   [handleIdentityChange](/docs/api/functions/handleIdentityChange)
*   [hasNonNullishProperty](/docs/api/functions/hasNonNullishProperty)
*   [hkdfInfoKey](/docs/api/functions/hkdfInfoKey)
*   [hmacSign](/docs/api/functions/hmacSign)
*   [initAuthCreds](/docs/api/functions/initAuthCreds)
*   [isHostedLidUser](/docs/api/functions/isHostedLidUser)
*   [isHostedPnUser](/docs/api/functions/isHostedPnUser)
*   [isJidBot](/docs/api/functions/isJidBot)
*   [isJidBroadcast](/docs/api/functions/isJidBroadcast)
*   [isJidGroup](/docs/api/functions/isJidGroup)
*   [isJidMetaAI](/docs/api/functions/isJidMetaAI)
*   [isJidNewsletter](/docs/api/functions/isJidNewsletter)
*   [isJidStatusBroadcast](/docs/api/functions/isJidStatusBroadcast)
*   [isLidUser](/docs/api/functions/isLidUser)
*   [isPnUser](/docs/api/functions/isPnUser)
*   [isRealMessage](/docs/api/functions/isRealMessage)
*   [isStringNullOrEmpty](/docs/api/functions/isStringNullOrEmpty)
*   [isWABusinessPlatform](/docs/api/functions/isWABusinessPlatform)
*   [jidDecode](/docs/api/functions/jidDecode)
*   [jidEncode](/docs/api/functions/jidEncode)
*   [jidNormalizedUser](/docs/api/functions/jidNormalizedUser)
*   [makeCacheableSignalKeyStore](/docs/api/functions/makeCacheableSignalKeyStore)
*   [makeEventBuffer](/docs/api/functions/makeEventBuffer)
*   [makeNoiseHandler](/docs/api/functions/makeNoiseHandler)
*   [makeWASocket](/docs/api/functions/makeWASocket)
*   [mediaMessageSHA256B64](/docs/api/functions/mediaMessageSHA256B64)
*   [newLTHashState](/docs/api/functions/newLTHashState)
*   [normalizeMessageContent](/docs/api/functions/normalizeMessageContent)
*   [parseAndInjectE2ESessions](/docs/api/functions/parseAndInjectE2ESessions)
*   [prepareDisappearingMessageSettingContent](/docs/api/functions/prepareDisappearingMessageSettingContent)
*   [prepareWAMessageMedia](/docs/api/functions/prepareWAMessageMedia)
*   [processHistoryMessage](/docs/api/functions/processHistoryMessage)
*   [processSyncAction](/docs/api/functions/processSyncAction)
*   [promiseTimeout](/docs/api/functions/promiseTimeout)
*   [reduceBinaryNodeToDictionary](/docs/api/functions/reduceBinaryNodeToDictionary)
*   [sha256](/docs/api/functions/sha256)
*   [shouldIncrementChatUnread](/docs/api/functions/shouldIncrementChatUnread)
*   [signedKeyPair](/docs/api/functions/signedKeyPair)
*   [toBuffer](/docs/api/functions/toBuffer)
*   [toNumber](/docs/api/functions/toNumber)
*   [toReadable](/docs/api/functions/toReadable)
*   [transferDevice](/docs/api/functions/transferDevice)
*   [trimUndefined](/docs/api/functions/trimUndefined)
*   [unixTimestampSeconds](/docs/api/functions/unixTimestampSeconds)
*   [unpadRandomMax16](/docs/api/functions/unpadRandomMax16)
*   [updateMessageWithEventResponse](/docs/api/functions/updateMessageWithEventResponse)
*   [updateMessageWithPollUpdate](/docs/api/functions/updateMessageWithPollUpdate)
*   [updateMessageWithReaction](/docs/api/functions/updateMessageWithReaction)
*   [updateMessageWithReceipt](/docs/api/functions/updateMessageWithReceipt)
*   [uploadWithNodeHttp](/docs/api/functions/uploadWithNodeHttp)
*   [useMultiFileAuthState](/docs/api/functions/useMultiFileAuthState)
*   [writeRandomPadMax16](/docs/api/functions/writeRandomPadMax16)
*   [xmppPreKey](/docs/api/functions/xmppPreKey)
*   [xmppSignedPreKey](/docs/api/functions/xmppSignedPreKey)

## References[​](#references "Direct link to References")

### default[​](#default "Direct link to default")

Renames and re-exports [makeWASocket](/docs/api/functions/makeWASocket)

* * *

### WAProto[​](#waproto "Direct link to WAProto")

Renames and re-exports [proto](/docs/api/namespaces/proto/)

---

<a name="class-binaryinfo"></a>

> Source: [https://baileys.wiki/docs/api/classes/BinaryInfo](https://baileys.wiki/docs/api/classes/BinaryInfo)

Defined in: [src/WAM/BinaryInfo.ts:3](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAM/BinaryInfo.ts#L3)

## Constructors[​](#constructors "Direct link to Constructors")

### new BinaryInfo()[​](#new-binaryinfo "Direct link to new BinaryInfo()")

> **new BinaryInfo**(`options`): [`BinaryInfo`](/docs/api/classes/BinaryInfo)

Defined in: [src/WAM/BinaryInfo.ts:9](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAM/BinaryInfo.ts#L9)

#### Parameters[​](#parameters "Direct link to Parameters")

##### options[​](#options "Direct link to options")

`Partial`<[`BinaryInfo`](/docs/api/classes/BinaryInfo)\> = `{}`

#### Returns[​](#returns "Direct link to Returns")

[`BinaryInfo`](/docs/api/classes/BinaryInfo)

## Properties[​](#properties "Direct link to Properties")

### buffer[​](#buffer "Direct link to buffer")

> **buffer**: `Buffer`<`ArrayBufferLike`\>\[\] = `[]`

Defined in: [src/WAM/BinaryInfo.ts:7](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAM/BinaryInfo.ts#L7)

* * *

### events[​](#events "Direct link to events")

> **events**: `object`\[\]

Defined in: [src/WAM/BinaryInfo.ts:6](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAM/BinaryInfo.ts#L6)

#### Index Signature[​](#index-signature "Direct link to Index Signature")

\[`key`: `string`\]: `object`

* * *

### protocolVersion[​](#protocolversion "Direct link to protocolVersion")

> **protocolVersion**: `number` = `5`

Defined in: [src/WAM/BinaryInfo.ts:4](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAM/BinaryInfo.ts#L4)

* * *

### sequence[​](#sequence "Direct link to sequence")

> **sequence**: `number` = `0`

Defined in: [src/WAM/BinaryInfo.ts:5](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAM/BinaryInfo.ts#L5)

---

<a name="class-messageretrymanager"></a>

> Source: [https://baileys.wiki/docs/api/classes/MessageRetryManager](https://baileys.wiki/docs/api/classes/MessageRetryManager)

Defined in: [src/Utils/message-retry-manager.ts:65](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L65)

## Constructors[​](#constructors "Direct link to Constructors")

### new MessageRetryManager()[​](#new-messageretrymanager "Direct link to new MessageRetryManager()")

> **new MessageRetryManager**(`logger`, `maxMsgRetryCount`): [`MessageRetryManager`](/docs/api/classes/MessageRetryManager)

Defined in: [src/Utils/message-retry-manager.ts:99](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L99)

#### Parameters[​](#parameters "Direct link to Parameters")

##### logger[​](#logger "Direct link to logger")

`ILogger`

##### maxMsgRetryCount[​](#maxmsgretrycount "Direct link to maxMsgRetryCount")

`number`

#### Returns[​](#returns "Direct link to Returns")

[`MessageRetryManager`](/docs/api/classes/MessageRetryManager)

## Methods[​](#methods "Direct link to Methods")

### addRecentMessage()[​](#addrecentmessage "Direct link to addRecentMessage()")

> **addRecentMessage**(`to`, `id`, `message`): `void`

Defined in: [src/Utils/message-retry-manager.ts:109](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L109)

Add a recent message to the cache for retry handling

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### to[​](#to "Direct link to to")

`string`

##### id[​](#id "Direct link to id")

`string`

##### message[​](#message "Direct link to message")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

* * *

### cancelPendingPhoneRequest()[​](#cancelpendingphonerequest "Direct link to cancelPendingPhoneRequest()")

> **cancelPendingPhoneRequest**(`messageId`): `void`

Defined in: [src/Utils/message-retry-manager.ts:273](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L273)

Cancel pending phone request

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### messageId[​](#messageid "Direct link to messageId")

`string`

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

* * *

### getRecentMessage()[​](#getrecentmessage "Direct link to getRecentMessage()")

> **getRecentMessage**(`to`, `id`): `undefined` | [`RecentMessage`](/docs/api/interfaces/RecentMessage)

Defined in: [src/Utils/message-retry-manager.ts:126](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L126)

Get a recent message from the cache

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### to[​](#to-1 "Direct link to to")

`string`

##### id[​](#id-1 "Direct link to id")

`string`

#### Returns[​](#returns-3 "Direct link to Returns")

`undefined` | [`RecentMessage`](/docs/api/interfaces/RecentMessage)

* * *

### getRetryCount()[​](#getretrycount "Direct link to getRetryCount()")

> **getRetryCount**(`messageId`): `number`

Defined in: [src/Utils/message-retry-manager.ts:222](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L222)

Get retry count for a message

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### messageId[​](#messageid-1 "Direct link to messageId")

`string`

#### Returns[​](#returns-4 "Direct link to Returns")

`number`

* * *

### hasExceededMaxRetries()[​](#hasexceededmaxretries "Direct link to hasExceededMaxRetries()")

> **hasExceededMaxRetries**(`messageId`): `boolean`

Defined in: [src/Utils/message-retry-manager.ts:229](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L229)

Check if message has exceeded maximum retry attempts

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### messageId[​](#messageid-2 "Direct link to messageId")

`string`

#### Returns[​](#returns-5 "Direct link to Returns")

`boolean`

* * *

### incrementRetryCount()[​](#incrementretrycount "Direct link to incrementRetryCount()")

> **incrementRetryCount**(`messageId`): `number`

Defined in: [src/Utils/message-retry-manager.ts:213](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L213)

Increment retry counter for a message

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### messageId[​](#messageid-3 "Direct link to messageId")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`number`

* * *

### isMacError()[​](#ismacerror "Direct link to isMacError()")

> **isMacError**(`errorCode`): `boolean`

Defined in: [src/Utils/message-retry-manager.ts:206](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L206)

Check if an error code indicates a MAC failure

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### errorCode[​](#errorcode "Direct link to errorCode")

`undefined` | [`RetryReason`](/docs/api/enumerations/RetryReason)

#### Returns[​](#returns-7 "Direct link to Returns")

`boolean`

* * *

### markRetryFailed()[​](#markretryfailed "Direct link to markRetryFailed()")

> **markRetryFailed**(`messageId`): `void`

Defined in: [src/Utils/message-retry-manager.ts:247](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L247)

Mark retry as failed

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### messageId[​](#messageid-4 "Direct link to messageId")

`string`

#### Returns[​](#returns-8 "Direct link to Returns")

`void`

* * *

### markRetrySuccess()[​](#markretrysuccess "Direct link to markRetrySuccess()")

> **markRetrySuccess**(`messageId`): `void`

Defined in: [src/Utils/message-retry-manager.ts:236](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L236)

Mark retry as successful

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### messageId[​](#messageid-5 "Direct link to messageId")

`string`

#### Returns[​](#returns-9 "Direct link to Returns")

`void`

* * *

### parseRetryErrorCode()[​](#parseretryerrorcode "Direct link to parseRetryErrorCode()")

> **parseRetryErrorCode**(`errorAttr`): `undefined` | [`RetryReason`](/docs/api/enumerations/RetryReason)

Defined in: [src/Utils/message-retry-manager.ts:185](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L185)

Parse error code from retry receipt's retry node. Returns undefined if no error code is present.

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### errorAttr[​](#errorattr "Direct link to errorAttr")

`undefined` | `string`

#### Returns[​](#returns-10 "Direct link to Returns")

`undefined` | [`RetryReason`](/docs/api/enumerations/RetryReason)

* * *

### schedulePhoneRequest()[​](#schedulephonerequest "Direct link to schedulePhoneRequest()")

> **schedulePhoneRequest**(`messageId`, `callback`, `delay`): `void`

Defined in: [src/Utils/message-retry-manager.ts:257](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L257)

Schedule a phone request with delay

#### Parameters[​](#parameters-11 "Direct link to Parameters")

##### messageId[​](#messageid-6 "Direct link to messageId")

`string`

##### callback[​](#callback "Direct link to callback")

() => `void`

##### delay[​](#delay "Direct link to delay")

`number` = `PHONE_REQUEST_DELAY`

#### Returns[​](#returns-11 "Direct link to Returns")

`void`

* * *

### shouldRecreateSession()[​](#shouldrecreatesession "Direct link to shouldRecreateSession()")

> **shouldRecreateSession**(`jid`, `hasSession`, `errorCode`?): `object`

Defined in: [src/Utils/message-retry-manager.ts:136](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L136)

Check if a session should be recreated based on retry count, history, and error code. MAC errors (codes 4 and 7) trigger immediate session recreation regardless of timeout.

#### Parameters[​](#parameters-12 "Direct link to Parameters")

##### jid[​](#jid "Direct link to jid")

`string`

##### hasSession[​](#hassession "Direct link to hasSession")

`boolean`

##### errorCode?[​](#errorcode-1 "Direct link to errorCode?")

[`RetryReason`](/docs/api/enumerations/RetryReason)

#### Returns[​](#returns-12 "Direct link to Returns")

`object`

##### reason[​](#reason "Direct link to reason")

> **reason**: `string`

##### recreate[​](#recreate "Direct link to recreate")

> **recreate**: `boolean`

---

<a name="class-usynccontactprotocol"></a>

> Source: [https://baileys.wiki/docs/api/classes/USyncContactProtocol](https://baileys.wiki/docs/api/classes/USyncContactProtocol)

Defined in: [src/WAUSync/Protocols/USyncContactProtocol.ts:5](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncContactProtocol.ts#L5)

## Implements[​](#implements "Direct link to Implements")

*   `USyncQueryProtocol`

## Constructors[​](#constructors "Direct link to Constructors")

### new USyncContactProtocol()[​](#new-usynccontactprotocol "Direct link to new USyncContactProtocol()")

> **new USyncContactProtocol**(): [`USyncContactProtocol`](/docs/api/classes/USyncContactProtocol)

#### Returns[​](#returns "Direct link to Returns")

[`USyncContactProtocol`](/docs/api/classes/USyncContactProtocol)

## Properties[​](#properties "Direct link to Properties")

### name[​](#name "Direct link to name")

> **name**: `string` = `'contact'`

Defined in: [src/WAUSync/Protocols/USyncContactProtocol.ts:6](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncContactProtocol.ts#L6)

The name of the protocol

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

`USyncQueryProtocol.name`

## Methods[​](#methods "Direct link to Methods")

### getQueryElement()[​](#getqueryelement "Direct link to getQueryElement()")

> **getQueryElement**(): [`BinaryNode`](/docs/api/type-aliases/BinaryNode)

Defined in: [src/WAUSync/Protocols/USyncContactProtocol.ts:8](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncContactProtocol.ts#L8)

Defines what goes inside the query part of a USyncQuery

#### Returns[​](#returns-1 "Direct link to Returns")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

`USyncQueryProtocol.getQueryElement`

* * *

### getUserElement()[​](#getuserelement "Direct link to getUserElement()")

> **getUserElement**(`user`): [`BinaryNode`](/docs/api/type-aliases/BinaryNode)

Defined in: [src/WAUSync/Protocols/USyncContactProtocol.ts:15](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncContactProtocol.ts#L15)

Defines what goes inside the user part of a USyncQuery

#### Parameters[​](#parameters "Direct link to Parameters")

##### user[​](#user "Direct link to user")

[`USyncUser`](/docs/api/classes/USyncUser)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

`USyncQueryProtocol.getUserElement`

* * *

### parser()[​](#parser "Direct link to parser()")

> **parser**(`node`): `boolean`

Defined in: [src/WAUSync/Protocols/USyncContactProtocol.ts:24](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncContactProtocol.ts#L24)

Parse the result of the query

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### node[​](#node "Direct link to node")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

#### Returns[​](#returns-3 "Direct link to Returns")

`boolean`

Whatever the protocol is supposed to return

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

`USyncQueryProtocol.parser`

---

<a name="class-usyncdeviceprotocol"></a>

> Source: [https://baileys.wiki/docs/api/classes/USyncDeviceProtocol](https://baileys.wiki/docs/api/classes/USyncDeviceProtocol)

Defined in: [src/WAUSync/Protocols/USyncDeviceProtocol.ts:22](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncDeviceProtocol.ts#L22)

## Implements[​](#implements "Direct link to Implements")

*   `USyncQueryProtocol`

## Constructors[​](#constructors "Direct link to Constructors")

### new USyncDeviceProtocol()[​](#new-usyncdeviceprotocol "Direct link to new USyncDeviceProtocol()")

> **new USyncDeviceProtocol**(): [`USyncDeviceProtocol`](/docs/api/classes/USyncDeviceProtocol)

#### Returns[​](#returns "Direct link to Returns")

[`USyncDeviceProtocol`](/docs/api/classes/USyncDeviceProtocol)

## Properties[​](#properties "Direct link to Properties")

### name[​](#name "Direct link to name")

> **name**: `string` = `'devices'`

Defined in: [src/WAUSync/Protocols/USyncDeviceProtocol.ts:23](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncDeviceProtocol.ts#L23)

The name of the protocol

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

`USyncQueryProtocol.name`

## Methods[​](#methods "Direct link to Methods")

### getQueryElement()[​](#getqueryelement "Direct link to getQueryElement()")

> **getQueryElement**(): [`BinaryNode`](/docs/api/type-aliases/BinaryNode)

Defined in: [src/WAUSync/Protocols/USyncDeviceProtocol.ts:25](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncDeviceProtocol.ts#L25)

Defines what goes inside the query part of a USyncQuery

#### Returns[​](#returns-1 "Direct link to Returns")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

`USyncQueryProtocol.getQueryElement`

* * *

### getUserElement()[​](#getuserelement "Direct link to getUserElement()")

> **getUserElement**(): `null` | [`BinaryNode`](/docs/api/type-aliases/BinaryNode)

Defined in: [src/WAUSync/Protocols/USyncDeviceProtocol.ts:34](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncDeviceProtocol.ts#L34)

Defines what goes inside the user part of a USyncQuery

#### Returns[​](#returns-2 "Direct link to Returns")

`null` | [`BinaryNode`](/docs/api/type-aliases/BinaryNode)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

`USyncQueryProtocol.getUserElement`

* * *

### parser()[​](#parser "Direct link to parser()")

> **parser**(`node`): [`ParsedDeviceInfo`](/docs/api/type-aliases/ParsedDeviceInfo)

Defined in: [src/WAUSync/Protocols/USyncDeviceProtocol.ts:41](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncDeviceProtocol.ts#L41)

Parse the result of the query

#### Parameters[​](#parameters "Direct link to Parameters")

##### node[​](#node "Direct link to node")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

#### Returns[​](#returns-3 "Direct link to Returns")

[`ParsedDeviceInfo`](/docs/api/type-aliases/ParsedDeviceInfo)

Whatever the protocol is supposed to return

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

`USyncQueryProtocol.parser`

---

<a name="class-usyncdisappearingmodeprotocol"></a>

> Source: [https://baileys.wiki/docs/api/classes/USyncDisappearingModeProtocol](https://baileys.wiki/docs/api/classes/USyncDisappearingModeProtocol)

Defined in: [src/WAUSync/Protocols/USyncDisappearingModeProtocol.ts:9](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncDisappearingModeProtocol.ts#L9)

## Implements[​](#implements "Direct link to Implements")

*   `USyncQueryProtocol`

## Constructors[​](#constructors "Direct link to Constructors")

### new USyncDisappearingModeProtocol()[​](#new-usyncdisappearingmodeprotocol "Direct link to new USyncDisappearingModeProtocol()")

> **new USyncDisappearingModeProtocol**(): [`USyncDisappearingModeProtocol`](/docs/api/classes/USyncDisappearingModeProtocol)

#### Returns[​](#returns "Direct link to Returns")

[`USyncDisappearingModeProtocol`](/docs/api/classes/USyncDisappearingModeProtocol)

## Properties[​](#properties "Direct link to Properties")

### name[​](#name "Direct link to name")

> **name**: `string` = `'disappearing_mode'`

Defined in: [src/WAUSync/Protocols/USyncDisappearingModeProtocol.ts:10](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncDisappearingModeProtocol.ts#L10)

The name of the protocol

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

`USyncQueryProtocol.name`

## Methods[​](#methods "Direct link to Methods")

### getQueryElement()[​](#getqueryelement "Direct link to getQueryElement()")

> **getQueryElement**(): [`BinaryNode`](/docs/api/type-aliases/BinaryNode)

Defined in: [src/WAUSync/Protocols/USyncDisappearingModeProtocol.ts:12](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncDisappearingModeProtocol.ts#L12)

Defines what goes inside the query part of a USyncQuery

#### Returns[​](#returns-1 "Direct link to Returns")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

`USyncQueryProtocol.getQueryElement`

* * *

### getUserElement()[​](#getuserelement "Direct link to getUserElement()")

> **getUserElement**(): `null`

Defined in: [src/WAUSync/Protocols/USyncDisappearingModeProtocol.ts:19](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncDisappearingModeProtocol.ts#L19)

Defines what goes inside the user part of a USyncQuery

#### Returns[​](#returns-2 "Direct link to Returns")

`null`

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

`USyncQueryProtocol.getUserElement`

* * *

### parser()[​](#parser "Direct link to parser()")

> **parser**(`node`): `undefined` | [`DisappearingModeData`](/docs/api/type-aliases/DisappearingModeData)

Defined in: [src/WAUSync/Protocols/USyncDisappearingModeProtocol.ts:23](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncDisappearingModeProtocol.ts#L23)

Parse the result of the query

#### Parameters[​](#parameters "Direct link to Parameters")

##### node[​](#node "Direct link to node")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

#### Returns[​](#returns-3 "Direct link to Returns")

`undefined` | [`DisappearingModeData`](/docs/api/type-aliases/DisappearingModeData)

Whatever the protocol is supposed to return

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

`USyncQueryProtocol.parser`

---

<a name="class-usyncquery"></a>

> Source: [https://baileys.wiki/docs/api/classes/USyncQuery](https://baileys.wiki/docs/api/classes/USyncQuery)

Defined in: [src/WAUSync/USyncQuery.ts:20](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncQuery.ts#L20)

## Constructors[​](#constructors "Direct link to Constructors")

### new USyncQuery()[​](#new-usyncquery "Direct link to new USyncQuery()")

> **new USyncQuery**(): [`USyncQuery`](/docs/api/classes/USyncQuery)

Defined in: [src/WAUSync/USyncQuery.ts:26](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncQuery.ts#L26)

#### Returns[​](#returns "Direct link to Returns")

[`USyncQuery`](/docs/api/classes/USyncQuery)

## Properties[​](#properties "Direct link to Properties")

### context[​](#context "Direct link to context")

> **context**: `string`

Defined in: [src/WAUSync/USyncQuery.ts:23](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncQuery.ts#L23)

* * *

### mode[​](#mode "Direct link to mode")

> **mode**: `string`

Defined in: [src/WAUSync/USyncQuery.ts:24](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncQuery.ts#L24)

* * *

### protocols[​](#protocols "Direct link to protocols")

> **protocols**: `USyncQueryProtocol`\[\]

Defined in: [src/WAUSync/USyncQuery.ts:21](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncQuery.ts#L21)

* * *

### users[​](#users "Direct link to users")

> **users**: [`USyncUser`](/docs/api/classes/USyncUser)\[\]

Defined in: [src/WAUSync/USyncQuery.ts:22](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncQuery.ts#L22)

## Methods[​](#methods "Direct link to Methods")

### parseUSyncQueryResult()[​](#parseusyncqueryresult "Direct link to parseUSyncQueryResult()")

> **parseUSyncQueryResult**(`result`): `undefined` | [`USyncQueryResult`](/docs/api/type-aliases/USyncQueryResult)

Defined in: [src/WAUSync/USyncQuery.ts:48](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncQuery.ts#L48)

#### Parameters[​](#parameters "Direct link to Parameters")

##### result[​](#result "Direct link to result")

`undefined` | [`BinaryNode`](/docs/api/type-aliases/BinaryNode)

#### Returns[​](#returns-1 "Direct link to Returns")

`undefined` | [`USyncQueryResult`](/docs/api/type-aliases/USyncQueryResult)

* * *

### withBotProfileProtocol()[​](#withbotprofileprotocol "Direct link to withBotProfileProtocol()")

> **withBotProfileProtocol**(): [`USyncQuery`](/docs/api/classes/USyncQuery)

Defined in: [src/WAUSync/USyncQuery.ts:124](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncQuery.ts#L124)

#### Returns[​](#returns-2 "Direct link to Returns")

[`USyncQuery`](/docs/api/classes/USyncQuery)

* * *

### withContactProtocol()[​](#withcontactprotocol "Direct link to withContactProtocol()")

> **withContactProtocol**(): [`USyncQuery`](/docs/api/classes/USyncQuery)

Defined in: [src/WAUSync/USyncQuery.ts:109](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncQuery.ts#L109)

#### Returns[​](#returns-3 "Direct link to Returns")

[`USyncQuery`](/docs/api/classes/USyncQuery)

* * *

### withContext()[​](#withcontext "Direct link to withContext()")

> **withContext**(`context`): [`USyncQuery`](/docs/api/classes/USyncQuery)

Defined in: [src/WAUSync/USyncQuery.ts:38](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncQuery.ts#L38)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### context[​](#context-1 "Direct link to context")

`string`

#### Returns[​](#returns-4 "Direct link to Returns")

[`USyncQuery`](/docs/api/classes/USyncQuery)

* * *

### withDeviceProtocol()[​](#withdeviceprotocol "Direct link to withDeviceProtocol()")

> **withDeviceProtocol**(): [`USyncQuery`](/docs/api/classes/USyncQuery)

Defined in: [src/WAUSync/USyncQuery.ts:104](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncQuery.ts#L104)

#### Returns[​](#returns-5 "Direct link to Returns")

[`USyncQuery`](/docs/api/classes/USyncQuery)

* * *

### withDisappearingModeProtocol()[​](#withdisappearingmodeprotocol "Direct link to withDisappearingModeProtocol()")

> **withDisappearingModeProtocol**(): [`USyncQuery`](/docs/api/classes/USyncQuery)

Defined in: [src/WAUSync/USyncQuery.ts:119](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncQuery.ts#L119)

#### Returns[​](#returns-6 "Direct link to Returns")

[`USyncQuery`](/docs/api/classes/USyncQuery)

* * *

### withLIDProtocol()[​](#withlidprotocol "Direct link to withLIDProtocol()")

> **withLIDProtocol**(): [`USyncQuery`](/docs/api/classes/USyncQuery)

Defined in: [src/WAUSync/USyncQuery.ts:129](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncQuery.ts#L129)

#### Returns[​](#returns-7 "Direct link to Returns")

[`USyncQuery`](/docs/api/classes/USyncQuery)

* * *

### withMode()[​](#withmode "Direct link to withMode()")

> **withMode**(`mode`): [`USyncQuery`](/docs/api/classes/USyncQuery)

Defined in: [src/WAUSync/USyncQuery.ts:33](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncQuery.ts#L33)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### mode[​](#mode-1 "Direct link to mode")

`string`

#### Returns[​](#returns-8 "Direct link to Returns")

[`USyncQuery`](/docs/api/classes/USyncQuery)

* * *

### withStatusProtocol()[​](#withstatusprotocol "Direct link to withStatusProtocol()")

> **withStatusProtocol**(): [`USyncQuery`](/docs/api/classes/USyncQuery)

Defined in: [src/WAUSync/USyncQuery.ts:114](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncQuery.ts#L114)

#### Returns[​](#returns-9 "Direct link to Returns")

[`USyncQuery`](/docs/api/classes/USyncQuery)

* * *

### withUser()[​](#withuser "Direct link to withUser()")

> **withUser**(`user`): [`USyncQuery`](/docs/api/classes/USyncQuery)

Defined in: [src/WAUSync/USyncQuery.ts:43](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncQuery.ts#L43)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### user[​](#user "Direct link to user")

[`USyncUser`](/docs/api/classes/USyncUser)

#### Returns[​](#returns-10 "Direct link to Returns")

[`USyncQuery`](/docs/api/classes/USyncQuery)

---

<a name="class-usyncstatusprotocol"></a>

> Source: [https://baileys.wiki/docs/api/classes/USyncStatusProtocol](https://baileys.wiki/docs/api/classes/USyncStatusProtocol)

Defined in: [src/WAUSync/Protocols/USyncStatusProtocol.ts:9](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncStatusProtocol.ts#L9)

## Implements[​](#implements "Direct link to Implements")

*   `USyncQueryProtocol`

## Constructors[​](#constructors "Direct link to Constructors")

### new USyncStatusProtocol()[​](#new-usyncstatusprotocol "Direct link to new USyncStatusProtocol()")

> **new USyncStatusProtocol**(): [`USyncStatusProtocol`](/docs/api/classes/USyncStatusProtocol)

#### Returns[​](#returns "Direct link to Returns")

[`USyncStatusProtocol`](/docs/api/classes/USyncStatusProtocol)

## Properties[​](#properties "Direct link to Properties")

### name[​](#name "Direct link to name")

> **name**: `string` = `'status'`

Defined in: [src/WAUSync/Protocols/USyncStatusProtocol.ts:10](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncStatusProtocol.ts#L10)

The name of the protocol

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

`USyncQueryProtocol.name`

## Methods[​](#methods "Direct link to Methods")

### getQueryElement()[​](#getqueryelement "Direct link to getQueryElement()")

> **getQueryElement**(): [`BinaryNode`](/docs/api/type-aliases/BinaryNode)

Defined in: [src/WAUSync/Protocols/USyncStatusProtocol.ts:12](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncStatusProtocol.ts#L12)

Defines what goes inside the query part of a USyncQuery

#### Returns[​](#returns-1 "Direct link to Returns")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

`USyncQueryProtocol.getQueryElement`

* * *

### getUserElement()[​](#getuserelement "Direct link to getUserElement()")

> **getUserElement**(): `null`

Defined in: [src/WAUSync/Protocols/USyncStatusProtocol.ts:19](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncStatusProtocol.ts#L19)

Defines what goes inside the user part of a USyncQuery

#### Returns[​](#returns-2 "Direct link to Returns")

`null`

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

`USyncQueryProtocol.getUserElement`

* * *

### parser()[​](#parser "Direct link to parser()")

> **parser**(`node`): `undefined` | [`StatusData`](/docs/api/type-aliases/StatusData)

Defined in: [src/WAUSync/Protocols/USyncStatusProtocol.ts:23](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncStatusProtocol.ts#L23)

Parse the result of the query

#### Parameters[​](#parameters "Direct link to Parameters")

##### node[​](#node "Direct link to node")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

#### Returns[​](#returns-3 "Direct link to Returns")

`undefined` | [`StatusData`](/docs/api/type-aliases/StatusData)

Whatever the protocol is supposed to return

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

`USyncQueryProtocol.parser`

---

<a name="class-usyncuser"></a>

> Source: [https://baileys.wiki/docs/api/classes/USyncUser](https://baileys.wiki/docs/api/classes/USyncUser)

Defined in: [src/WAUSync/USyncUser.ts:1](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncUser.ts#L1)

## Constructors[​](#constructors "Direct link to Constructors")

### new USyncUser()[​](#new-usyncuser "Direct link to new USyncUser()")

> **new USyncUser**(): [`USyncUser`](/docs/api/classes/USyncUser)

#### Returns[​](#returns "Direct link to Returns")

[`USyncUser`](/docs/api/classes/USyncUser)

## Properties[​](#properties "Direct link to Properties")

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

Defined in: [src/WAUSync/USyncUser.ts:2](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncUser.ts#L2)

* * *

### lid?[​](#lid "Direct link to lid?")

> `optional` **lid**: `string`

Defined in: [src/WAUSync/USyncUser.ts:3](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncUser.ts#L3)

* * *

### personaId?[​](#personaid "Direct link to personaId?")

> `optional` **personaId**: `string`

Defined in: [src/WAUSync/USyncUser.ts:6](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncUser.ts#L6)

* * *

### phone?[​](#phone "Direct link to phone?")

> `optional` **phone**: `string`

Defined in: [src/WAUSync/USyncUser.ts:4](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncUser.ts#L4)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `string`

Defined in: [src/WAUSync/USyncUser.ts:5](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncUser.ts#L5)

## Methods[​](#methods "Direct link to Methods")

### withId()[​](#withid "Direct link to withId()")

> **withId**(`id`): [`USyncUser`](/docs/api/classes/USyncUser)

Defined in: [src/WAUSync/USyncUser.ts:8](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncUser.ts#L8)

#### Parameters[​](#parameters "Direct link to Parameters")

##### id[​](#id-1 "Direct link to id")

`string`

#### Returns[​](#returns-1 "Direct link to Returns")

[`USyncUser`](/docs/api/classes/USyncUser)

* * *

### withLid()[​](#withlid "Direct link to withLid()")

> **withLid**(`lid`): [`USyncUser`](/docs/api/classes/USyncUser)

Defined in: [src/WAUSync/USyncUser.ts:13](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncUser.ts#L13)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### lid[​](#lid-1 "Direct link to lid")

`string`

#### Returns[​](#returns-2 "Direct link to Returns")

[`USyncUser`](/docs/api/classes/USyncUser)

* * *

### withPersonaId()[​](#withpersonaid "Direct link to withPersonaId()")

> **withPersonaId**(`personaId`): [`USyncUser`](/docs/api/classes/USyncUser)

Defined in: [src/WAUSync/USyncUser.ts:28](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncUser.ts#L28)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### personaId[​](#personaid-1 "Direct link to personaId")

`string`

#### Returns[​](#returns-3 "Direct link to Returns")

[`USyncUser`](/docs/api/classes/USyncUser)

* * *

### withPhone()[​](#withphone "Direct link to withPhone()")

> **withPhone**(`phone`): [`USyncUser`](/docs/api/classes/USyncUser)

Defined in: [src/WAUSync/USyncUser.ts:18](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncUser.ts#L18)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### phone[​](#phone-1 "Direct link to phone")

`string`

#### Returns[​](#returns-4 "Direct link to Returns")

[`USyncUser`](/docs/api/classes/USyncUser)

* * *

### withType()[​](#withtype "Direct link to withType()")

> **withType**(`type`): [`USyncUser`](/docs/api/classes/USyncUser)

Defined in: [src/WAUSync/USyncUser.ts:23](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncUser.ts#L23)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### type[​](#type-1 "Direct link to type")

`string`

#### Returns[​](#returns-5 "Direct link to Returns")

[`USyncUser`](/docs/api/classes/USyncUser)

---

<a name="enumeration-disconnectreason"></a>

> Source: [https://baileys.wiki/docs/api/enumerations/DisconnectReason](https://baileys.wiki/docs/api/enumerations/DisconnectReason)

Defined in: [src/Types/index.ts:27](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/index.ts#L27)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### badSession[​](#badsession "Direct link to badSession")

> **badSession**: `500`

Defined in: [src/Types/index.ts:33](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/index.ts#L33)

* * *

### connectionClosed[​](#connectionclosed "Direct link to connectionClosed")

> **connectionClosed**: `428`

Defined in: [src/Types/index.ts:28](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/index.ts#L28)

* * *

### connectionLost[​](#connectionlost "Direct link to connectionLost")

> **connectionLost**: `408`

Defined in: [src/Types/index.ts:29](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/index.ts#L29)

* * *

### connectionReplaced[​](#connectionreplaced "Direct link to connectionReplaced")

> **connectionReplaced**: `440`

Defined in: [src/Types/index.ts:30](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/index.ts#L30)

* * *

### forbidden[​](#forbidden "Direct link to forbidden")

> **forbidden**: `403`

Defined in: [src/Types/index.ts:36](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/index.ts#L36)

* * *

### loggedOut[​](#loggedout "Direct link to loggedOut")

> **loggedOut**: `401`

Defined in: [src/Types/index.ts:32](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/index.ts#L32)

* * *

### multideviceMismatch[​](#multidevicemismatch "Direct link to multideviceMismatch")

> **multideviceMismatch**: `411`

Defined in: [src/Types/index.ts:35](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/index.ts#L35)

* * *

### restartRequired[​](#restartrequired "Direct link to restartRequired")

> **restartRequired**: `515`

Defined in: [src/Types/index.ts:34](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/index.ts#L34)

* * *

### timedOut[​](#timedout "Direct link to timedOut")

> **timedOut**: `408`

Defined in: [src/Types/index.ts:31](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/index.ts#L31)

* * *

### unavailableService[​](#unavailableservice "Direct link to unavailableService")

> **unavailableService**: `503`

Defined in: [src/Types/index.ts:37](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/index.ts#L37)

---

<a name="enumeration-queryids"></a>

> Source: [https://baileys.wiki/docs/api/enumerations/QueryIds](https://baileys.wiki/docs/api/enumerations/QueryIds)

Defined in: [src/Types/Newsletter.ts:15](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L15)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### ADMIN\_COUNT[​](#admin_count "Direct link to ADMIN_COUNT")

> **ADMIN\_COUNT**: `"7130823597031706"`

Defined in: [src/Types/Newsletter.ts:24](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L24)

* * *

### CHANGE\_OWNER[​](#change_owner "Direct link to CHANGE_OWNER")

> **CHANGE\_OWNER**: `"7341777602580933"`

Defined in: [src/Types/Newsletter.ts:25](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L25)

* * *

### CREATE[​](#create "Direct link to CREATE")

> **CREATE**: `"8823471724422422"`

Defined in: [src/Types/Newsletter.ts:16](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L16)

* * *

### DELETE[​](#delete "Direct link to DELETE")

> **DELETE**: `"30062808666639665"`

Defined in: [src/Types/Newsletter.ts:27](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L27)

* * *

### DEMOTE[​](#demote "Direct link to DEMOTE")

> **DEMOTE**: `"6551828931592903"`

Defined in: [src/Types/Newsletter.ts:26](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L26)

* * *

### FOLLOW[​](#follow "Direct link to FOLLOW")

> **FOLLOW**: `"7871414976211147"`

Defined in: [src/Types/Newsletter.ts:20](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L20)

* * *

### METADATA[​](#metadata "Direct link to METADATA")

> **METADATA**: `"6563316087068696"`

Defined in: [src/Types/Newsletter.ts:18](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L18)

* * *

### MUTE[​](#mute "Direct link to MUTE")

> **MUTE**: `"29766401636284406"`

Defined in: [src/Types/Newsletter.ts:22](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L22)

* * *

### SUBSCRIBERS[​](#subscribers "Direct link to SUBSCRIBERS")

> **SUBSCRIBERS**: `"9783111038412085"`

Defined in: [src/Types/Newsletter.ts:19](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L19)

* * *

### UNFOLLOW[​](#unfollow "Direct link to UNFOLLOW")

> **UNFOLLOW**: `"7238632346214362"`

Defined in: [src/Types/Newsletter.ts:21](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L21)

* * *

### UNMUTE[​](#unmute "Direct link to UNMUTE")

> **UNMUTE**: `"9864994326891137"`

Defined in: [src/Types/Newsletter.ts:23](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L23)

* * *

### UPDATE\_METADATA[​](#update_metadata "Direct link to UPDATE_METADATA")

> **UPDATE\_METADATA**: `"24250201037901610"`

Defined in: [src/Types/Newsletter.ts:17](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L17)

---

<a name="enumeration-retryreason"></a>

> Source: [https://baileys.wiki/docs/api/enumerations/RetryReason](https://baileys.wiki/docs/api/enumerations/RetryReason)

Defined in: [src/Utils/message-retry-manager.ts:43](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L43)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AdvFailure[​](#advfailure "Direct link to AdvFailure")

> **AdvFailure**: `12`

Defined in: [src/Utils/message-retry-manager.ts:58](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L58)

* * *

### BadBroadcastEphemeralSetting[​](#badbroadcastephemeralsetting "Direct link to BadBroadcastEphemeralSetting")

> **BadBroadcastEphemeralSetting**: `10`

Defined in: [src/Utils/message-retry-manager.ts:56](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L56)

* * *

### SignalErrorBadMac[​](#signalerrorbadmac "Direct link to SignalErrorBadMac")

> **SignalErrorBadMac**: `7`

Defined in: [src/Utils/message-retry-manager.ts:53](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L53)

Explicit MAC failure - session is definitely out of sync

* * *

### SignalErrorFutureMessage[​](#signalerrorfuturemessage "Direct link to SignalErrorFutureMessage")

> **SignalErrorFutureMessage**: `6`

Defined in: [src/Utils/message-retry-manager.ts:51](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L51)

* * *

### SignalErrorInvalidKey[​](#signalerrorinvalidkey "Direct link to SignalErrorInvalidKey")

> **SignalErrorInvalidKey**: `2`

Defined in: [src/Utils/message-retry-manager.ts:46](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L46)

* * *

### SignalErrorInvalidKeyId[​](#signalerrorinvalidkeyid "Direct link to SignalErrorInvalidKeyId")

> **SignalErrorInvalidKeyId**: `3`

Defined in: [src/Utils/message-retry-manager.ts:47](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L47)

* * *

### SignalErrorInvalidMessage[​](#signalerrorinvalidmessage "Direct link to SignalErrorInvalidMessage")

> **SignalErrorInvalidMessage**: `4`

Defined in: [src/Utils/message-retry-manager.ts:49](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L49)

MAC verification failed - most common cause of decryption failures

* * *

### SignalErrorInvalidMsgKey[​](#signalerrorinvalidmsgkey "Direct link to SignalErrorInvalidMsgKey")

> **SignalErrorInvalidMsgKey**: `9`

Defined in: [src/Utils/message-retry-manager.ts:55](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L55)

* * *

### SignalErrorInvalidSession[​](#signalerrorinvalidsession "Direct link to SignalErrorInvalidSession")

> **SignalErrorInvalidSession**: `8`

Defined in: [src/Utils/message-retry-manager.ts:54](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L54)

* * *

### SignalErrorInvalidSignature[​](#signalerrorinvalidsignature "Direct link to SignalErrorInvalidSignature")

> **SignalErrorInvalidSignature**: `5`

Defined in: [src/Utils/message-retry-manager.ts:50](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L50)

* * *

### SignalErrorNoSession[​](#signalerrornosession "Direct link to SignalErrorNoSession")

> **SignalErrorNoSession**: `1`

Defined in: [src/Utils/message-retry-manager.ts:45](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L45)

* * *

### StatusRevokeDelay[​](#statusrevokedelay "Direct link to StatusRevokeDelay")

> **StatusRevokeDelay**: `13`

Defined in: [src/Utils/message-retry-manager.ts:59](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L59)

* * *

### UnknownCompanionNoPrekey[​](#unknowncompanionnoprekey "Direct link to UnknownCompanionNoPrekey")

> **UnknownCompanionNoPrekey**: `11`

Defined in: [src/Utils/message-retry-manager.ts:57](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L57)

* * *

### UnknownError[​](#unknownerror "Direct link to UnknownError")

> **UnknownError**: `0`

Defined in: [src/Utils/message-retry-manager.ts:44](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L44)

---

<a name="enumeration-syncstate"></a>

> Source: [https://baileys.wiki/docs/api/enumerations/SyncState](https://baileys.wiki/docs/api/enumerations/SyncState)

Defined in: [src/Types/State.ts:4](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/State.ts#L4)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AwaitingInitialSync[​](#awaitinginitialsync "Direct link to AwaitingInitialSync")

> **AwaitingInitialSync**: `1`

Defined in: [src/Types/State.ts:8](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/State.ts#L8)

Pending notifications received. Buffering events until we decide whether to sync or not.

* * *

### Connecting[​](#connecting "Direct link to Connecting")

> **Connecting**: `0`

Defined in: [src/Types/State.ts:6](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/State.ts#L6)

The socket is connecting, but we haven't received pending notifications yet.

* * *

### Online[​](#online "Direct link to Online")

> **Online**: `3`

Defined in: [src/Types/State.ts:12](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/State.ts#L12)

Initial sync is complete, or was skipped. The socket is fully operational and events are processed in real-time.

* * *

### Syncing[​](#syncing "Direct link to Syncing")

> **Syncing**: `2`

Defined in: [src/Types/State.ts:10](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/State.ts#L10)

The initial app state sync (history, etc.) is in progress. Buffering continues.

---

<a name="enumeration-wajiddomains"></a>

> Source: [https://baileys.wiki/docs/api/enumerations/WAJIDDomains](https://baileys.wiki/docs/api/enumerations/WAJIDDomains)

Defined in: [src/WABinary/jid-utils.ts:20](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L20)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### HOSTED[​](#hosted "Direct link to HOSTED")

> **HOSTED**: `128`

Defined in: [src/WABinary/jid-utils.ts:23](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L23)

* * *

### HOSTED\_LID[​](#hosted_lid "Direct link to HOSTED_LID")

> **HOSTED\_LID**: `129`

Defined in: [src/WABinary/jid-utils.ts:24](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L24)

* * *

### LID[​](#lid "Direct link to LID")

> **LID**: `1`

Defined in: [src/WABinary/jid-utils.ts:22](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L22)

* * *

### WHATSAPP[​](#whatsapp "Direct link to WHATSAPP")

> **WHATSAPP**: `0`

Defined in: [src/WABinary/jid-utils.ts:21](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L21)

---

<a name="enumeration-wamessageaddressingmode"></a>

> Source: [https://baileys.wiki/docs/api/enumerations/WAMessageAddressingMode](https://baileys.wiki/docs/api/enumerations/WAMessageAddressingMode)

Defined in: [src/Types/Message.ts:45](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L45)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### LID[​](#lid "Direct link to LID")

> **LID**: `"lid"`

Defined in: [src/Types/Message.ts:47](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L47)

* * *

### PN[​](#pn "Direct link to PN")

> **PN**: `"pn"`

Defined in: [src/Types/Message.ts:46](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L46)

---

<a name="enumeration-xwapaths"></a>

> Source: [https://baileys.wiki/docs/api/enumerations/XWAPaths](https://baileys.wiki/docs/api/enumerations/XWAPaths)

Defined in: [src/Types/Newsletter.ts:1](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L1)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### xwa2\_newsletter\_admin\_count[​](#xwa2_newsletter_admin_count "Direct link to xwa2_newsletter_admin_count")

> **xwa2\_newsletter\_admin\_count**: `"xwa2_newsletter_admin"`

Defined in: [src/Types/Newsletter.ts:6](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L6)

* * *

### xwa2\_newsletter\_change\_owner[​](#xwa2_newsletter_change_owner "Direct link to xwa2_newsletter_change_owner")

> **xwa2\_newsletter\_change\_owner**: `"xwa2_newsletter_change_owner"`

Defined in: [src/Types/Newsletter.ts:11](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L11)

* * *

### xwa2\_newsletter\_create[​](#xwa2_newsletter_create "Direct link to xwa2_newsletter_create")

> **xwa2\_newsletter\_create**: `"xwa2_newsletter_create"`

Defined in: [src/Types/Newsletter.ts:2](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L2)

* * *

### xwa2\_newsletter\_delete\_v2[​](#xwa2_newsletter_delete_v2 "Direct link to xwa2_newsletter_delete_v2")

> **xwa2\_newsletter\_delete\_v2**: `"xwa2_newsletter_delete_v2"`

Defined in: [src/Types/Newsletter.ts:13](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L13)

* * *

### xwa2\_newsletter\_demote[​](#xwa2_newsletter_demote "Direct link to xwa2_newsletter_demote")

> **xwa2\_newsletter\_demote**: `"xwa2_newsletter_demote"`

Defined in: [src/Types/Newsletter.ts:12](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L12)

* * *

### xwa2\_newsletter\_follow[​](#xwa2_newsletter_follow "Direct link to xwa2_newsletter_follow")

> **xwa2\_newsletter\_follow**: `"xwa2_newsletter_follow"`

Defined in: [src/Types/Newsletter.ts:9](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L9)

* * *

### xwa2\_newsletter\_metadata[​](#xwa2_newsletter_metadata "Direct link to xwa2_newsletter_metadata")

> **xwa2\_newsletter\_metadata**: `"xwa2_newsletter"`

Defined in: [src/Types/Newsletter.ts:5](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L5)

* * *

### xwa2\_newsletter\_mute\_v2[​](#xwa2_newsletter_mute_v2 "Direct link to xwa2_newsletter_mute_v2")

> **xwa2\_newsletter\_mute\_v2**: `"xwa2_newsletter_mute_v2"`

Defined in: [src/Types/Newsletter.ts:7](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L7)

* * *

### xwa2\_newsletter\_subscribers[​](#xwa2_newsletter_subscribers "Direct link to xwa2_newsletter_subscribers")

> **xwa2\_newsletter\_subscribers**: `"xwa2_newsletter_subscribers"`

Defined in: [src/Types/Newsletter.ts:3](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L3)

* * *

### xwa2\_newsletter\_unfollow[​](#xwa2_newsletter_unfollow "Direct link to xwa2_newsletter_unfollow")

> **xwa2\_newsletter\_unfollow**: `"xwa2_newsletter_unfollow"`

Defined in: [src/Types/Newsletter.ts:10](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L10)

* * *

### xwa2\_newsletter\_unmute\_v2[​](#xwa2_newsletter_unmute_v2 "Direct link to xwa2_newsletter_unmute_v2")

> **xwa2\_newsletter\_unmute\_v2**: `"xwa2_newsletter_unmute_v2"`

Defined in: [src/Types/Newsletter.ts:8](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L8)

* * *

### xwa2\_newsletter\_view[​](#xwa2_newsletter_view "Direct link to xwa2_newsletter_view")

> **xwa2\_newsletter\_view**: `"xwa2_newsletter_view"`

Defined in: [src/Types/Newsletter.ts:4](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L4)

---

<a name="function-addtransactioncapability-"></a>

> Source: [https://baileys.wiki/docs/api/functions/addTransactionCapability](https://baileys.wiki/docs/api/functions/addTransactionCapability)

> **addTransactionCapability**(`state`, `logger`, `__namedParameters`): [`SignalKeyStoreWithTransaction`](/docs/api/type-aliases/SignalKeyStoreWithTransaction)

Defined in: [src/Utils/auth-utils.ts:115](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/auth-utils.ts#L115)

Adds DB-like transaction capability to the SignalKeyStore Uses AsyncLocalStorage for automatic context management

## Parameters[​](#parameters "Direct link to Parameters")

### state[​](#state "Direct link to state")

[`SignalKeyStore`](/docs/api/type-aliases/SignalKeyStore)

the key store to apply this capability to

### logger[​](#logger "Direct link to logger")

`ILogger`

logger to log events

### \_\_namedParameters[​](#__namedparameters "Direct link to __namedParameters")

[`TransactionCapabilityOptions`](/docs/api/type-aliases/TransactionCapabilityOptions)

## Returns[​](#returns "Direct link to Returns")

[`SignalKeyStoreWithTransaction`](/docs/api/type-aliases/SignalKeyStoreWithTransaction)

SignalKeyStore with transaction capability

---

<a name="function-aesdecrypt-"></a>

> Source: [https://baileys.wiki/docs/api/functions/aesDecrypt](https://baileys.wiki/docs/api/functions/aesDecrypt)

> **aesDecrypt**(`buffer`, `key`): `Buffer`<`ArrayBuffer`\>

Defined in: [src/Utils/crypto.ts:86](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/crypto.ts#L86)

decrypt AES 256 CBC; where the IV is prefixed to the buffer

## Parameters[​](#parameters "Direct link to Parameters")

### buffer[​](#buffer "Direct link to buffer")

`Uint8Array`

### key[​](#key "Direct link to key")

`Uint8Array`

## Returns[​](#returns "Direct link to Returns")

`Buffer`<`ArrayBuffer`\>

---

<a name="function-aesdecryptctr-"></a>

> Source: [https://baileys.wiki/docs/api/functions/aesDecryptCTR](https://baileys.wiki/docs/api/functions/aesDecryptCTR)

> **aesDecryptCTR**(`ciphertext`, `key`, `iv`): `Buffer`<`ArrayBuffer`\>

Defined in: [src/Utils/crypto.ts:80](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/crypto.ts#L80)

## Parameters[​](#parameters "Direct link to Parameters")

### ciphertext[​](#ciphertext "Direct link to ciphertext")

`Uint8Array`

### key[​](#key "Direct link to key")

`Uint8Array`

### iv[​](#iv "Direct link to iv")

`Uint8Array`

## Returns[​](#returns "Direct link to Returns")

`Buffer`<`ArrayBuffer`\>

---

<a name="function-aesdecryptgcm-"></a>

> Source: [https://baileys.wiki/docs/api/functions/aesDecryptGCM](https://baileys.wiki/docs/api/functions/aesDecryptGCM)

> **aesDecryptGCM**(`ciphertext`, `key`, `iv`, `additionalData`): `Buffer`<`ArrayBuffer`\>

Defined in: [src/Utils/crypto.ts:63](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/crypto.ts#L63)

decrypt AES 256 GCM; where the auth tag is suffixed to the ciphertext

## Parameters[​](#parameters "Direct link to Parameters")

### ciphertext[​](#ciphertext "Direct link to ciphertext")

`Uint8Array`

### key[​](#key "Direct link to key")

`Uint8Array`

### iv[​](#iv "Direct link to iv")

`Uint8Array`

### additionalData[​](#additionaldata "Direct link to additionalData")

`Uint8Array`

## Returns[​](#returns "Direct link to Returns")

`Buffer`<`ArrayBuffer`\>

---

<a name="function-aesdecryptwithiv-"></a>

> Source: [https://baileys.wiki/docs/api/functions/aesDecryptWithIV](https://baileys.wiki/docs/api/functions/aesDecryptWithIV)

> **aesDecryptWithIV**(`buffer`, `key`, `IV`): `Buffer`<`ArrayBuffer`\>

Defined in: [src/Utils/crypto.ts:91](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/crypto.ts#L91)

decrypt AES 256 CBC

## Parameters[​](#parameters "Direct link to Parameters")

### buffer[​](#buffer "Direct link to buffer")

`Uint8Array`

### key[​](#key "Direct link to key")

`Uint8Array`

### IV[​](#iv "Direct link to IV")

`Uint8Array`

## Returns[​](#returns "Direct link to Returns")

`Buffer`<`ArrayBuffer`\>

---

<a name="function-aesencrypwithiv-"></a>

> Source: [https://baileys.wiki/docs/api/functions/aesEncrypWithIV](https://baileys.wiki/docs/api/functions/aesEncrypWithIV)

> **aesEncrypWithIV**(`buffer`, `key`, `IV`): `Buffer`<`ArrayBuffer`\>

Defined in: [src/Utils/crypto.ts:104](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/crypto.ts#L104)

## Parameters[​](#parameters "Direct link to Parameters")

### buffer[​](#buffer "Direct link to buffer")

`Buffer`

### key[​](#key "Direct link to key")

`Buffer`

### IV[​](#iv "Direct link to IV")

`Buffer`

## Returns[​](#returns "Direct link to Returns")

`Buffer`<`ArrayBuffer`\>

---

<a name="function-aesencrypt-"></a>

> Source: [https://baileys.wiki/docs/api/functions/aesEncrypt](https://baileys.wiki/docs/api/functions/aesEncrypt)

> **aesEncrypt**(`buffer`, `key`): `Buffer`<`ArrayBuffer`\>

Defined in: [src/Utils/crypto.ts:97](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/crypto.ts#L97)

## Parameters[​](#parameters "Direct link to Parameters")

### buffer[​](#buffer "Direct link to buffer")

`Uint8Array`

### key[​](#key "Direct link to key")

`Uint8Array`

## Returns[​](#returns "Direct link to Returns")

`Buffer`<`ArrayBuffer`\>

---

<a name="function-aesencryptctr-"></a>

> Source: [https://baileys.wiki/docs/api/functions/aesEncryptCTR](https://baileys.wiki/docs/api/functions/aesEncryptCTR)

> **aesEncryptCTR**(`plaintext`, `key`, `iv`): `Buffer`<`ArrayBuffer`\>

Defined in: [src/Utils/crypto.ts:75](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/crypto.ts#L75)

## Parameters[​](#parameters "Direct link to Parameters")

### plaintext[​](#plaintext "Direct link to plaintext")

`Uint8Array`

### key[​](#key "Direct link to key")

`Uint8Array`

### iv[​](#iv "Direct link to iv")

`Uint8Array`

## Returns[​](#returns "Direct link to Returns")

`Buffer`<`ArrayBuffer`\>

---

<a name="function-aesencryptgcm-"></a>

> Source: [https://baileys.wiki/docs/api/functions/aesEncryptGCM](https://baileys.wiki/docs/api/functions/aesEncryptGCM)

> **aesEncryptGCM**(`plaintext`, `key`, `iv`, `additionalData`): `Buffer`<`ArrayBuffer`\>

Defined in: [src/Utils/crypto.ts:53](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/crypto.ts#L53)

encrypt AES 256 GCM; where the tag tag is suffixed to the ciphertext

## Parameters[​](#parameters "Direct link to Parameters")

### plaintext[​](#plaintext "Direct link to plaintext")

`Uint8Array`

### key[​](#key "Direct link to key")

`Uint8Array`

### iv[​](#iv "Direct link to iv")

`Uint8Array`

### additionalData[​](#additionaldata "Direct link to additionalData")

`Uint8Array`

## Returns[​](#returns "Direct link to Returns")

`Buffer`<`ArrayBuffer`\>

---

<a name="function-aggregatemessagekeysnotfromme-"></a>

> Source: [https://baileys.wiki/docs/api/functions/aggregateMessageKeysNotFromMe](https://baileys.wiki/docs/api/functions/aggregateMessageKeysNotFromMe)

> **aggregateMessageKeysNotFromMe**(`keys`): `object`\[\]

Defined in: [src/Utils/messages.ts:1002](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L1002)

Given a list of message keys, aggregates them by chat & sender. Useful for sending read receipts in bulk

## Parameters[​](#parameters "Direct link to Parameters")

### keys[​](#keys "Direct link to keys")

[`WAMessageKey`](/docs/api/type-aliases/WAMessageKey)\[\]

## Returns[​](#returns "Direct link to Returns")

`object`\[\]

---

<a name="function-arejidssameuser-"></a>

> Source: [https://baileys.wiki/docs/api/functions/areJidsSameUser](https://baileys.wiki/docs/api/functions/areJidsSameUser)

> **areJidsSameUser**(`jid1`, `jid2`): `boolean`

Defined in: [src/WABinary/jid-utils.ts:88](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L88)

is the jid a user

## Parameters[​](#parameters "Direct link to Parameters")

### jid1[​](#jid1 "Direct link to jid1")

`undefined` | `string`

### jid2[​](#jid2 "Direct link to jid2")

`undefined` | `string`

## Returns[​](#returns "Direct link to Returns")

`boolean`

---

<a name="function-assertmediacontent-"></a>

> Source: [https://baileys.wiki/docs/api/functions/assertMediaContent](https://baileys.wiki/docs/api/functions/assertMediaContent)

> **assertMediaContent**(`content`): [`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage) | [`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage) | [`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage) | [`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage) | [`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage)

Defined in: [src/Utils/messages.ts:1096](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L1096)

Checks whether the given message is a media message; if it is returns the inner content

## Parameters[​](#parameters "Direct link to Parameters")

### content[​](#content "Direct link to content")

`undefined` | `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

## Returns[​](#returns "Direct link to Returns")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage) | [`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage) | [`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage) | [`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage) | [`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage)

---

<a name="function-assertnodeerrorfree-"></a>

> Source: [https://baileys.wiki/docs/api/functions/assertNodeErrorFree](https://baileys.wiki/docs/api/functions/assertNodeErrorFree)

> **assertNodeErrorFree**(`node`): `void`

Defined in: [src/WABinary/generic-utils.ts:66](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/generic-utils.ts#L66)

## Parameters[​](#parameters "Direct link to Parameters")

### node[​](#node "Direct link to node")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

## Returns[​](#returns "Direct link to Returns")

`void`

---

<a name="function-binarynodetostring-"></a>

> Source: [https://baileys.wiki/docs/api/functions/binaryNodeToString](https://baileys.wiki/docs/api/functions/binaryNodeToString)

> **binaryNodeToString**(`node`, `i`): `string`

Defined in: [src/WABinary/generic-utils.ts:114](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/generic-utils.ts#L114)

## Parameters[​](#parameters "Direct link to Parameters")

### node[​](#node "Direct link to node")

`undefined` | `string` | [`BinaryNode`](/docs/api/type-aliases/BinaryNode) | `Uint8Array`<`ArrayBufferLike`\> | [`BinaryNode`](/docs/api/type-aliases/BinaryNode)\[\]

### i[​](#i "Direct link to i")

`number` = `0`

## Returns[​](#returns "Direct link to Returns")

`string`

---

<a name="function-bindwaitforconnectionupdate-"></a>

> Source: [https://baileys.wiki/docs/api/functions/bindWaitForConnectionUpdate](https://baileys.wiki/docs/api/functions/bindWaitForConnectionUpdate)

> **bindWaitForConnectionUpdate**(`ev`): (`check`, `timeoutMs`?) => `Promise`<`void`\>

Defined in: [src/Utils/generics.ts:232](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L232)

## Parameters[​](#parameters "Direct link to Parameters")

### ev[​](#ev "Direct link to ev")

[`BaileysEventEmitter`](/docs/api/interfaces/BaileysEventEmitter)

## Returns[​](#returns "Direct link to Returns")

`Function`

### Parameters[​](#parameters-1 "Direct link to Parameters")

#### check[​](#check "Direct link to check")

(`u`) => `Promise`<`undefined` | `boolean`\>

#### timeoutMs?[​](#timeoutms "Direct link to timeoutMs?")

`number`

### Returns[​](#returns-1 "Direct link to Returns")

`Promise`<`void`\>

---

<a name="function-bindwaitforevent-"></a>

> Source: [https://baileys.wiki/docs/api/functions/bindWaitForEvent](https://baileys.wiki/docs/api/functions/bindWaitForEvent)

> **bindWaitForEvent**<`T`\>(`ev`, `event`): (`check`, `timeoutMs`?) => `Promise`<`void`\>

Defined in: [src/Utils/generics.ts:204](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L204)

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

• **T** _extends_ keyof [`BaileysEventMap`](/docs/api/type-aliases/BaileysEventMap)

## Parameters[​](#parameters "Direct link to Parameters")

### ev[​](#ev "Direct link to ev")

[`BaileysEventEmitter`](/docs/api/interfaces/BaileysEventEmitter)

### event[​](#event "Direct link to event")

`T`

## Returns[​](#returns "Direct link to Returns")

`Function`

### Parameters[​](#parameters-1 "Direct link to Parameters")

#### check[​](#check "Direct link to check")

(`u`) => `Promise`<`undefined` | `boolean`\>

#### timeoutMs?[​](#timeoutms "Direct link to timeoutMs?")

`number`

### Returns[​](#returns-1 "Direct link to Returns")

`Promise`<`void`\>

---

<a name="function-buildackstanza-"></a>

> Source: [https://baileys.wiki/docs/api/functions/buildAckStanza](https://baileys.wiki/docs/api/functions/buildAckStanza)

> **buildAckStanza**(`node`, `errorCode`?, `meId`?): [`BinaryNode`](/docs/api/type-aliases/BinaryNode)

Defined in: [src/Utils/stanza-ack.ts:11](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/stanza-ack.ts#L11)

Builds an ACK stanza for a received node. Pure function -- no I/O, no side effects.

Mirrors WhatsApp Web's ACK construction:

*   WAWebHandleMsgSendAck.sendAck / sendNack
*   WAWebCreateNackFromStanza.createNackFromStanza

## Parameters[​](#parameters "Direct link to Parameters")

### node[​](#node "Direct link to node")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

### errorCode?[​](#errorcode "Direct link to errorCode?")

`number`

### meId?[​](#meid "Direct link to meId?")

`string`

## Returns[​](#returns "Direct link to Returns")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

---

<a name="function-bytestocrockford-"></a>

> Source: [https://baileys.wiki/docs/api/functions/bytesToCrockford](https://baileys.wiki/docs/api/functions/bytesToCrockford)

> **bytesToCrockford**(`buffer`): `string`

Defined in: [src/Utils/generics.ts:450](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L450)

## Parameters[​](#parameters "Direct link to Parameters")

### buffer[​](#buffer "Direct link to buffer")

`Buffer`

## Returns[​](#returns "Direct link to Returns")

`string`

---

<a name="function-chatmodificationtoapppatch-"></a>

> Source: [https://baileys.wiki/docs/api/functions/chatModificationToAppPatch](https://baileys.wiki/docs/api/functions/chatModificationToAppPatch)

> **chatModificationToAppPatch**(`mod`, `jid`): [`WAPatchCreate`](/docs/api/type-aliases/WAPatchCreate)

Defined in: [src/Utils/chat-utils.ts:491](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/chat-utils.ts#L491)

## Parameters[​](#parameters "Direct link to Parameters")

### mod[​](#mod "Direct link to mod")

[`ChatModification`](/docs/api/type-aliases/ChatModification)

### jid[​](#jid "Direct link to jid")

`string`

## Returns[​](#returns "Direct link to Returns")

[`WAPatchCreate`](/docs/api/type-aliases/WAPatchCreate)

---

<a name="function-cleanmessage-"></a>

> Source: [https://baileys.wiki/docs/api/functions/cleanMessage](https://baileys.wiki/docs/api/functions/cleanMessage)

> **cleanMessage**(`message`, `meId`, `meLid`): `void`

Defined in: [src/Utils/process-message.ts:59](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/process-message.ts#L59)

Cleans a received message to further processing

## Parameters[​](#parameters "Direct link to Parameters")

### message[​](#message "Direct link to message")

[`WAMessage`](/docs/api/type-aliases/WAMessage)

### meId[​](#meid "Direct link to meId")

`string`

### meLid[​](#melid "Direct link to meLid")

`string`

## Returns[​](#returns "Direct link to Returns")

`void`

---

<a name="function-configuresuccessfulpairing-"></a>

> Source: [https://baileys.wiki/docs/api/functions/configureSuccessfulPairing](https://baileys.wiki/docs/api/functions/configureSuccessfulPairing)

> **configureSuccessfulPairing**(`stanza`, `__namedParameters`): `object`

Defined in: [src/Utils/validate-connection.ts:147](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/validate-connection.ts#L147)

## Parameters[​](#parameters "Direct link to Parameters")

### stanza[​](#stanza "Direct link to stanza")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

### \_\_namedParameters[​](#__namedparameters "Direct link to __namedParameters")

`Pick`<[`AuthenticationCreds`](/docs/api/type-aliases/AuthenticationCreds), `"signedIdentityKey"` | `"advSecretKey"` | `"signalIdentities"`\>

## Returns[​](#returns "Direct link to Returns")

`object`

### creds[​](#creds "Direct link to creds")

> **creds**: `Partial`<[`AuthenticationCreds`](/docs/api/type-aliases/AuthenticationCreds)\> = `authUpdate`

### reply[​](#reply "Direct link to reply")

> **reply**: [`BinaryNode`](/docs/api/type-aliases/BinaryNode)

---

<a name="function-createsignalidentity-"></a>

> Source: [https://baileys.wiki/docs/api/functions/createSignalIdentity](https://baileys.wiki/docs/api/functions/createSignalIdentity)

> **createSignalIdentity**(`wid`, `accountSignatureKey`): [`SignalIdentity`](/docs/api/type-aliases/SignalIdentity)

Defined in: [src/Utils/signal.ts:37](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/signal.ts#L37)

## Parameters[​](#parameters "Direct link to Parameters")

### wid[​](#wid "Direct link to wid")

`string`

### accountSignatureKey[​](#accountsignaturekey "Direct link to accountSignatureKey")

`Uint8Array`

## Returns[​](#returns "Direct link to Returns")

[`SignalIdentity`](/docs/api/type-aliases/SignalIdentity)

---

<a name="function-debouncedtimeout-"></a>

> Source: [https://baileys.wiki/docs/api/functions/debouncedTimeout](https://baileys.wiki/docs/api/functions/debouncedTimeout)

> **debouncedTimeout**(`intervalMs`, `task`?): `object`

Defined in: [src/Utils/generics.ts:107](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L107)

## Parameters[​](#parameters "Direct link to Parameters")

### intervalMs[​](#intervalms "Direct link to intervalMs")

`number` = `1000`

### task?[​](#task "Direct link to task?")

() => `void`

## Returns[​](#returns "Direct link to Returns")

`object`

### cancel()[​](#cancel "Direct link to cancel()")

> **cancel**: () => `void`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

### setInterval()[​](#setinterval "Direct link to setInterval()")

> **setInterval**: (`newInterval`) => `number`

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### newInterval[​](#newinterval "Direct link to newInterval")

`number`

#### Returns[​](#returns-2 "Direct link to Returns")

`number`

### setTask()[​](#settask "Direct link to setTask()")

> **setTask**: (`newTask`) => () => `void`

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### newTask[​](#newtask "Direct link to newTask")

() => `void`

#### Returns[​](#returns-3 "Direct link to Returns")

`Function`

##### Returns[​](#returns-4 "Direct link to Returns")

`void`

### start()[​](#start "Direct link to start()")

> **start**: (`newIntervalMs`?, `newTask`?) => `void`

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### newIntervalMs?[​](#newintervalms "Direct link to newIntervalMs?")

`number`

##### newTask?[​](#newtask-1 "Direct link to newTask?")

() => `void`

#### Returns[​](#returns-5 "Direct link to Returns")

`void`

---

<a name="function-decodebinarynode-"></a>

> Source: [https://baileys.wiki/docs/api/functions/decodeBinaryNode](https://baileys.wiki/docs/api/functions/decodeBinaryNode)

> **decodeBinaryNode**(`buff`): `Promise`<[`BinaryNode`](/docs/api/type-aliases/BinaryNode)\>

Defined in: [src/WABinary/decode.ts:305](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/decode.ts#L305)

## Parameters[​](#parameters "Direct link to Parameters")

### buff[​](#buff "Direct link to buff")

`Buffer`

## Returns[​](#returns "Direct link to Returns")

`Promise`<[`BinaryNode`](/docs/api/type-aliases/BinaryNode)\>

---

<a name="function-decodedecompressedbinarynode-"></a>

> Source: [https://baileys.wiki/docs/api/functions/decodeDecompressedBinaryNode](https://baileys.wiki/docs/api/functions/decodeDecompressedBinaryNode)

> **decodeDecompressedBinaryNode**(`buffer`, `opts`, `indexRef`): [`BinaryNode`](/docs/api/type-aliases/BinaryNode)

Defined in: [src/WABinary/decode.ts:20](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/decode.ts#L20)

## Parameters[​](#parameters "Direct link to Parameters")

### buffer[​](#buffer "Direct link to buffer")

`Buffer`

### opts[​](#opts "Direct link to opts")

`Pick`<`__module`, `"TAGS"` | `"DOUBLE_BYTE_TOKENS"` | `"SINGLE_BYTE_TOKENS"`\>

### indexRef[​](#indexref "Direct link to indexRef")

#### index[​](#index "Direct link to index")

`number`

## Returns[​](#returns "Direct link to Returns")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

---

<a name="function-decodemediaretrynode-"></a>

> Source: [https://baileys.wiki/docs/api/functions/decodeMediaRetryNode](https://baileys.wiki/docs/api/functions/decodeMediaRetryNode)

> **decodeMediaRetryNode**(`node`): `object`

Defined in: [src/Utils/messages-media.ts:933](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L933)

## Parameters[​](#parameters "Direct link to Parameters")

### node[​](#node "Direct link to node")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

## Returns[​](#returns "Direct link to Returns")

`object`

### error?[​](#error "Direct link to error?")

> `optional` **error**: `Boom`<`any`\>

### key[​](#key "Direct link to key")

> **key**: [`WAMessageKey`](/docs/api/type-aliases/WAMessageKey)

### media?[​](#media "Direct link to media?")

> `optional` **media**: `object`

#### media.ciphertext[​](#mediaciphertext "Direct link to media.ciphertext")

> **ciphertext**: `Uint8Array`

#### media.iv[​](#mediaiv "Direct link to media.iv")

> **iv**: `Uint8Array`

---

<a name="function-decodemessagenode-"></a>

> Source: [https://baileys.wiki/docs/api/functions/decodeMessageNode](https://baileys.wiki/docs/api/functions/decodeMessageNode)

> **decodeMessageNode**(`stanza`, `meId`, `meLid`): `object`

Defined in: [src/Utils/decode-wa-message.ts:122](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/decode-wa-message.ts#L122)

Decode the received node as a message.

## Parameters[​](#parameters "Direct link to Parameters")

### stanza[​](#stanza "Direct link to stanza")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

### meId[​](#meid "Direct link to meId")

`string`

### meLid[​](#melid "Direct link to meLid")

`string`

## Returns[​](#returns "Direct link to Returns")

`object`

### author[​](#author "Direct link to author")

> **author**: `string`

### fullMessage[​](#fullmessage "Direct link to fullMessage")

> **fullMessage**: [`WAMessage`](/docs/api/type-aliases/WAMessage)

### sender[​](#sender "Direct link to sender")

> **sender**: `string`

## Note[​](#note "Direct link to Note")

this will only parse the message, not decrypt it

---

<a name="function-decodepatches-"></a>

> Source: [https://baileys.wiki/docs/api/functions/decodePatches](https://baileys.wiki/docs/api/functions/decodePatches)

> **decodePatches**(`name`, `syncds`, `initial`, `getAppStateSyncKey`, `options`, `minimumVersionNumber`?, `logger`?, `validateMacs`?): `Promise`<{ `mutationMap`: [`ChatMutationMap`](/docs/api/type-aliases/ChatMutationMap); `state`: [`LTHashState`](/docs/api/type-aliases/LTHashState); }>

Defined in: [src/Utils/chat-utils.ts:422](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/chat-utils.ts#L422)

## Parameters[​](#parameters "Direct link to Parameters")

### name[​](#name "Direct link to name")

`"critical_unblock_low"` | `"regular_high"` | `"regular_low"` | `"critical_block"` | `"regular"`

### syncds[​](#syncds "Direct link to syncds")

[`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch)\[\]

### initial[​](#initial "Direct link to initial")

[`LTHashState`](/docs/api/type-aliases/LTHashState)

### getAppStateSyncKey[​](#getappstatesynckey "Direct link to getAppStateSyncKey")

`FetchAppStateSyncKey`

### options[​](#options "Direct link to options")

`RequestInit`

### minimumVersionNumber?[​](#minimumversionnumber "Direct link to minimumVersionNumber?")

`number`

### logger?[​](#logger "Direct link to logger?")

`ILogger`

### validateMacs?[​](#validatemacs "Direct link to validateMacs?")

`boolean` = `true`

## Returns[​](#returns "Direct link to Returns")

`Promise`<{ `mutationMap`: [`ChatMutationMap`](/docs/api/type-aliases/ChatMutationMap); `state`: [`LTHashState`](/docs/api/type-aliases/LTHashState); }>

---

<a name="function-decodesyncdmutations-"></a>

> Source: [https://baileys.wiki/docs/api/functions/decodeSyncdMutations](https://baileys.wiki/docs/api/functions/decodeSyncdMutations)

> **decodeSyncdMutations**(`msgMutations`, `initialState`, `getAppStateSyncKey`, `onMutation`, `validateMacs`): `Promise`<{ `hash`: `Buffer`<`ArrayBuffer`\>; `indexValueMap`: {}; }>

Defined in: [src/Utils/chat-utils.ts:197](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/chat-utils.ts#L197)

## Parameters[​](#parameters "Direct link to Parameters")

### msgMutations[​](#msgmutations "Direct link to msgMutations")

([`ISyncdMutation`](/docs/api/namespaces/proto/interfaces/ISyncdMutation) | [`ISyncdRecord`](/docs/api/namespaces/proto/interfaces/ISyncdRecord))\[\]

### initialState[​](#initialstate "Direct link to initialState")

[`LTHashState`](/docs/api/type-aliases/LTHashState)

### getAppStateSyncKey[​](#getappstatesynckey "Direct link to getAppStateSyncKey")

`FetchAppStateSyncKey`

### onMutation[​](#onmutation "Direct link to onMutation")

(`mutation`) => `void`

### validateMacs[​](#validatemacs "Direct link to validateMacs")

`boolean`

## Returns[​](#returns "Direct link to Returns")

`Promise`<{ `hash`: `Buffer`<`ArrayBuffer`\>; `indexValueMap`: {}; }>

---

<a name="function-decodesyncdpatch-"></a>

> Source: [https://baileys.wiki/docs/api/functions/decodeSyncdPatch](https://baileys.wiki/docs/api/functions/decodeSyncdPatch)

> **decodeSyncdPatch**(`msg`, `name`, `initialState`, `getAppStateSyncKey`, `onMutation`, `validateMacs`): `Promise`<{ `hash`: `Buffer`<`ArrayBuffer`\>; `indexValueMap`: {}; }>

Defined in: [src/Utils/chat-utils.ts:272](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/chat-utils.ts#L272)

## Parameters[​](#parameters "Direct link to Parameters")

### msg[​](#msg "Direct link to msg")

[`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch)

### name[​](#name "Direct link to name")

`"critical_unblock_low"` | `"regular_high"` | `"regular_low"` | `"critical_block"` | `"regular"`

### initialState[​](#initialstate "Direct link to initialState")

[`LTHashState`](/docs/api/type-aliases/LTHashState)

### getAppStateSyncKey[​](#getappstatesynckey "Direct link to getAppStateSyncKey")

`FetchAppStateSyncKey`

### onMutation[​](#onmutation "Direct link to onMutation")

(`mutation`) => `void`

### validateMacs[​](#validatemacs "Direct link to validateMacs")

`boolean`

## Returns[​](#returns "Direct link to Returns")

`Promise`<{ `hash`: `Buffer`<`ArrayBuffer`\>; `indexValueMap`: {}; }>

---

<a name="function-decodesyncdsnapshot-"></a>

> Source: [https://baileys.wiki/docs/api/functions/decodeSyncdSnapshot](https://baileys.wiki/docs/api/functions/decodeSyncdSnapshot)

> **decodeSyncdSnapshot**(`name`, `snapshot`, `getAppStateSyncKey`, `minimumVersionNumber`, `validateMacs`): `Promise`<{ `mutationMap`: [`ChatMutationMap`](/docs/api/type-aliases/ChatMutationMap); `state`: [`LTHashState`](/docs/api/type-aliases/LTHashState); }>

Defined in: [src/Utils/chat-utils.ts:374](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/chat-utils.ts#L374)

## Parameters[​](#parameters "Direct link to Parameters")

### name[​](#name "Direct link to name")

`"critical_unblock_low"` | `"regular_high"` | `"regular_low"` | `"critical_block"` | `"regular"`

### snapshot[​](#snapshot "Direct link to snapshot")

[`ISyncdSnapshot`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot)

### getAppStateSyncKey[​](#getappstatesynckey "Direct link to getAppStateSyncKey")

`FetchAppStateSyncKey`

### minimumVersionNumber[​](#minimumversionnumber "Direct link to minimumVersionNumber")

`undefined` | `number`

### validateMacs[​](#validatemacs "Direct link to validateMacs")

`boolean` = `true`

## Returns[​](#returns "Direct link to Returns")

`Promise`<{ `mutationMap`: [`ChatMutationMap`](/docs/api/type-aliases/ChatMutationMap); `state`: [`LTHashState`](/docs/api/type-aliases/LTHashState); }>

---

<a name="function-decompressingifrequired-"></a>

> Source: [https://baileys.wiki/docs/api/functions/decompressingIfRequired](https://baileys.wiki/docs/api/functions/decompressingIfRequired)

> **decompressingIfRequired**(`buffer`): `Promise`<`Buffer`<`ArrayBufferLike`\>>

Defined in: [src/WABinary/decode.ts:9](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/decode.ts#L9)

## Parameters[​](#parameters "Direct link to Parameters")

### buffer[​](#buffer "Direct link to buffer")

`Buffer`

## Returns[​](#returns "Direct link to Returns")

`Promise`<`Buffer`<`ArrayBufferLike`\>>

---

<a name="function-decrypteventresponse-"></a>

> Source: [https://baileys.wiki/docs/api/functions/decryptEventResponse](https://baileys.wiki/docs/api/functions/decryptEventResponse)

> **decryptEventResponse**(`response`, `ctx`): [`EventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EventResponseMessage)

Defined in: [src/Utils/process-message.ts:197](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/process-message.ts#L197)

Decrypt an event response

## Parameters[​](#parameters "Direct link to Parameters")

### response[​](#response "Direct link to response")

[`IPollEncValue`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollEncValue)

encrypted event response

### ctx[​](#ctx "Direct link to ctx")

`EventContext`

additional info about the event required for decryption

## Returns[​](#returns "Direct link to Returns")

[`EventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EventResponseMessage)

event response message

---

<a name="function-decryptmediaretrydata-"></a>

> Source: [https://baileys.wiki/docs/api/functions/decryptMediaRetryData](https://baileys.wiki/docs/api/functions/decryptMediaRetryData)

> **decryptMediaRetryData**(`__namedParameters`, `mediaKey`, `msgId`): [`MediaRetryNotification`](/docs/api/namespaces/proto/classes/MediaRetryNotification)

Defined in: [src/Utils/messages-media.ts:966](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L966)

## Parameters[​](#parameters "Direct link to Parameters")

### \_\_namedParameters[​](#__namedparameters "Direct link to __namedParameters")

#### ciphertext[​](#ciphertext "Direct link to ciphertext")

`Uint8Array`

#### iv[​](#iv "Direct link to iv")

`Uint8Array`

### mediaKey[​](#mediakey "Direct link to mediaKey")

`Uint8Array`

### msgId[​](#msgid "Direct link to msgId")

`string`

## Returns[​](#returns "Direct link to Returns")

[`MediaRetryNotification`](/docs/api/namespaces/proto/classes/MediaRetryNotification)

---

<a name="function-decryptmessagenode-"></a>

> Source: [https://baileys.wiki/docs/api/functions/decryptMessageNode](https://baileys.wiki/docs/api/functions/decryptMessageNode)

> **decryptMessageNode**(`stanza`, `meId`, `meLid`, `repository`, `logger`): `object`

Defined in: [src/Utils/decode-wa-message.ts:226](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/decode-wa-message.ts#L226)

## Parameters[​](#parameters "Direct link to Parameters")

### stanza[​](#stanza "Direct link to stanza")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

### meId[​](#meid "Direct link to meId")

`string`

### meLid[​](#melid "Direct link to meLid")

`string`

### repository[​](#repository "Direct link to repository")

[`SignalRepositoryWithLIDStore`](/docs/api/interfaces/SignalRepositoryWithLIDStore)

### logger[​](#logger "Direct link to logger")

`ILogger`

## Returns[​](#returns "Direct link to Returns")

`object`

### author[​](#author "Direct link to author")

> **author**: `string`

### category[​](#category "Direct link to category")

> **category**: `undefined` | `string` = `stanza.attrs.category`

### fullMessage[​](#fullmessage "Direct link to fullMessage")

> **fullMessage**: [`WAMessage`](/docs/api/type-aliases/WAMessage)

### decrypt()[​](#decrypt "Direct link to decrypt()")

#### Returns[​](#returns-1 "Direct link to Returns")

`Promise`<`void`\>

---

<a name="function-decryptpollvote-"></a>

> Source: [https://baileys.wiki/docs/api/functions/decryptPollVote](https://baileys.wiki/docs/api/functions/decryptPollVote)

> **decryptPollVote**(`vote`, `ctx`): [`PollVoteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollVoteMessage)

Defined in: [src/Utils/process-message.ts:167](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/process-message.ts#L167)

Decrypt a poll vote

## Parameters[​](#parameters "Direct link to Parameters")

### vote[​](#vote "Direct link to vote")

[`IPollEncValue`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollEncValue)

encrypted vote

### ctx[​](#ctx "Direct link to ctx")

`PollContext`

additional info about the poll required for decryption

## Returns[​](#returns "Direct link to Returns")

[`PollVoteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollVoteMessage)

list of SHA256 options

---

<a name="function-delay-"></a>

> Source: [https://baileys.wiki/docs/api/functions/delay](https://baileys.wiki/docs/api/functions/delay)

> **delay**(`ms`): `Promise`<`void`\>

Defined in: [src/Utils/generics.ts:125](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L125)

## Parameters[​](#parameters "Direct link to Parameters")

### ms[​](#ms "Direct link to ms")

`number`

## Returns[​](#returns "Direct link to Returns")

`Promise`<`void`\>

---

<a name="function-delaycancellable-"></a>

> Source: [https://baileys.wiki/docs/api/functions/delayCancellable](https://baileys.wiki/docs/api/functions/delayCancellable)

> **delayCancellable**(`ms`): `object`

Defined in: [src/Utils/generics.ts:127](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L127)

## Parameters[​](#parameters "Direct link to Parameters")

### ms[​](#ms "Direct link to ms")

`number`

## Returns[​](#returns "Direct link to Returns")

`object`

### cancel()[​](#cancel "Direct link to cancel()")

> **cancel**: () => `void`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

### delay[​](#delay "Direct link to delay")

> **delay**: `Promise`<`void`\>

---

<a name="function-derivepairingcodekey-"></a>

> Source: [https://baileys.wiki/docs/api/functions/derivePairingCodeKey](https://baileys.wiki/docs/api/functions/derivePairingCodeKey)

> **derivePairingCodeKey**(`pairingCode`, `salt`): `Promise`<`Buffer`<`ArrayBufferLike`\>>

Defined in: [src/Utils/crypto.ts:122](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/crypto.ts#L122)

## Parameters[​](#parameters "Direct link to Parameters")

### pairingCode[​](#pairingcode "Direct link to pairingCode")

`string`

### salt[​](#salt "Direct link to salt")

`Buffer`

## Returns[​](#returns "Direct link to Returns")

`Promise`<`Buffer`<`ArrayBufferLike`\>>

---

<a name="function-downloadandprocesshistorysyncnotification-"></a>

> Source: [https://baileys.wiki/docs/api/functions/downloadAndProcessHistorySyncNotification](https://baileys.wiki/docs/api/functions/downloadAndProcessHistorySyncNotification)

> **downloadAndProcessHistorySyncNotification**(`msg`, `options`, `logger`?): `Promise`<{ `chats`: [`Chat`](/docs/api/type-aliases/Chat)\[\]; `contacts`: [`Contact`](/docs/api/interfaces/Contact)\[\]; `lidPnMappings`: [`LIDMapping`](/docs/api/type-aliases/LIDMapping)\[\]; `messages`: [`WAMessage`](/docs/api/type-aliases/WAMessage)\[\]; `progress`: `undefined` | `null` | `number`; `syncType`: `undefined` | `null` | [`HistorySyncType`](/docs/api/namespaces/proto/namespaces/HistorySync/enumerations/HistorySyncType); }>

Defined in: [src/Utils/history.ts:141](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/history.ts#L141)

## Parameters[​](#parameters "Direct link to Parameters")

### msg[​](#msg "Direct link to msg")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification)

### options[​](#options "Direct link to options")

`RequestInit`

### logger?[​](#logger "Direct link to logger?")

`ILogger`

## Returns[​](#returns "Direct link to Returns")

`Promise`<{ `chats`: [`Chat`](/docs/api/type-aliases/Chat)\[\]; `contacts`: [`Contact`](/docs/api/interfaces/Contact)\[\]; `lidPnMappings`: [`LIDMapping`](/docs/api/type-aliases/LIDMapping)\[\]; `messages`: [`WAMessage`](/docs/api/type-aliases/WAMessage)\[\]; `progress`: `undefined` | `null` | `number`; `syncType`: `undefined` | `null` | [`HistorySyncType`](/docs/api/namespaces/proto/namespaces/HistorySync/enumerations/HistorySyncType); }>

---

<a name="function-downloadcontentfrommessage-"></a>

> Source: [https://baileys.wiki/docs/api/functions/downloadContentFromMessage](https://baileys.wiki/docs/api/functions/downloadContentFromMessage)

> **downloadContentFromMessage**(`__namedParameters`, `type`, `opts`): `Promise`<`Transform`\>

Defined in: [src/Utils/messages-media.ts:518](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L518)

## Parameters[​](#parameters "Direct link to Parameters")

### \_\_namedParameters[​](#__namedparameters "Direct link to __namedParameters")

[`DownloadableMessage`](/docs/api/type-aliases/DownloadableMessage)

### type[​](#type "Direct link to type")

`"ppic"` | `"product"` | `"image"` | `"video"` | `"sticker"` | `"thumbnail-document"` | `"audio"` | `"thumbnail-image"` | `"biz-cover-photo"` | `"thumbnail-video"` | `"thumbnail-link"` | `"gif"` | `"md-app-state"` | `"md-msg-hist"` | `"document"` | `"ptt"` | `"product-catalog-image"` | `"payment-bg-image"` | `"ptv"`

### opts[​](#opts "Direct link to opts")

[`MediaDownloadOptions`](/docs/api/type-aliases/MediaDownloadOptions) = `{}`

## Returns[​](#returns "Direct link to Returns")

`Promise`<`Transform`\>

---

<a name="function-downloadencryptedcontent-"></a>

> Source: [https://baileys.wiki/docs/api/functions/downloadEncryptedContent](https://baileys.wiki/docs/api/functions/downloadEncryptedContent)

> **downloadEncryptedContent**(`downloadUrl`, `__namedParameters`, `__namedParameters`): `Promise`<`Transform`\>

Defined in: [src/Utils/messages-media.ts:538](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L538)

Decrypts and downloads an AES256-CBC encrypted file given the keys. Assumes the SHA256 of the plaintext is appended to the end of the ciphertext

## Parameters[​](#parameters "Direct link to Parameters")

### downloadUrl[​](#downloadurl "Direct link to downloadUrl")

`string`

### \_\_namedParameters[​](#__namedparameters "Direct link to __namedParameters")

[`MediaDecryptionKeyInfo`](/docs/api/type-aliases/MediaDecryptionKeyInfo)

### \_\_namedParameters[​](#__namedparameters-1 "Direct link to __namedParameters")

[`MediaDownloadOptions`](/docs/api/type-aliases/MediaDownloadOptions) = `{}`

## Returns[​](#returns "Direct link to Returns")

`Promise`<`Transform`\>

---

<a name="function-downloadexternalblob-"></a>

> Source: [https://baileys.wiki/docs/api/functions/downloadExternalBlob](https://baileys.wiki/docs/api/functions/downloadExternalBlob)

> **downloadExternalBlob**(`blob`, `options`): `Promise`<`Buffer`<`ArrayBuffer`\>>

Defined in: [src/Utils/chat-utils.ts:358](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/chat-utils.ts#L358)

## Parameters[​](#parameters "Direct link to Parameters")

### blob[​](#blob "Direct link to blob")

[`IExternalBlobReference`](/docs/api/namespaces/proto/interfaces/IExternalBlobReference)

### options[​](#options "Direct link to options")

`RequestInit`

## Returns[​](#returns "Direct link to Returns")

`Promise`<`Buffer`<`ArrayBuffer`\>>

---

<a name="function-downloadexternalpatch-"></a>

> Source: [https://baileys.wiki/docs/api/functions/downloadExternalPatch](https://baileys.wiki/docs/api/functions/downloadExternalPatch)

> **downloadExternalPatch**(`blob`, `options`): `Promise`<[`SyncdMutations`](/docs/api/namespaces/proto/classes/SyncdMutations)\>

Defined in: [src/Utils/chat-utils.ts:368](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/chat-utils.ts#L368)

## Parameters[​](#parameters "Direct link to Parameters")

### blob[​](#blob "Direct link to blob")

[`IExternalBlobReference`](/docs/api/namespaces/proto/interfaces/IExternalBlobReference)

### options[​](#options "Direct link to options")

`RequestInit`

## Returns[​](#returns "Direct link to Returns")

`Promise`<[`SyncdMutations`](/docs/api/namespaces/proto/classes/SyncdMutations)\>

---

<a name="function-downloadhistory-"></a>

> Source: [https://baileys.wiki/docs/api/functions/downloadHistory](https://baileys.wiki/docs/api/functions/downloadHistory)

> **downloadHistory**(`msg`, `options`): `Promise`<[`HistorySync`](/docs/api/namespaces/proto/classes/HistorySync)\>

Defined in: [src/Utils/history.ts:32](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/history.ts#L32)

## Parameters[​](#parameters "Direct link to Parameters")

### msg[​](#msg "Direct link to msg")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification)

### options[​](#options "Direct link to options")

`RequestInit`

## Returns[​](#returns "Direct link to Returns")

`Promise`<[`HistorySync`](/docs/api/namespaces/proto/classes/HistorySync)\>

---

<a name="function-downloadmediamessage-"></a>

> Source: [https://baileys.wiki/docs/api/functions/downloadMediaMessage](https://baileys.wiki/docs/api/functions/downloadMediaMessage)

> **downloadMediaMessage**<`Type`\>(`message`, `type`, `options`, `ctx`?): `Promise`<`Type` _extends_ `"buffer"` ? `Buffer`<`ArrayBufferLike`\> : `Transform`\>

Defined in: [src/Utils/messages.ts:1032](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L1032)

Downloads the given message. Throws an error if it's not a media message

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

• **Type** _extends_ `"buffer"` | `"stream"`

## Parameters[​](#parameters "Direct link to Parameters")

### message[​](#message "Direct link to message")

[`WAMessage`](/docs/api/type-aliases/WAMessage)

### type[​](#type "Direct link to type")

`Type`

### options[​](#options "Direct link to options")

[`MediaDownloadOptions`](/docs/api/type-aliases/MediaDownloadOptions)

### ctx?[​](#ctx "Direct link to ctx?")

`DownloadMediaMessageContext`

## Returns[​](#returns "Direct link to Returns")

`Promise`<`Type` _extends_ `"buffer"` ? `Buffer`<`ArrayBufferLike`\> : `Transform`\>

---

<a name="function-encodebase64encodedstringforupload-"></a>

> Source: [https://baileys.wiki/docs/api/functions/encodeBase64EncodedStringForUpload](https://baileys.wiki/docs/api/functions/encodeBase64EncodedStringForUpload)

> **encodeBase64EncodedStringForUpload**(`b64`): `string`

Defined in: [src/Utils/messages-media.ts:173](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L173)

## Parameters[​](#parameters "Direct link to Parameters")

### b64[​](#b64 "Direct link to b64")

`string`

## Returns[​](#returns "Direct link to Returns")

`string`

---

<a name="function-encodebigendian-"></a>

> Source: [https://baileys.wiki/docs/api/functions/encodeBigEndian](https://baileys.wiki/docs/api/functions/encodeBigEndian)

> **encodeBigEndian**(`e`, `t`): `Uint8Array`<`ArrayBuffer`\>

Defined in: [src/Utils/generics.ts:88](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L88)

## Parameters[​](#parameters "Direct link to Parameters")

### e[​](#e "Direct link to e")

`number`

### t[​](#t "Direct link to t")

`number` = `4`

## Returns[​](#returns "Direct link to Returns")

`Uint8Array`<`ArrayBuffer`\>

---

<a name="function-encodebinarynode-"></a>

> Source: [https://baileys.wiki/docs/api/functions/encodeBinaryNode](https://baileys.wiki/docs/api/functions/encodeBinaryNode)

> **encodeBinaryNode**(`node`, `opts`, `buffer`): `Buffer`

Defined in: [src/WABinary/encode.ts:5](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/encode.ts#L5)

## Parameters[​](#parameters "Direct link to Parameters")

### node[​](#node "Direct link to node")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

### opts[​](#opts "Direct link to opts")

`Pick`<`__module`, `"TAGS"` | `"TOKEN_MAP"`\> = `constants`

### buffer[​](#buffer "Direct link to buffer")

`number`\[\] = `...`

## Returns[​](#returns "Direct link to Returns")

`Buffer`

---

<a name="function-encodenewslettermessage-"></a>

> Source: [https://baileys.wiki/docs/api/functions/encodeNewsletterMessage](https://baileys.wiki/docs/api/functions/encodeNewsletterMessage)

> **encodeNewsletterMessage**(`message`): `Uint8Array`

Defined in: [src/Utils/generics.ts:472](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L472)

## Parameters[​](#parameters "Direct link to Parameters")

### message[​](#message "Direct link to message")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

## Returns[​](#returns "Direct link to Returns")

`Uint8Array`

---

<a name="function-encodesigneddeviceidentity-"></a>

> Source: [https://baileys.wiki/docs/api/functions/encodeSignedDeviceIdentity](https://baileys.wiki/docs/api/functions/encodeSignedDeviceIdentity)

> **encodeSignedDeviceIdentity**(`account`, `includeSignatureKey`): `Uint8Array`<`ArrayBufferLike`\>

Defined in: [src/Utils/validate-connection.ts:244](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/validate-connection.ts#L244)

## Parameters[​](#parameters "Direct link to Parameters")

### account[​](#account "Direct link to account")

[`IADVSignedDeviceIdentity`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentity)

### includeSignatureKey[​](#includesignaturekey "Direct link to includeSignatureKey")

`boolean`

## Returns[​](#returns "Direct link to Returns")

`Uint8Array`<`ArrayBufferLike`\>

---

<a name="function-encodesyncdpatch-"></a>

> Source: [https://baileys.wiki/docs/api/functions/encodeSyncdPatch](https://baileys.wiki/docs/api/functions/encodeSyncdPatch)

> **encodeSyncdPatch**(`__namedParameters`, `myAppStateKeyId`, `state`, `getAppStateSyncKey`): `Promise`<{ `patch`: [`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch); `state`: [`LTHashState`](/docs/api/type-aliases/LTHashState); }>

Defined in: [src/Utils/chat-utils.ts:132](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/chat-utils.ts#L132)

## Parameters[​](#parameters "Direct link to Parameters")

### \_\_namedParameters[​](#__namedparameters "Direct link to __namedParameters")

[`WAPatchCreate`](/docs/api/type-aliases/WAPatchCreate)

### myAppStateKeyId[​](#myappstatekeyid "Direct link to myAppStateKeyId")

`string`

### state[​](#state "Direct link to state")

[`LTHashState`](/docs/api/type-aliases/LTHashState)

### getAppStateSyncKey[​](#getappstatesynckey "Direct link to getAppStateSyncKey")

`FetchAppStateSyncKey`

## Returns[​](#returns "Direct link to Returns")

`Promise`<{ `patch`: [`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch); `state`: [`LTHashState`](/docs/api/type-aliases/LTHashState); }>

---

<a name="function-encodewam-"></a>

> Source: [https://baileys.wiki/docs/api/functions/encodeWAM](https://baileys.wiki/docs/api/functions/encodeWAM)

> **encodeWAM**(`binaryInfo`): `Buffer`<`ArrayBuffer`\>

Defined in: [src/WAM/encode.ts:15](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAM/encode.ts#L15)

## Parameters[​](#parameters "Direct link to Parameters")

### binaryInfo[​](#binaryinfo "Direct link to binaryInfo")

[`BinaryInfo`](/docs/api/classes/BinaryInfo)

## Returns[​](#returns "Direct link to Returns")

`Buffer`<`ArrayBuffer`\>

---

<a name="function-encodewamessage-"></a>

> Source: [https://baileys.wiki/docs/api/functions/encodeWAMessage](https://baileys.wiki/docs/api/functions/encodeWAMessage)

> **encodeWAMessage**(`message`): `Buffer`<`ArrayBuffer`\>

Defined in: [src/Utils/generics.ts:82](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L82)

## Parameters[​](#parameters "Direct link to Parameters")

### message[​](#message "Direct link to message")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

## Returns[​](#returns "Direct link to Returns")

`Buffer`<`ArrayBuffer`\>

---

<a name="function-encryptmediaretryrequest-"></a>

> Source: [https://baileys.wiki/docs/api/functions/encryptMediaRetryRequest](https://baileys.wiki/docs/api/functions/encryptMediaRetryRequest)

> **encryptMediaRetryRequest**(`key`, `mediaKey`, `meId`): [`BinaryNode`](/docs/api/type-aliases/BinaryNode)

Defined in: [src/Utils/messages-media.ts:891](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L891)

Generate a binary node that will request the phone to re-upload the media & return the newly uploaded URL

## Parameters[​](#parameters "Direct link to Parameters")

### key[​](#key "Direct link to key")

[`WAMessageKey`](/docs/api/type-aliases/WAMessageKey)

### mediaKey[​](#mediakey "Direct link to mediaKey")

`Uint8Array`<`ArrayBufferLike`\> | `Buffer`<`ArrayBufferLike`\>

### meId[​](#meid "Direct link to meId")

`string`

## Returns[​](#returns "Direct link to Returns")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

---

<a name="function-encryptedstream-"></a>

> Source: [https://baileys.wiki/docs/api/functions/encryptedStream](https://baileys.wiki/docs/api/functions/encryptedStream)

> **encryptedStream**(`media`, `mediaType`, `__namedParameters`): `Promise`<{ `encFilePath`: `string`; `fileEncSha256`: `Buffer`<`ArrayBufferLike`\>; `fileLength`: `number`; `fileSha256`: `Buffer`<`ArrayBufferLike`\>; `mac`: `Buffer`<`ArrayBuffer`\>; `mediaKey`: `Buffer`<`ArrayBufferLike`\>; `originalFilePath`: `undefined` | `string`; }>

Defined in: [src/Utils/messages-media.ts:385](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L385)

## Parameters[​](#parameters "Direct link to Parameters")

### media[​](#media "Direct link to media")

[`WAMediaUpload`](/docs/api/type-aliases/WAMediaUpload)

### mediaType[​](#mediatype "Direct link to mediaType")

`"ppic"` | `"product"` | `"image"` | `"video"` | `"sticker"` | `"thumbnail-document"` | `"audio"` | `"thumbnail-image"` | `"biz-cover-photo"` | `"thumbnail-video"` | `"thumbnail-link"` | `"gif"` | `"md-app-state"` | `"md-msg-hist"` | `"document"` | `"ptt"` | `"product-catalog-image"` | `"payment-bg-image"` | `"ptv"`

### \_\_namedParameters[​](#__namedparameters "Direct link to __namedParameters")

`EncryptedStreamOptions` = `{}`

## Returns[​](#returns "Direct link to Returns")

`Promise`<{ `encFilePath`: `string`; `fileEncSha256`: `Buffer`<`ArrayBufferLike`\>; `fileLength`: `number`; `fileSha256`: `Buffer`<`ArrayBufferLike`\>; `mac`: `Buffer`<`ArrayBuffer`\>; `mediaKey`: `Buffer`<`ArrayBufferLike`\>; `originalFilePath`: `undefined` | `string`; }>

---

<a name="function-extensionformediamessage-"></a>

> Source: [https://baileys.wiki/docs/api/functions/extensionForMediaMessage](https://baileys.wiki/docs/api/functions/extensionForMediaMessage)

> **extensionForMediaMessage**(`message`): `string`

Defined in: [src/Utils/messages-media.ts:640](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L640)

## Parameters[​](#parameters "Direct link to Parameters")

### message[​](#message "Direct link to message")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

## Returns[​](#returns "Direct link to Returns")

`string`

---

<a name="function-extractaddressingcontext-"></a>

> Source: [https://baileys.wiki/docs/api/functions/extractAddressingContext](https://baileys.wiki/docs/api/functions/extractAddressingContext)

> **extractAddressingContext**(`stanza`): `object`

Defined in: [src/Utils/decode-wa-message.ts:87](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/decode-wa-message.ts#L87)

## Parameters[​](#parameters "Direct link to Parameters")

### stanza[​](#stanza "Direct link to stanza")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

## Returns[​](#returns "Direct link to Returns")

`object`

### addressingMode[​](#addressingmode "Direct link to addressingMode")

> **addressingMode**: `string`

### recipientAlt[​](#recipientalt "Direct link to recipientAlt")

> **recipientAlt**: `undefined` | `string`

### senderAlt[​](#senderalt "Direct link to senderAlt")

> **senderAlt**: `undefined` | `string`

---

<a name="function-extractdevicejids-"></a>

> Source: [https://baileys.wiki/docs/api/functions/extractDeviceJids](https://baileys.wiki/docs/api/functions/extractDeviceJids)

> **extractDeviceJids**(`result`, `myJid`, `myLid`, `excludeZeroDevices`): [`FullJid`](/docs/api/type-aliases/FullJid)\[\]

Defined in: [src/Utils/signal.ts:134](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/signal.ts#L134)

## Parameters[​](#parameters "Direct link to Parameters")

### result[​](#result "Direct link to result")

[`USyncQueryResultList`](/docs/api/type-aliases/USyncQueryResultList)\[\]

### myJid[​](#myjid "Direct link to myJid")

`string`

### myLid[​](#mylid "Direct link to myLid")

`string`

### excludeZeroDevices[​](#excludezerodevices "Direct link to excludeZeroDevices")

`boolean`

## Returns[​](#returns "Direct link to Returns")

[`FullJid`](/docs/api/type-aliases/FullJid)\[\]

---

<a name="function-extractimagethumb-"></a>

> Source: [https://baileys.wiki/docs/api/functions/extractImageThumb](https://baileys.wiki/docs/api/functions/extractImageThumb)

> **extractImageThumb**(`bufferOrFilePath`, `width`): `Promise`<{ `buffer`: `any`; `original`: { `height`: `any`; `width`: `any`; }; }>

Defined in: [src/Utils/messages-media.ts:135](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L135)

## Parameters[​](#parameters "Direct link to Parameters")

### bufferOrFilePath[​](#bufferorfilepath "Direct link to bufferOrFilePath")

`string` | `Buffer`<`ArrayBufferLike`\> | `Readable`

### width[​](#width "Direct link to width")

`number` = `32`

## Returns[​](#returns "Direct link to Returns")

`Promise`<{ `buffer`: `any`; `original`: { `height`: `any`; `width`: `any`; }; }>

---

<a name="function-extractmessagecontent-"></a>

> Source: [https://baileys.wiki/docs/api/functions/extractMessageContent](https://baileys.wiki/docs/api/functions/extractMessageContent)

> **extractMessageContent**(`content`): `undefined` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [src/Utils/messages.ts:809](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L809)

Extract the true message content from a message Eg. extracts the inner message from a disappearing message/view once message

## Parameters[​](#parameters "Direct link to Parameters")

### content[​](#content "Direct link to content")

`undefined` | `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

## Returns[​](#returns "Direct link to Returns")

`undefined` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

---

<a name="function-extractsyncdpatches-"></a>

> Source: [https://baileys.wiki/docs/api/functions/extractSyncdPatches](https://baileys.wiki/docs/api/functions/extractSyncdPatches)

> **extractSyncdPatches**(`result`, `options`): `Promise`<{ `critical_block`: { `hasMorePatches`: `boolean`; `patches`: [`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch)\[\]; `snapshot`: [`ISyncdSnapshot`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot); }; `critical_unblock_low`: { `hasMorePatches`: `boolean`; `patches`: [`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch)\[\]; `snapshot`: [`ISyncdSnapshot`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot); }; `regular`: { `hasMorePatches`: `boolean`; `patches`: [`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch)\[\]; `snapshot`: [`ISyncdSnapshot`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot); }; `regular_high`: { `hasMorePatches`: `boolean`; `patches`: [`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch)\[\]; `snapshot`: [`ISyncdSnapshot`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot); }; `regular_low`: { `hasMorePatches`: `boolean`; `patches`: [`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch)\[\]; `snapshot`: [`ISyncdSnapshot`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot); }; }>

Defined in: [src/Utils/chat-utils.ts:306](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/chat-utils.ts#L306)

## Parameters[​](#parameters "Direct link to Parameters")

### result[​](#result "Direct link to result")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

### options[​](#options "Direct link to options")

`RequestInit`

## Returns[​](#returns "Direct link to Returns")

`Promise`<{ `critical_block`: { `hasMorePatches`: `boolean`; `patches`: [`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch)\[\]; `snapshot`: [`ISyncdSnapshot`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot); }; `critical_unblock_low`: { `hasMorePatches`: `boolean`; `patches`: [`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch)\[\]; `snapshot`: [`ISyncdSnapshot`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot); }; `regular`: { `hasMorePatches`: `boolean`; `patches`: [`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch)\[\]; `snapshot`: [`ISyncdSnapshot`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot); }; `regular_high`: { `hasMorePatches`: `boolean`; `patches`: [`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch)\[\]; `snapshot`: [`ISyncdSnapshot`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot); }; `regular_low`: { `hasMorePatches`: `boolean`; `patches`: [`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch)\[\]; `snapshot`: [`ISyncdSnapshot`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot); }; }>

---

<a name="function-extracturlfromtext-"></a>

> Source: [https://baileys.wiki/docs/api/functions/extractUrlFromText](https://baileys.wiki/docs/api/functions/extractUrlFromText)

> **extractUrlFromText**(`text`): `undefined` | `string`

Defined in: [src/Utils/messages.ts:90](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L90)

Uses a regex to test whether the string contains a URL, and returns the URL if it does.

## Parameters[​](#parameters "Direct link to Parameters")

### text[​](#text "Direct link to text")

`string`

eg. hello [https://google.com](https://google.com)

## Returns[​](#returns "Direct link to Returns")

`undefined` | `string`

the URL, eg. [https://google.com](https://google.com)

---

<a name="function-fetchlatestbaileysversion-"></a>

> Source: [https://baileys.wiki/docs/api/functions/fetchLatestBaileysVersion](https://baileys.wiki/docs/api/functions/fetchLatestBaileysVersion)

> **fetchLatestBaileysVersion**(`options`): `Promise`<{ `error`: `undefined`; `isLatest`: `boolean`; `version`: [`WAVersion`](/docs/api/type-aliases/WAVersion); } | { `error`: `unknown`; `isLatest`: `boolean`; `version`: [`WAVersion`](/docs/api/type-aliases/WAVersion); }>

Defined in: [src/Utils/generics.ts:238](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L238)

utility that fetches latest baileys version from the master branch. Use to ensure your WA connection is always on the latest version

## Parameters[​](#parameters "Direct link to Parameters")

### options[​](#options "Direct link to options")

`RequestInit` = `{}`

## Returns[​](#returns "Direct link to Returns")

`Promise`<{ `error`: `undefined`; `isLatest`: `boolean`; `version`: [`WAVersion`](/docs/api/type-aliases/WAVersion); } | { `error`: `unknown`; `isLatest`: `boolean`; `version`: [`WAVersion`](/docs/api/type-aliases/WAVersion); }>

---

<a name="function-fetchlatestwawebversion-"></a>

> Source: [https://baileys.wiki/docs/api/functions/fetchLatestWaWebVersion](https://baileys.wiki/docs/api/functions/fetchLatestWaWebVersion)

> **fetchLatestWaWebVersion**(`options`): `Promise`<{ `error`: `undefined`; `isLatest`: `boolean`; `version`: [`WAVersion`](/docs/api/type-aliases/WAVersion); } | { `error`: `unknown`; `isLatest`: `boolean`; `version`: [`WAVersion`](/docs/api/type-aliases/WAVersion); }>

Defined in: [src/Utils/generics.ts:279](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L279)

A utility that fetches the latest web version of whatsapp. Use to ensure your WA connection is always on the latest version

## Parameters[​](#parameters "Direct link to Parameters")

### options[​](#options "Direct link to options")

`RequestInit` = `{}`

## Returns[​](#returns "Direct link to Returns")

`Promise`<{ `error`: `undefined`; `isLatest`: `boolean`; `version`: [`WAVersion`](/docs/api/type-aliases/WAVersion); } | { `error`: `unknown`; `isLatest`: `boolean`; `version`: [`WAVersion`](/docs/api/type-aliases/WAVersion); }>

---

<a name="function-generateforwardmessagecontent-"></a>

> Source: [https://baileys.wiki/docs/api/functions/generateForwardMessageContent](https://baileys.wiki/docs/api/functions/generateForwardMessageContent)

> **generateForwardMessageContent**(`message`, `forceForward`?): [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [src/Utils/messages.ts:347](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L347)

Generate forwarded message content like WA does

## Parameters[​](#parameters "Direct link to Parameters")

### message[​](#message "Direct link to message")

[`WAMessage`](/docs/api/type-aliases/WAMessage)

the message to forward

### forceForward?[​](#forceforward "Direct link to forceForward?")

`boolean`

## Returns[​](#returns "Direct link to Returns")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

---

<a name="function-generatelinkpreviewifrequired-"></a>

> Source: [https://baileys.wiki/docs/api/functions/generateLinkPreviewIfRequired](https://baileys.wiki/docs/api/functions/generateLinkPreviewIfRequired)

> **generateLinkPreviewIfRequired**(`text`, `getUrlInfo`, `logger`): `Promise`<`undefined` | [`WAUrlInfo`](/docs/api/interfaces/WAUrlInfo)\>

Defined in: [src/Utils/messages.ts:92](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L92)

## Parameters[​](#parameters "Direct link to Parameters")

### text[​](#text "Direct link to text")

`string`

### getUrlInfo[​](#geturlinfo "Direct link to getUrlInfo")

`undefined` | (`text`) => `Promise`<`undefined` | [`WAUrlInfo`](/docs/api/interfaces/WAUrlInfo)\>

### logger[​](#logger "Direct link to logger")

`undefined` | `ILogger`

## Returns[​](#returns "Direct link to Returns")

`Promise`<`undefined` | [`WAUrlInfo`](/docs/api/interfaces/WAUrlInfo)\>

---

<a name="function-generateloginnode-"></a>

> Source: [https://baileys.wiki/docs/api/functions/generateLoginNode](https://baileys.wiki/docs/api/functions/generateLoginNode)

> **generateLoginNode**(`userJid`, `config`): [`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload)

Defined in: [src/Utils/validate-connection.ts:66](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/validate-connection.ts#L66)

## Parameters[​](#parameters "Direct link to Parameters")

### userJid[​](#userjid "Direct link to userJid")

`string`

### config[​](#config "Direct link to config")

[`SocketConfig`](/docs/api/type-aliases/SocketConfig)

## Returns[​](#returns "Direct link to Returns")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload)

---

<a name="function-generatemdtagprefix-"></a>

> Source: [https://baileys.wiki/docs/api/functions/generateMdTagPrefix](https://baileys.wiki/docs/api/functions/generateMdTagPrefix)

> **generateMdTagPrefix**(): `string`

Defined in: [src/Utils/generics.ts:331](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L331)

unique message tag prefix for MD clients

## Returns[​](#returns "Direct link to Returns")

`string`

---

<a name="function-generatemessageid-"></a>

> Source: [https://baileys.wiki/docs/api/functions/generateMessageID](https://baileys.wiki/docs/api/functions/generateMessageID)

> **generateMessageID**(): `string`

Defined in: [src/Utils/generics.ts:202](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L202)

## Returns[​](#returns "Direct link to Returns")

`string`

---

<a name="function-generatemessageidv2-"></a>

> Source: [https://baileys.wiki/docs/api/functions/generateMessageIDV2](https://baileys.wiki/docs/api/functions/generateMessageIDV2)

> **generateMessageIDV2**(`userId`?): `string`

Defined in: [src/Utils/generics.ts:182](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L182)

## Parameters[​](#parameters "Direct link to Parameters")

### userId?[​](#userid "Direct link to userId?")

`string`

## Returns[​](#returns "Direct link to Returns")

`string`

---

<a name="function-generateorgetprekeys-"></a>

> Source: [https://baileys.wiki/docs/api/functions/generateOrGetPreKeys](https://baileys.wiki/docs/api/functions/generateOrGetPreKeys)

> **generateOrGetPreKeys**(`creds`, `range`): `object`

Defined in: [src/Utils/signal.ts:53](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/signal.ts#L53)

## Parameters[​](#parameters "Direct link to Parameters")

### creds[​](#creds "Direct link to creds")

[`AuthenticationCreds`](/docs/api/type-aliases/AuthenticationCreds)

### range[​](#range "Direct link to range")

`number`

## Returns[​](#returns "Direct link to Returns")

`object`

### lastPreKeyId[​](#lastprekeyid "Direct link to lastPreKeyId")

> **lastPreKeyId**: `number`

### newPreKeys[​](#newprekeys "Direct link to newPreKeys")

> **newPreKeys**: `object`

#### Index Signature[​](#index-signature "Direct link to Index Signature")

\[`id`: `number`\]: [`KeyPair`](/docs/api/type-aliases/KeyPair)

### preKeysRange[​](#prekeysrange "Direct link to preKeysRange")

> **preKeysRange**: readonly \[`number`, `number`\]

---

<a name="function-generateparticipanthashv2-"></a>

> Source: [https://baileys.wiki/docs/api/functions/generateParticipantHashV2](https://baileys.wiki/docs/api/functions/generateParticipantHashV2)

> **generateParticipantHashV2**(`participants`): `string`

Defined in: [src/Utils/generics.ts:76](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L76)

## Parameters[​](#parameters "Direct link to Parameters")

### participants[​](#participants "Direct link to participants")

`string`\[\]

## Returns[​](#returns "Direct link to Returns")

`string`

---

<a name="function-generateprofilepicture-"></a>

> Source: [https://baileys.wiki/docs/api/functions/generateProfilePicture](https://baileys.wiki/docs/api/functions/generateProfilePicture)

> **generateProfilePicture**(`mediaUpload`, `dimensions`?): `Promise`<{ `img`: `Buffer`<`ArrayBufferLike`\>; }>

Defined in: [src/Utils/messages-media.ts:176](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L176)

## Parameters[​](#parameters "Direct link to Parameters")

### mediaUpload[​](#mediaupload "Direct link to mediaUpload")

[`WAMediaUpload`](/docs/api/type-aliases/WAMediaUpload)

### dimensions?[​](#dimensions "Direct link to dimensions?")

#### height[​](#height "Direct link to height")

`number`

#### width[​](#width "Direct link to width")

`number`

## Returns[​](#returns "Direct link to Returns")

`Promise`<{ `img`: `Buffer`<`ArrayBufferLike`\>; }>

---

<a name="function-generateregistrationid-"></a>

> Source: [https://baileys.wiki/docs/api/functions/generateRegistrationId](https://baileys.wiki/docs/api/functions/generateRegistrationId)

> **generateRegistrationId**(): `number`

Defined in: [src/Utils/generics.ts:84](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L84)

## Returns[​](#returns "Direct link to Returns")

`number`

---

<a name="function-generateregistrationnode-"></a>

> Source: [https://baileys.wiki/docs/api/functions/generateRegistrationNode](https://baileys.wiki/docs/api/functions/generateRegistrationNode)

> **generateRegistrationNode**(`__namedParameters`, `config`): [`ClientPayload`](/docs/api/namespaces/proto/classes/ClientPayload)

Defined in: [src/Utils/validate-connection.ts:88](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/validate-connection.ts#L88)

## Parameters[​](#parameters "Direct link to Parameters")

### \_\_namedParameters[​](#__namedparameters "Direct link to __namedParameters")

[`SignalCreds`](/docs/api/type-aliases/SignalCreds)

### config[​](#config "Direct link to config")

[`SocketConfig`](/docs/api/type-aliases/SocketConfig)

## Returns[​](#returns "Direct link to Returns")

[`ClientPayload`](/docs/api/namespaces/proto/classes/ClientPayload)

---

<a name="function-generatesignalpubkey-"></a>

> Source: [https://baileys.wiki/docs/api/functions/generateSignalPubKey](https://baileys.wiki/docs/api/functions/generateSignalPubKey)

> **generateSignalPubKey**(`pubKey`): `Uint8Array`<`ArrayBufferLike`\> | `Buffer`<`ArrayBufferLike`\>

Defined in: [src/Utils/crypto.ts:11](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/crypto.ts#L11)

prefix version byte to the pub keys, required for some curve crypto functions

## Parameters[​](#parameters "Direct link to Parameters")

### pubKey[​](#pubkey "Direct link to pubKey")

`Uint8Array`<`ArrayBufferLike`\> | `Buffer`<`ArrayBufferLike`\>

## Returns[​](#returns "Direct link to Returns")

`Uint8Array`<`ArrayBufferLike`\> | `Buffer`<`ArrayBufferLike`\>

---

<a name="function-generatethumbnail-"></a>

> Source: [https://baileys.wiki/docs/api/functions/generateThumbnail](https://baileys.wiki/docs/api/functions/generateThumbnail)

> **generateThumbnail**(`file`, `mediaType`, `options`): `Promise`<{ `originalImageDimensions`: `undefined` | { `height`: `number`; `width`: `number`; }; `thumbnail`: `undefined` | `string`; }>

Defined in: [src/Utils/messages-media.ts:328](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L328)

generates a thumbnail for a given media, if required

## Parameters[​](#parameters "Direct link to Parameters")

### file[​](#file "Direct link to file")

`string`

### mediaType[​](#mediatype "Direct link to mediaType")

`"image"` | `"video"`

### options[​](#options "Direct link to options")

#### logger?[​](#logger "Direct link to logger?")

`ILogger`

## Returns[​](#returns "Direct link to Returns")

`Promise`<{ `originalImageDimensions`: `undefined` | { `height`: `number`; `width`: `number`; }; `thumbnail`: `undefined` | `string`; }>

---

<a name="function-generatewamessage-"></a>

> Source: [https://baileys.wiki/docs/api/functions/generateWAMessage](https://baileys.wiki/docs/api/functions/generateWAMessage)

> **generateWAMessage**(`jid`, `content`, `options`): `Promise`<[`WAMessage`](/docs/api/type-aliases/WAMessage)\>

Defined in: [src/Utils/messages.ts:751](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L751)

## Parameters[​](#parameters "Direct link to Parameters")

### jid[​](#jid "Direct link to jid")

`string`

### content[​](#content "Direct link to content")

[`AnyMessageContent`](/docs/api/type-aliases/AnyMessageContent)

### options[​](#options "Direct link to options")

[`MessageGenerationOptions`](/docs/api/type-aliases/MessageGenerationOptions)

## Returns[​](#returns "Direct link to Returns")

`Promise`<[`WAMessage`](/docs/api/type-aliases/WAMessage)\>

---

<a name="function-generatewamessagecontent-"></a>

> Source: [https://baileys.wiki/docs/api/functions/generateWAMessageContent](https://baileys.wiki/docs/api/functions/generateWAMessageContent)

> **generateWAMessageContent**(`message`, `options`): `Promise`<[`Message`](/docs/api/namespaces/proto/classes/Message)\>

Defined in: [src/Utils/messages.ts:395](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L395)

## Parameters[​](#parameters "Direct link to Parameters")

### message[​](#message "Direct link to message")

[`AnyMessageContent`](/docs/api/type-aliases/AnyMessageContent)

### options[​](#options "Direct link to options")

[`MessageContentGenerationOptions`](/docs/api/type-aliases/MessageContentGenerationOptions)

## Returns[​](#returns "Direct link to Returns")

`Promise`<[`Message`](/docs/api/namespaces/proto/classes/Message)\>

---

<a name="function-generatewamessagefromcontent-"></a>

> Source: [https://baileys.wiki/docs/api/functions/generateWAMessageFromContent](https://baileys.wiki/docs/api/functions/generateWAMessageFromContent)

> **generateWAMessageFromContent**(`jid`, `message`, `options`): [`WAMessage`](/docs/api/type-aliases/WAMessage)

Defined in: [src/Utils/messages.ts:667](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L667)

## Parameters[​](#parameters "Direct link to Parameters")

### jid[​](#jid "Direct link to jid")

`string`

### message[​](#message "Direct link to message")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

### options[​](#options "Direct link to options")

[`MessageGenerationOptionsFromContent`](/docs/api/type-aliases/MessageGenerationOptionsFromContent)

## Returns[​](#returns "Direct link to Returns")

[`WAMessage`](/docs/api/type-aliases/WAMessage)

---

<a name="function-getaggregateresponsesineventmessage-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getAggregateResponsesInEventMessage](https://baileys.wiki/docs/api/functions/getAggregateResponsesInEventMessage)

> **getAggregateResponsesInEventMessage**(`msg`, `meId`?): `ResponseAggregation`\[\]

Defined in: [src/Utils/messages.ts:977](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L977)

Aggregates all event responses in an event message.

## Parameters[​](#parameters "Direct link to Parameters")

### msg[​](#msg "Direct link to msg")

`Pick`<[`WAMessage`](/docs/api/type-aliases/WAMessage), `"eventResponses"`\>

the event creation message

### meId?[​](#meid "Direct link to meId?")

`string`

your jid

## Returns[​](#returns "Direct link to Returns")

`ResponseAggregation`\[\]

A list of response types & their responders

---

<a name="function-getaggregatevotesinpollmessage-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getAggregateVotesInPollMessage](https://baileys.wiki/docs/api/functions/getAggregateVotesInPollMessage)

> **getAggregateVotesInPollMessage**(`msg`, `meId`?): `VoteAggregation`\[\]

Defined in: [src/Utils/messages.ts:921](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L921)

Aggregates all poll updates in a poll.

## Parameters[​](#parameters "Direct link to Parameters")

### msg[​](#msg "Direct link to msg")

`Pick`<[`WAMessage`](/docs/api/type-aliases/WAMessage), `"message"` | `"pollUpdates"`\>

the poll creation message

### meId?[​](#meid "Direct link to meId?")

`string`

your jid

## Returns[​](#returns "Direct link to Returns")

`VoteAggregation`\[\]

A list of options & their voters

---

<a name="function-getallbinarynodechildren-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getAllBinaryNodeChildren](https://baileys.wiki/docs/api/functions/getAllBinaryNodeChildren)

> **getAllBinaryNodeChildren**(`__namedParameters`): [`BinaryNode`](/docs/api/type-aliases/BinaryNode)\[\]

Defined in: [src/WABinary/generic-utils.ts:35](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/generic-utils.ts#L35)

## Parameters[​](#parameters "Direct link to Parameters")

### \_\_namedParameters[​](#__namedparameters "Direct link to __namedParameters")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

## Returns[​](#returns "Direct link to Returns")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)\[\]

---

<a name="function-getaudioduration-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getAudioDuration](https://baileys.wiki/docs/api/functions/getAudioDuration)

> **getAudioDuration**(`buffer`): `Promise`<`undefined` | `number`\>

Defined in: [src/Utils/messages-media.ts:224](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L224)

## Parameters[​](#parameters "Direct link to Parameters")

### buffer[​](#buffer "Direct link to buffer")

`string` | `Buffer`<`ArrayBufferLike`\> | `Readable`

## Returns[​](#returns "Direct link to Returns")

`Promise`<`undefined` | `number`\>

---

<a name="function-getaudiowaveform-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getAudioWaveform](https://baileys.wiki/docs/api/functions/getAudioWaveform)

> **getAudioWaveform**(`buffer`, `logger`?): `Promise`<`undefined` | `Uint8Array`<`ArrayBuffer`\>>

Defined in: [src/Utils/messages-media.ts:244](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L244)

referenced from and modifying [https://github.com/wppconnect-team/wa-js/blob/main/src/chat/functions/prepareAudioWaveform.ts](https://github.com/wppconnect-team/wa-js/blob/main/src/chat/functions/prepareAudioWaveform.ts)

## Parameters[​](#parameters "Direct link to Parameters")

### buffer[​](#buffer "Direct link to buffer")

`string` | `Buffer`<`ArrayBufferLike`\> | `Readable`

### logger?[​](#logger "Direct link to logger?")

`ILogger`

## Returns[​](#returns "Direct link to Returns")

`Promise`<`undefined` | `Uint8Array`<`ArrayBuffer`\>>

---

<a name="function-getbinarynodechild-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getBinaryNodeChild](https://baileys.wiki/docs/api/functions/getBinaryNodeChild)

> **getBinaryNodeChild**(`node`, `childTag`): `undefined` | [`BinaryNode`](/docs/api/type-aliases/BinaryNode)

Defined in: [src/WABinary/generic-utils.ts:31](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/generic-utils.ts#L31)

## Parameters[​](#parameters "Direct link to Parameters")

### node[​](#node "Direct link to node")

`undefined` | [`BinaryNode`](/docs/api/type-aliases/BinaryNode)

### childTag[​](#childtag "Direct link to childTag")

`string`

## Returns[​](#returns "Direct link to Returns")

`undefined` | [`BinaryNode`](/docs/api/type-aliases/BinaryNode)

---

<a name="function-getbinarynodechildbuffer-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getBinaryNodeChildBuffer](https://baileys.wiki/docs/api/functions/getBinaryNodeChildBuffer)

> **getBinaryNodeChildBuffer**(`node`, `childTag`): `undefined` | `Uint8Array`<`ArrayBufferLike`\> | `Buffer`<`ArrayBufferLike`\>

Defined in: [src/WABinary/generic-utils.ts:43](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/generic-utils.ts#L43)

## Parameters[​](#parameters "Direct link to Parameters")

### node[​](#node "Direct link to node")

`undefined` | [`BinaryNode`](/docs/api/type-aliases/BinaryNode)

### childTag[​](#childtag "Direct link to childTag")

`string`

## Returns[​](#returns "Direct link to Returns")

`undefined` | `Uint8Array`<`ArrayBufferLike`\> | `Buffer`<`ArrayBufferLike`\>

---

<a name="function-getbinarynodechildstring-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getBinaryNodeChildString](https://baileys.wiki/docs/api/functions/getBinaryNodeChildString)

> **getBinaryNodeChildString**(`node`, `childTag`): `undefined` | `string`

Defined in: [src/WABinary/generic-utils.ts:50](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/generic-utils.ts#L50)

## Parameters[​](#parameters "Direct link to Parameters")

### node[​](#node "Direct link to node")

`undefined` | [`BinaryNode`](/docs/api/type-aliases/BinaryNode)

### childTag[​](#childtag "Direct link to childTag")

`string`

## Returns[​](#returns "Direct link to Returns")

`undefined` | `string`

---

<a name="function-getbinarynodechilduint-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getBinaryNodeChildUInt](https://baileys.wiki/docs/api/functions/getBinaryNodeChildUInt)

> **getBinaryNodeChildUInt**(`node`, `childTag`, `length`): `undefined` | `number`

Defined in: [src/WABinary/generic-utils.ts:59](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/generic-utils.ts#L59)

## Parameters[​](#parameters "Direct link to Parameters")

### node[​](#node "Direct link to node")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

### childTag[​](#childtag "Direct link to childTag")

`string`

### length[​](#length "Direct link to length")

`number`

## Returns[​](#returns "Direct link to Returns")

`undefined` | `number`

---

<a name="function-getbinarynodechildren-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getBinaryNodeChildren](https://baileys.wiki/docs/api/functions/getBinaryNodeChildren)

> **getBinaryNodeChildren**(`node`, `childTag`): [`BinaryNode`](/docs/api/type-aliases/BinaryNode)\[\]

Defined in: [src/WABinary/generic-utils.ts:9](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/generic-utils.ts#L9)

## Parameters[​](#parameters "Direct link to Parameters")

### node[​](#node "Direct link to node")

`undefined` | [`BinaryNode`](/docs/api/type-aliases/BinaryNode)

### childTag[​](#childtag "Direct link to childTag")

`string`

## Returns[​](#returns "Direct link to Returns")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)\[\]

---

<a name="function-getbinarynodemessages-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getBinaryNodeMessages](https://baileys.wiki/docs/api/functions/getBinaryNodeMessages)

> **getBinaryNodeMessages**(`__namedParameters`): [`WebMessageInfo`](/docs/api/namespaces/proto/classes/WebMessageInfo)\[\]

Defined in: [src/WABinary/generic-utils.ts:90](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/generic-utils.ts#L90)

## Parameters[​](#parameters "Direct link to Parameters")

### \_\_namedParameters[​](#__namedparameters "Direct link to __namedParameters")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

## Returns[​](#returns "Direct link to Returns")

[`WebMessageInfo`](/docs/api/namespaces/proto/classes/WebMessageInfo)\[\]

---

<a name="function-getcallstatusfromnode-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getCallStatusFromNode](https://baileys.wiki/docs/api/functions/getCallStatusFromNode)

> **getCallStatusFromNode**(`__namedParameters`): [`WACallUpdateType`](/docs/api/type-aliases/WACallUpdateType)

Defined in: [src/Utils/generics.ts:378](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L378)

## Parameters[​](#parameters "Direct link to Parameters")

### \_\_namedParameters[​](#__namedparameters "Direct link to __namedParameters")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

## Returns[​](#returns "Direct link to Returns")

[`WACallUpdateType`](/docs/api/type-aliases/WACallUpdateType)

---

<a name="function-getchatid-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getChatId](https://baileys.wiki/docs/api/functions/getChatId)

> **getChatId**(`__namedParameters`): `string`

Defined in: [src/Utils/process-message.ts:131](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/process-message.ts#L131)

Get the ID of the chat from the given key. Typically -- that'll be the remoteJid, but for broadcasts, it'll be the participant

## Parameters[​](#parameters "Direct link to Parameters")

### \_\_namedParameters[​](#__namedparameters "Direct link to __namedParameters")

[`WAMessageKey`](/docs/api/type-aliases/WAMessageKey)

## Returns[​](#returns "Direct link to Returns")

`string`

---

<a name="function-getcodefromwserror-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getCodeFromWSError](https://baileys.wiki/docs/api/functions/getCodeFromWSError)

> **getCodeFromWSError**(`error`): `number`

Defined in: [src/Utils/generics.ts:410](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L410)

## Parameters[​](#parameters "Direct link to Parameters")

### error[​](#error "Direct link to error")

`Error`

## Returns[​](#returns "Direct link to Returns")

`number`

---

<a name="function-getcontenttype-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getContentType](https://baileys.wiki/docs/api/functions/getContentType)

> **getContentType**(`content`): `undefined` | keyof IMessage

Defined in: [src/Utils/messages.ts:759](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L759)

Get the key to access the true type of content

## Parameters[​](#parameters "Direct link to Parameters")

### content[​](#content "Direct link to content")

`undefined` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

## Returns[​](#returns "Direct link to Returns")

`undefined` | keyof IMessage

---

<a name="function-getdecryptionjid-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getDecryptionJid](https://baileys.wiki/docs/api/functions/getDecryptionJid)

> **getDecryptionJid**(`sender`, `repository`): `Promise`<`string`\>

Defined in: [src/Utils/decode-wa-message.ts:22](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/decode-wa-message.ts#L22)

## Parameters[​](#parameters "Direct link to Parameters")

### sender[​](#sender "Direct link to sender")

`string`

### repository[​](#repository "Direct link to repository")

[`SignalRepositoryWithLIDStore`](/docs/api/interfaces/SignalRepositoryWithLIDStore)

## Returns[​](#returns "Direct link to Returns")

`Promise`<`string`\>

---

<a name="function-getdevice-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getDevice](https://baileys.wiki/docs/api/functions/getDevice)

> **getDevice**(`id`): `"web"` | `"unknown"` | `"android"` | `"ios"` | `"desktop"`

Defined in: [src/Utils/messages.ts:853](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L853)

Returns the device predicted by message ID

## Parameters[​](#parameters "Direct link to Parameters")

### id[​](#id "Direct link to id")

`string`

## Returns[​](#returns "Direct link to Returns")

`"web"` | `"unknown"` | `"android"` | `"ios"` | `"desktop"`

---

<a name="function-geterrorcodefromstreamerror-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getErrorCodeFromStreamError](https://baileys.wiki/docs/api/functions/getErrorCodeFromStreamError)

> **getErrorCodeFromStreamError**(`node`): `object`

Defined in: [src/Utils/generics.ts:363](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L363)

Stream errors generally provide a reason, map that to a baileys DisconnectReason

## Parameters[​](#parameters "Direct link to Parameters")

### node[​](#node "Direct link to node")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

## Returns[​](#returns "Direct link to Returns")

`object`

### reason[​](#reason "Direct link to reason")

> **reason**: `string`

### statusCode[​](#statuscode "Direct link to statusCode")

> **statusCode**: `number`

---

<a name="function-gethistorymsg-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getHistoryMsg](https://baileys.wiki/docs/api/functions/getHistoryMsg)

> **getHistoryMsg**(`message`): [`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification)

Defined in: [src/Utils/history.ts:156](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/history.ts#L156)

## Parameters[​](#parameters "Direct link to Parameters")

### message[​](#message "Direct link to message")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

## Returns[​](#returns "Direct link to Returns")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification)

---

<a name="function-gethttpstream-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getHttpStream](https://baileys.wiki/docs/api/functions/getHttpStream)

> **getHttpStream**(`url`, `options`): `Promise`<`Readable`\>

Defined in: [src/Utils/messages-media.ts:365](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L365)

## Parameters[​](#parameters "Direct link to Parameters")

### url[​](#url "Direct link to url")

`string` | `URL`

### options[​](#options "Direct link to options")

`RequestInit` & `object` = `{}`

## Returns[​](#returns "Direct link to Returns")

`Promise`<`Readable`\>

---

<a name="function-getkeyauthor-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getKeyAuthor](https://baileys.wiki/docs/api/functions/getKeyAuthor)

> **getKeyAuthor**(`key`, `meId`): `string`

Defined in: [src/Utils/generics.ts:47](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L47)

## Parameters[​](#parameters "Direct link to Parameters")

### key[​](#key "Direct link to key")

`undefined` | `null` | [`WAMessageKey`](/docs/api/type-aliases/WAMessageKey)

### meId[​](#meid "Direct link to meId")

`string` = `'me'`

## Returns[​](#returns "Direct link to Returns")

`string`

---

<a name="function-getmediakeys-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getMediaKeys](https://baileys.wiki/docs/api/functions/getMediaKeys)

> **getMediaKeys**(`buffer`, `mediaType`): `Promise`<[`MediaDecryptionKeyInfo`](/docs/api/type-aliases/MediaDecryptionKeyInfo)\>

Defined in: [src/Utils/messages-media.ts:96](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L96)

generates all the keys required to encrypt/decrypt & sign a media message

## Parameters[​](#parameters "Direct link to Parameters")

### buffer[​](#buffer "Direct link to buffer")

`undefined` | `null` | `string` | `Uint8Array`<`ArrayBufferLike`\>

### mediaType[​](#mediatype "Direct link to mediaType")

`"ppic"` | `"product"` | `"image"` | `"video"` | `"sticker"` | `"thumbnail-document"` | `"audio"` | `"thumbnail-image"` | `"biz-cover-photo"` | `"thumbnail-video"` | `"thumbnail-link"` | `"gif"` | `"md-app-state"` | `"md-msg-hist"` | `"document"` | `"ptt"` | `"product-catalog-image"` | `"payment-bg-image"` | `"ptv"`

## Returns[​](#returns "Direct link to Returns")

`Promise`<[`MediaDecryptionKeyInfo`](/docs/api/type-aliases/MediaDecryptionKeyInfo)\>

---

<a name="function-getnextprekeys-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getNextPreKeys](https://baileys.wiki/docs/api/functions/getNextPreKeys)

> **getNextPreKeys**(`__namedParameters`, `count`): `Promise`<{ `preKeys`: {}; `update`: `Partial`<[`AuthenticationCreds`](/docs/api/type-aliases/AuthenticationCreds)\>; }>

Defined in: [src/Utils/signal.ts:178](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/signal.ts#L178)

get the next N keys for upload or processing

## Parameters[​](#parameters "Direct link to Parameters")

### \_\_namedParameters[​](#__namedparameters "Direct link to __namedParameters")

[`AuthenticationState`](/docs/api/type-aliases/AuthenticationState)

### count[​](#count "Direct link to count")

`number`

number of pre-keys to get or generate

## Returns[​](#returns "Direct link to Returns")

`Promise`<{ `preKeys`: {}; `update`: `Partial`<[`AuthenticationCreds`](/docs/api/type-aliases/AuthenticationCreds)\>; }>

---

<a name="function-getnextprekeysnode-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getNextPreKeysNode](https://baileys.wiki/docs/api/functions/getNextPreKeysNode)

> **getNextPreKeysNode**(`state`, `count`): `Promise`<{ `node`: [`BinaryNode`](/docs/api/type-aliases/BinaryNode); `update`: `Partial`<[`AuthenticationCreds`](/docs/api/type-aliases/AuthenticationCreds)\>; }>

Defined in: [src/Utils/signal.ts:193](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/signal.ts#L193)

## Parameters[​](#parameters "Direct link to Parameters")

### state[​](#state "Direct link to state")

[`AuthenticationState`](/docs/api/type-aliases/AuthenticationState)

### count[​](#count "Direct link to count")

`number`

## Returns[​](#returns "Direct link to Returns")

`Promise`<{ `node`: [`BinaryNode`](/docs/api/type-aliases/BinaryNode); `update`: `Partial`<[`AuthenticationCreds`](/docs/api/type-aliases/AuthenticationCreds)\>; }>

---

<a name="function-getplatformid-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getPlatformId](https://baileys.wiki/docs/api/functions/getPlatformId)

> **getPlatformId**(`browser`): `string`

Defined in: [src/Utils/browser-utils.ts:28](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/browser-utils.ts#L28)

## Parameters[​](#parameters "Direct link to Parameters")

### browser[​](#browser "Direct link to browser")

`string`

## Returns[​](#returns "Direct link to Returns")

`string`

---

<a name="function-getprekeys-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getPreKeys](https://baileys.wiki/docs/api/functions/getPreKeys)

> **getPreKeys**(`__namedParameters`, `min`, `limit`): `Promise`<{}>

Defined in: [src/Utils/signal.ts:44](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/signal.ts#L44)

## Parameters[​](#parameters "Direct link to Parameters")

### \_\_namedParameters[​](#__namedparameters "Direct link to __namedParameters")

[`SignalKeyStore`](/docs/api/type-aliases/SignalKeyStore)

### min[​](#min "Direct link to min")

`number`

### limit[​](#limit "Direct link to limit")

`number`

## Returns[​](#returns "Direct link to Returns")

`Promise`<{}>

---

<a name="function-getrawmediauploaddata-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getRawMediaUploadData](https://baileys.wiki/docs/api/functions/getRawMediaUploadData)

> **getRawMediaUploadData**(`media`, `mediaType`, `logger`?): `Promise`<{ `fileLength`: `number`; `filePath`: `string`; `fileSha256`: `Buffer`<`ArrayBufferLike`\>; }>

Defined in: [src/Utils/messages-media.ts:54](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L54)

## Parameters[​](#parameters "Direct link to Parameters")

### media[​](#media "Direct link to media")

[`WAMediaUpload`](/docs/api/type-aliases/WAMediaUpload)

### mediaType[​](#mediatype "Direct link to mediaType")

`"ppic"` | `"product"` | `"image"` | `"video"` | `"sticker"` | `"thumbnail-document"` | `"audio"` | `"thumbnail-image"` | `"biz-cover-photo"` | `"thumbnail-video"` | `"thumbnail-link"` | `"gif"` | `"md-app-state"` | `"md-msg-hist"` | `"document"` | `"ptt"` | `"product-catalog-image"` | `"payment-bg-image"` | `"ptv"`

### logger?[​](#logger "Direct link to logger?")

`ILogger`

## Returns[​](#returns "Direct link to Returns")

`Promise`<{ `fileLength`: `number`; `filePath`: `string`; `fileSha256`: `Buffer`<`ArrayBufferLike`\>; }>

---

<a name="function-getserverfromdomaintype-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getServerFromDomainType](https://baileys.wiki/docs/api/functions/getServerFromDomainType)

> **getServerFromDomainType**(`initialServer`, `domainType`?): [`JidServer`](/docs/api/type-aliases/JidServer)

Defined in: [src/WABinary/jid-utils.ts:37](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L37)

## Parameters[​](#parameters "Direct link to Parameters")

### initialServer[​](#initialserver "Direct link to initialServer")

`string`

### domainType?[​](#domaintype "Direct link to domainType?")

[`WAJIDDomains`](/docs/api/enumerations/WAJIDDomains)

## Returns[​](#returns "Direct link to Returns")

[`JidServer`](/docs/api/type-aliases/JidServer)

---

<a name="function-getstatuscodeformediaretry-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getStatusCodeForMediaRetry](https://baileys.wiki/docs/api/functions/getStatusCodeForMediaRetry)

> **getStatusCodeForMediaRetry**(`code`): `200` | `404` | `412` | `418`

Defined in: [src/Utils/messages-media.ts:976](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L976)

## Parameters[​](#parameters "Direct link to Parameters")

### code[​](#code "Direct link to code")

`number`

## Returns[​](#returns "Direct link to Returns")

`200` | `404` | `412` | `418`

---

<a name="function-getstatusfromreceipttype-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getStatusFromReceiptType](https://baileys.wiki/docs/api/functions/getStatusFromReceiptType)

> **getStatusFromReceiptType**(`type`): `undefined` | [`Status`](/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/Status)

Defined in: [src/Utils/generics.ts:346](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L346)

Given a type of receipt, returns what the new status of the message should be

## Parameters[​](#parameters "Direct link to Parameters")

### type[​](#type "Direct link to type")

type from receipt

`undefined` | `string`

## Returns[​](#returns "Direct link to Returns")

`undefined` | [`Status`](/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/Status)

---

<a name="function-getstream-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getStream](https://baileys.wiki/docs/api/functions/getStream)

> **getStream**(`item`, `opts`?): `Promise`<{ `stream`: `Readable`; `type`: `"buffer"`; } | { `stream`: `Readable`; `type`: `"readable"`; } | { `stream`: `Readable`; `type`: `"remote"`; } | { `stream`: `ReadStream`; `type`: `"file"`; }>

Defined in: [src/Utils/messages-media.ts:304](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L304)

## Parameters[​](#parameters "Direct link to Parameters")

### item[​](#item "Direct link to item")

[`WAMediaUpload`](/docs/api/type-aliases/WAMediaUpload)

### opts?[​](#opts "Direct link to opts?")

`RequestInit` & `object`

## Returns[​](#returns "Direct link to Returns")

`Promise`<{ `stream`: `Readable`; `type`: `"buffer"`; } | { `stream`: `Readable`; `type`: `"readable"`; } | { `stream`: `Readable`; `type`: `"remote"`; } | { `stream`: `ReadStream`; `type`: `"file"`; }>

---

<a name="function-geturlfromdirectpath-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getUrlFromDirectPath](https://baileys.wiki/docs/api/functions/getUrlFromDirectPath)

> **getUrlFromDirectPath**(`directPath`): `string`

Defined in: [src/Utils/messages-media.ts:516](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L516)

## Parameters[​](#parameters "Direct link to Parameters")

### directPath[​](#directpath "Direct link to directPath")

`string`

## Returns[​](#returns "Direct link to Returns")

`string`

---

<a name="function-geturlinfo-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getUrlInfo](https://baileys.wiki/docs/api/functions/getUrlInfo)

> **getUrlInfo**(`text`, `opts`): `Promise`<`undefined` | [`WAUrlInfo`](/docs/api/interfaces/WAUrlInfo)\>

Defined in: [src/Utils/link-preview.ts:33](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/link-preview.ts#L33)

Given a piece of text, checks for any URL present, generates link preview for the same and returns it Return undefined if the fetch failed or no URL was found

## Parameters[​](#parameters "Direct link to Parameters")

### text[​](#text "Direct link to text")

`string`

first matched URL in text

### opts[​](#opts "Direct link to opts")

[`URLGenerationOptions`](/docs/api/type-aliases/URLGenerationOptions) = `...`

## Returns[​](#returns "Direct link to Returns")

`Promise`<`undefined` | [`WAUrlInfo`](/docs/api/interfaces/WAUrlInfo)\>

the URL info required to generate link preview

---

<a name="function-getwauploadtoserver-"></a>

> Source: [https://baileys.wiki/docs/api/functions/getWAUploadToServer](https://baileys.wiki/docs/api/functions/getWAUploadToServer)

> **getWAUploadToServer**(`__namedParameters`, `refreshMediaConn`): [`WAMediaUploadFunction`](/docs/api/type-aliases/WAMediaUploadFunction)

Defined in: [src/Utils/messages-media.ts:809](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L809)

## Parameters[​](#parameters "Direct link to Parameters")

### \_\_namedParameters[​](#__namedparameters "Direct link to __namedParameters")

[`SocketConfig`](/docs/api/type-aliases/SocketConfig)

### refreshMediaConn[​](#refreshmediaconn "Direct link to refreshMediaConn")

(`force`) => `Promise`<[`MediaConnInfo`](/docs/api/type-aliases/MediaConnInfo)\>

## Returns[​](#returns "Direct link to Returns")

[`WAMediaUploadFunction`](/docs/api/type-aliases/WAMediaUploadFunction)

---

<a name="function-handleidentitychange-"></a>

> Source: [https://baileys.wiki/docs/api/functions/handleIdentityChange](https://baileys.wiki/docs/api/functions/handleIdentityChange)

> **handleIdentityChange**(`node`, `ctx`): `Promise`<[`IdentityChangeResult`](/docs/api/type-aliases/IdentityChangeResult)\>

Defined in: [src/Utils/identity-change-handler.ts:26](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/identity-change-handler.ts#L26)

## Parameters[​](#parameters "Direct link to Parameters")

### node[​](#node "Direct link to node")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

### ctx[​](#ctx "Direct link to ctx")

[`IdentityChangeContext`](/docs/api/type-aliases/IdentityChangeContext)

## Returns[​](#returns "Direct link to Returns")

`Promise`<[`IdentityChangeResult`](/docs/api/type-aliases/IdentityChangeResult)\>

---

<a name="function-hasnonnullishproperty-"></a>

> Source: [https://baileys.wiki/docs/api/functions/hasNonNullishProperty](https://baileys.wiki/docs/api/functions/hasNonNullishProperty)

> **hasNonNullishProperty**<`K`\>(`message`, `key`): message is ExtractByKey<SharePhoneNumber & ViewOnce, K> | ExtractByKey<RequestPhoneNumber & ViewOnce, K> | ExtractByKey<{ caption?: string; image: WAMediaUpload; jpegThumbnail?: string } & Mentionable & Contextable & WithDimensions & { mimetype?: string } & Editable & ViewOnce, K> | ExtractByKey<{ caption?: string; gifPlayback?: boolean; jpegThumbnail?: string; ptv?: boolean; video: WAMediaUpload } & Mentionable & Contextable & WithDimensions & { mimetype?: string } & Editable & ViewOnce, K> | ExtractByKey<{ audio: WAMediaUpload; ptt?: boolean; seconds?: number } & { mimetype?: string } & Editable & ViewOnce, K> | ExtractByKey<{ isAnimated?: boolean; sticker: WAMediaUpload } & WithDimensions & { mimetype?: string } & Editable & ViewOnce, K> | ExtractByKey<{ caption?: string; document: WAMediaUpload; fileName?: string; mimetype: string } & Contextable & { mimetype?: string } & Editable & ViewOnce, K> | ExtractByKey<{ linkPreview?: null | WAUrlInfo; text: string } & Mentionable & Contextable & Editable & ViewOnce, K> | ExtractByKey<{ event: EventMessageOptions } & ViewOnce, K> | ExtractByKey<{ poll: PollMessageOptions } & Mentionable & Contextable & Editable & ViewOnce, K> | ExtractByKey<{ contacts: { contacts: IContactMessage\[\]; displayName?: string } } & ViewOnce, K> | ExtractByKey<{ location: ILocationMessage } & ViewOnce, K> | ExtractByKey<{ react: IReactionMessage } & ViewOnce, K> | ExtractByKey<{ buttonReply: ButtonReplyInfo; type: "template" | "plain" } & ViewOnce, K> | ExtractByKey<{ groupInvite: GroupInviteInfo } & ViewOnce, K> | ExtractByKey<{ listReply: Omit<IListResponseMessage, "contextInfo"> } & ViewOnce, K> | ExtractByKey<{ pin: WAMessageKey; time?: 86400 | 604800 | 2592000; type: Type } & ViewOnce, K> | ExtractByKey<{ body?: string; businessOwnerJid?: string; footer?: string; product: WASendableProduct } & ViewOnce, K> | ExtractByKey<{ force?: boolean; forward: WAMessage }, K> | ExtractByKey<{ delete: WAMessageKey }, K> | ExtractByKey<{ disappearingMessagesInChat: number | boolean }, K> | ExtractByKey<{ limitSharing: boolean }, K>

Defined in: [src/Utils/messages.ts:378](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L378)

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

• **K** _extends_ `PropertyKey`

## Parameters[​](#parameters "Direct link to Parameters")

### message[​](#message "Direct link to message")

[`AnyMessageContent`](/docs/api/type-aliases/AnyMessageContent)

### key[​](#key "Direct link to key")

`K`

## Returns[​](#returns "Direct link to Returns")

message is ExtractByKey<SharePhoneNumber & ViewOnce, K> | ExtractByKey<RequestPhoneNumber & ViewOnce, K> | ExtractByKey<{ caption?: string; image: WAMediaUpload; jpegThumbnail?: string } & Mentionable & Contextable & WithDimensions & { mimetype?: string } & Editable & ViewOnce, K> | ExtractByKey<{ caption?: string; gifPlayback?: boolean; jpegThumbnail?: string; ptv?: boolean; video: WAMediaUpload } & Mentionable & Contextable & WithDimensions & { mimetype?: string } & Editable & ViewOnce, K> | ExtractByKey<{ audio: WAMediaUpload; ptt?: boolean; seconds?: number } & { mimetype?: string } & Editable & ViewOnce, K> | ExtractByKey<{ isAnimated?: boolean; sticker: WAMediaUpload } & WithDimensions & { mimetype?: string } & Editable & ViewOnce, K> | ExtractByKey<{ caption?: string; document: WAMediaUpload; fileName?: string; mimetype: string } & Contextable & { mimetype?: string } & Editable & ViewOnce, K> | ExtractByKey<{ linkPreview?: null | WAUrlInfo; text: string } & Mentionable & Contextable & Editable & ViewOnce, K> | ExtractByKey<{ event: EventMessageOptions } & ViewOnce, K> | ExtractByKey<{ poll: PollMessageOptions } & Mentionable & Contextable & Editable & ViewOnce, K> | ExtractByKey<{ contacts: { contacts: IContactMessage\[\]; displayName?: string } } & ViewOnce, K> | ExtractByKey<{ location: ILocationMessage } & ViewOnce, K> | ExtractByKey<{ react: IReactionMessage } & ViewOnce, K> | ExtractByKey<{ buttonReply: ButtonReplyInfo; type: "template" | "plain" } & ViewOnce, K> | ExtractByKey<{ groupInvite: GroupInviteInfo } & ViewOnce, K> | ExtractByKey<{ listReply: Omit<IListResponseMessage, "contextInfo"> } & ViewOnce, K> | ExtractByKey<{ pin: WAMessageKey; time?: 86400 | 604800 | 2592000; type: Type } & ViewOnce, K> | ExtractByKey<{ body?: string; businessOwnerJid?: string; footer?: string; product: WASendableProduct } & ViewOnce, K> | ExtractByKey<{ force?: boolean; forward: WAMessage }, K> | ExtractByKey<{ delete: WAMessageKey }, K> | ExtractByKey<{ disappearingMessagesInChat: number | boolean }, K> | ExtractByKey<{ limitSharing: boolean }, K>

---

<a name="function-hkdfinfokey-"></a>

> Source: [https://baileys.wiki/docs/api/functions/hkdfInfoKey](https://baileys.wiki/docs/api/functions/hkdfInfoKey)

> **hkdfInfoKey**(`type`): `string`

Defined in: [src/Utils/messages-media.ts:49](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L49)

## Parameters[​](#parameters "Direct link to Parameters")

### type[​](#type "Direct link to type")

`"ppic"` | `"product"` | `"image"` | `"video"` | `"sticker"` | `"thumbnail-document"` | `"audio"` | `"thumbnail-image"` | `"biz-cover-photo"` | `"thumbnail-video"` | `"thumbnail-link"` | `"gif"` | `"md-app-state"` | `"md-msg-hist"` | `"document"` | `"ptt"` | `"product-catalog-image"` | `"payment-bg-image"` | `"ptv"`

## Returns[​](#returns "Direct link to Returns")

`string`

---

<a name="function-hmacsign-"></a>

> Source: [https://baileys.wiki/docs/api/functions/hmacSign](https://baileys.wiki/docs/api/functions/hmacSign)

> **hmacSign**(`buffer`, `key`, `variant`): `Buffer`<`ArrayBufferLike`\>

Defined in: [src/Utils/crypto.ts:110](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/crypto.ts#L110)

## Parameters[​](#parameters "Direct link to Parameters")

### buffer[​](#buffer "Direct link to buffer")

`Uint8Array`<`ArrayBufferLike`\> | `Buffer`<`ArrayBufferLike`\>

### key[​](#key "Direct link to key")

`Uint8Array`<`ArrayBufferLike`\> | `Buffer`<`ArrayBufferLike`\>

### variant[​](#variant "Direct link to variant")

`"sha256"` | `"sha512"`

## Returns[​](#returns "Direct link to Returns")

`Buffer`<`ArrayBufferLike`\>

---

<a name="function-initauthcreds-"></a>

> Source: [https://baileys.wiki/docs/api/functions/initAuthCreds](https://baileys.wiki/docs/api/functions/initAuthCreds)

> **initAuthCreds**(): [`AuthenticationCreds`](/docs/api/type-aliases/AuthenticationCreds)

Defined in: [src/Utils/auth-utils.ts:346](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/auth-utils.ts#L346)

## Returns[​](#returns "Direct link to Returns")

[`AuthenticationCreds`](/docs/api/type-aliases/AuthenticationCreds)

---

<a name="function-ishostedliduser-"></a>

> Source: [https://baileys.wiki/docs/api/functions/isHostedLidUser](https://baileys.wiki/docs/api/functions/isHostedLidUser)

> **isHostedLidUser**(`jid`): `undefined` | `boolean`

Defined in: [src/WABinary/jid-utils.ts:107](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L107)

is the jid a hosted LID

## Parameters[​](#parameters "Direct link to Parameters")

### jid[​](#jid "Direct link to jid")

`undefined` | `string`

## Returns[​](#returns "Direct link to Returns")

`undefined` | `boolean`

---

<a name="function-ishostedpnuser-"></a>

> Source: [https://baileys.wiki/docs/api/functions/isHostedPnUser](https://baileys.wiki/docs/api/functions/isHostedPnUser)

> **isHostedPnUser**(`jid`): `undefined` | `boolean`

Defined in: [src/WABinary/jid-utils.ts:105](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L105)

is the jid a hosted PN

## Parameters[​](#parameters "Direct link to Parameters")

### jid[​](#jid "Direct link to jid")

`undefined` | `string`

## Returns[​](#returns "Direct link to Returns")

`undefined` | `boolean`

---

<a name="function-isjidbot-"></a>

> Source: [https://baileys.wiki/docs/api/functions/isJidBot](https://baileys.wiki/docs/api/functions/isJidBot)

> **isJidBot**(`jid`): `undefined` | `boolean` | `""`

Defined in: [src/WABinary/jid-utils.ts:111](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L111)

## Parameters[​](#parameters "Direct link to Parameters")

### jid[​](#jid "Direct link to jid")

`undefined` | `string`

## Returns[​](#returns "Direct link to Returns")

`undefined` | `boolean` | `""`

---

<a name="function-isjidbroadcast-"></a>

> Source: [https://baileys.wiki/docs/api/functions/isJidBroadcast](https://baileys.wiki/docs/api/functions/isJidBroadcast)

> **isJidBroadcast**(`jid`): `undefined` | `boolean`

Defined in: [src/WABinary/jid-utils.ts:97](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L97)

is the jid a broadcast

## Parameters[​](#parameters "Direct link to Parameters")

### jid[​](#jid "Direct link to jid")

`undefined` | `string`

## Returns[​](#returns "Direct link to Returns")

`undefined` | `boolean`

---

<a name="function-isjidgroup-"></a>

> Source: [https://baileys.wiki/docs/api/functions/isJidGroup](https://baileys.wiki/docs/api/functions/isJidGroup)

> **isJidGroup**(`jid`): `undefined` | `boolean`

Defined in: [src/WABinary/jid-utils.ts:99](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L99)

is the jid a group

## Parameters[​](#parameters "Direct link to Parameters")

### jid[​](#jid "Direct link to jid")

`undefined` | `string`

## Returns[​](#returns "Direct link to Returns")

`undefined` | `boolean`

---

<a name="function-isjidmetaai-"></a>

> Source: [https://baileys.wiki/docs/api/functions/isJidMetaAI](https://baileys.wiki/docs/api/functions/isJidMetaAI)

> **isJidMetaAI**(`jid`): `undefined` | `boolean`

Defined in: [src/WABinary/jid-utils.ts:91](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L91)

is the jid Meta AI

## Parameters[​](#parameters "Direct link to Parameters")

### jid[​](#jid "Direct link to jid")

`undefined` | `string`

## Returns[​](#returns "Direct link to Returns")

`undefined` | `boolean`

---

<a name="function-isjidnewsletter-"></a>

> Source: [https://baileys.wiki/docs/api/functions/isJidNewsletter](https://baileys.wiki/docs/api/functions/isJidNewsletter)

> **isJidNewsletter**(`jid`): `undefined` | `boolean`

Defined in: [src/WABinary/jid-utils.ts:103](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L103)

is the jid a newsletter

## Parameters[​](#parameters "Direct link to Parameters")

### jid[​](#jid "Direct link to jid")

`undefined` | `string`

## Returns[​](#returns "Direct link to Returns")

`undefined` | `boolean`

---

<a name="function-isjidstatusbroadcast-"></a>

> Source: [https://baileys.wiki/docs/api/functions/isJidStatusBroadcast](https://baileys.wiki/docs/api/functions/isJidStatusBroadcast)

> **isJidStatusBroadcast**(`jid`): `jid is "status@broadcast"`

Defined in: [src/WABinary/jid-utils.ts:101](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L101)

is the jid the status broadcast

## Parameters[​](#parameters "Direct link to Parameters")

### jid[​](#jid "Direct link to jid")

`string`

## Returns[​](#returns "Direct link to Returns")

`jid is "status@broadcast"`

---

<a name="function-isliduser-"></a>

> Source: [https://baileys.wiki/docs/api/functions/isLidUser](https://baileys.wiki/docs/api/functions/isLidUser)

> **isLidUser**(`jid`): `undefined` | `boolean`

Defined in: [src/WABinary/jid-utils.ts:95](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L95)

is the jid a LID

## Parameters[​](#parameters "Direct link to Parameters")

### jid[​](#jid "Direct link to jid")

`undefined` | `string`

## Returns[​](#returns "Direct link to Returns")

`undefined` | `boolean`

---

<a name="function-ispnuser-"></a>

> Source: [https://baileys.wiki/docs/api/functions/isPnUser](https://baileys.wiki/docs/api/functions/isPnUser)

> **isPnUser**(`jid`): `undefined` | `boolean`

Defined in: [src/WABinary/jid-utils.ts:93](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L93)

is the jid a PN user

## Parameters[​](#parameters "Direct link to Parameters")

### jid[​](#jid "Direct link to jid")

`undefined` | `string`

## Returns[​](#returns "Direct link to Returns")

`undefined` | `boolean`

---

<a name="function-isrealmessage-"></a>

> Source: [https://baileys.wiki/docs/api/functions/isRealMessage](https://baileys.wiki/docs/api/functions/isRealMessage)

> **isRealMessage**(`message`): `boolean`

Defined in: [src/Utils/process-message.ts:111](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/process-message.ts#L111)

## Parameters[​](#parameters "Direct link to Parameters")

### message[​](#message "Direct link to message")

[`WAMessage`](/docs/api/type-aliases/WAMessage)

## Returns[​](#returns "Direct link to Returns")

`boolean`

---

<a name="function-isstringnullorempty-"></a>

> Source: [https://baileys.wiki/docs/api/functions/isStringNullOrEmpty](https://baileys.wiki/docs/api/functions/isStringNullOrEmpty)

> **isStringNullOrEmpty**(`value`): value is undefined | null | ""

Defined in: [src/Utils/generics.ts:50](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L50)

## Parameters[​](#parameters "Direct link to Parameters")

### value[​](#value "Direct link to value")

`undefined` | `null` | `string`

## Returns[​](#returns "Direct link to Returns")

value is undefined | null | ""

---

<a name="function-iswabusinessplatform-"></a>

> Source: [https://baileys.wiki/docs/api/functions/isWABusinessPlatform](https://baileys.wiki/docs/api/functions/isWABusinessPlatform)

> **isWABusinessPlatform**(`platform`): platform is "smba" | "smbi"

Defined in: [src/Utils/generics.ts:433](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L433)

Is the given platform WA business

## Parameters[​](#parameters "Direct link to Parameters")

### platform[​](#platform "Direct link to platform")

`string`

AuthenticationCreds.platform

## Returns[​](#returns "Direct link to Returns")

platform is "smba" | "smbi"

---

<a name="function-jiddecode-"></a>

> Source: [https://baileys.wiki/docs/api/functions/jidDecode](https://baileys.wiki/docs/api/functions/jidDecode)

> **jidDecode**(`jid`): `undefined` | [`FullJid`](/docs/api/type-aliases/FullJid)

Defined in: [src/WABinary/jid-utils.ts:55](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L55)

## Parameters[​](#parameters "Direct link to Parameters")

### jid[​](#jid "Direct link to jid")

`undefined` | `string`

## Returns[​](#returns "Direct link to Returns")

`undefined` | [`FullJid`](/docs/api/type-aliases/FullJid)

---

<a name="function-jidencode-"></a>

> Source: [https://baileys.wiki/docs/api/functions/jidEncode](https://baileys.wiki/docs/api/functions/jidEncode)

> **jidEncode**(`user`, `server`, `device`?, `agent`?): `string`

Defined in: [src/WABinary/jid-utils.ts:51](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L51)

## Parameters[​](#parameters "Direct link to Parameters")

### user[​](#user "Direct link to user")

`null` | `string` | `number`

### server[​](#server "Direct link to server")

[`JidServer`](/docs/api/type-aliases/JidServer)

### device?[​](#device "Direct link to device?")

`number`

### agent?[​](#agent "Direct link to agent?")

`number`

## Returns[​](#returns "Direct link to Returns")

`string`

---

<a name="function-jidnormalizeduser-"></a>

> Source: [https://baileys.wiki/docs/api/functions/jidNormalizedUser](https://baileys.wiki/docs/api/functions/jidNormalizedUser)

> **jidNormalizedUser**(`jid`): `string`

Defined in: [src/WABinary/jid-utils.ts:113](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L113)

## Parameters[​](#parameters "Direct link to Parameters")

### jid[​](#jid "Direct link to jid")

`undefined` | `string`

## Returns[​](#returns "Direct link to Returns")

`string`

---

<a name="function-makecacheablesignalkeystore-"></a>

> Source: [https://baileys.wiki/docs/api/functions/makeCacheableSignalKeyStore](https://baileys.wiki/docs/api/functions/makeCacheableSignalKeyStore)

> **makeCacheableSignalKeyStore**(`store`, `logger`?, `_cache`?): [`SignalKeyStore`](/docs/api/type-aliases/SignalKeyStore)

Defined in: [src/Utils/auth-utils.ts:36](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/auth-utils.ts#L36)

Adds caching capability to a SignalKeyStore

## Parameters[​](#parameters "Direct link to Parameters")

### store[​](#store "Direct link to store")

[`SignalKeyStore`](/docs/api/type-aliases/SignalKeyStore)

the store to add caching to

### logger?[​](#logger "Direct link to logger?")

`ILogger`

to log trace events

### \_cache?[​](#_cache "Direct link to _cache?")

[`CacheStore`](/docs/api/type-aliases/CacheStore)

cache store to use

## Returns[​](#returns "Direct link to Returns")

[`SignalKeyStore`](/docs/api/type-aliases/SignalKeyStore)

---

<a name="function-makeeventbuffer-"></a>

> Source: [https://baileys.wiki/docs/api/functions/makeEventBuffer](https://baileys.wiki/docs/api/functions/makeEventBuffer)

> **makeEventBuffer**(`logger`): `BaileysBufferableEventEmitter`

Defined in: [src/Utils/event-buffer.ts:70](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/event-buffer.ts#L70)

The event buffer logically consolidates different events into a single event making the data processing more efficient.

## Parameters[​](#parameters "Direct link to Parameters")

### logger[​](#logger "Direct link to logger")

`ILogger`

## Returns[​](#returns "Direct link to Returns")

`BaileysBufferableEventEmitter`

---

<a name="function-makenoisehandler-"></a>

> Source: [https://baileys.wiki/docs/api/functions/makeNoiseHandler](https://baileys.wiki/docs/api/functions/makeNoiseHandler)

> **makeNoiseHandler**(`__namedParameters`): `object`

Defined in: [src/Utils/noise-handler.ts:52](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/noise-handler.ts#L52)

## Parameters[​](#parameters "Direct link to Parameters")

### \_\_namedParameters[​](#__namedparameters "Direct link to __namedParameters")

#### keyPair[​](#keypair "Direct link to keyPair")

[`KeyPair`](/docs/api/type-aliases/KeyPair)

#### logger[​](#logger "Direct link to logger")

`ILogger`

#### NOISE\_HEADER[​](#noise_header "Direct link to NOISE_HEADER")

`Uint8Array`

#### routingInfo?[​](#routinginfo "Direct link to routingInfo?")

`Buffer`<`ArrayBufferLike`\>

## Returns[​](#returns "Direct link to Returns")

`object`

### authenticate()[​](#authenticate "Direct link to authenticate()")

> **authenticate**: (`data`) => `void`

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### data[​](#data "Direct link to data")

`Uint8Array`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

### decodeFrame()[​](#decodeframe "Direct link to decodeFrame()")

> **decodeFrame**: (`newData`, `onFrame`) => `Promise`<`void`\>

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### newData[​](#newdata "Direct link to newData")

`Uint8Array`<`ArrayBufferLike`\> | `Buffer`<`ArrayBufferLike`\>

##### onFrame[​](#onframe "Direct link to onFrame")

(`buff`) => `void`

#### Returns[​](#returns-2 "Direct link to Returns")

`Promise`<`void`\>

### decrypt()[​](#decrypt "Direct link to decrypt()")

> **decrypt**: (`ciphertext`) => `Uint8Array`

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### ciphertext[​](#ciphertext "Direct link to ciphertext")

`Uint8Array`

#### Returns[​](#returns-3 "Direct link to Returns")

`Uint8Array`

### encodeFrame()[​](#encodeframe "Direct link to encodeFrame()")

> **encodeFrame**: (`data`) => `Buffer`<`ArrayBuffer`\>

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### data[​](#data-1 "Direct link to data")

`Uint8Array`<`ArrayBufferLike`\> | `Buffer`<`ArrayBufferLike`\>

#### Returns[​](#returns-4 "Direct link to Returns")

`Buffer`<`ArrayBuffer`\>

### encrypt()[​](#encrypt "Direct link to encrypt()")

> **encrypt**: (`plaintext`) => `Uint8Array`

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### plaintext[​](#plaintext "Direct link to plaintext")

`Uint8Array`

#### Returns[​](#returns-5 "Direct link to Returns")

`Uint8Array`

### finishInit()[​](#finishinit "Direct link to finishInit()")

> **finishInit**: () => `Promise`<`void`\>

#### Returns[​](#returns-6 "Direct link to Returns")

`Promise`<`void`\>

### mixIntoKey()[​](#mixintokey "Direct link to mixIntoKey()")

> **mixIntoKey**: (`data`) => `void`

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### data[​](#data-2 "Direct link to data")

`Uint8Array`

#### Returns[​](#returns-7 "Direct link to Returns")

`void`

### processHandshake()[​](#processhandshake "Direct link to processHandshake()")

> **processHandshake**: (`__namedParameters`, `noiseKey`) => `Uint8Array`<`ArrayBufferLike`\>

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### \_\_namedParameters[​](#__namedparameters-1 "Direct link to __namedParameters")

[`HandshakeMessage`](/docs/api/namespaces/proto/classes/HandshakeMessage)

##### noiseKey[​](#noisekey "Direct link to noiseKey")

[`KeyPair`](/docs/api/type-aliases/KeyPair)

#### Returns[​](#returns-8 "Direct link to Returns")

`Uint8Array`<`ArrayBufferLike`\>

---

<a name="function-makewasocket-"></a>

> Source: [https://baileys.wiki/docs/api/functions/makeWASocket](https://baileys.wiki/docs/api/functions/makeWASocket)

> **makeWASocket**(`config`): `object`

Defined in: [src/Socket/index.ts:6](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Socket/index.ts#L6)

## Parameters[​](#parameters "Direct link to Parameters")

### config[​](#config "Direct link to config")

[`UserFacingSocketConfig`](/docs/api/type-aliases/UserFacingSocketConfig)

## Returns[​](#returns "Direct link to Returns")

`object`

### addChatLabel()[​](#addchatlabel "Direct link to addChatLabel()")

> **addChatLabel**: (`jid`, `labelId`) => `Promise`<`void`\>

Adds label for the chats

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### jid[​](#jid "Direct link to jid")

`string`

##### labelId[​](#labelid "Direct link to labelId")

`string`

#### Returns[​](#returns-1 "Direct link to Returns")

`Promise`<`void`\>

### addLabel()[​](#addlabel "Direct link to addLabel()")

> **addLabel**: (`jid`, `labels`) => `Promise`<`void`\>

Adds label

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### jid[​](#jid-1 "Direct link to jid")

`string`

##### labels[​](#labels "Direct link to labels")

`LabelActionBody`

#### Returns[​](#returns-2 "Direct link to Returns")

`Promise`<`void`\>

### addMessageLabel()[​](#addmessagelabel "Direct link to addMessageLabel()")

> **addMessageLabel**: (`jid`, `messageId`, `labelId`) => `Promise`<`void`\>

Adds label for the message

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### jid[​](#jid-2 "Direct link to jid")

`string`

##### messageId[​](#messageid "Direct link to messageId")

`string`

##### labelId[​](#labelid-1 "Direct link to labelId")

`string`

#### Returns[​](#returns-3 "Direct link to Returns")

`Promise`<`void`\>

### addOrEditContact()[​](#addoreditcontact "Direct link to addOrEditContact()")

> **addOrEditContact**: (`jid`, `contact`) => `Promise`<`void`\>

Add or Edit Contact

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### jid[​](#jid-3 "Direct link to jid")

`string`

##### contact[​](#contact "Direct link to contact")

[`IContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction)

#### Returns[​](#returns-4 "Direct link to Returns")

`Promise`<`void`\>

### addOrEditQuickReply()[​](#addoreditquickreply "Direct link to addOrEditQuickReply()")

> **addOrEditQuickReply**: (`quickReply`) => `Promise`<`void`\>

Add or Edit Quick Reply

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### quickReply[​](#quickreply "Direct link to quickReply")

`QuickReplyAction`

#### Returns[​](#returns-5 "Direct link to Returns")

`Promise`<`void`\>

### appPatch()[​](#apppatch "Direct link to appPatch()")

> **appPatch**: (`patchCreate`) => `Promise`<`void`\>

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### patchCreate[​](#patchcreate "Direct link to patchCreate")

[`WAPatchCreate`](/docs/api/type-aliases/WAPatchCreate)

#### Returns[​](#returns-6 "Direct link to Returns")

`Promise`<`void`\>

### appStatePatchMutex[​](#appstatepatchmutex "Direct link to appStatePatchMutex")

> **appStatePatchMutex**: `object`

#### appStatePatchMutex.mutex()[​](#appstatepatchmutexmutex "Direct link to appStatePatchMutex.mutex()")

##### Type Parameters[​](#type-parameters "Direct link to Type Parameters")

• **T**

##### Parameters[​](#parameters-7 "Direct link to Parameters")

###### code[​](#code "Direct link to code")

() => `T` | `Promise`<`T`\>

##### Returns[​](#returns-7 "Direct link to Returns")

`Promise`<`T`\>

### assertSessions()[​](#assertsessions "Direct link to assertSessions()")

> **assertSessions**: (`jids`, `force`?) => `Promise`<`boolean`\>

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### jids[​](#jids "Direct link to jids")

`string`\[\]

##### force?[​](#force "Direct link to force?")

`boolean`

#### Returns[​](#returns-8 "Direct link to Returns")

`Promise`<`boolean`\>

### authState[​](#authstate "Direct link to authState")

> **authState**: `object`

#### authState.creds[​](#authstatecreds "Direct link to authState.creds")

> **creds**: [`AuthenticationCreds`](/docs/api/type-aliases/AuthenticationCreds)

#### authState.keys[​](#authstatekeys "Direct link to authState.keys")

> **keys**: [`SignalKeyStoreWithTransaction`](/docs/api/type-aliases/SignalKeyStoreWithTransaction)

### chatModify()[​](#chatmodify "Direct link to chatModify()")

> **chatModify**: (`mod`, `jid`) => `Promise`<`void`\>

modify a chat -- mark unread, read etc. lastMessages must be sorted in reverse chronologically requires the last messages till the last message received; required for archive & unread

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### mod[​](#mod "Direct link to mod")

[`ChatModification`](/docs/api/type-aliases/ChatModification)

##### jid[​](#jid-4 "Direct link to jid")

`string`

#### Returns[​](#returns-9 "Direct link to Returns")

`Promise`<`void`\>

### cleanDirtyBits()[​](#cleandirtybits "Direct link to cleanDirtyBits()")

> **cleanDirtyBits**: (`type`, `fromTimestamp`?) => `Promise`<`void`\>

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### type[​](#type "Direct link to type")

`"account_sync"` | `"groups"`

##### fromTimestamp?[​](#fromtimestamp "Direct link to fromTimestamp?")

`string` | `number`

#### Returns[​](#returns-10 "Direct link to Returns")

`Promise`<`void`\>

### communityAcceptInvite()[​](#communityacceptinvite "Direct link to communityAcceptInvite()")

> **communityAcceptInvite**: (`code`) => `Promise`<`undefined` | `string`\>

#### Parameters[​](#parameters-11 "Direct link to Parameters")

##### code[​](#code-1 "Direct link to code")

`string`

#### Returns[​](#returns-11 "Direct link to Returns")

`Promise`<`undefined` | `string`\>

### communityAcceptInviteV4()[​](#communityacceptinvitev4 "Direct link to communityAcceptInviteV4()")

> **communityAcceptInviteV4**: (...`args`) => `Promise`<`any`\>

accept a CommunityInviteMessage

#### Parameters[​](#parameters-12 "Direct link to Parameters")

##### args[​](#args "Direct link to args")

...\[`string` | [`WAMessageKey`](/docs/api/type-aliases/WAMessageKey), [`IGroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage)\]

#### Returns[​](#returns-12 "Direct link to Returns")

`Promise`<`any`\>

### communityCreate()[​](#communitycreate "Direct link to communityCreate()")

> **communityCreate**: (`subject`, `body`) => `Promise`<`null` | [`GroupMetadata`](/docs/api/interfaces/GroupMetadata)\>

#### Parameters[​](#parameters-13 "Direct link to Parameters")

##### subject[​](#subject "Direct link to subject")

`string`

##### body[​](#body "Direct link to body")

`string`

#### Returns[​](#returns-13 "Direct link to Returns")

`Promise`<`null` | [`GroupMetadata`](/docs/api/interfaces/GroupMetadata)\>

### communityCreateGroup()[​](#communitycreategroup "Direct link to communityCreateGroup()")

> **communityCreateGroup**: (`subject`, `participants`, `parentCommunityJid`) => `Promise`<`null` | [`GroupMetadata`](/docs/api/interfaces/GroupMetadata)\>

#### Parameters[​](#parameters-14 "Direct link to Parameters")

##### subject[​](#subject-1 "Direct link to subject")

`string`

##### participants[​](#participants "Direct link to participants")

`string`\[\]

##### parentCommunityJid[​](#parentcommunityjid "Direct link to parentCommunityJid")

`string`

#### Returns[​](#returns-14 "Direct link to Returns")

`Promise`<`null` | [`GroupMetadata`](/docs/api/interfaces/GroupMetadata)\>

### communityFetchAllParticipating()[​](#communityfetchallparticipating "Direct link to communityFetchAllParticipating()")

> **communityFetchAllParticipating**: () => `Promise`<{}>

#### Returns[​](#returns-15 "Direct link to Returns")

`Promise`<{}>

### communityFetchLinkedGroups()[​](#communityfetchlinkedgroups "Direct link to communityFetchLinkedGroups()")

> **communityFetchLinkedGroups**: (`jid`) => `Promise`<{ `communityJid`: `string`; `isCommunity`: `boolean`; `linkedGroups`: `object`\[\]; }>

#### Parameters[​](#parameters-15 "Direct link to Parameters")

##### jid[​](#jid-5 "Direct link to jid")

`string`

#### Returns[​](#returns-16 "Direct link to Returns")

`Promise`<{ `communityJid`: `string`; `isCommunity`: `boolean`; `linkedGroups`: `object`\[\]; }>

### communityGetInviteInfo()[​](#communitygetinviteinfo "Direct link to communityGetInviteInfo()")

> **communityGetInviteInfo**: (`code`) => `Promise`<[`GroupMetadata`](/docs/api/interfaces/GroupMetadata)\>

#### Parameters[​](#parameters-16 "Direct link to Parameters")

##### code[​](#code-2 "Direct link to code")

`string`

#### Returns[​](#returns-17 "Direct link to Returns")

`Promise`<[`GroupMetadata`](/docs/api/interfaces/GroupMetadata)\>

### communityInviteCode()[​](#communityinvitecode "Direct link to communityInviteCode()")

> **communityInviteCode**: (`jid`) => `Promise`<`undefined` | `string`\>

#### Parameters[​](#parameters-17 "Direct link to Parameters")

##### jid[​](#jid-6 "Direct link to jid")

`string`

#### Returns[​](#returns-18 "Direct link to Returns")

`Promise`<`undefined` | `string`\>

### communityJoinApprovalMode()[​](#communityjoinapprovalmode "Direct link to communityJoinApprovalMode()")

> **communityJoinApprovalMode**: (`jid`, `mode`) => `Promise`<`void`\>

#### Parameters[​](#parameters-18 "Direct link to Parameters")

##### jid[​](#jid-7 "Direct link to jid")

`string`

##### mode[​](#mode "Direct link to mode")

`"on"` | `"off"`

#### Returns[​](#returns-19 "Direct link to Returns")

`Promise`<`void`\>

### communityLeave()[​](#communityleave "Direct link to communityLeave()")

> **communityLeave**: (`id`) => `Promise`<`void`\>

#### Parameters[​](#parameters-19 "Direct link to Parameters")

##### id[​](#id "Direct link to id")

`string`

#### Returns[​](#returns-20 "Direct link to Returns")

`Promise`<`void`\>

### communityLinkGroup()[​](#communitylinkgroup "Direct link to communityLinkGroup()")

> **communityLinkGroup**: (`groupJid`, `parentCommunityJid`) => `Promise`<`void`\>

#### Parameters[​](#parameters-20 "Direct link to Parameters")

##### groupJid[​](#groupjid "Direct link to groupJid")

`string`

##### parentCommunityJid[​](#parentcommunityjid-1 "Direct link to parentCommunityJid")

`string`

#### Returns[​](#returns-21 "Direct link to Returns")

`Promise`<`void`\>

### communityMemberAddMode()[​](#communitymemberaddmode "Direct link to communityMemberAddMode()")

> **communityMemberAddMode**: (`jid`, `mode`) => `Promise`<`void`\>

#### Parameters[​](#parameters-21 "Direct link to Parameters")

##### jid[​](#jid-8 "Direct link to jid")

`string`

##### mode[​](#mode-1 "Direct link to mode")

`"all_member_add"` | `"admin_add"`

#### Returns[​](#returns-22 "Direct link to Returns")

`Promise`<`void`\>

### communityMetadata()[​](#communitymetadata "Direct link to communityMetadata()")

> **communityMetadata**: (`jid`) => `Promise`<[`GroupMetadata`](/docs/api/interfaces/GroupMetadata)\>

#### Parameters[​](#parameters-22 "Direct link to Parameters")

##### jid[​](#jid-9 "Direct link to jid")

`string`

#### Returns[​](#returns-23 "Direct link to Returns")

`Promise`<[`GroupMetadata`](/docs/api/interfaces/GroupMetadata)\>

### communityParticipantsUpdate()[​](#communityparticipantsupdate "Direct link to communityParticipantsUpdate()")

> **communityParticipantsUpdate**: (`jid`, `participants`, `action`) => `Promise`<`object`\[\]>

#### Parameters[​](#parameters-23 "Direct link to Parameters")

##### jid[​](#jid-10 "Direct link to jid")

`string`

##### participants[​](#participants-1 "Direct link to participants")

`string`\[\]

##### action[​](#action "Direct link to action")

[`ParticipantAction`](/docs/api/type-aliases/ParticipantAction)

#### Returns[​](#returns-24 "Direct link to Returns")

`Promise`<`object`\[\]>

### communityRequestParticipantsList()[​](#communityrequestparticipantslist "Direct link to communityRequestParticipantsList()")

> **communityRequestParticipantsList**: (`jid`) => `Promise`<`object`\[\]>

#### Parameters[​](#parameters-24 "Direct link to Parameters")

##### jid[​](#jid-11 "Direct link to jid")

`string`

#### Returns[​](#returns-25 "Direct link to Returns")

`Promise`<`object`\[\]>

### communityRequestParticipantsUpdate()[​](#communityrequestparticipantsupdate "Direct link to communityRequestParticipantsUpdate()")

> **communityRequestParticipantsUpdate**: (`jid`, `participants`, `action`) => `Promise`<`object`\[\]>

#### Parameters[​](#parameters-25 "Direct link to Parameters")

##### jid[​](#jid-12 "Direct link to jid")

`string`

##### participants[​](#participants-2 "Direct link to participants")

`string`\[\]

##### action[​](#action-1 "Direct link to action")

`"reject"` | `"approve"`

#### Returns[​](#returns-26 "Direct link to Returns")

`Promise`<`object`\[\]>

### communityRevokeInvite()[​](#communityrevokeinvite "Direct link to communityRevokeInvite()")

> **communityRevokeInvite**: (`jid`) => `Promise`<`undefined` | `string`\>

#### Parameters[​](#parameters-26 "Direct link to Parameters")

##### jid[​](#jid-13 "Direct link to jid")

`string`

#### Returns[​](#returns-27 "Direct link to Returns")

`Promise`<`undefined` | `string`\>

### communityRevokeInviteV4()[​](#communityrevokeinvitev4 "Direct link to communityRevokeInviteV4()")

> **communityRevokeInviteV4**: (`communityJid`, `invitedJid`) => `Promise`<`boolean`\>

revoke a v4 invite for someone

#### Parameters[​](#parameters-27 "Direct link to Parameters")

##### communityJid[​](#communityjid "Direct link to communityJid")

`string`

community jid

##### invitedJid[​](#invitedjid "Direct link to invitedJid")

`string`

jid of person you invited

#### Returns[​](#returns-28 "Direct link to Returns")

`Promise`<`boolean`\>

true if successful

### communitySettingUpdate()[​](#communitysettingupdate "Direct link to communitySettingUpdate()")

> **communitySettingUpdate**: (`jid`, `setting`) => `Promise`<`void`\>

#### Parameters[​](#parameters-28 "Direct link to Parameters")

##### jid[​](#jid-14 "Direct link to jid")

`string`

##### setting[​](#setting "Direct link to setting")

`"announcement"` | `"locked"` | `"not_announcement"` | `"unlocked"`

#### Returns[​](#returns-29 "Direct link to Returns")

`Promise`<`void`\>

### communityToggleEphemeral()[​](#communitytoggleephemeral "Direct link to communityToggleEphemeral()")

> **communityToggleEphemeral**: (`jid`, `ephemeralExpiration`) => `Promise`<`void`\>

#### Parameters[​](#parameters-29 "Direct link to Parameters")

##### jid[​](#jid-15 "Direct link to jid")

`string`

##### ephemeralExpiration[​](#ephemeralexpiration "Direct link to ephemeralExpiration")

`number`

#### Returns[​](#returns-30 "Direct link to Returns")

`Promise`<`void`\>

### communityUnlinkGroup()[​](#communityunlinkgroup "Direct link to communityUnlinkGroup()")

> **communityUnlinkGroup**: (`groupJid`, `parentCommunityJid`) => `Promise`<`void`\>

#### Parameters[​](#parameters-30 "Direct link to Parameters")

##### groupJid[​](#groupjid-1 "Direct link to groupJid")

`string`

##### parentCommunityJid[​](#parentcommunityjid-2 "Direct link to parentCommunityJid")

`string`

#### Returns[​](#returns-31 "Direct link to Returns")

`Promise`<`void`\>

### communityUpdateDescription()[​](#communityupdatedescription "Direct link to communityUpdateDescription()")

> **communityUpdateDescription**: (`jid`, `description`?) => `Promise`<`void`\>

#### Parameters[​](#parameters-31 "Direct link to Parameters")

##### jid[​](#jid-16 "Direct link to jid")

`string`

##### description?[​](#description "Direct link to description?")

`string`

#### Returns[​](#returns-32 "Direct link to Returns")

`Promise`<`void`\>

### communityUpdateSubject()[​](#communityupdatesubject "Direct link to communityUpdateSubject()")

> **communityUpdateSubject**: (`jid`, `subject`) => `Promise`<`void`\>

#### Parameters[​](#parameters-32 "Direct link to Parameters")

##### jid[​](#jid-17 "Direct link to jid")

`string`

##### subject[​](#subject-2 "Direct link to subject")

`string`

#### Returns[​](#returns-33 "Direct link to Returns")

`Promise`<`void`\>

### createCallLink()[​](#createcalllink "Direct link to createCallLink()")

> **createCallLink**: (`type`, `event`?, `timeoutMs`?) => `Promise`<`undefined` | `string`\>

#### Parameters[​](#parameters-33 "Direct link to Parameters")

##### type[​](#type-1 "Direct link to type")

`"video"` | `"audio"`

##### event?[​](#event "Direct link to event?")

###### startTime[​](#starttime "Direct link to startTime")

`number`

##### timeoutMs?[​](#timeoutms "Direct link to timeoutMs?")

`number`

#### Returns[​](#returns-34 "Direct link to Returns")

`Promise`<`undefined` | `string`\>

### createParticipantNodes()[​](#createparticipantnodes "Direct link to createParticipantNodes()")

> **createParticipantNodes**: (`recipientJids`, `message`, `extraAttrs`?, `dsmMessage`?) => `Promise`<{ `nodes`: [`BinaryNode`](/docs/api/type-aliases/BinaryNode)\[\]; `shouldIncludeDeviceIdentity`: `boolean`; }>

#### Parameters[​](#parameters-34 "Direct link to Parameters")

##### recipientJids[​](#recipientjids "Direct link to recipientJids")

`string`\[\]

##### message[​](#message "Direct link to message")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

##### extraAttrs?[​](#extraattrs "Direct link to extraAttrs?")

##### dsmMessage?[​](#dsmmessage "Direct link to dsmMessage?")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

#### Returns[​](#returns-35 "Direct link to Returns")

`Promise`<{ `nodes`: [`BinaryNode`](/docs/api/type-aliases/BinaryNode)\[\]; `shouldIncludeDeviceIdentity`: `boolean`; }>

### digestKeyBundle()[​](#digestkeybundle "Direct link to digestKeyBundle()")

> **digestKeyBundle**: () => `Promise`<`void`\>

#### Returns[​](#returns-36 "Direct link to Returns")

`Promise`<`void`\>

### end()[​](#end "Direct link to end()")

> **end**: (`error`) => `Promise`<`void`\>

#### Parameters[​](#parameters-35 "Direct link to Parameters")

##### error[​](#error "Direct link to error")

`undefined` | `Error`

#### Returns[​](#returns-37 "Direct link to Returns")

`Promise`<`void`\>

### ev[​](#ev "Direct link to ev")

> **ev**: `BaileysBufferableEventEmitter`

### executeUSyncQuery()[​](#executeusyncquery "Direct link to executeUSyncQuery()")

> **executeUSyncQuery**: (`usyncQuery`) => `Promise`<`undefined` | [`USyncQueryResult`](/docs/api/type-aliases/USyncQueryResult)\>

#### Parameters[​](#parameters-36 "Direct link to Parameters")

##### usyncQuery[​](#usyncquery "Direct link to usyncQuery")

[`USyncQuery`](/docs/api/classes/USyncQuery)

#### Returns[​](#returns-38 "Direct link to Returns")

`Promise`<`undefined` | [`USyncQueryResult`](/docs/api/type-aliases/USyncQueryResult)\>

### fetchBlocklist()[​](#fetchblocklist "Direct link to fetchBlocklist()")

> **fetchBlocklist**: () => `Promise`<(`undefined` | `string`)\[\]>

#### Returns[​](#returns-39 "Direct link to Returns")

`Promise`<(`undefined` | `string`)\[\]>

### fetchDisappearingDuration()[​](#fetchdisappearingduration "Direct link to fetchDisappearingDuration()")

> **fetchDisappearingDuration**: (...`jids`) => `Promise`<`undefined` | [`USyncQueryResultList`](/docs/api/type-aliases/USyncQueryResultList)\[\]>

#### Parameters[​](#parameters-37 "Direct link to Parameters")

##### jids[​](#jids-1 "Direct link to jids")

...`string`\[\]

#### Returns[​](#returns-40 "Direct link to Returns")

`Promise`<`undefined` | [`USyncQueryResultList`](/docs/api/type-aliases/USyncQueryResultList)\[\]>

### fetchMessageHistory()[​](#fetchmessagehistory "Direct link to fetchMessageHistory()")

> **fetchMessageHistory**: (`count`, `oldestMsgKey`, `oldestMsgTimestamp`) => `Promise`<`string`\>

#### Parameters[​](#parameters-38 "Direct link to Parameters")

##### count[​](#count "Direct link to count")

`number`

##### oldestMsgKey[​](#oldestmsgkey "Direct link to oldestMsgKey")

[`WAMessageKey`](/docs/api/type-aliases/WAMessageKey)

##### oldestMsgTimestamp[​](#oldestmsgtimestamp "Direct link to oldestMsgTimestamp")

`number` | `Long`

#### Returns[​](#returns-41 "Direct link to Returns")

`Promise`<`string`\>

### fetchPrivacySettings()[​](#fetchprivacysettings "Direct link to fetchPrivacySettings()")

> **fetchPrivacySettings**: (`force`) => `Promise`<{}>

#### Parameters[​](#parameters-39 "Direct link to Parameters")

##### force[​](#force-1 "Direct link to force")

`boolean` = `false`

#### Returns[​](#returns-42 "Direct link to Returns")

`Promise`<{}>

### fetchStatus()[​](#fetchstatus "Direct link to fetchStatus()")

> **fetchStatus**: (...`jids`) => `Promise`<`undefined` | [`USyncQueryResultList`](/docs/api/type-aliases/USyncQueryResultList)\[\]>

#### Parameters[​](#parameters-40 "Direct link to Parameters")

##### jids[​](#jids-2 "Direct link to jids")

...`string`\[\]

#### Returns[​](#returns-43 "Direct link to Returns")

`Promise`<`undefined` | [`USyncQueryResultList`](/docs/api/type-aliases/USyncQueryResultList)\[\]>

### generateMessageTag()[​](#generatemessagetag "Direct link to generateMessageTag()")

> **generateMessageTag**: () => `string`

#### Returns[​](#returns-44 "Direct link to Returns")

`string`

### getBotListV2()[​](#getbotlistv2 "Direct link to getBotListV2()")

> **getBotListV2**: () => `Promise`<[`BotListInfo`](/docs/api/type-aliases/BotListInfo)\[\]>

#### Returns[​](#returns-45 "Direct link to Returns")

`Promise`<[`BotListInfo`](/docs/api/type-aliases/BotListInfo)\[\]>

### getBusinessProfile()[​](#getbusinessprofile "Direct link to getBusinessProfile()")

> **getBusinessProfile**: (`jid`) => `Promise`<`void` | [`WABusinessProfile`](/docs/api/type-aliases/WABusinessProfile)\>

#### Parameters[​](#parameters-41 "Direct link to Parameters")

##### jid[​](#jid-18 "Direct link to jid")

`string`

#### Returns[​](#returns-46 "Direct link to Returns")

`Promise`<`void` | [`WABusinessProfile`](/docs/api/type-aliases/WABusinessProfile)\>

### getCatalog()[​](#getcatalog "Direct link to getCatalog()")

> **getCatalog**: (`__namedParameters`) => `Promise`<{ `nextPageCursor`: `undefined` | `string`; `products`: [`Product`](/docs/api/type-aliases/Product)\[\]; }>

#### Parameters[​](#parameters-42 "Direct link to Parameters")

##### \_\_namedParameters[​](#__namedparameters "Direct link to __namedParameters")

[`GetCatalogOptions`](/docs/api/type-aliases/GetCatalogOptions)

#### Returns[​](#returns-47 "Direct link to Returns")

`Promise`<{ `nextPageCursor`: `undefined` | `string`; `products`: [`Product`](/docs/api/type-aliases/Product)\[\]; }>

### getCollections()[​](#getcollections "Direct link to getCollections()")

> **getCollections**: (`jid`?, `limit`) => `Promise`<{ `collections`: [`CatalogCollection`](/docs/api/type-aliases/CatalogCollection)\[\]; }>

#### Parameters[​](#parameters-43 "Direct link to Parameters")

##### jid?[​](#jid-19 "Direct link to jid?")

`string`

##### limit?[​](#limit "Direct link to limit?")

`number` = `51`

#### Returns[​](#returns-48 "Direct link to Returns")

`Promise`<{ `collections`: [`CatalogCollection`](/docs/api/type-aliases/CatalogCollection)\[\]; }>

### getOrderDetails()[​](#getorderdetails "Direct link to getOrderDetails()")

> **getOrderDetails**: (`orderId`, `tokenBase64`) => `Promise`<[`OrderDetails`](/docs/api/type-aliases/OrderDetails)\>

#### Parameters[​](#parameters-44 "Direct link to Parameters")

##### orderId[​](#orderid "Direct link to orderId")

`string`

##### tokenBase64[​](#tokenbase64 "Direct link to tokenBase64")

`string`

#### Returns[​](#returns-49 "Direct link to Returns")

`Promise`<[`OrderDetails`](/docs/api/type-aliases/OrderDetails)\>

### getPrivacyTokens()[​](#getprivacytokens "Direct link to getPrivacyTokens()")

> **getPrivacyTokens**: (`jids`) => `Promise`<`any`\>

#### Parameters[​](#parameters-45 "Direct link to Parameters")

##### jids[​](#jids-3 "Direct link to jids")

`string`\[\]

#### Returns[​](#returns-50 "Direct link to Returns")

`Promise`<`any`\>

### getUSyncDevices()[​](#getusyncdevices "Direct link to getUSyncDevices()")

> **getUSyncDevices**: (`jids`, `useCache`, `ignoreZeroDevices`) => `Promise`<`DeviceWithJid`\[\]>

Fetch all the devices we've to send a message to

#### Parameters[​](#parameters-46 "Direct link to Parameters")

##### jids[​](#jids-4 "Direct link to jids")

`string`\[\]

##### useCache[​](#usecache "Direct link to useCache")

`boolean`

##### ignoreZeroDevices[​](#ignorezerodevices "Direct link to ignoreZeroDevices")

`boolean`

#### Returns[​](#returns-51 "Direct link to Returns")

`Promise`<`DeviceWithJid`\[\]>

### groupAcceptInvite()[​](#groupacceptinvite "Direct link to groupAcceptInvite()")

> **groupAcceptInvite**: (`code`) => `Promise`<`undefined` | `string`\>

#### Parameters[​](#parameters-47 "Direct link to Parameters")

##### code[​](#code-3 "Direct link to code")

`string`

#### Returns[​](#returns-52 "Direct link to Returns")

`Promise`<`undefined` | `string`\>

### groupAcceptInviteV4()[​](#groupacceptinvitev4 "Direct link to groupAcceptInviteV4()")

> **groupAcceptInviteV4**: (...`args`) => `Promise`<`any`\>

accept a GroupInviteMessage

#### Parameters[​](#parameters-48 "Direct link to Parameters")

##### args[​](#args-1 "Direct link to args")

...\[`string` | [`WAMessageKey`](/docs/api/type-aliases/WAMessageKey), [`IGroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage)\]

#### Returns[​](#returns-53 "Direct link to Returns")

`Promise`<`any`\>

### groupCreate()[​](#groupcreate "Direct link to groupCreate()")

> **groupCreate**: (`subject`, `participants`) => `Promise`<[`GroupMetadata`](/docs/api/interfaces/GroupMetadata)\>

#### Parameters[​](#parameters-49 "Direct link to Parameters")

##### subject[​](#subject-3 "Direct link to subject")

`string`

##### participants[​](#participants-3 "Direct link to participants")

`string`\[\]

#### Returns[​](#returns-54 "Direct link to Returns")

`Promise`<[`GroupMetadata`](/docs/api/interfaces/GroupMetadata)\>

### groupFetchAllParticipating()[​](#groupfetchallparticipating "Direct link to groupFetchAllParticipating()")

> **groupFetchAllParticipating**: () => `Promise`<{}>

#### Returns[​](#returns-55 "Direct link to Returns")

`Promise`<{}>

### groupGetInviteInfo()[​](#groupgetinviteinfo "Direct link to groupGetInviteInfo()")

> **groupGetInviteInfo**: (`code`) => `Promise`<[`GroupMetadata`](/docs/api/interfaces/GroupMetadata)\>

#### Parameters[​](#parameters-50 "Direct link to Parameters")

##### code[​](#code-4 "Direct link to code")

`string`

#### Returns[​](#returns-56 "Direct link to Returns")

`Promise`<[`GroupMetadata`](/docs/api/interfaces/GroupMetadata)\>

### groupInviteCode()[​](#groupinvitecode "Direct link to groupInviteCode()")

> **groupInviteCode**: (`jid`) => `Promise`<`undefined` | `string`\>

#### Parameters[​](#parameters-51 "Direct link to Parameters")

##### jid[​](#jid-20 "Direct link to jid")

`string`

#### Returns[​](#returns-57 "Direct link to Returns")

`Promise`<`undefined` | `string`\>

### groupJoinApprovalMode()[​](#groupjoinapprovalmode "Direct link to groupJoinApprovalMode()")

> **groupJoinApprovalMode**: (`jid`, `mode`) => `Promise`<`void`\>

#### Parameters[​](#parameters-52 "Direct link to Parameters")

##### jid[​](#jid-21 "Direct link to jid")

`string`

##### mode[​](#mode-2 "Direct link to mode")

`"on"` | `"off"`

#### Returns[​](#returns-58 "Direct link to Returns")

`Promise`<`void`\>

### groupLeave()[​](#groupleave "Direct link to groupLeave()")

> **groupLeave**: (`id`) => `Promise`<`void`\>

#### Parameters[​](#parameters-53 "Direct link to Parameters")

##### id[​](#id-1 "Direct link to id")

`string`

#### Returns[​](#returns-59 "Direct link to Returns")

`Promise`<`void`\>

### groupMemberAddMode()[​](#groupmemberaddmode "Direct link to groupMemberAddMode()")

> **groupMemberAddMode**: (`jid`, `mode`) => `Promise`<`void`\>

#### Parameters[​](#parameters-54 "Direct link to Parameters")

##### jid[​](#jid-22 "Direct link to jid")

`string`

##### mode[​](#mode-3 "Direct link to mode")

`"all_member_add"` | `"admin_add"`

#### Returns[​](#returns-60 "Direct link to Returns")

`Promise`<`void`\>

### groupMetadata()[​](#groupmetadata "Direct link to groupMetadata()")

> **groupMetadata**: (`jid`) => `Promise`<[`GroupMetadata`](/docs/api/interfaces/GroupMetadata)\>

#### Parameters[​](#parameters-55 "Direct link to Parameters")

##### jid[​](#jid-23 "Direct link to jid")

`string`

#### Returns[​](#returns-61 "Direct link to Returns")

`Promise`<[`GroupMetadata`](/docs/api/interfaces/GroupMetadata)\>

### groupParticipantsUpdate()[​](#groupparticipantsupdate "Direct link to groupParticipantsUpdate()")

> **groupParticipantsUpdate**: (`jid`, `participants`, `action`) => `Promise`<`object`\[\]>

#### Parameters[​](#parameters-56 "Direct link to Parameters")

##### jid[​](#jid-24 "Direct link to jid")

`string`

##### participants[​](#participants-4 "Direct link to participants")

`string`\[\]

##### action[​](#action-2 "Direct link to action")

[`ParticipantAction`](/docs/api/type-aliases/ParticipantAction)

#### Returns[​](#returns-62 "Direct link to Returns")

`Promise`<`object`\[\]>

### groupRequestParticipantsList()[​](#grouprequestparticipantslist "Direct link to groupRequestParticipantsList()")

> **groupRequestParticipantsList**: (`jid`) => `Promise`<`object`\[\]>

#### Parameters[​](#parameters-57 "Direct link to Parameters")

##### jid[​](#jid-25 "Direct link to jid")

`string`

#### Returns[​](#returns-63 "Direct link to Returns")

`Promise`<`object`\[\]>

### groupRequestParticipantsUpdate()[​](#grouprequestparticipantsupdate "Direct link to groupRequestParticipantsUpdate()")

> **groupRequestParticipantsUpdate**: (`jid`, `participants`, `action`) => `Promise`<`object`\[\]>

#### Parameters[​](#parameters-58 "Direct link to Parameters")

##### jid[​](#jid-26 "Direct link to jid")

`string`

##### participants[​](#participants-5 "Direct link to participants")

`string`\[\]

##### action[​](#action-3 "Direct link to action")

`"reject"` | `"approve"`

#### Returns[​](#returns-64 "Direct link to Returns")

`Promise`<`object`\[\]>

### groupRevokeInvite()[​](#grouprevokeinvite "Direct link to groupRevokeInvite()")

> **groupRevokeInvite**: (`jid`) => `Promise`<`undefined` | `string`\>

#### Parameters[​](#parameters-59 "Direct link to Parameters")

##### jid[​](#jid-27 "Direct link to jid")

`string`

#### Returns[​](#returns-65 "Direct link to Returns")

`Promise`<`undefined` | `string`\>

### groupRevokeInviteV4()[​](#grouprevokeinvitev4 "Direct link to groupRevokeInviteV4()")

> **groupRevokeInviteV4**: (`groupJid`, `invitedJid`) => `Promise`<`boolean`\>

revoke a v4 invite for someone

#### Parameters[​](#parameters-60 "Direct link to Parameters")

##### groupJid[​](#groupjid-2 "Direct link to groupJid")

`string`

group jid

##### invitedJid[​](#invitedjid-1 "Direct link to invitedJid")

`string`

jid of person you invited

#### Returns[​](#returns-66 "Direct link to Returns")

`Promise`<`boolean`\>

true if successful

### groupSettingUpdate()[​](#groupsettingupdate "Direct link to groupSettingUpdate()")

> **groupSettingUpdate**: (`jid`, `setting`) => `Promise`<`void`\>

#### Parameters[​](#parameters-61 "Direct link to Parameters")

##### jid[​](#jid-28 "Direct link to jid")

`string`

##### setting[​](#setting-1 "Direct link to setting")

`"announcement"` | `"locked"` | `"not_announcement"` | `"unlocked"`

#### Returns[​](#returns-67 "Direct link to Returns")

`Promise`<`void`\>

### groupToggleEphemeral()[​](#grouptoggleephemeral "Direct link to groupToggleEphemeral()")

> **groupToggleEphemeral**: (`jid`, `ephemeralExpiration`) => `Promise`<`void`\>

#### Parameters[​](#parameters-62 "Direct link to Parameters")

##### jid[​](#jid-29 "Direct link to jid")

`string`

##### ephemeralExpiration[​](#ephemeralexpiration-1 "Direct link to ephemeralExpiration")

`number`

#### Returns[​](#returns-68 "Direct link to Returns")

`Promise`<`void`\>

### groupUpdateDescription()[​](#groupupdatedescription "Direct link to groupUpdateDescription()")

> **groupUpdateDescription**: (`jid`, `description`?) => `Promise`<`void`\>

#### Parameters[​](#parameters-63 "Direct link to Parameters")

##### jid[​](#jid-30 "Direct link to jid")

`string`

##### description?[​](#description-1 "Direct link to description?")

`string`

#### Returns[​](#returns-69 "Direct link to Returns")

`Promise`<`void`\>

### groupUpdateSubject()[​](#groupupdatesubject "Direct link to groupUpdateSubject()")

> **groupUpdateSubject**: (`jid`, `subject`) => `Promise`<`void`\>

#### Parameters[​](#parameters-64 "Direct link to Parameters")

##### jid[​](#jid-31 "Direct link to jid")

`string`

##### subject[​](#subject-4 "Direct link to subject")

`string`

#### Returns[​](#returns-70 "Direct link to Returns")

`Promise`<`void`\>

### logger[​](#logger "Direct link to logger")

> **logger**: `ILogger` = `config.logger`

### logout()[​](#logout "Direct link to logout()")

> **logout**: (`msg`?) => `Promise`<`void`\>

logout & invalidate connection

#### Parameters[​](#parameters-65 "Direct link to Parameters")

##### msg?[​](#msg "Direct link to msg?")

`string`

#### Returns[​](#returns-71 "Direct link to Returns")

`Promise`<`void`\>

### messageMutex[​](#messagemutex "Direct link to messageMutex")

> **messageMutex**: `object`

#### messageMutex.mutex()[​](#messagemutexmutex "Direct link to messageMutex.mutex()")

##### Type Parameters[​](#type-parameters-1 "Direct link to Type Parameters")

• **T**

##### Parameters[​](#parameters-66 "Direct link to Parameters")

###### code[​](#code-5 "Direct link to code")

() => `T` | `Promise`<`T`\>

##### Returns[​](#returns-72 "Direct link to Returns")

`Promise`<`T`\>

### messageRetryManager[​](#messageretrymanager "Direct link to messageRetryManager")

> **messageRetryManager**: `null` | [`MessageRetryManager`](/docs/api/classes/MessageRetryManager)

### newsletterAdminCount()[​](#newsletteradmincount "Direct link to newsletterAdminCount()")

> **newsletterAdminCount**: (`jid`) => `Promise`<`number`\>

#### Parameters[​](#parameters-67 "Direct link to Parameters")

##### jid[​](#jid-32 "Direct link to jid")

`string`

#### Returns[​](#returns-73 "Direct link to Returns")

`Promise`<`number`\>

### newsletterChangeOwner()[​](#newsletterchangeowner "Direct link to newsletterChangeOwner()")

> **newsletterChangeOwner**: (`jid`, `newOwnerJid`) => `Promise`<`void`\>

#### Parameters[​](#parameters-68 "Direct link to Parameters")

##### jid[​](#jid-33 "Direct link to jid")

`string`

##### newOwnerJid[​](#newownerjid "Direct link to newOwnerJid")

`string`

#### Returns[​](#returns-74 "Direct link to Returns")

`Promise`<`void`\>

### newsletterCreate()[​](#newslettercreate "Direct link to newsletterCreate()")

> **newsletterCreate**: (`name`, `description`?) => `Promise`<[`NewsletterMetadata`](/docs/api/interfaces/NewsletterMetadata)\>

#### Parameters[​](#parameters-69 "Direct link to Parameters")

##### name[​](#name "Direct link to name")

`string`

##### description?[​](#description-2 "Direct link to description?")

`string`

#### Returns[​](#returns-75 "Direct link to Returns")

`Promise`<[`NewsletterMetadata`](/docs/api/interfaces/NewsletterMetadata)\>

### newsletterDelete()[​](#newsletterdelete "Direct link to newsletterDelete()")

> **newsletterDelete**: (`jid`) => `Promise`<`void`\>

#### Parameters[​](#parameters-70 "Direct link to Parameters")

##### jid[​](#jid-34 "Direct link to jid")

`string`

#### Returns[​](#returns-76 "Direct link to Returns")

`Promise`<`void`\>

### newsletterDemote()[​](#newsletterdemote "Direct link to newsletterDemote()")

> **newsletterDemote**: (`jid`, `userJid`) => `Promise`<`void`\>

#### Parameters[​](#parameters-71 "Direct link to Parameters")

##### jid[​](#jid-35 "Direct link to jid")

`string`

##### userJid[​](#userjid "Direct link to userJid")

`string`

#### Returns[​](#returns-77 "Direct link to Returns")

`Promise`<`void`\>

### newsletterFetchMessages()[​](#newsletterfetchmessages "Direct link to newsletterFetchMessages()")

> **newsletterFetchMessages**: (`jid`, `count`, `since`, `after`) => `Promise`<`any`\>

#### Parameters[​](#parameters-72 "Direct link to Parameters")

##### jid[​](#jid-36 "Direct link to jid")

`string`

##### count[​](#count-1 "Direct link to count")

`number`

##### since[​](#since "Direct link to since")

`number`

##### after[​](#after "Direct link to after")

`number`

#### Returns[​](#returns-78 "Direct link to Returns")

`Promise`<`any`\>

### newsletterFollow()[​](#newsletterfollow "Direct link to newsletterFollow()")

> **newsletterFollow**: (`jid`) => `Promise`<`unknown`\>

#### Parameters[​](#parameters-73 "Direct link to Parameters")

##### jid[​](#jid-37 "Direct link to jid")

`string`

#### Returns[​](#returns-79 "Direct link to Returns")

`Promise`<`unknown`\>

### newsletterMetadata()[​](#newslettermetadata "Direct link to newsletterMetadata()")

> **newsletterMetadata**: (`type`, `key`) => `Promise`<`null` | [`NewsletterMetadata`](/docs/api/interfaces/NewsletterMetadata)\>

#### Parameters[​](#parameters-74 "Direct link to Parameters")

##### type[​](#type-2 "Direct link to type")

`"invite"` | `"jid"`

##### key[​](#key "Direct link to key")

`string`

#### Returns[​](#returns-80 "Direct link to Returns")

`Promise`<`null` | [`NewsletterMetadata`](/docs/api/interfaces/NewsletterMetadata)\>

### newsletterMute()[​](#newslettermute "Direct link to newsletterMute()")

> **newsletterMute**: (`jid`) => `Promise`<`unknown`\>

#### Parameters[​](#parameters-75 "Direct link to Parameters")

##### jid[​](#jid-38 "Direct link to jid")

`string`

#### Returns[​](#returns-81 "Direct link to Returns")

`Promise`<`unknown`\>

### newsletterReactMessage()[​](#newsletterreactmessage "Direct link to newsletterReactMessage()")

> **newsletterReactMessage**: (`jid`, `serverId`, `reaction`?) => `Promise`<`void`\>

#### Parameters[​](#parameters-76 "Direct link to Parameters")

##### jid[​](#jid-39 "Direct link to jid")

`string`

##### serverId[​](#serverid "Direct link to serverId")

`string`

##### reaction?[​](#reaction "Direct link to reaction?")

`string`

#### Returns[​](#returns-82 "Direct link to Returns")

`Promise`<`void`\>

### newsletterRemovePicture()[​](#newsletterremovepicture "Direct link to newsletterRemovePicture()")

> **newsletterRemovePicture**: (`jid`) => `Promise`<`unknown`\>

#### Parameters[​](#parameters-77 "Direct link to Parameters")

##### jid[​](#jid-40 "Direct link to jid")

`string`

#### Returns[​](#returns-83 "Direct link to Returns")

`Promise`<`unknown`\>

### newsletterSubscribers()[​](#newslettersubscribers "Direct link to newsletterSubscribers()")

> **newsletterSubscribers**: (`jid`) => `Promise`<{ `subscribers`: `number`; }>

#### Parameters[​](#parameters-78 "Direct link to Parameters")

##### jid[​](#jid-41 "Direct link to jid")

`string`

#### Returns[​](#returns-84 "Direct link to Returns")

`Promise`<{ `subscribers`: `number`; }>

### newsletterUnfollow()[​](#newsletterunfollow "Direct link to newsletterUnfollow()")

> **newsletterUnfollow**: (`jid`) => `Promise`<`unknown`\>

#### Parameters[​](#parameters-79 "Direct link to Parameters")

##### jid[​](#jid-42 "Direct link to jid")

`string`

#### Returns[​](#returns-85 "Direct link to Returns")

`Promise`<`unknown`\>

### newsletterUnmute()[​](#newsletterunmute "Direct link to newsletterUnmute()")

> **newsletterUnmute**: (`jid`) => `Promise`<`unknown`\>

#### Parameters[​](#parameters-80 "Direct link to Parameters")

##### jid[​](#jid-43 "Direct link to jid")

`string`

#### Returns[​](#returns-86 "Direct link to Returns")

`Promise`<`unknown`\>

### newsletterUpdate()[​](#newsletterupdate "Direct link to newsletterUpdate()")

> **newsletterUpdate**: (`jid`, `updates`) => `Promise`<`unknown`\>

#### Parameters[​](#parameters-81 "Direct link to Parameters")

##### jid[​](#jid-44 "Direct link to jid")

`string`

##### updates[​](#updates "Direct link to updates")

[`NewsletterUpdate`](/docs/api/type-aliases/NewsletterUpdate)

#### Returns[​](#returns-87 "Direct link to Returns")

`Promise`<`unknown`\>

### newsletterUpdateDescription()[​](#newsletterupdatedescription "Direct link to newsletterUpdateDescription()")

> **newsletterUpdateDescription**: (`jid`, `description`) => `Promise`<`unknown`\>

#### Parameters[​](#parameters-82 "Direct link to Parameters")

##### jid[​](#jid-45 "Direct link to jid")

`string`

##### description[​](#description-3 "Direct link to description")

`string`

#### Returns[​](#returns-88 "Direct link to Returns")

`Promise`<`unknown`\>

### newsletterUpdateName()[​](#newsletterupdatename "Direct link to newsletterUpdateName()")

> **newsletterUpdateName**: (`jid`, `name`) => `Promise`<`unknown`\>

#### Parameters[​](#parameters-83 "Direct link to Parameters")

##### jid[​](#jid-46 "Direct link to jid")

`string`

##### name[​](#name-1 "Direct link to name")

`string`

#### Returns[​](#returns-89 "Direct link to Returns")

`Promise`<`unknown`\>

### newsletterUpdatePicture()[​](#newsletterupdatepicture "Direct link to newsletterUpdatePicture()")

> **newsletterUpdatePicture**: (`jid`, `content`) => `Promise`<`unknown`\>

#### Parameters[​](#parameters-84 "Direct link to Parameters")

##### jid[​](#jid-47 "Direct link to jid")

`string`

##### content[​](#content "Direct link to content")

[`WAMediaUpload`](/docs/api/type-aliases/WAMediaUpload)

#### Returns[​](#returns-90 "Direct link to Returns")

`Promise`<`unknown`\>

### notificationMutex[​](#notificationmutex "Direct link to notificationMutex")

> **notificationMutex**: `object`

#### notificationMutex.mutex()[​](#notificationmutexmutex "Direct link to notificationMutex.mutex()")

##### Type Parameters[​](#type-parameters-2 "Direct link to Type Parameters")

• **T**

##### Parameters[​](#parameters-85 "Direct link to Parameters")

###### code[​](#code-6 "Direct link to code")

() => `T` | `Promise`<`T`\>

##### Returns[​](#returns-91 "Direct link to Returns")

`Promise`<`T`\>

### onUnexpectedError()[​](#onunexpectederror "Direct link to onUnexpectedError()")

> **onUnexpectedError**: (`err`, `msg`) => `void`

log & process any unexpected errors

#### Parameters[​](#parameters-86 "Direct link to Parameters")

##### err[​](#err "Direct link to err")

`Error` | `Boom`<`any`\>

##### msg[​](#msg-1 "Direct link to msg")

`string`

#### Returns[​](#returns-92 "Direct link to Returns")

`void`

### onWhatsApp()[​](#onwhatsapp "Direct link to onWhatsApp()")

> **onWhatsApp**: (...`phoneNumber`) => `Promise`<`undefined` | `object`\[\]>

#### Parameters[​](#parameters-87 "Direct link to Parameters")

##### phoneNumber[​](#phonenumber "Direct link to phoneNumber")

...`string`\[\]

#### Returns[​](#returns-93 "Direct link to Returns")

`Promise`<`undefined` | `object`\[\]>

### presenceSubscribe()[​](#presencesubscribe "Direct link to presenceSubscribe()")

> **presenceSubscribe**: (`toJid`) => `Promise`<`void`\>

#### Parameters[​](#parameters-88 "Direct link to Parameters")

##### toJid[​](#tojid "Direct link to toJid")

`string`

the jid to subscribe to

#### Returns[​](#returns-94 "Direct link to Returns")

`Promise`<`void`\>

### productCreate()[​](#productcreate "Direct link to productCreate()")

> **productCreate**: (`create`) => `Promise`<[`Product`](/docs/api/type-aliases/Product)\>

#### Parameters[​](#parameters-89 "Direct link to Parameters")

##### create[​](#create "Direct link to create")

[`ProductCreate`](/docs/api/type-aliases/ProductCreate)

#### Returns[​](#returns-95 "Direct link to Returns")

`Promise`<[`Product`](/docs/api/type-aliases/Product)\>

### productDelete()[​](#productdelete "Direct link to productDelete()")

> **productDelete**: (`productIds`) => `Promise`<{ `deleted`: `number`; }>

#### Parameters[​](#parameters-90 "Direct link to Parameters")

##### productIds[​](#productids "Direct link to productIds")

`string`\[\]

#### Returns[​](#returns-96 "Direct link to Returns")

`Promise`<{ `deleted`: `number`; }>

### productUpdate()[​](#productupdate "Direct link to productUpdate()")

> **productUpdate**: (`productId`, `update`) => `Promise`<[`Product`](/docs/api/type-aliases/Product)\>

#### Parameters[​](#parameters-91 "Direct link to Parameters")

##### productId[​](#productid "Direct link to productId")

`string`

##### update[​](#update "Direct link to update")

[`ProductUpdate`](/docs/api/type-aliases/ProductUpdate)

#### Returns[​](#returns-97 "Direct link to Returns")

`Promise`<[`Product`](/docs/api/type-aliases/Product)\>

### profilePictureUrl()[​](#profilepictureurl "Direct link to profilePictureUrl()")

> **profilePictureUrl**: (`jid`, `type`, `timeoutMs`?) => `Promise`<`undefined` | `string`\>

fetch the profile picture of a user/group type = "preview" for a low res picture type = "image for the high res picture"

#### Parameters[​](#parameters-92 "Direct link to Parameters")

##### jid[​](#jid-48 "Direct link to jid")

`string`

##### type[​](#type-3 "Direct link to type")

`"image"` | `"preview"`

##### timeoutMs?[​](#timeoutms-1 "Direct link to timeoutMs?")

`number`

#### Returns[​](#returns-98 "Direct link to Returns")

`Promise`<`undefined` | `string`\>

### query()[​](#query "Direct link to query()")

> **query**: (`node`, `timeoutMs`?) => `Promise`<`any`\>

send a query, and wait for its response. auto-generates message ID if not provided

#### Parameters[​](#parameters-93 "Direct link to Parameters")

##### node[​](#node "Direct link to node")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

##### timeoutMs?[​](#timeoutms-2 "Direct link to timeoutMs?")

`number`

#### Returns[​](#returns-99 "Direct link to Returns")

`Promise`<`any`\>

### readMessages()[​](#readmessages "Direct link to readMessages()")

> **readMessages**: (`keys`) => `Promise`<`void`\>

Bulk read messages. Keys can be from different chats & participants

#### Parameters[​](#parameters-94 "Direct link to Parameters")

##### keys[​](#keys "Direct link to keys")

[`WAMessageKey`](/docs/api/type-aliases/WAMessageKey)\[\]

#### Returns[​](#returns-100 "Direct link to Returns")

`Promise`<`void`\>

### receiptMutex[​](#receiptmutex "Direct link to receiptMutex")

> **receiptMutex**: `object`

#### receiptMutex.mutex()[​](#receiptmutexmutex "Direct link to receiptMutex.mutex()")

##### Type Parameters[​](#type-parameters-3 "Direct link to Type Parameters")

• **T**

##### Parameters[​](#parameters-95 "Direct link to Parameters")

###### code[​](#code-7 "Direct link to code")

() => `T` | `Promise`<`T`\>

##### Returns[​](#returns-101 "Direct link to Returns")

`Promise`<`T`\>

### refreshMediaConn()[​](#refreshmediaconn "Direct link to refreshMediaConn()")

> **refreshMediaConn**: (`forceGet`) => `Promise`<[`MediaConnInfo`](/docs/api/type-aliases/MediaConnInfo)\>

#### Parameters[​](#parameters-96 "Direct link to Parameters")

##### forceGet[​](#forceget "Direct link to forceGet")

`boolean` = `false`

#### Returns[​](#returns-102 "Direct link to Returns")

`Promise`<[`MediaConnInfo`](/docs/api/type-aliases/MediaConnInfo)\>

### rejectCall()[​](#rejectcall "Direct link to rejectCall()")

> **rejectCall**: (`callId`, `callFrom`) => `Promise`<`void`\>

#### Parameters[​](#parameters-97 "Direct link to Parameters")

##### callId[​](#callid "Direct link to callId")

`string`

##### callFrom[​](#callfrom "Direct link to callFrom")

`string`

#### Returns[​](#returns-103 "Direct link to Returns")

`Promise`<`void`\>

### relayMessage()[​](#relaymessage "Direct link to relayMessage()")

> **relayMessage**: (`jid`, `message`, `__namedParameters`) => `Promise`<`string`\>

#### Parameters[​](#parameters-98 "Direct link to Parameters")

##### jid[​](#jid-49 "Direct link to jid")

`string`

##### message[​](#message-1 "Direct link to message")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

##### \_\_namedParameters[​](#__namedparameters-1 "Direct link to __namedParameters")

[`MessageRelayOptions`](/docs/api/type-aliases/MessageRelayOptions)

#### Returns[​](#returns-104 "Direct link to Returns")

`Promise`<`string`\>

### removeChatLabel()[​](#removechatlabel "Direct link to removeChatLabel()")

> **removeChatLabel**: (`jid`, `labelId`) => `Promise`<`void`\>

Removes label for the chat

#### Parameters[​](#parameters-99 "Direct link to Parameters")

##### jid[​](#jid-50 "Direct link to jid")

`string`

##### labelId[​](#labelid-2 "Direct link to labelId")

`string`

#### Returns[​](#returns-105 "Direct link to Returns")

`Promise`<`void`\>

### removeContact()[​](#removecontact "Direct link to removeContact()")

> **removeContact**: (`jid`) => `Promise`<`void`\>

Remove Contact

#### Parameters[​](#parameters-100 "Direct link to Parameters")

##### jid[​](#jid-51 "Direct link to jid")

`string`

#### Returns[​](#returns-106 "Direct link to Returns")

`Promise`<`void`\>

### removeCoverPhoto()[​](#removecoverphoto "Direct link to removeCoverPhoto()")

> **removeCoverPhoto**: (`id`) => `Promise`<`any`\>

#### Parameters[​](#parameters-101 "Direct link to Parameters")

##### id[​](#id-2 "Direct link to id")

`string`

#### Returns[​](#returns-107 "Direct link to Returns")

`Promise`<`any`\>

### removeMessageLabel()[​](#removemessagelabel "Direct link to removeMessageLabel()")

> **removeMessageLabel**: (`jid`, `messageId`, `labelId`) => `Promise`<`void`\>

Removes label for the message

#### Parameters[​](#parameters-102 "Direct link to Parameters")

##### jid[​](#jid-52 "Direct link to jid")

`string`

##### messageId[​](#messageid-1 "Direct link to messageId")

`string`

##### labelId[​](#labelid-3 "Direct link to labelId")

`string`

#### Returns[​](#returns-108 "Direct link to Returns")

`Promise`<`void`\>

### removeProfilePicture()[​](#removeprofilepicture "Direct link to removeProfilePicture()")

> **removeProfilePicture**: (`jid`) => `Promise`<`void`\>

remove the profile picture for yourself or a group

#### Parameters[​](#parameters-103 "Direct link to Parameters")

##### jid[​](#jid-53 "Direct link to jid")

`string`

#### Returns[​](#returns-109 "Direct link to Returns")

`Promise`<`void`\>

### removeQuickReply()[​](#removequickreply "Direct link to removeQuickReply()")

> **removeQuickReply**: (`timestamp`) => `Promise`<`void`\>

Remove Quick Reply

#### Parameters[​](#parameters-104 "Direct link to Parameters")

##### timestamp[​](#timestamp "Direct link to timestamp")

`string`

#### Returns[​](#returns-110 "Direct link to Returns")

`Promise`<`void`\>

### requestPairingCode()[​](#requestpairingcode "Direct link to requestPairingCode()")

> **requestPairingCode**: (`phoneNumber`, `customPairingCode`?) => `Promise`<`string`\>

#### Parameters[​](#parameters-105 "Direct link to Parameters")

##### phoneNumber[​](#phonenumber-1 "Direct link to phoneNumber")

`string`

##### customPairingCode?[​](#custompairingcode "Direct link to customPairingCode?")

`string`

#### Returns[​](#returns-111 "Direct link to Returns")

`Promise`<`string`\>

### requestPlaceholderResend()[​](#requestplaceholderresend "Direct link to requestPlaceholderResend()")

> **requestPlaceholderResend**: (`messageKey`, `msgData`?) => `Promise`<`undefined` | `string`\>

#### Parameters[​](#parameters-106 "Direct link to Parameters")

##### messageKey[​](#messagekey "Direct link to messageKey")

[`WAMessageKey`](/docs/api/type-aliases/WAMessageKey)

##### msgData?[​](#msgdata "Direct link to msgData?")

`Partial`<[`WAMessage`](/docs/api/type-aliases/WAMessage)\>

#### Returns[​](#returns-112 "Direct link to Returns")

`Promise`<`undefined` | `string`\>

### resyncAppState()[​](#resyncappstate "Direct link to resyncAppState()")

> **resyncAppState**: (...`args`) => `Promise`<`void`\>

#### Parameters[​](#parameters-107 "Direct link to Parameters")

##### args[​](#args-2 "Direct link to args")

...\[readonly (`"critical_unblock_low"` | `"regular_high"` | `"regular_low"` | `"critical_block"` | `"regular"`)\[\], `boolean`\]

#### Returns[​](#returns-113 "Direct link to Returns")

`Promise`<`void`\>

### rotateSignedPreKey()[​](#rotatesignedprekey "Direct link to rotateSignedPreKey()")

> **rotateSignedPreKey**: () => `Promise`<`void`\>

#### Returns[​](#returns-114 "Direct link to Returns")

`Promise`<`void`\>

### sendMessage()[​](#sendmessage "Direct link to sendMessage()")

> **sendMessage**: (`jid`, `content`, `options`) => `Promise`<`undefined` | [`WAMessage`](/docs/api/type-aliases/WAMessage)\>

#### Parameters[​](#parameters-108 "Direct link to Parameters")

##### jid[​](#jid-54 "Direct link to jid")

`string`

##### content[​](#content-1 "Direct link to content")

[`AnyMessageContent`](/docs/api/type-aliases/AnyMessageContent)

##### options[​](#options "Direct link to options")

[`MiscMessageGenerationOptions`](/docs/api/type-aliases/MiscMessageGenerationOptions) = `{}`

#### Returns[​](#returns-115 "Direct link to Returns")

`Promise`<`undefined` | [`WAMessage`](/docs/api/type-aliases/WAMessage)\>

### sendMessageAck()[​](#sendmessageack "Direct link to sendMessageAck()")

> **sendMessageAck**: (`node`, `errorCode`?) => `Promise`<`void`\>

#### Parameters[​](#parameters-109 "Direct link to Parameters")

##### node[​](#node-1 "Direct link to node")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

##### errorCode?[​](#errorcode "Direct link to errorCode?")

`number`

#### Returns[​](#returns-116 "Direct link to Returns")

`Promise`<`void`\>

### sendNode()[​](#sendnode "Direct link to sendNode()")

> **sendNode**: (`frame`) => `Promise`<`void`\>

send a binary node

#### Parameters[​](#parameters-110 "Direct link to Parameters")

##### frame[​](#frame "Direct link to frame")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

#### Returns[​](#returns-117 "Direct link to Returns")

`Promise`<`void`\>

### sendPeerDataOperationMessage()[​](#sendpeerdataoperationmessage "Direct link to sendPeerDataOperationMessage()")

> **sendPeerDataOperationMessage**: (`pdoMessage`) => `Promise`<`string`\>

#### Parameters[​](#parameters-111 "Direct link to Parameters")

##### pdoMessage[​](#pdomessage "Direct link to pdoMessage")

[`IPeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage)

#### Returns[​](#returns-118 "Direct link to Returns")

`Promise`<`string`\>

### sendPresenceUpdate()[​](#sendpresenceupdate "Direct link to sendPresenceUpdate()")

> **sendPresenceUpdate**: (`type`, `toJid`?) => `Promise`<`void`\>

#### Parameters[​](#parameters-112 "Direct link to Parameters")

##### type[​](#type-4 "Direct link to type")

[`WAPresence`](/docs/api/type-aliases/WAPresence)

##### toJid?[​](#tojid-1 "Direct link to toJid?")

`string`

#### Returns[​](#returns-119 "Direct link to Returns")

`Promise`<`void`\>

### sendRawMessage()[​](#sendrawmessage "Direct link to sendRawMessage()")

> **sendRawMessage**: (`data`) => `Promise`<`void`\>

send a raw buffer

#### Parameters[​](#parameters-113 "Direct link to Parameters")

##### data[​](#data "Direct link to data")

`Uint8Array`<`ArrayBufferLike`\> | `Buffer`<`ArrayBufferLike`\>

#### Returns[​](#returns-120 "Direct link to Returns")

`Promise`<`void`\>

### sendReceipt()[​](#sendreceipt "Direct link to sendReceipt()")

> **sendReceipt**: (`jid`, `participant`, `messageIds`, `type`) => `Promise`<`void`\>

generic send receipt function used for receipts of phone call, read, delivery etc.

#### Parameters[​](#parameters-114 "Direct link to Parameters")

##### jid[​](#jid-55 "Direct link to jid")

`string`

##### participant[​](#participant "Direct link to participant")

`undefined` | `string`

##### messageIds[​](#messageids "Direct link to messageIds")

`string`\[\]

##### type[​](#type-5 "Direct link to type")

[`MessageReceiptType`](/docs/api/type-aliases/MessageReceiptType)

#### Returns[​](#returns-121 "Direct link to Returns")

`Promise`<`void`\>

### sendReceipts()[​](#sendreceipts "Direct link to sendReceipts()")

> **sendReceipts**: (`keys`, `type`) => `Promise`<`void`\>

Correctly bulk send receipts to multiple chats, participants

#### Parameters[​](#parameters-115 "Direct link to Parameters")

##### keys[​](#keys-1 "Direct link to keys")

[`WAMessageKey`](/docs/api/type-aliases/WAMessageKey)\[\]

##### type[​](#type-6 "Direct link to type")

[`MessageReceiptType`](/docs/api/type-aliases/MessageReceiptType)

#### Returns[​](#returns-122 "Direct link to Returns")

`Promise`<`void`\>

### sendRetryRequest()[​](#sendretryrequest "Direct link to sendRetryRequest()")

> **sendRetryRequest**: (`node`, `forceIncludeKeys`) => `Promise`<`void`\>

#### Parameters[​](#parameters-116 "Direct link to Parameters")

##### node[​](#node-2 "Direct link to node")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

##### forceIncludeKeys[​](#forceincludekeys "Direct link to forceIncludeKeys")

`boolean` = `false`

#### Returns[​](#returns-123 "Direct link to Returns")

`Promise`<`void`\>

### sendUnifiedSession()[​](#sendunifiedsession "Direct link to sendUnifiedSession()")

> **sendUnifiedSession**: () => `Promise`<`void`\>

#### Returns[​](#returns-124 "Direct link to Returns")

`Promise`<`void`\>

### sendWAMBuffer()[​](#sendwambuffer "Direct link to sendWAMBuffer()")

> **sendWAMBuffer**: (`wamBuffer`) => `Promise`<`any`\>

#### Parameters[​](#parameters-117 "Direct link to Parameters")

##### wamBuffer[​](#wambuffer "Direct link to wamBuffer")

`Buffer`

#### Returns[​](#returns-125 "Direct link to Returns")

`Promise`<`any`\>

### signalRepository[​](#signalrepository "Direct link to signalRepository")

> **signalRepository**: [`SignalRepositoryWithLIDStore`](/docs/api/interfaces/SignalRepositoryWithLIDStore)

### star()[​](#star "Direct link to star()")

> **star**: (`jid`, `messages`, `star`) => `Promise`<`void`\>

Star or Unstar a message

#### Parameters[​](#parameters-118 "Direct link to Parameters")

##### jid[​](#jid-56 "Direct link to jid")

`string`

##### messages[​](#messages "Direct link to messages")

`object`\[\]

##### star[​](#star-1 "Direct link to star")

`boolean`

#### Returns[​](#returns-126 "Direct link to Returns")

`Promise`<`void`\>

### subscribeNewsletterUpdates()[​](#subscribenewsletterupdates "Direct link to subscribeNewsletterUpdates()")

> **subscribeNewsletterUpdates**: (`jid`) => `Promise`<`null` | { `duration`: `string`; }>

#### Parameters[​](#parameters-119 "Direct link to Parameters")

##### jid[​](#jid-57 "Direct link to jid")

`string`

#### Returns[​](#returns-127 "Direct link to Returns")

`Promise`<`null` | { `duration`: `string`; }>

### type[​](#type-7 "Direct link to type")

> **type**: `"md"`

### updateBlockStatus()[​](#updateblockstatus "Direct link to updateBlockStatus()")

> **updateBlockStatus**: (`jid`, `action`) => `Promise`<`void`\>

#### Parameters[​](#parameters-120 "Direct link to Parameters")

##### jid[​](#jid-58 "Direct link to jid")

`string`

##### action[​](#action-4 "Direct link to action")

`"block"` | `"unblock"`

#### Returns[​](#returns-128 "Direct link to Returns")

`Promise`<`void`\>

### updateBussinesProfile()[​](#updatebussinesprofile "Direct link to updateBussinesProfile()")

> **updateBussinesProfile**: (`args`) => `Promise`<`any`\>

#### Parameters[​](#parameters-121 "Direct link to Parameters")

##### args[​](#args-3 "Direct link to args")

`UpdateBussinesProfileProps`

#### Returns[​](#returns-129 "Direct link to Returns")

`Promise`<`any`\>

### updateCallPrivacy()[​](#updatecallprivacy "Direct link to updateCallPrivacy()")

> **updateCallPrivacy**: (`value`) => `Promise`<`void`\>

#### Parameters[​](#parameters-122 "Direct link to Parameters")

##### value[​](#value "Direct link to value")

[`WAPrivacyCallValue`](/docs/api/type-aliases/WAPrivacyCallValue)

#### Returns[​](#returns-130 "Direct link to Returns")

`Promise`<`void`\>

### updateCoverPhoto()[​](#updatecoverphoto "Direct link to updateCoverPhoto()")

> **updateCoverPhoto**: (`photo`) => `Promise`<`number`\>

#### Parameters[​](#parameters-123 "Direct link to Parameters")

##### photo[​](#photo "Direct link to photo")

[`WAMediaUpload`](/docs/api/type-aliases/WAMediaUpload)

#### Returns[​](#returns-131 "Direct link to Returns")

`Promise`<`number`\>

### updateDefaultDisappearingMode()[​](#updatedefaultdisappearingmode "Direct link to updateDefaultDisappearingMode()")

> **updateDefaultDisappearingMode**: (`duration`) => `Promise`<`void`\>

#### Parameters[​](#parameters-124 "Direct link to Parameters")

##### duration[​](#duration "Direct link to duration")

`number`

#### Returns[​](#returns-132 "Direct link to Returns")

`Promise`<`void`\>

### updateDisableLinkPreviewsPrivacy()[​](#updatedisablelinkpreviewsprivacy "Direct link to updateDisableLinkPreviewsPrivacy()")

> **updateDisableLinkPreviewsPrivacy**: (`isPreviewsDisabled`) => `Promise`<`void`\>

Enable/Disable link preview privacy, not related to baileys link preview generation

#### Parameters[​](#parameters-125 "Direct link to Parameters")

##### isPreviewsDisabled[​](#ispreviewsdisabled "Direct link to isPreviewsDisabled")

`boolean`

#### Returns[​](#returns-133 "Direct link to Returns")

`Promise`<`void`\>

### updateGroupsAddPrivacy()[​](#updategroupsaddprivacy "Direct link to updateGroupsAddPrivacy()")

> **updateGroupsAddPrivacy**: (`value`) => `Promise`<`void`\>

#### Parameters[​](#parameters-126 "Direct link to Parameters")

##### value[​](#value-1 "Direct link to value")

[`WAPrivacyGroupAddValue`](/docs/api/type-aliases/WAPrivacyGroupAddValue)

#### Returns[​](#returns-134 "Direct link to Returns")

`Promise`<`void`\>

### updateLastSeenPrivacy()[​](#updatelastseenprivacy "Direct link to updateLastSeenPrivacy()")

> **updateLastSeenPrivacy**: (`value`) => `Promise`<`void`\>

#### Parameters[​](#parameters-127 "Direct link to Parameters")

##### value[​](#value-2 "Direct link to value")

[`WAPrivacyValue`](/docs/api/type-aliases/WAPrivacyValue)

#### Returns[​](#returns-135 "Direct link to Returns")

`Promise`<`void`\>

### updateMediaMessage()[​](#updatemediamessage "Direct link to updateMediaMessage()")

> **updateMediaMessage**: (`message`) => `Promise`<[`WAMessage`](/docs/api/type-aliases/WAMessage)\>

#### Parameters[​](#parameters-128 "Direct link to Parameters")

##### message[​](#message-2 "Direct link to message")

[`WAMessage`](/docs/api/type-aliases/WAMessage)

#### Returns[​](#returns-136 "Direct link to Returns")

`Promise`<[`WAMessage`](/docs/api/type-aliases/WAMessage)\>

### updateMemberLabel()[​](#updatememberlabel "Direct link to updateMemberLabel()")

> **updateMemberLabel**: (`jid`, `memberLabel`) => `Promise`<`string`\>

Update Member Label

#### Parameters[​](#parameters-129 "Direct link to Parameters")

##### jid[​](#jid-59 "Direct link to jid")

`string`

##### memberLabel[​](#memberlabel "Direct link to memberLabel")

`string`

#### Returns[​](#returns-137 "Direct link to Returns")

`Promise`<`string`\>

### updateMessagesPrivacy()[​](#updatemessagesprivacy "Direct link to updateMessagesPrivacy()")

> **updateMessagesPrivacy**: (`value`) => `Promise`<`void`\>

#### Parameters[​](#parameters-130 "Direct link to Parameters")

##### value[​](#value-3 "Direct link to value")

[`WAPrivacyMessagesValue`](/docs/api/type-aliases/WAPrivacyMessagesValue)

#### Returns[​](#returns-138 "Direct link to Returns")

`Promise`<`void`\>

### updateOnlinePrivacy()[​](#updateonlineprivacy "Direct link to updateOnlinePrivacy()")

> **updateOnlinePrivacy**: (`value`) => `Promise`<`void`\>

#### Parameters[​](#parameters-131 "Direct link to Parameters")

##### value[​](#value-4 "Direct link to value")

[`WAPrivacyOnlineValue`](/docs/api/type-aliases/WAPrivacyOnlineValue)

#### Returns[​](#returns-139 "Direct link to Returns")

`Promise`<`void`\>

### updateProfileName()[​](#updateprofilename "Direct link to updateProfileName()")

> **updateProfileName**: (`name`) => `Promise`<`void`\>

#### Parameters[​](#parameters-132 "Direct link to Parameters")

##### name[​](#name-2 "Direct link to name")

`string`

#### Returns[​](#returns-140 "Direct link to Returns")

`Promise`<`void`\>

### updateProfilePicture()[​](#updateprofilepicture "Direct link to updateProfilePicture()")

> **updateProfilePicture**: (`jid`, `content`, `dimensions`?) => `Promise`<`void`\>

update the profile picture for yourself or a group

#### Parameters[​](#parameters-133 "Direct link to Parameters")

##### jid[​](#jid-60 "Direct link to jid")

`string`

##### content[​](#content-2 "Direct link to content")

[`WAMediaUpload`](/docs/api/type-aliases/WAMediaUpload)

##### dimensions?[​](#dimensions "Direct link to dimensions?")

###### height[​](#height "Direct link to height")

`number`

###### width[​](#width "Direct link to width")

`number`

#### Returns[​](#returns-141 "Direct link to Returns")

`Promise`<`void`\>

### updateProfilePicturePrivacy()[​](#updateprofilepictureprivacy "Direct link to updateProfilePicturePrivacy()")

> **updateProfilePicturePrivacy**: (`value`) => `Promise`<`void`\>

#### Parameters[​](#parameters-134 "Direct link to Parameters")

##### value[​](#value-5 "Direct link to value")

[`WAPrivacyValue`](/docs/api/type-aliases/WAPrivacyValue)

#### Returns[​](#returns-142 "Direct link to Returns")

`Promise`<`void`\>

### updateProfileStatus()[​](#updateprofilestatus "Direct link to updateProfileStatus()")

> **updateProfileStatus**: (`status`) => `Promise`<`void`\>

update the profile status for yourself

#### Parameters[​](#parameters-135 "Direct link to Parameters")

##### status[​](#status "Direct link to status")

`string`

#### Returns[​](#returns-143 "Direct link to Returns")

`Promise`<`void`\>

### updateReadReceiptsPrivacy()[​](#updatereadreceiptsprivacy "Direct link to updateReadReceiptsPrivacy()")

> **updateReadReceiptsPrivacy**: (`value`) => `Promise`<`void`\>

#### Parameters[​](#parameters-136 "Direct link to Parameters")

##### value[​](#value-6 "Direct link to value")

[`WAReadReceiptsValue`](/docs/api/type-aliases/WAReadReceiptsValue)

#### Returns[​](#returns-144 "Direct link to Returns")

`Promise`<`void`\>

### updateServerTimeOffset()[​](#updateservertimeoffset "Direct link to updateServerTimeOffset()")

> **updateServerTimeOffset**: (`__namedParameters`) => `void`

#### Parameters[​](#parameters-137 "Direct link to Parameters")

##### \_\_namedParameters[​](#__namedparameters-2 "Direct link to __namedParameters")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

#### Returns[​](#returns-145 "Direct link to Returns")

`void`

### updateStatusPrivacy()[​](#updatestatusprivacy "Direct link to updateStatusPrivacy()")

> **updateStatusPrivacy**: (`value`) => `Promise`<`void`\>

#### Parameters[​](#parameters-138 "Direct link to Parameters")

##### value[​](#value-7 "Direct link to value")

[`WAPrivacyValue`](/docs/api/type-aliases/WAPrivacyValue)

#### Returns[​](#returns-146 "Direct link to Returns")

`Promise`<`void`\>

### uploadPreKeys()[​](#uploadprekeys "Direct link to uploadPreKeys()")

> **uploadPreKeys**: (`count`, `retryCount`) => `Promise`<`void`\>

generates and uploads a set of pre-keys to the server

#### Parameters[​](#parameters-139 "Direct link to Parameters")

##### count[​](#count-2 "Direct link to count")

`number` = `MIN_PREKEY_COUNT`

##### retryCount[​](#retrycount "Direct link to retryCount")

`number` = `0`

#### Returns[​](#returns-147 "Direct link to Returns")

`Promise`<`void`\>

### uploadPreKeysToServerIfRequired()[​](#uploadprekeystoserverifrequired "Direct link to uploadPreKeysToServerIfRequired()")

> **uploadPreKeysToServerIfRequired**: () => `Promise`<`void`\>

#### Returns[​](#returns-148 "Direct link to Returns")

`Promise`<`void`\>

### upsertMessage()[​](#upsertmessage "Direct link to upsertMessage()")

> **upsertMessage**: (...`args`) => `Promise`<`void`\>

#### Parameters[​](#parameters-140 "Direct link to Parameters")

##### args[​](#args-4 "Direct link to args")

...\[[`WAMessage`](/docs/api/type-aliases/WAMessage), [`MessageUpsertType`](/docs/api/type-aliases/MessageUpsertType)\]

#### Returns[​](#returns-149 "Direct link to Returns")

`Promise`<`void`\>

### user[​](#user "Direct link to user")

> **user**: `undefined` | [`Contact`](/docs/api/interfaces/Contact)

### waitForConnectionUpdate()[​](#waitforconnectionupdate "Direct link to waitForConnectionUpdate()")

> **waitForConnectionUpdate**: (`check`, `timeoutMs`?) => `Promise`<`void`\>

Waits for the connection to WA to reach a state

#### Parameters[​](#parameters-141 "Direct link to Parameters")

##### check[​](#check "Direct link to check")

(`u`) => `Promise`<`undefined` | `boolean`\>

##### timeoutMs?[​](#timeoutms-3 "Direct link to timeoutMs?")

`number`

#### Returns[​](#returns-150 "Direct link to Returns")

`Promise`<`void`\>

### waitForMessage()[​](#waitformessage "Direct link to waitForMessage()")

> **waitForMessage**: <`T`\>(`msgId`, `timeoutMs`) => `Promise`<`undefined` | `T`\>

Wait for a message with a certain tag to be received

#### Type Parameters[​](#type-parameters-4 "Direct link to Type Parameters")

• **T**

#### Parameters[​](#parameters-142 "Direct link to Parameters")

##### msgId[​](#msgid "Direct link to msgId")

`string`

the message tag to await

##### timeoutMs[​](#timeoutms-4 "Direct link to timeoutMs")

timeout after which the promise will reject

`undefined` | `number`

#### Returns[​](#returns-151 "Direct link to Returns")

`Promise`<`undefined` | `T`\>

### waitForSocketOpen()[​](#waitforsocketopen "Direct link to waitForSocketOpen()")

> **waitForSocketOpen**: () => `Promise`<`void`\>

#### Returns[​](#returns-152 "Direct link to Returns")

`Promise`<`void`\>

### wamBuffer[​](#wambuffer-1 "Direct link to wamBuffer")

> **wamBuffer**: [`BinaryInfo`](/docs/api/classes/BinaryInfo) = `publicWAMBuffer`

### waUploadToServer[​](#wauploadtoserver "Direct link to waUploadToServer")

> **waUploadToServer**: [`WAMediaUploadFunction`](/docs/api/type-aliases/WAMediaUploadFunction)

### ws[​](#ws "Direct link to ws")

> **ws**: `WebSocketClient`

---

<a name="function-mediamessagesha256b64-"></a>

> Source: [https://baileys.wiki/docs/api/functions/mediaMessageSHA256B64](https://baileys.wiki/docs/api/functions/mediaMessageSHA256B64)

> **mediaMessageSHA256B64**(`message`): `undefined` | `null` | `string`

Defined in: [src/Utils/messages-media.ts:219](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L219)

gets the SHA256 of the given media message

## Parameters[​](#parameters "Direct link to Parameters")

### message[​](#message "Direct link to message")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

## Returns[​](#returns "Direct link to Returns")

`undefined` | `null` | `string`

---

<a name="function-newlthashstate-"></a>

> Source: [https://baileys.wiki/docs/api/functions/newLTHashState](https://baileys.wiki/docs/api/functions/newLTHashState)

> **newLTHashState**(): [`LTHashState`](/docs/api/type-aliases/LTHashState)

Defined in: [src/Utils/chat-utils.ts:130](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/chat-utils.ts#L130)

## Returns[​](#returns "Direct link to Returns")

[`LTHashState`](/docs/api/type-aliases/LTHashState)

---

<a name="function-normalizemessagecontent-"></a>

> Source: [https://baileys.wiki/docs/api/functions/normalizeMessageContent](https://baileys.wiki/docs/api/functions/normalizeMessageContent)

> **normalizeMessageContent**(`content`): `undefined` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [src/Utils/messages.ts:773](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L773)

Normalizes ephemeral, view once messages to regular message content Eg. image messages in ephemeral messages, in view once messages etc.

## Parameters[​](#parameters "Direct link to Parameters")

### content[​](#content "Direct link to content")

`undefined` | `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

## Returns[​](#returns "Direct link to Returns")

`undefined` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

---

<a name="function-parseandinjecte2esessions-"></a>

> Source: [https://baileys.wiki/docs/api/functions/parseAndInjectE2ESessions](https://baileys.wiki/docs/api/functions/parseAndInjectE2ESessions)

> **parseAndInjectE2ESessions**(`node`, `repository`): `Promise`<`void`\>

Defined in: [src/Utils/signal.ts:90](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/signal.ts#L90)

## Parameters[​](#parameters "Direct link to Parameters")

### node[​](#node "Direct link to node")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

### repository[​](#repository "Direct link to repository")

[`SignalRepositoryWithLIDStore`](/docs/api/interfaces/SignalRepositoryWithLIDStore)

## Returns[​](#returns "Direct link to Returns")

`Promise`<`void`\>

---

<a name="function-preparedisappearingmessagesettingcontent-"></a>

> Source: [https://baileys.wiki/docs/api/functions/prepareDisappearingMessageSettingContent](https://baileys.wiki/docs/api/functions/prepareDisappearingMessageSettingContent)

> **prepareDisappearingMessageSettingContent**(`ephemeralExpiration`?): [`Message`](/docs/api/namespaces/proto/classes/Message)

Defined in: [src/Utils/messages.ts:327](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L327)

## Parameters[​](#parameters "Direct link to Parameters")

### ephemeralExpiration?[​](#ephemeralexpiration "Direct link to ephemeralExpiration?")

`number`

## Returns[​](#returns "Direct link to Returns")

[`Message`](/docs/api/namespaces/proto/classes/Message)

---

<a name="function-preparewamessagemedia-"></a>

> Source: [https://baileys.wiki/docs/api/functions/prepareWAMessageMedia](https://baileys.wiki/docs/api/functions/prepareWAMessageMedia)

> **prepareWAMessageMedia**(`message`, `options`): `Promise`<[`Message`](/docs/api/namespaces/proto/classes/Message)\>

Defined in: [src/Utils/messages.ts:124](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L124)

## Parameters[​](#parameters "Direct link to Parameters")

### message[​](#message "Direct link to message")

[`AnyMediaMessageContent`](/docs/api/type-aliases/AnyMediaMessageContent)

### options[​](#options "Direct link to options")

[`MessageContentGenerationOptions`](/docs/api/type-aliases/MessageContentGenerationOptions)

## Returns[​](#returns "Direct link to Returns")

`Promise`<[`Message`](/docs/api/namespaces/proto/classes/Message)\>

---

<a name="function-processhistorymessage-"></a>

> Source: [https://baileys.wiki/docs/api/functions/processHistoryMessage](https://baileys.wiki/docs/api/functions/processHistoryMessage)

> **processHistoryMessage**(`item`, `logger`?): `object`

Defined in: [src/Utils/history.ts:48](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/history.ts#L48)

## Parameters[​](#parameters "Direct link to Parameters")

### item[​](#item "Direct link to item")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync)

### logger?[​](#logger "Direct link to logger?")

`ILogger`

## Returns[​](#returns "Direct link to Returns")

`object`

### chats[​](#chats "Direct link to chats")

> **chats**: [`Chat`](/docs/api/type-aliases/Chat)\[\]

### contacts[​](#contacts "Direct link to contacts")

> **contacts**: [`Contact`](/docs/api/interfaces/Contact)\[\]

### lidPnMappings[​](#lidpnmappings "Direct link to lidPnMappings")

> **lidPnMappings**: [`LIDMapping`](/docs/api/type-aliases/LIDMapping)\[\]

### messages[​](#messages "Direct link to messages")

> **messages**: [`WAMessage`](/docs/api/type-aliases/WAMessage)\[\]

### progress[​](#progress "Direct link to progress")

> **progress**: `undefined` | `null` | `number` = `item.progress`

### syncType[​](#synctype "Direct link to syncType")

> **syncType**: `undefined` | `null` | [`HistorySyncType`](/docs/api/namespaces/proto/namespaces/HistorySync/enumerations/HistorySyncType) = `item.syncType`

---

<a name="function-processsyncaction-"></a>

> Source: [https://baileys.wiki/docs/api/functions/processSyncAction](https://baileys.wiki/docs/api/functions/processSyncAction)

> **processSyncAction**(`syncAction`, `ev`, `me`, `initialSyncOpts`?, `logger`?): `void`

Defined in: [src/Utils/chat-utils.ts:758](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/chat-utils.ts#L758)

## Parameters[​](#parameters "Direct link to Parameters")

### syncAction[​](#syncaction "Direct link to syncAction")

[`ChatMutation`](/docs/api/type-aliases/ChatMutation)

### ev[​](#ev "Direct link to ev")

[`BaileysEventEmitter`](/docs/api/interfaces/BaileysEventEmitter)

### me[​](#me "Direct link to me")

[`Contact`](/docs/api/interfaces/Contact)

### initialSyncOpts?[​](#initialsyncopts "Direct link to initialSyncOpts?")

[`InitialAppStateSyncOptions`](/docs/api/type-aliases/InitialAppStateSyncOptions)

### logger?[​](#logger "Direct link to logger?")

`ILogger`

## Returns[​](#returns "Direct link to Returns")

`void`

---

<a name="function-promisetimeout-"></a>

> Source: [https://baileys.wiki/docs/api/functions/promiseTimeout](https://baileys.wiki/docs/api/functions/promiseTimeout)

> **promiseTimeout**<`T`\>(`ms`, `promise`): `Promise`<`T`\>

Defined in: [src/Utils/generics.ts:150](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L150)

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

• **T**

## Parameters[​](#parameters "Direct link to Parameters")

### ms[​](#ms "Direct link to ms")

`undefined` | `number`

### promise[​](#promise "Direct link to promise")

(`resolve`, `reject`) => `void`

## Returns[​](#returns "Direct link to Returns")

`Promise`<`T`\>

---

<a name="function-reducebinarynodetodictionary-"></a>

> Source: [https://baileys.wiki/docs/api/functions/reduceBinaryNodeToDictionary](https://baileys.wiki/docs/api/functions/reduceBinaryNodeToDictionary)

> **reduceBinaryNodeToDictionary**(`node`, `tag`): `object`

Defined in: [src/WABinary/generic-utils.ts:73](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/generic-utils.ts#L73)

## Parameters[​](#parameters "Direct link to Parameters")

### node[​](#node "Direct link to node")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

### tag[​](#tag "Direct link to tag")

`string`

## Returns[​](#returns "Direct link to Returns")

`object`

---

<a name="function-sha256-"></a>

> Source: [https://baileys.wiki/docs/api/functions/sha256](https://baileys.wiki/docs/api/functions/sha256)

> **sha256**(`buffer`): `Buffer`<`ArrayBufferLike`\>

Defined in: [src/Utils/crypto.ts:118](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/crypto.ts#L118)

## Parameters[​](#parameters "Direct link to Parameters")

### buffer[​](#buffer "Direct link to buffer")

`Buffer`

## Returns[​](#returns "Direct link to Returns")

`Buffer`<`ArrayBufferLike`\>

---

<a name="function-shouldincrementchatunread-"></a>

> Source: [https://baileys.wiki/docs/api/functions/shouldIncrementChatUnread](https://baileys.wiki/docs/api/functions/shouldIncrementChatUnread)

> **shouldIncrementChatUnread**(`message`): `boolean`

Defined in: [src/Utils/process-message.ts:125](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/process-message.ts#L125)

## Parameters[​](#parameters "Direct link to Parameters")

### message[​](#message "Direct link to message")

[`WAMessage`](/docs/api/type-aliases/WAMessage)

## Returns[​](#returns "Direct link to Returns")

`boolean`

---

<a name="function-signedkeypair-"></a>

> Source: [https://baileys.wiki/docs/api/functions/signedKeyPair](https://baileys.wiki/docs/api/functions/signedKeyPair)

> **signedKeyPair**(`identityKeyPair`, `keyId`): `object`

Defined in: [src/Utils/crypto.ts:38](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/crypto.ts#L38)

## Parameters[​](#parameters "Direct link to Parameters")

### identityKeyPair[​](#identitykeypair "Direct link to identityKeyPair")

[`KeyPair`](/docs/api/type-aliases/KeyPair)

### keyId[​](#keyid "Direct link to keyId")

`number`

## Returns[​](#returns "Direct link to Returns")

`object`

### keyId[​](#keyid-1 "Direct link to keyId")

> **keyId**: `number`

### keyPair[​](#keypair "Direct link to keyPair")

> **keyPair**: [`KeyPair`](/docs/api/type-aliases/KeyPair) = `preKey`

### signature[​](#signature "Direct link to signature")

> **signature**: `Uint8Array`<`ArrayBufferLike`\>

---

<a name="function-tobuffer-"></a>

> Source: [https://baileys.wiki/docs/api/functions/toBuffer](https://baileys.wiki/docs/api/functions/toBuffer)

> **toBuffer**(`stream`): `Promise`<`Buffer`<`ArrayBuffer`\>>

Defined in: [src/Utils/messages-media.ts:294](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L294)

## Parameters[​](#parameters "Direct link to Parameters")

### stream[​](#stream "Direct link to stream")

`Readable`

## Returns[​](#returns "Direct link to Returns")

`Promise`<`Buffer`<`ArrayBuffer`\>>

---

<a name="function-tonumber-"></a>

> Source: [https://baileys.wiki/docs/api/functions/toNumber](https://baileys.wiki/docs/api/functions/toNumber)

> **toNumber**(`t`): `number`

Defined in: [src/Utils/generics.ts:99](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L99)

## Parameters[​](#parameters "Direct link to Parameters")

### t[​](#t "Direct link to t")

`undefined` | `null` | `number` | `Long`

## Returns[​](#returns "Direct link to Returns")

`number`

---

<a name="function-toreadable-"></a>

> Source: [https://baileys.wiki/docs/api/functions/toReadable](https://baileys.wiki/docs/api/functions/toReadable)

> **toReadable**(`buffer`): `Readable`

Defined in: [src/Utils/messages-media.ts:287](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L287)

## Parameters[​](#parameters "Direct link to Parameters")

### buffer[​](#buffer "Direct link to buffer")

`Buffer`

## Returns[​](#returns "Direct link to Returns")

`Readable`

---

<a name="function-transferdevice-"></a>

> Source: [https://baileys.wiki/docs/api/functions/transferDevice](https://baileys.wiki/docs/api/functions/transferDevice)

> **transferDevice**(`fromJid`, `toJid`): `string`

Defined in: [src/WABinary/jid-utils.ts:123](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L123)

## Parameters[​](#parameters "Direct link to Parameters")

### fromJid[​](#fromjid "Direct link to fromJid")

`string`

### toJid[​](#tojid "Direct link to toJid")

`string`

## Returns[​](#returns "Direct link to Returns")

`string`

---

<a name="function-trimundefined-"></a>

> Source: [https://baileys.wiki/docs/api/functions/trimUndefined](https://baileys.wiki/docs/api/functions/trimUndefined)

> **trimUndefined**(`obj`): `object`

Defined in: [src/Utils/generics.ts:438](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L438)

## Parameters[​](#parameters "Direct link to Parameters")

### obj[​](#obj "Direct link to obj")

## Returns[​](#returns "Direct link to Returns")

`object`

---

<a name="function-unixtimestampseconds-"></a>

> Source: [https://baileys.wiki/docs/api/functions/unixTimestampSeconds](https://baileys.wiki/docs/api/functions/unixTimestampSeconds)

> **unixTimestampSeconds**(`date`): `number`

Defined in: [src/Utils/generics.ts:103](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L103)

unix timestamp of a date in seconds

## Parameters[​](#parameters "Direct link to Parameters")

### date[​](#date "Direct link to date")

`Date` = `...`

## Returns[​](#returns "Direct link to Returns")

`number`

---

<a name="function-unpadrandommax16-"></a>

> Source: [https://baileys.wiki/docs/api/functions/unpadRandomMax16](https://baileys.wiki/docs/api/functions/unpadRandomMax16)

> **unpadRandomMax16**(`e`): `Uint8Array`<`ArrayBuffer`\>

Defined in: [src/Utils/generics.ts:61](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L61)

## Parameters[​](#parameters "Direct link to Parameters")

### e[​](#e "Direct link to e")

`Uint8Array`<`ArrayBufferLike`\> | `Buffer`<`ArrayBufferLike`\>

## Returns[​](#returns "Direct link to Returns")

`Uint8Array`<`ArrayBuffer`\>

---

<a name="function-updatemessagewitheventresponse-"></a>

> Source: [https://baileys.wiki/docs/api/functions/updateMessageWithEventResponse](https://baileys.wiki/docs/api/functions/updateMessageWithEventResponse)

> **updateMessageWithEventResponse**(`msg`, `update`): `void`

Defined in: [src/Utils/messages.ts:898](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L898)

Update the message with a new event response

## Parameters[​](#parameters "Direct link to Parameters")

### msg[​](#msg "Direct link to msg")

`Pick`<[`WAMessage`](/docs/api/type-aliases/WAMessage), `"eventResponses"`\>

### update[​](#update "Direct link to update")

[`IEventResponse`](/docs/api/namespaces/proto/interfaces/IEventResponse)

## Returns[​](#returns "Direct link to Returns")

`void`

---

<a name="function-updatemessagewithpollupdate-"></a>

> Source: [https://baileys.wiki/docs/api/functions/updateMessageWithPollUpdate](https://baileys.wiki/docs/api/functions/updateMessageWithPollUpdate)

> **updateMessageWithPollUpdate**(`msg`, `update`): `void`

Defined in: [src/Utils/messages.ts:886](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L886)

Update the message with a new poll update

## Parameters[​](#parameters "Direct link to Parameters")

### msg[​](#msg "Direct link to msg")

`Pick`<[`WAMessage`](/docs/api/type-aliases/WAMessage), `"pollUpdates"`\>

### update[​](#update "Direct link to update")

[`IPollUpdate`](/docs/api/namespaces/proto/interfaces/IPollUpdate)

## Returns[​](#returns "Direct link to Returns")

`void`

---

<a name="function-updatemessagewithreaction-"></a>

> Source: [https://baileys.wiki/docs/api/functions/updateMessageWithReaction](https://baileys.wiki/docs/api/functions/updateMessageWithReaction)

> **updateMessageWithReaction**(`msg`, `reaction`): `void`

Defined in: [src/Utils/messages.ts:876](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L876)

Update the message with a new reaction

## Parameters[​](#parameters "Direct link to Parameters")

### msg[​](#msg "Direct link to msg")

`Pick`<[`WAMessage`](/docs/api/type-aliases/WAMessage), `"reactions"`\>

### reaction[​](#reaction "Direct link to reaction")

[`IReaction`](/docs/api/namespaces/proto/interfaces/IReaction)

## Returns[​](#returns "Direct link to Returns")

`void`

---

<a name="function-updatemessagewithreceipt-"></a>

> Source: [https://baileys.wiki/docs/api/functions/updateMessageWithReceipt](https://baileys.wiki/docs/api/functions/updateMessageWithReceipt)

> **updateMessageWithReceipt**(`msg`, `receipt`): `void`

Defined in: [src/Utils/messages.ts:865](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages.ts#L865)

Upserts a receipt in the message

## Parameters[​](#parameters "Direct link to Parameters")

### msg[​](#msg "Direct link to msg")

`Pick`<[`WAMessage`](/docs/api/type-aliases/WAMessage), `"userReceipt"`\>

### receipt[​](#receipt "Direct link to receipt")

[`IUserReceipt`](/docs/api/namespaces/proto/interfaces/IUserReceipt)

## Returns[​](#returns "Direct link to Returns")

`void`

---

<a name="function-uploadwithnodehttp-"></a>

> Source: [https://baileys.wiki/docs/api/functions/uploadWithNodeHttp](https://baileys.wiki/docs/api/functions/uploadWithNodeHttp)

> **uploadWithNodeHttp**(`__namedParameters`, `redirectCount`): `Promise`<`undefined` | `MediaUploadResult`\>

Defined in: [src/Utils/messages-media.ts:679](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L679)

## Parameters[​](#parameters "Direct link to Parameters")

### \_\_namedParameters[​](#__namedparameters "Direct link to __namedParameters")

[`UploadParams`](/docs/api/type-aliases/UploadParams)

### redirectCount[​](#redirectcount "Direct link to redirectCount")

`number` = `0`

## Returns[​](#returns "Direct link to Returns")

`Promise`<`undefined` | `MediaUploadResult`\>

---

<a name="function-usemultifileauthstate-"></a>

> Source: [https://baileys.wiki/docs/api/functions/useMultiFileAuthState](https://baileys.wiki/docs/api/functions/useMultiFileAuthState)

> **useMultiFileAuthState**(`folder`): `Promise`<{ `saveCreds`: () => `Promise`<`void`\>; `state`: [`AuthenticationState`](/docs/api/type-aliases/AuthenticationState); }>

Defined in: [src/Utils/use-multi-file-auth-state.ts:33](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/use-multi-file-auth-state.ts#L33)

stores the full authentication state in a single folder. Far more efficient than singlefileauthstate

Again, I wouldn't endorse this for any production level use other than perhaps a bot. Would recommend writing an auth state for use with a proper SQL or No-SQL DB

## Parameters[​](#parameters "Direct link to Parameters")

### folder[​](#folder "Direct link to folder")

`string`

## Returns[​](#returns "Direct link to Returns")

`Promise`<{ `saveCreds`: () => `Promise`<`void`\>; `state`: [`AuthenticationState`](/docs/api/type-aliases/AuthenticationState); }>

---

<a name="function-writerandompadmax16-"></a>

> Source: [https://baileys.wiki/docs/api/functions/writeRandomPadMax16](https://baileys.wiki/docs/api/functions/writeRandomPadMax16)

> **writeRandomPadMax16**(`msg`): `Buffer`<`ArrayBuffer`\>

Defined in: [src/Utils/generics.ts:54](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L54)

## Parameters[​](#parameters "Direct link to Parameters")

### msg[​](#msg "Direct link to msg")

`Uint8Array`

## Returns[​](#returns "Direct link to Returns")

`Buffer`<`ArrayBuffer`\>

---

<a name="function-xmppprekey-"></a>

> Source: [https://baileys.wiki/docs/api/functions/xmppPreKey](https://baileys.wiki/docs/api/functions/xmppPreKey)

> **xmppPreKey**(`pair`, `id`): [`BinaryNode`](/docs/api/type-aliases/BinaryNode)

Defined in: [src/Utils/signal.ts:81](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/signal.ts#L81)

## Parameters[​](#parameters "Direct link to Parameters")

### pair[​](#pair "Direct link to pair")

[`KeyPair`](/docs/api/type-aliases/KeyPair)

### id[​](#id "Direct link to id")

`number`

## Returns[​](#returns "Direct link to Returns")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

---

<a name="function-xmppsignedprekey-"></a>

> Source: [https://baileys.wiki/docs/api/functions/xmppSignedPreKey](https://baileys.wiki/docs/api/functions/xmppSignedPreKey)

> **xmppSignedPreKey**(`key`): [`BinaryNode`](/docs/api/type-aliases/BinaryNode)

Defined in: [src/Utils/signal.ts:71](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/signal.ts#L71)

## Parameters[​](#parameters "Direct link to Parameters")

### key[​](#key "Direct link to key")

[`SignedKeyPair`](/docs/api/type-aliases/SignedKeyPair)

## Returns[​](#returns "Direct link to Returns")

[`BinaryNode`](/docs/api/type-aliases/BinaryNode)

---

<a name="interface-baileyseventemitter"></a>

> Source: [https://baileys.wiki/docs/api/interfaces/BaileysEventEmitter](https://baileys.wiki/docs/api/interfaces/BaileysEventEmitter)

Defined in: [src/Types/Events.ts:154](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Events.ts#L154)

## Methods[​](#methods "Direct link to Methods")

### emit()[​](#emit "Direct link to emit()")

> **emit**<`T`\>(`event`, `arg`): `boolean`

Defined in: [src/Types/Events.ts:158](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Events.ts#L158)

#### Type Parameters[​](#type-parameters "Direct link to Type Parameters")

• **T** _extends_ keyof [`BaileysEventMap`](/docs/api/type-aliases/BaileysEventMap)

#### Parameters[​](#parameters "Direct link to Parameters")

##### event[​](#event "Direct link to event")

`T`

##### arg[​](#arg "Direct link to arg")

[`BaileysEventMap`](/docs/api/type-aliases/BaileysEventMap)\[`T`\]

#### Returns[​](#returns "Direct link to Returns")

`boolean`

* * *

### off()[​](#off "Direct link to off()")

> **off**<`T`\>(`event`, `listener`): `void`

Defined in: [src/Types/Events.ts:156](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Events.ts#L156)

#### Type Parameters[​](#type-parameters-1 "Direct link to Type Parameters")

• **T** _extends_ keyof [`BaileysEventMap`](/docs/api/type-aliases/BaileysEventMap)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### event[​](#event-1 "Direct link to event")

`T`

##### listener[​](#listener "Direct link to listener")

(`arg`) => `void`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

* * *

### on()[​](#on "Direct link to on()")

> **on**<`T`\>(`event`, `listener`): `void`

Defined in: [src/Types/Events.ts:155](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Events.ts#L155)

#### Type Parameters[​](#type-parameters-2 "Direct link to Type Parameters")

• **T** _extends_ keyof [`BaileysEventMap`](/docs/api/type-aliases/BaileysEventMap)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### event[​](#event-2 "Direct link to event")

`T`

##### listener[​](#listener-1 "Direct link to listener")

(`arg`) => `void`

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

* * *

### removeAllListeners()[​](#removealllisteners "Direct link to removeAllListeners()")

> **removeAllListeners**<`T`\>(`event`): `void`

Defined in: [src/Types/Events.ts:157](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Events.ts#L157)

#### Type Parameters[​](#type-parameters-3 "Direct link to Type Parameters")

• **T** _extends_ keyof [`BaileysEventMap`](/docs/api/type-aliases/BaileysEventMap)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### event[​](#event-3 "Direct link to event")

`T`

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

---

<a name="interface-contact"></a>

> Source: [https://baileys.wiki/docs/api/interfaces/Contact](https://baileys.wiki/docs/api/interfaces/Contact)

Defined in: [src/Types/Contact.ts:1](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Contact.ts#L1)

## Properties[​](#properties "Direct link to Properties")

### id[​](#id "Direct link to id")

> **id**: `string`

Defined in: [src/Types/Contact.ts:3](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Contact.ts#L3)

ID either in lid or jid format (preferred) \*

* * *

### imgUrl?[​](#imgurl "Direct link to imgUrl?")

> `optional` **imgUrl**: `null` | `string`

Defined in: [src/Types/Contact.ts:22](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Contact.ts#L22)

Url of the profile picture of the contact

'changed' => if the profile picture has changed null => if the profile picture has not been set (default profile picture) any other string => url of the profile picture

* * *

### lid?[​](#lid "Direct link to lid?")

> `optional` **lid**: `string`

Defined in: [src/Types/Contact.ts:5](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Contact.ts#L5)

ID in LID format (@lid) \*

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

Defined in: [src/Types/Contact.ts:9](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Contact.ts#L9)

name of the contact, you have saved on your WA

* * *

### notify?[​](#notify "Direct link to notify?")

> `optional` **notify**: `string`

Defined in: [src/Types/Contact.ts:11](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Contact.ts#L11)

name of the contact, the contact has set on their own on WA

* * *

### phoneNumber?[​](#phonenumber "Direct link to phoneNumber?")

> `optional` **phoneNumber**: `string`

Defined in: [src/Types/Contact.ts:7](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Contact.ts#L7)

ID in PN format (@s.whatsapp.net) \*

* * *

### status?[​](#status "Direct link to status?")

> `optional` **status**: `string`

Defined in: [src/Types/Contact.ts:23](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Contact.ts#L23)

* * *

### verifiedName?[​](#verifiedname "Direct link to verifiedName?")

> `optional` **verifiedName**: `string`

Defined in: [src/Types/Contact.ts:13](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Contact.ts#L13)

I have no idea

---

<a name="interface-groupmetadata"></a>

> Source: [https://baileys.wiki/docs/api/interfaces/GroupMetadata](https://baileys.wiki/docs/api/interfaces/GroupMetadata)

Defined in: [src/Types/GroupMetadata.ts:16](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L16)

## Properties[​](#properties "Direct link to Properties")

### addressingMode?[​](#addressingmode "Direct link to addressingMode?")

> `optional` **addressingMode**: [`WAMessageAddressingMode`](/docs/api/enumerations/WAMessageAddressingMode)

Defined in: [src/Types/GroupMetadata.ts:20](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L20)

group uses 'lid' or 'pn' to send messages

* * *

### announce?[​](#announce "Direct link to announce?")

> `optional` **announce**: `boolean`

Defined in: [src/Types/GroupMetadata.ts:41](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L41)

is set when the group only allows admins to write messages

* * *

### author?[​](#author "Direct link to author?")

> `optional` **author**: `string`

Defined in: [src/Types/GroupMetadata.ts:57](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L57)

the person who added you to group or changed some setting in group

* * *

### authorPn?[​](#authorpn "Direct link to authorPn?")

> `optional` **authorPn**: `string`

Defined in: [src/Types/GroupMetadata.ts:58](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L58)

* * *

### creation?[​](#creation "Direct link to creation?")

> `optional` **creation**: `number`

Defined in: [src/Types/GroupMetadata.ts:30](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L30)

* * *

### desc?[​](#desc "Direct link to desc?")

> `optional` **desc**: `string`

Defined in: [src/Types/GroupMetadata.ts:31](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L31)

* * *

### descId?[​](#descid "Direct link to descId?")

> `optional` **descId**: `string`

Defined in: [src/Types/GroupMetadata.ts:34](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L34)

* * *

### descOwner?[​](#descowner "Direct link to descOwner?")

> `optional` **descOwner**: `string`

Defined in: [src/Types/GroupMetadata.ts:32](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L32)

* * *

### descOwnerPn?[​](#descownerpn "Direct link to descOwnerPn?")

> `optional` **descOwnerPn**: `string`

Defined in: [src/Types/GroupMetadata.ts:33](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L33)

* * *

### descTime?[​](#desctime "Direct link to descTime?")

> `optional` **descTime**: `number`

Defined in: [src/Types/GroupMetadata.ts:35](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L35)

* * *

### ephemeralDuration?[​](#ephemeralduration "Direct link to ephemeralDuration?")

> `optional` **ephemeralDuration**: `number`

Defined in: [src/Types/GroupMetadata.ts:54](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L54)

* * *

### id[​](#id "Direct link to id")

> **id**: `string`

Defined in: [src/Types/GroupMetadata.ts:17](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L17)

* * *

### inviteCode?[​](#invitecode "Direct link to inviteCode?")

> `optional` **inviteCode**: `string`

Defined in: [src/Types/GroupMetadata.ts:55](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L55)

* * *

### isCommunity?[​](#iscommunity "Direct link to isCommunity?")

> `optional` **isCommunity**: `boolean`

Defined in: [src/Types/GroupMetadata.ts:47](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L47)

is this a community

* * *

### isCommunityAnnounce?[​](#iscommunityannounce "Direct link to isCommunityAnnounce?")

> `optional` **isCommunityAnnounce**: `boolean`

Defined in: [src/Types/GroupMetadata.ts:49](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L49)

is this the announce of a community

* * *

### joinApprovalMode?[​](#joinapprovalmode "Direct link to joinApprovalMode?")

> `optional` **joinApprovalMode**: `boolean`

Defined in: [src/Types/GroupMetadata.ts:45](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L45)

Request approval to join the group

* * *

### linkedParent?[​](#linkedparent "Direct link to linkedParent?")

> `optional` **linkedParent**: `string`

Defined in: [src/Types/GroupMetadata.ts:37](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L37)

if this group is part of a community, it returns the jid of the community to which it belongs

* * *

### memberAddMode?[​](#memberaddmode "Direct link to memberAddMode?")

> `optional` **memberAddMode**: `boolean`

Defined in: [src/Types/GroupMetadata.ts:43](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L43)

is set when the group also allows members to add participants

* * *

### notify?[​](#notify "Direct link to notify?")

> `optional` **notify**: `string`

Defined in: [src/Types/GroupMetadata.ts:18](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L18)

* * *

### owner[​](#owner "Direct link to owner")

> **owner**: `undefined` | `string`

Defined in: [src/Types/GroupMetadata.ts:21](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L21)

* * *

### owner\_country\_code?[​](#owner_country_code "Direct link to owner_country_code?")

> `optional` **owner\_country\_code**: `string`

Defined in: [src/Types/GroupMetadata.ts:23](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L23)

* * *

### ownerPn?[​](#ownerpn "Direct link to ownerPn?")

> `optional` **ownerPn**: `string`

Defined in: [src/Types/GroupMetadata.ts:22](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L22)

* * *

### participants[​](#participants "Direct link to participants")

> **participants**: [`GroupParticipant`](/docs/api/type-aliases/GroupParticipant)\[\]

Defined in: [src/Types/GroupMetadata.ts:53](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L53)

* * *

### restrict?[​](#restrict "Direct link to restrict?")

> `optional` **restrict**: `boolean`

Defined in: [src/Types/GroupMetadata.ts:39](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L39)

is set when the group only allows admins to change group settings

* * *

### size?[​](#size "Direct link to size?")

> `optional` **size**: `number`

Defined in: [src/Types/GroupMetadata.ts:51](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L51)

number of group participants

* * *

### subject[​](#subject "Direct link to subject")

> **subject**: `string`

Defined in: [src/Types/GroupMetadata.ts:24](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L24)

* * *

### subjectOwner?[​](#subjectowner "Direct link to subjectOwner?")

> `optional` **subjectOwner**: `string`

Defined in: [src/Types/GroupMetadata.ts:26](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L26)

group subject owner

* * *

### subjectOwnerPn?[​](#subjectownerpn "Direct link to subjectOwnerPn?")

> `optional` **subjectOwnerPn**: `string`

Defined in: [src/Types/GroupMetadata.ts:27](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L27)

* * *

### subjectTime?[​](#subjecttime "Direct link to subjectTime?")

> `optional` **subjectTime**: `number`

Defined in: [src/Types/GroupMetadata.ts:29](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L29)

group subject modification date

---

<a name="interface-groupmodificationresponse"></a>

> Source: [https://baileys.wiki/docs/api/interfaces/GroupModificationResponse](https://baileys.wiki/docs/api/interfaces/GroupModificationResponse)

Defined in: [src/Types/GroupMetadata.ts:67](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L67)

## Properties[​](#properties "Direct link to Properties")

### participants?[​](#participants "Direct link to participants?")

> `optional` **participants**: `object`

Defined in: [src/Types/GroupMetadata.ts:69](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L69)

#### Index Signature[​](#index-signature "Direct link to Index Signature")

\[`key`: `string`\]: `object`

* * *

### status[​](#status "Direct link to status")

> **status**: `number`

Defined in: [src/Types/GroupMetadata.ts:68](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L68)

---

<a name="interface-newslettercreateresponse"></a>

> Source: [https://baileys.wiki/docs/api/interfaces/NewsletterCreateResponse](https://baileys.wiki/docs/api/interfaces/NewsletterCreateResponse)

Defined in: [src/Types/Newsletter.ts:34](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L34)

## Properties[​](#properties "Direct link to Properties")

### id[​](#id "Direct link to id")

> **id**: `string`

Defined in: [src/Types/Newsletter.ts:35](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L35)

* * *

### state[​](#state "Direct link to state")

> **state**: `object`

Defined in: [src/Types/Newsletter.ts:36](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L36)

#### type[​](#type "Direct link to type")

> **type**: `string`

* * *

### thread\_metadata[​](#thread_metadata "Direct link to thread_metadata")

> **thread\_metadata**: `object`

Defined in: [src/Types/Newsletter.ts:37](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L37)

#### creation\_time[​](#creation_time "Direct link to creation_time")

> **creation\_time**: `string`

#### description[​](#description "Direct link to description")

> **description**: `object`

##### description.id[​](#descriptionid "Direct link to description.id")

> **id**: `string`

##### description.text[​](#descriptiontext "Direct link to description.text")

> **text**: `string`

##### description.update\_time[​](#descriptionupdate_time "Direct link to description.update_time")

> **update\_time**: `string`

#### handle[​](#handle "Direct link to handle")

> **handle**: `null` | `string`

#### invite[​](#invite "Direct link to invite")

> **invite**: `string`

#### name[​](#name "Direct link to name")

> **name**: `object`

##### name.id[​](#nameid "Direct link to name.id")

> **id**: `string`

##### name.text[​](#nametext "Direct link to name.text")

> **text**: `string`

##### name.update\_time[​](#nameupdate_time "Direct link to name.update_time")

> **update\_time**: `string`

#### picture[​](#picture "Direct link to picture")

> **picture**: `object`

##### picture.direct\_path[​](#picturedirect_path "Direct link to picture.direct_path")

> **direct\_path**: `string`

##### picture.id[​](#pictureid "Direct link to picture.id")

> **id**: `string`

##### picture.type[​](#picturetype "Direct link to picture.type")

> **type**: `string`

#### preview[​](#preview "Direct link to preview")

> **preview**: `object`

##### preview.direct\_path[​](#previewdirect_path "Direct link to preview.direct_path")

> **direct\_path**: `string`

##### preview.id[​](#previewid "Direct link to preview.id")

> **id**: `string`

##### preview.type[​](#previewtype "Direct link to preview.type")

> **type**: `string`

#### subscribers\_count[​](#subscribers_count "Direct link to subscribers_count")

> **subscribers\_count**: `string`

#### verification[​](#verification "Direct link to verification")

> **verification**: `"VERIFIED"` | `"UNVERIFIED"`

* * *

### viewer\_metadata[​](#viewer_metadata "Direct link to viewer_metadata")

> **viewer\_metadata**: `object`

Defined in: [src/Types/Newsletter.ts:48](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L48)

#### mute[​](#mute "Direct link to mute")

> **mute**: `"ON"` | `"OFF"`

#### role[​](#role "Direct link to role")

> **role**: [`NewsletterViewRole`](/docs/api/type-aliases/NewsletterViewRole)

---

<a name="interface-newslettermetadata"></a>

> Source: [https://baileys.wiki/docs/api/interfaces/NewsletterMetadata](https://baileys.wiki/docs/api/interfaces/NewsletterMetadata)

Defined in: [src/Types/Newsletter.ts:73](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L73)

## Properties[​](#properties "Direct link to Properties")

### creation\_time?[​](#creation_time "Direct link to creation_time?")

> `optional` **creation\_time**: `number`

Defined in: [src/Types/Newsletter.ts:79](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L79)

* * *

### description?[​](#description "Direct link to description?")

> `optional` **description**: `string`

Defined in: [src/Types/Newsletter.ts:77](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L77)

* * *

### id[​](#id "Direct link to id")

> **id**: `string`

Defined in: [src/Types/Newsletter.ts:74](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L74)

* * *

### invite?[​](#invite "Direct link to invite?")

> `optional` **invite**: `string`

Defined in: [src/Types/Newsletter.ts:78](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L78)

* * *

### mute\_state?[​](#mute_state "Direct link to mute_state?")

> `optional` **mute\_state**: `"ON"` | `"OFF"`

Defined in: [src/Types/Newsletter.ts:92](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L92)

* * *

### name[​](#name "Direct link to name")

> **name**: `string`

Defined in: [src/Types/Newsletter.ts:76](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L76)

* * *

### owner?[​](#owner "Direct link to owner?")

> `optional` **owner**: `string`

Defined in: [src/Types/Newsletter.ts:75](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L75)

* * *

### picture?[​](#picture "Direct link to picture?")

> `optional` **picture**: `object`

Defined in: [src/Types/Newsletter.ts:81](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L81)

#### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `string`

#### id?[​](#id-1 "Direct link to id?")

> `optional` **id**: `string`

#### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `string`

#### url?[​](#url "Direct link to url?")

> `optional` **url**: `string`

* * *

### reaction\_codes?[​](#reaction_codes "Direct link to reaction_codes?")

> `optional` **reaction\_codes**: `object`\[\]

Defined in: [src/Types/Newsletter.ts:88](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L88)

#### code[​](#code "Direct link to code")

> **code**: `string`

#### count[​](#count "Direct link to count")

> **count**: `number`

* * *

### subscribers?[​](#subscribers "Direct link to subscribers?")

> `optional` **subscribers**: `number`

Defined in: [src/Types/Newsletter.ts:80](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L80)

* * *

### thread\_metadata?[​](#thread_metadata "Direct link to thread_metadata?")

> `optional` **thread\_metadata**: `object`

Defined in: [src/Types/Newsletter.ts:93](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L93)

#### creation\_time?[​](#creation_time-1 "Direct link to creation_time?")

> `optional` **creation\_time**: `number`

#### description?[​](#description-1 "Direct link to description?")

> `optional` **description**: `string`

#### name?[​](#name-1 "Direct link to name?")

> `optional` **name**: `string`

* * *

### verification?[​](#verification "Direct link to verification?")

> `optional` **verification**: `"VERIFIED"` | `"UNVERIFIED"`

Defined in: [src/Types/Newsletter.ts:87](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L87)

---

<a name="interface-presencedata"></a>

> Source: [https://baileys.wiki/docs/api/interfaces/PresenceData](https://baileys.wiki/docs/api/interfaces/PresenceData)

Defined in: [src/Types/Chat.ts:36](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L36)

## Properties[​](#properties "Direct link to Properties")

### lastKnownPresence[​](#lastknownpresence "Direct link to lastKnownPresence")

> **lastKnownPresence**: [`WAPresence`](/docs/api/type-aliases/WAPresence)

Defined in: [src/Types/Chat.ts:37](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L37)

* * *

### lastSeen?[​](#lastseen "Direct link to lastSeen?")

> `optional` **lastSeen**: `number`

Defined in: [src/Types/Chat.ts:38](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L38)

---

<a name="interface-recentmessage"></a>

> Source: [https://baileys.wiki/docs/api/interfaces/RecentMessage](https://baileys.wiki/docs/api/interfaces/RecentMessage)

Defined in: [src/Utils/message-retry-manager.ts:18](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L18)

## Properties[​](#properties "Direct link to Properties")

### message[​](#message "Direct link to message")

> **message**: [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [src/Utils/message-retry-manager.ts:19](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L19)

* * *

### timestamp[​](#timestamp "Direct link to timestamp")

> **timestamp**: `number`

Defined in: [src/Utils/message-retry-manager.ts:20](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L20)

---

<a name="interface-recentmessagekey"></a>

> Source: [https://baileys.wiki/docs/api/interfaces/RecentMessageKey](https://baileys.wiki/docs/api/interfaces/RecentMessageKey)

Defined in: [src/Utils/message-retry-manager.ts:13](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L13)

## Properties[​](#properties "Direct link to Properties")

### id[​](#id "Direct link to id")

> **id**: `string`

Defined in: [src/Utils/message-retry-manager.ts:15](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L15)

* * *

### to[​](#to "Direct link to to")

> **to**: `string`

Defined in: [src/Utils/message-retry-manager.ts:14](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L14)

---

<a name="interface-retrycounter"></a>

> Source: [https://baileys.wiki/docs/api/interfaces/RetryCounter](https://baileys.wiki/docs/api/interfaces/RetryCounter)

Defined in: [src/Utils/message-retry-manager.ts:27](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L27)

## Indexable[​](#indexable "Direct link to Indexable")

\[`messageId`: `string`\]: `number`

---

<a name="interface-retrystatistics"></a>

> Source: [https://baileys.wiki/docs/api/interfaces/RetryStatistics](https://baileys.wiki/docs/api/interfaces/RetryStatistics)

Defined in: [src/Utils/message-retry-manager.ts:33](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L33)

## Properties[​](#properties "Direct link to Properties")

### failedRetries[​](#failedretries "Direct link to failedRetries")

> **failedRetries**: `number`

Defined in: [src/Utils/message-retry-manager.ts:36](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L36)

* * *

### mediaRetries[​](#mediaretries "Direct link to mediaRetries")

> **mediaRetries**: `number`

Defined in: [src/Utils/message-retry-manager.ts:37](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L37)

* * *

### phoneRequests[​](#phonerequests "Direct link to phoneRequests")

> **phoneRequests**: `number`

Defined in: [src/Utils/message-retry-manager.ts:39](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L39)

* * *

### sessionRecreations[​](#sessionrecreations "Direct link to sessionRecreations")

> **sessionRecreations**: `number`

Defined in: [src/Utils/message-retry-manager.ts:38](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L38)

* * *

### successfulRetries[​](#successfulretries "Direct link to successfulRetries")

> **successfulRetries**: `number`

Defined in: [src/Utils/message-retry-manager.ts:35](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L35)

* * *

### totalRetries[​](#totalretries "Direct link to totalRetries")

> **totalRetries**: `number`

Defined in: [src/Utils/message-retry-manager.ts:34](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L34)

---

<a name="interface-sessionrecreatehistory"></a>

> Source: [https://baileys.wiki/docs/api/interfaces/SessionRecreateHistory](https://baileys.wiki/docs/api/interfaces/SessionRecreateHistory)

Defined in: [src/Utils/message-retry-manager.ts:23](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L23)

## Indexable[​](#indexable "Direct link to Indexable")

\[`jid`: `string`\]: `number`

---

<a name="interface-signalrepositorywithlidstore"></a>

> Source: [https://baileys.wiki/docs/api/interfaces/SignalRepositoryWithLIDStore](https://baileys.wiki/docs/api/interfaces/SignalRepositoryWithLIDStore)

Defined in: [src/Types/Signal.ts:74](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Signal.ts#L74)

## Extends[​](#extends "Direct link to Extends")

*   [`SignalRepository`](/docs/api/type-aliases/SignalRepository)

## Properties[​](#properties "Direct link to Properties")

### lidMapping[​](#lidmapping "Direct link to lidMapping")

> **lidMapping**: `LIDMappingStore`

Defined in: [src/Types/Signal.ts:75](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Signal.ts#L75)

## Methods[​](#methods "Direct link to Methods")

### decryptGroupMessage()[​](#decryptgroupmessage "Direct link to decryptGroupMessage()")

> **decryptGroupMessage**(`opts`): `Promise`<`Uint8Array`<`ArrayBufferLike`\>>

Defined in: [src/Types/Signal.ts:54](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Signal.ts#L54)

#### Parameters[​](#parameters "Direct link to Parameters")

##### opts[​](#opts "Direct link to opts")

`DecryptGroupSignalOpts`

#### Returns[​](#returns "Direct link to Returns")

`Promise`<`Uint8Array`<`ArrayBufferLike`\>>

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`SignalRepository.decryptGroupMessage`

* * *

### decryptMessage()[​](#decryptmessage "Direct link to decryptMessage()")

> **decryptMessage**(`opts`): `Promise`<`Uint8Array`<`ArrayBufferLike`\>>

Defined in: [src/Types/Signal.ts:56](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Signal.ts#L56)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### opts[​](#opts-1 "Direct link to opts")

`DecryptSignalProtoOpts`

#### Returns[​](#returns-1 "Direct link to Returns")

`Promise`<`Uint8Array`<`ArrayBufferLike`\>>

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`SignalRepository.decryptMessage`

* * *

### deleteSession()[​](#deletesession "Direct link to deleteSession()")

> **deleteSession**(`jids`): `Promise`<`void`\>

Defined in: [src/Types/Signal.ts:70](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Signal.ts#L70)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### jids[​](#jids "Direct link to jids")

`string`\[\]

#### Returns[​](#returns-2 "Direct link to Returns")

`Promise`<`void`\>

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`SignalRepository.deleteSession`

* * *

### encryptGroupMessage()[​](#encryptgroupmessage "Direct link to encryptGroupMessage()")

> **encryptGroupMessage**(`opts`): `Promise`<{ `ciphertext`: `Uint8Array`; `senderKeyDistributionMessage`: `Uint8Array`; }>

Defined in: [src/Types/Signal.ts:61](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Signal.ts#L61)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### opts[​](#opts-2 "Direct link to opts")

`EncryptGroupMessageOpts`

#### Returns[​](#returns-3 "Direct link to Returns")

`Promise`<{ `ciphertext`: `Uint8Array`; `senderKeyDistributionMessage`: `Uint8Array`; }>

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`SignalRepository.encryptGroupMessage`

* * *

### encryptMessage()[​](#encryptmessage "Direct link to encryptMessage()")

> **encryptMessage**(`opts`): `Promise`<{ `ciphertext`: `Uint8Array`; `type`: `"msg"` | `"pkmsg"`; }>

Defined in: [src/Types/Signal.ts:57](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Signal.ts#L57)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### opts[​](#opts-3 "Direct link to opts")

`EncryptMessageOpts`

#### Returns[​](#returns-4 "Direct link to Returns")

`Promise`<{ `ciphertext`: `Uint8Array`; `type`: `"msg"` | `"pkmsg"`; }>

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`SignalRepository.encryptMessage`

* * *

### injectE2ESession()[​](#injecte2esession "Direct link to injectE2ESession()")

> **injectE2ESession**(`opts`): `Promise`<`void`\>

Defined in: [src/Types/Signal.ts:65](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Signal.ts#L65)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### opts[​](#opts-4 "Direct link to opts")

`E2ESessionOpts`

#### Returns[​](#returns-5 "Direct link to Returns")

`Promise`<`void`\>

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`SignalRepository.injectE2ESession`

* * *

### jidToSignalProtocolAddress()[​](#jidtosignalprotocoladdress "Direct link to jidToSignalProtocolAddress()")

> **jidToSignalProtocolAddress**(`jid`): `string`

Defined in: [src/Types/Signal.ts:67](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Signal.ts#L67)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### jid[​](#jid "Direct link to jid")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`SignalRepository.jidToSignalProtocolAddress`

* * *

### migrateSession()[​](#migratesession "Direct link to migrateSession()")

> **migrateSession**(`fromJid`, `toJid`): `Promise`<{ `migrated`: `number`; `skipped`: `number`; `total`: `number`; }>

Defined in: [src/Types/Signal.ts:68](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Signal.ts#L68)

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### fromJid[​](#fromjid "Direct link to fromJid")

`string`

##### toJid[​](#tojid "Direct link to toJid")

`string`

#### Returns[​](#returns-7 "Direct link to Returns")

`Promise`<{ `migrated`: `number`; `skipped`: `number`; `total`: `number`; }>

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`SignalRepository.migrateSession`

* * *

### processSenderKeyDistributionMessage()[​](#processsenderkeydistributionmessage "Direct link to processSenderKeyDistributionMessage()")

> **processSenderKeyDistributionMessage**(`opts`): `Promise`<`void`\>

Defined in: [src/Types/Signal.ts:55](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Signal.ts#L55)

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### opts[​](#opts-5 "Direct link to opts")

`ProcessSenderKeyDistributionMessageOpts`

#### Returns[​](#returns-8 "Direct link to Returns")

`Promise`<`void`\>

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`SignalRepository.processSenderKeyDistributionMessage`

* * *

### validateSession()[​](#validatesession "Direct link to validateSession()")

#### Call Signature[​](#call-signature "Direct link to Call Signature")

> **validateSession**(`jid`): `Promise`<{ `exists`: `boolean`; `reason`: `string`; }>

Defined in: [src/Types/Signal.ts:66](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Signal.ts#L66)

##### Parameters[​](#parameters-9 "Direct link to Parameters")

###### jid[​](#jid-1 "Direct link to jid")

`string`

##### Returns[​](#returns-9 "Direct link to Returns")

`Promise`<{ `exists`: `boolean`; `reason`: `string`; }>

##### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`SignalRepository.validateSession`

#### Call Signature[​](#call-signature-1 "Direct link to Call Signature")

> **validateSession**(`jid`): `Promise`<{ `exists`: `boolean`; `reason`: `string`; }>

Defined in: [src/Types/Signal.ts:69](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Signal.ts#L69)

##### Parameters[​](#parameters-10 "Direct link to Parameters")

###### jid[​](#jid-2 "Direct link to jid")

`string`

##### Returns[​](#returns-10 "Direct link to Returns")

`Promise`<{ `exists`: `boolean`; `reason`: `string`; }>

##### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`SignalRepository.validateSession`

---

<a name="interface-wagroupcreateresponse"></a>

> Source: [https://baileys.wiki/docs/api/interfaces/WAGroupCreateResponse](https://baileys.wiki/docs/api/interfaces/WAGroupCreateResponse)

Defined in: [src/Types/GroupMetadata.ts:61](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L61)

## Properties[​](#properties "Direct link to Properties")

### gid?[​](#gid "Direct link to gid?")

> `optional` **gid**: `string`

Defined in: [src/Types/GroupMetadata.ts:63](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L63)

* * *

### participants?[​](#participants "Direct link to participants?")

> `optional` **participants**: \[{}\]

Defined in: [src/Types/GroupMetadata.ts:64](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L64)

* * *

### status[​](#status "Direct link to status")

> **status**: `number`

Defined in: [src/Types/GroupMetadata.ts:62](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L62)

---

<a name="interface-waurlinfo"></a>

> Source: [https://baileys.wiki/docs/api/interfaces/WAUrlInfo](https://baileys.wiki/docs/api/interfaces/WAUrlInfo)

Defined in: [src/Types/Message.ts:102](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L102)

## Properties[​](#properties "Direct link to Properties")

### canonical-url[​](#canonical-url "Direct link to canonical-url")

> **canonical-url**: `string`

Defined in: [src/Types/Message.ts:103](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L103)

* * *

### description?[​](#description "Direct link to description?")

> `optional` **description**: `string`

Defined in: [src/Types/Message.ts:106](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L106)

* * *

### highQualityThumbnail?[​](#highqualitythumbnail "Direct link to highQualityThumbnail?")

> `optional` **highQualityThumbnail**: [`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage)

Defined in: [src/Types/Message.ts:108](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L108)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `Buffer`<`ArrayBufferLike`\>

Defined in: [src/Types/Message.ts:107](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L107)

* * *

### matched-text[​](#matched-text "Direct link to matched-text")

> **matched-text**: `string`

Defined in: [src/Types/Message.ts:104](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L104)

* * *

### originalThumbnailUrl?[​](#originalthumbnailurl "Direct link to originalThumbnailUrl?")

> `optional` **originalThumbnailUrl**: `string`

Defined in: [src/Types/Message.ts:109](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L109)

* * *

### title[​](#title "Direct link to title")

> **title**: `string`

Defined in: [src/Types/Message.ts:105](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L105)

---

<a name="proto"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/](https://baileys.wiki/docs/api/namespaces/proto/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [AIHomeState](/docs/api/namespaces/proto/namespaces/AIHomeState/)
*   [AIRichResponseCodeMetadata](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/)
*   [AIRichResponseContentItemsMetadata](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/)
*   [AIRichResponseDynamicMetadata](/docs/api/namespaces/proto/namespaces/AIRichResponseDynamicMetadata/)
*   [AIRichResponseInlineImageMetadata](/docs/api/namespaces/proto/namespaces/AIRichResponseInlineImageMetadata/)
*   [AIRichResponseLatexMetadata](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/)
*   [AIRichResponseMapMetadata](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/)
*   [AIRichResponseTableMetadata](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/)
*   [AIThreadInfo](/docs/api/namespaces/proto/namespaces/AIThreadInfo/)
*   [BizAccountLinkInfo](/docs/api/namespaces/proto/namespaces/BizAccountLinkInfo/)
*   [BizIdentityInfo](/docs/api/namespaces/proto/namespaces/BizIdentityInfo/)
*   [BotAgeCollectionMetadata](/docs/api/namespaces/proto/namespaces/BotAgeCollectionMetadata/)
*   [BotCapabilityMetadata](/docs/api/namespaces/proto/namespaces/BotCapabilityMetadata/)
*   [BotFeedbackMessage](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/)
*   [BotImagineMetadata](/docs/api/namespaces/proto/namespaces/BotImagineMetadata/)
*   [BotLinkedAccount](/docs/api/namespaces/proto/namespaces/BotLinkedAccount/)
*   [BotMediaMetadata](/docs/api/namespaces/proto/namespaces/BotMediaMetadata/)
*   [BotMessageOrigin](/docs/api/namespaces/proto/namespaces/BotMessageOrigin/)
*   [BotModelMetadata](/docs/api/namespaces/proto/namespaces/BotModelMetadata/)
*   [BotModeSelectionMetadata](/docs/api/namespaces/proto/namespaces/BotModeSelectionMetadata/)
*   [BotPluginMetadata](/docs/api/namespaces/proto/namespaces/BotPluginMetadata/)
*   [BotProgressIndicatorMetadata](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/)
*   [BotPromotionMessageMetadata](/docs/api/namespaces/proto/namespaces/BotPromotionMessageMetadata/)
*   [BotQuotaMetadata](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/)
*   [BotReminderMetadata](/docs/api/namespaces/proto/namespaces/BotReminderMetadata/)
*   [BotRenderingMetadata](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/)
*   [BotSignatureVerificationUseCaseProof](/docs/api/namespaces/proto/namespaces/BotSignatureVerificationUseCaseProof/)
*   [BotSourcesMetadata](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/)
*   [BotUnifiedResponseMutation](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/)
*   [CallLogRecord](/docs/api/namespaces/proto/namespaces/CallLogRecord/)
*   [CertChain](/docs/api/namespaces/proto/namespaces/CertChain/)
*   [ChatRowOpaqueData](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/)
*   [ClientPayload](/docs/api/namespaces/proto/namespaces/ClientPayload/)
*   [ContextInfo](/docs/api/namespaces/proto/namespaces/ContextInfo/)
*   [Conversation](/docs/api/namespaces/proto/namespaces/Conversation/)
*   [DeviceCapabilities](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/)
*   [DeviceProps](/docs/api/namespaces/proto/namespaces/DeviceProps/)
*   [DisappearingMode](/docs/api/namespaces/proto/namespaces/DisappearingMode/)
*   [GroupHistoryBundleInfo](/docs/api/namespaces/proto/namespaces/GroupHistoryBundleInfo/)
*   [GroupParticipant](/docs/api/namespaces/proto/namespaces/GroupParticipant/)
*   [HandshakeMessage](/docs/api/namespaces/proto/namespaces/HandshakeMessage/)
*   [HistorySync](/docs/api/namespaces/proto/namespaces/HistorySync/)
*   [HydratedTemplateButton](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/)
*   [InteractiveAnnotation](/docs/api/namespaces/proto/namespaces/InteractiveAnnotation/)
*   [InThreadSurveyMetadata](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/)
*   [LimitSharing](/docs/api/namespaces/proto/namespaces/LimitSharing/)
*   [MediaRetryNotification](/docs/api/namespaces/proto/namespaces/MediaRetryNotification/)
*   [Message](/docs/api/namespaces/proto/namespaces/Message/)
*   [MessageAddOn](/docs/api/namespaces/proto/namespaces/MessageAddOn/)
*   [MessageAssociation](/docs/api/namespaces/proto/namespaces/MessageAssociation/)
*   [MessageContextInfo](/docs/api/namespaces/proto/namespaces/MessageContextInfo/)
*   [MsgOpaqueData](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/)
*   [NoiseCertificate](/docs/api/namespaces/proto/namespaces/NoiseCertificate/)
*   [PastParticipant](/docs/api/namespaces/proto/namespaces/PastParticipant/)
*   [PatchDebugData](/docs/api/namespaces/proto/namespaces/PatchDebugData/)
*   [PaymentBackground](/docs/api/namespaces/proto/namespaces/PaymentBackground/)
*   [PaymentInfo](/docs/api/namespaces/proto/namespaces/PaymentInfo/)
*   [PinInChat](/docs/api/namespaces/proto/namespaces/PinInChat/)
*   [ProcessedVideo](/docs/api/namespaces/proto/namespaces/ProcessedVideo/)
*   [SenderKeyStateStructure](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/)
*   [SessionStructure](/docs/api/namespaces/proto/namespaces/SessionStructure/)
*   [StatusAttribution](/docs/api/namespaces/proto/namespaces/StatusAttribution/)
*   [SyncActionValue](/docs/api/namespaces/proto/namespaces/SyncActionValue/)
*   [SyncdMutation](/docs/api/namespaces/proto/namespaces/SyncdMutation/)
*   [TemplateButton](/docs/api/namespaces/proto/namespaces/TemplateButton/)
*   [ThreadID](/docs/api/namespaces/proto/namespaces/ThreadID/)
*   [UrlTrackingMap](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/)
*   [UserPassword](/docs/api/namespaces/proto/namespaces/UserPassword/)
*   [VerifiedNameCertificate](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/)
*   [WebFeatures](/docs/api/namespaces/proto/namespaces/WebFeatures/)
*   [WebMessageInfo](/docs/api/namespaces/proto/namespaces/WebMessageInfo/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [ADVEncryptionType](/docs/api/namespaces/proto/enumerations/ADVEncryptionType)
*   [AIRichResponseMessageType](/docs/api/namespaces/proto/enumerations/AIRichResponseMessageType)
*   [AIRichResponseSubMessageType](/docs/api/namespaces/proto/enumerations/AIRichResponseSubMessageType)
*   [BotMetricsEntryPoint](/docs/api/namespaces/proto/enumerations/BotMetricsEntryPoint)
*   [BotMetricsThreadEntryPoint](/docs/api/namespaces/proto/enumerations/BotMetricsThreadEntryPoint)
*   [BotSessionSource](/docs/api/namespaces/proto/enumerations/BotSessionSource)
*   [CollectionName](/docs/api/namespaces/proto/enumerations/CollectionName)
*   [KeepType](/docs/api/namespaces/proto/enumerations/KeepType)
*   [MediaVisibility](/docs/api/namespaces/proto/enumerations/MediaVisibility)
*   [MutationProps](/docs/api/namespaces/proto/enumerations/MutationProps)
*   [PrivacySystemMessage](/docs/api/namespaces/proto/enumerations/PrivacySystemMessage)
*   [SessionTransparencyType](/docs/api/namespaces/proto/enumerations/SessionTransparencyType)
*   [WebLinkRenderConfig](/docs/api/namespaces/proto/enumerations/WebLinkRenderConfig)

## Classes[​](#classes "Direct link to Classes")

*   [Account](/docs/api/namespaces/proto/classes/Account)
*   [ActionLink](/docs/api/namespaces/proto/classes/ActionLink)
*   [ADVDeviceIdentity](/docs/api/namespaces/proto/classes/ADVDeviceIdentity)
*   [ADVKeyIndexList](/docs/api/namespaces/proto/classes/ADVKeyIndexList)
*   [ADVSignedDeviceIdentity](/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentity)
*   [ADVSignedDeviceIdentityHMAC](/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentityHMAC)
*   [ADVSignedKeyIndexList](/docs/api/namespaces/proto/classes/ADVSignedKeyIndexList)
*   [AIHomeState](/docs/api/namespaces/proto/classes/AIHomeState)
*   [AIQueryFanout](/docs/api/namespaces/proto/classes/AIQueryFanout)
*   [AIRegenerateMetadata](/docs/api/namespaces/proto/classes/AIRegenerateMetadata)
*   [AIRichResponseCodeMetadata](/docs/api/namespaces/proto/classes/AIRichResponseCodeMetadata)
*   [AIRichResponseContentItemsMetadata](/docs/api/namespaces/proto/classes/AIRichResponseContentItemsMetadata)
*   [AIRichResponseDynamicMetadata](/docs/api/namespaces/proto/classes/AIRichResponseDynamicMetadata)
*   [AIRichResponseGridImageMetadata](/docs/api/namespaces/proto/classes/AIRichResponseGridImageMetadata)
*   [AIRichResponseImageURL](/docs/api/namespaces/proto/classes/AIRichResponseImageURL)
*   [AIRichResponseInlineImageMetadata](/docs/api/namespaces/proto/classes/AIRichResponseInlineImageMetadata)
*   [AIRichResponseLatexMetadata](/docs/api/namespaces/proto/classes/AIRichResponseLatexMetadata)
*   [AIRichResponseMapMetadata](/docs/api/namespaces/proto/classes/AIRichResponseMapMetadata)
*   [AIRichResponseMessage](/docs/api/namespaces/proto/classes/AIRichResponseMessage)
*   [AIRichResponseSubMessage](/docs/api/namespaces/proto/classes/AIRichResponseSubMessage)
*   [AIRichResponseTableMetadata](/docs/api/namespaces/proto/classes/AIRichResponseTableMetadata)
*   [AIRichResponseUnifiedResponse](/docs/api/namespaces/proto/classes/AIRichResponseUnifiedResponse)
*   [AIThreadInfo](/docs/api/namespaces/proto/classes/AIThreadInfo)
*   [AutoDownloadSettings](/docs/api/namespaces/proto/classes/AutoDownloadSettings)
*   [AvatarUserSettings](/docs/api/namespaces/proto/classes/AvatarUserSettings)
*   [BizAccountLinkInfo](/docs/api/namespaces/proto/classes/BizAccountLinkInfo)
*   [BizAccountPayload](/docs/api/namespaces/proto/classes/BizAccountPayload)
*   [BizIdentityInfo](/docs/api/namespaces/proto/classes/BizIdentityInfo)
*   [BotAgeCollectionMetadata](/docs/api/namespaces/proto/classes/BotAgeCollectionMetadata)
*   [BotAvatarMetadata](/docs/api/namespaces/proto/classes/BotAvatarMetadata)
*   [BotCapabilityMetadata](/docs/api/namespaces/proto/classes/BotCapabilityMetadata)
*   [BotFeedbackMessage](/docs/api/namespaces/proto/classes/BotFeedbackMessage)
*   [BotImagineMetadata](/docs/api/namespaces/proto/classes/BotImagineMetadata)
*   [BotLinkedAccount](/docs/api/namespaces/proto/classes/BotLinkedAccount)
*   [BotLinkedAccountsMetadata](/docs/api/namespaces/proto/classes/BotLinkedAccountsMetadata)
*   [BotMediaMetadata](/docs/api/namespaces/proto/classes/BotMediaMetadata)
*   [BotMemoryFact](/docs/api/namespaces/proto/classes/BotMemoryFact)
*   [BotMemoryMetadata](/docs/api/namespaces/proto/classes/BotMemoryMetadata)
*   [BotMemuMetadata](/docs/api/namespaces/proto/classes/BotMemuMetadata)
*   [BotMessageOrigin](/docs/api/namespaces/proto/classes/BotMessageOrigin)
*   [BotMessageOriginMetadata](/docs/api/namespaces/proto/classes/BotMessageOriginMetadata)
*   [BotMessageSharingInfo](/docs/api/namespaces/proto/classes/BotMessageSharingInfo)
*   [BotMetadata](/docs/api/namespaces/proto/classes/BotMetadata)
*   [BotMetricsMetadata](/docs/api/namespaces/proto/classes/BotMetricsMetadata)
*   [BotModelMetadata](/docs/api/namespaces/proto/classes/BotModelMetadata)
*   [BotModeSelectionMetadata](/docs/api/namespaces/proto/classes/BotModeSelectionMetadata)
*   [BotPluginMetadata](/docs/api/namespaces/proto/classes/BotPluginMetadata)
*   [BotProgressIndicatorMetadata](/docs/api/namespaces/proto/classes/BotProgressIndicatorMetadata)
*   [BotPromotionMessageMetadata](/docs/api/namespaces/proto/classes/BotPromotionMessageMetadata)
*   [BotPromptSuggestion](/docs/api/namespaces/proto/classes/BotPromptSuggestion)
*   [BotPromptSuggestions](/docs/api/namespaces/proto/classes/BotPromptSuggestions)
*   [BotQuotaMetadata](/docs/api/namespaces/proto/classes/BotQuotaMetadata)
*   [BotReminderMetadata](/docs/api/namespaces/proto/classes/BotReminderMetadata)
*   [BotRenderingMetadata](/docs/api/namespaces/proto/classes/BotRenderingMetadata)
*   [BotSessionMetadata](/docs/api/namespaces/proto/classes/BotSessionMetadata)
*   [BotSignatureVerificationMetadata](/docs/api/namespaces/proto/classes/BotSignatureVerificationMetadata)
*   [BotSignatureVerificationUseCaseProof](/docs/api/namespaces/proto/classes/BotSignatureVerificationUseCaseProof)
*   [BotSourcesMetadata](/docs/api/namespaces/proto/classes/BotSourcesMetadata)
*   [BotSuggestedPromptMetadata](/docs/api/namespaces/proto/classes/BotSuggestedPromptMetadata)
*   [BotUnifiedResponseMutation](/docs/api/namespaces/proto/classes/BotUnifiedResponseMutation)
*   [CallLogRecord](/docs/api/namespaces/proto/classes/CallLogRecord)
*   [CertChain](/docs/api/namespaces/proto/classes/CertChain)
*   [ChatLockSettings](/docs/api/namespaces/proto/classes/ChatLockSettings)
*   [ChatRowOpaqueData](/docs/api/namespaces/proto/classes/ChatRowOpaqueData)
*   [Citation](/docs/api/namespaces/proto/classes/Citation)
*   [ClientPairingProps](/docs/api/namespaces/proto/classes/ClientPairingProps)
*   [ClientPayload](/docs/api/namespaces/proto/classes/ClientPayload)
*   [CommentMetadata](/docs/api/namespaces/proto/classes/CommentMetadata)
*   [CompanionCommitment](/docs/api/namespaces/proto/classes/CompanionCommitment)
*   [CompanionEphemeralIdentity](/docs/api/namespaces/proto/classes/CompanionEphemeralIdentity)
*   [Config](/docs/api/namespaces/proto/classes/Config)
*   [ContextInfo](/docs/api/namespaces/proto/classes/ContextInfo)
*   [Conversation](/docs/api/namespaces/proto/classes/Conversation)
*   [DeviceCapabilities](/docs/api/namespaces/proto/classes/DeviceCapabilities)
*   [DeviceConsistencyCodeMessage](/docs/api/namespaces/proto/classes/DeviceConsistencyCodeMessage)
*   [DeviceListMetadata](/docs/api/namespaces/proto/classes/DeviceListMetadata)
*   [DeviceProps](/docs/api/namespaces/proto/classes/DeviceProps)
*   [DisappearingMode](/docs/api/namespaces/proto/classes/DisappearingMode)
*   [EmbeddedContent](/docs/api/namespaces/proto/classes/EmbeddedContent)
*   [EmbeddedMessage](/docs/api/namespaces/proto/classes/EmbeddedMessage)
*   [EmbeddedMusic](/docs/api/namespaces/proto/classes/EmbeddedMusic)
*   [EncryptedPairingRequest](/docs/api/namespaces/proto/classes/EncryptedPairingRequest)
*   [EphemeralSetting](/docs/api/namespaces/proto/classes/EphemeralSetting)
*   [EventAdditionalMetadata](/docs/api/namespaces/proto/classes/EventAdditionalMetadata)
*   [EventResponse](/docs/api/namespaces/proto/classes/EventResponse)
*   [ExitCode](/docs/api/namespaces/proto/classes/ExitCode)
*   [ExternalBlobReference](/docs/api/namespaces/proto/classes/ExternalBlobReference)
*   [Field](/docs/api/namespaces/proto/classes/Field)
*   [ForwardedAIBotMessageInfo](/docs/api/namespaces/proto/classes/ForwardedAIBotMessageInfo)
*   [GlobalSettings](/docs/api/namespaces/proto/classes/GlobalSettings)
*   [GroupHistoryBundleInfo](/docs/api/namespaces/proto/classes/GroupHistoryBundleInfo)
*   [GroupHistoryIndividualMessageInfo](/docs/api/namespaces/proto/classes/GroupHistoryIndividualMessageInfo)
*   [GroupMention](/docs/api/namespaces/proto/classes/GroupMention)
*   [GroupParticipant](/docs/api/namespaces/proto/classes/GroupParticipant)
*   [HandshakeMessage](/docs/api/namespaces/proto/classes/HandshakeMessage)
*   [HistorySync](/docs/api/namespaces/proto/classes/HistorySync)
*   [HistorySyncMsg](/docs/api/namespaces/proto/classes/HistorySyncMsg)
*   [HydratedTemplateButton](/docs/api/namespaces/proto/classes/HydratedTemplateButton)
*   [IdentityKeyPairStructure](/docs/api/namespaces/proto/classes/IdentityKeyPairStructure)
*   [InteractiveAnnotation](/docs/api/namespaces/proto/classes/InteractiveAnnotation)
*   [InteractiveMessageAdditionalMetadata](/docs/api/namespaces/proto/classes/InteractiveMessageAdditionalMetadata)
*   [InThreadSurveyMetadata](/docs/api/namespaces/proto/classes/InThreadSurveyMetadata)
*   [KeepInChat](/docs/api/namespaces/proto/classes/KeepInChat)
*   [KeyExchangeMessage](/docs/api/namespaces/proto/classes/KeyExchangeMessage)
*   [KeyId](/docs/api/namespaces/proto/classes/KeyId)
*   [LegacyMessage](/docs/api/namespaces/proto/classes/LegacyMessage)
*   [LIDMigrationMapping](/docs/api/namespaces/proto/classes/LIDMigrationMapping)
*   [LIDMigrationMappingSyncMessage](/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncMessage)
*   [LIDMigrationMappingSyncPayload](/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncPayload)
*   [LimitSharing](/docs/api/namespaces/proto/classes/LimitSharing)
*   [LocalizedName](/docs/api/namespaces/proto/classes/LocalizedName)
*   [Location](/docs/api/namespaces/proto/classes/Location)
*   [MediaData](/docs/api/namespaces/proto/classes/MediaData)
*   [MediaNotifyMessage](/docs/api/namespaces/proto/classes/MediaNotifyMessage)
*   [MediaRetryNotification](/docs/api/namespaces/proto/classes/MediaRetryNotification)
*   [MemberLabel](/docs/api/namespaces/proto/classes/MemberLabel)
*   [Message](/docs/api/namespaces/proto/classes/Message)
*   [MessageAddOn](/docs/api/namespaces/proto/classes/MessageAddOn)
*   [MessageAddOnContextInfo](/docs/api/namespaces/proto/classes/MessageAddOnContextInfo)
*   [MessageAssociation](/docs/api/namespaces/proto/classes/MessageAssociation)
*   [MessageContextInfo](/docs/api/namespaces/proto/classes/MessageContextInfo)
*   [MessageKey](/docs/api/namespaces/proto/classes/MessageKey)
*   [MessageSecretMessage](/docs/api/namespaces/proto/classes/MessageSecretMessage)
*   [Money](/docs/api/namespaces/proto/classes/Money)
*   [MsgOpaqueData](/docs/api/namespaces/proto/classes/MsgOpaqueData)
*   [MsgRowOpaqueData](/docs/api/namespaces/proto/classes/MsgRowOpaqueData)
*   [NoiseCertificate](/docs/api/namespaces/proto/classes/NoiseCertificate)
*   [NotificationMessageInfo](/docs/api/namespaces/proto/classes/NotificationMessageInfo)
*   [NotificationSettings](/docs/api/namespaces/proto/classes/NotificationSettings)
*   [PairingRequest](/docs/api/namespaces/proto/classes/PairingRequest)
*   [PastParticipant](/docs/api/namespaces/proto/classes/PastParticipant)
*   [PastParticipants](/docs/api/namespaces/proto/classes/PastParticipants)
*   [PatchDebugData](/docs/api/namespaces/proto/classes/PatchDebugData)
*   [PaymentBackground](/docs/api/namespaces/proto/classes/PaymentBackground)
*   [PaymentInfo](/docs/api/namespaces/proto/classes/PaymentInfo)
*   [PhoneNumberToLIDMapping](/docs/api/namespaces/proto/classes/PhoneNumberToLIDMapping)
*   [PhotoChange](/docs/api/namespaces/proto/classes/PhotoChange)
*   [PinInChat](/docs/api/namespaces/proto/classes/PinInChat)
*   [Point](/docs/api/namespaces/proto/classes/Point)
*   [PollAdditionalMetadata](/docs/api/namespaces/proto/classes/PollAdditionalMetadata)
*   [PollEncValue](/docs/api/namespaces/proto/classes/PollEncValue)
*   [PollUpdate](/docs/api/namespaces/proto/classes/PollUpdate)
*   [PreKeyRecordStructure](/docs/api/namespaces/proto/classes/PreKeyRecordStructure)
*   [PreKeySignalMessage](/docs/api/namespaces/proto/classes/PreKeySignalMessage)
*   [PremiumMessageInfo](/docs/api/namespaces/proto/classes/PremiumMessageInfo)
*   [PrimaryEphemeralIdentity](/docs/api/namespaces/proto/classes/PrimaryEphemeralIdentity)
*   [ProcessedVideo](/docs/api/namespaces/proto/classes/ProcessedVideo)
*   [ProloguePayload](/docs/api/namespaces/proto/classes/ProloguePayload)
*   [Pushname](/docs/api/namespaces/proto/classes/Pushname)
*   [QuarantinedMessage](/docs/api/namespaces/proto/classes/QuarantinedMessage)
*   [Reaction](/docs/api/namespaces/proto/classes/Reaction)
*   [RecentEmojiWeight](/docs/api/namespaces/proto/classes/RecentEmojiWeight)
*   [RecordStructure](/docs/api/namespaces/proto/classes/RecordStructure)
*   [Reportable](/docs/api/namespaces/proto/classes/Reportable)
*   [ReportingTokenInfo](/docs/api/namespaces/proto/classes/ReportingTokenInfo)
*   [SenderKeyDistributionMessage](/docs/api/namespaces/proto/classes/SenderKeyDistributionMessage)
*   [SenderKeyMessage](/docs/api/namespaces/proto/classes/SenderKeyMessage)
*   [SenderKeyRecordStructure](/docs/api/namespaces/proto/classes/SenderKeyRecordStructure)
*   [SenderKeyStateStructure](/docs/api/namespaces/proto/classes/SenderKeyStateStructure)
*   [ServerErrorReceipt](/docs/api/namespaces/proto/classes/ServerErrorReceipt)
*   [SessionStructure](/docs/api/namespaces/proto/classes/SessionStructure)
*   [SessionTransparencyMetadata](/docs/api/namespaces/proto/classes/SessionTransparencyMetadata)
*   [SignalMessage](/docs/api/namespaces/proto/classes/SignalMessage)
*   [SignedPreKeyRecordStructure](/docs/api/namespaces/proto/classes/SignedPreKeyRecordStructure)
*   [StatusAttribution](/docs/api/namespaces/proto/classes/StatusAttribution)
*   [StatusMentionMessage](/docs/api/namespaces/proto/classes/StatusMentionMessage)
*   [StatusPSA](/docs/api/namespaces/proto/classes/StatusPSA)
*   [StickerMetadata](/docs/api/namespaces/proto/classes/StickerMetadata)
*   [SyncActionData](/docs/api/namespaces/proto/classes/SyncActionData)
*   [SyncActionValue](/docs/api/namespaces/proto/classes/SyncActionValue)
*   [SyncdIndex](/docs/api/namespaces/proto/classes/SyncdIndex)
*   [SyncdMutation](/docs/api/namespaces/proto/classes/SyncdMutation)
*   [SyncdMutations](/docs/api/namespaces/proto/classes/SyncdMutations)
*   [SyncdPatch](/docs/api/namespaces/proto/classes/SyncdPatch)
*   [SyncdRecord](/docs/api/namespaces/proto/classes/SyncdRecord)
*   [SyncdSnapshot](/docs/api/namespaces/proto/classes/SyncdSnapshot)
*   [SyncdValue](/docs/api/namespaces/proto/classes/SyncdValue)
*   [SyncdVersion](/docs/api/namespaces/proto/classes/SyncdVersion)
*   [TapLinkAction](/docs/api/namespaces/proto/classes/TapLinkAction)
*   [TemplateButton](/docs/api/namespaces/proto/classes/TemplateButton)
*   [ThreadID](/docs/api/namespaces/proto/classes/ThreadID)
*   [UrlTrackingMap](/docs/api/namespaces/proto/classes/UrlTrackingMap)
*   [UserPassword](/docs/api/namespaces/proto/classes/UserPassword)
*   [UserReceipt](/docs/api/namespaces/proto/classes/UserReceipt)
*   [VerifiedNameCertificate](/docs/api/namespaces/proto/classes/VerifiedNameCertificate)
*   [WallpaperSettings](/docs/api/namespaces/proto/classes/WallpaperSettings)
*   [WebFeatures](/docs/api/namespaces/proto/classes/WebFeatures)
*   [WebMessageInfo](/docs/api/namespaces/proto/classes/WebMessageInfo)
*   [WebNotificationsInfo](/docs/api/namespaces/proto/classes/WebNotificationsInfo)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IAccount](/docs/api/namespaces/proto/interfaces/IAccount)
*   [IActionLink](/docs/api/namespaces/proto/interfaces/IActionLink)
*   [IADVDeviceIdentity](/docs/api/namespaces/proto/interfaces/IADVDeviceIdentity)
*   [IADVKeyIndexList](/docs/api/namespaces/proto/interfaces/IADVKeyIndexList)
*   [IADVSignedDeviceIdentity](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentity)
*   [IADVSignedDeviceIdentityHMAC](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentityHMAC)
*   [IADVSignedKeyIndexList](/docs/api/namespaces/proto/interfaces/IADVSignedKeyIndexList)
*   [IAIHomeState](/docs/api/namespaces/proto/interfaces/IAIHomeState)
*   [IAIQueryFanout](/docs/api/namespaces/proto/interfaces/IAIQueryFanout)
*   [IAIRegenerateMetadata](/docs/api/namespaces/proto/interfaces/IAIRegenerateMetadata)
*   [IAIRichResponseCodeMetadata](/docs/api/namespaces/proto/interfaces/IAIRichResponseCodeMetadata)
*   [IAIRichResponseContentItemsMetadata](/docs/api/namespaces/proto/interfaces/IAIRichResponseContentItemsMetadata)
*   [IAIRichResponseDynamicMetadata](/docs/api/namespaces/proto/interfaces/IAIRichResponseDynamicMetadata)
*   [IAIRichResponseGridImageMetadata](/docs/api/namespaces/proto/interfaces/IAIRichResponseGridImageMetadata)
*   [IAIRichResponseImageURL](/docs/api/namespaces/proto/interfaces/IAIRichResponseImageURL)
*   [IAIRichResponseInlineImageMetadata](/docs/api/namespaces/proto/interfaces/IAIRichResponseInlineImageMetadata)
*   [IAIRichResponseLatexMetadata](/docs/api/namespaces/proto/interfaces/IAIRichResponseLatexMetadata)
*   [IAIRichResponseMapMetadata](/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata)
*   [IAIRichResponseMessage](/docs/api/namespaces/proto/interfaces/IAIRichResponseMessage)
*   [IAIRichResponseSubMessage](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage)
*   [IAIRichResponseTableMetadata](/docs/api/namespaces/proto/interfaces/IAIRichResponseTableMetadata)
*   [IAIRichResponseUnifiedResponse](/docs/api/namespaces/proto/interfaces/IAIRichResponseUnifiedResponse)
*   [IAIThreadInfo](/docs/api/namespaces/proto/interfaces/IAIThreadInfo)
*   [IAutoDownloadSettings](/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings)
*   [IAvatarUserSettings](/docs/api/namespaces/proto/interfaces/IAvatarUserSettings)
*   [IBizAccountLinkInfo](/docs/api/namespaces/proto/interfaces/IBizAccountLinkInfo)
*   [IBizAccountPayload](/docs/api/namespaces/proto/interfaces/IBizAccountPayload)
*   [IBizIdentityInfo](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo)
*   [IBotAgeCollectionMetadata](/docs/api/namespaces/proto/interfaces/IBotAgeCollectionMetadata)
*   [IBotAvatarMetadata](/docs/api/namespaces/proto/interfaces/IBotAvatarMetadata)
*   [IBotCapabilityMetadata](/docs/api/namespaces/proto/interfaces/IBotCapabilityMetadata)
*   [IBotFeedbackMessage](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage)
*   [IBotImagineMetadata](/docs/api/namespaces/proto/interfaces/IBotImagineMetadata)
*   [IBotLinkedAccount](/docs/api/namespaces/proto/interfaces/IBotLinkedAccount)
*   [IBotLinkedAccountsMetadata](/docs/api/namespaces/proto/interfaces/IBotLinkedAccountsMetadata)
*   [IBotMediaMetadata](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata)
*   [IBotMemoryFact](/docs/api/namespaces/proto/interfaces/IBotMemoryFact)
*   [IBotMemoryMetadata](/docs/api/namespaces/proto/interfaces/IBotMemoryMetadata)
*   [IBotMemuMetadata](/docs/api/namespaces/proto/interfaces/IBotMemuMetadata)
*   [IBotMessageOrigin](/docs/api/namespaces/proto/interfaces/IBotMessageOrigin)
*   [IBotMessageOriginMetadata](/docs/api/namespaces/proto/interfaces/IBotMessageOriginMetadata)
*   [IBotMessageSharingInfo](/docs/api/namespaces/proto/interfaces/IBotMessageSharingInfo)
*   [IBotMetadata](/docs/api/namespaces/proto/interfaces/IBotMetadata)
*   [IBotMetricsMetadata](/docs/api/namespaces/proto/interfaces/IBotMetricsMetadata)
*   [IBotModelMetadata](/docs/api/namespaces/proto/interfaces/IBotModelMetadata)
*   [IBotModeSelectionMetadata](/docs/api/namespaces/proto/interfaces/IBotModeSelectionMetadata)
*   [IBotPluginMetadata](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata)
*   [IBotProgressIndicatorMetadata](/docs/api/namespaces/proto/interfaces/IBotProgressIndicatorMetadata)
*   [IBotPromotionMessageMetadata](/docs/api/namespaces/proto/interfaces/IBotPromotionMessageMetadata)
*   [IBotPromptSuggestion](/docs/api/namespaces/proto/interfaces/IBotPromptSuggestion)
*   [IBotPromptSuggestions](/docs/api/namespaces/proto/interfaces/IBotPromptSuggestions)
*   [IBotQuotaMetadata](/docs/api/namespaces/proto/interfaces/IBotQuotaMetadata)
*   [IBotReminderMetadata](/docs/api/namespaces/proto/interfaces/IBotReminderMetadata)
*   [IBotRenderingMetadata](/docs/api/namespaces/proto/interfaces/IBotRenderingMetadata)
*   [IBotSessionMetadata](/docs/api/namespaces/proto/interfaces/IBotSessionMetadata)
*   [IBotSignatureVerificationMetadata](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationMetadata)
*   [IBotSignatureVerificationUseCaseProof](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationUseCaseProof)
*   [IBotSourcesMetadata](/docs/api/namespaces/proto/interfaces/IBotSourcesMetadata)
*   [IBotSuggestedPromptMetadata](/docs/api/namespaces/proto/interfaces/IBotSuggestedPromptMetadata)
*   [IBotUnifiedResponseMutation](/docs/api/namespaces/proto/interfaces/IBotUnifiedResponseMutation)
*   [ICallLogRecord](/docs/api/namespaces/proto/interfaces/ICallLogRecord)
*   [ICertChain](/docs/api/namespaces/proto/interfaces/ICertChain)
*   [IChatLockSettings](/docs/api/namespaces/proto/interfaces/IChatLockSettings)
*   [IChatRowOpaqueData](/docs/api/namespaces/proto/interfaces/IChatRowOpaqueData)
*   [ICitation](/docs/api/namespaces/proto/interfaces/ICitation)
*   [IClientPairingProps](/docs/api/namespaces/proto/interfaces/IClientPairingProps)
*   [IClientPayload](/docs/api/namespaces/proto/interfaces/IClientPayload)
*   [ICommentMetadata](/docs/api/namespaces/proto/interfaces/ICommentMetadata)
*   [ICompanionCommitment](/docs/api/namespaces/proto/interfaces/ICompanionCommitment)
*   [ICompanionEphemeralIdentity](/docs/api/namespaces/proto/interfaces/ICompanionEphemeralIdentity)
*   [IConfig](/docs/api/namespaces/proto/interfaces/IConfig)
*   [IContextInfo](/docs/api/namespaces/proto/interfaces/IContextInfo)
*   [IConversation](/docs/api/namespaces/proto/interfaces/IConversation)
*   [IDeviceCapabilities](/docs/api/namespaces/proto/interfaces/IDeviceCapabilities)
*   [IDeviceConsistencyCodeMessage](/docs/api/namespaces/proto/interfaces/IDeviceConsistencyCodeMessage)
*   [IDeviceListMetadata](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata)
*   [IDeviceProps](/docs/api/namespaces/proto/interfaces/IDeviceProps)
*   [IDisappearingMode](/docs/api/namespaces/proto/interfaces/IDisappearingMode)
*   [IEmbeddedContent](/docs/api/namespaces/proto/interfaces/IEmbeddedContent)
*   [IEmbeddedMessage](/docs/api/namespaces/proto/interfaces/IEmbeddedMessage)
*   [IEmbeddedMusic](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic)
*   [IEncryptedPairingRequest](/docs/api/namespaces/proto/interfaces/IEncryptedPairingRequest)
*   [IEphemeralSetting](/docs/api/namespaces/proto/interfaces/IEphemeralSetting)
*   [IEventAdditionalMetadata](/docs/api/namespaces/proto/interfaces/IEventAdditionalMetadata)
*   [IEventResponse](/docs/api/namespaces/proto/interfaces/IEventResponse)
*   [IExitCode](/docs/api/namespaces/proto/interfaces/IExitCode)
*   [IExternalBlobReference](/docs/api/namespaces/proto/interfaces/IExternalBlobReference)
*   [IField](/docs/api/namespaces/proto/interfaces/IField)
*   [IForwardedAIBotMessageInfo](/docs/api/namespaces/proto/interfaces/IForwardedAIBotMessageInfo)
*   [IGlobalSettings](/docs/api/namespaces/proto/interfaces/IGlobalSettings)
*   [IGroupHistoryBundleInfo](/docs/api/namespaces/proto/interfaces/IGroupHistoryBundleInfo)
*   [IGroupHistoryIndividualMessageInfo](/docs/api/namespaces/proto/interfaces/IGroupHistoryIndividualMessageInfo)
*   [IGroupMention](/docs/api/namespaces/proto/interfaces/IGroupMention)
*   [IGroupParticipant](/docs/api/namespaces/proto/interfaces/IGroupParticipant)
*   [IHandshakeMessage](/docs/api/namespaces/proto/interfaces/IHandshakeMessage)
*   [IHistorySync](/docs/api/namespaces/proto/interfaces/IHistorySync)
*   [IHistorySyncMsg](/docs/api/namespaces/proto/interfaces/IHistorySyncMsg)
*   [IHydratedTemplateButton](/docs/api/namespaces/proto/interfaces/IHydratedTemplateButton)
*   [IIdentityKeyPairStructure](/docs/api/namespaces/proto/interfaces/IIdentityKeyPairStructure)
*   [IInteractiveAnnotation](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation)
*   [IInteractiveMessageAdditionalMetadata](/docs/api/namespaces/proto/interfaces/IInteractiveMessageAdditionalMetadata)
*   [IInThreadSurveyMetadata](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata)
*   [IKeepInChat](/docs/api/namespaces/proto/interfaces/IKeepInChat)
*   [IKeyExchangeMessage](/docs/api/namespaces/proto/interfaces/IKeyExchangeMessage)
*   [IKeyId](/docs/api/namespaces/proto/interfaces/IKeyId)
*   [ILegacyMessage](/docs/api/namespaces/proto/interfaces/ILegacyMessage)
*   [ILIDMigrationMapping](/docs/api/namespaces/proto/interfaces/ILIDMigrationMapping)
*   [ILIDMigrationMappingSyncMessage](/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncMessage)
*   [ILIDMigrationMappingSyncPayload](/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncPayload)
*   [ILimitSharing](/docs/api/namespaces/proto/interfaces/ILimitSharing)
*   [ILocalizedName](/docs/api/namespaces/proto/interfaces/ILocalizedName)
*   [ILocation](/docs/api/namespaces/proto/interfaces/ILocation)
*   [IMediaData](/docs/api/namespaces/proto/interfaces/IMediaData)
*   [IMediaNotifyMessage](/docs/api/namespaces/proto/interfaces/IMediaNotifyMessage)
*   [IMediaRetryNotification](/docs/api/namespaces/proto/interfaces/IMediaRetryNotification)
*   [IMemberLabel](/docs/api/namespaces/proto/interfaces/IMemberLabel)
*   [IMessage](/docs/api/namespaces/proto/interfaces/IMessage)
*   [IMessageAddOn](/docs/api/namespaces/proto/interfaces/IMessageAddOn)
*   [IMessageAddOnContextInfo](/docs/api/namespaces/proto/interfaces/IMessageAddOnContextInfo)
*   [IMessageAssociation](/docs/api/namespaces/proto/interfaces/IMessageAssociation)
*   [IMessageContextInfo](/docs/api/namespaces/proto/interfaces/IMessageContextInfo)
*   [IMessageKey](/docs/api/namespaces/proto/interfaces/IMessageKey)
*   [IMessageSecretMessage](/docs/api/namespaces/proto/interfaces/IMessageSecretMessage)
*   [IMoney](/docs/api/namespaces/proto/interfaces/IMoney)
*   [IMsgOpaqueData](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData)
*   [IMsgRowOpaqueData](/docs/api/namespaces/proto/interfaces/IMsgRowOpaqueData)
*   [INoiseCertificate](/docs/api/namespaces/proto/interfaces/INoiseCertificate)
*   [INotificationMessageInfo](/docs/api/namespaces/proto/interfaces/INotificationMessageInfo)
*   [INotificationSettings](/docs/api/namespaces/proto/interfaces/INotificationSettings)
*   [IPairingRequest](/docs/api/namespaces/proto/interfaces/IPairingRequest)
*   [IPastParticipant](/docs/api/namespaces/proto/interfaces/IPastParticipant)
*   [IPastParticipants](/docs/api/namespaces/proto/interfaces/IPastParticipants)
*   [IPatchDebugData](/docs/api/namespaces/proto/interfaces/IPatchDebugData)
*   [IPaymentBackground](/docs/api/namespaces/proto/interfaces/IPaymentBackground)
*   [IPaymentInfo](/docs/api/namespaces/proto/interfaces/IPaymentInfo)
*   [IPhoneNumberToLIDMapping](/docs/api/namespaces/proto/interfaces/IPhoneNumberToLIDMapping)
*   [IPhotoChange](/docs/api/namespaces/proto/interfaces/IPhotoChange)
*   [IPinInChat](/docs/api/namespaces/proto/interfaces/IPinInChat)
*   [IPoint](/docs/api/namespaces/proto/interfaces/IPoint)
*   [IPollAdditionalMetadata](/docs/api/namespaces/proto/interfaces/IPollAdditionalMetadata)
*   [IPollEncValue](/docs/api/namespaces/proto/interfaces/IPollEncValue)
*   [IPollUpdate](/docs/api/namespaces/proto/interfaces/IPollUpdate)
*   [IPreKeyRecordStructure](/docs/api/namespaces/proto/interfaces/IPreKeyRecordStructure)
*   [IPreKeySignalMessage](/docs/api/namespaces/proto/interfaces/IPreKeySignalMessage)
*   [IPremiumMessageInfo](/docs/api/namespaces/proto/interfaces/IPremiumMessageInfo)
*   [IPrimaryEphemeralIdentity](/docs/api/namespaces/proto/interfaces/IPrimaryEphemeralIdentity)
*   [IProcessedVideo](/docs/api/namespaces/proto/interfaces/IProcessedVideo)
*   [IProloguePayload](/docs/api/namespaces/proto/interfaces/IProloguePayload)
*   [IPushname](/docs/api/namespaces/proto/interfaces/IPushname)
*   [IQuarantinedMessage](/docs/api/namespaces/proto/interfaces/IQuarantinedMessage)
*   [IReaction](/docs/api/namespaces/proto/interfaces/IReaction)
*   [IRecentEmojiWeight](/docs/api/namespaces/proto/interfaces/IRecentEmojiWeight)
*   [IRecordStructure](/docs/api/namespaces/proto/interfaces/IRecordStructure)
*   [IReportable](/docs/api/namespaces/proto/interfaces/IReportable)
*   [IReportingTokenInfo](/docs/api/namespaces/proto/interfaces/IReportingTokenInfo)
*   [ISenderKeyDistributionMessage](/docs/api/namespaces/proto/interfaces/ISenderKeyDistributionMessage)
*   [ISenderKeyMessage](/docs/api/namespaces/proto/interfaces/ISenderKeyMessage)
*   [ISenderKeyRecordStructure](/docs/api/namespaces/proto/interfaces/ISenderKeyRecordStructure)
*   [ISenderKeyStateStructure](/docs/api/namespaces/proto/interfaces/ISenderKeyStateStructure)
*   [IServerErrorReceipt](/docs/api/namespaces/proto/interfaces/IServerErrorReceipt)
*   [ISessionStructure](/docs/api/namespaces/proto/interfaces/ISessionStructure)
*   [ISessionTransparencyMetadata](/docs/api/namespaces/proto/interfaces/ISessionTransparencyMetadata)
*   [ISignalMessage](/docs/api/namespaces/proto/interfaces/ISignalMessage)
*   [ISignedPreKeyRecordStructure](/docs/api/namespaces/proto/interfaces/ISignedPreKeyRecordStructure)
*   [IStatusAttribution](/docs/api/namespaces/proto/interfaces/IStatusAttribution)
*   [IStatusMentionMessage](/docs/api/namespaces/proto/interfaces/IStatusMentionMessage)
*   [IStatusPSA](/docs/api/namespaces/proto/interfaces/IStatusPSA)
*   [IStickerMetadata](/docs/api/namespaces/proto/interfaces/IStickerMetadata)
*   [ISyncActionData](/docs/api/namespaces/proto/interfaces/ISyncActionData)
*   [ISyncActionValue](/docs/api/namespaces/proto/interfaces/ISyncActionValue)
*   [ISyncdIndex](/docs/api/namespaces/proto/interfaces/ISyncdIndex)
*   [ISyncdMutation](/docs/api/namespaces/proto/interfaces/ISyncdMutation)
*   [ISyncdMutations](/docs/api/namespaces/proto/interfaces/ISyncdMutations)
*   [ISyncdPatch](/docs/api/namespaces/proto/interfaces/ISyncdPatch)
*   [ISyncdRecord](/docs/api/namespaces/proto/interfaces/ISyncdRecord)
*   [ISyncdSnapshot](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot)
*   [ISyncdValue](/docs/api/namespaces/proto/interfaces/ISyncdValue)
*   [ISyncdVersion](/docs/api/namespaces/proto/interfaces/ISyncdVersion)
*   [ITapLinkAction](/docs/api/namespaces/proto/interfaces/ITapLinkAction)
*   [ITemplateButton](/docs/api/namespaces/proto/interfaces/ITemplateButton)
*   [IThreadID](/docs/api/namespaces/proto/interfaces/IThreadID)
*   [IUrlTrackingMap](/docs/api/namespaces/proto/interfaces/IUrlTrackingMap)
*   [IUserPassword](/docs/api/namespaces/proto/interfaces/IUserPassword)
*   [IUserReceipt](/docs/api/namespaces/proto/interfaces/IUserReceipt)
*   [IVerifiedNameCertificate](/docs/api/namespaces/proto/interfaces/IVerifiedNameCertificate)
*   [IWallpaperSettings](/docs/api/namespaces/proto/interfaces/IWallpaperSettings)
*   [IWebFeatures](/docs/api/namespaces/proto/interfaces/IWebFeatures)
*   [IWebMessageInfo](/docs/api/namespaces/proto/interfaces/IWebMessageInfo)
*   [IWebNotificationsInfo](/docs/api/namespaces/proto/interfaces/IWebNotificationsInfo)

---

<a name="class-advdeviceidentity"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/ADVDeviceIdentity](https://baileys.wiki/docs/api/namespaces/proto/classes/ADVDeviceIdentity)

Defined in: [WAProto/index.d.ts:13](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13)

## Implements[​](#implements "Direct link to Implements")

*   [`IADVDeviceIdentity`](/docs/api/namespaces/proto/interfaces/IADVDeviceIdentity)

## Constructors[​](#constructors "Direct link to Constructors")

### new ADVDeviceIdentity()[​](#new-advdeviceidentity "Direct link to new ADVDeviceIdentity()")

> **new ADVDeviceIdentity**(`p`?): [`ADVDeviceIdentity`](/docs/api/namespaces/proto/classes/ADVDeviceIdentity)

Defined in: [WAProto/index.d.ts:14](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L14)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IADVDeviceIdentity`](/docs/api/namespaces/proto/interfaces/IADVDeviceIdentity)

#### Returns[​](#returns "Direct link to Returns")

[`ADVDeviceIdentity`](/docs/api/namespaces/proto/classes/ADVDeviceIdentity)

## Properties[​](#properties "Direct link to Properties")

### accountType?[​](#accounttype "Direct link to accountType?")

> `optional` **accountType**: `null` | [`ADVEncryptionType`](/docs/api/namespaces/proto/enumerations/ADVEncryptionType)

Defined in: [WAProto/index.d.ts:18](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L18)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IADVDeviceIdentity`](/docs/api/namespaces/proto/interfaces/IADVDeviceIdentity).[`accountType`](/docs/api/namespaces/proto/interfaces/IADVDeviceIdentity#accounttype)

* * *

### deviceType?[​](#devicetype "Direct link to deviceType?")

> `optional` **deviceType**: `null` | [`ADVEncryptionType`](/docs/api/namespaces/proto/enumerations/ADVEncryptionType)

Defined in: [WAProto/index.d.ts:19](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L19)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IADVDeviceIdentity`](/docs/api/namespaces/proto/interfaces/IADVDeviceIdentity).[`deviceType`](/docs/api/namespaces/proto/interfaces/IADVDeviceIdentity#devicetype)

* * *

### keyIndex?[​](#keyindex "Direct link to keyIndex?")

> `optional` **keyIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:17](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L17)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IADVDeviceIdentity`](/docs/api/namespaces/proto/interfaces/IADVDeviceIdentity).[`keyIndex`](/docs/api/namespaces/proto/interfaces/IADVDeviceIdentity#keyindex)

* * *

### rawId?[​](#rawid "Direct link to rawId?")

> `optional` **rawId**: `null` | `number`

Defined in: [WAProto/index.d.ts:15](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L15)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IADVDeviceIdentity`](/docs/api/namespaces/proto/interfaces/IADVDeviceIdentity).[`rawId`](/docs/api/namespaces/proto/interfaces/IADVDeviceIdentity#rawid)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:16](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L16)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IADVDeviceIdentity`](/docs/api/namespaces/proto/interfaces/IADVDeviceIdentity).[`timestamp`](/docs/api/namespaces/proto/interfaces/IADVDeviceIdentity#timestamp)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:25](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L25)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ADVDeviceIdentity`](/docs/api/namespaces/proto/classes/ADVDeviceIdentity)

Defined in: [WAProto/index.d.ts:20](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L20)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IADVDeviceIdentity`](/docs/api/namespaces/proto/interfaces/IADVDeviceIdentity)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ADVDeviceIdentity`](/docs/api/namespaces/proto/classes/ADVDeviceIdentity)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ADVDeviceIdentity`](/docs/api/namespaces/proto/classes/ADVDeviceIdentity)

Defined in: [WAProto/index.d.ts:22](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L22)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ADVDeviceIdentity`](/docs/api/namespaces/proto/classes/ADVDeviceIdentity)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:21](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L21)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IADVDeviceIdentity`](/docs/api/namespaces/proto/interfaces/IADVDeviceIdentity)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ADVDeviceIdentity`](/docs/api/namespaces/proto/classes/ADVDeviceIdentity)

Defined in: [WAProto/index.d.ts:23](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L23)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ADVDeviceIdentity`](/docs/api/namespaces/proto/classes/ADVDeviceIdentity)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:26](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L26)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:24](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L24)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ADVDeviceIdentity`](/docs/api/namespaces/proto/classes/ADVDeviceIdentity)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-advkeyindexlist"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/ADVKeyIndexList](https://baileys.wiki/docs/api/namespaces/proto/classes/ADVKeyIndexList)

Defined in: [WAProto/index.d.ts:42](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L42)

## Implements[​](#implements "Direct link to Implements")

*   [`IADVKeyIndexList`](/docs/api/namespaces/proto/interfaces/IADVKeyIndexList)

## Constructors[​](#constructors "Direct link to Constructors")

### new ADVKeyIndexList()[​](#new-advkeyindexlist "Direct link to new ADVKeyIndexList()")

> **new ADVKeyIndexList**(`p`?): [`ADVKeyIndexList`](/docs/api/namespaces/proto/classes/ADVKeyIndexList)

Defined in: [WAProto/index.d.ts:43](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L43)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IADVKeyIndexList`](/docs/api/namespaces/proto/interfaces/IADVKeyIndexList)

#### Returns[​](#returns "Direct link to Returns")

[`ADVKeyIndexList`](/docs/api/namespaces/proto/classes/ADVKeyIndexList)

## Properties[​](#properties "Direct link to Properties")

### accountType?[​](#accounttype "Direct link to accountType?")

> `optional` **accountType**: `null` | [`ADVEncryptionType`](/docs/api/namespaces/proto/enumerations/ADVEncryptionType)

Defined in: [WAProto/index.d.ts:48](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L48)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IADVKeyIndexList`](/docs/api/namespaces/proto/interfaces/IADVKeyIndexList).[`accountType`](/docs/api/namespaces/proto/interfaces/IADVKeyIndexList#accounttype)

* * *

### currentIndex?[​](#currentindex "Direct link to currentIndex?")

> `optional` **currentIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:46](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L46)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IADVKeyIndexList`](/docs/api/namespaces/proto/interfaces/IADVKeyIndexList).[`currentIndex`](/docs/api/namespaces/proto/interfaces/IADVKeyIndexList#currentindex)

* * *

### rawId?[​](#rawid "Direct link to rawId?")

> `optional` **rawId**: `null` | `number`

Defined in: [WAProto/index.d.ts:44](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L44)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IADVKeyIndexList`](/docs/api/namespaces/proto/interfaces/IADVKeyIndexList).[`rawId`](/docs/api/namespaces/proto/interfaces/IADVKeyIndexList#rawid)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:45](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L45)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IADVKeyIndexList`](/docs/api/namespaces/proto/interfaces/IADVKeyIndexList).[`timestamp`](/docs/api/namespaces/proto/interfaces/IADVKeyIndexList#timestamp)

* * *

### validIndexes[​](#validindexes "Direct link to validIndexes")

> **validIndexes**: `number`\[\]

Defined in: [WAProto/index.d.ts:47](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L47)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IADVKeyIndexList`](/docs/api/namespaces/proto/interfaces/IADVKeyIndexList).[`validIndexes`](/docs/api/namespaces/proto/interfaces/IADVKeyIndexList#validindexes)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:54](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L54)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ADVKeyIndexList`](/docs/api/namespaces/proto/classes/ADVKeyIndexList)

Defined in: [WAProto/index.d.ts:49](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L49)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IADVKeyIndexList`](/docs/api/namespaces/proto/interfaces/IADVKeyIndexList)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ADVKeyIndexList`](/docs/api/namespaces/proto/classes/ADVKeyIndexList)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ADVKeyIndexList`](/docs/api/namespaces/proto/classes/ADVKeyIndexList)

Defined in: [WAProto/index.d.ts:51](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L51)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ADVKeyIndexList`](/docs/api/namespaces/proto/classes/ADVKeyIndexList)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:50](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L50)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IADVKeyIndexList`](/docs/api/namespaces/proto/interfaces/IADVKeyIndexList)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ADVKeyIndexList`](/docs/api/namespaces/proto/classes/ADVKeyIndexList)

Defined in: [WAProto/index.d.ts:52](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L52)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ADVKeyIndexList`](/docs/api/namespaces/proto/classes/ADVKeyIndexList)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:55](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L55)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:53](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L53)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ADVKeyIndexList`](/docs/api/namespaces/proto/classes/ADVKeyIndexList)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-advsigneddeviceidentity"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentity](https://baileys.wiki/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentity)

Defined in: [WAProto/index.d.ts:65](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L65)

## Implements[​](#implements "Direct link to Implements")

*   [`IADVSignedDeviceIdentity`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentity)

## Constructors[​](#constructors "Direct link to Constructors")

### new ADVSignedDeviceIdentity()[​](#new-advsigneddeviceidentity "Direct link to new ADVSignedDeviceIdentity()")

> **new ADVSignedDeviceIdentity**(`p`?): [`ADVSignedDeviceIdentity`](/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentity)

Defined in: [WAProto/index.d.ts:66](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L66)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IADVSignedDeviceIdentity`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentity)

#### Returns[​](#returns "Direct link to Returns")

[`ADVSignedDeviceIdentity`](/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentity)

## Properties[​](#properties "Direct link to Properties")

### accountSignature?[​](#accountsignature "Direct link to accountSignature?")

> `optional` **accountSignature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:69](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L69)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IADVSignedDeviceIdentity`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentity).[`accountSignature`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentity#accountsignature)

* * *

### accountSignatureKey?[​](#accountsignaturekey "Direct link to accountSignatureKey?")

> `optional` **accountSignatureKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:68](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L68)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IADVSignedDeviceIdentity`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentity).[`accountSignatureKey`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentity#accountsignaturekey)

* * *

### details?[​](#details "Direct link to details?")

> `optional` **details**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:67](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L67)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IADVSignedDeviceIdentity`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentity).[`details`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentity#details)

* * *

### deviceSignature?[​](#devicesignature "Direct link to deviceSignature?")

> `optional` **deviceSignature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:70](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L70)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IADVSignedDeviceIdentity`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentity).[`deviceSignature`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentity#devicesignature)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:76](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L76)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ADVSignedDeviceIdentity`](/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentity)

Defined in: [WAProto/index.d.ts:71](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L71)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IADVSignedDeviceIdentity`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentity)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ADVSignedDeviceIdentity`](/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentity)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ADVSignedDeviceIdentity`](/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentity)

Defined in: [WAProto/index.d.ts:73](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L73)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ADVSignedDeviceIdentity`](/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentity)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:72](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L72)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IADVSignedDeviceIdentity`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentity)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ADVSignedDeviceIdentity`](/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentity)

Defined in: [WAProto/index.d.ts:74](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L74)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ADVSignedDeviceIdentity`](/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentity)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:77](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L77)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:75](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L75)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ADVSignedDeviceIdentity`](/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentity)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-advsigneddeviceidentityhmac"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentityHMAC](https://baileys.wiki/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentityHMAC)

Defined in: [WAProto/index.d.ts:86](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L86)

## Implements[​](#implements "Direct link to Implements")

*   [`IADVSignedDeviceIdentityHMAC`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentityHMAC)

## Constructors[​](#constructors "Direct link to Constructors")

### new ADVSignedDeviceIdentityHMAC()[​](#new-advsigneddeviceidentityhmac "Direct link to new ADVSignedDeviceIdentityHMAC()")

> **new ADVSignedDeviceIdentityHMAC**(`p`?): [`ADVSignedDeviceIdentityHMAC`](/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentityHMAC)

Defined in: [WAProto/index.d.ts:87](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L87)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IADVSignedDeviceIdentityHMAC`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentityHMAC)

#### Returns[​](#returns "Direct link to Returns")

[`ADVSignedDeviceIdentityHMAC`](/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentityHMAC)

## Properties[​](#properties "Direct link to Properties")

### accountType?[​](#accounttype "Direct link to accountType?")

> `optional` **accountType**: `null` | [`ADVEncryptionType`](/docs/api/namespaces/proto/enumerations/ADVEncryptionType)

Defined in: [WAProto/index.d.ts:90](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L90)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IADVSignedDeviceIdentityHMAC`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentityHMAC).[`accountType`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentityHMAC#accounttype)

* * *

### details?[​](#details "Direct link to details?")

> `optional` **details**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:88](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L88)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IADVSignedDeviceIdentityHMAC`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentityHMAC).[`details`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentityHMAC#details)

* * *

### hmac?[​](#hmac "Direct link to hmac?")

> `optional` **hmac**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:89](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L89)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IADVSignedDeviceIdentityHMAC`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentityHMAC).[`hmac`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentityHMAC#hmac)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:96](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L96)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ADVSignedDeviceIdentityHMAC`](/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentityHMAC)

Defined in: [WAProto/index.d.ts:91](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L91)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IADVSignedDeviceIdentityHMAC`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentityHMAC)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ADVSignedDeviceIdentityHMAC`](/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentityHMAC)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ADVSignedDeviceIdentityHMAC`](/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentityHMAC)

Defined in: [WAProto/index.d.ts:93](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L93)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ADVSignedDeviceIdentityHMAC`](/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentityHMAC)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:92](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L92)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IADVSignedDeviceIdentityHMAC`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentityHMAC)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ADVSignedDeviceIdentityHMAC`](/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentityHMAC)

Defined in: [WAProto/index.d.ts:94](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L94)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ADVSignedDeviceIdentityHMAC`](/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentityHMAC)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:97](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L97)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:95](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L95)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ADVSignedDeviceIdentityHMAC`](/docs/api/namespaces/proto/classes/ADVSignedDeviceIdentityHMAC)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-advsignedkeyindexlist"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/ADVSignedKeyIndexList](https://baileys.wiki/docs/api/namespaces/proto/classes/ADVSignedKeyIndexList)

Defined in: [WAProto/index.d.ts:106](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L106)

## Implements[​](#implements "Direct link to Implements")

*   [`IADVSignedKeyIndexList`](/docs/api/namespaces/proto/interfaces/IADVSignedKeyIndexList)

## Constructors[​](#constructors "Direct link to Constructors")

### new ADVSignedKeyIndexList()[​](#new-advsignedkeyindexlist "Direct link to new ADVSignedKeyIndexList()")

> **new ADVSignedKeyIndexList**(`p`?): [`ADVSignedKeyIndexList`](/docs/api/namespaces/proto/classes/ADVSignedKeyIndexList)

Defined in: [WAProto/index.d.ts:107](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L107)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IADVSignedKeyIndexList`](/docs/api/namespaces/proto/interfaces/IADVSignedKeyIndexList)

#### Returns[​](#returns "Direct link to Returns")

[`ADVSignedKeyIndexList`](/docs/api/namespaces/proto/classes/ADVSignedKeyIndexList)

## Properties[​](#properties "Direct link to Properties")

### accountSignature?[​](#accountsignature "Direct link to accountSignature?")

> `optional` **accountSignature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:109](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L109)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IADVSignedKeyIndexList`](/docs/api/namespaces/proto/interfaces/IADVSignedKeyIndexList).[`accountSignature`](/docs/api/namespaces/proto/interfaces/IADVSignedKeyIndexList#accountsignature)

* * *

### accountSignatureKey?[​](#accountsignaturekey "Direct link to accountSignatureKey?")

> `optional` **accountSignatureKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:110](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L110)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IADVSignedKeyIndexList`](/docs/api/namespaces/proto/interfaces/IADVSignedKeyIndexList).[`accountSignatureKey`](/docs/api/namespaces/proto/interfaces/IADVSignedKeyIndexList#accountsignaturekey)

* * *

### details?[​](#details "Direct link to details?")

> `optional` **details**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:108](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L108)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IADVSignedKeyIndexList`](/docs/api/namespaces/proto/interfaces/IADVSignedKeyIndexList).[`details`](/docs/api/namespaces/proto/interfaces/IADVSignedKeyIndexList#details)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:116](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L116)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ADVSignedKeyIndexList`](/docs/api/namespaces/proto/classes/ADVSignedKeyIndexList)

Defined in: [WAProto/index.d.ts:111](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L111)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IADVSignedKeyIndexList`](/docs/api/namespaces/proto/interfaces/IADVSignedKeyIndexList)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ADVSignedKeyIndexList`](/docs/api/namespaces/proto/classes/ADVSignedKeyIndexList)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ADVSignedKeyIndexList`](/docs/api/namespaces/proto/classes/ADVSignedKeyIndexList)

Defined in: [WAProto/index.d.ts:113](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L113)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ADVSignedKeyIndexList`](/docs/api/namespaces/proto/classes/ADVSignedKeyIndexList)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:112](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L112)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IADVSignedKeyIndexList`](/docs/api/namespaces/proto/interfaces/IADVSignedKeyIndexList)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ADVSignedKeyIndexList`](/docs/api/namespaces/proto/classes/ADVSignedKeyIndexList)

Defined in: [WAProto/index.d.ts:114](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L114)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ADVSignedKeyIndexList`](/docs/api/namespaces/proto/classes/ADVSignedKeyIndexList)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:117](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L117)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:115](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L115)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ADVSignedKeyIndexList`](/docs/api/namespaces/proto/classes/ADVSignedKeyIndexList)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-aihomestate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/AIHomeState](https://baileys.wiki/docs/api/namespaces/proto/classes/AIHomeState)

Defined in: [WAProto/index.d.ts:126](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L126)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIHomeState`](/docs/api/namespaces/proto/interfaces/IAIHomeState)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIHomeState()[​](#new-aihomestate "Direct link to new AIHomeState()")

> **new AIHomeState**(`p`?): [`AIHomeState`](/docs/api/namespaces/proto/classes/AIHomeState)

Defined in: [WAProto/index.d.ts:127](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L127)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIHomeState`](/docs/api/namespaces/proto/interfaces/IAIHomeState)

#### Returns[​](#returns "Direct link to Returns")

[`AIHomeState`](/docs/api/namespaces/proto/classes/AIHomeState)

## Properties[​](#properties "Direct link to Properties")

### capabilityOptions[​](#capabilityoptions "Direct link to capabilityOptions")

> **capabilityOptions**: [`IAIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption)\[\]

Defined in: [WAProto/index.d.ts:129](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L129)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIHomeState`](/docs/api/namespaces/proto/interfaces/IAIHomeState).[`capabilityOptions`](/docs/api/namespaces/proto/interfaces/IAIHomeState#capabilityoptions)

* * *

### conversationOptions[​](#conversationoptions "Direct link to conversationOptions")

> **conversationOptions**: [`IAIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption)\[\]

Defined in: [WAProto/index.d.ts:130](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L130)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIHomeState`](/docs/api/namespaces/proto/interfaces/IAIHomeState).[`conversationOptions`](/docs/api/namespaces/proto/interfaces/IAIHomeState#conversationoptions)

* * *

### lastFetchTime?[​](#lastfetchtime "Direct link to lastFetchTime?")

> `optional` **lastFetchTime**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:128](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L128)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAIHomeState`](/docs/api/namespaces/proto/interfaces/IAIHomeState).[`lastFetchTime`](/docs/api/namespaces/proto/interfaces/IAIHomeState#lastfetchtime)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:136](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L136)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIHomeState`](/docs/api/namespaces/proto/classes/AIHomeState)

Defined in: [WAProto/index.d.ts:131](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L131)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIHomeState`](/docs/api/namespaces/proto/interfaces/IAIHomeState)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIHomeState`](/docs/api/namespaces/proto/classes/AIHomeState)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIHomeState`](/docs/api/namespaces/proto/classes/AIHomeState)

Defined in: [WAProto/index.d.ts:133](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L133)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIHomeState`](/docs/api/namespaces/proto/classes/AIHomeState)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:132](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L132)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIHomeState`](/docs/api/namespaces/proto/interfaces/IAIHomeState)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIHomeState`](/docs/api/namespaces/proto/classes/AIHomeState)

Defined in: [WAProto/index.d.ts:134](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L134)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIHomeState`](/docs/api/namespaces/proto/classes/AIHomeState)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:137](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L137)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:135](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L135)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIHomeState`](/docs/api/namespaces/proto/classes/AIHomeState)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-aiqueryfanout"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/AIQueryFanout](https://baileys.wiki/docs/api/namespaces/proto/classes/AIQueryFanout)

Defined in: [WAProto/index.d.ts:187](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L187)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIQueryFanout`](/docs/api/namespaces/proto/interfaces/IAIQueryFanout)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIQueryFanout()[​](#new-aiqueryfanout "Direct link to new AIQueryFanout()")

> **new AIQueryFanout**(`p`?): [`AIQueryFanout`](/docs/api/namespaces/proto/classes/AIQueryFanout)

Defined in: [WAProto/index.d.ts:188](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L188)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIQueryFanout`](/docs/api/namespaces/proto/interfaces/IAIQueryFanout)

#### Returns[​](#returns "Direct link to Returns")

[`AIQueryFanout`](/docs/api/namespaces/proto/classes/AIQueryFanout)

## Properties[​](#properties "Direct link to Properties")

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:190](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L190)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIQueryFanout`](/docs/api/namespaces/proto/interfaces/IAIQueryFanout).[`message`](/docs/api/namespaces/proto/interfaces/IAIQueryFanout#message)

* * *

### messageKey?[​](#messagekey "Direct link to messageKey?")

> `optional` **messageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:189](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L189)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIQueryFanout`](/docs/api/namespaces/proto/interfaces/IAIQueryFanout).[`messageKey`](/docs/api/namespaces/proto/interfaces/IAIQueryFanout#messagekey)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:191](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L191)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAIQueryFanout`](/docs/api/namespaces/proto/interfaces/IAIQueryFanout).[`timestamp`](/docs/api/namespaces/proto/interfaces/IAIQueryFanout#timestamp)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:197](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L197)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIQueryFanout`](/docs/api/namespaces/proto/classes/AIQueryFanout)

Defined in: [WAProto/index.d.ts:192](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L192)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIQueryFanout`](/docs/api/namespaces/proto/interfaces/IAIQueryFanout)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIQueryFanout`](/docs/api/namespaces/proto/classes/AIQueryFanout)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIQueryFanout`](/docs/api/namespaces/proto/classes/AIQueryFanout)

Defined in: [WAProto/index.d.ts:194](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L194)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIQueryFanout`](/docs/api/namespaces/proto/classes/AIQueryFanout)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:193](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L193)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIQueryFanout`](/docs/api/namespaces/proto/interfaces/IAIQueryFanout)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIQueryFanout`](/docs/api/namespaces/proto/classes/AIQueryFanout)

Defined in: [WAProto/index.d.ts:195](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L195)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIQueryFanout`](/docs/api/namespaces/proto/classes/AIQueryFanout)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:198](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L198)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:196](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L196)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIQueryFanout`](/docs/api/namespaces/proto/classes/AIQueryFanout)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-airegeneratemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/AIRegenerateMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/AIRegenerateMetadata)

Defined in: [WAProto/index.d.ts:206](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L206)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIRegenerateMetadata`](/docs/api/namespaces/proto/interfaces/IAIRegenerateMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIRegenerateMetadata()[​](#new-airegeneratemetadata "Direct link to new AIRegenerateMetadata()")

> **new AIRegenerateMetadata**(`p`?): [`AIRegenerateMetadata`](/docs/api/namespaces/proto/classes/AIRegenerateMetadata)

Defined in: [WAProto/index.d.ts:207](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L207)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIRegenerateMetadata`](/docs/api/namespaces/proto/interfaces/IAIRegenerateMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`AIRegenerateMetadata`](/docs/api/namespaces/proto/classes/AIRegenerateMetadata)

## Properties[​](#properties "Direct link to Properties")

### messageKey?[​](#messagekey "Direct link to messageKey?")

> `optional` **messageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:208](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L208)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIRegenerateMetadata`](/docs/api/namespaces/proto/interfaces/IAIRegenerateMetadata).[`messageKey`](/docs/api/namespaces/proto/interfaces/IAIRegenerateMetadata#messagekey)

* * *

### responseTimestampMs?[​](#responsetimestampms "Direct link to responseTimestampMs?")

> `optional` **responseTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:209](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L209)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIRegenerateMetadata`](/docs/api/namespaces/proto/interfaces/IAIRegenerateMetadata).[`responseTimestampMs`](/docs/api/namespaces/proto/interfaces/IAIRegenerateMetadata#responsetimestampms)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:215](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L215)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIRegenerateMetadata`](/docs/api/namespaces/proto/classes/AIRegenerateMetadata)

Defined in: [WAProto/index.d.ts:210](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L210)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIRegenerateMetadata`](/docs/api/namespaces/proto/interfaces/IAIRegenerateMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIRegenerateMetadata`](/docs/api/namespaces/proto/classes/AIRegenerateMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIRegenerateMetadata`](/docs/api/namespaces/proto/classes/AIRegenerateMetadata)

Defined in: [WAProto/index.d.ts:212](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L212)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIRegenerateMetadata`](/docs/api/namespaces/proto/classes/AIRegenerateMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:211](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L211)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIRegenerateMetadata`](/docs/api/namespaces/proto/interfaces/IAIRegenerateMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIRegenerateMetadata`](/docs/api/namespaces/proto/classes/AIRegenerateMetadata)

Defined in: [WAProto/index.d.ts:213](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L213)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIRegenerateMetadata`](/docs/api/namespaces/proto/classes/AIRegenerateMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:216](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L216)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:214](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L214)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIRegenerateMetadata`](/docs/api/namespaces/proto/classes/AIRegenerateMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-airichresponsecodemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseCodeMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseCodeMetadata)

Defined in: [WAProto/index.d.ts:224](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L224)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIRichResponseCodeMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseCodeMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIRichResponseCodeMetadata()[​](#new-airichresponsecodemetadata "Direct link to new AIRichResponseCodeMetadata()")

> **new AIRichResponseCodeMetadata**(`p`?): [`AIRichResponseCodeMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseCodeMetadata)

Defined in: [WAProto/index.d.ts:225](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L225)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIRichResponseCodeMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseCodeMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`AIRichResponseCodeMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseCodeMetadata)

## Properties[​](#properties "Direct link to Properties")

### codeBlocks[​](#codeblocks "Direct link to codeBlocks")

> **codeBlocks**: [`IAIRichResponseCodeBlock`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/interfaces/IAIRichResponseCodeBlock)\[\]

Defined in: [WAProto/index.d.ts:227](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L227)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIRichResponseCodeMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseCodeMetadata).[`codeBlocks`](/docs/api/namespaces/proto/interfaces/IAIRichResponseCodeMetadata#codeblocks)

* * *

### codeLanguage?[​](#codelanguage "Direct link to codeLanguage?")

> `optional` **codeLanguage**: `null` | `string`

Defined in: [WAProto/index.d.ts:226](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L226)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIRichResponseCodeMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseCodeMetadata).[`codeLanguage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseCodeMetadata#codelanguage)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:233](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L233)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIRichResponseCodeMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseCodeMetadata)

Defined in: [WAProto/index.d.ts:228](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L228)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIRichResponseCodeMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseCodeMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIRichResponseCodeMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseCodeMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIRichResponseCodeMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseCodeMetadata)

Defined in: [WAProto/index.d.ts:230](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L230)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIRichResponseCodeMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseCodeMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:229](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L229)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIRichResponseCodeMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseCodeMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIRichResponseCodeMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseCodeMetadata)

Defined in: [WAProto/index.d.ts:231](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L231)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIRichResponseCodeMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseCodeMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:234](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L234)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:232](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L232)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIRichResponseCodeMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseCodeMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-airichresponsecontentitemsmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseContentItemsMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseContentItemsMetadata)

Defined in: [WAProto/index.d.ts:272](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L272)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIRichResponseContentItemsMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseContentItemsMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIRichResponseContentItemsMetadata()[​](#new-airichresponsecontentitemsmetadata "Direct link to new AIRichResponseContentItemsMetadata()")

> **new AIRichResponseContentItemsMetadata**(`p`?): [`AIRichResponseContentItemsMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseContentItemsMetadata)

Defined in: [WAProto/index.d.ts:273](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L273)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIRichResponseContentItemsMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseContentItemsMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`AIRichResponseContentItemsMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseContentItemsMetadata)

## Properties[​](#properties "Direct link to Properties")

### contentType?[​](#contenttype "Direct link to contentType?")

> `optional` **contentType**: `null` | [`ContentType`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/enumerations/ContentType)

Defined in: [WAProto/index.d.ts:275](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L275)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIRichResponseContentItemsMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseContentItemsMetadata).[`contentType`](/docs/api/namespaces/proto/interfaces/IAIRichResponseContentItemsMetadata#contenttype)

* * *

### itemsMetadata[​](#itemsmetadata "Direct link to itemsMetadata")

> **itemsMetadata**: [`IAIRichResponseContentItemMetadata`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseContentItemMetadata)\[\]

Defined in: [WAProto/index.d.ts:274](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L274)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIRichResponseContentItemsMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseContentItemsMetadata).[`itemsMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseContentItemsMetadata#itemsmetadata)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:281](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L281)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIRichResponseContentItemsMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseContentItemsMetadata)

Defined in: [WAProto/index.d.ts:276](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L276)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIRichResponseContentItemsMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseContentItemsMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIRichResponseContentItemsMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseContentItemsMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIRichResponseContentItemsMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseContentItemsMetadata)

Defined in: [WAProto/index.d.ts:278](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L278)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIRichResponseContentItemsMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseContentItemsMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:277](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L277)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIRichResponseContentItemsMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseContentItemsMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIRichResponseContentItemsMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseContentItemsMetadata)

Defined in: [WAProto/index.d.ts:279](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L279)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIRichResponseContentItemsMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseContentItemsMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:282](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L282)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:280](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L280)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIRichResponseContentItemsMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseContentItemsMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-airichresponsedynamicmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseDynamicMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseDynamicMetadata)

Defined in: [WAProto/index.d.ts:339](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L339)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIRichResponseDynamicMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseDynamicMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIRichResponseDynamicMetadata()[​](#new-airichresponsedynamicmetadata "Direct link to new AIRichResponseDynamicMetadata()")

> **new AIRichResponseDynamicMetadata**(`p`?): [`AIRichResponseDynamicMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseDynamicMetadata)

Defined in: [WAProto/index.d.ts:340](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L340)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIRichResponseDynamicMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseDynamicMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`AIRichResponseDynamicMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseDynamicMetadata)

## Properties[​](#properties "Direct link to Properties")

### loopCount?[​](#loopcount "Direct link to loopCount?")

> `optional` **loopCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:344](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L344)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIRichResponseDynamicMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseDynamicMetadata).[`loopCount`](/docs/api/namespaces/proto/interfaces/IAIRichResponseDynamicMetadata#loopcount)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`AIRichResponseDynamicMetadataType`](/docs/api/namespaces/proto/namespaces/AIRichResponseDynamicMetadata/enumerations/AIRichResponseDynamicMetadataType)

Defined in: [WAProto/index.d.ts:341](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L341)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIRichResponseDynamicMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseDynamicMetadata).[`type`](/docs/api/namespaces/proto/interfaces/IAIRichResponseDynamicMetadata#type)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:343](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L343)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAIRichResponseDynamicMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseDynamicMetadata).[`url`](/docs/api/namespaces/proto/interfaces/IAIRichResponseDynamicMetadata#url)

* * *

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:342](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L342)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IAIRichResponseDynamicMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseDynamicMetadata).[`version`](/docs/api/namespaces/proto/interfaces/IAIRichResponseDynamicMetadata#version)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:350](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L350)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIRichResponseDynamicMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseDynamicMetadata)

Defined in: [WAProto/index.d.ts:345](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L345)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIRichResponseDynamicMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseDynamicMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIRichResponseDynamicMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseDynamicMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIRichResponseDynamicMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseDynamicMetadata)

Defined in: [WAProto/index.d.ts:347](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L347)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIRichResponseDynamicMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseDynamicMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:346](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L346)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIRichResponseDynamicMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseDynamicMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIRichResponseDynamicMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseDynamicMetadata)

Defined in: [WAProto/index.d.ts:348](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L348)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIRichResponseDynamicMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseDynamicMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:351](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L351)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:349](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L349)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIRichResponseDynamicMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseDynamicMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-airichresponsegridimagemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseGridImageMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseGridImageMetadata)

Defined in: [WAProto/index.d.ts:368](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L368)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIRichResponseGridImageMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseGridImageMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIRichResponseGridImageMetadata()[​](#new-airichresponsegridimagemetadata "Direct link to new AIRichResponseGridImageMetadata()")

> **new AIRichResponseGridImageMetadata**(`p`?): [`AIRichResponseGridImageMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseGridImageMetadata)

Defined in: [WAProto/index.d.ts:369](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L369)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIRichResponseGridImageMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseGridImageMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`AIRichResponseGridImageMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseGridImageMetadata)

## Properties[​](#properties "Direct link to Properties")

### gridImageUrl?[​](#gridimageurl "Direct link to gridImageUrl?")

> `optional` **gridImageUrl**: `null` | [`IAIRichResponseImageURL`](/docs/api/namespaces/proto/interfaces/IAIRichResponseImageURL)

Defined in: [WAProto/index.d.ts:370](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L370)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIRichResponseGridImageMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseGridImageMetadata).[`gridImageUrl`](/docs/api/namespaces/proto/interfaces/IAIRichResponseGridImageMetadata#gridimageurl)

* * *

### imageUrls[​](#imageurls "Direct link to imageUrls")

> **imageUrls**: [`IAIRichResponseImageURL`](/docs/api/namespaces/proto/interfaces/IAIRichResponseImageURL)\[\]

Defined in: [WAProto/index.d.ts:371](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L371)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIRichResponseGridImageMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseGridImageMetadata).[`imageUrls`](/docs/api/namespaces/proto/interfaces/IAIRichResponseGridImageMetadata#imageurls)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:377](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L377)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIRichResponseGridImageMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseGridImageMetadata)

Defined in: [WAProto/index.d.ts:372](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L372)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIRichResponseGridImageMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseGridImageMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIRichResponseGridImageMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseGridImageMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIRichResponseGridImageMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseGridImageMetadata)

Defined in: [WAProto/index.d.ts:374](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L374)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIRichResponseGridImageMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseGridImageMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:373](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L373)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIRichResponseGridImageMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseGridImageMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIRichResponseGridImageMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseGridImageMetadata)

Defined in: [WAProto/index.d.ts:375](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L375)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIRichResponseGridImageMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseGridImageMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:378](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L378)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:376](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L376)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIRichResponseGridImageMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseGridImageMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-airichresponseimageurl"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseImageURL](https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseImageURL)

Defined in: [WAProto/index.d.ts:387](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L387)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIRichResponseImageURL`](/docs/api/namespaces/proto/interfaces/IAIRichResponseImageURL)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIRichResponseImageURL()[​](#new-airichresponseimageurl "Direct link to new AIRichResponseImageURL()")

> **new AIRichResponseImageURL**(`p`?): [`AIRichResponseImageURL`](/docs/api/namespaces/proto/classes/AIRichResponseImageURL)

Defined in: [WAProto/index.d.ts:388](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L388)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIRichResponseImageURL`](/docs/api/namespaces/proto/interfaces/IAIRichResponseImageURL)

#### Returns[​](#returns "Direct link to Returns")

[`AIRichResponseImageURL`](/docs/api/namespaces/proto/classes/AIRichResponseImageURL)

## Properties[​](#properties "Direct link to Properties")

### imageHighResUrl?[​](#imagehighresurl "Direct link to imageHighResUrl?")

> `optional` **imageHighResUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:390](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L390)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIRichResponseImageURL`](/docs/api/namespaces/proto/interfaces/IAIRichResponseImageURL).[`imageHighResUrl`](/docs/api/namespaces/proto/interfaces/IAIRichResponseImageURL#imagehighresurl)

* * *

### imagePreviewUrl?[​](#imagepreviewurl "Direct link to imagePreviewUrl?")

> `optional` **imagePreviewUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:389](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L389)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIRichResponseImageURL`](/docs/api/namespaces/proto/interfaces/IAIRichResponseImageURL).[`imagePreviewUrl`](/docs/api/namespaces/proto/interfaces/IAIRichResponseImageURL#imagepreviewurl)

* * *

### sourceUrl?[​](#sourceurl "Direct link to sourceUrl?")

> `optional` **sourceUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:391](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L391)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAIRichResponseImageURL`](/docs/api/namespaces/proto/interfaces/IAIRichResponseImageURL).[`sourceUrl`](/docs/api/namespaces/proto/interfaces/IAIRichResponseImageURL#sourceurl)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:397](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L397)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIRichResponseImageURL`](/docs/api/namespaces/proto/classes/AIRichResponseImageURL)

Defined in: [WAProto/index.d.ts:392](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L392)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIRichResponseImageURL`](/docs/api/namespaces/proto/interfaces/IAIRichResponseImageURL)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIRichResponseImageURL`](/docs/api/namespaces/proto/classes/AIRichResponseImageURL)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIRichResponseImageURL`](/docs/api/namespaces/proto/classes/AIRichResponseImageURL)

Defined in: [WAProto/index.d.ts:394](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L394)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIRichResponseImageURL`](/docs/api/namespaces/proto/classes/AIRichResponseImageURL)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:393](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L393)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIRichResponseImageURL`](/docs/api/namespaces/proto/interfaces/IAIRichResponseImageURL)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIRichResponseImageURL`](/docs/api/namespaces/proto/classes/AIRichResponseImageURL)

Defined in: [WAProto/index.d.ts:395](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L395)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIRichResponseImageURL`](/docs/api/namespaces/proto/classes/AIRichResponseImageURL)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:398](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L398)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:396](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L396)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIRichResponseImageURL`](/docs/api/namespaces/proto/classes/AIRichResponseImageURL)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-airichresponseinlineimagemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseInlineImageMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseInlineImageMetadata)

Defined in: [WAProto/index.d.ts:408](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L408)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIRichResponseInlineImageMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseInlineImageMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIRichResponseInlineImageMetadata()[​](#new-airichresponseinlineimagemetadata "Direct link to new AIRichResponseInlineImageMetadata()")

> **new AIRichResponseInlineImageMetadata**(`p`?): [`AIRichResponseInlineImageMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseInlineImageMetadata)

Defined in: [WAProto/index.d.ts:409](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L409)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIRichResponseInlineImageMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseInlineImageMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`AIRichResponseInlineImageMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseInlineImageMetadata)

## Properties[​](#properties "Direct link to Properties")

### alignment?[​](#alignment "Direct link to alignment?")

> `optional` **alignment**: `null` | [`AIRichResponseImageAlignment`](/docs/api/namespaces/proto/namespaces/AIRichResponseInlineImageMetadata/enumerations/AIRichResponseImageAlignment)

Defined in: [WAProto/index.d.ts:412](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L412)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIRichResponseInlineImageMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseInlineImageMetadata).[`alignment`](/docs/api/namespaces/proto/interfaces/IAIRichResponseInlineImageMetadata#alignment)

* * *

### imageText?[​](#imagetext "Direct link to imageText?")

> `optional` **imageText**: `null` | `string`

Defined in: [WAProto/index.d.ts:411](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L411)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIRichResponseInlineImageMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseInlineImageMetadata).[`imageText`](/docs/api/namespaces/proto/interfaces/IAIRichResponseInlineImageMetadata#imagetext)

* * *

### imageUrl?[​](#imageurl "Direct link to imageUrl?")

> `optional` **imageUrl**: `null` | [`IAIRichResponseImageURL`](/docs/api/namespaces/proto/interfaces/IAIRichResponseImageURL)

Defined in: [WAProto/index.d.ts:410](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L410)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAIRichResponseInlineImageMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseInlineImageMetadata).[`imageUrl`](/docs/api/namespaces/proto/interfaces/IAIRichResponseInlineImageMetadata#imageurl)

* * *

### tapLinkUrl?[​](#taplinkurl "Direct link to tapLinkUrl?")

> `optional` **tapLinkUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:413](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L413)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IAIRichResponseInlineImageMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseInlineImageMetadata).[`tapLinkUrl`](/docs/api/namespaces/proto/interfaces/IAIRichResponseInlineImageMetadata#taplinkurl)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:419](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L419)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIRichResponseInlineImageMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseInlineImageMetadata)

Defined in: [WAProto/index.d.ts:414](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L414)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIRichResponseInlineImageMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseInlineImageMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIRichResponseInlineImageMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseInlineImageMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIRichResponseInlineImageMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseInlineImageMetadata)

Defined in: [WAProto/index.d.ts:416](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L416)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIRichResponseInlineImageMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseInlineImageMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:415](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L415)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIRichResponseInlineImageMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseInlineImageMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIRichResponseInlineImageMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseInlineImageMetadata)

Defined in: [WAProto/index.d.ts:417](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L417)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIRichResponseInlineImageMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseInlineImageMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:420](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L420)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:418](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L418)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIRichResponseInlineImageMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseInlineImageMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-airichresponselatexmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseLatexMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseLatexMetadata)

Defined in: [WAProto/index.d.ts:437](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L437)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIRichResponseLatexMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseLatexMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIRichResponseLatexMetadata()[​](#new-airichresponselatexmetadata "Direct link to new AIRichResponseLatexMetadata()")

> **new AIRichResponseLatexMetadata**(`p`?): [`AIRichResponseLatexMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseLatexMetadata)

Defined in: [WAProto/index.d.ts:438](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L438)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIRichResponseLatexMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseLatexMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`AIRichResponseLatexMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseLatexMetadata)

## Properties[​](#properties "Direct link to Properties")

### expressions[​](#expressions "Direct link to expressions")

> **expressions**: [`IAIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression)\[\]

Defined in: [WAProto/index.d.ts:440](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L440)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIRichResponseLatexMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseLatexMetadata).[`expressions`](/docs/api/namespaces/proto/interfaces/IAIRichResponseLatexMetadata#expressions)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:439](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L439)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIRichResponseLatexMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseLatexMetadata).[`text`](/docs/api/namespaces/proto/interfaces/IAIRichResponseLatexMetadata#text)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:446](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L446)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIRichResponseLatexMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseLatexMetadata)

Defined in: [WAProto/index.d.ts:441](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L441)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIRichResponseLatexMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseLatexMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIRichResponseLatexMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseLatexMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIRichResponseLatexMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseLatexMetadata)

Defined in: [WAProto/index.d.ts:443](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L443)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIRichResponseLatexMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseLatexMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:442](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L442)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIRichResponseLatexMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseLatexMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIRichResponseLatexMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseLatexMetadata)

Defined in: [WAProto/index.d.ts:444](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L444)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIRichResponseLatexMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseLatexMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:447](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L447)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:445](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L445)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIRichResponseLatexMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseLatexMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-airichresponsemapmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseMapMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseMapMetadata)

Defined in: [WAProto/index.d.ts:494](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L494)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIRichResponseMapMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIRichResponseMapMetadata()[​](#new-airichresponsemapmetadata "Direct link to new AIRichResponseMapMetadata()")

> **new AIRichResponseMapMetadata**(`p`?): [`AIRichResponseMapMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseMapMetadata)

Defined in: [WAProto/index.d.ts:495](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L495)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIRichResponseMapMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`AIRichResponseMapMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseMapMetadata)

## Properties[​](#properties "Direct link to Properties")

### annotations[​](#annotations "Direct link to annotations")

> **annotations**: [`IAIRichResponseMapAnnotation`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/interfaces/IAIRichResponseMapAnnotation)\[\]

Defined in: [WAProto/index.d.ts:500](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L500)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIRichResponseMapMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata).[`annotations`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata#annotations)

* * *

### centerLatitude?[​](#centerlatitude "Direct link to centerLatitude?")

> `optional` **centerLatitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:496](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L496)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIRichResponseMapMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata).[`centerLatitude`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata#centerlatitude)

* * *

### centerLongitude?[​](#centerlongitude "Direct link to centerLongitude?")

> `optional` **centerLongitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:497](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L497)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAIRichResponseMapMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata).[`centerLongitude`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata#centerlongitude)

* * *

### latitudeDelta?[​](#latitudedelta "Direct link to latitudeDelta?")

> `optional` **latitudeDelta**: `null` | `number`

Defined in: [WAProto/index.d.ts:498](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L498)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IAIRichResponseMapMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata).[`latitudeDelta`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata#latitudedelta)

* * *

### longitudeDelta?[​](#longitudedelta "Direct link to longitudeDelta?")

> `optional` **longitudeDelta**: `null` | `number`

Defined in: [WAProto/index.d.ts:499](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L499)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IAIRichResponseMapMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata).[`longitudeDelta`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata#longitudedelta)

* * *

### showInfoList?[​](#showinfolist "Direct link to showInfoList?")

> `optional` **showInfoList**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:501](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L501)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IAIRichResponseMapMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata).[`showInfoList`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata#showinfolist)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:507](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L507)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIRichResponseMapMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseMapMetadata)

Defined in: [WAProto/index.d.ts:502](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L502)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIRichResponseMapMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIRichResponseMapMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseMapMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIRichResponseMapMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseMapMetadata)

Defined in: [WAProto/index.d.ts:504](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L504)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIRichResponseMapMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseMapMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:503](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L503)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIRichResponseMapMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIRichResponseMapMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseMapMetadata)

Defined in: [WAProto/index.d.ts:505](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L505)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIRichResponseMapMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseMapMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:508](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L508)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:506](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L506)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIRichResponseMapMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseMapMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-airichresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseMessage](https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseMessage)

Defined in: [WAProto/index.d.ts:545](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L545)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIRichResponseMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIRichResponseMessage()[​](#new-airichresponsemessage "Direct link to new AIRichResponseMessage()")

> **new AIRichResponseMessage**(`p`?): [`AIRichResponseMessage`](/docs/api/namespaces/proto/classes/AIRichResponseMessage)

Defined in: [WAProto/index.d.ts:546](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L546)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIRichResponseMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMessage)

#### Returns[​](#returns "Direct link to Returns")

[`AIRichResponseMessage`](/docs/api/namespaces/proto/classes/AIRichResponseMessage)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:550](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L550)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIRichResponseMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMessage).[`contextInfo`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMessage#contextinfo)

* * *

### messageType?[​](#messagetype "Direct link to messageType?")

> `optional` **messageType**: `null` | [`AIRichResponseMessageType`](/docs/api/namespaces/proto/enumerations/AIRichResponseMessageType)

Defined in: [WAProto/index.d.ts:547](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L547)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIRichResponseMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMessage).[`messageType`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMessage#messagetype)

* * *

### submessages[​](#submessages "Direct link to submessages")

> **submessages**: [`IAIRichResponseSubMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage)\[\]

Defined in: [WAProto/index.d.ts:548](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L548)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAIRichResponseMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMessage).[`submessages`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMessage#submessages)

* * *

### unifiedResponse?[​](#unifiedresponse "Direct link to unifiedResponse?")

> `optional` **unifiedResponse**: `null` | [`IAIRichResponseUnifiedResponse`](/docs/api/namespaces/proto/interfaces/IAIRichResponseUnifiedResponse)

Defined in: [WAProto/index.d.ts:549](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L549)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IAIRichResponseMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMessage).[`unifiedResponse`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMessage#unifiedresponse)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:556](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L556)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIRichResponseMessage`](/docs/api/namespaces/proto/classes/AIRichResponseMessage)

Defined in: [WAProto/index.d.ts:551](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L551)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIRichResponseMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIRichResponseMessage`](/docs/api/namespaces/proto/classes/AIRichResponseMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIRichResponseMessage`](/docs/api/namespaces/proto/classes/AIRichResponseMessage)

Defined in: [WAProto/index.d.ts:553](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L553)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIRichResponseMessage`](/docs/api/namespaces/proto/classes/AIRichResponseMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:552](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L552)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIRichResponseMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIRichResponseMessage`](/docs/api/namespaces/proto/classes/AIRichResponseMessage)

Defined in: [WAProto/index.d.ts:554](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L554)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIRichResponseMessage`](/docs/api/namespaces/proto/classes/AIRichResponseMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:557](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L557)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:555](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L555)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIRichResponseMessage`](/docs/api/namespaces/proto/classes/AIRichResponseMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-airichresponsesubmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseSubMessage](https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseSubMessage)

Defined in: [WAProto/index.d.ts:578](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L578)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIRichResponseSubMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIRichResponseSubMessage()[​](#new-airichresponsesubmessage "Direct link to new AIRichResponseSubMessage()")

> **new AIRichResponseSubMessage**(`p`?): [`AIRichResponseSubMessage`](/docs/api/namespaces/proto/classes/AIRichResponseSubMessage)

Defined in: [WAProto/index.d.ts:579](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L579)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIRichResponseSubMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage)

#### Returns[​](#returns "Direct link to Returns")

[`AIRichResponseSubMessage`](/docs/api/namespaces/proto/classes/AIRichResponseSubMessage)

## Properties[​](#properties "Direct link to Properties")

### codeMetadata?[​](#codemetadata "Direct link to codeMetadata?")

> `optional` **codeMetadata**: `null` | [`IAIRichResponseCodeMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseCodeMetadata)

Defined in: [WAProto/index.d.ts:584](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L584)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIRichResponseSubMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage).[`codeMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage#codemetadata)

* * *

### contentItemsMetadata?[​](#contentitemsmetadata "Direct link to contentItemsMetadata?")

> `optional` **contentItemsMetadata**: `null` | [`IAIRichResponseContentItemsMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseContentItemsMetadata)

Defined in: [WAProto/index.d.ts:589](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L589)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIRichResponseSubMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage).[`contentItemsMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage#contentitemsmetadata)

* * *

### dynamicMetadata?[​](#dynamicmetadata "Direct link to dynamicMetadata?")

> `optional` **dynamicMetadata**: `null` | [`IAIRichResponseDynamicMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseDynamicMetadata)

Defined in: [WAProto/index.d.ts:586](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L586)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAIRichResponseSubMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage).[`dynamicMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage#dynamicmetadata)

* * *

### gridImageMetadata?[​](#gridimagemetadata "Direct link to gridImageMetadata?")

> `optional` **gridImageMetadata**: `null` | [`IAIRichResponseGridImageMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseGridImageMetadata)

Defined in: [WAProto/index.d.ts:581](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L581)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IAIRichResponseSubMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage).[`gridImageMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage#gridimagemetadata)

* * *

### imageMetadata?[​](#imagemetadata "Direct link to imageMetadata?")

> `optional` **imageMetadata**: `null` | [`IAIRichResponseInlineImageMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseInlineImageMetadata)

Defined in: [WAProto/index.d.ts:583](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L583)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IAIRichResponseSubMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage).[`imageMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage#imagemetadata)

* * *

### latexMetadata?[​](#latexmetadata "Direct link to latexMetadata?")

> `optional` **latexMetadata**: `null` | [`IAIRichResponseLatexMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseLatexMetadata)

Defined in: [WAProto/index.d.ts:587](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L587)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IAIRichResponseSubMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage).[`latexMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage#latexmetadata)

* * *

### mapMetadata?[​](#mapmetadata "Direct link to mapMetadata?")

> `optional` **mapMetadata**: `null` | [`IAIRichResponseMapMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata)

Defined in: [WAProto/index.d.ts:588](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L588)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IAIRichResponseSubMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage).[`mapMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage#mapmetadata)

* * *

### messageText?[​](#messagetext "Direct link to messageText?")

> `optional` **messageText**: `null` | `string`

Defined in: [WAProto/index.d.ts:582](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L582)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IAIRichResponseSubMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage).[`messageText`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage#messagetext)

* * *

### messageType?[​](#messagetype "Direct link to messageType?")

> `optional` **messageType**: `null` | [`AIRichResponseSubMessageType`](/docs/api/namespaces/proto/enumerations/AIRichResponseSubMessageType)

Defined in: [WAProto/index.d.ts:580](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L580)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IAIRichResponseSubMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage).[`messageType`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage#messagetype)

* * *

### tableMetadata?[​](#tablemetadata "Direct link to tableMetadata?")

> `optional` **tableMetadata**: `null` | [`IAIRichResponseTableMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseTableMetadata)

Defined in: [WAProto/index.d.ts:585](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L585)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IAIRichResponseSubMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage).[`tableMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage#tablemetadata)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:595](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L595)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIRichResponseSubMessage`](/docs/api/namespaces/proto/classes/AIRichResponseSubMessage)

Defined in: [WAProto/index.d.ts:590](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L590)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIRichResponseSubMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIRichResponseSubMessage`](/docs/api/namespaces/proto/classes/AIRichResponseSubMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIRichResponseSubMessage`](/docs/api/namespaces/proto/classes/AIRichResponseSubMessage)

Defined in: [WAProto/index.d.ts:592](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L592)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIRichResponseSubMessage`](/docs/api/namespaces/proto/classes/AIRichResponseSubMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:591](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L591)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIRichResponseSubMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIRichResponseSubMessage`](/docs/api/namespaces/proto/classes/AIRichResponseSubMessage)

Defined in: [WAProto/index.d.ts:593](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L593)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIRichResponseSubMessage`](/docs/api/namespaces/proto/classes/AIRichResponseSubMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:596](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L596)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:594](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L594)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIRichResponseSubMessage`](/docs/api/namespaces/proto/classes/AIRichResponseSubMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-airichresponsetablemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseTableMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseTableMetadata)

Defined in: [WAProto/index.d.ts:617](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L617)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIRichResponseTableMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseTableMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIRichResponseTableMetadata()[​](#new-airichresponsetablemetadata "Direct link to new AIRichResponseTableMetadata()")

> **new AIRichResponseTableMetadata**(`p`?): [`AIRichResponseTableMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseTableMetadata)

Defined in: [WAProto/index.d.ts:618](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L618)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIRichResponseTableMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseTableMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`AIRichResponseTableMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseTableMetadata)

## Properties[​](#properties "Direct link to Properties")

### rows[​](#rows "Direct link to rows")

> **rows**: [`IAIRichResponseTableRow`](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/interfaces/IAIRichResponseTableRow)\[\]

Defined in: [WAProto/index.d.ts:619](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L619)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIRichResponseTableMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseTableMetadata).[`rows`](/docs/api/namespaces/proto/interfaces/IAIRichResponseTableMetadata#rows)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:620](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L620)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIRichResponseTableMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseTableMetadata).[`title`](/docs/api/namespaces/proto/interfaces/IAIRichResponseTableMetadata#title)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:626](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L626)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIRichResponseTableMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseTableMetadata)

Defined in: [WAProto/index.d.ts:621](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L621)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIRichResponseTableMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseTableMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIRichResponseTableMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseTableMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIRichResponseTableMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseTableMetadata)

Defined in: [WAProto/index.d.ts:623](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L623)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIRichResponseTableMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseTableMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:622](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L622)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIRichResponseTableMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseTableMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIRichResponseTableMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseTableMetadata)

Defined in: [WAProto/index.d.ts:624](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L624)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIRichResponseTableMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseTableMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:627](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L627)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:625](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L625)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIRichResponseTableMetadata`](/docs/api/namespaces/proto/classes/AIRichResponseTableMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-airichresponseunifiedresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseUnifiedResponse](https://baileys.wiki/docs/api/namespaces/proto/classes/AIRichResponseUnifiedResponse)

Defined in: [WAProto/index.d.ts:655](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L655)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIRichResponseUnifiedResponse`](/docs/api/namespaces/proto/interfaces/IAIRichResponseUnifiedResponse)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIRichResponseUnifiedResponse()[​](#new-airichresponseunifiedresponse "Direct link to new AIRichResponseUnifiedResponse()")

> **new AIRichResponseUnifiedResponse**(`p`?): [`AIRichResponseUnifiedResponse`](/docs/api/namespaces/proto/classes/AIRichResponseUnifiedResponse)

Defined in: [WAProto/index.d.ts:656](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L656)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIRichResponseUnifiedResponse`](/docs/api/namespaces/proto/interfaces/IAIRichResponseUnifiedResponse)

#### Returns[​](#returns "Direct link to Returns")

[`AIRichResponseUnifiedResponse`](/docs/api/namespaces/proto/classes/AIRichResponseUnifiedResponse)

## Properties[​](#properties "Direct link to Properties")

### data?[​](#data "Direct link to data?")

> `optional` **data**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:657](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L657)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIRichResponseUnifiedResponse`](/docs/api/namespaces/proto/interfaces/IAIRichResponseUnifiedResponse).[`data`](/docs/api/namespaces/proto/interfaces/IAIRichResponseUnifiedResponse#data)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:663](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L663)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIRichResponseUnifiedResponse`](/docs/api/namespaces/proto/classes/AIRichResponseUnifiedResponse)

Defined in: [WAProto/index.d.ts:658](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L658)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIRichResponseUnifiedResponse`](/docs/api/namespaces/proto/interfaces/IAIRichResponseUnifiedResponse)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIRichResponseUnifiedResponse`](/docs/api/namespaces/proto/classes/AIRichResponseUnifiedResponse)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIRichResponseUnifiedResponse`](/docs/api/namespaces/proto/classes/AIRichResponseUnifiedResponse)

Defined in: [WAProto/index.d.ts:660](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L660)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIRichResponseUnifiedResponse`](/docs/api/namespaces/proto/classes/AIRichResponseUnifiedResponse)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:659](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L659)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIRichResponseUnifiedResponse`](/docs/api/namespaces/proto/interfaces/IAIRichResponseUnifiedResponse)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIRichResponseUnifiedResponse`](/docs/api/namespaces/proto/classes/AIRichResponseUnifiedResponse)

Defined in: [WAProto/index.d.ts:661](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L661)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIRichResponseUnifiedResponse`](/docs/api/namespaces/proto/classes/AIRichResponseUnifiedResponse)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:664](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L664)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:662](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L662)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIRichResponseUnifiedResponse`](/docs/api/namespaces/proto/classes/AIRichResponseUnifiedResponse)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-aithreadinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/AIThreadInfo](https://baileys.wiki/docs/api/namespaces/proto/classes/AIThreadInfo)

Defined in: [WAProto/index.d.ts:672](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L672)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIThreadInfo`](/docs/api/namespaces/proto/interfaces/IAIThreadInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIThreadInfo()[​](#new-aithreadinfo "Direct link to new AIThreadInfo()")

> **new AIThreadInfo**(`p`?): [`AIThreadInfo`](/docs/api/namespaces/proto/classes/AIThreadInfo)

Defined in: [WAProto/index.d.ts:673](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L673)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIThreadInfo`](/docs/api/namespaces/proto/interfaces/IAIThreadInfo)

#### Returns[​](#returns "Direct link to Returns")

[`AIThreadInfo`](/docs/api/namespaces/proto/classes/AIThreadInfo)

## Properties[​](#properties "Direct link to Properties")

### clientInfo?[​](#clientinfo "Direct link to clientInfo?")

> `optional` **clientInfo**: `null` | [`IAIThreadClientInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadClientInfo)

Defined in: [WAProto/index.d.ts:675](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L675)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIThreadInfo`](/docs/api/namespaces/proto/interfaces/IAIThreadInfo).[`clientInfo`](/docs/api/namespaces/proto/interfaces/IAIThreadInfo#clientinfo)

* * *

### serverInfo?[​](#serverinfo "Direct link to serverInfo?")

> `optional` **serverInfo**: `null` | [`IAIThreadServerInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadServerInfo)

Defined in: [WAProto/index.d.ts:674](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L674)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIThreadInfo`](/docs/api/namespaces/proto/interfaces/IAIThreadInfo).[`serverInfo`](/docs/api/namespaces/proto/interfaces/IAIThreadInfo#serverinfo)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:681](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L681)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIThreadInfo`](/docs/api/namespaces/proto/classes/AIThreadInfo)

Defined in: [WAProto/index.d.ts:676](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L676)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIThreadInfo`](/docs/api/namespaces/proto/interfaces/IAIThreadInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIThreadInfo`](/docs/api/namespaces/proto/classes/AIThreadInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIThreadInfo`](/docs/api/namespaces/proto/classes/AIThreadInfo)

Defined in: [WAProto/index.d.ts:678](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L678)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIThreadInfo`](/docs/api/namespaces/proto/classes/AIThreadInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:677](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L677)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIThreadInfo`](/docs/api/namespaces/proto/interfaces/IAIThreadInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIThreadInfo`](/docs/api/namespaces/proto/classes/AIThreadInfo)

Defined in: [WAProto/index.d.ts:679](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L679)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIThreadInfo`](/docs/api/namespaces/proto/classes/AIThreadInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:682](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L682)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:680](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L680)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIThreadInfo`](/docs/api/namespaces/proto/classes/AIThreadInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-account"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/Account](https://baileys.wiki/docs/api/namespaces/proto/classes/Account)

Defined in: [WAProto/index.d.ts:736](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L736)

## Implements[​](#implements "Direct link to Implements")

*   [`IAccount`](/docs/api/namespaces/proto/interfaces/IAccount)

## Constructors[​](#constructors "Direct link to Constructors")

### new Account()[​](#new-account "Direct link to new Account()")

> **new Account**(`p`?): [`Account`](/docs/api/namespaces/proto/classes/Account)

Defined in: [WAProto/index.d.ts:737](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L737)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAccount`](/docs/api/namespaces/proto/interfaces/IAccount)

#### Returns[​](#returns "Direct link to Returns")

[`Account`](/docs/api/namespaces/proto/classes/Account)

## Properties[​](#properties "Direct link to Properties")

### countryCode?[​](#countrycode "Direct link to countryCode?")

> `optional` **countryCode**: `null` | `string`

Defined in: [WAProto/index.d.ts:740](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L740)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAccount`](/docs/api/namespaces/proto/interfaces/IAccount).[`countryCode`](/docs/api/namespaces/proto/interfaces/IAccount#countrycode)

* * *

### isUsernameDeleted?[​](#isusernamedeleted "Direct link to isUsernameDeleted?")

> `optional` **isUsernameDeleted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:741](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L741)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAccount`](/docs/api/namespaces/proto/interfaces/IAccount).[`isUsernameDeleted`](/docs/api/namespaces/proto/interfaces/IAccount#isusernamedeleted)

* * *

### lid?[​](#lid "Direct link to lid?")

> `optional` **lid**: `null` | `string`

Defined in: [WAProto/index.d.ts:738](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L738)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAccount`](/docs/api/namespaces/proto/interfaces/IAccount).[`lid`](/docs/api/namespaces/proto/interfaces/IAccount#lid)

* * *

### username?[​](#username "Direct link to username?")

> `optional` **username**: `null` | `string`

Defined in: [WAProto/index.d.ts:739](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L739)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IAccount`](/docs/api/namespaces/proto/interfaces/IAccount).[`username`](/docs/api/namespaces/proto/interfaces/IAccount#username)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:747](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L747)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Account`](/docs/api/namespaces/proto/classes/Account)

Defined in: [WAProto/index.d.ts:742](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L742)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAccount`](/docs/api/namespaces/proto/interfaces/IAccount)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Account`](/docs/api/namespaces/proto/classes/Account)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Account`](/docs/api/namespaces/proto/classes/Account)

Defined in: [WAProto/index.d.ts:744](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L744)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Account`](/docs/api/namespaces/proto/classes/Account)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:743](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L743)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAccount`](/docs/api/namespaces/proto/interfaces/IAccount)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Account`](/docs/api/namespaces/proto/classes/Account)

Defined in: [WAProto/index.d.ts:745](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L745)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Account`](/docs/api/namespaces/proto/classes/Account)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:748](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L748)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:746](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L746)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Account`](/docs/api/namespaces/proto/classes/Account)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-actionlink"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/ActionLink](https://baileys.wiki/docs/api/namespaces/proto/classes/ActionLink)

Defined in: [WAProto/index.d.ts:756](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L756)

## Implements[​](#implements "Direct link to Implements")

*   [`IActionLink`](/docs/api/namespaces/proto/interfaces/IActionLink)

## Constructors[​](#constructors "Direct link to Constructors")

### new ActionLink()[​](#new-actionlink "Direct link to new ActionLink()")

> **new ActionLink**(`p`?): [`ActionLink`](/docs/api/namespaces/proto/classes/ActionLink)

Defined in: [WAProto/index.d.ts:757](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L757)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IActionLink`](/docs/api/namespaces/proto/interfaces/IActionLink)

#### Returns[​](#returns "Direct link to Returns")

[`ActionLink`](/docs/api/namespaces/proto/classes/ActionLink)

## Properties[​](#properties "Direct link to Properties")

### buttonTitle?[​](#buttontitle "Direct link to buttonTitle?")

> `optional` **buttonTitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:759](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L759)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IActionLink`](/docs/api/namespaces/proto/interfaces/IActionLink).[`buttonTitle`](/docs/api/namespaces/proto/interfaces/IActionLink#buttontitle)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:758](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L758)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IActionLink`](/docs/api/namespaces/proto/interfaces/IActionLink).[`url`](/docs/api/namespaces/proto/interfaces/IActionLink#url)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:765](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L765)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ActionLink`](/docs/api/namespaces/proto/classes/ActionLink)

Defined in: [WAProto/index.d.ts:760](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L760)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IActionLink`](/docs/api/namespaces/proto/interfaces/IActionLink)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ActionLink`](/docs/api/namespaces/proto/classes/ActionLink)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ActionLink`](/docs/api/namespaces/proto/classes/ActionLink)

Defined in: [WAProto/index.d.ts:762](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L762)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ActionLink`](/docs/api/namespaces/proto/classes/ActionLink)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:761](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L761)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IActionLink`](/docs/api/namespaces/proto/interfaces/IActionLink)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ActionLink`](/docs/api/namespaces/proto/classes/ActionLink)

Defined in: [WAProto/index.d.ts:763](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L763)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ActionLink`](/docs/api/namespaces/proto/classes/ActionLink)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:766](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L766)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:764](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L764)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ActionLink`](/docs/api/namespaces/proto/classes/ActionLink)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-autodownloadsettings"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/AutoDownloadSettings](https://baileys.wiki/docs/api/namespaces/proto/classes/AutoDownloadSettings)

Defined in: [WAProto/index.d.ts:776](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L776)

## Implements[​](#implements "Direct link to Implements")

*   [`IAutoDownloadSettings`](/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings)

## Constructors[​](#constructors "Direct link to Constructors")

### new AutoDownloadSettings()[​](#new-autodownloadsettings "Direct link to new AutoDownloadSettings()")

> **new AutoDownloadSettings**(`p`?): [`AutoDownloadSettings`](/docs/api/namespaces/proto/classes/AutoDownloadSettings)

Defined in: [WAProto/index.d.ts:777](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L777)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAutoDownloadSettings`](/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings)

#### Returns[​](#returns "Direct link to Returns")

[`AutoDownloadSettings`](/docs/api/namespaces/proto/classes/AutoDownloadSettings)

## Properties[​](#properties "Direct link to Properties")

### downloadAudio?[​](#downloadaudio "Direct link to downloadAudio?")

> `optional` **downloadAudio**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:779](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L779)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAutoDownloadSettings`](/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings).[`downloadAudio`](/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings#downloadaudio)

* * *

### downloadDocuments?[​](#downloaddocuments "Direct link to downloadDocuments?")

> `optional` **downloadDocuments**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:781](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L781)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAutoDownloadSettings`](/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings).[`downloadDocuments`](/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings#downloaddocuments)

* * *

### downloadImages?[​](#downloadimages "Direct link to downloadImages?")

> `optional` **downloadImages**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:778](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L778)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAutoDownloadSettings`](/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings).[`downloadImages`](/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings#downloadimages)

* * *

### downloadVideo?[​](#downloadvideo "Direct link to downloadVideo?")

> `optional` **downloadVideo**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:780](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L780)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IAutoDownloadSettings`](/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings).[`downloadVideo`](/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings#downloadvideo)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:787](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L787)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AutoDownloadSettings`](/docs/api/namespaces/proto/classes/AutoDownloadSettings)

Defined in: [WAProto/index.d.ts:782](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L782)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAutoDownloadSettings`](/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AutoDownloadSettings`](/docs/api/namespaces/proto/classes/AutoDownloadSettings)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AutoDownloadSettings`](/docs/api/namespaces/proto/classes/AutoDownloadSettings)

Defined in: [WAProto/index.d.ts:784](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L784)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AutoDownloadSettings`](/docs/api/namespaces/proto/classes/AutoDownloadSettings)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:783](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L783)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAutoDownloadSettings`](/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AutoDownloadSettings`](/docs/api/namespaces/proto/classes/AutoDownloadSettings)

Defined in: [WAProto/index.d.ts:785](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L785)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AutoDownloadSettings`](/docs/api/namespaces/proto/classes/AutoDownloadSettings)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:788](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L788)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:786](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L786)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AutoDownloadSettings`](/docs/api/namespaces/proto/classes/AutoDownloadSettings)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-avatarusersettings"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/AvatarUserSettings](https://baileys.wiki/docs/api/namespaces/proto/classes/AvatarUserSettings)

Defined in: [WAProto/index.d.ts:796](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L796)

## Implements[​](#implements "Direct link to Implements")

*   [`IAvatarUserSettings`](/docs/api/namespaces/proto/interfaces/IAvatarUserSettings)

## Constructors[​](#constructors "Direct link to Constructors")

### new AvatarUserSettings()[​](#new-avatarusersettings "Direct link to new AvatarUserSettings()")

> **new AvatarUserSettings**(`p`?): [`AvatarUserSettings`](/docs/api/namespaces/proto/classes/AvatarUserSettings)

Defined in: [WAProto/index.d.ts:797](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L797)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAvatarUserSettings`](/docs/api/namespaces/proto/interfaces/IAvatarUserSettings)

#### Returns[​](#returns "Direct link to Returns")

[`AvatarUserSettings`](/docs/api/namespaces/proto/classes/AvatarUserSettings)

## Properties[​](#properties "Direct link to Properties")

### fbid?[​](#fbid "Direct link to fbid?")

> `optional` **fbid**: `null` | `string`

Defined in: [WAProto/index.d.ts:798](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L798)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAvatarUserSettings`](/docs/api/namespaces/proto/interfaces/IAvatarUserSettings).[`fbid`](/docs/api/namespaces/proto/interfaces/IAvatarUserSettings#fbid)

* * *

### password?[​](#password "Direct link to password?")

> `optional` **password**: `null` | `string`

Defined in: [WAProto/index.d.ts:799](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L799)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAvatarUserSettings`](/docs/api/namespaces/proto/interfaces/IAvatarUserSettings).[`password`](/docs/api/namespaces/proto/interfaces/IAvatarUserSettings#password)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:805](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L805)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AvatarUserSettings`](/docs/api/namespaces/proto/classes/AvatarUserSettings)

Defined in: [WAProto/index.d.ts:800](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L800)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAvatarUserSettings`](/docs/api/namespaces/proto/interfaces/IAvatarUserSettings)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AvatarUserSettings`](/docs/api/namespaces/proto/classes/AvatarUserSettings)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AvatarUserSettings`](/docs/api/namespaces/proto/classes/AvatarUserSettings)

Defined in: [WAProto/index.d.ts:802](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L802)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AvatarUserSettings`](/docs/api/namespaces/proto/classes/AvatarUserSettings)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:801](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L801)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAvatarUserSettings`](/docs/api/namespaces/proto/interfaces/IAvatarUserSettings)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AvatarUserSettings`](/docs/api/namespaces/proto/classes/AvatarUserSettings)

Defined in: [WAProto/index.d.ts:803](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L803)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AvatarUserSettings`](/docs/api/namespaces/proto/classes/AvatarUserSettings)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:806](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L806)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:804](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L804)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AvatarUserSettings`](/docs/api/namespaces/proto/classes/AvatarUserSettings)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-bizaccountlinkinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BizAccountLinkInfo](https://baileys.wiki/docs/api/namespaces/proto/classes/BizAccountLinkInfo)

Defined in: [WAProto/index.d.ts:817](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L817)

## Implements[​](#implements "Direct link to Implements")

*   [`IBizAccountLinkInfo`](/docs/api/namespaces/proto/interfaces/IBizAccountLinkInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new BizAccountLinkInfo()[​](#new-bizaccountlinkinfo "Direct link to new BizAccountLinkInfo()")

> **new BizAccountLinkInfo**(`p`?): [`BizAccountLinkInfo`](/docs/api/namespaces/proto/classes/BizAccountLinkInfo)

Defined in: [WAProto/index.d.ts:818](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L818)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBizAccountLinkInfo`](/docs/api/namespaces/proto/interfaces/IBizAccountLinkInfo)

#### Returns[​](#returns "Direct link to Returns")

[`BizAccountLinkInfo`](/docs/api/namespaces/proto/classes/BizAccountLinkInfo)

## Properties[​](#properties "Direct link to Properties")

### accountType?[​](#accounttype "Direct link to accountType?")

> `optional` **accountType**: `null` | [`ENTERPRISE`](/docs/api/namespaces/proto/namespaces/BizAccountLinkInfo/enumerations/AccountType#enterprise)

Defined in: [WAProto/index.d.ts:823](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L823)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBizAccountLinkInfo`](/docs/api/namespaces/proto/interfaces/IBizAccountLinkInfo).[`accountType`](/docs/api/namespaces/proto/interfaces/IBizAccountLinkInfo#accounttype)

* * *

### hostStorage?[​](#hoststorage "Direct link to hostStorage?")

> `optional` **hostStorage**: `null` | [`HostStorageType`](/docs/api/namespaces/proto/namespaces/BizAccountLinkInfo/enumerations/HostStorageType)

Defined in: [WAProto/index.d.ts:822](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L822)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBizAccountLinkInfo`](/docs/api/namespaces/proto/interfaces/IBizAccountLinkInfo).[`hostStorage`](/docs/api/namespaces/proto/interfaces/IBizAccountLinkInfo#hoststorage)

* * *

### issueTime?[​](#issuetime "Direct link to issueTime?")

> `optional` **issueTime**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:821](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L821)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBizAccountLinkInfo`](/docs/api/namespaces/proto/interfaces/IBizAccountLinkInfo).[`issueTime`](/docs/api/namespaces/proto/interfaces/IBizAccountLinkInfo#issuetime)

* * *

### whatsappAcctNumber?[​](#whatsappacctnumber "Direct link to whatsappAcctNumber?")

> `optional` **whatsappAcctNumber**: `null` | `string`

Defined in: [WAProto/index.d.ts:820](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L820)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IBizAccountLinkInfo`](/docs/api/namespaces/proto/interfaces/IBizAccountLinkInfo).[`whatsappAcctNumber`](/docs/api/namespaces/proto/interfaces/IBizAccountLinkInfo#whatsappacctnumber)

* * *

### whatsappBizAcctFbid?[​](#whatsappbizacctfbid "Direct link to whatsappBizAcctFbid?")

> `optional` **whatsappBizAcctFbid**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:819](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L819)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IBizAccountLinkInfo`](/docs/api/namespaces/proto/interfaces/IBizAccountLinkInfo).[`whatsappBizAcctFbid`](/docs/api/namespaces/proto/interfaces/IBizAccountLinkInfo#whatsappbizacctfbid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:829](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L829)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BizAccountLinkInfo`](/docs/api/namespaces/proto/classes/BizAccountLinkInfo)

Defined in: [WAProto/index.d.ts:824](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L824)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBizAccountLinkInfo`](/docs/api/namespaces/proto/interfaces/IBizAccountLinkInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BizAccountLinkInfo`](/docs/api/namespaces/proto/classes/BizAccountLinkInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BizAccountLinkInfo`](/docs/api/namespaces/proto/classes/BizAccountLinkInfo)

Defined in: [WAProto/index.d.ts:826](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L826)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BizAccountLinkInfo`](/docs/api/namespaces/proto/classes/BizAccountLinkInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:825](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L825)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBizAccountLinkInfo`](/docs/api/namespaces/proto/interfaces/IBizAccountLinkInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BizAccountLinkInfo`](/docs/api/namespaces/proto/classes/BizAccountLinkInfo)

Defined in: [WAProto/index.d.ts:827](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L827)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BizAccountLinkInfo`](/docs/api/namespaces/proto/classes/BizAccountLinkInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:830](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L830)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:828](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L828)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BizAccountLinkInfo`](/docs/api/namespaces/proto/classes/BizAccountLinkInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-bizaccountpayload"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BizAccountPayload](https://baileys.wiki/docs/api/namespaces/proto/classes/BizAccountPayload)

Defined in: [WAProto/index.d.ts:850](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L850)

## Implements[​](#implements "Direct link to Implements")

*   [`IBizAccountPayload`](/docs/api/namespaces/proto/interfaces/IBizAccountPayload)

## Constructors[​](#constructors "Direct link to Constructors")

### new BizAccountPayload()[​](#new-bizaccountpayload "Direct link to new BizAccountPayload()")

> **new BizAccountPayload**(`p`?): [`BizAccountPayload`](/docs/api/namespaces/proto/classes/BizAccountPayload)

Defined in: [WAProto/index.d.ts:851](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L851)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBizAccountPayload`](/docs/api/namespaces/proto/interfaces/IBizAccountPayload)

#### Returns[​](#returns "Direct link to Returns")

[`BizAccountPayload`](/docs/api/namespaces/proto/classes/BizAccountPayload)

## Properties[​](#properties "Direct link to Properties")

### bizAcctLinkInfo?[​](#bizacctlinkinfo "Direct link to bizAcctLinkInfo?")

> `optional` **bizAcctLinkInfo**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:853](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L853)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBizAccountPayload`](/docs/api/namespaces/proto/interfaces/IBizAccountPayload).[`bizAcctLinkInfo`](/docs/api/namespaces/proto/interfaces/IBizAccountPayload#bizacctlinkinfo)

* * *

### vnameCert?[​](#vnamecert "Direct link to vnameCert?")

> `optional` **vnameCert**: `null` | [`IVerifiedNameCertificate`](/docs/api/namespaces/proto/interfaces/IVerifiedNameCertificate)

Defined in: [WAProto/index.d.ts:852](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L852)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBizAccountPayload`](/docs/api/namespaces/proto/interfaces/IBizAccountPayload).[`vnameCert`](/docs/api/namespaces/proto/interfaces/IBizAccountPayload#vnamecert)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:859](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L859)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BizAccountPayload`](/docs/api/namespaces/proto/classes/BizAccountPayload)

Defined in: [WAProto/index.d.ts:854](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L854)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBizAccountPayload`](/docs/api/namespaces/proto/interfaces/IBizAccountPayload)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BizAccountPayload`](/docs/api/namespaces/proto/classes/BizAccountPayload)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BizAccountPayload`](/docs/api/namespaces/proto/classes/BizAccountPayload)

Defined in: [WAProto/index.d.ts:856](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L856)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BizAccountPayload`](/docs/api/namespaces/proto/classes/BizAccountPayload)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:855](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L855)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBizAccountPayload`](/docs/api/namespaces/proto/interfaces/IBizAccountPayload)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BizAccountPayload`](/docs/api/namespaces/proto/classes/BizAccountPayload)

Defined in: [WAProto/index.d.ts:857](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L857)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BizAccountPayload`](/docs/api/namespaces/proto/classes/BizAccountPayload)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:860](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L860)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:858](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L858)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BizAccountPayload`](/docs/api/namespaces/proto/classes/BizAccountPayload)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-bizidentityinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BizIdentityInfo](https://baileys.wiki/docs/api/namespaces/proto/classes/BizIdentityInfo)

Defined in: [WAProto/index.d.ts:874](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L874)

## Implements[​](#implements "Direct link to Implements")

*   [`IBizIdentityInfo`](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new BizIdentityInfo()[​](#new-bizidentityinfo "Direct link to new BizIdentityInfo()")

> **new BizIdentityInfo**(`p`?): [`BizIdentityInfo`](/docs/api/namespaces/proto/classes/BizIdentityInfo)

Defined in: [WAProto/index.d.ts:875](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L875)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBizIdentityInfo`](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo)

#### Returns[​](#returns "Direct link to Returns")

[`BizIdentityInfo`](/docs/api/namespaces/proto/classes/BizIdentityInfo)

## Properties[​](#properties "Direct link to Properties")

### actualActors?[​](#actualactors "Direct link to actualActors?")

> `optional` **actualActors**: `null` | [`ActualActorsType`](/docs/api/namespaces/proto/namespaces/BizIdentityInfo/enumerations/ActualActorsType)

Defined in: [WAProto/index.d.ts:881](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L881)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBizIdentityInfo`](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo).[`actualActors`](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo#actualactors)

* * *

### featureControls?[​](#featurecontrols "Direct link to featureControls?")

> `optional` **featureControls**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:883](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L883)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBizIdentityInfo`](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo).[`featureControls`](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo#featurecontrols)

* * *

### hostStorage?[​](#hoststorage "Direct link to hostStorage?")

> `optional` **hostStorage**: `null` | [`HostStorageType`](/docs/api/namespaces/proto/namespaces/BizIdentityInfo/enumerations/HostStorageType)

Defined in: [WAProto/index.d.ts:880](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L880)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBizIdentityInfo`](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo).[`hostStorage`](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo#hoststorage)

* * *

### privacyModeTs?[​](#privacymodets "Direct link to privacyModeTs?")

> `optional` **privacyModeTs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:882](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L882)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IBizIdentityInfo`](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo).[`privacyModeTs`](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo#privacymodets)

* * *

### revoked?[​](#revoked "Direct link to revoked?")

> `optional` **revoked**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:879](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L879)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IBizIdentityInfo`](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo).[`revoked`](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo#revoked)

* * *

### signed?[​](#signed "Direct link to signed?")

> `optional` **signed**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:878](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L878)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IBizIdentityInfo`](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo).[`signed`](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo#signed)

* * *

### vlevel?[​](#vlevel "Direct link to vlevel?")

> `optional` **vlevel**: `null` | [`VerifiedLevelValue`](/docs/api/namespaces/proto/namespaces/BizIdentityInfo/enumerations/VerifiedLevelValue)

Defined in: [WAProto/index.d.ts:876](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L876)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IBizIdentityInfo`](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo).[`vlevel`](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo#vlevel)

* * *

### vnameCert?[​](#vnamecert "Direct link to vnameCert?")

> `optional` **vnameCert**: `null` | [`IVerifiedNameCertificate`](/docs/api/namespaces/proto/interfaces/IVerifiedNameCertificate)

Defined in: [WAProto/index.d.ts:877](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L877)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IBizIdentityInfo`](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo).[`vnameCert`](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo#vnamecert)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:889](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L889)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BizIdentityInfo`](/docs/api/namespaces/proto/classes/BizIdentityInfo)

Defined in: [WAProto/index.d.ts:884](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L884)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBizIdentityInfo`](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BizIdentityInfo`](/docs/api/namespaces/proto/classes/BizIdentityInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BizIdentityInfo`](/docs/api/namespaces/proto/classes/BizIdentityInfo)

Defined in: [WAProto/index.d.ts:886](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L886)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BizIdentityInfo`](/docs/api/namespaces/proto/classes/BizIdentityInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:885](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L885)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBizIdentityInfo`](/docs/api/namespaces/proto/interfaces/IBizIdentityInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BizIdentityInfo`](/docs/api/namespaces/proto/classes/BizIdentityInfo)

Defined in: [WAProto/index.d.ts:887](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L887)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BizIdentityInfo`](/docs/api/namespaces/proto/classes/BizIdentityInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:890](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L890)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:888](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L888)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BizIdentityInfo`](/docs/api/namespaces/proto/classes/BizIdentityInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botagecollectionmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotAgeCollectionMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotAgeCollectionMetadata)

Defined in: [WAProto/index.d.ts:918](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L918)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotAgeCollectionMetadata`](/docs/api/namespaces/proto/interfaces/IBotAgeCollectionMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotAgeCollectionMetadata()[​](#new-botagecollectionmetadata "Direct link to new BotAgeCollectionMetadata()")

> **new BotAgeCollectionMetadata**(`p`?): [`BotAgeCollectionMetadata`](/docs/api/namespaces/proto/classes/BotAgeCollectionMetadata)

Defined in: [WAProto/index.d.ts:919](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L919)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotAgeCollectionMetadata`](/docs/api/namespaces/proto/interfaces/IBotAgeCollectionMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotAgeCollectionMetadata`](/docs/api/namespaces/proto/classes/BotAgeCollectionMetadata)

## Properties[​](#properties "Direct link to Properties")

### ageCollectionEligible?[​](#agecollectioneligible "Direct link to ageCollectionEligible?")

> `optional` **ageCollectionEligible**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:920](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L920)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotAgeCollectionMetadata`](/docs/api/namespaces/proto/interfaces/IBotAgeCollectionMetadata).[`ageCollectionEligible`](/docs/api/namespaces/proto/interfaces/IBotAgeCollectionMetadata#agecollectioneligible)

* * *

### ageCollectionType?[​](#agecollectiontype "Direct link to ageCollectionType?")

> `optional` **ageCollectionType**: `null` | [`AgeCollectionType`](/docs/api/namespaces/proto/namespaces/BotAgeCollectionMetadata/enumerations/AgeCollectionType)

Defined in: [WAProto/index.d.ts:922](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L922)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotAgeCollectionMetadata`](/docs/api/namespaces/proto/interfaces/IBotAgeCollectionMetadata).[`ageCollectionType`](/docs/api/namespaces/proto/interfaces/IBotAgeCollectionMetadata#agecollectiontype)

* * *

### shouldTriggerAgeCollectionOnClient?[​](#shouldtriggeragecollectiononclient "Direct link to shouldTriggerAgeCollectionOnClient?")

> `optional` **shouldTriggerAgeCollectionOnClient**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:921](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L921)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBotAgeCollectionMetadata`](/docs/api/namespaces/proto/interfaces/IBotAgeCollectionMetadata).[`shouldTriggerAgeCollectionOnClient`](/docs/api/namespaces/proto/interfaces/IBotAgeCollectionMetadata#shouldtriggeragecollectiononclient)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:928](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L928)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotAgeCollectionMetadata`](/docs/api/namespaces/proto/classes/BotAgeCollectionMetadata)

Defined in: [WAProto/index.d.ts:923](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L923)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotAgeCollectionMetadata`](/docs/api/namespaces/proto/interfaces/IBotAgeCollectionMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotAgeCollectionMetadata`](/docs/api/namespaces/proto/classes/BotAgeCollectionMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotAgeCollectionMetadata`](/docs/api/namespaces/proto/classes/BotAgeCollectionMetadata)

Defined in: [WAProto/index.d.ts:925](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L925)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotAgeCollectionMetadata`](/docs/api/namespaces/proto/classes/BotAgeCollectionMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:924](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L924)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotAgeCollectionMetadata`](/docs/api/namespaces/proto/interfaces/IBotAgeCollectionMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotAgeCollectionMetadata`](/docs/api/namespaces/proto/classes/BotAgeCollectionMetadata)

Defined in: [WAProto/index.d.ts:926](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L926)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotAgeCollectionMetadata`](/docs/api/namespaces/proto/classes/BotAgeCollectionMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:929](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L929)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:927](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L927)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotAgeCollectionMetadata`](/docs/api/namespaces/proto/classes/BotAgeCollectionMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botavatarmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotAvatarMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotAvatarMetadata)

Defined in: [WAProto/index.d.ts:948](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L948)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotAvatarMetadata`](/docs/api/namespaces/proto/interfaces/IBotAvatarMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotAvatarMetadata()[​](#new-botavatarmetadata "Direct link to new BotAvatarMetadata()")

> **new BotAvatarMetadata**(`p`?): [`BotAvatarMetadata`](/docs/api/namespaces/proto/classes/BotAvatarMetadata)

Defined in: [WAProto/index.d.ts:949](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L949)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotAvatarMetadata`](/docs/api/namespaces/proto/interfaces/IBotAvatarMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotAvatarMetadata`](/docs/api/namespaces/proto/classes/BotAvatarMetadata)

## Properties[​](#properties "Direct link to Properties")

### action?[​](#action "Direct link to action?")

> `optional` **action**: `null` | `number`

Defined in: [WAProto/index.d.ts:952](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L952)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotAvatarMetadata`](/docs/api/namespaces/proto/interfaces/IBotAvatarMetadata).[`action`](/docs/api/namespaces/proto/interfaces/IBotAvatarMetadata#action)

* * *

### behaviorGraph?[​](#behaviorgraph "Direct link to behaviorGraph?")

> `optional` **behaviorGraph**: `null` | `string`

Defined in: [WAProto/index.d.ts:951](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L951)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotAvatarMetadata`](/docs/api/namespaces/proto/interfaces/IBotAvatarMetadata).[`behaviorGraph`](/docs/api/namespaces/proto/interfaces/IBotAvatarMetadata#behaviorgraph)

* * *

### intensity?[​](#intensity "Direct link to intensity?")

> `optional` **intensity**: `null` | `number`

Defined in: [WAProto/index.d.ts:953](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L953)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBotAvatarMetadata`](/docs/api/namespaces/proto/interfaces/IBotAvatarMetadata).[`intensity`](/docs/api/namespaces/proto/interfaces/IBotAvatarMetadata#intensity)

* * *

### sentiment?[​](#sentiment "Direct link to sentiment?")

> `optional` **sentiment**: `null` | `number`

Defined in: [WAProto/index.d.ts:950](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L950)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IBotAvatarMetadata`](/docs/api/namespaces/proto/interfaces/IBotAvatarMetadata).[`sentiment`](/docs/api/namespaces/proto/interfaces/IBotAvatarMetadata#sentiment)

* * *

### wordCount?[​](#wordcount "Direct link to wordCount?")

> `optional` **wordCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:954](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L954)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IBotAvatarMetadata`](/docs/api/namespaces/proto/interfaces/IBotAvatarMetadata).[`wordCount`](/docs/api/namespaces/proto/interfaces/IBotAvatarMetadata#wordcount)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:960](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L960)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotAvatarMetadata`](/docs/api/namespaces/proto/classes/BotAvatarMetadata)

Defined in: [WAProto/index.d.ts:955](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L955)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotAvatarMetadata`](/docs/api/namespaces/proto/interfaces/IBotAvatarMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotAvatarMetadata`](/docs/api/namespaces/proto/classes/BotAvatarMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotAvatarMetadata`](/docs/api/namespaces/proto/classes/BotAvatarMetadata)

Defined in: [WAProto/index.d.ts:957](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L957)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotAvatarMetadata`](/docs/api/namespaces/proto/classes/BotAvatarMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:956](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L956)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotAvatarMetadata`](/docs/api/namespaces/proto/interfaces/IBotAvatarMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotAvatarMetadata`](/docs/api/namespaces/proto/classes/BotAvatarMetadata)

Defined in: [WAProto/index.d.ts:958](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L958)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotAvatarMetadata`](/docs/api/namespaces/proto/classes/BotAvatarMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:961](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L961)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:959](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L959)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotAvatarMetadata`](/docs/api/namespaces/proto/classes/BotAvatarMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botcapabilitymetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotCapabilityMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotCapabilityMetadata)

Defined in: [WAProto/index.d.ts:968](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L968)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotCapabilityMetadata`](/docs/api/namespaces/proto/interfaces/IBotCapabilityMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotCapabilityMetadata()[​](#new-botcapabilitymetadata "Direct link to new BotCapabilityMetadata()")

> **new BotCapabilityMetadata**(`p`?): [`BotCapabilityMetadata`](/docs/api/namespaces/proto/classes/BotCapabilityMetadata)

Defined in: [WAProto/index.d.ts:969](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L969)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotCapabilityMetadata`](/docs/api/namespaces/proto/interfaces/IBotCapabilityMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotCapabilityMetadata`](/docs/api/namespaces/proto/classes/BotCapabilityMetadata)

## Properties[​](#properties "Direct link to Properties")

### capabilities[​](#capabilities "Direct link to capabilities")

> **capabilities**: [`BotCapabilityType`](/docs/api/namespaces/proto/namespaces/BotCapabilityMetadata/enumerations/BotCapabilityType)\[\]

Defined in: [WAProto/index.d.ts:970](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L970)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotCapabilityMetadata`](/docs/api/namespaces/proto/interfaces/IBotCapabilityMetadata).[`capabilities`](/docs/api/namespaces/proto/interfaces/IBotCapabilityMetadata#capabilities)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:976](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L976)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotCapabilityMetadata`](/docs/api/namespaces/proto/classes/BotCapabilityMetadata)

Defined in: [WAProto/index.d.ts:971](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L971)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotCapabilityMetadata`](/docs/api/namespaces/proto/interfaces/IBotCapabilityMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotCapabilityMetadata`](/docs/api/namespaces/proto/classes/BotCapabilityMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotCapabilityMetadata`](/docs/api/namespaces/proto/classes/BotCapabilityMetadata)

Defined in: [WAProto/index.d.ts:973](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L973)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotCapabilityMetadata`](/docs/api/namespaces/proto/classes/BotCapabilityMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:972](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L972)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotCapabilityMetadata`](/docs/api/namespaces/proto/interfaces/IBotCapabilityMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotCapabilityMetadata`](/docs/api/namespaces/proto/classes/BotCapabilityMetadata)

Defined in: [WAProto/index.d.ts:974](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L974)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotCapabilityMetadata`](/docs/api/namespaces/proto/classes/BotCapabilityMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:977](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L977)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:975](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L975)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotCapabilityMetadata`](/docs/api/namespaces/proto/classes/BotCapabilityMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botfeedbackmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotFeedbackMessage](https://baileys.wiki/docs/api/namespaces/proto/classes/BotFeedbackMessage)

Defined in: [WAProto/index.d.ts:1046](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1046)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotFeedbackMessage`](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotFeedbackMessage()[​](#new-botfeedbackmessage "Direct link to new BotFeedbackMessage()")

> **new BotFeedbackMessage**(`p`?): [`BotFeedbackMessage`](/docs/api/namespaces/proto/classes/BotFeedbackMessage)

Defined in: [WAProto/index.d.ts:1047](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1047)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotFeedbackMessage`](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage)

#### Returns[​](#returns "Direct link to Returns")

[`BotFeedbackMessage`](/docs/api/namespaces/proto/classes/BotFeedbackMessage)

## Properties[​](#properties "Direct link to Properties")

### kind?[​](#kind "Direct link to kind?")

> `optional` **kind**: `null` | [`BotFeedbackKind`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/enumerations/BotFeedbackKind)

Defined in: [WAProto/index.d.ts:1049](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1049)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotFeedbackMessage`](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage).[`kind`](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage#kind)

* * *

### kindNegative?[​](#kindnegative "Direct link to kindNegative?")

> `optional` **kindNegative**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:1051](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1051)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotFeedbackMessage`](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage).[`kindNegative`](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage#kindnegative)

* * *

### kindPositive?[​](#kindpositive "Direct link to kindPositive?")

> `optional` **kindPositive**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:1052](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1052)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBotFeedbackMessage`](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage).[`kindPositive`](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage#kindpositive)

* * *

### kindReport?[​](#kindreport "Direct link to kindReport?")

> `optional` **kindReport**: `null` | [`ReportKind`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/enumerations/ReportKind)

Defined in: [WAProto/index.d.ts:1053](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1053)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IBotFeedbackMessage`](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage).[`kindReport`](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage#kindreport)

* * *

### messageKey?[​](#messagekey "Direct link to messageKey?")

> `optional` **messageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:1048](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1048)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IBotFeedbackMessage`](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage).[`messageKey`](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage#messagekey)

* * *

### sideBySideSurveyMetadata?[​](#sidebysidesurveymetadata "Direct link to sideBySideSurveyMetadata?")

> `optional` **sideBySideSurveyMetadata**: `null` | [`ISideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata)

Defined in: [WAProto/index.d.ts:1054](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1054)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IBotFeedbackMessage`](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage).[`sideBySideSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage#sidebysidesurveymetadata)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:1050](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1050)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IBotFeedbackMessage`](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage).[`text`](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage#text)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1060](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1060)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotFeedbackMessage`](/docs/api/namespaces/proto/classes/BotFeedbackMessage)

Defined in: [WAProto/index.d.ts:1055](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1055)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotFeedbackMessage`](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotFeedbackMessage`](/docs/api/namespaces/proto/classes/BotFeedbackMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotFeedbackMessage`](/docs/api/namespaces/proto/classes/BotFeedbackMessage)

Defined in: [WAProto/index.d.ts:1057](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1057)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotFeedbackMessage`](/docs/api/namespaces/proto/classes/BotFeedbackMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1056](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1056)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotFeedbackMessage`](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotFeedbackMessage`](/docs/api/namespaces/proto/classes/BotFeedbackMessage)

Defined in: [WAProto/index.d.ts:1058](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1058)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotFeedbackMessage`](/docs/api/namespaces/proto/classes/BotFeedbackMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1061](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1061)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1059](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1059)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotFeedbackMessage`](/docs/api/namespaces/proto/classes/BotFeedbackMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botimaginemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotImagineMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotImagineMetadata)

Defined in: [WAProto/index.d.ts:1282](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1282)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotImagineMetadata`](/docs/api/namespaces/proto/interfaces/IBotImagineMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotImagineMetadata()[​](#new-botimaginemetadata "Direct link to new BotImagineMetadata()")

> **new BotImagineMetadata**(`p`?): [`BotImagineMetadata`](/docs/api/namespaces/proto/classes/BotImagineMetadata)

Defined in: [WAProto/index.d.ts:1283](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1283)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotImagineMetadata`](/docs/api/namespaces/proto/interfaces/IBotImagineMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotImagineMetadata`](/docs/api/namespaces/proto/classes/BotImagineMetadata)

## Properties[​](#properties "Direct link to Properties")

### imagineType?[​](#imaginetype "Direct link to imagineType?")

> `optional` **imagineType**: `null` | [`ImagineType`](/docs/api/namespaces/proto/namespaces/BotImagineMetadata/enumerations/ImagineType)

Defined in: [WAProto/index.d.ts:1284](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1284)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotImagineMetadata`](/docs/api/namespaces/proto/interfaces/IBotImagineMetadata).[`imagineType`](/docs/api/namespaces/proto/interfaces/IBotImagineMetadata#imaginetype)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1290](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1290)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotImagineMetadata`](/docs/api/namespaces/proto/classes/BotImagineMetadata)

Defined in: [WAProto/index.d.ts:1285](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1285)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotImagineMetadata`](/docs/api/namespaces/proto/interfaces/IBotImagineMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotImagineMetadata`](/docs/api/namespaces/proto/classes/BotImagineMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotImagineMetadata`](/docs/api/namespaces/proto/classes/BotImagineMetadata)

Defined in: [WAProto/index.d.ts:1287](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1287)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotImagineMetadata`](/docs/api/namespaces/proto/classes/BotImagineMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1286](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1286)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotImagineMetadata`](/docs/api/namespaces/proto/interfaces/IBotImagineMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotImagineMetadata`](/docs/api/namespaces/proto/classes/BotImagineMetadata)

Defined in: [WAProto/index.d.ts:1288](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1288)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotImagineMetadata`](/docs/api/namespaces/proto/classes/BotImagineMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1291](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1291)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1289](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1289)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotImagineMetadata`](/docs/api/namespaces/proto/classes/BotImagineMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botlinkedaccount"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotLinkedAccount](https://baileys.wiki/docs/api/namespaces/proto/classes/BotLinkedAccount)

Defined in: [WAProto/index.d.ts:1309](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1309)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotLinkedAccount`](/docs/api/namespaces/proto/interfaces/IBotLinkedAccount)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotLinkedAccount()[​](#new-botlinkedaccount "Direct link to new BotLinkedAccount()")

> **new BotLinkedAccount**(`p`?): [`BotLinkedAccount`](/docs/api/namespaces/proto/classes/BotLinkedAccount)

Defined in: [WAProto/index.d.ts:1310](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1310)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotLinkedAccount`](/docs/api/namespaces/proto/interfaces/IBotLinkedAccount)

#### Returns[​](#returns "Direct link to Returns")

[`BotLinkedAccount`](/docs/api/namespaces/proto/classes/BotLinkedAccount)

## Properties[​](#properties "Direct link to Properties")

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`BOT_LINKED_ACCOUNT_TYPE_1P`](/docs/api/namespaces/proto/namespaces/BotLinkedAccount/enumerations/BotLinkedAccountType#bot_linked_account_type_1p)

Defined in: [WAProto/index.d.ts:1311](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1311)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotLinkedAccount`](/docs/api/namespaces/proto/interfaces/IBotLinkedAccount).[`type`](/docs/api/namespaces/proto/interfaces/IBotLinkedAccount#type)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1317](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1317)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotLinkedAccount`](/docs/api/namespaces/proto/classes/BotLinkedAccount)

Defined in: [WAProto/index.d.ts:1312](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1312)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotLinkedAccount`](/docs/api/namespaces/proto/interfaces/IBotLinkedAccount)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotLinkedAccount`](/docs/api/namespaces/proto/classes/BotLinkedAccount)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotLinkedAccount`](/docs/api/namespaces/proto/classes/BotLinkedAccount)

Defined in: [WAProto/index.d.ts:1314](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1314)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotLinkedAccount`](/docs/api/namespaces/proto/classes/BotLinkedAccount)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1313](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1313)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotLinkedAccount`](/docs/api/namespaces/proto/interfaces/IBotLinkedAccount)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotLinkedAccount`](/docs/api/namespaces/proto/classes/BotLinkedAccount)

Defined in: [WAProto/index.d.ts:1315](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1315)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotLinkedAccount`](/docs/api/namespaces/proto/classes/BotLinkedAccount)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1318](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1318)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1316](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1316)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotLinkedAccount`](/docs/api/namespaces/proto/classes/BotLinkedAccount)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botlinkedaccountsmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotLinkedAccountsMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotLinkedAccountsMetadata)

Defined in: [WAProto/index.d.ts:1334](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1334)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotLinkedAccountsMetadata`](/docs/api/namespaces/proto/interfaces/IBotLinkedAccountsMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotLinkedAccountsMetadata()[​](#new-botlinkedaccountsmetadata "Direct link to new BotLinkedAccountsMetadata()")

> **new BotLinkedAccountsMetadata**(`p`?): [`BotLinkedAccountsMetadata`](/docs/api/namespaces/proto/classes/BotLinkedAccountsMetadata)

Defined in: [WAProto/index.d.ts:1335](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1335)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotLinkedAccountsMetadata`](/docs/api/namespaces/proto/interfaces/IBotLinkedAccountsMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotLinkedAccountsMetadata`](/docs/api/namespaces/proto/classes/BotLinkedAccountsMetadata)

## Properties[​](#properties "Direct link to Properties")

### acAuthTokens?[​](#acauthtokens "Direct link to acAuthTokens?")

> `optional` **acAuthTokens**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:1337](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1337)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotLinkedAccountsMetadata`](/docs/api/namespaces/proto/interfaces/IBotLinkedAccountsMetadata).[`acAuthTokens`](/docs/api/namespaces/proto/interfaces/IBotLinkedAccountsMetadata#acauthtokens)

* * *

### accounts[​](#accounts "Direct link to accounts")

> **accounts**: [`IBotLinkedAccount`](/docs/api/namespaces/proto/interfaces/IBotLinkedAccount)\[\]

Defined in: [WAProto/index.d.ts:1336](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1336)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotLinkedAccountsMetadata`](/docs/api/namespaces/proto/interfaces/IBotLinkedAccountsMetadata).[`accounts`](/docs/api/namespaces/proto/interfaces/IBotLinkedAccountsMetadata#accounts)

* * *

### acErrorCode?[​](#acerrorcode "Direct link to acErrorCode?")

> `optional` **acErrorCode**: `null` | `number`

Defined in: [WAProto/index.d.ts:1338](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1338)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBotLinkedAccountsMetadata`](/docs/api/namespaces/proto/interfaces/IBotLinkedAccountsMetadata).[`acErrorCode`](/docs/api/namespaces/proto/interfaces/IBotLinkedAccountsMetadata#acerrorcode)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1344](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1344)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotLinkedAccountsMetadata`](/docs/api/namespaces/proto/classes/BotLinkedAccountsMetadata)

Defined in: [WAProto/index.d.ts:1339](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1339)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotLinkedAccountsMetadata`](/docs/api/namespaces/proto/interfaces/IBotLinkedAccountsMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotLinkedAccountsMetadata`](/docs/api/namespaces/proto/classes/BotLinkedAccountsMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotLinkedAccountsMetadata`](/docs/api/namespaces/proto/classes/BotLinkedAccountsMetadata)

Defined in: [WAProto/index.d.ts:1341](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1341)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotLinkedAccountsMetadata`](/docs/api/namespaces/proto/classes/BotLinkedAccountsMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1340](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1340)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotLinkedAccountsMetadata`](/docs/api/namespaces/proto/interfaces/IBotLinkedAccountsMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotLinkedAccountsMetadata`](/docs/api/namespaces/proto/classes/BotLinkedAccountsMetadata)

Defined in: [WAProto/index.d.ts:1342](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1342)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotLinkedAccountsMetadata`](/docs/api/namespaces/proto/classes/BotLinkedAccountsMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1345](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1345)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1343](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1343)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotLinkedAccountsMetadata`](/docs/api/namespaces/proto/classes/BotLinkedAccountsMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botmediametadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotMediaMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotMediaMetadata)

Defined in: [WAProto/index.d.ts:1358](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1358)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotMediaMetadata`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotMediaMetadata()[​](#new-botmediametadata "Direct link to new BotMediaMetadata()")

> **new BotMediaMetadata**(`p`?): [`BotMediaMetadata`](/docs/api/namespaces/proto/classes/BotMediaMetadata)

Defined in: [WAProto/index.d.ts:1359](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1359)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotMediaMetadata`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotMediaMetadata`](/docs/api/namespaces/proto/classes/BotMediaMetadata)

## Properties[​](#properties "Direct link to Properties")

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:1363](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1363)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotMediaMetadata`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata).[`directPath`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata#directpath)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `string`

Defined in: [WAProto/index.d.ts:1362](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1362)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotMediaMetadata`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata).[`fileEncSha256`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata#fileencsha256)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `string`

Defined in: [WAProto/index.d.ts:1360](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1360)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBotMediaMetadata`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata).[`fileSha256`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata#filesha256)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `string`

Defined in: [WAProto/index.d.ts:1361](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1361)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IBotMediaMetadata`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata).[`mediaKey`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata#mediakey)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:1364](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1364)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IBotMediaMetadata`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata).[`mediaKeyTimestamp`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata#mediakeytimestamp)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:1365](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1365)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IBotMediaMetadata`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata).[`mimetype`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata#mimetype)

* * *

### orientationType?[​](#orientationtype "Direct link to orientationType?")

> `optional` **orientationType**: `null` | [`OrientationType`](/docs/api/namespaces/proto/namespaces/BotMediaMetadata/enumerations/OrientationType)

Defined in: [WAProto/index.d.ts:1366](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1366)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IBotMediaMetadata`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata).[`orientationType`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata#orientationtype)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1372](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1372)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotMediaMetadata`](/docs/api/namespaces/proto/classes/BotMediaMetadata)

Defined in: [WAProto/index.d.ts:1367](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1367)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotMediaMetadata`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotMediaMetadata`](/docs/api/namespaces/proto/classes/BotMediaMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotMediaMetadata`](/docs/api/namespaces/proto/classes/BotMediaMetadata)

Defined in: [WAProto/index.d.ts:1369](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1369)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotMediaMetadata`](/docs/api/namespaces/proto/classes/BotMediaMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1368](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1368)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotMediaMetadata`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotMediaMetadata`](/docs/api/namespaces/proto/classes/BotMediaMetadata)

Defined in: [WAProto/index.d.ts:1370](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1370)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotMediaMetadata`](/docs/api/namespaces/proto/classes/BotMediaMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1373](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1373)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1371](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1371)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotMediaMetadata`](/docs/api/namespaces/proto/classes/BotMediaMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botmemoryfact"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotMemoryFact](https://baileys.wiki/docs/api/namespaces/proto/classes/BotMemoryFact)

Defined in: [WAProto/index.d.ts:1390](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1390)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotMemoryFact`](/docs/api/namespaces/proto/interfaces/IBotMemoryFact)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotMemoryFact()[​](#new-botmemoryfact "Direct link to new BotMemoryFact()")

> **new BotMemoryFact**(`p`?): [`BotMemoryFact`](/docs/api/namespaces/proto/classes/BotMemoryFact)

Defined in: [WAProto/index.d.ts:1391](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1391)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotMemoryFact`](/docs/api/namespaces/proto/interfaces/IBotMemoryFact)

#### Returns[​](#returns "Direct link to Returns")

[`BotMemoryFact`](/docs/api/namespaces/proto/classes/BotMemoryFact)

## Properties[​](#properties "Direct link to Properties")

### fact?[​](#fact "Direct link to fact?")

> `optional` **fact**: `null` | `string`

Defined in: [WAProto/index.d.ts:1392](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1392)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotMemoryFact`](/docs/api/namespaces/proto/interfaces/IBotMemoryFact).[`fact`](/docs/api/namespaces/proto/interfaces/IBotMemoryFact#fact)

* * *

### factId?[​](#factid "Direct link to factId?")

> `optional` **factId**: `null` | `string`

Defined in: [WAProto/index.d.ts:1393](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1393)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotMemoryFact`](/docs/api/namespaces/proto/interfaces/IBotMemoryFact).[`factId`](/docs/api/namespaces/proto/interfaces/IBotMemoryFact#factid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1399](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1399)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotMemoryFact`](/docs/api/namespaces/proto/classes/BotMemoryFact)

Defined in: [WAProto/index.d.ts:1394](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1394)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotMemoryFact`](/docs/api/namespaces/proto/interfaces/IBotMemoryFact)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotMemoryFact`](/docs/api/namespaces/proto/classes/BotMemoryFact)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotMemoryFact`](/docs/api/namespaces/proto/classes/BotMemoryFact)

Defined in: [WAProto/index.d.ts:1396](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1396)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotMemoryFact`](/docs/api/namespaces/proto/classes/BotMemoryFact)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1395](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1395)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotMemoryFact`](/docs/api/namespaces/proto/interfaces/IBotMemoryFact)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotMemoryFact`](/docs/api/namespaces/proto/classes/BotMemoryFact)

Defined in: [WAProto/index.d.ts:1397](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1397)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotMemoryFact`](/docs/api/namespaces/proto/classes/BotMemoryFact)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1400](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1400)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1398](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1398)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotMemoryFact`](/docs/api/namespaces/proto/classes/BotMemoryFact)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botmemorymetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotMemoryMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotMemoryMetadata)

Defined in: [WAProto/index.d.ts:1409](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1409)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotMemoryMetadata`](/docs/api/namespaces/proto/interfaces/IBotMemoryMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotMemoryMetadata()[​](#new-botmemorymetadata "Direct link to new BotMemoryMetadata()")

> **new BotMemoryMetadata**(`p`?): [`BotMemoryMetadata`](/docs/api/namespaces/proto/classes/BotMemoryMetadata)

Defined in: [WAProto/index.d.ts:1410](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1410)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotMemoryMetadata`](/docs/api/namespaces/proto/interfaces/IBotMemoryMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotMemoryMetadata`](/docs/api/namespaces/proto/classes/BotMemoryMetadata)

## Properties[​](#properties "Direct link to Properties")

### addedFacts[​](#addedfacts "Direct link to addedFacts")

> **addedFacts**: [`IBotMemoryFact`](/docs/api/namespaces/proto/interfaces/IBotMemoryFact)\[\]

Defined in: [WAProto/index.d.ts:1411](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1411)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotMemoryMetadata`](/docs/api/namespaces/proto/interfaces/IBotMemoryMetadata).[`addedFacts`](/docs/api/namespaces/proto/interfaces/IBotMemoryMetadata#addedfacts)

* * *

### disclaimer?[​](#disclaimer "Direct link to disclaimer?")

> `optional` **disclaimer**: `null` | `string`

Defined in: [WAProto/index.d.ts:1413](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1413)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotMemoryMetadata`](/docs/api/namespaces/proto/interfaces/IBotMemoryMetadata).[`disclaimer`](/docs/api/namespaces/proto/interfaces/IBotMemoryMetadata#disclaimer)

* * *

### removedFacts[​](#removedfacts "Direct link to removedFacts")

> **removedFacts**: [`IBotMemoryFact`](/docs/api/namespaces/proto/interfaces/IBotMemoryFact)\[\]

Defined in: [WAProto/index.d.ts:1412](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1412)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBotMemoryMetadata`](/docs/api/namespaces/proto/interfaces/IBotMemoryMetadata).[`removedFacts`](/docs/api/namespaces/proto/interfaces/IBotMemoryMetadata#removedfacts)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1419](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1419)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotMemoryMetadata`](/docs/api/namespaces/proto/classes/BotMemoryMetadata)

Defined in: [WAProto/index.d.ts:1414](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1414)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotMemoryMetadata`](/docs/api/namespaces/proto/interfaces/IBotMemoryMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotMemoryMetadata`](/docs/api/namespaces/proto/classes/BotMemoryMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotMemoryMetadata`](/docs/api/namespaces/proto/classes/BotMemoryMetadata)

Defined in: [WAProto/index.d.ts:1416](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1416)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotMemoryMetadata`](/docs/api/namespaces/proto/classes/BotMemoryMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1415](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1415)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotMemoryMetadata`](/docs/api/namespaces/proto/interfaces/IBotMemoryMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotMemoryMetadata`](/docs/api/namespaces/proto/classes/BotMemoryMetadata)

Defined in: [WAProto/index.d.ts:1417](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1417)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotMemoryMetadata`](/docs/api/namespaces/proto/classes/BotMemoryMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1420](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1420)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1418](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1418)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotMemoryMetadata`](/docs/api/namespaces/proto/classes/BotMemoryMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botmemumetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotMemuMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotMemuMetadata)

Defined in: [WAProto/index.d.ts:1427](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1427)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotMemuMetadata`](/docs/api/namespaces/proto/interfaces/IBotMemuMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotMemuMetadata()[​](#new-botmemumetadata "Direct link to new BotMemuMetadata()")

> **new BotMemuMetadata**(`p`?): [`BotMemuMetadata`](/docs/api/namespaces/proto/classes/BotMemuMetadata)

Defined in: [WAProto/index.d.ts:1428](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1428)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotMemuMetadata`](/docs/api/namespaces/proto/interfaces/IBotMemuMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotMemuMetadata`](/docs/api/namespaces/proto/classes/BotMemuMetadata)

## Properties[​](#properties "Direct link to Properties")

### faceImages[​](#faceimages "Direct link to faceImages")

> **faceImages**: [`IBotMediaMetadata`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata)\[\]

Defined in: [WAProto/index.d.ts:1429](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1429)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotMemuMetadata`](/docs/api/namespaces/proto/interfaces/IBotMemuMetadata).[`faceImages`](/docs/api/namespaces/proto/interfaces/IBotMemuMetadata#faceimages)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1435](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1435)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotMemuMetadata`](/docs/api/namespaces/proto/classes/BotMemuMetadata)

Defined in: [WAProto/index.d.ts:1430](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1430)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotMemuMetadata`](/docs/api/namespaces/proto/interfaces/IBotMemuMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotMemuMetadata`](/docs/api/namespaces/proto/classes/BotMemuMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotMemuMetadata`](/docs/api/namespaces/proto/classes/BotMemuMetadata)

Defined in: [WAProto/index.d.ts:1432](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1432)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotMemuMetadata`](/docs/api/namespaces/proto/classes/BotMemuMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1431](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1431)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotMemuMetadata`](/docs/api/namespaces/proto/interfaces/IBotMemuMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotMemuMetadata`](/docs/api/namespaces/proto/classes/BotMemuMetadata)

Defined in: [WAProto/index.d.ts:1433](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1433)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotMemuMetadata`](/docs/api/namespaces/proto/classes/BotMemuMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1436](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1436)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1434](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1434)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotMemuMetadata`](/docs/api/namespaces/proto/classes/BotMemuMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botmessageorigin"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotMessageOrigin](https://baileys.wiki/docs/api/namespaces/proto/classes/BotMessageOrigin)

Defined in: [WAProto/index.d.ts:1443](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1443)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotMessageOrigin`](/docs/api/namespaces/proto/interfaces/IBotMessageOrigin)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotMessageOrigin()[​](#new-botmessageorigin "Direct link to new BotMessageOrigin()")

> **new BotMessageOrigin**(`p`?): [`BotMessageOrigin`](/docs/api/namespaces/proto/classes/BotMessageOrigin)

Defined in: [WAProto/index.d.ts:1444](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1444)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotMessageOrigin`](/docs/api/namespaces/proto/interfaces/IBotMessageOrigin)

#### Returns[​](#returns "Direct link to Returns")

[`BotMessageOrigin`](/docs/api/namespaces/proto/classes/BotMessageOrigin)

## Properties[​](#properties "Direct link to Properties")

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`BOT_MESSAGE_ORIGIN_TYPE_AI_INITIATED`](/docs/api/namespaces/proto/namespaces/BotMessageOrigin/enumerations/BotMessageOriginType#bot_message_origin_type_ai_initiated)

Defined in: [WAProto/index.d.ts:1445](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1445)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotMessageOrigin`](/docs/api/namespaces/proto/interfaces/IBotMessageOrigin).[`type`](/docs/api/namespaces/proto/interfaces/IBotMessageOrigin#type)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1451](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1451)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotMessageOrigin`](/docs/api/namespaces/proto/classes/BotMessageOrigin)

Defined in: [WAProto/index.d.ts:1446](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1446)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotMessageOrigin`](/docs/api/namespaces/proto/interfaces/IBotMessageOrigin)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotMessageOrigin`](/docs/api/namespaces/proto/classes/BotMessageOrigin)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotMessageOrigin`](/docs/api/namespaces/proto/classes/BotMessageOrigin)

Defined in: [WAProto/index.d.ts:1448](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1448)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotMessageOrigin`](/docs/api/namespaces/proto/classes/BotMessageOrigin)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1447](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1447)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotMessageOrigin`](/docs/api/namespaces/proto/interfaces/IBotMessageOrigin)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotMessageOrigin`](/docs/api/namespaces/proto/classes/BotMessageOrigin)

Defined in: [WAProto/index.d.ts:1449](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1449)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotMessageOrigin`](/docs/api/namespaces/proto/classes/BotMessageOrigin)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1452](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1452)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1450](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1450)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotMessageOrigin`](/docs/api/namespaces/proto/classes/BotMessageOrigin)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botmessageoriginmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotMessageOriginMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotMessageOriginMetadata)

Defined in: [WAProto/index.d.ts:1466](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1466)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotMessageOriginMetadata`](/docs/api/namespaces/proto/interfaces/IBotMessageOriginMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotMessageOriginMetadata()[​](#new-botmessageoriginmetadata "Direct link to new BotMessageOriginMetadata()")

> **new BotMessageOriginMetadata**(`p`?): [`BotMessageOriginMetadata`](/docs/api/namespaces/proto/classes/BotMessageOriginMetadata)

Defined in: [WAProto/index.d.ts:1467](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1467)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotMessageOriginMetadata`](/docs/api/namespaces/proto/interfaces/IBotMessageOriginMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotMessageOriginMetadata`](/docs/api/namespaces/proto/classes/BotMessageOriginMetadata)

## Properties[​](#properties "Direct link to Properties")

### origins[​](#origins "Direct link to origins")

> **origins**: [`IBotMessageOrigin`](/docs/api/namespaces/proto/interfaces/IBotMessageOrigin)\[\]

Defined in: [WAProto/index.d.ts:1468](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1468)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotMessageOriginMetadata`](/docs/api/namespaces/proto/interfaces/IBotMessageOriginMetadata).[`origins`](/docs/api/namespaces/proto/interfaces/IBotMessageOriginMetadata#origins)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1474](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1474)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotMessageOriginMetadata`](/docs/api/namespaces/proto/classes/BotMessageOriginMetadata)

Defined in: [WAProto/index.d.ts:1469](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1469)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotMessageOriginMetadata`](/docs/api/namespaces/proto/interfaces/IBotMessageOriginMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotMessageOriginMetadata`](/docs/api/namespaces/proto/classes/BotMessageOriginMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotMessageOriginMetadata`](/docs/api/namespaces/proto/classes/BotMessageOriginMetadata)

Defined in: [WAProto/index.d.ts:1471](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1471)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotMessageOriginMetadata`](/docs/api/namespaces/proto/classes/BotMessageOriginMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1470](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1470)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotMessageOriginMetadata`](/docs/api/namespaces/proto/interfaces/IBotMessageOriginMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotMessageOriginMetadata`](/docs/api/namespaces/proto/classes/BotMessageOriginMetadata)

Defined in: [WAProto/index.d.ts:1472](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1472)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotMessageOriginMetadata`](/docs/api/namespaces/proto/classes/BotMessageOriginMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1475](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1475)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1473](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1473)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotMessageOriginMetadata`](/docs/api/namespaces/proto/classes/BotMessageOriginMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botmessagesharinginfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotMessageSharingInfo](https://baileys.wiki/docs/api/namespaces/proto/classes/BotMessageSharingInfo)

Defined in: [WAProto/index.d.ts:1483](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1483)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotMessageSharingInfo`](/docs/api/namespaces/proto/interfaces/IBotMessageSharingInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotMessageSharingInfo()[​](#new-botmessagesharinginfo "Direct link to new BotMessageSharingInfo()")

> **new BotMessageSharingInfo**(`p`?): [`BotMessageSharingInfo`](/docs/api/namespaces/proto/classes/BotMessageSharingInfo)

Defined in: [WAProto/index.d.ts:1484](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1484)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotMessageSharingInfo`](/docs/api/namespaces/proto/interfaces/IBotMessageSharingInfo)

#### Returns[​](#returns "Direct link to Returns")

[`BotMessageSharingInfo`](/docs/api/namespaces/proto/classes/BotMessageSharingInfo)

## Properties[​](#properties "Direct link to Properties")

### botEntryPointOrigin?[​](#botentrypointorigin "Direct link to botEntryPointOrigin?")

> `optional` **botEntryPointOrigin**: `null` | [`BotMetricsEntryPoint`](/docs/api/namespaces/proto/enumerations/BotMetricsEntryPoint)

Defined in: [WAProto/index.d.ts:1485](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1485)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotMessageSharingInfo`](/docs/api/namespaces/proto/interfaces/IBotMessageSharingInfo).[`botEntryPointOrigin`](/docs/api/namespaces/proto/interfaces/IBotMessageSharingInfo#botentrypointorigin)

* * *

### forwardScore?[​](#forwardscore "Direct link to forwardScore?")

> `optional` **forwardScore**: `null` | `number`

Defined in: [WAProto/index.d.ts:1486](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1486)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotMessageSharingInfo`](/docs/api/namespaces/proto/interfaces/IBotMessageSharingInfo).[`forwardScore`](/docs/api/namespaces/proto/interfaces/IBotMessageSharingInfo#forwardscore)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1492](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1492)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotMessageSharingInfo`](/docs/api/namespaces/proto/classes/BotMessageSharingInfo)

Defined in: [WAProto/index.d.ts:1487](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1487)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotMessageSharingInfo`](/docs/api/namespaces/proto/interfaces/IBotMessageSharingInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotMessageSharingInfo`](/docs/api/namespaces/proto/classes/BotMessageSharingInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotMessageSharingInfo`](/docs/api/namespaces/proto/classes/BotMessageSharingInfo)

Defined in: [WAProto/index.d.ts:1489](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1489)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotMessageSharingInfo`](/docs/api/namespaces/proto/classes/BotMessageSharingInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1488](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1488)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotMessageSharingInfo`](/docs/api/namespaces/proto/interfaces/IBotMessageSharingInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotMessageSharingInfo`](/docs/api/namespaces/proto/classes/BotMessageSharingInfo)

Defined in: [WAProto/index.d.ts:1490](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1490)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotMessageSharingInfo`](/docs/api/namespaces/proto/classes/BotMessageSharingInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1493](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1493)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1491](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1491)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotMessageSharingInfo`](/docs/api/namespaces/proto/classes/BotMessageSharingInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotMetadata)

Defined in: [WAProto/index.d.ts:1533](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1533)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotMetadata()[​](#new-botmetadata "Direct link to new BotMetadata()")

> **new BotMetadata**(`p`?): [`BotMetadata`](/docs/api/namespaces/proto/classes/BotMetadata)

Defined in: [WAProto/index.d.ts:1534](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1534)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotMetadata`](/docs/api/namespaces/proto/classes/BotMetadata)

## Properties[​](#properties "Direct link to Properties")

### aiConversationContext?[​](#aiconversationcontext "Direct link to aiConversationContext?")

> `optional` **aiConversationContext**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:1554](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1554)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`aiConversationContext`](/docs/api/namespaces/proto/interfaces/IBotMetadata#aiconversationcontext)

* * *

### avatarMetadata?[​](#avatarmetadata "Direct link to avatarMetadata?")

> `optional` **avatarMetadata**: `null` | [`IBotAvatarMetadata`](/docs/api/namespaces/proto/interfaces/IBotAvatarMetadata)

Defined in: [WAProto/index.d.ts:1535](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1535)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`avatarMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#avatarmetadata)

* * *

### botAgeCollectionMetadata?[​](#botagecollectionmetadata "Direct link to botAgeCollectionMetadata?")

> `optional` **botAgeCollectionMetadata**: `null` | [`IBotAgeCollectionMetadata`](/docs/api/namespaces/proto/interfaces/IBotAgeCollectionMetadata)

Defined in: [WAProto/index.d.ts:1558](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1558)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`botAgeCollectionMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#botagecollectionmetadata)

* * *

### botLinkedAccountsMetadata?[​](#botlinkedaccountsmetadata "Direct link to botLinkedAccountsMetadata?")

> `optional` **botLinkedAccountsMetadata**: `null` | [`IBotLinkedAccountsMetadata`](/docs/api/namespaces/proto/interfaces/IBotLinkedAccountsMetadata)

Defined in: [WAProto/index.d.ts:1552](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1552)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`botLinkedAccountsMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#botlinkedaccountsmetadata)

* * *

### botMessageOriginMetadata?[​](#botmessageoriginmetadata "Direct link to botMessageOriginMetadata?")

> `optional` **botMessageOriginMetadata**: `null` | [`IBotMessageOriginMetadata`](/docs/api/namespaces/proto/interfaces/IBotMessageOriginMetadata)

Defined in: [WAProto/index.d.ts:1563](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1563)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`botMessageOriginMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#botmessageoriginmetadata)

* * *

### botMetricsMetadata?[​](#botmetricsmetadata "Direct link to botMetricsMetadata?")

> `optional` **botMetricsMetadata**: `null` | [`IBotMetricsMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetricsMetadata)

Defined in: [WAProto/index.d.ts:1551](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1551)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`botMetricsMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#botmetricsmetadata)

* * *

### botModeSelectionMetadata?[​](#botmodeselectionmetadata "Direct link to botModeSelectionMetadata?")

> `optional` **botModeSelectionMetadata**: `null` | [`IBotModeSelectionMetadata`](/docs/api/namespaces/proto/interfaces/IBotModeSelectionMetadata)

Defined in: [WAProto/index.d.ts:1556](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1556)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`botModeSelectionMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#botmodeselectionmetadata)

* * *

### botPromotionMessageMetadata?[​](#botpromotionmessagemetadata "Direct link to botPromotionMessageMetadata?")

> `optional` **botPromotionMessageMetadata**: `null` | [`IBotPromotionMessageMetadata`](/docs/api/namespaces/proto/interfaces/IBotPromotionMessageMetadata)

Defined in: [WAProto/index.d.ts:1555](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1555)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`botPromotionMessageMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#botpromotionmessagemetadata)

* * *

### botQuotaMetadata?[​](#botquotametadata "Direct link to botQuotaMetadata?")

> `optional` **botQuotaMetadata**: `null` | [`IBotQuotaMetadata`](/docs/api/namespaces/proto/interfaces/IBotQuotaMetadata)

Defined in: [WAProto/index.d.ts:1557](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1557)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`botQuotaMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#botquotametadata)

* * *

### botResponseId?[​](#botresponseid "Direct link to botResponseId?")

> `optional` **botResponseId**: `null` | `string`

Defined in: [WAProto/index.d.ts:1560](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1560)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`botResponseId`](/docs/api/namespaces/proto/interfaces/IBotMetadata#botresponseid)

* * *

### botThreadInfo?[​](#botthreadinfo "Direct link to botThreadInfo?")

> `optional` **botThreadInfo**: `null` | [`IAIThreadInfo`](/docs/api/namespaces/proto/interfaces/IAIThreadInfo)

Defined in: [WAProto/index.d.ts:1565](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1565)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`botThreadInfo`](/docs/api/namespaces/proto/interfaces/IBotMetadata#botthreadinfo)

* * *

### capabilityMetadata?[​](#capabilitymetadata "Direct link to capabilityMetadata?")

> `optional` **capabilityMetadata**: `null` | [`IBotCapabilityMetadata`](/docs/api/namespaces/proto/interfaces/IBotCapabilityMetadata)

Defined in: [WAProto/index.d.ts:1547](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1547)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`capabilityMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#capabilitymetadata)

* * *

### conversationStarterPromptId?[​](#conversationstarterpromptid "Direct link to conversationStarterPromptId?")

> `optional` **conversationStarterPromptId**: `null` | `string`

Defined in: [WAProto/index.d.ts:1559](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1559)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`conversationStarterPromptId`](/docs/api/namespaces/proto/interfaces/IBotMetadata#conversationstarterpromptid)

* * *

### imagineMetadata?[​](#imaginemetadata "Direct link to imagineMetadata?")

> `optional` **imagineMetadata**: `null` | [`IBotImagineMetadata`](/docs/api/namespaces/proto/interfaces/IBotImagineMetadata)

Defined in: [WAProto/index.d.ts:1548](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1548)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`imagineMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#imaginemetadata)

* * *

### internalMetadata?[​](#internalmetadata "Direct link to internalMetadata?")

> `optional` **internalMetadata**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:1568](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1568)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`internalMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#internalmetadata)

* * *

### inThreadSurveyMetadata?[​](#inthreadsurveymetadata "Direct link to inThreadSurveyMetadata?")

> `optional` **inThreadSurveyMetadata**: `null` | [`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata)

Defined in: [WAProto/index.d.ts:1564](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1564)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`inThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#inthreadsurveymetadata)

* * *

### invokerJid?[​](#invokerjid "Direct link to invokerJid?")

> `optional` **invokerJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:1539](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1539)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`invokerJid`](/docs/api/namespaces/proto/interfaces/IBotMetadata#invokerjid)

* * *

### memoryMetadata?[​](#memorymetadata "Direct link to memoryMetadata?")

> `optional` **memoryMetadata**: `null` | [`IBotMemoryMetadata`](/docs/api/namespaces/proto/interfaces/IBotMemoryMetadata)

Defined in: [WAProto/index.d.ts:1549](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1549)

#### Implementation of[​](#implementation-of-17 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`memoryMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#memorymetadata)

* * *

### memuMetadata?[​](#memumetadata "Direct link to memuMetadata?")

> `optional` **memuMetadata**: `null` | [`IBotMemuMetadata`](/docs/api/namespaces/proto/interfaces/IBotMemuMetadata)

Defined in: [WAProto/index.d.ts:1541](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1541)

#### Implementation of[​](#implementation-of-18 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`memuMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#memumetadata)

* * *

### messageDisclaimerText?[​](#messagedisclaimertext "Direct link to messageDisclaimerText?")

> `optional` **messageDisclaimerText**: `null` | `string`

Defined in: [WAProto/index.d.ts:1545](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1545)

#### Implementation of[​](#implementation-of-19 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`messageDisclaimerText`](/docs/api/namespaces/proto/interfaces/IBotMetadata#messagedisclaimertext)

* * *

### modelMetadata?[​](#modelmetadata "Direct link to modelMetadata?")

> `optional` **modelMetadata**: `null` | [`IBotModelMetadata`](/docs/api/namespaces/proto/interfaces/IBotModelMetadata)

Defined in: [WAProto/index.d.ts:1544](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1544)

#### Implementation of[​](#implementation-of-20 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`modelMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#modelmetadata)

* * *

### personaId?[​](#personaid "Direct link to personaId?")

> `optional` **personaId**: `null` | `string`

Defined in: [WAProto/index.d.ts:1536](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1536)

#### Implementation of[​](#implementation-of-21 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`personaId`](/docs/api/namespaces/proto/interfaces/IBotMetadata#personaid)

* * *

### pluginMetadata?[​](#pluginmetadata "Direct link to pluginMetadata?")

> `optional` **pluginMetadata**: `null` | [`IBotPluginMetadata`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata)

Defined in: [WAProto/index.d.ts:1537](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1537)

#### Implementation of[​](#implementation-of-22 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`pluginMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#pluginmetadata)

* * *

### progressIndicatorMetadata?[​](#progressindicatormetadata "Direct link to progressIndicatorMetadata?")

> `optional` **progressIndicatorMetadata**: `null` | [`IBotProgressIndicatorMetadata`](/docs/api/namespaces/proto/interfaces/IBotProgressIndicatorMetadata)

Defined in: [WAProto/index.d.ts:1546](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1546)

#### Implementation of[​](#implementation-of-23 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`progressIndicatorMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#progressindicatormetadata)

* * *

### regenerateMetadata?[​](#regeneratemetadata "Direct link to regenerateMetadata?")

> `optional` **regenerateMetadata**: `null` | [`IAIRegenerateMetadata`](/docs/api/namespaces/proto/interfaces/IAIRegenerateMetadata)

Defined in: [WAProto/index.d.ts:1566](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1566)

#### Implementation of[​](#implementation-of-24 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`regenerateMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#regeneratemetadata)

* * *

### reminderMetadata?[​](#remindermetadata "Direct link to reminderMetadata?")

> `optional` **reminderMetadata**: `null` | [`IBotReminderMetadata`](/docs/api/namespaces/proto/interfaces/IBotReminderMetadata)

Defined in: [WAProto/index.d.ts:1543](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1543)

#### Implementation of[​](#implementation-of-25 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`reminderMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#remindermetadata)

* * *

### renderingMetadata?[​](#renderingmetadata "Direct link to renderingMetadata?")

> `optional` **renderingMetadata**: `null` | [`IBotRenderingMetadata`](/docs/api/namespaces/proto/interfaces/IBotRenderingMetadata)

Defined in: [WAProto/index.d.ts:1550](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1550)

#### Implementation of[​](#implementation-of-26 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`renderingMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#renderingmetadata)

* * *

### richResponseSourcesMetadata?[​](#richresponsesourcesmetadata "Direct link to richResponseSourcesMetadata?")

> `optional` **richResponseSourcesMetadata**: `null` | [`IBotSourcesMetadata`](/docs/api/namespaces/proto/interfaces/IBotSourcesMetadata)

Defined in: [WAProto/index.d.ts:1553](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1553)

#### Implementation of[​](#implementation-of-27 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`richResponseSourcesMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#richresponsesourcesmetadata)

* * *

### sessionMetadata?[​](#sessionmetadata "Direct link to sessionMetadata?")

> `optional` **sessionMetadata**: `null` | [`IBotSessionMetadata`](/docs/api/namespaces/proto/interfaces/IBotSessionMetadata)

Defined in: [WAProto/index.d.ts:1540](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1540)

#### Implementation of[​](#implementation-of-28 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`sessionMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#sessionmetadata)

* * *

### sessionTransparencyMetadata?[​](#sessiontransparencymetadata "Direct link to sessionTransparencyMetadata?")

> `optional` **sessionTransparencyMetadata**: `null` | [`ISessionTransparencyMetadata`](/docs/api/namespaces/proto/interfaces/ISessionTransparencyMetadata)

Defined in: [WAProto/index.d.ts:1567](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1567)

#### Implementation of[​](#implementation-of-29 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`sessionTransparencyMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#sessiontransparencymetadata)

* * *

### suggestedPromptMetadata?[​](#suggestedpromptmetadata "Direct link to suggestedPromptMetadata?")

> `optional` **suggestedPromptMetadata**: `null` | [`IBotSuggestedPromptMetadata`](/docs/api/namespaces/proto/interfaces/IBotSuggestedPromptMetadata)

Defined in: [WAProto/index.d.ts:1538](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1538)

#### Implementation of[​](#implementation-of-30 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`suggestedPromptMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#suggestedpromptmetadata)

* * *

### timezone?[​](#timezone "Direct link to timezone?")

> `optional` **timezone**: `null` | `string`

Defined in: [WAProto/index.d.ts:1542](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1542)

#### Implementation of[​](#implementation-of-31 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`timezone`](/docs/api/namespaces/proto/interfaces/IBotMetadata#timezone)

* * *

### unifiedResponseMutation?[​](#unifiedresponsemutation "Direct link to unifiedResponseMutation?")

> `optional` **unifiedResponseMutation**: `null` | [`IBotUnifiedResponseMutation`](/docs/api/namespaces/proto/interfaces/IBotUnifiedResponseMutation)

Defined in: [WAProto/index.d.ts:1562](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1562)

#### Implementation of[​](#implementation-of-32 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`unifiedResponseMutation`](/docs/api/namespaces/proto/interfaces/IBotMetadata#unifiedresponsemutation)

* * *

### verificationMetadata?[​](#verificationmetadata "Direct link to verificationMetadata?")

> `optional` **verificationMetadata**: `null` | [`IBotSignatureVerificationMetadata`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationMetadata)

Defined in: [WAProto/index.d.ts:1561](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1561)

#### Implementation of[​](#implementation-of-33 "Direct link to Implementation of")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata).[`verificationMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata#verificationmetadata)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1574](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1574)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotMetadata`](/docs/api/namespaces/proto/classes/BotMetadata)

Defined in: [WAProto/index.d.ts:1569](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1569)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotMetadata`](/docs/api/namespaces/proto/classes/BotMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotMetadata`](/docs/api/namespaces/proto/classes/BotMetadata)

Defined in: [WAProto/index.d.ts:1571](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1571)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotMetadata`](/docs/api/namespaces/proto/classes/BotMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1570](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1570)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotMetadata`](/docs/api/namespaces/proto/classes/BotMetadata)

Defined in: [WAProto/index.d.ts:1572](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1572)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotMetadata`](/docs/api/namespaces/proto/classes/BotMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1575](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1575)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1573](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1573)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotMetadata`](/docs/api/namespaces/proto/classes/BotMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botmetricsmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotMetricsMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotMetricsMetadata)

Defined in: [WAProto/index.d.ts:1626](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1626)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotMetricsMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetricsMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotMetricsMetadata()[​](#new-botmetricsmetadata "Direct link to new BotMetricsMetadata()")

> **new BotMetricsMetadata**(`p`?): [`BotMetricsMetadata`](/docs/api/namespaces/proto/classes/BotMetricsMetadata)

Defined in: [WAProto/index.d.ts:1627](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1627)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotMetricsMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetricsMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotMetricsMetadata`](/docs/api/namespaces/proto/classes/BotMetricsMetadata)

## Properties[​](#properties "Direct link to Properties")

### destinationEntryPoint?[​](#destinationentrypoint "Direct link to destinationEntryPoint?")

> `optional` **destinationEntryPoint**: `null` | [`BotMetricsEntryPoint`](/docs/api/namespaces/proto/enumerations/BotMetricsEntryPoint)

Defined in: [WAProto/index.d.ts:1629](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1629)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotMetricsMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetricsMetadata).[`destinationEntryPoint`](/docs/api/namespaces/proto/interfaces/IBotMetricsMetadata#destinationentrypoint)

* * *

### destinationId?[​](#destinationid "Direct link to destinationId?")

> `optional` **destinationId**: `null` | `string`

Defined in: [WAProto/index.d.ts:1628](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1628)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotMetricsMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetricsMetadata).[`destinationId`](/docs/api/namespaces/proto/interfaces/IBotMetricsMetadata#destinationid)

* * *

### threadOrigin?[​](#threadorigin "Direct link to threadOrigin?")

> `optional` **threadOrigin**: `null` | [`BotMetricsThreadEntryPoint`](/docs/api/namespaces/proto/enumerations/BotMetricsThreadEntryPoint)

Defined in: [WAProto/index.d.ts:1630](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1630)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBotMetricsMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetricsMetadata).[`threadOrigin`](/docs/api/namespaces/proto/interfaces/IBotMetricsMetadata#threadorigin)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1636](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1636)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotMetricsMetadata`](/docs/api/namespaces/proto/classes/BotMetricsMetadata)

Defined in: [WAProto/index.d.ts:1631](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1631)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotMetricsMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetricsMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotMetricsMetadata`](/docs/api/namespaces/proto/classes/BotMetricsMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotMetricsMetadata`](/docs/api/namespaces/proto/classes/BotMetricsMetadata)

Defined in: [WAProto/index.d.ts:1633](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1633)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotMetricsMetadata`](/docs/api/namespaces/proto/classes/BotMetricsMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1632](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1632)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotMetricsMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetricsMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotMetricsMetadata`](/docs/api/namespaces/proto/classes/BotMetricsMetadata)

Defined in: [WAProto/index.d.ts:1634](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1634)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotMetricsMetadata`](/docs/api/namespaces/proto/classes/BotMetricsMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1637](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1637)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1635](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1635)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotMetricsMetadata`](/docs/api/namespaces/proto/classes/BotMetricsMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botmodeselectionmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotModeSelectionMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotModeSelectionMetadata)

Defined in: [WAProto/index.d.ts:1652](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1652)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotModeSelectionMetadata`](/docs/api/namespaces/proto/interfaces/IBotModeSelectionMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotModeSelectionMetadata()[​](#new-botmodeselectionmetadata "Direct link to new BotModeSelectionMetadata()")

> **new BotModeSelectionMetadata**(`p`?): [`BotModeSelectionMetadata`](/docs/api/namespaces/proto/classes/BotModeSelectionMetadata)

Defined in: [WAProto/index.d.ts:1653](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1653)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotModeSelectionMetadata`](/docs/api/namespaces/proto/interfaces/IBotModeSelectionMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotModeSelectionMetadata`](/docs/api/namespaces/proto/classes/BotModeSelectionMetadata)

## Properties[​](#properties "Direct link to Properties")

### mode[​](#mode "Direct link to mode")

> **mode**: [`BotUserSelectionMode`](/docs/api/namespaces/proto/namespaces/BotModeSelectionMetadata/enumerations/BotUserSelectionMode)\[\]

Defined in: [WAProto/index.d.ts:1654](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1654)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotModeSelectionMetadata`](/docs/api/namespaces/proto/interfaces/IBotModeSelectionMetadata).[`mode`](/docs/api/namespaces/proto/interfaces/IBotModeSelectionMetadata#mode)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1660](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1660)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotModeSelectionMetadata`](/docs/api/namespaces/proto/classes/BotModeSelectionMetadata)

Defined in: [WAProto/index.d.ts:1655](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1655)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotModeSelectionMetadata`](/docs/api/namespaces/proto/interfaces/IBotModeSelectionMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotModeSelectionMetadata`](/docs/api/namespaces/proto/classes/BotModeSelectionMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotModeSelectionMetadata`](/docs/api/namespaces/proto/classes/BotModeSelectionMetadata)

Defined in: [WAProto/index.d.ts:1657](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1657)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotModeSelectionMetadata`](/docs/api/namespaces/proto/classes/BotModeSelectionMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1656](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1656)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotModeSelectionMetadata`](/docs/api/namespaces/proto/interfaces/IBotModeSelectionMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotModeSelectionMetadata`](/docs/api/namespaces/proto/classes/BotModeSelectionMetadata)

Defined in: [WAProto/index.d.ts:1658](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1658)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotModeSelectionMetadata`](/docs/api/namespaces/proto/classes/BotModeSelectionMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1661](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1661)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1659](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1659)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotModeSelectionMetadata`](/docs/api/namespaces/proto/classes/BotModeSelectionMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botmodelmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotModelMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotModelMetadata)

Defined in: [WAProto/index.d.ts:1678](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1678)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotModelMetadata`](/docs/api/namespaces/proto/interfaces/IBotModelMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotModelMetadata()[​](#new-botmodelmetadata "Direct link to new BotModelMetadata()")

> **new BotModelMetadata**(`p`?): [`BotModelMetadata`](/docs/api/namespaces/proto/classes/BotModelMetadata)

Defined in: [WAProto/index.d.ts:1679](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1679)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotModelMetadata`](/docs/api/namespaces/proto/interfaces/IBotModelMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotModelMetadata`](/docs/api/namespaces/proto/classes/BotModelMetadata)

## Properties[​](#properties "Direct link to Properties")

### modelNameOverride?[​](#modelnameoverride "Direct link to modelNameOverride?")

> `optional` **modelNameOverride**: `null` | `string`

Defined in: [WAProto/index.d.ts:1682](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1682)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotModelMetadata`](/docs/api/namespaces/proto/interfaces/IBotModelMetadata).[`modelNameOverride`](/docs/api/namespaces/proto/interfaces/IBotModelMetadata#modelnameoverride)

* * *

### modelType?[​](#modeltype "Direct link to modelType?")

> `optional` **modelType**: `null` | [`ModelType`](/docs/api/namespaces/proto/namespaces/BotModelMetadata/enumerations/ModelType)

Defined in: [WAProto/index.d.ts:1680](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1680)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotModelMetadata`](/docs/api/namespaces/proto/interfaces/IBotModelMetadata).[`modelType`](/docs/api/namespaces/proto/interfaces/IBotModelMetadata#modeltype)

* * *

### premiumModelStatus?[​](#premiummodelstatus "Direct link to premiumModelStatus?")

> `optional` **premiumModelStatus**: `null` | [`PremiumModelStatus`](/docs/api/namespaces/proto/namespaces/BotModelMetadata/enumerations/PremiumModelStatus)

Defined in: [WAProto/index.d.ts:1681](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1681)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBotModelMetadata`](/docs/api/namespaces/proto/interfaces/IBotModelMetadata).[`premiumModelStatus`](/docs/api/namespaces/proto/interfaces/IBotModelMetadata#premiummodelstatus)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1688](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1688)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotModelMetadata`](/docs/api/namespaces/proto/classes/BotModelMetadata)

Defined in: [WAProto/index.d.ts:1683](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1683)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotModelMetadata`](/docs/api/namespaces/proto/interfaces/IBotModelMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotModelMetadata`](/docs/api/namespaces/proto/classes/BotModelMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotModelMetadata`](/docs/api/namespaces/proto/classes/BotModelMetadata)

Defined in: [WAProto/index.d.ts:1685](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1685)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotModelMetadata`](/docs/api/namespaces/proto/classes/BotModelMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1684](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1684)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotModelMetadata`](/docs/api/namespaces/proto/interfaces/IBotModelMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotModelMetadata`](/docs/api/namespaces/proto/classes/BotModelMetadata)

Defined in: [WAProto/index.d.ts:1686](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1686)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotModelMetadata`](/docs/api/namespaces/proto/classes/BotModelMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1689](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1689)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1687](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1687)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotModelMetadata`](/docs/api/namespaces/proto/classes/BotModelMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botpluginmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotPluginMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotPluginMetadata)

Defined in: [WAProto/index.d.ts:1722](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1722)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotPluginMetadata`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotPluginMetadata()[​](#new-botpluginmetadata "Direct link to new BotPluginMetadata()")

> **new BotPluginMetadata**(`p`?): [`BotPluginMetadata`](/docs/api/namespaces/proto/classes/BotPluginMetadata)

Defined in: [WAProto/index.d.ts:1723](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1723)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotPluginMetadata`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotPluginMetadata`](/docs/api/namespaces/proto/classes/BotPluginMetadata)

## Properties[​](#properties "Direct link to Properties")

### deprecatedField?[​](#deprecatedfield "Direct link to deprecatedField?")

> `optional` **deprecatedField**: `null` | [`PluginType`](/docs/api/namespaces/proto/namespaces/BotPluginMetadata/enumerations/PluginType)

Defined in: [WAProto/index.d.ts:1733](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1733)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotPluginMetadata`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata).[`deprecatedField`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata#deprecatedfield)

* * *

### expectedLinksCount?[​](#expectedlinkscount "Direct link to expectedLinksCount?")

> `optional` **expectedLinksCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:1730](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1730)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotPluginMetadata`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata).[`expectedLinksCount`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata#expectedlinkscount)

* * *

### faviconCdnUrl?[​](#faviconcdnurl "Direct link to faviconCdnUrl?")

> `optional` **faviconCdnUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:1735](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1735)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBotPluginMetadata`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata).[`faviconCdnUrl`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata#faviconcdnurl)

* * *

### parentPluginMessageKey?[​](#parentpluginmessagekey "Direct link to parentPluginMessageKey?")

> `optional` **parentPluginMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:1732](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1732)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IBotPluginMetadata`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata).[`parentPluginMessageKey`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata#parentpluginmessagekey)

* * *

### parentPluginType?[​](#parentplugintype "Direct link to parentPluginType?")

> `optional` **parentPluginType**: `null` | [`PluginType`](/docs/api/namespaces/proto/namespaces/BotPluginMetadata/enumerations/PluginType)

Defined in: [WAProto/index.d.ts:1734](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1734)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IBotPluginMetadata`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata).[`parentPluginType`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata#parentplugintype)

* * *

### pluginType?[​](#plugintype "Direct link to pluginType?")

> `optional` **pluginType**: `null` | [`PluginType`](/docs/api/namespaces/proto/namespaces/BotPluginMetadata/enumerations/PluginType)

Defined in: [WAProto/index.d.ts:1725](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1725)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IBotPluginMetadata`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata).[`pluginType`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata#plugintype)

* * *

### profilePhotoCdnUrl?[​](#profilephotocdnurl "Direct link to profilePhotoCdnUrl?")

> `optional` **profilePhotoCdnUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:1727](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1727)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IBotPluginMetadata`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata).[`profilePhotoCdnUrl`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata#profilephotocdnurl)

* * *

### provider?[​](#provider "Direct link to provider?")

> `optional` **provider**: `null` | [`SearchProvider`](/docs/api/namespaces/proto/namespaces/BotPluginMetadata/enumerations/SearchProvider)

Defined in: [WAProto/index.d.ts:1724](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1724)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IBotPluginMetadata`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata).[`provider`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata#provider)

* * *

### referenceIndex?[​](#referenceindex "Direct link to referenceIndex?")

> `optional` **referenceIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:1729](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1729)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IBotPluginMetadata`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata).[`referenceIndex`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata#referenceindex)

* * *

### searchProviderUrl?[​](#searchproviderurl "Direct link to searchProviderUrl?")

> `optional` **searchProviderUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:1728](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1728)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IBotPluginMetadata`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata).[`searchProviderUrl`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata#searchproviderurl)

* * *

### searchQuery?[​](#searchquery "Direct link to searchQuery?")

> `optional` **searchQuery**: `null` | `string`

Defined in: [WAProto/index.d.ts:1731](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1731)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IBotPluginMetadata`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata).[`searchQuery`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata#searchquery)

* * *

### thumbnailCdnUrl?[​](#thumbnailcdnurl "Direct link to thumbnailCdnUrl?")

> `optional` **thumbnailCdnUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:1726](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1726)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IBotPluginMetadata`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata).[`thumbnailCdnUrl`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata#thumbnailcdnurl)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1741](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1741)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotPluginMetadata`](/docs/api/namespaces/proto/classes/BotPluginMetadata)

Defined in: [WAProto/index.d.ts:1736](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1736)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotPluginMetadata`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotPluginMetadata`](/docs/api/namespaces/proto/classes/BotPluginMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotPluginMetadata`](/docs/api/namespaces/proto/classes/BotPluginMetadata)

Defined in: [WAProto/index.d.ts:1738](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1738)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotPluginMetadata`](/docs/api/namespaces/proto/classes/BotPluginMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1737](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1737)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotPluginMetadata`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotPluginMetadata`](/docs/api/namespaces/proto/classes/BotPluginMetadata)

Defined in: [WAProto/index.d.ts:1739](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1739)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotPluginMetadata`](/docs/api/namespaces/proto/classes/BotPluginMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1742](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1742)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1740](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1740)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotPluginMetadata`](/docs/api/namespaces/proto/classes/BotPluginMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botprogressindicatormetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotProgressIndicatorMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotProgressIndicatorMetadata)

Defined in: [WAProto/index.d.ts:1766](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1766)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotProgressIndicatorMetadata`](/docs/api/namespaces/proto/interfaces/IBotProgressIndicatorMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotProgressIndicatorMetadata()[​](#new-botprogressindicatormetadata "Direct link to new BotProgressIndicatorMetadata()")

> **new BotProgressIndicatorMetadata**(`p`?): [`BotProgressIndicatorMetadata`](/docs/api/namespaces/proto/classes/BotProgressIndicatorMetadata)

Defined in: [WAProto/index.d.ts:1767](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1767)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotProgressIndicatorMetadata`](/docs/api/namespaces/proto/interfaces/IBotProgressIndicatorMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotProgressIndicatorMetadata`](/docs/api/namespaces/proto/classes/BotProgressIndicatorMetadata)

## Properties[​](#properties "Direct link to Properties")

### progressDescription?[​](#progressdescription "Direct link to progressDescription?")

> `optional` **progressDescription**: `null` | `string`

Defined in: [WAProto/index.d.ts:1768](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1768)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotProgressIndicatorMetadata`](/docs/api/namespaces/proto/interfaces/IBotProgressIndicatorMetadata).[`progressDescription`](/docs/api/namespaces/proto/interfaces/IBotProgressIndicatorMetadata#progressdescription)

* * *

### stepsMetadata[​](#stepsmetadata "Direct link to stepsMetadata")

> **stepsMetadata**: [`IBotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata)\[\]

Defined in: [WAProto/index.d.ts:1769](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1769)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotProgressIndicatorMetadata`](/docs/api/namespaces/proto/interfaces/IBotProgressIndicatorMetadata).[`stepsMetadata`](/docs/api/namespaces/proto/interfaces/IBotProgressIndicatorMetadata#stepsmetadata)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1775](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1775)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotProgressIndicatorMetadata`](/docs/api/namespaces/proto/classes/BotProgressIndicatorMetadata)

Defined in: [WAProto/index.d.ts:1770](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1770)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotProgressIndicatorMetadata`](/docs/api/namespaces/proto/interfaces/IBotProgressIndicatorMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotProgressIndicatorMetadata`](/docs/api/namespaces/proto/classes/BotProgressIndicatorMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotProgressIndicatorMetadata`](/docs/api/namespaces/proto/classes/BotProgressIndicatorMetadata)

Defined in: [WAProto/index.d.ts:1772](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1772)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotProgressIndicatorMetadata`](/docs/api/namespaces/proto/classes/BotProgressIndicatorMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1771](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1771)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotProgressIndicatorMetadata`](/docs/api/namespaces/proto/interfaces/IBotProgressIndicatorMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotProgressIndicatorMetadata`](/docs/api/namespaces/proto/classes/BotProgressIndicatorMetadata)

Defined in: [WAProto/index.d.ts:1773](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1773)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotProgressIndicatorMetadata`](/docs/api/namespaces/proto/classes/BotProgressIndicatorMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1776](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1776)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1774](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1774)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotProgressIndicatorMetadata`](/docs/api/namespaces/proto/classes/BotProgressIndicatorMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botpromotionmessagemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotPromotionMessageMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotPromotionMessageMetadata)

Defined in: [WAProto/index.d.ts:1904](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1904)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotPromotionMessageMetadata`](/docs/api/namespaces/proto/interfaces/IBotPromotionMessageMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotPromotionMessageMetadata()[​](#new-botpromotionmessagemetadata "Direct link to new BotPromotionMessageMetadata()")

> **new BotPromotionMessageMetadata**(`p`?): [`BotPromotionMessageMetadata`](/docs/api/namespaces/proto/classes/BotPromotionMessageMetadata)

Defined in: [WAProto/index.d.ts:1905](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1905)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotPromotionMessageMetadata`](/docs/api/namespaces/proto/interfaces/IBotPromotionMessageMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotPromotionMessageMetadata`](/docs/api/namespaces/proto/classes/BotPromotionMessageMetadata)

## Properties[​](#properties "Direct link to Properties")

### buttonTitle?[​](#buttontitle "Direct link to buttonTitle?")

> `optional` **buttonTitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:1907](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1907)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotPromotionMessageMetadata`](/docs/api/namespaces/proto/interfaces/IBotPromotionMessageMetadata).[`buttonTitle`](/docs/api/namespaces/proto/interfaces/IBotPromotionMessageMetadata#buttontitle)

* * *

### promotionType?[​](#promotiontype "Direct link to promotionType?")

> `optional` **promotionType**: `null` | [`BotPromotionType`](/docs/api/namespaces/proto/namespaces/BotPromotionMessageMetadata/enumerations/BotPromotionType)

Defined in: [WAProto/index.d.ts:1906](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1906)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotPromotionMessageMetadata`](/docs/api/namespaces/proto/interfaces/IBotPromotionMessageMetadata).[`promotionType`](/docs/api/namespaces/proto/interfaces/IBotPromotionMessageMetadata#promotiontype)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1913](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1913)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotPromotionMessageMetadata`](/docs/api/namespaces/proto/classes/BotPromotionMessageMetadata)

Defined in: [WAProto/index.d.ts:1908](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1908)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotPromotionMessageMetadata`](/docs/api/namespaces/proto/interfaces/IBotPromotionMessageMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotPromotionMessageMetadata`](/docs/api/namespaces/proto/classes/BotPromotionMessageMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotPromotionMessageMetadata`](/docs/api/namespaces/proto/classes/BotPromotionMessageMetadata)

Defined in: [WAProto/index.d.ts:1910](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1910)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotPromotionMessageMetadata`](/docs/api/namespaces/proto/classes/BotPromotionMessageMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1909](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1909)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotPromotionMessageMetadata`](/docs/api/namespaces/proto/interfaces/IBotPromotionMessageMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotPromotionMessageMetadata`](/docs/api/namespaces/proto/classes/BotPromotionMessageMetadata)

Defined in: [WAProto/index.d.ts:1911](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1911)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotPromotionMessageMetadata`](/docs/api/namespaces/proto/classes/BotPromotionMessageMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1914](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1914)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1912](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1912)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotPromotionMessageMetadata`](/docs/api/namespaces/proto/classes/BotPromotionMessageMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botpromptsuggestion"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotPromptSuggestion](https://baileys.wiki/docs/api/namespaces/proto/classes/BotPromptSuggestion)

Defined in: [WAProto/index.d.ts:1931](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1931)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotPromptSuggestion`](/docs/api/namespaces/proto/interfaces/IBotPromptSuggestion)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotPromptSuggestion()[​](#new-botpromptsuggestion "Direct link to new BotPromptSuggestion()")

> **new BotPromptSuggestion**(`p`?): [`BotPromptSuggestion`](/docs/api/namespaces/proto/classes/BotPromptSuggestion)

Defined in: [WAProto/index.d.ts:1932](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1932)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotPromptSuggestion`](/docs/api/namespaces/proto/interfaces/IBotPromptSuggestion)

#### Returns[​](#returns "Direct link to Returns")

[`BotPromptSuggestion`](/docs/api/namespaces/proto/classes/BotPromptSuggestion)

## Properties[​](#properties "Direct link to Properties")

### prompt?[​](#prompt "Direct link to prompt?")

> `optional` **prompt**: `null` | `string`

Defined in: [WAProto/index.d.ts:1933](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1933)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotPromptSuggestion`](/docs/api/namespaces/proto/interfaces/IBotPromptSuggestion).[`prompt`](/docs/api/namespaces/proto/interfaces/IBotPromptSuggestion#prompt)

* * *

### promptId?[​](#promptid "Direct link to promptId?")

> `optional` **promptId**: `null` | `string`

Defined in: [WAProto/index.d.ts:1934](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1934)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotPromptSuggestion`](/docs/api/namespaces/proto/interfaces/IBotPromptSuggestion).[`promptId`](/docs/api/namespaces/proto/interfaces/IBotPromptSuggestion#promptid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1940](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1940)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotPromptSuggestion`](/docs/api/namespaces/proto/classes/BotPromptSuggestion)

Defined in: [WAProto/index.d.ts:1935](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1935)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotPromptSuggestion`](/docs/api/namespaces/proto/interfaces/IBotPromptSuggestion)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotPromptSuggestion`](/docs/api/namespaces/proto/classes/BotPromptSuggestion)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotPromptSuggestion`](/docs/api/namespaces/proto/classes/BotPromptSuggestion)

Defined in: [WAProto/index.d.ts:1937](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1937)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotPromptSuggestion`](/docs/api/namespaces/proto/classes/BotPromptSuggestion)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1936](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1936)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotPromptSuggestion`](/docs/api/namespaces/proto/interfaces/IBotPromptSuggestion)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotPromptSuggestion`](/docs/api/namespaces/proto/classes/BotPromptSuggestion)

Defined in: [WAProto/index.d.ts:1938](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1938)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotPromptSuggestion`](/docs/api/namespaces/proto/classes/BotPromptSuggestion)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1941](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1941)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1939](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1939)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotPromptSuggestion`](/docs/api/namespaces/proto/classes/BotPromptSuggestion)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botpromptsuggestions"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotPromptSuggestions](https://baileys.wiki/docs/api/namespaces/proto/classes/BotPromptSuggestions)

Defined in: [WAProto/index.d.ts:1948](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1948)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotPromptSuggestions`](/docs/api/namespaces/proto/interfaces/IBotPromptSuggestions)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotPromptSuggestions()[​](#new-botpromptsuggestions "Direct link to new BotPromptSuggestions()")

> **new BotPromptSuggestions**(`p`?): [`BotPromptSuggestions`](/docs/api/namespaces/proto/classes/BotPromptSuggestions)

Defined in: [WAProto/index.d.ts:1949](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1949)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotPromptSuggestions`](/docs/api/namespaces/proto/interfaces/IBotPromptSuggestions)

#### Returns[​](#returns "Direct link to Returns")

[`BotPromptSuggestions`](/docs/api/namespaces/proto/classes/BotPromptSuggestions)

## Properties[​](#properties "Direct link to Properties")

### suggestions[​](#suggestions "Direct link to suggestions")

> **suggestions**: [`IBotPromptSuggestion`](/docs/api/namespaces/proto/interfaces/IBotPromptSuggestion)\[\]

Defined in: [WAProto/index.d.ts:1950](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1950)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotPromptSuggestions`](/docs/api/namespaces/proto/interfaces/IBotPromptSuggestions).[`suggestions`](/docs/api/namespaces/proto/interfaces/IBotPromptSuggestions#suggestions)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1956](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1956)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotPromptSuggestions`](/docs/api/namespaces/proto/classes/BotPromptSuggestions)

Defined in: [WAProto/index.d.ts:1951](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1951)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotPromptSuggestions`](/docs/api/namespaces/proto/interfaces/IBotPromptSuggestions)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotPromptSuggestions`](/docs/api/namespaces/proto/classes/BotPromptSuggestions)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotPromptSuggestions`](/docs/api/namespaces/proto/classes/BotPromptSuggestions)

Defined in: [WAProto/index.d.ts:1953](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1953)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotPromptSuggestions`](/docs/api/namespaces/proto/classes/BotPromptSuggestions)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1952](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1952)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotPromptSuggestions`](/docs/api/namespaces/proto/interfaces/IBotPromptSuggestions)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotPromptSuggestions`](/docs/api/namespaces/proto/classes/BotPromptSuggestions)

Defined in: [WAProto/index.d.ts:1954](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1954)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotPromptSuggestions`](/docs/api/namespaces/proto/classes/BotPromptSuggestions)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1957](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1957)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1955](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1955)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotPromptSuggestions`](/docs/api/namespaces/proto/classes/BotPromptSuggestions)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botquotametadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotQuotaMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotQuotaMetadata)

Defined in: [WAProto/index.d.ts:1964](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1964)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotQuotaMetadata`](/docs/api/namespaces/proto/interfaces/IBotQuotaMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotQuotaMetadata()[​](#new-botquotametadata "Direct link to new BotQuotaMetadata()")

> **new BotQuotaMetadata**(`p`?): [`BotQuotaMetadata`](/docs/api/namespaces/proto/classes/BotQuotaMetadata)

Defined in: [WAProto/index.d.ts:1965](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1965)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotQuotaMetadata`](/docs/api/namespaces/proto/interfaces/IBotQuotaMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotQuotaMetadata`](/docs/api/namespaces/proto/classes/BotQuotaMetadata)

## Properties[​](#properties "Direct link to Properties")

### botFeatureQuotaMetadata[​](#botfeaturequotametadata "Direct link to botFeatureQuotaMetadata")

> **botFeatureQuotaMetadata**: [`IBotFeatureQuotaMetadata`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/interfaces/IBotFeatureQuotaMetadata)\[\]

Defined in: [WAProto/index.d.ts:1966](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1966)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotQuotaMetadata`](/docs/api/namespaces/proto/interfaces/IBotQuotaMetadata).[`botFeatureQuotaMetadata`](/docs/api/namespaces/proto/interfaces/IBotQuotaMetadata#botfeaturequotametadata)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1972](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1972)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotQuotaMetadata`](/docs/api/namespaces/proto/classes/BotQuotaMetadata)

Defined in: [WAProto/index.d.ts:1967](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1967)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotQuotaMetadata`](/docs/api/namespaces/proto/interfaces/IBotQuotaMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotQuotaMetadata`](/docs/api/namespaces/proto/classes/BotQuotaMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotQuotaMetadata`](/docs/api/namespaces/proto/classes/BotQuotaMetadata)

Defined in: [WAProto/index.d.ts:1969](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1969)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotQuotaMetadata`](/docs/api/namespaces/proto/classes/BotQuotaMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1968](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1968)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotQuotaMetadata`](/docs/api/namespaces/proto/interfaces/IBotQuotaMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotQuotaMetadata`](/docs/api/namespaces/proto/classes/BotQuotaMetadata)

Defined in: [WAProto/index.d.ts:1970](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1970)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotQuotaMetadata`](/docs/api/namespaces/proto/classes/BotQuotaMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1973](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1973)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1971](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1971)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotQuotaMetadata`](/docs/api/namespaces/proto/classes/BotQuotaMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botremindermetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotReminderMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotReminderMetadata)

Defined in: [WAProto/index.d.ts:2015](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2015)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotReminderMetadata`](/docs/api/namespaces/proto/interfaces/IBotReminderMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotReminderMetadata()[​](#new-botremindermetadata "Direct link to new BotReminderMetadata()")

> **new BotReminderMetadata**(`p`?): [`BotReminderMetadata`](/docs/api/namespaces/proto/classes/BotReminderMetadata)

Defined in: [WAProto/index.d.ts:2016](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2016)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotReminderMetadata`](/docs/api/namespaces/proto/interfaces/IBotReminderMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotReminderMetadata`](/docs/api/namespaces/proto/classes/BotReminderMetadata)

## Properties[​](#properties "Direct link to Properties")

### action?[​](#action "Direct link to action?")

> `optional` **action**: `null` | [`ReminderAction`](/docs/api/namespaces/proto/namespaces/BotReminderMetadata/enumerations/ReminderAction)

Defined in: [WAProto/index.d.ts:2018](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2018)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotReminderMetadata`](/docs/api/namespaces/proto/interfaces/IBotReminderMetadata).[`action`](/docs/api/namespaces/proto/interfaces/IBotReminderMetadata#action)

* * *

### frequency?[​](#frequency "Direct link to frequency?")

> `optional` **frequency**: `null` | [`ReminderFrequency`](/docs/api/namespaces/proto/namespaces/BotReminderMetadata/enumerations/ReminderFrequency)

Defined in: [WAProto/index.d.ts:2021](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2021)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotReminderMetadata`](/docs/api/namespaces/proto/interfaces/IBotReminderMetadata).[`frequency`](/docs/api/namespaces/proto/interfaces/IBotReminderMetadata#frequency)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:2019](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2019)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBotReminderMetadata`](/docs/api/namespaces/proto/interfaces/IBotReminderMetadata).[`name`](/docs/api/namespaces/proto/interfaces/IBotReminderMetadata#name)

* * *

### nextTriggerTimestamp?[​](#nexttriggertimestamp "Direct link to nextTriggerTimestamp?")

> `optional` **nextTriggerTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:2020](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2020)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IBotReminderMetadata`](/docs/api/namespaces/proto/interfaces/IBotReminderMetadata).[`nextTriggerTimestamp`](/docs/api/namespaces/proto/interfaces/IBotReminderMetadata#nexttriggertimestamp)

* * *

### requestMessageKey?[​](#requestmessagekey "Direct link to requestMessageKey?")

> `optional` **requestMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:2017](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2017)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IBotReminderMetadata`](/docs/api/namespaces/proto/interfaces/IBotReminderMetadata).[`requestMessageKey`](/docs/api/namespaces/proto/interfaces/IBotReminderMetadata#requestmessagekey)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2027](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2027)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotReminderMetadata`](/docs/api/namespaces/proto/classes/BotReminderMetadata)

Defined in: [WAProto/index.d.ts:2022](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2022)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotReminderMetadata`](/docs/api/namespaces/proto/interfaces/IBotReminderMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotReminderMetadata`](/docs/api/namespaces/proto/classes/BotReminderMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotReminderMetadata`](/docs/api/namespaces/proto/classes/BotReminderMetadata)

Defined in: [WAProto/index.d.ts:2024](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2024)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotReminderMetadata`](/docs/api/namespaces/proto/classes/BotReminderMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2023](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2023)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotReminderMetadata`](/docs/api/namespaces/proto/interfaces/IBotReminderMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotReminderMetadata`](/docs/api/namespaces/proto/classes/BotReminderMetadata)

Defined in: [WAProto/index.d.ts:2025](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2025)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotReminderMetadata`](/docs/api/namespaces/proto/classes/BotReminderMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2028](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2028)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2026](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2026)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotReminderMetadata`](/docs/api/namespaces/proto/classes/BotReminderMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botrenderingmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotRenderingMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotRenderingMetadata)

Defined in: [WAProto/index.d.ts:2053](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2053)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotRenderingMetadata`](/docs/api/namespaces/proto/interfaces/IBotRenderingMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotRenderingMetadata()[​](#new-botrenderingmetadata "Direct link to new BotRenderingMetadata()")

> **new BotRenderingMetadata**(`p`?): [`BotRenderingMetadata`](/docs/api/namespaces/proto/classes/BotRenderingMetadata)

Defined in: [WAProto/index.d.ts:2054](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2054)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotRenderingMetadata`](/docs/api/namespaces/proto/interfaces/IBotRenderingMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotRenderingMetadata`](/docs/api/namespaces/proto/classes/BotRenderingMetadata)

## Properties[​](#properties "Direct link to Properties")

### keywords[​](#keywords "Direct link to keywords")

> **keywords**: [`IKeyword`](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/interfaces/IKeyword)\[\]

Defined in: [WAProto/index.d.ts:2055](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2055)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotRenderingMetadata`](/docs/api/namespaces/proto/interfaces/IBotRenderingMetadata).[`keywords`](/docs/api/namespaces/proto/interfaces/IBotRenderingMetadata#keywords)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2061](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2061)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotRenderingMetadata`](/docs/api/namespaces/proto/classes/BotRenderingMetadata)

Defined in: [WAProto/index.d.ts:2056](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2056)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotRenderingMetadata`](/docs/api/namespaces/proto/interfaces/IBotRenderingMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotRenderingMetadata`](/docs/api/namespaces/proto/classes/BotRenderingMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotRenderingMetadata`](/docs/api/namespaces/proto/classes/BotRenderingMetadata)

Defined in: [WAProto/index.d.ts:2058](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2058)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotRenderingMetadata`](/docs/api/namespaces/proto/classes/BotRenderingMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2057](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2057)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotRenderingMetadata`](/docs/api/namespaces/proto/interfaces/IBotRenderingMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotRenderingMetadata`](/docs/api/namespaces/proto/classes/BotRenderingMetadata)

Defined in: [WAProto/index.d.ts:2059](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2059)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotRenderingMetadata`](/docs/api/namespaces/proto/classes/BotRenderingMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2062](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2062)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2060](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2060)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotRenderingMetadata`](/docs/api/namespaces/proto/classes/BotRenderingMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botsessionmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotSessionMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotSessionMetadata)

Defined in: [WAProto/index.d.ts:2091](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2091)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotSessionMetadata`](/docs/api/namespaces/proto/interfaces/IBotSessionMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotSessionMetadata()[​](#new-botsessionmetadata "Direct link to new BotSessionMetadata()")

> **new BotSessionMetadata**(`p`?): [`BotSessionMetadata`](/docs/api/namespaces/proto/classes/BotSessionMetadata)

Defined in: [WAProto/index.d.ts:2092](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2092)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotSessionMetadata`](/docs/api/namespaces/proto/interfaces/IBotSessionMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotSessionMetadata`](/docs/api/namespaces/proto/classes/BotSessionMetadata)

## Properties[​](#properties "Direct link to Properties")

### sessionId?[​](#sessionid "Direct link to sessionId?")

> `optional` **sessionId**: `null` | `string`

Defined in: [WAProto/index.d.ts:2093](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2093)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotSessionMetadata`](/docs/api/namespaces/proto/interfaces/IBotSessionMetadata).[`sessionId`](/docs/api/namespaces/proto/interfaces/IBotSessionMetadata#sessionid)

* * *

### sessionSource?[​](#sessionsource "Direct link to sessionSource?")

> `optional` **sessionSource**: `null` | [`BotSessionSource`](/docs/api/namespaces/proto/enumerations/BotSessionSource)

Defined in: [WAProto/index.d.ts:2094](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2094)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotSessionMetadata`](/docs/api/namespaces/proto/interfaces/IBotSessionMetadata).[`sessionSource`](/docs/api/namespaces/proto/interfaces/IBotSessionMetadata#sessionsource)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2100](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2100)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotSessionMetadata`](/docs/api/namespaces/proto/classes/BotSessionMetadata)

Defined in: [WAProto/index.d.ts:2095](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2095)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotSessionMetadata`](/docs/api/namespaces/proto/interfaces/IBotSessionMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotSessionMetadata`](/docs/api/namespaces/proto/classes/BotSessionMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotSessionMetadata`](/docs/api/namespaces/proto/classes/BotSessionMetadata)

Defined in: [WAProto/index.d.ts:2097](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2097)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotSessionMetadata`](/docs/api/namespaces/proto/classes/BotSessionMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2096](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2096)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotSessionMetadata`](/docs/api/namespaces/proto/interfaces/IBotSessionMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotSessionMetadata`](/docs/api/namespaces/proto/classes/BotSessionMetadata)

Defined in: [WAProto/index.d.ts:2098](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2098)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotSessionMetadata`](/docs/api/namespaces/proto/classes/BotSessionMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2101](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2101)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2099](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2099)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotSessionMetadata`](/docs/api/namespaces/proto/classes/BotSessionMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botsignatureverificationmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotSignatureVerificationMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotSignatureVerificationMetadata)

Defined in: [WAProto/index.d.ts:2118](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2118)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotSignatureVerificationMetadata`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotSignatureVerificationMetadata()[​](#new-botsignatureverificationmetadata "Direct link to new BotSignatureVerificationMetadata()")

> **new BotSignatureVerificationMetadata**(`p`?): [`BotSignatureVerificationMetadata`](/docs/api/namespaces/proto/classes/BotSignatureVerificationMetadata)

Defined in: [WAProto/index.d.ts:2119](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2119)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotSignatureVerificationMetadata`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotSignatureVerificationMetadata`](/docs/api/namespaces/proto/classes/BotSignatureVerificationMetadata)

## Properties[​](#properties "Direct link to Properties")

### proofs[​](#proofs "Direct link to proofs")

> **proofs**: [`IBotSignatureVerificationUseCaseProof`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationUseCaseProof)\[\]

Defined in: [WAProto/index.d.ts:2120](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2120)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotSignatureVerificationMetadata`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationMetadata).[`proofs`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationMetadata#proofs)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2126](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2126)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotSignatureVerificationMetadata`](/docs/api/namespaces/proto/classes/BotSignatureVerificationMetadata)

Defined in: [WAProto/index.d.ts:2121](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2121)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotSignatureVerificationMetadata`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotSignatureVerificationMetadata`](/docs/api/namespaces/proto/classes/BotSignatureVerificationMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotSignatureVerificationMetadata`](/docs/api/namespaces/proto/classes/BotSignatureVerificationMetadata)

Defined in: [WAProto/index.d.ts:2123](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2123)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotSignatureVerificationMetadata`](/docs/api/namespaces/proto/classes/BotSignatureVerificationMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2122](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2122)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotSignatureVerificationMetadata`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotSignatureVerificationMetadata`](/docs/api/namespaces/proto/classes/BotSignatureVerificationMetadata)

Defined in: [WAProto/index.d.ts:2124](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2124)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotSignatureVerificationMetadata`](/docs/api/namespaces/proto/classes/BotSignatureVerificationMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2127](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2127)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2125](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2125)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotSignatureVerificationMetadata`](/docs/api/namespaces/proto/classes/BotSignatureVerificationMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botsignatureverificationusecaseproof"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotSignatureVerificationUseCaseProof](https://baileys.wiki/docs/api/namespaces/proto/classes/BotSignatureVerificationUseCaseProof)

Defined in: [WAProto/index.d.ts:2137](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2137)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotSignatureVerificationUseCaseProof`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationUseCaseProof)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotSignatureVerificationUseCaseProof()[​](#new-botsignatureverificationusecaseproof "Direct link to new BotSignatureVerificationUseCaseProof()")

> **new BotSignatureVerificationUseCaseProof**(`p`?): [`BotSignatureVerificationUseCaseProof`](/docs/api/namespaces/proto/classes/BotSignatureVerificationUseCaseProof)

Defined in: [WAProto/index.d.ts:2138](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2138)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotSignatureVerificationUseCaseProof`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationUseCaseProof)

#### Returns[​](#returns "Direct link to Returns")

[`BotSignatureVerificationUseCaseProof`](/docs/api/namespaces/proto/classes/BotSignatureVerificationUseCaseProof)

## Properties[​](#properties "Direct link to Properties")

### certificateChain[​](#certificatechain "Direct link to certificateChain")

> **certificateChain**: `Uint8Array`<`ArrayBufferLike`\>\[\]

Defined in: [WAProto/index.d.ts:2142](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2142)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotSignatureVerificationUseCaseProof`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationUseCaseProof).[`certificateChain`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationUseCaseProof#certificatechain)

* * *

### signature?[​](#signature "Direct link to signature?")

> `optional` **signature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2141](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2141)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotSignatureVerificationUseCaseProof`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationUseCaseProof).[`signature`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationUseCaseProof#signature)

* * *

### useCase?[​](#usecase "Direct link to useCase?")

> `optional` **useCase**: `null` | [`BotSignatureUseCase`](/docs/api/namespaces/proto/namespaces/BotSignatureVerificationUseCaseProof/enumerations/BotSignatureUseCase)

Defined in: [WAProto/index.d.ts:2140](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2140)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBotSignatureVerificationUseCaseProof`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationUseCaseProof).[`useCase`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationUseCaseProof#usecase)

* * *

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | `number`

Defined in: [WAProto/index.d.ts:2139](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2139)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IBotSignatureVerificationUseCaseProof`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationUseCaseProof).[`version`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationUseCaseProof#version)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2148](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2148)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotSignatureVerificationUseCaseProof`](/docs/api/namespaces/proto/classes/BotSignatureVerificationUseCaseProof)

Defined in: [WAProto/index.d.ts:2143](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2143)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotSignatureVerificationUseCaseProof`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationUseCaseProof)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotSignatureVerificationUseCaseProof`](/docs/api/namespaces/proto/classes/BotSignatureVerificationUseCaseProof)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotSignatureVerificationUseCaseProof`](/docs/api/namespaces/proto/classes/BotSignatureVerificationUseCaseProof)

Defined in: [WAProto/index.d.ts:2145](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2145)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotSignatureVerificationUseCaseProof`](/docs/api/namespaces/proto/classes/BotSignatureVerificationUseCaseProof)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2144](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2144)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotSignatureVerificationUseCaseProof`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationUseCaseProof)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotSignatureVerificationUseCaseProof`](/docs/api/namespaces/proto/classes/BotSignatureVerificationUseCaseProof)

Defined in: [WAProto/index.d.ts:2146](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2146)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotSignatureVerificationUseCaseProof`](/docs/api/namespaces/proto/classes/BotSignatureVerificationUseCaseProof)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2149](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2149)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2147](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2147)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotSignatureVerificationUseCaseProof`](/docs/api/namespaces/proto/classes/BotSignatureVerificationUseCaseProof)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botsourcesmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotSourcesMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotSourcesMetadata)

Defined in: [WAProto/index.d.ts:2164](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2164)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotSourcesMetadata`](/docs/api/namespaces/proto/interfaces/IBotSourcesMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotSourcesMetadata()[​](#new-botsourcesmetadata "Direct link to new BotSourcesMetadata()")

> **new BotSourcesMetadata**(`p`?): [`BotSourcesMetadata`](/docs/api/namespaces/proto/classes/BotSourcesMetadata)

Defined in: [WAProto/index.d.ts:2165](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2165)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotSourcesMetadata`](/docs/api/namespaces/proto/interfaces/IBotSourcesMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotSourcesMetadata`](/docs/api/namespaces/proto/classes/BotSourcesMetadata)

## Properties[​](#properties "Direct link to Properties")

### sources[​](#sources "Direct link to sources")

> **sources**: [`IBotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem)\[\]

Defined in: [WAProto/index.d.ts:2166](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2166)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotSourcesMetadata`](/docs/api/namespaces/proto/interfaces/IBotSourcesMetadata).[`sources`](/docs/api/namespaces/proto/interfaces/IBotSourcesMetadata#sources)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2172](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2172)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotSourcesMetadata`](/docs/api/namespaces/proto/classes/BotSourcesMetadata)

Defined in: [WAProto/index.d.ts:2167](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2167)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotSourcesMetadata`](/docs/api/namespaces/proto/interfaces/IBotSourcesMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotSourcesMetadata`](/docs/api/namespaces/proto/classes/BotSourcesMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotSourcesMetadata`](/docs/api/namespaces/proto/classes/BotSourcesMetadata)

Defined in: [WAProto/index.d.ts:2169](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2169)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotSourcesMetadata`](/docs/api/namespaces/proto/classes/BotSourcesMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2168](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2168)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotSourcesMetadata`](/docs/api/namespaces/proto/interfaces/IBotSourcesMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotSourcesMetadata`](/docs/api/namespaces/proto/classes/BotSourcesMetadata)

Defined in: [WAProto/index.d.ts:2170](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2170)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotSourcesMetadata`](/docs/api/namespaces/proto/classes/BotSourcesMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2173](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2173)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2171](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2171)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotSourcesMetadata`](/docs/api/namespaces/proto/classes/BotSourcesMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botsuggestedpromptmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotSuggestedPromptMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/BotSuggestedPromptMetadata)

Defined in: [WAProto/index.d.ts:2225](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2225)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotSuggestedPromptMetadata`](/docs/api/namespaces/proto/interfaces/IBotSuggestedPromptMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotSuggestedPromptMetadata()[​](#new-botsuggestedpromptmetadata "Direct link to new BotSuggestedPromptMetadata()")

> **new BotSuggestedPromptMetadata**(`p`?): [`BotSuggestedPromptMetadata`](/docs/api/namespaces/proto/classes/BotSuggestedPromptMetadata)

Defined in: [WAProto/index.d.ts:2226](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2226)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotSuggestedPromptMetadata`](/docs/api/namespaces/proto/interfaces/IBotSuggestedPromptMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotSuggestedPromptMetadata`](/docs/api/namespaces/proto/classes/BotSuggestedPromptMetadata)

## Properties[​](#properties "Direct link to Properties")

### promptSuggestions?[​](#promptsuggestions "Direct link to promptSuggestions?")

> `optional` **promptSuggestions**: `null` | [`IBotPromptSuggestions`](/docs/api/namespaces/proto/interfaces/IBotPromptSuggestions)

Defined in: [WAProto/index.d.ts:2229](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2229)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotSuggestedPromptMetadata`](/docs/api/namespaces/proto/interfaces/IBotSuggestedPromptMetadata).[`promptSuggestions`](/docs/api/namespaces/proto/interfaces/IBotSuggestedPromptMetadata#promptsuggestions)

* * *

### selectedPromptId?[​](#selectedpromptid "Direct link to selectedPromptId?")

> `optional` **selectedPromptId**: `null` | `string`

Defined in: [WAProto/index.d.ts:2230](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2230)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotSuggestedPromptMetadata`](/docs/api/namespaces/proto/interfaces/IBotSuggestedPromptMetadata).[`selectedPromptId`](/docs/api/namespaces/proto/interfaces/IBotSuggestedPromptMetadata#selectedpromptid)

* * *

### selectedPromptIndex?[​](#selectedpromptindex "Direct link to selectedPromptIndex?")

> `optional` **selectedPromptIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:2228](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2228)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBotSuggestedPromptMetadata`](/docs/api/namespaces/proto/interfaces/IBotSuggestedPromptMetadata).[`selectedPromptIndex`](/docs/api/namespaces/proto/interfaces/IBotSuggestedPromptMetadata#selectedpromptindex)

* * *

### suggestedPrompts[​](#suggestedprompts "Direct link to suggestedPrompts")

> **suggestedPrompts**: `string`\[\]

Defined in: [WAProto/index.d.ts:2227](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2227)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IBotSuggestedPromptMetadata`](/docs/api/namespaces/proto/interfaces/IBotSuggestedPromptMetadata).[`suggestedPrompts`](/docs/api/namespaces/proto/interfaces/IBotSuggestedPromptMetadata#suggestedprompts)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2236](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2236)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotSuggestedPromptMetadata`](/docs/api/namespaces/proto/classes/BotSuggestedPromptMetadata)

Defined in: [WAProto/index.d.ts:2231](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2231)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotSuggestedPromptMetadata`](/docs/api/namespaces/proto/interfaces/IBotSuggestedPromptMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotSuggestedPromptMetadata`](/docs/api/namespaces/proto/classes/BotSuggestedPromptMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotSuggestedPromptMetadata`](/docs/api/namespaces/proto/classes/BotSuggestedPromptMetadata)

Defined in: [WAProto/index.d.ts:2233](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2233)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotSuggestedPromptMetadata`](/docs/api/namespaces/proto/classes/BotSuggestedPromptMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2232](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2232)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotSuggestedPromptMetadata`](/docs/api/namespaces/proto/interfaces/IBotSuggestedPromptMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotSuggestedPromptMetadata`](/docs/api/namespaces/proto/classes/BotSuggestedPromptMetadata)

Defined in: [WAProto/index.d.ts:2234](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2234)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotSuggestedPromptMetadata`](/docs/api/namespaces/proto/classes/BotSuggestedPromptMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2237](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2237)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2235](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2235)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotSuggestedPromptMetadata`](/docs/api/namespaces/proto/classes/BotSuggestedPromptMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botunifiedresponsemutation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/BotUnifiedResponseMutation](https://baileys.wiki/docs/api/namespaces/proto/classes/BotUnifiedResponseMutation)

Defined in: [WAProto/index.d.ts:2245](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2245)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotUnifiedResponseMutation`](/docs/api/namespaces/proto/interfaces/IBotUnifiedResponseMutation)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotUnifiedResponseMutation()[​](#new-botunifiedresponsemutation "Direct link to new BotUnifiedResponseMutation()")

> **new BotUnifiedResponseMutation**(`p`?): [`BotUnifiedResponseMutation`](/docs/api/namespaces/proto/classes/BotUnifiedResponseMutation)

Defined in: [WAProto/index.d.ts:2246](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2246)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotUnifiedResponseMutation`](/docs/api/namespaces/proto/interfaces/IBotUnifiedResponseMutation)

#### Returns[​](#returns "Direct link to Returns")

[`BotUnifiedResponseMutation`](/docs/api/namespaces/proto/classes/BotUnifiedResponseMutation)

## Properties[​](#properties "Direct link to Properties")

### mediaDetailsMetadataList[​](#mediadetailsmetadatalist "Direct link to mediaDetailsMetadataList")

> **mediaDetailsMetadataList**: [`IMediaDetailsMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/IMediaDetailsMetadata)\[\]

Defined in: [WAProto/index.d.ts:2248](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2248)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotUnifiedResponseMutation`](/docs/api/namespaces/proto/interfaces/IBotUnifiedResponseMutation).[`mediaDetailsMetadataList`](/docs/api/namespaces/proto/interfaces/IBotUnifiedResponseMutation#mediadetailsmetadatalist)

* * *

### sbsMetadata?[​](#sbsmetadata "Direct link to sbsMetadata?")

> `optional` **sbsMetadata**: `null` | [`ISideBySideMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/ISideBySideMetadata)

Defined in: [WAProto/index.d.ts:2247](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2247)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotUnifiedResponseMutation`](/docs/api/namespaces/proto/interfaces/IBotUnifiedResponseMutation).[`sbsMetadata`](/docs/api/namespaces/proto/interfaces/IBotUnifiedResponseMutation#sbsmetadata)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2254](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2254)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotUnifiedResponseMutation`](/docs/api/namespaces/proto/classes/BotUnifiedResponseMutation)

Defined in: [WAProto/index.d.ts:2249](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2249)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotUnifiedResponseMutation`](/docs/api/namespaces/proto/interfaces/IBotUnifiedResponseMutation)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotUnifiedResponseMutation`](/docs/api/namespaces/proto/classes/BotUnifiedResponseMutation)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotUnifiedResponseMutation`](/docs/api/namespaces/proto/classes/BotUnifiedResponseMutation)

Defined in: [WAProto/index.d.ts:2251](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2251)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotUnifiedResponseMutation`](/docs/api/namespaces/proto/classes/BotUnifiedResponseMutation)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2250](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2250)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotUnifiedResponseMutation`](/docs/api/namespaces/proto/interfaces/IBotUnifiedResponseMutation)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotUnifiedResponseMutation`](/docs/api/namespaces/proto/classes/BotUnifiedResponseMutation)

Defined in: [WAProto/index.d.ts:2252](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2252)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotUnifiedResponseMutation`](/docs/api/namespaces/proto/classes/BotUnifiedResponseMutation)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2255](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2255)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2253](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2253)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotUnifiedResponseMutation`](/docs/api/namespaces/proto/classes/BotUnifiedResponseMutation)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-calllogrecord"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/CallLogRecord](https://baileys.wiki/docs/api/namespaces/proto/classes/CallLogRecord)

Defined in: [WAProto/index.d.ts:2317](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2317)

## Implements[​](#implements "Direct link to Implements")

*   [`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord)

## Constructors[​](#constructors "Direct link to Constructors")

### new CallLogRecord()[​](#new-calllogrecord "Direct link to new CallLogRecord()")

> **new CallLogRecord**(`p`?): [`CallLogRecord`](/docs/api/namespaces/proto/classes/CallLogRecord)

Defined in: [WAProto/index.d.ts:2318](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2318)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord)

#### Returns[​](#returns "Direct link to Returns")

[`CallLogRecord`](/docs/api/namespaces/proto/classes/CallLogRecord)

## Properties[​](#properties "Direct link to Properties")

### callCreatorJid?[​](#callcreatorjid "Direct link to callCreatorJid?")

> `optional` **callCreatorJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:2330](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2330)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord).[`callCreatorJid`](/docs/api/namespaces/proto/interfaces/ICallLogRecord#callcreatorjid)

* * *

### callId?[​](#callid "Direct link to callId?")

> `optional` **callId**: `null` | `string`

Defined in: [WAProto/index.d.ts:2329](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2329)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord).[`callId`](/docs/api/namespaces/proto/interfaces/ICallLogRecord#callid)

* * *

### callLinkToken?[​](#calllinktoken "Direct link to callLinkToken?")

> `optional` **callLinkToken**: `null` | `string`

Defined in: [WAProto/index.d.ts:2327](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2327)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord).[`callLinkToken`](/docs/api/namespaces/proto/interfaces/ICallLogRecord#calllinktoken)

* * *

### callResult?[​](#callresult "Direct link to callResult?")

> `optional` **callResult**: `null` | [`CallResult`](/docs/api/namespaces/proto/namespaces/CallLogRecord/enumerations/CallResult)

Defined in: [WAProto/index.d.ts:2319](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2319)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord).[`callResult`](/docs/api/namespaces/proto/interfaces/ICallLogRecord#callresult)

* * *

### callType?[​](#calltype "Direct link to callType?")

> `optional` **callType**: `null` | [`CallType`](/docs/api/namespaces/proto/namespaces/CallLogRecord/enumerations/CallType)

Defined in: [WAProto/index.d.ts:2333](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2333)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord).[`callType`](/docs/api/namespaces/proto/interfaces/ICallLogRecord#calltype)

* * *

### duration?[​](#duration "Direct link to duration?")

> `optional` **duration**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:2322](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2322)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord).[`duration`](/docs/api/namespaces/proto/interfaces/ICallLogRecord#duration)

* * *

### groupJid?[​](#groupjid "Direct link to groupJid?")

> `optional` **groupJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:2331](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2331)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord).[`groupJid`](/docs/api/namespaces/proto/interfaces/ICallLogRecord#groupjid)

* * *

### isCallLink?[​](#iscalllink "Direct link to isCallLink?")

> `optional` **isCallLink**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2326](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2326)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord).[`isCallLink`](/docs/api/namespaces/proto/interfaces/ICallLogRecord#iscalllink)

* * *

### isDndMode?[​](#isdndmode "Direct link to isDndMode?")

> `optional` **isDndMode**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2320](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2320)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord).[`isDndMode`](/docs/api/namespaces/proto/interfaces/ICallLogRecord#isdndmode)

* * *

### isIncoming?[​](#isincoming "Direct link to isIncoming?")

> `optional` **isIncoming**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2324](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2324)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord).[`isIncoming`](/docs/api/namespaces/proto/interfaces/ICallLogRecord#isincoming)

* * *

### isVideo?[​](#isvideo "Direct link to isVideo?")

> `optional` **isVideo**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2325](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2325)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord).[`isVideo`](/docs/api/namespaces/proto/interfaces/ICallLogRecord#isvideo)

* * *

### participants[​](#participants "Direct link to participants")

> **participants**: [`IParticipantInfo`](/docs/api/namespaces/proto/namespaces/CallLogRecord/interfaces/IParticipantInfo)\[\]

Defined in: [WAProto/index.d.ts:2332](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2332)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord).[`participants`](/docs/api/namespaces/proto/interfaces/ICallLogRecord#participants)

* * *

### scheduledCallId?[​](#scheduledcallid "Direct link to scheduledCallId?")

> `optional` **scheduledCallId**: `null` | `string`

Defined in: [WAProto/index.d.ts:2328](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2328)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord).[`scheduledCallId`](/docs/api/namespaces/proto/interfaces/ICallLogRecord#scheduledcallid)

* * *

### silenceReason?[​](#silencereason "Direct link to silenceReason?")

> `optional` **silenceReason**: `null` | [`SilenceReason`](/docs/api/namespaces/proto/namespaces/CallLogRecord/enumerations/SilenceReason)

Defined in: [WAProto/index.d.ts:2321](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2321)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord).[`silenceReason`](/docs/api/namespaces/proto/interfaces/ICallLogRecord#silencereason)

* * *

### startTime?[​](#starttime "Direct link to startTime?")

> `optional` **startTime**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:2323](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2323)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord).[`startTime`](/docs/api/namespaces/proto/interfaces/ICallLogRecord#starttime)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2339](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2339)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CallLogRecord`](/docs/api/namespaces/proto/classes/CallLogRecord)

Defined in: [WAProto/index.d.ts:2334](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2334)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CallLogRecord`](/docs/api/namespaces/proto/classes/CallLogRecord)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CallLogRecord`](/docs/api/namespaces/proto/classes/CallLogRecord)

Defined in: [WAProto/index.d.ts:2336](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2336)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CallLogRecord`](/docs/api/namespaces/proto/classes/CallLogRecord)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2335](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2335)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CallLogRecord`](/docs/api/namespaces/proto/classes/CallLogRecord)

Defined in: [WAProto/index.d.ts:2337](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2337)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CallLogRecord`](/docs/api/namespaces/proto/classes/CallLogRecord)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2340](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2340)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2338](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2338)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CallLogRecord`](/docs/api/namespaces/proto/classes/CallLogRecord)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-certchain"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/CertChain](https://baileys.wiki/docs/api/namespaces/proto/classes/CertChain)

Defined in: [WAProto/index.d.ts:2396](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2396)

## Implements[​](#implements "Direct link to Implements")

*   [`ICertChain`](/docs/api/namespaces/proto/interfaces/ICertChain)

## Constructors[​](#constructors "Direct link to Constructors")

### new CertChain()[​](#new-certchain "Direct link to new CertChain()")

> **new CertChain**(`p`?): [`CertChain`](/docs/api/namespaces/proto/classes/CertChain)

Defined in: [WAProto/index.d.ts:2397](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2397)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICertChain`](/docs/api/namespaces/proto/interfaces/ICertChain)

#### Returns[​](#returns "Direct link to Returns")

[`CertChain`](/docs/api/namespaces/proto/classes/CertChain)

## Properties[​](#properties "Direct link to Properties")

### intermediate?[​](#intermediate "Direct link to intermediate?")

> `optional` **intermediate**: `null` | [`INoiseCertificate`](/docs/api/namespaces/proto/namespaces/CertChain/interfaces/INoiseCertificate)

Defined in: [WAProto/index.d.ts:2399](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2399)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICertChain`](/docs/api/namespaces/proto/interfaces/ICertChain).[`intermediate`](/docs/api/namespaces/proto/interfaces/ICertChain#intermediate)

* * *

### leaf?[​](#leaf "Direct link to leaf?")

> `optional` **leaf**: `null` | [`INoiseCertificate`](/docs/api/namespaces/proto/namespaces/CertChain/interfaces/INoiseCertificate)

Defined in: [WAProto/index.d.ts:2398](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2398)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ICertChain`](/docs/api/namespaces/proto/interfaces/ICertChain).[`leaf`](/docs/api/namespaces/proto/interfaces/ICertChain#leaf)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2405](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2405)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CertChain`](/docs/api/namespaces/proto/classes/CertChain)

Defined in: [WAProto/index.d.ts:2400](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2400)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICertChain`](/docs/api/namespaces/proto/interfaces/ICertChain)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CertChain`](/docs/api/namespaces/proto/classes/CertChain)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CertChain`](/docs/api/namespaces/proto/classes/CertChain)

Defined in: [WAProto/index.d.ts:2402](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2402)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CertChain`](/docs/api/namespaces/proto/classes/CertChain)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2401](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2401)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICertChain`](/docs/api/namespaces/proto/interfaces/ICertChain)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CertChain`](/docs/api/namespaces/proto/classes/CertChain)

Defined in: [WAProto/index.d.ts:2403](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2403)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CertChain`](/docs/api/namespaces/proto/classes/CertChain)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2406](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2406)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2404](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2404)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CertChain`](/docs/api/namespaces/proto/classes/CertChain)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-chatlocksettings"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/ChatLockSettings](https://baileys.wiki/docs/api/namespaces/proto/classes/ChatLockSettings)

Defined in: [WAProto/index.d.ts:2462](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2462)

## Implements[​](#implements "Direct link to Implements")

*   [`IChatLockSettings`](/docs/api/namespaces/proto/interfaces/IChatLockSettings)

## Constructors[​](#constructors "Direct link to Constructors")

### new ChatLockSettings()[​](#new-chatlocksettings "Direct link to new ChatLockSettings()")

> **new ChatLockSettings**(`p`?): [`ChatLockSettings`](/docs/api/namespaces/proto/classes/ChatLockSettings)

Defined in: [WAProto/index.d.ts:2463](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2463)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IChatLockSettings`](/docs/api/namespaces/proto/interfaces/IChatLockSettings)

#### Returns[​](#returns "Direct link to Returns")

[`ChatLockSettings`](/docs/api/namespaces/proto/classes/ChatLockSettings)

## Properties[​](#properties "Direct link to Properties")

### hideLockedChats?[​](#hidelockedchats "Direct link to hideLockedChats?")

> `optional` **hideLockedChats**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2464](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2464)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IChatLockSettings`](/docs/api/namespaces/proto/interfaces/IChatLockSettings).[`hideLockedChats`](/docs/api/namespaces/proto/interfaces/IChatLockSettings#hidelockedchats)

* * *

### secretCode?[​](#secretcode "Direct link to secretCode?")

> `optional` **secretCode**: `null` | [`IUserPassword`](/docs/api/namespaces/proto/interfaces/IUserPassword)

Defined in: [WAProto/index.d.ts:2465](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2465)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IChatLockSettings`](/docs/api/namespaces/proto/interfaces/IChatLockSettings).[`secretCode`](/docs/api/namespaces/proto/interfaces/IChatLockSettings#secretcode)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2471](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2471)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ChatLockSettings`](/docs/api/namespaces/proto/classes/ChatLockSettings)

Defined in: [WAProto/index.d.ts:2466](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2466)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IChatLockSettings`](/docs/api/namespaces/proto/interfaces/IChatLockSettings)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ChatLockSettings`](/docs/api/namespaces/proto/classes/ChatLockSettings)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ChatLockSettings`](/docs/api/namespaces/proto/classes/ChatLockSettings)

Defined in: [WAProto/index.d.ts:2468](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2468)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ChatLockSettings`](/docs/api/namespaces/proto/classes/ChatLockSettings)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2467](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2467)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IChatLockSettings`](/docs/api/namespaces/proto/interfaces/IChatLockSettings)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ChatLockSettings`](/docs/api/namespaces/proto/classes/ChatLockSettings)

Defined in: [WAProto/index.d.ts:2469](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2469)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ChatLockSettings`](/docs/api/namespaces/proto/classes/ChatLockSettings)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2472](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2472)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2470](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2470)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ChatLockSettings`](/docs/api/namespaces/proto/classes/ChatLockSettings)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-chatrowopaquedata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/ChatRowOpaqueData](https://baileys.wiki/docs/api/namespaces/proto/classes/ChatRowOpaqueData)

Defined in: [WAProto/index.d.ts:2479](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2479)

## Implements[​](#implements "Direct link to Implements")

*   [`IChatRowOpaqueData`](/docs/api/namespaces/proto/interfaces/IChatRowOpaqueData)

## Constructors[​](#constructors "Direct link to Constructors")

### new ChatRowOpaqueData()[​](#new-chatrowopaquedata "Direct link to new ChatRowOpaqueData()")

> **new ChatRowOpaqueData**(`p`?): [`ChatRowOpaqueData`](/docs/api/namespaces/proto/classes/ChatRowOpaqueData)

Defined in: [WAProto/index.d.ts:2480](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2480)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IChatRowOpaqueData`](/docs/api/namespaces/proto/interfaces/IChatRowOpaqueData)

#### Returns[​](#returns "Direct link to Returns")

[`ChatRowOpaqueData`](/docs/api/namespaces/proto/classes/ChatRowOpaqueData)

## Properties[​](#properties "Direct link to Properties")

### draftMessage?[​](#draftmessage "Direct link to draftMessage?")

> `optional` **draftMessage**: `null` | [`IDraftMessage`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/interfaces/IDraftMessage)

Defined in: [WAProto/index.d.ts:2481](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2481)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IChatRowOpaqueData`](/docs/api/namespaces/proto/interfaces/IChatRowOpaqueData).[`draftMessage`](/docs/api/namespaces/proto/interfaces/IChatRowOpaqueData#draftmessage)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2487](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2487)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ChatRowOpaqueData`](/docs/api/namespaces/proto/classes/ChatRowOpaqueData)

Defined in: [WAProto/index.d.ts:2482](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2482)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IChatRowOpaqueData`](/docs/api/namespaces/proto/interfaces/IChatRowOpaqueData)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ChatRowOpaqueData`](/docs/api/namespaces/proto/classes/ChatRowOpaqueData)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ChatRowOpaqueData`](/docs/api/namespaces/proto/classes/ChatRowOpaqueData)

Defined in: [WAProto/index.d.ts:2484](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2484)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ChatRowOpaqueData`](/docs/api/namespaces/proto/classes/ChatRowOpaqueData)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2483](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2483)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IChatRowOpaqueData`](/docs/api/namespaces/proto/interfaces/IChatRowOpaqueData)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ChatRowOpaqueData`](/docs/api/namespaces/proto/classes/ChatRowOpaqueData)

Defined in: [WAProto/index.d.ts:2485](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2485)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ChatRowOpaqueData`](/docs/api/namespaces/proto/classes/ChatRowOpaqueData)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2488](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2488)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2486](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2486)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ChatRowOpaqueData`](/docs/api/namespaces/proto/classes/ChatRowOpaqueData)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-citation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/Citation](https://baileys.wiki/docs/api/namespaces/proto/classes/Citation)

Defined in: [WAProto/index.d.ts:2597](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2597)

## Implements[​](#implements "Direct link to Implements")

*   [`ICitation`](/docs/api/namespaces/proto/interfaces/ICitation)

## Constructors[​](#constructors "Direct link to Constructors")

### new Citation()[​](#new-citation "Direct link to new Citation()")

> **new Citation**(`p`?): [`Citation`](/docs/api/namespaces/proto/classes/Citation)

Defined in: [WAProto/index.d.ts:2598](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2598)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICitation`](/docs/api/namespaces/proto/interfaces/ICitation)

#### Returns[​](#returns "Direct link to Returns")

[`Citation`](/docs/api/namespaces/proto/classes/Citation)

## Properties[​](#properties "Direct link to Properties")

### cmsId[​](#cmsid "Direct link to cmsId")

> **cmsId**: `string`

Defined in: [WAProto/index.d.ts:2601](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2601)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICitation`](/docs/api/namespaces/proto/interfaces/ICitation).[`cmsId`](/docs/api/namespaces/proto/interfaces/ICitation#cmsid)

* * *

### imageUrl[​](#imageurl "Direct link to imageUrl")

> **imageUrl**: `string`

Defined in: [WAProto/index.d.ts:2602](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2602)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ICitation`](/docs/api/namespaces/proto/interfaces/ICitation).[`imageUrl`](/docs/api/namespaces/proto/interfaces/ICitation#imageurl)

* * *

### subtitle[​](#subtitle "Direct link to subtitle")

> **subtitle**: `string`

Defined in: [WAProto/index.d.ts:2600](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2600)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ICitation`](/docs/api/namespaces/proto/interfaces/ICitation).[`subtitle`](/docs/api/namespaces/proto/interfaces/ICitation#subtitle)

* * *

### title[​](#title "Direct link to title")

> **title**: `string`

Defined in: [WAProto/index.d.ts:2599](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2599)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ICitation`](/docs/api/namespaces/proto/interfaces/ICitation).[`title`](/docs/api/namespaces/proto/interfaces/ICitation#title)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2608](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2608)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Citation`](/docs/api/namespaces/proto/classes/Citation)

Defined in: [WAProto/index.d.ts:2603](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2603)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICitation`](/docs/api/namespaces/proto/interfaces/ICitation)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Citation`](/docs/api/namespaces/proto/classes/Citation)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Citation`](/docs/api/namespaces/proto/classes/Citation)

Defined in: [WAProto/index.d.ts:2605](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2605)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Citation`](/docs/api/namespaces/proto/classes/Citation)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2604](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2604)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICitation`](/docs/api/namespaces/proto/interfaces/ICitation)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Citation`](/docs/api/namespaces/proto/classes/Citation)

Defined in: [WAProto/index.d.ts:2606](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2606)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Citation`](/docs/api/namespaces/proto/classes/Citation)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2609](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2609)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2607](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2607)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Citation`](/docs/api/namespaces/proto/classes/Citation)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-clientpairingprops"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/ClientPairingProps](https://baileys.wiki/docs/api/namespaces/proto/classes/ClientPairingProps)

Defined in: [WAProto/index.d.ts:2618](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2618)

## Implements[​](#implements "Direct link to Implements")

*   [`IClientPairingProps`](/docs/api/namespaces/proto/interfaces/IClientPairingProps)

## Constructors[​](#constructors "Direct link to Constructors")

### new ClientPairingProps()[​](#new-clientpairingprops "Direct link to new ClientPairingProps()")

> **new ClientPairingProps**(`p`?): [`ClientPairingProps`](/docs/api/namespaces/proto/classes/ClientPairingProps)

Defined in: [WAProto/index.d.ts:2619](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2619)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IClientPairingProps`](/docs/api/namespaces/proto/interfaces/IClientPairingProps)

#### Returns[​](#returns "Direct link to Returns")

[`ClientPairingProps`](/docs/api/namespaces/proto/classes/ClientPairingProps)

## Properties[​](#properties "Direct link to Properties")

### isChatDbLidMigrated?[​](#ischatdblidmigrated "Direct link to isChatDbLidMigrated?")

> `optional` **isChatDbLidMigrated**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2620](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2620)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IClientPairingProps`](/docs/api/namespaces/proto/interfaces/IClientPairingProps).[`isChatDbLidMigrated`](/docs/api/namespaces/proto/interfaces/IClientPairingProps#ischatdblidmigrated)

* * *

### isSyncdPureLidSession?[​](#issyncdpurelidsession "Direct link to isSyncdPureLidSession?")

> `optional` **isSyncdPureLidSession**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2621](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2621)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IClientPairingProps`](/docs/api/namespaces/proto/interfaces/IClientPairingProps).[`isSyncdPureLidSession`](/docs/api/namespaces/proto/interfaces/IClientPairingProps#issyncdpurelidsession)

* * *

### isSyncdSnapshotRecoveryEnabled?[​](#issyncdsnapshotrecoveryenabled "Direct link to isSyncdSnapshotRecoveryEnabled?")

> `optional` **isSyncdSnapshotRecoveryEnabled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2622](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2622)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IClientPairingProps`](/docs/api/namespaces/proto/interfaces/IClientPairingProps).[`isSyncdSnapshotRecoveryEnabled`](/docs/api/namespaces/proto/interfaces/IClientPairingProps#issyncdsnapshotrecoveryenabled)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2628](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2628)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ClientPairingProps`](/docs/api/namespaces/proto/classes/ClientPairingProps)

Defined in: [WAProto/index.d.ts:2623](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2623)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IClientPairingProps`](/docs/api/namespaces/proto/interfaces/IClientPairingProps)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ClientPairingProps`](/docs/api/namespaces/proto/classes/ClientPairingProps)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ClientPairingProps`](/docs/api/namespaces/proto/classes/ClientPairingProps)

Defined in: [WAProto/index.d.ts:2625](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2625)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ClientPairingProps`](/docs/api/namespaces/proto/classes/ClientPairingProps)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2624](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2624)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IClientPairingProps`](/docs/api/namespaces/proto/interfaces/IClientPairingProps)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ClientPairingProps`](/docs/api/namespaces/proto/classes/ClientPairingProps)

Defined in: [WAProto/index.d.ts:2626](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2626)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ClientPairingProps`](/docs/api/namespaces/proto/classes/ClientPairingProps)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2629](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2629)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2627](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2627)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ClientPairingProps`](/docs/api/namespaces/proto/classes/ClientPairingProps)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-clientpayload"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/ClientPayload](https://baileys.wiki/docs/api/namespaces/proto/classes/ClientPayload)

Defined in: [WAProto/index.d.ts:2669](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2669)

## Implements[​](#implements "Direct link to Implements")

*   [`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload)

## Constructors[​](#constructors "Direct link to Constructors")

### new ClientPayload()[​](#new-clientpayload "Direct link to new ClientPayload()")

> **new ClientPayload**(`p`?): [`ClientPayload`](/docs/api/namespaces/proto/classes/ClientPayload)

Defined in: [WAProto/index.d.ts:2670](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2670)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload)

#### Returns[​](#returns "Direct link to Returns")

[`ClientPayload`](/docs/api/namespaces/proto/classes/ClientPayload)

## Properties[​](#properties "Direct link to Properties")

### accountType?[​](#accounttype "Direct link to accountType?")

> `optional` **accountType**: `null` | [`AccountType`](/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/AccountType)

Defined in: [WAProto/index.d.ts:2700](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2700)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`accountType`](/docs/api/namespaces/proto/interfaces/IClientPayload#accounttype)

* * *

### connectAttemptCount?[​](#connectattemptcount "Direct link to connectAttemptCount?")

> `optional` **connectAttemptCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:2682](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2682)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`connectAttemptCount`](/docs/api/namespaces/proto/interfaces/IClientPayload#connectattemptcount)

* * *

### connectionSequenceInfo?[​](#connectionsequenceinfo "Direct link to connectionSequenceInfo?")

> `optional` **connectionSequenceInfo**: `null` | `number`

Defined in: [WAProto/index.d.ts:2701](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2701)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`connectionSequenceInfo`](/docs/api/namespaces/proto/interfaces/IClientPayload#connectionsequenceinfo)

* * *

### connectReason?[​](#connectreason "Direct link to connectReason?")

> `optional` **connectReason**: `null` | [`ConnectReason`](/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/ConnectReason)

Defined in: [WAProto/index.d.ts:2679](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2679)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`connectReason`](/docs/api/namespaces/proto/interfaces/IClientPayload#connectreason)

* * *

### connectType?[​](#connecttype "Direct link to connectType?")

> `optional` **connectType**: `null` | [`ConnectType`](/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/ConnectType)

Defined in: [WAProto/index.d.ts:2678](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2678)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`connectType`](/docs/api/namespaces/proto/interfaces/IClientPayload#connecttype)

* * *

### device?[​](#device "Direct link to device?")

> `optional` **device**: `null` | `number`

Defined in: [WAProto/index.d.ts:2683](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2683)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`device`](/docs/api/namespaces/proto/interfaces/IClientPayload#device)

* * *

### devicePairingData?[​](#devicepairingdata "Direct link to devicePairingData?")

> `optional` **devicePairingData**: `null` | [`IDevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData)

Defined in: [WAProto/index.d.ts:2684](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2684)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`devicePairingData`](/docs/api/namespaces/proto/interfaces/IClientPayload#devicepairingdata)

* * *

### dnsSource?[​](#dnssource "Direct link to dnsSource?")

> `optional` **dnsSource**: `null` | [`IDNSSource`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDNSSource)

Defined in: [WAProto/index.d.ts:2681](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2681)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`dnsSource`](/docs/api/namespaces/proto/interfaces/IClientPayload#dnssource)

* * *

### fbAppId?[​](#fbappid "Direct link to fbAppId?")

> `optional` **fbAppId**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:2691](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2691)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`fbAppId`](/docs/api/namespaces/proto/interfaces/IClientPayload#fbappid)

* * *

### fbCat?[​](#fbcat "Direct link to fbCat?")

> `optional` **fbCat**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2686](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2686)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`fbCat`](/docs/api/namespaces/proto/interfaces/IClientPayload#fbcat)

* * *

### fbDeviceId?[​](#fbdeviceid "Direct link to fbDeviceId?")

> `optional` **fbDeviceId**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2692](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2692)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`fbDeviceId`](/docs/api/namespaces/proto/interfaces/IClientPayload#fbdeviceid)

* * *

### fbUserAgent?[​](#fbuseragent "Direct link to fbUserAgent?")

> `optional` **fbUserAgent**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2687](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2687)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`fbUserAgent`](/docs/api/namespaces/proto/interfaces/IClientPayload#fbuseragent)

* * *

### interopData?[​](#interopdata "Direct link to interopData?")

> `optional` **interopData**: `null` | [`IInteropData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IInteropData)

Defined in: [WAProto/index.d.ts:2697](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2697)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`interopData`](/docs/api/namespaces/proto/interfaces/IClientPayload#interopdata)

* * *

### iosAppExtension?[​](#iosappextension "Direct link to iosAppExtension?")

> `optional` **iosAppExtension**: `null` | [`IOSAppExtension`](/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/IOSAppExtension)

Defined in: [WAProto/index.d.ts:2690](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2690)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`iosAppExtension`](/docs/api/namespaces/proto/interfaces/IClientPayload#iosappextension)

* * *

### lc?[​](#lc "Direct link to lc?")

> `optional` **lc**: `null` | `number`

Defined in: [WAProto/index.d.ts:2689](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2689)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`lc`](/docs/api/namespaces/proto/interfaces/IClientPayload#lc)

* * *

### lidDbMigrated?[​](#liddbmigrated "Direct link to lidDbMigrated?")

> `optional` **lidDbMigrated**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2699](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2699)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`lidDbMigrated`](/docs/api/namespaces/proto/interfaces/IClientPayload#liddbmigrated)

* * *

### memClass?[​](#memclass "Direct link to memClass?")

> `optional` **memClass**: `null` | `number`

Defined in: [WAProto/index.d.ts:2696](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2696)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`memClass`](/docs/api/namespaces/proto/interfaces/IClientPayload#memclass)

* * *

### oc?[​](#oc "Direct link to oc?")

> `optional` **oc**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2688](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2688)

#### Implementation of[​](#implementation-of-17 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`oc`](/docs/api/namespaces/proto/interfaces/IClientPayload#oc)

* * *

### paaLink?[​](#paalink "Direct link to paaLink?")

> `optional` **paaLink**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2702](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2702)

#### Implementation of[​](#implementation-of-18 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`paaLink`](/docs/api/namespaces/proto/interfaces/IClientPayload#paalink)

* * *

### paddingBytes?[​](#paddingbytes "Direct link to paddingBytes?")

> `optional` **paddingBytes**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2694](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2694)

#### Implementation of[​](#implementation-of-19 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`paddingBytes`](/docs/api/namespaces/proto/interfaces/IClientPayload#paddingbytes)

* * *

### passive?[​](#passive "Direct link to passive?")

> `optional` **passive**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2672](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2672)

#### Implementation of[​](#implementation-of-20 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`passive`](/docs/api/namespaces/proto/interfaces/IClientPayload#passive)

* * *

### preacksCount?[​](#preackscount "Direct link to preacksCount?")

> `optional` **preacksCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:2703](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2703)

#### Implementation of[​](#implementation-of-21 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`preacksCount`](/docs/api/namespaces/proto/interfaces/IClientPayload#preackscount)

* * *

### processingQueueSize?[​](#processingqueuesize "Direct link to processingQueueSize?")

> `optional` **processingQueueSize**: `null` | `number`

Defined in: [WAProto/index.d.ts:2704](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2704)

#### Implementation of[​](#implementation-of-22 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`processingQueueSize`](/docs/api/namespaces/proto/interfaces/IClientPayload#processingqueuesize)

* * *

### product?[​](#product "Direct link to product?")

> `optional` **product**: `null` | [`Product`](/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/Product)

Defined in: [WAProto/index.d.ts:2685](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2685)

#### Implementation of[​](#implementation-of-23 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`product`](/docs/api/namespaces/proto/interfaces/IClientPayload#product)

* * *

### pull?[​](#pull "Direct link to pull?")

> `optional` **pull**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2693](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2693)

#### Implementation of[​](#implementation-of-24 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`pull`](/docs/api/namespaces/proto/interfaces/IClientPayload#pull)

* * *

### pushName?[​](#pushname "Direct link to pushName?")

> `optional` **pushName**: `null` | `string`

Defined in: [WAProto/index.d.ts:2675](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2675)

#### Implementation of[​](#implementation-of-25 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`pushName`](/docs/api/namespaces/proto/interfaces/IClientPayload#pushname)

* * *

### sessionId?[​](#sessionid "Direct link to sessionId?")

> `optional` **sessionId**: `null` | `number`

Defined in: [WAProto/index.d.ts:2676](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2676)

#### Implementation of[​](#implementation-of-26 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`sessionId`](/docs/api/namespaces/proto/interfaces/IClientPayload#sessionid)

* * *

### shards[​](#shards "Direct link to shards")

> **shards**: `number`\[\]

Defined in: [WAProto/index.d.ts:2680](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2680)

#### Implementation of[​](#implementation-of-27 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`shards`](/docs/api/namespaces/proto/interfaces/IClientPayload#shards)

* * *

### shortConnect?[​](#shortconnect "Direct link to shortConnect?")

> `optional` **shortConnect**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2677](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2677)

#### Implementation of[​](#implementation-of-28 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`shortConnect`](/docs/api/namespaces/proto/interfaces/IClientPayload#shortconnect)

* * *

### trafficAnonymization?[​](#trafficanonymization "Direct link to trafficAnonymization?")

> `optional` **trafficAnonymization**: `null` | [`TrafficAnonymization`](/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/TrafficAnonymization)

Defined in: [WAProto/index.d.ts:2698](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2698)

#### Implementation of[​](#implementation-of-29 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`trafficAnonymization`](/docs/api/namespaces/proto/interfaces/IClientPayload#trafficanonymization)

* * *

### userAgent?[​](#useragent "Direct link to userAgent?")

> `optional` **userAgent**: `null` | [`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent)

Defined in: [WAProto/index.d.ts:2673](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2673)

#### Implementation of[​](#implementation-of-30 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`userAgent`](/docs/api/namespaces/proto/interfaces/IClientPayload#useragent)

* * *

### username?[​](#username "Direct link to username?")

> `optional` **username**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:2671](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2671)

#### Implementation of[​](#implementation-of-31 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`username`](/docs/api/namespaces/proto/interfaces/IClientPayload#username)

* * *

### webInfo?[​](#webinfo "Direct link to webInfo?")

> `optional` **webInfo**: `null` | [`IWebInfo`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IWebInfo)

Defined in: [WAProto/index.d.ts:2674](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2674)

#### Implementation of[​](#implementation-of-32 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`webInfo`](/docs/api/namespaces/proto/interfaces/IClientPayload#webinfo)

* * *

### yearClass?[​](#yearclass "Direct link to yearClass?")

> `optional` **yearClass**: `null` | `number`

Defined in: [WAProto/index.d.ts:2695](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2695)

#### Implementation of[​](#implementation-of-33 "Direct link to Implementation of")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload).[`yearClass`](/docs/api/namespaces/proto/interfaces/IClientPayload#yearclass)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2710](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2710)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ClientPayload`](/docs/api/namespaces/proto/classes/ClientPayload)

Defined in: [WAProto/index.d.ts:2705](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2705)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ClientPayload`](/docs/api/namespaces/proto/classes/ClientPayload)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ClientPayload`](/docs/api/namespaces/proto/classes/ClientPayload)

Defined in: [WAProto/index.d.ts:2707](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2707)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ClientPayload`](/docs/api/namespaces/proto/classes/ClientPayload)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2706](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2706)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IClientPayload`](/docs/api/namespaces/proto/interfaces/IClientPayload)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ClientPayload`](/docs/api/namespaces/proto/classes/ClientPayload)

Defined in: [WAProto/index.d.ts:2708](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2708)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ClientPayload`](/docs/api/namespaces/proto/classes/ClientPayload)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2711](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2711)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2709](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2709)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ClientPayload`](/docs/api/namespaces/proto/classes/ClientPayload)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-commentmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/CommentMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/CommentMetadata)

Defined in: [WAProto/index.d.ts:3062](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3062)

## Implements[​](#implements "Direct link to Implements")

*   [`ICommentMetadata`](/docs/api/namespaces/proto/interfaces/ICommentMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new CommentMetadata()[​](#new-commentmetadata "Direct link to new CommentMetadata()")

> **new CommentMetadata**(`p`?): [`CommentMetadata`](/docs/api/namespaces/proto/classes/CommentMetadata)

Defined in: [WAProto/index.d.ts:3063](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3063)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICommentMetadata`](/docs/api/namespaces/proto/interfaces/ICommentMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`CommentMetadata`](/docs/api/namespaces/proto/classes/CommentMetadata)

## Properties[​](#properties "Direct link to Properties")

### commentParentKey?[​](#commentparentkey "Direct link to commentParentKey?")

> `optional` **commentParentKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:3064](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3064)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICommentMetadata`](/docs/api/namespaces/proto/interfaces/ICommentMetadata).[`commentParentKey`](/docs/api/namespaces/proto/interfaces/ICommentMetadata#commentparentkey)

* * *

### replyCount?[​](#replycount "Direct link to replyCount?")

> `optional` **replyCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:3065](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3065)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ICommentMetadata`](/docs/api/namespaces/proto/interfaces/ICommentMetadata).[`replyCount`](/docs/api/namespaces/proto/interfaces/ICommentMetadata#replycount)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3071](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3071)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CommentMetadata`](/docs/api/namespaces/proto/classes/CommentMetadata)

Defined in: [WAProto/index.d.ts:3066](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3066)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICommentMetadata`](/docs/api/namespaces/proto/interfaces/ICommentMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CommentMetadata`](/docs/api/namespaces/proto/classes/CommentMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CommentMetadata`](/docs/api/namespaces/proto/classes/CommentMetadata)

Defined in: [WAProto/index.d.ts:3068](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3068)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CommentMetadata`](/docs/api/namespaces/proto/classes/CommentMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3067](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3067)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICommentMetadata`](/docs/api/namespaces/proto/interfaces/ICommentMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CommentMetadata`](/docs/api/namespaces/proto/classes/CommentMetadata)

Defined in: [WAProto/index.d.ts:3069](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3069)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CommentMetadata`](/docs/api/namespaces/proto/classes/CommentMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3072](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3072)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3070](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3070)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CommentMetadata`](/docs/api/namespaces/proto/classes/CommentMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-companioncommitment"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/CompanionCommitment](https://baileys.wiki/docs/api/namespaces/proto/classes/CompanionCommitment)

Defined in: [WAProto/index.d.ts:3079](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3079)

## Implements[​](#implements "Direct link to Implements")

*   [`ICompanionCommitment`](/docs/api/namespaces/proto/interfaces/ICompanionCommitment)

## Constructors[​](#constructors "Direct link to Constructors")

### new CompanionCommitment()[​](#new-companioncommitment "Direct link to new CompanionCommitment()")

> **new CompanionCommitment**(`p`?): [`CompanionCommitment`](/docs/api/namespaces/proto/classes/CompanionCommitment)

Defined in: [WAProto/index.d.ts:3080](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3080)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICompanionCommitment`](/docs/api/namespaces/proto/interfaces/ICompanionCommitment)

#### Returns[​](#returns "Direct link to Returns")

[`CompanionCommitment`](/docs/api/namespaces/proto/classes/CompanionCommitment)

## Properties[​](#properties "Direct link to Properties")

### hash?[​](#hash "Direct link to hash?")

> `optional` **hash**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3081](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3081)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICompanionCommitment`](/docs/api/namespaces/proto/interfaces/ICompanionCommitment).[`hash`](/docs/api/namespaces/proto/interfaces/ICompanionCommitment#hash)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3087](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3087)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CompanionCommitment`](/docs/api/namespaces/proto/classes/CompanionCommitment)

Defined in: [WAProto/index.d.ts:3082](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3082)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICompanionCommitment`](/docs/api/namespaces/proto/interfaces/ICompanionCommitment)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CompanionCommitment`](/docs/api/namespaces/proto/classes/CompanionCommitment)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CompanionCommitment`](/docs/api/namespaces/proto/classes/CompanionCommitment)

Defined in: [WAProto/index.d.ts:3084](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3084)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CompanionCommitment`](/docs/api/namespaces/proto/classes/CompanionCommitment)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3083](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3083)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICompanionCommitment`](/docs/api/namespaces/proto/interfaces/ICompanionCommitment)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CompanionCommitment`](/docs/api/namespaces/proto/classes/CompanionCommitment)

Defined in: [WAProto/index.d.ts:3085](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3085)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CompanionCommitment`](/docs/api/namespaces/proto/classes/CompanionCommitment)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3088](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3088)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3086](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3086)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CompanionCommitment`](/docs/api/namespaces/proto/classes/CompanionCommitment)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-companionephemeralidentity"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/CompanionEphemeralIdentity](https://baileys.wiki/docs/api/namespaces/proto/classes/CompanionEphemeralIdentity)

Defined in: [WAProto/index.d.ts:3097](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3097)

## Implements[​](#implements "Direct link to Implements")

*   [`ICompanionEphemeralIdentity`](/docs/api/namespaces/proto/interfaces/ICompanionEphemeralIdentity)

## Constructors[​](#constructors "Direct link to Constructors")

### new CompanionEphemeralIdentity()[​](#new-companionephemeralidentity "Direct link to new CompanionEphemeralIdentity()")

> **new CompanionEphemeralIdentity**(`p`?): [`CompanionEphemeralIdentity`](/docs/api/namespaces/proto/classes/CompanionEphemeralIdentity)

Defined in: [WAProto/index.d.ts:3098](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3098)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICompanionEphemeralIdentity`](/docs/api/namespaces/proto/interfaces/ICompanionEphemeralIdentity)

#### Returns[​](#returns "Direct link to Returns")

[`CompanionEphemeralIdentity`](/docs/api/namespaces/proto/classes/CompanionEphemeralIdentity)

## Properties[​](#properties "Direct link to Properties")

### deviceType?[​](#devicetype "Direct link to deviceType?")

> `optional` **deviceType**: `null` | [`PlatformType`](/docs/api/namespaces/proto/namespaces/DeviceProps/enumerations/PlatformType)

Defined in: [WAProto/index.d.ts:3100](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3100)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICompanionEphemeralIdentity`](/docs/api/namespaces/proto/interfaces/ICompanionEphemeralIdentity).[`deviceType`](/docs/api/namespaces/proto/interfaces/ICompanionEphemeralIdentity#devicetype)

* * *

### publicKey?[​](#publickey "Direct link to publicKey?")

> `optional` **publicKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3099](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3099)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ICompanionEphemeralIdentity`](/docs/api/namespaces/proto/interfaces/ICompanionEphemeralIdentity).[`publicKey`](/docs/api/namespaces/proto/interfaces/ICompanionEphemeralIdentity#publickey)

* * *

### ref?[​](#ref "Direct link to ref?")

> `optional` **ref**: `null` | `string`

Defined in: [WAProto/index.d.ts:3101](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3101)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ICompanionEphemeralIdentity`](/docs/api/namespaces/proto/interfaces/ICompanionEphemeralIdentity).[`ref`](/docs/api/namespaces/proto/interfaces/ICompanionEphemeralIdentity#ref)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3107](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3107)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CompanionEphemeralIdentity`](/docs/api/namespaces/proto/classes/CompanionEphemeralIdentity)

Defined in: [WAProto/index.d.ts:3102](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3102)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICompanionEphemeralIdentity`](/docs/api/namespaces/proto/interfaces/ICompanionEphemeralIdentity)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CompanionEphemeralIdentity`](/docs/api/namespaces/proto/classes/CompanionEphemeralIdentity)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CompanionEphemeralIdentity`](/docs/api/namespaces/proto/classes/CompanionEphemeralIdentity)

Defined in: [WAProto/index.d.ts:3104](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3104)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CompanionEphemeralIdentity`](/docs/api/namespaces/proto/classes/CompanionEphemeralIdentity)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3103](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3103)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICompanionEphemeralIdentity`](/docs/api/namespaces/proto/interfaces/ICompanionEphemeralIdentity)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CompanionEphemeralIdentity`](/docs/api/namespaces/proto/classes/CompanionEphemeralIdentity)

Defined in: [WAProto/index.d.ts:3105](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3105)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CompanionEphemeralIdentity`](/docs/api/namespaces/proto/classes/CompanionEphemeralIdentity)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3108](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3108)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3106](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3106)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CompanionEphemeralIdentity`](/docs/api/namespaces/proto/classes/CompanionEphemeralIdentity)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-config"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/Config](https://baileys.wiki/docs/api/namespaces/proto/classes/Config)

Defined in: [WAProto/index.d.ts:3116](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3116)

## Implements[​](#implements "Direct link to Implements")

*   [`IConfig`](/docs/api/namespaces/proto/interfaces/IConfig)

## Constructors[​](#constructors "Direct link to Constructors")

### new Config()[​](#new-config "Direct link to new Config()")

> **new Config**(`p`?): [`Config`](/docs/api/namespaces/proto/classes/Config)

Defined in: [WAProto/index.d.ts:3117](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3117)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IConfig`](/docs/api/namespaces/proto/interfaces/IConfig)

#### Returns[​](#returns "Direct link to Returns")

[`Config`](/docs/api/namespaces/proto/classes/Config)

## Properties[​](#properties "Direct link to Properties")

### field[​](#field "Direct link to field")

> **field**: `object`

Defined in: [WAProto/index.d.ts:3118](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3118)

#### Index Signature[​](#index-signature "Direct link to Index Signature")

\[`k`: `string`\]: [`IField`](/docs/api/namespaces/proto/interfaces/IField)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IConfig`](/docs/api/namespaces/proto/interfaces/IConfig).[`field`](/docs/api/namespaces/proto/interfaces/IConfig#field)

* * *

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | `number`

Defined in: [WAProto/index.d.ts:3119](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3119)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IConfig`](/docs/api/namespaces/proto/interfaces/IConfig).[`version`](/docs/api/namespaces/proto/interfaces/IConfig#version)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3125](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3125)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Config`](/docs/api/namespaces/proto/classes/Config)

Defined in: [WAProto/index.d.ts:3120](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3120)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IConfig`](/docs/api/namespaces/proto/interfaces/IConfig)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Config`](/docs/api/namespaces/proto/classes/Config)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Config`](/docs/api/namespaces/proto/classes/Config)

Defined in: [WAProto/index.d.ts:3122](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3122)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Config`](/docs/api/namespaces/proto/classes/Config)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3121](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3121)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IConfig`](/docs/api/namespaces/proto/interfaces/IConfig)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Config`](/docs/api/namespaces/proto/classes/Config)

Defined in: [WAProto/index.d.ts:3123](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3123)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Config`](/docs/api/namespaces/proto/classes/Config)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3126](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3126)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3124](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3124)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Config`](/docs/api/namespaces/proto/classes/Config)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-contextinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/ContextInfo](https://baileys.wiki/docs/api/namespaces/proto/classes/ContextInfo)

Defined in: [WAProto/index.d.ts:3187](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3187)

## Implements[​](#implements "Direct link to Implements")

*   [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new ContextInfo()[​](#new-contextinfo "Direct link to new ContextInfo()")

> **new ContextInfo**(`p`?): [`ContextInfo`](/docs/api/namespaces/proto/classes/ContextInfo)

Defined in: [WAProto/index.d.ts:3188](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3188)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

#### Returns[​](#returns "Direct link to Returns")

[`ContextInfo`](/docs/api/namespaces/proto/classes/ContextInfo)

## Properties[​](#properties "Direct link to Properties")

### actionLink?[​](#actionlink "Direct link to actionLink?")

> `optional` **actionLink**: `null` | [`IActionLink`](/docs/api/namespaces/proto/interfaces/IActionLink)

Defined in: [WAProto/index.d.ts:3209](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3209)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`actionLink`](/docs/api/namespaces/proto/interfaces/IContextInfo#actionlink)

* * *

### alwaysShowAdAttribution?[​](#alwaysshowadattribution "Direct link to alwaysShowAdAttribution?")

> `optional` **alwaysShowAdAttribution**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3222](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3222)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`alwaysShowAdAttribution`](/docs/api/namespaces/proto/interfaces/IContextInfo#alwaysshowadattribution)

* * *

### botMessageSharingInfo?[​](#botmessagesharinginfo "Direct link to botMessageSharingInfo?")

> `optional` **botMessageSharingInfo**: `null` | [`IBotMessageSharingInfo`](/docs/api/namespaces/proto/interfaces/IBotMessageSharingInfo)

Defined in: [WAProto/index.d.ts:3243](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3243)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`botMessageSharingInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo#botmessagesharinginfo)

* * *

### businessMessageForwardInfo?[​](#businessmessageforwardinfo "Direct link to businessMessageForwardInfo?")

> `optional` **businessMessageForwardInfo**: `null` | [`IBusinessMessageForwardInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IBusinessMessageForwardInfo)

Defined in: [WAProto/index.d.ts:3218](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3218)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`businessMessageForwardInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo#businessmessageforwardinfo)

* * *

### conversionData?[​](#conversiondata "Direct link to conversionData?")

> `optional` **conversionData**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3195](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3195)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`conversionData`](/docs/api/namespaces/proto/interfaces/IContextInfo#conversiondata)

* * *

### conversionDelaySeconds?[​](#conversiondelayseconds "Direct link to conversionDelaySeconds?")

> `optional` **conversionDelaySeconds**: `null` | `number`

Defined in: [WAProto/index.d.ts:3196](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3196)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`conversionDelaySeconds`](/docs/api/namespaces/proto/interfaces/IContextInfo#conversiondelayseconds)

* * *

### conversionSource?[​](#conversionsource "Direct link to conversionSource?")

> `optional` **conversionSource**: `null` | `string`

Defined in: [WAProto/index.d.ts:3194](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3194)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`conversionSource`](/docs/api/namespaces/proto/interfaces/IContextInfo#conversionsource)

* * *

### ctwaPayload?[​](#ctwapayload "Direct link to ctwaPayload?")

> `optional` **ctwaPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3227](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3227)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`ctwaPayload`](/docs/api/namespaces/proto/interfaces/IContextInfo#ctwapayload)

* * *

### ctwaSignals?[​](#ctwasignals "Direct link to ctwaSignals?")

> `optional` **ctwaSignals**: `null` | `string`

Defined in: [WAProto/index.d.ts:3226](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3226)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`ctwaSignals`](/docs/api/namespaces/proto/interfaces/IContextInfo#ctwasignals)

* * *

### dataSharingContext?[​](#datasharingcontext "Direct link to dataSharingContext?")

> `optional` **dataSharingContext**: `null` | [`IDataSharingContext`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IDataSharingContext)

Defined in: [WAProto/index.d.ts:3221](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3221)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`dataSharingContext`](/docs/api/namespaces/proto/interfaces/IContextInfo#datasharingcontext)

* * *

### disappearingMode?[​](#disappearingmode "Direct link to disappearingMode?")

> `optional` **disappearingMode**: `null` | [`IDisappearingMode`](/docs/api/namespaces/proto/interfaces/IDisappearingMode)

Defined in: [WAProto/index.d.ts:3208](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3208)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`disappearingMode`](/docs/api/namespaces/proto/interfaces/IContextInfo#disappearingmode)

* * *

### entryPointConversionApp?[​](#entrypointconversionapp "Direct link to entryPointConversionApp?")

> `optional` **entryPointConversionApp**: `null` | `string`

Defined in: [WAProto/index.d.ts:3206](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3206)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`entryPointConversionApp`](/docs/api/namespaces/proto/interfaces/IContextInfo#entrypointconversionapp)

* * *

### entryPointConversionDelaySeconds?[​](#entrypointconversiondelayseconds "Direct link to entryPointConversionDelaySeconds?")

> `optional` **entryPointConversionDelaySeconds**: `null` | `number`

Defined in: [WAProto/index.d.ts:3207](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3207)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`entryPointConversionDelaySeconds`](/docs/api/namespaces/proto/interfaces/IContextInfo#entrypointconversiondelayseconds)

* * *

### entryPointConversionExternalMedium?[​](#entrypointconversionexternalmedium "Direct link to entryPointConversionExternalMedium?")

> `optional` **entryPointConversionExternalMedium**: `null` | `string`

Defined in: [WAProto/index.d.ts:3225](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3225)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`entryPointConversionExternalMedium`](/docs/api/namespaces/proto/interfaces/IContextInfo#entrypointconversionexternalmedium)

* * *

### entryPointConversionExternalSource?[​](#entrypointconversionexternalsource "Direct link to entryPointConversionExternalSource?")

> `optional` **entryPointConversionExternalSource**: `null` | `string`

Defined in: [WAProto/index.d.ts:3224](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3224)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`entryPointConversionExternalSource`](/docs/api/namespaces/proto/interfaces/IContextInfo#entrypointconversionexternalsource)

* * *

### entryPointConversionSource?[​](#entrypointconversionsource "Direct link to entryPointConversionSource?")

> `optional` **entryPointConversionSource**: `null` | `string`

Defined in: [WAProto/index.d.ts:3205](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3205)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`entryPointConversionSource`](/docs/api/namespaces/proto/interfaces/IContextInfo#entrypointconversionsource)

* * *

### ephemeralSettingTimestamp?[​](#ephemeralsettingtimestamp "Direct link to ephemeralSettingTimestamp?")

> `optional` **ephemeralSettingTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3202](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3202)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`ephemeralSettingTimestamp`](/docs/api/namespaces/proto/interfaces/IContextInfo#ephemeralsettingtimestamp)

* * *

### ephemeralSharedSecret?[​](#ephemeralsharedsecret "Direct link to ephemeralSharedSecret?")

> `optional` **ephemeralSharedSecret**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3203](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3203)

#### Implementation of[​](#implementation-of-17 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`ephemeralSharedSecret`](/docs/api/namespaces/proto/interfaces/IContextInfo#ephemeralsharedsecret)

* * *

### expiration?[​](#expiration "Direct link to expiration?")

> `optional` **expiration**: `null` | `number`

Defined in: [WAProto/index.d.ts:3201](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3201)

#### Implementation of[​](#implementation-of-18 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`expiration`](/docs/api/namespaces/proto/interfaces/IContextInfo#expiration)

* * *

### externalAdReply?[​](#externaladreply "Direct link to externalAdReply?")

> `optional` **externalAdReply**: `null` | [`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo)

Defined in: [WAProto/index.d.ts:3204](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3204)

#### Implementation of[​](#implementation-of-19 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`externalAdReply`](/docs/api/namespaces/proto/interfaces/IContextInfo#externaladreply)

* * *

### featureEligibilities?[​](#featureeligibilities "Direct link to featureEligibilities?")

> `optional` **featureEligibilities**: `null` | [`IFeatureEligibilities`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IFeatureEligibilities)

Defined in: [WAProto/index.d.ts:3223](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3223)

#### Implementation of[​](#implementation-of-20 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`featureEligibilities`](/docs/api/namespaces/proto/interfaces/IContextInfo#featureeligibilities)

* * *

### forwardedAiBotMessageInfo?[​](#forwardedaibotmessageinfo "Direct link to forwardedAiBotMessageInfo?")

> `optional` **forwardedAiBotMessageInfo**: `null` | [`IForwardedAIBotMessageInfo`](/docs/api/namespaces/proto/interfaces/IForwardedAIBotMessageInfo)

Defined in: [WAProto/index.d.ts:3228](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3228)

#### Implementation of[​](#implementation-of-21 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`forwardedAiBotMessageInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo#forwardedaibotmessageinfo)

* * *

### forwardedNewsletterMessageInfo?[​](#forwardednewslettermessageinfo "Direct link to forwardedNewsletterMessageInfo?")

> `optional` **forwardedNewsletterMessageInfo**: `null` | [`IForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo)

Defined in: [WAProto/index.d.ts:3217](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3217)

#### Implementation of[​](#implementation-of-22 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`forwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo#forwardednewslettermessageinfo)

* * *

### forwardingScore?[​](#forwardingscore "Direct link to forwardingScore?")

> `optional` **forwardingScore**: `null` | `number`

Defined in: [WAProto/index.d.ts:3197](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3197)

#### Implementation of[​](#implementation-of-23 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`forwardingScore`](/docs/api/namespaces/proto/interfaces/IContextInfo#forwardingscore)

* * *

### forwardOrigin?[​](#forwardorigin "Direct link to forwardOrigin?")

> `optional` **forwardOrigin**: `null` | [`ForwardOrigin`](/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/ForwardOrigin)

Defined in: [WAProto/index.d.ts:3238](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3238)

#### Implementation of[​](#implementation-of-24 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`forwardOrigin`](/docs/api/namespaces/proto/interfaces/IContextInfo#forwardorigin)

* * *

### groupMentions[​](#groupmentions "Direct link to groupMentions")

> **groupMentions**: [`IGroupMention`](/docs/api/namespaces/proto/interfaces/IGroupMention)\[\]

Defined in: [WAProto/index.d.ts:3215](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3215)

#### Implementation of[​](#implementation-of-25 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`groupMentions`](/docs/api/namespaces/proto/interfaces/IContextInfo#groupmentions)

* * *

### groupSubject?[​](#groupsubject "Direct link to groupSubject?")

> `optional` **groupSubject**: `null` | `string`

Defined in: [WAProto/index.d.ts:3210](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3210)

#### Implementation of[​](#implementation-of-26 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`groupSubject`](/docs/api/namespaces/proto/interfaces/IContextInfo#groupsubject)

* * *

### isForwarded?[​](#isforwarded "Direct link to isForwarded?")

> `optional` **isForwarded**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3198](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3198)

#### Implementation of[​](#implementation-of-27 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`isForwarded`](/docs/api/namespaces/proto/interfaces/IContextInfo#isforwarded)

* * *

### isGroupStatus?[​](#isgroupstatus "Direct link to isGroupStatus?")

> `optional` **isGroupStatus**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3237](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3237)

#### Implementation of[​](#implementation-of-28 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`isGroupStatus`](/docs/api/namespaces/proto/interfaces/IContextInfo#isgroupstatus)

* * *

### isQuestion?[​](#isquestion "Direct link to isQuestion?")

> `optional` **isQuestion**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3234](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3234)

#### Implementation of[​](#implementation-of-29 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`isQuestion`](/docs/api/namespaces/proto/interfaces/IContextInfo#isquestion)

* * *

### isSampled?[​](#issampled "Direct link to isSampled?")

> `optional` **isSampled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3214](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3214)

#### Implementation of[​](#implementation-of-30 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`isSampled`](/docs/api/namespaces/proto/interfaces/IContextInfo#issampled)

* * *

### memberLabel?[​](#memberlabel "Direct link to memberLabel?")

> `optional` **memberLabel**: `null` | [`IMemberLabel`](/docs/api/namespaces/proto/interfaces/IMemberLabel)

Defined in: [WAProto/index.d.ts:3233](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3233)

#### Implementation of[​](#implementation-of-31 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`memberLabel`](/docs/api/namespaces/proto/interfaces/IContextInfo#memberlabel)

* * *

### mentionedJid[​](#mentionedjid "Direct link to mentionedJid")

> **mentionedJid**: `string`\[\]

Defined in: [WAProto/index.d.ts:3193](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3193)

#### Implementation of[​](#implementation-of-32 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`mentionedJid`](/docs/api/namespaces/proto/interfaces/IContextInfo#mentionedjid)

* * *

### nonJidMentions?[​](#nonjidmentions "Direct link to nonJidMentions?")

> `optional` **nonJidMentions**: `null` | `number`

Defined in: [WAProto/index.d.ts:3241](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3241)

#### Implementation of[​](#implementation-of-33 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`nonJidMentions`](/docs/api/namespaces/proto/interfaces/IContextInfo#nonjidmentions)

* * *

### pairedMediaType?[​](#pairedmediatype "Direct link to pairedMediaType?")

> `optional` **pairedMediaType**: `null` | [`PairedMediaType`](/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/PairedMediaType)

Defined in: [WAProto/index.d.ts:3231](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3231)

#### Implementation of[​](#implementation-of-34 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`pairedMediaType`](/docs/api/namespaces/proto/interfaces/IContextInfo#pairedmediatype)

* * *

### parentGroupJid?[​](#parentgroupjid "Direct link to parentGroupJid?")

> `optional` **parentGroupJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:3211](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3211)

#### Implementation of[​](#implementation-of-35 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`parentGroupJid`](/docs/api/namespaces/proto/interfaces/IContextInfo#parentgroupjid)

* * *

### participant?[​](#participant "Direct link to participant?")

> `optional` **participant**: `null` | `string`

Defined in: [WAProto/index.d.ts:3190](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3190)

#### Implementation of[​](#implementation-of-36 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`participant`](/docs/api/namespaces/proto/interfaces/IContextInfo#participant)

* * *

### placeholderKey?[​](#placeholderkey "Direct link to placeholderKey?")

> `optional` **placeholderKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:3200](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3200)

#### Implementation of[​](#implementation-of-37 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`placeholderKey`](/docs/api/namespaces/proto/interfaces/IContextInfo#placeholderkey)

* * *

### questionReplyQuotedMessage?[​](#questionreplyquotedmessage "Direct link to questionReplyQuotedMessage?")

> `optional` **questionReplyQuotedMessage**: `null` | [`IQuestionReplyQuotedMessage`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IQuestionReplyQuotedMessage)

Defined in: [WAProto/index.d.ts:3239](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3239)

#### Implementation of[​](#implementation-of-38 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`questionReplyQuotedMessage`](/docs/api/namespaces/proto/interfaces/IContextInfo#questionreplyquotedmessage)

* * *

### quotedAd?[​](#quotedad "Direct link to quotedAd?")

> `optional` **quotedAd**: `null` | [`IAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IAdReplyInfo)

Defined in: [WAProto/index.d.ts:3199](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3199)

#### Implementation of[​](#implementation-of-39 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`quotedAd`](/docs/api/namespaces/proto/interfaces/IContextInfo#quotedad)

* * *

### quotedMessage?[​](#quotedmessage "Direct link to quotedMessage?")

> `optional` **quotedMessage**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:3191](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3191)

#### Implementation of[​](#implementation-of-40 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`quotedMessage`](/docs/api/namespaces/proto/interfaces/IContextInfo#quotedmessage)

* * *

### quotedType?[​](#quotedtype "Direct link to quotedType?")

> `optional` **quotedType**: `null` | [`QuotedType`](/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/QuotedType)

Defined in: [WAProto/index.d.ts:3242](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3242)

#### Implementation of[​](#implementation-of-41 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`quotedType`](/docs/api/namespaces/proto/interfaces/IContextInfo#quotedtype)

* * *

### rankingVersion?[​](#rankingversion "Direct link to rankingVersion?")

> `optional` **rankingVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:3232](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3232)

#### Implementation of[​](#implementation-of-42 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`rankingVersion`](/docs/api/namespaces/proto/interfaces/IContextInfo#rankingversion)

* * *

### remoteJid?[​](#remotejid "Direct link to remoteJid?")

> `optional` **remoteJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:3192](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3192)

#### Implementation of[​](#implementation-of-43 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`remoteJid`](/docs/api/namespaces/proto/interfaces/IContextInfo#remotejid)

* * *

### smbClientCampaignId?[​](#smbclientcampaignid "Direct link to smbClientCampaignId?")

> `optional` **smbClientCampaignId**: `null` | `string`

Defined in: [WAProto/index.d.ts:3219](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3219)

#### Implementation of[​](#implementation-of-44 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`smbClientCampaignId`](/docs/api/namespaces/proto/interfaces/IContextInfo#smbclientcampaignid)

* * *

### smbServerCampaignId?[​](#smbservercampaignid "Direct link to smbServerCampaignId?")

> `optional` **smbServerCampaignId**: `null` | `string`

Defined in: [WAProto/index.d.ts:3220](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3220)

#### Implementation of[​](#implementation-of-45 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`smbServerCampaignId`](/docs/api/namespaces/proto/interfaces/IContextInfo#smbservercampaignid)

* * *

### stanzaId?[​](#stanzaid "Direct link to stanzaId?")

> `optional` **stanzaId**: `null` | `string`

Defined in: [WAProto/index.d.ts:3189](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3189)

#### Implementation of[​](#implementation-of-46 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`stanzaId`](/docs/api/namespaces/proto/interfaces/IContextInfo#stanzaid)

* * *

### statusAttributions[​](#statusattributions "Direct link to statusAttributions")

> **statusAttributions**: [`IStatusAttribution`](/docs/api/namespaces/proto/interfaces/IStatusAttribution)\[\]

Defined in: [WAProto/index.d.ts:3236](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3236)

#### Implementation of[​](#implementation-of-47 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`statusAttributions`](/docs/api/namespaces/proto/interfaces/IContextInfo#statusattributions)

* * *

### statusAttributionType?[​](#statusattributiontype "Direct link to statusAttributionType?")

> `optional` **statusAttributionType**: `null` | [`StatusAttributionType`](/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/StatusAttributionType)

Defined in: [WAProto/index.d.ts:3229](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3229)

#### Implementation of[​](#implementation-of-48 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`statusAttributionType`](/docs/api/namespaces/proto/interfaces/IContextInfo#statusattributiontype)

* * *

### statusAudienceMetadata?[​](#statusaudiencemetadata "Direct link to statusAudienceMetadata?")

> `optional` **statusAudienceMetadata**: `null` | [`IStatusAudienceMetadata`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IStatusAudienceMetadata)

Defined in: [WAProto/index.d.ts:3240](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3240)

#### Implementation of[​](#implementation-of-49 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`statusAudienceMetadata`](/docs/api/namespaces/proto/interfaces/IContextInfo#statusaudiencemetadata)

* * *

### statusSourceType?[​](#statussourcetype "Direct link to statusSourceType?")

> `optional` **statusSourceType**: `null` | [`StatusSourceType`](/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/StatusSourceType)

Defined in: [WAProto/index.d.ts:3235](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3235)

#### Implementation of[​](#implementation-of-50 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`statusSourceType`](/docs/api/namespaces/proto/interfaces/IContextInfo#statussourcetype)

* * *

### trustBannerAction?[​](#trustbanneraction "Direct link to trustBannerAction?")

> `optional` **trustBannerAction**: `null` | `number`

Defined in: [WAProto/index.d.ts:3213](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3213)

#### Implementation of[​](#implementation-of-51 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`trustBannerAction`](/docs/api/namespaces/proto/interfaces/IContextInfo#trustbanneraction)

* * *

### trustBannerType?[​](#trustbannertype "Direct link to trustBannerType?")

> `optional` **trustBannerType**: `null` | `string`

Defined in: [WAProto/index.d.ts:3212](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3212)

#### Implementation of[​](#implementation-of-52 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`trustBannerType`](/docs/api/namespaces/proto/interfaces/IContextInfo#trustbannertype)

* * *

### urlTrackingMap?[​](#urltrackingmap "Direct link to urlTrackingMap?")

> `optional` **urlTrackingMap**: `null` | [`IUrlTrackingMap`](/docs/api/namespaces/proto/interfaces/IUrlTrackingMap)

Defined in: [WAProto/index.d.ts:3230](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3230)

#### Implementation of[​](#implementation-of-53 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`urlTrackingMap`](/docs/api/namespaces/proto/interfaces/IContextInfo#urltrackingmap)

* * *

### utm?[​](#utm "Direct link to utm?")

> `optional` **utm**: `null` | [`IUTMInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IUTMInfo)

Defined in: [WAProto/index.d.ts:3216](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3216)

#### Implementation of[​](#implementation-of-54 "Direct link to Implementation of")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo).[`utm`](/docs/api/namespaces/proto/interfaces/IContextInfo#utm)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3249](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3249)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ContextInfo`](/docs/api/namespaces/proto/classes/ContextInfo)

Defined in: [WAProto/index.d.ts:3244](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3244)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ContextInfo`](/docs/api/namespaces/proto/classes/ContextInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ContextInfo`](/docs/api/namespaces/proto/classes/ContextInfo)

Defined in: [WAProto/index.d.ts:3246](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3246)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ContextInfo`](/docs/api/namespaces/proto/classes/ContextInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3245](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3245)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ContextInfo`](/docs/api/namespaces/proto/classes/ContextInfo)

Defined in: [WAProto/index.d.ts:3247](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3247)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ContextInfo`](/docs/api/namespaces/proto/classes/ContextInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3250](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3250)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3248](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3248)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ContextInfo`](/docs/api/namespaces/proto/classes/ContextInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-conversation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/Conversation](https://baileys.wiki/docs/api/namespaces/proto/classes/Conversation)

Defined in: [WAProto/index.d.ts:3658](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3658)

## Implements[​](#implements "Direct link to Implements")

*   [`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation)

## Constructors[​](#constructors "Direct link to Constructors")

### new Conversation()[​](#new-conversation "Direct link to new Conversation()")

> **new Conversation**(`p`?): [`Conversation`](/docs/api/namespaces/proto/classes/Conversation)

Defined in: [WAProto/index.d.ts:3659](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3659)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation)

#### Returns[​](#returns "Direct link to Returns")

[`Conversation`](/docs/api/namespaces/proto/classes/Conversation)

## Properties[​](#properties "Direct link to Properties")

### accountLid?[​](#accountlid "Direct link to accountLid?")

> `optional` **accountLid**: `null` | `string`

Defined in: [WAProto/index.d.ts:3708](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3708)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`accountLid`](/docs/api/namespaces/proto/interfaces/IConversation#accountlid)

* * *

### archived?[​](#archived "Direct link to archived?")

> `optional` **archived**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3675](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3675)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`archived`](/docs/api/namespaces/proto/interfaces/IConversation#archived)

* * *

### capiCreatedGroup?[​](#capicreatedgroup "Direct link to capiCreatedGroup?")

> `optional` **capiCreatedGroup**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3707](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3707)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`capiCreatedGroup`](/docs/api/namespaces/proto/interfaces/IConversation#capicreatedgroup)

* * *

### commentsCount?[​](#commentscount "Direct link to commentsCount?")

> `optional` **commentsCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:3704](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3704)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`commentsCount`](/docs/api/namespaces/proto/interfaces/IConversation#commentscount)

* * *

### contactPrimaryIdentityKey?[​](#contactprimaryidentitykey "Direct link to contactPrimaryIdentityKey?")

> `optional` **contactPrimaryIdentityKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3682](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3682)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`contactPrimaryIdentityKey`](/docs/api/namespaces/proto/interfaces/IConversation#contactprimaryidentitykey)

* * *

### conversationTimestamp?[​](#conversationtimestamp "Direct link to conversationTimestamp?")

> `optional` **conversationTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3671](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3671)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`conversationTimestamp`](/docs/api/namespaces/proto/interfaces/IConversation#conversationtimestamp)

* * *

### createdAt?[​](#createdat "Direct link to createdAt?")

> `optional` **createdAt**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3690](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3690)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`createdAt`](/docs/api/namespaces/proto/interfaces/IConversation#createdat)

* * *

### createdBy?[​](#createdby "Direct link to createdBy?")

> `optional` **createdBy**: `null` | `string`

Defined in: [WAProto/index.d.ts:3691](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3691)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`createdBy`](/docs/api/namespaces/proto/interfaces/IConversation#createdby)

* * *

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:3692](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3692)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`description`](/docs/api/namespaces/proto/interfaces/IConversation#description)

* * *

### disappearingMode?[​](#disappearingmode "Direct link to disappearingMode?")

> `optional` **disappearingMode**: `null` | [`IDisappearingMode`](/docs/api/namespaces/proto/interfaces/IDisappearingMode)

Defined in: [WAProto/index.d.ts:3676](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3676)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`disappearingMode`](/docs/api/namespaces/proto/interfaces/IConversation#disappearingmode)

* * *

### displayName?[​](#displayname "Direct link to displayName?")

> `optional` **displayName**: `null` | `string`

Defined in: [WAProto/index.d.ts:3697](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3697)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`displayName`](/docs/api/namespaces/proto/interfaces/IConversation#displayname)

* * *

### endOfHistoryTransfer?[​](#endofhistorytransfer "Direct link to endOfHistoryTransfer?")

> `optional` **endOfHistoryTransfer**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3667](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3667)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`endOfHistoryTransfer`](/docs/api/namespaces/proto/interfaces/IConversation#endofhistorytransfer)

* * *

### endOfHistoryTransferType?[​](#endofhistorytransfertype "Direct link to endOfHistoryTransferType?")

> `optional` **endOfHistoryTransferType**: `null` | [`EndOfHistoryTransferType`](/docs/api/namespaces/proto/namespaces/Conversation/enumerations/EndOfHistoryTransferType)

Defined in: [WAProto/index.d.ts:3670](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3670)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`endOfHistoryTransferType`](/docs/api/namespaces/proto/interfaces/IConversation#endofhistorytransfertype)

* * *

### ephemeralExpiration?[​](#ephemeralexpiration "Direct link to ephemeralExpiration?")

> `optional` **ephemeralExpiration**: `null` | `number`

Defined in: [WAProto/index.d.ts:3668](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3668)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`ephemeralExpiration`](/docs/api/namespaces/proto/interfaces/IConversation#ephemeralexpiration)

* * *

### ephemeralSettingTimestamp?[​](#ephemeralsettingtimestamp "Direct link to ephemeralSettingTimestamp?")

> `optional` **ephemeralSettingTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3669](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3669)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`ephemeralSettingTimestamp`](/docs/api/namespaces/proto/interfaces/IConversation#ephemeralsettingtimestamp)

* * *

### id[​](#id "Direct link to id")

> **id**: `string`

Defined in: [WAProto/index.d.ts:3660](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3660)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`id`](/docs/api/namespaces/proto/interfaces/IConversation#id)

* * *

### isDefaultSubgroup?[​](#isdefaultsubgroup "Direct link to isDefaultSubgroup?")

> `optional` **isDefaultSubgroup**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3696](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3696)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`isDefaultSubgroup`](/docs/api/namespaces/proto/interfaces/IConversation#isdefaultsubgroup)

* * *

### isParentGroup?[​](#isparentgroup "Direct link to isParentGroup?")

> `optional` **isParentGroup**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3694](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3694)

#### Implementation of[​](#implementation-of-17 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`isParentGroup`](/docs/api/namespaces/proto/interfaces/IConversation#isparentgroup)

* * *

### lastMsgTimestamp?[​](#lastmsgtimestamp "Direct link to lastMsgTimestamp?")

> `optional` **lastMsgTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3664](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3664)

#### Implementation of[​](#implementation-of-18 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`lastMsgTimestamp`](/docs/api/namespaces/proto/interfaces/IConversation#lastmsgtimestamp)

* * *

### lidJid?[​](#lidjid "Direct link to lidJid?")

> `optional` **lidJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:3701](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3701)

#### Implementation of[​](#implementation-of-19 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`lidJid`](/docs/api/namespaces/proto/interfaces/IConversation#lidjid)

* * *

### lidOriginType?[​](#lidorigintype "Direct link to lidOriginType?")

> `optional` **lidOriginType**: `null` | `string`

Defined in: [WAProto/index.d.ts:3703](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3703)

#### Implementation of[​](#implementation-of-20 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`lidOriginType`](/docs/api/namespaces/proto/interfaces/IConversation#lidorigintype)

* * *

### limitSharing?[​](#limitsharing "Direct link to limitSharing?")

> `optional` **limitSharing**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3709](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3709)

#### Implementation of[​](#implementation-of-21 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`limitSharing`](/docs/api/namespaces/proto/interfaces/IConversation#limitsharing)

* * *

### limitSharingInitiatedByMe?[​](#limitsharinginitiatedbyme "Direct link to limitSharingInitiatedByMe?")

> `optional` **limitSharingInitiatedByMe**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3712](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3712)

#### Implementation of[​](#implementation-of-22 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`limitSharingInitiatedByMe`](/docs/api/namespaces/proto/interfaces/IConversation#limitsharinginitiatedbyme)

* * *

### limitSharingSettingTimestamp?[​](#limitsharingsettingtimestamp "Direct link to limitSharingSettingTimestamp?")

> `optional` **limitSharingSettingTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3710](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3710)

#### Implementation of[​](#implementation-of-23 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`limitSharingSettingTimestamp`](/docs/api/namespaces/proto/interfaces/IConversation#limitsharingsettingtimestamp)

* * *

### limitSharingTrigger?[​](#limitsharingtrigger "Direct link to limitSharingTrigger?")

> `optional` **limitSharingTrigger**: `null` | [`TriggerType`](/docs/api/namespaces/proto/namespaces/LimitSharing/enumerations/TriggerType)

Defined in: [WAProto/index.d.ts:3711](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3711)

#### Implementation of[​](#implementation-of-24 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`limitSharingTrigger`](/docs/api/namespaces/proto/interfaces/IConversation#limitsharingtrigger)

* * *

### locked?[​](#locked "Direct link to locked?")

> `optional` **locked**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3705](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3705)

#### Implementation of[​](#implementation-of-25 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`locked`](/docs/api/namespaces/proto/interfaces/IConversation#locked)

* * *

### maibaAiThreadEnabled?[​](#maibaaithreadenabled "Direct link to maibaAiThreadEnabled?")

> `optional` **maibaAiThreadEnabled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3713](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3713)

#### Implementation of[​](#implementation-of-26 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`maibaAiThreadEnabled`](/docs/api/namespaces/proto/interfaces/IConversation#maibaaithreadenabled)

* * *

### markedAsUnread?[​](#markedasunread "Direct link to markedAsUnread?")

> `optional` **markedAsUnread**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3678](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3678)

#### Implementation of[​](#implementation-of-27 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`markedAsUnread`](/docs/api/namespaces/proto/interfaces/IConversation#markedasunread)

* * *

### mediaVisibility?[​](#mediavisibility "Direct link to mediaVisibility?")

> `optional` **mediaVisibility**: `null` | [`MediaVisibility`](/docs/api/namespaces/proto/enumerations/MediaVisibility)

Defined in: [WAProto/index.d.ts:3686](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3686)

#### Implementation of[​](#implementation-of-28 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`mediaVisibility`](/docs/api/namespaces/proto/interfaces/IConversation#mediavisibility)

* * *

### messages[​](#messages "Direct link to messages")

> **messages**: [`IHistorySyncMsg`](/docs/api/namespaces/proto/interfaces/IHistorySyncMsg)\[\]

Defined in: [WAProto/index.d.ts:3661](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3661)

#### Implementation of[​](#implementation-of-29 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`messages`](/docs/api/namespaces/proto/interfaces/IConversation#messages)

* * *

### muteEndTime?[​](#muteendtime "Direct link to muteEndTime?")

> `optional` **muteEndTime**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3684](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3684)

#### Implementation of[​](#implementation-of-30 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`muteEndTime`](/docs/api/namespaces/proto/interfaces/IConversation#muteendtime)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:3672](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3672)

#### Implementation of[​](#implementation-of-31 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`name`](/docs/api/namespaces/proto/interfaces/IConversation#name)

* * *

### newJid?[​](#newjid "Direct link to newJid?")

> `optional` **newJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:3662](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3662)

#### Implementation of[​](#implementation-of-32 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`newJid`](/docs/api/namespaces/proto/interfaces/IConversation#newjid)

* * *

### notSpam?[​](#notspam "Direct link to notSpam?")

> `optional` **notSpam**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3674](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3674)

#### Implementation of[​](#implementation-of-33 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`notSpam`](/docs/api/namespaces/proto/interfaces/IConversation#notspam)

* * *

### oldJid?[​](#oldjid "Direct link to oldJid?")

> `optional` **oldJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:3663](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3663)

#### Implementation of[​](#implementation-of-34 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`oldJid`](/docs/api/namespaces/proto/interfaces/IConversation#oldjid)

* * *

### parentGroupId?[​](#parentgroupid "Direct link to parentGroupId?")

> `optional` **parentGroupId**: `null` | `string`

Defined in: [WAProto/index.d.ts:3695](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3695)

#### Implementation of[​](#implementation-of-35 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`parentGroupId`](/docs/api/namespaces/proto/interfaces/IConversation#parentgroupid)

* * *

### participant[​](#participant "Direct link to participant")

> **participant**: [`IGroupParticipant`](/docs/api/namespaces/proto/interfaces/IGroupParticipant)\[\]

Defined in: [WAProto/index.d.ts:3679](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3679)

#### Implementation of[​](#implementation-of-36 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`participant`](/docs/api/namespaces/proto/interfaces/IConversation#participant)

* * *

### pHash?[​](#phash "Direct link to pHash?")

> `optional` **pHash**: `null` | `string`

Defined in: [WAProto/index.d.ts:3673](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3673)

#### Implementation of[​](#implementation-of-37 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`pHash`](/docs/api/namespaces/proto/interfaces/IConversation#phash)

* * *

### pinned?[​](#pinned "Direct link to pinned?")

> `optional` **pinned**: `null` | `number`

Defined in: [WAProto/index.d.ts:3683](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3683)

#### Implementation of[​](#implementation-of-38 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`pinned`](/docs/api/namespaces/proto/interfaces/IConversation#pinned)

* * *

### pnhDuplicateLidThread?[​](#pnhduplicatelidthread "Direct link to pnhDuplicateLidThread?")

> `optional` **pnhDuplicateLidThread**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3700](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3700)

#### Implementation of[​](#implementation-of-39 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`pnhDuplicateLidThread`](/docs/api/namespaces/proto/interfaces/IConversation#pnhduplicatelidthread)

* * *

### pnJid?[​](#pnjid "Direct link to pnJid?")

> `optional` **pnJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:3698](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3698)

#### Implementation of[​](#implementation-of-40 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`pnJid`](/docs/api/namespaces/proto/interfaces/IConversation#pnjid)

* * *

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3666](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3666)

#### Implementation of[​](#implementation-of-41 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`readOnly`](/docs/api/namespaces/proto/interfaces/IConversation#readonly)

* * *

### shareOwnPn?[​](#shareownpn "Direct link to shareOwnPn?")

> `optional` **shareOwnPn**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3699](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3699)

#### Implementation of[​](#implementation-of-42 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`shareOwnPn`](/docs/api/namespaces/proto/interfaces/IConversation#shareownpn)

* * *

### support?[​](#support "Direct link to support?")

> `optional` **support**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3693](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3693)

#### Implementation of[​](#implementation-of-43 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`support`](/docs/api/namespaces/proto/interfaces/IConversation#support)

* * *

### suspended?[​](#suspended "Direct link to suspended?")

> `optional` **suspended**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3688](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3688)

#### Implementation of[​](#implementation-of-44 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`suspended`](/docs/api/namespaces/proto/interfaces/IConversation#suspended)

* * *

### systemMessageToInsert?[​](#systemmessagetoinsert "Direct link to systemMessageToInsert?")

> `optional` **systemMessageToInsert**: `null` | [`PrivacySystemMessage`](/docs/api/namespaces/proto/enumerations/PrivacySystemMessage)

Defined in: [WAProto/index.d.ts:3706](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3706)

#### Implementation of[​](#implementation-of-45 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`systemMessageToInsert`](/docs/api/namespaces/proto/interfaces/IConversation#systemmessagetoinsert)

* * *

### tcToken?[​](#tctoken "Direct link to tcToken?")

> `optional` **tcToken**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3680](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3680)

#### Implementation of[​](#implementation-of-46 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`tcToken`](/docs/api/namespaces/proto/interfaces/IConversation#tctoken)

* * *

### tcTokenSenderTimestamp?[​](#tctokensendertimestamp "Direct link to tcTokenSenderTimestamp?")

> `optional` **tcTokenSenderTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3687](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3687)

#### Implementation of[​](#implementation-of-47 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`tcTokenSenderTimestamp`](/docs/api/namespaces/proto/interfaces/IConversation#tctokensendertimestamp)

* * *

### tcTokenTimestamp?[​](#tctokentimestamp "Direct link to tcTokenTimestamp?")

> `optional` **tcTokenTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3681](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3681)

#### Implementation of[​](#implementation-of-48 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`tcTokenTimestamp`](/docs/api/namespaces/proto/interfaces/IConversation#tctokentimestamp)

* * *

### terminated?[​](#terminated "Direct link to terminated?")

> `optional` **terminated**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3689](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3689)

#### Implementation of[​](#implementation-of-49 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`terminated`](/docs/api/namespaces/proto/interfaces/IConversation#terminated)

* * *

### unreadCount?[​](#unreadcount "Direct link to unreadCount?")

> `optional` **unreadCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:3665](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3665)

#### Implementation of[​](#implementation-of-50 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`unreadCount`](/docs/api/namespaces/proto/interfaces/IConversation#unreadcount)

* * *

### unreadMentionCount?[​](#unreadmentioncount "Direct link to unreadMentionCount?")

> `optional` **unreadMentionCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:3677](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3677)

#### Implementation of[​](#implementation-of-51 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`unreadMentionCount`](/docs/api/namespaces/proto/interfaces/IConversation#unreadmentioncount)

* * *

### username?[​](#username "Direct link to username?")

> `optional` **username**: `null` | `string`

Defined in: [WAProto/index.d.ts:3702](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3702)

#### Implementation of[​](#implementation-of-52 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`username`](/docs/api/namespaces/proto/interfaces/IConversation#username)

* * *

### wallpaper?[​](#wallpaper "Direct link to wallpaper?")

> `optional` **wallpaper**: `null` | [`IWallpaperSettings`](/docs/api/namespaces/proto/interfaces/IWallpaperSettings)

Defined in: [WAProto/index.d.ts:3685](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3685)

#### Implementation of[​](#implementation-of-53 "Direct link to Implementation of")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation).[`wallpaper`](/docs/api/namespaces/proto/interfaces/IConversation#wallpaper)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3719](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3719)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Conversation`](/docs/api/namespaces/proto/classes/Conversation)

Defined in: [WAProto/index.d.ts:3714](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3714)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Conversation`](/docs/api/namespaces/proto/classes/Conversation)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Conversation`](/docs/api/namespaces/proto/classes/Conversation)

Defined in: [WAProto/index.d.ts:3716](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3716)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Conversation`](/docs/api/namespaces/proto/classes/Conversation)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3715](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3715)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Conversation`](/docs/api/namespaces/proto/classes/Conversation)

Defined in: [WAProto/index.d.ts:3717](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3717)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Conversation`](/docs/api/namespaces/proto/classes/Conversation)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3720](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3720)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3718](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3718)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Conversation`](/docs/api/namespaces/proto/classes/Conversation)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-devicecapabilities"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/DeviceCapabilities](https://baileys.wiki/docs/api/namespaces/proto/classes/DeviceCapabilities)

Defined in: [WAProto/index.d.ts:3740](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3740)

## Implements[​](#implements "Direct link to Implements")

*   [`IDeviceCapabilities`](/docs/api/namespaces/proto/interfaces/IDeviceCapabilities)

## Constructors[​](#constructors "Direct link to Constructors")

### new DeviceCapabilities()[​](#new-devicecapabilities "Direct link to new DeviceCapabilities()")

> **new DeviceCapabilities**(`p`?): [`DeviceCapabilities`](/docs/api/namespaces/proto/classes/DeviceCapabilities)

Defined in: [WAProto/index.d.ts:3741](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3741)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IDeviceCapabilities`](/docs/api/namespaces/proto/interfaces/IDeviceCapabilities)

#### Returns[​](#returns "Direct link to Returns")

[`DeviceCapabilities`](/docs/api/namespaces/proto/classes/DeviceCapabilities)

## Properties[​](#properties "Direct link to Properties")

### businessBroadcast?[​](#businessbroadcast "Direct link to businessBroadcast?")

> `optional` **businessBroadcast**: `null` | [`IBusinessBroadcast`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IBusinessBroadcast)

Defined in: [WAProto/index.d.ts:3744](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3744)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IDeviceCapabilities`](/docs/api/namespaces/proto/interfaces/IDeviceCapabilities).[`businessBroadcast`](/docs/api/namespaces/proto/interfaces/IDeviceCapabilities#businessbroadcast)

* * *

### chatLockSupportLevel?[​](#chatlocksupportlevel "Direct link to chatLockSupportLevel?")

> `optional` **chatLockSupportLevel**: `null` | [`ChatLockSupportLevel`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/enumerations/ChatLockSupportLevel)

Defined in: [WAProto/index.d.ts:3742](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3742)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IDeviceCapabilities`](/docs/api/namespaces/proto/interfaces/IDeviceCapabilities).[`chatLockSupportLevel`](/docs/api/namespaces/proto/interfaces/IDeviceCapabilities#chatlocksupportlevel)

* * *

### lidMigration?[​](#lidmigration "Direct link to lidMigration?")

> `optional` **lidMigration**: `null` | [`ILIDMigration`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/ILIDMigration)

Defined in: [WAProto/index.d.ts:3743](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3743)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IDeviceCapabilities`](/docs/api/namespaces/proto/interfaces/IDeviceCapabilities).[`lidMigration`](/docs/api/namespaces/proto/interfaces/IDeviceCapabilities#lidmigration)

* * *

### memberNameTagPrimarySupport?[​](#membernametagprimarysupport "Direct link to memberNameTagPrimarySupport?")

> `optional` **memberNameTagPrimarySupport**: `null` | [`MemberNameTagPrimarySupport`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/enumerations/MemberNameTagPrimarySupport)

Defined in: [WAProto/index.d.ts:3746](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3746)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IDeviceCapabilities`](/docs/api/namespaces/proto/interfaces/IDeviceCapabilities).[`memberNameTagPrimarySupport`](/docs/api/namespaces/proto/interfaces/IDeviceCapabilities#membernametagprimarysupport)

* * *

### userHasAvatar?[​](#userhasavatar "Direct link to userHasAvatar?")

> `optional` **userHasAvatar**: `null` | [`IUserHasAvatar`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IUserHasAvatar)

Defined in: [WAProto/index.d.ts:3745](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3745)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IDeviceCapabilities`](/docs/api/namespaces/proto/interfaces/IDeviceCapabilities).[`userHasAvatar`](/docs/api/namespaces/proto/interfaces/IDeviceCapabilities#userhasavatar)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3752](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3752)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`DeviceCapabilities`](/docs/api/namespaces/proto/classes/DeviceCapabilities)

Defined in: [WAProto/index.d.ts:3747](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3747)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IDeviceCapabilities`](/docs/api/namespaces/proto/interfaces/IDeviceCapabilities)

#### Returns[​](#returns-2 "Direct link to Returns")

[`DeviceCapabilities`](/docs/api/namespaces/proto/classes/DeviceCapabilities)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`DeviceCapabilities`](/docs/api/namespaces/proto/classes/DeviceCapabilities)

Defined in: [WAProto/index.d.ts:3749](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3749)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`DeviceCapabilities`](/docs/api/namespaces/proto/classes/DeviceCapabilities)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3748](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3748)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IDeviceCapabilities`](/docs/api/namespaces/proto/interfaces/IDeviceCapabilities)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`DeviceCapabilities`](/docs/api/namespaces/proto/classes/DeviceCapabilities)

Defined in: [WAProto/index.d.ts:3750](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3750)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`DeviceCapabilities`](/docs/api/namespaces/proto/classes/DeviceCapabilities)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3753](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3753)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3751](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3751)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`DeviceCapabilities`](/docs/api/namespaces/proto/classes/DeviceCapabilities)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-deviceconsistencycodemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/DeviceConsistencyCodeMessage](https://baileys.wiki/docs/api/namespaces/proto/classes/DeviceConsistencyCodeMessage)

Defined in: [WAProto/index.d.ts:3824](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3824)

## Implements[​](#implements "Direct link to Implements")

*   [`IDeviceConsistencyCodeMessage`](/docs/api/namespaces/proto/interfaces/IDeviceConsistencyCodeMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new DeviceConsistencyCodeMessage()[​](#new-deviceconsistencycodemessage "Direct link to new DeviceConsistencyCodeMessage()")

> **new DeviceConsistencyCodeMessage**(`p`?): [`DeviceConsistencyCodeMessage`](/docs/api/namespaces/proto/classes/DeviceConsistencyCodeMessage)

Defined in: [WAProto/index.d.ts:3825](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3825)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IDeviceConsistencyCodeMessage`](/docs/api/namespaces/proto/interfaces/IDeviceConsistencyCodeMessage)

#### Returns[​](#returns "Direct link to Returns")

[`DeviceConsistencyCodeMessage`](/docs/api/namespaces/proto/classes/DeviceConsistencyCodeMessage)

## Properties[​](#properties "Direct link to Properties")

### generation?[​](#generation "Direct link to generation?")

> `optional` **generation**: `null` | `number`

Defined in: [WAProto/index.d.ts:3826](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3826)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IDeviceConsistencyCodeMessage`](/docs/api/namespaces/proto/interfaces/IDeviceConsistencyCodeMessage).[`generation`](/docs/api/namespaces/proto/interfaces/IDeviceConsistencyCodeMessage#generation)

* * *

### signature?[​](#signature "Direct link to signature?")

> `optional` **signature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3827](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3827)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IDeviceConsistencyCodeMessage`](/docs/api/namespaces/proto/interfaces/IDeviceConsistencyCodeMessage).[`signature`](/docs/api/namespaces/proto/interfaces/IDeviceConsistencyCodeMessage#signature)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3833](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3833)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`DeviceConsistencyCodeMessage`](/docs/api/namespaces/proto/classes/DeviceConsistencyCodeMessage)

Defined in: [WAProto/index.d.ts:3828](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3828)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IDeviceConsistencyCodeMessage`](/docs/api/namespaces/proto/interfaces/IDeviceConsistencyCodeMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`DeviceConsistencyCodeMessage`](/docs/api/namespaces/proto/classes/DeviceConsistencyCodeMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`DeviceConsistencyCodeMessage`](/docs/api/namespaces/proto/classes/DeviceConsistencyCodeMessage)

Defined in: [WAProto/index.d.ts:3830](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3830)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`DeviceConsistencyCodeMessage`](/docs/api/namespaces/proto/classes/DeviceConsistencyCodeMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3829](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3829)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IDeviceConsistencyCodeMessage`](/docs/api/namespaces/proto/interfaces/IDeviceConsistencyCodeMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`DeviceConsistencyCodeMessage`](/docs/api/namespaces/proto/classes/DeviceConsistencyCodeMessage)

Defined in: [WAProto/index.d.ts:3831](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3831)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`DeviceConsistencyCodeMessage`](/docs/api/namespaces/proto/classes/DeviceConsistencyCodeMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3834](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3834)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3832](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3832)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`DeviceConsistencyCodeMessage`](/docs/api/namespaces/proto/classes/DeviceConsistencyCodeMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-devicelistmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/DeviceListMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/DeviceListMetadata)

Defined in: [WAProto/index.d.ts:3848](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3848)

## Implements[​](#implements "Direct link to Implements")

*   [`IDeviceListMetadata`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new DeviceListMetadata()[​](#new-devicelistmetadata "Direct link to new DeviceListMetadata()")

> **new DeviceListMetadata**(`p`?): [`DeviceListMetadata`](/docs/api/namespaces/proto/classes/DeviceListMetadata)

Defined in: [WAProto/index.d.ts:3849](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3849)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IDeviceListMetadata`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`DeviceListMetadata`](/docs/api/namespaces/proto/classes/DeviceListMetadata)

## Properties[​](#properties "Direct link to Properties")

### receiverAccountType?[​](#receiveraccounttype "Direct link to receiverAccountType?")

> `optional` **receiverAccountType**: `null` | [`ADVEncryptionType`](/docs/api/namespaces/proto/enumerations/ADVEncryptionType)

Defined in: [WAProto/index.d.ts:3854](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3854)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IDeviceListMetadata`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata).[`receiverAccountType`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata#receiveraccounttype)

* * *

### recipientKeyHash?[​](#recipientkeyhash "Direct link to recipientKeyHash?")

> `optional` **recipientKeyHash**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3855](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3855)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IDeviceListMetadata`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata).[`recipientKeyHash`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata#recipientkeyhash)

* * *

### recipientKeyIndexes[​](#recipientkeyindexes "Direct link to recipientKeyIndexes")

> **recipientKeyIndexes**: `number`\[\]

Defined in: [WAProto/index.d.ts:3857](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3857)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IDeviceListMetadata`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata).[`recipientKeyIndexes`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata#recipientkeyindexes)

* * *

### recipientTimestamp?[​](#recipienttimestamp "Direct link to recipientTimestamp?")

> `optional` **recipientTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3856](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3856)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IDeviceListMetadata`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata).[`recipientTimestamp`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata#recipienttimestamp)

* * *

### senderAccountType?[​](#senderaccounttype "Direct link to senderAccountType?")

> `optional` **senderAccountType**: `null` | [`ADVEncryptionType`](/docs/api/namespaces/proto/enumerations/ADVEncryptionType)

Defined in: [WAProto/index.d.ts:3853](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3853)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IDeviceListMetadata`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata).[`senderAccountType`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata#senderaccounttype)

* * *

### senderKeyHash?[​](#senderkeyhash "Direct link to senderKeyHash?")

> `optional` **senderKeyHash**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3850](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3850)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IDeviceListMetadata`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata).[`senderKeyHash`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata#senderkeyhash)

* * *

### senderKeyIndexes[​](#senderkeyindexes "Direct link to senderKeyIndexes")

> **senderKeyIndexes**: `number`\[\]

Defined in: [WAProto/index.d.ts:3852](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3852)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IDeviceListMetadata`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata).[`senderKeyIndexes`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata#senderkeyindexes)

* * *

### senderTimestamp?[​](#sendertimestamp "Direct link to senderTimestamp?")

> `optional` **senderTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3851](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3851)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IDeviceListMetadata`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata).[`senderTimestamp`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata#sendertimestamp)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3863](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3863)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`DeviceListMetadata`](/docs/api/namespaces/proto/classes/DeviceListMetadata)

Defined in: [WAProto/index.d.ts:3858](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3858)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IDeviceListMetadata`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`DeviceListMetadata`](/docs/api/namespaces/proto/classes/DeviceListMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`DeviceListMetadata`](/docs/api/namespaces/proto/classes/DeviceListMetadata)

Defined in: [WAProto/index.d.ts:3860](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3860)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`DeviceListMetadata`](/docs/api/namespaces/proto/classes/DeviceListMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3859](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3859)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IDeviceListMetadata`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`DeviceListMetadata`](/docs/api/namespaces/proto/classes/DeviceListMetadata)

Defined in: [WAProto/index.d.ts:3861](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3861)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`DeviceListMetadata`](/docs/api/namespaces/proto/classes/DeviceListMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3864](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3864)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3862](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3862)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`DeviceListMetadata`](/docs/api/namespaces/proto/classes/DeviceListMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-deviceprops"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/DeviceProps](https://baileys.wiki/docs/api/namespaces/proto/classes/DeviceProps)

Defined in: [WAProto/index.d.ts:3875](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3875)

## Implements[​](#implements "Direct link to Implements")

*   [`IDeviceProps`](/docs/api/namespaces/proto/interfaces/IDeviceProps)

## Constructors[​](#constructors "Direct link to Constructors")

### new DeviceProps()[​](#new-deviceprops "Direct link to new DeviceProps()")

> **new DeviceProps**(`p`?): [`DeviceProps`](/docs/api/namespaces/proto/classes/DeviceProps)

Defined in: [WAProto/index.d.ts:3876](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3876)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IDeviceProps`](/docs/api/namespaces/proto/interfaces/IDeviceProps)

#### Returns[​](#returns "Direct link to Returns")

[`DeviceProps`](/docs/api/namespaces/proto/classes/DeviceProps)

## Properties[​](#properties "Direct link to Properties")

### historySyncConfig?[​](#historysyncconfig "Direct link to historySyncConfig?")

> `optional` **historySyncConfig**: `null` | [`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig)

Defined in: [WAProto/index.d.ts:3881](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3881)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IDeviceProps`](/docs/api/namespaces/proto/interfaces/IDeviceProps).[`historySyncConfig`](/docs/api/namespaces/proto/interfaces/IDeviceProps#historysyncconfig)

* * *

### os?[​](#os "Direct link to os?")

> `optional` **os**: `null` | `string`

Defined in: [WAProto/index.d.ts:3877](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3877)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IDeviceProps`](/docs/api/namespaces/proto/interfaces/IDeviceProps).[`os`](/docs/api/namespaces/proto/interfaces/IDeviceProps#os)

* * *

### platformType?[​](#platformtype "Direct link to platformType?")

> `optional` **platformType**: `null` | [`PlatformType`](/docs/api/namespaces/proto/namespaces/DeviceProps/enumerations/PlatformType)

Defined in: [WAProto/index.d.ts:3879](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3879)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IDeviceProps`](/docs/api/namespaces/proto/interfaces/IDeviceProps).[`platformType`](/docs/api/namespaces/proto/interfaces/IDeviceProps#platformtype)

* * *

### requireFullSync?[​](#requirefullsync "Direct link to requireFullSync?")

> `optional` **requireFullSync**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3880](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3880)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IDeviceProps`](/docs/api/namespaces/proto/interfaces/IDeviceProps).[`requireFullSync`](/docs/api/namespaces/proto/interfaces/IDeviceProps#requirefullsync)

* * *

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | [`IAppVersion`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IAppVersion)

Defined in: [WAProto/index.d.ts:3878](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3878)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IDeviceProps`](/docs/api/namespaces/proto/interfaces/IDeviceProps).[`version`](/docs/api/namespaces/proto/interfaces/IDeviceProps#version)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3887](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3887)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`DeviceProps`](/docs/api/namespaces/proto/classes/DeviceProps)

Defined in: [WAProto/index.d.ts:3882](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3882)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IDeviceProps`](/docs/api/namespaces/proto/interfaces/IDeviceProps)

#### Returns[​](#returns-2 "Direct link to Returns")

[`DeviceProps`](/docs/api/namespaces/proto/classes/DeviceProps)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`DeviceProps`](/docs/api/namespaces/proto/classes/DeviceProps)

Defined in: [WAProto/index.d.ts:3884](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3884)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`DeviceProps`](/docs/api/namespaces/proto/classes/DeviceProps)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3883](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3883)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IDeviceProps`](/docs/api/namespaces/proto/interfaces/IDeviceProps)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`DeviceProps`](/docs/api/namespaces/proto/classes/DeviceProps)

Defined in: [WAProto/index.d.ts:3885](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3885)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`DeviceProps`](/docs/api/namespaces/proto/classes/DeviceProps)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3888](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3888)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3886](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3886)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`DeviceProps`](/docs/api/namespaces/proto/classes/DeviceProps)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-disappearingmode"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/DisappearingMode](https://baileys.wiki/docs/api/namespaces/proto/classes/DisappearingMode)

Defined in: [WAProto/index.d.ts:4005](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4005)

## Implements[​](#implements "Direct link to Implements")

*   [`IDisappearingMode`](/docs/api/namespaces/proto/interfaces/IDisappearingMode)

## Constructors[​](#constructors "Direct link to Constructors")

### new DisappearingMode()[​](#new-disappearingmode "Direct link to new DisappearingMode()")

> **new DisappearingMode**(`p`?): [`DisappearingMode`](/docs/api/namespaces/proto/classes/DisappearingMode)

Defined in: [WAProto/index.d.ts:4006](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4006)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IDisappearingMode`](/docs/api/namespaces/proto/interfaces/IDisappearingMode)

#### Returns[​](#returns "Direct link to Returns")

[`DisappearingMode`](/docs/api/namespaces/proto/classes/DisappearingMode)

## Properties[​](#properties "Direct link to Properties")

### initiatedByMe?[​](#initiatedbyme "Direct link to initiatedByMe?")

> `optional` **initiatedByMe**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4010](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4010)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IDisappearingMode`](/docs/api/namespaces/proto/interfaces/IDisappearingMode).[`initiatedByMe`](/docs/api/namespaces/proto/interfaces/IDisappearingMode#initiatedbyme)

* * *

### initiator?[​](#initiator "Direct link to initiator?")

> `optional` **initiator**: `null` | [`Initiator`](/docs/api/namespaces/proto/namespaces/DisappearingMode/enumerations/Initiator)

Defined in: [WAProto/index.d.ts:4007](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4007)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IDisappearingMode`](/docs/api/namespaces/proto/interfaces/IDisappearingMode).[`initiator`](/docs/api/namespaces/proto/interfaces/IDisappearingMode#initiator)

* * *

### initiatorDeviceJid?[​](#initiatordevicejid "Direct link to initiatorDeviceJid?")

> `optional` **initiatorDeviceJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:4009](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4009)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IDisappearingMode`](/docs/api/namespaces/proto/interfaces/IDisappearingMode).[`initiatorDeviceJid`](/docs/api/namespaces/proto/interfaces/IDisappearingMode#initiatordevicejid)

* * *

### trigger?[​](#trigger "Direct link to trigger?")

> `optional` **trigger**: `null` | [`Trigger`](/docs/api/namespaces/proto/namespaces/DisappearingMode/enumerations/Trigger)

Defined in: [WAProto/index.d.ts:4008](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4008)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IDisappearingMode`](/docs/api/namespaces/proto/interfaces/IDisappearingMode).[`trigger`](/docs/api/namespaces/proto/interfaces/IDisappearingMode#trigger)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4016](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4016)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`DisappearingMode`](/docs/api/namespaces/proto/classes/DisappearingMode)

Defined in: [WAProto/index.d.ts:4011](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4011)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IDisappearingMode`](/docs/api/namespaces/proto/interfaces/IDisappearingMode)

#### Returns[​](#returns-2 "Direct link to Returns")

[`DisappearingMode`](/docs/api/namespaces/proto/classes/DisappearingMode)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`DisappearingMode`](/docs/api/namespaces/proto/classes/DisappearingMode)

Defined in: [WAProto/index.d.ts:4013](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4013)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`DisappearingMode`](/docs/api/namespaces/proto/classes/DisappearingMode)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4012](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4012)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IDisappearingMode`](/docs/api/namespaces/proto/interfaces/IDisappearingMode)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`DisappearingMode`](/docs/api/namespaces/proto/classes/DisappearingMode)

Defined in: [WAProto/index.d.ts:4014](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4014)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`DisappearingMode`](/docs/api/namespaces/proto/classes/DisappearingMode)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4017](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4017)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4015](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4015)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`DisappearingMode`](/docs/api/namespaces/proto/classes/DisappearingMode)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-embeddedcontent"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/EmbeddedContent](https://baileys.wiki/docs/api/namespaces/proto/classes/EmbeddedContent)

Defined in: [WAProto/index.d.ts:4044](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4044)

## Implements[​](#implements "Direct link to Implements")

*   [`IEmbeddedContent`](/docs/api/namespaces/proto/interfaces/IEmbeddedContent)

## Constructors[​](#constructors "Direct link to Constructors")

### new EmbeddedContent()[​](#new-embeddedcontent "Direct link to new EmbeddedContent()")

> **new EmbeddedContent**(`p`?): [`EmbeddedContent`](/docs/api/namespaces/proto/classes/EmbeddedContent)

Defined in: [WAProto/index.d.ts:4045](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4045)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IEmbeddedContent`](/docs/api/namespaces/proto/interfaces/IEmbeddedContent)

#### Returns[​](#returns "Direct link to Returns")

[`EmbeddedContent`](/docs/api/namespaces/proto/classes/EmbeddedContent)

## Properties[​](#properties "Direct link to Properties")

### content?[​](#content "Direct link to content?")

> `optional` **content**: `"embeddedMessage"` | `"embeddedMusic"`

Defined in: [WAProto/index.d.ts:4048](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4048)

* * *

### embeddedMessage?[​](#embeddedmessage "Direct link to embeddedMessage?")

> `optional` **embeddedMessage**: `null` | [`IEmbeddedMessage`](/docs/api/namespaces/proto/interfaces/IEmbeddedMessage)

Defined in: [WAProto/index.d.ts:4046](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4046)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IEmbeddedContent`](/docs/api/namespaces/proto/interfaces/IEmbeddedContent).[`embeddedMessage`](/docs/api/namespaces/proto/interfaces/IEmbeddedContent#embeddedmessage)

* * *

### embeddedMusic?[​](#embeddedmusic "Direct link to embeddedMusic?")

> `optional` **embeddedMusic**: `null` | [`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic)

Defined in: [WAProto/index.d.ts:4047](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4047)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IEmbeddedContent`](/docs/api/namespaces/proto/interfaces/IEmbeddedContent).[`embeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedContent#embeddedmusic)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4054](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4054)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`EmbeddedContent`](/docs/api/namespaces/proto/classes/EmbeddedContent)

Defined in: [WAProto/index.d.ts:4049](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4049)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IEmbeddedContent`](/docs/api/namespaces/proto/interfaces/IEmbeddedContent)

#### Returns[​](#returns-2 "Direct link to Returns")

[`EmbeddedContent`](/docs/api/namespaces/proto/classes/EmbeddedContent)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`EmbeddedContent`](/docs/api/namespaces/proto/classes/EmbeddedContent)

Defined in: [WAProto/index.d.ts:4051](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4051)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`EmbeddedContent`](/docs/api/namespaces/proto/classes/EmbeddedContent)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4050](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4050)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IEmbeddedContent`](/docs/api/namespaces/proto/interfaces/IEmbeddedContent)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`EmbeddedContent`](/docs/api/namespaces/proto/classes/EmbeddedContent)

Defined in: [WAProto/index.d.ts:4052](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4052)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`EmbeddedContent`](/docs/api/namespaces/proto/classes/EmbeddedContent)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4055](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4055)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4053](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4053)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`EmbeddedContent`](/docs/api/namespaces/proto/classes/EmbeddedContent)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-embeddedmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/EmbeddedMessage](https://baileys.wiki/docs/api/namespaces/proto/classes/EmbeddedMessage)

Defined in: [WAProto/index.d.ts:4063](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4063)

## Implements[​](#implements "Direct link to Implements")

*   [`IEmbeddedMessage`](/docs/api/namespaces/proto/interfaces/IEmbeddedMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new EmbeddedMessage()[​](#new-embeddedmessage "Direct link to new EmbeddedMessage()")

> **new EmbeddedMessage**(`p`?): [`EmbeddedMessage`](/docs/api/namespaces/proto/classes/EmbeddedMessage)

Defined in: [WAProto/index.d.ts:4064](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4064)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IEmbeddedMessage`](/docs/api/namespaces/proto/interfaces/IEmbeddedMessage)

#### Returns[​](#returns "Direct link to Returns")

[`EmbeddedMessage`](/docs/api/namespaces/proto/classes/EmbeddedMessage)

## Properties[​](#properties "Direct link to Properties")

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:4066](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4066)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IEmbeddedMessage`](/docs/api/namespaces/proto/interfaces/IEmbeddedMessage).[`message`](/docs/api/namespaces/proto/interfaces/IEmbeddedMessage#message)

* * *

### stanzaId?[​](#stanzaid "Direct link to stanzaId?")

> `optional` **stanzaId**: `null` | `string`

Defined in: [WAProto/index.d.ts:4065](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4065)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IEmbeddedMessage`](/docs/api/namespaces/proto/interfaces/IEmbeddedMessage).[`stanzaId`](/docs/api/namespaces/proto/interfaces/IEmbeddedMessage#stanzaid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4072](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4072)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`EmbeddedMessage`](/docs/api/namespaces/proto/classes/EmbeddedMessage)

Defined in: [WAProto/index.d.ts:4067](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4067)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IEmbeddedMessage`](/docs/api/namespaces/proto/interfaces/IEmbeddedMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`EmbeddedMessage`](/docs/api/namespaces/proto/classes/EmbeddedMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`EmbeddedMessage`](/docs/api/namespaces/proto/classes/EmbeddedMessage)

Defined in: [WAProto/index.d.ts:4069](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4069)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`EmbeddedMessage`](/docs/api/namespaces/proto/classes/EmbeddedMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4068](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4068)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IEmbeddedMessage`](/docs/api/namespaces/proto/interfaces/IEmbeddedMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`EmbeddedMessage`](/docs/api/namespaces/proto/classes/EmbeddedMessage)

Defined in: [WAProto/index.d.ts:4070](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4070)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`EmbeddedMessage`](/docs/api/namespaces/proto/classes/EmbeddedMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4073](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4073)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4071](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4071)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`EmbeddedMessage`](/docs/api/namespaces/proto/classes/EmbeddedMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-embeddedmusic"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/EmbeddedMusic](https://baileys.wiki/docs/api/namespaces/proto/classes/EmbeddedMusic)

Defined in: [WAProto/index.d.ts:4093](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4093)

## Implements[​](#implements "Direct link to Implements")

*   [`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic)

## Constructors[​](#constructors "Direct link to Constructors")

### new EmbeddedMusic()[​](#new-embeddedmusic "Direct link to new EmbeddedMusic()")

> **new EmbeddedMusic**(`p`?): [`EmbeddedMusic`](/docs/api/namespaces/proto/classes/EmbeddedMusic)

Defined in: [WAProto/index.d.ts:4094](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4094)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic)

#### Returns[​](#returns "Direct link to Returns")

[`EmbeddedMusic`](/docs/api/namespaces/proto/classes/EmbeddedMusic)

## Properties[​](#properties "Direct link to Properties")

### artistAttribution?[​](#artistattribution "Direct link to artistAttribution?")

> `optional` **artistAttribution**: `null` | `string`

Defined in: [WAProto/index.d.ts:4102](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4102)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic).[`artistAttribution`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic#artistattribution)

* * *

### artworkDirectPath?[​](#artworkdirectpath "Direct link to artworkDirectPath?")

> `optional` **artworkDirectPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:4099](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4099)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic).[`artworkDirectPath`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic#artworkdirectpath)

* * *

### artworkEncSha256?[​](#artworkencsha256 "Direct link to artworkEncSha256?")

> `optional` **artworkEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4101](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4101)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic).[`artworkEncSha256`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic#artworkencsha256)

* * *

### artworkMediaKey?[​](#artworkmediakey "Direct link to artworkMediaKey?")

> `optional` **artworkMediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4105](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4105)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic).[`artworkMediaKey`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic#artworkmediakey)

* * *

### artworkSha256?[​](#artworksha256 "Direct link to artworkSha256?")

> `optional` **artworkSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4100](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4100)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic).[`artworkSha256`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic#artworksha256)

* * *

### author?[​](#author "Direct link to author?")

> `optional` **author**: `null` | `string`

Defined in: [WAProto/index.d.ts:4097](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4097)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic).[`author`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic#author)

* * *

### countryBlocklist?[​](#countryblocklist "Direct link to countryBlocklist?")

> `optional` **countryBlocklist**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4103](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4103)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic).[`countryBlocklist`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic#countryblocklist)

* * *

### derivedContentStartTimeInMs?[​](#derivedcontentstarttimeinms "Direct link to derivedContentStartTimeInMs?")

> `optional` **derivedContentStartTimeInMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4107](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4107)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic).[`derivedContentStartTimeInMs`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic#derivedcontentstarttimeinms)

* * *

### isExplicit?[​](#isexplicit "Direct link to isExplicit?")

> `optional` **isExplicit**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4104](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4104)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic).[`isExplicit`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic#isexplicit)

* * *

### musicContentMediaId?[​](#musiccontentmediaid "Direct link to musicContentMediaId?")

> `optional` **musicContentMediaId**: `null` | `string`

Defined in: [WAProto/index.d.ts:4095](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4095)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic).[`musicContentMediaId`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic#musiccontentmediaid)

* * *

### musicSongStartTimeInMs?[​](#musicsongstarttimeinms "Direct link to musicSongStartTimeInMs?")

> `optional` **musicSongStartTimeInMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4106](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4106)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic).[`musicSongStartTimeInMs`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic#musicsongstarttimeinms)

* * *

### overlapDurationInMs?[​](#overlapdurationinms "Direct link to overlapDurationInMs?")

> `optional` **overlapDurationInMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4108](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4108)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic).[`overlapDurationInMs`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic#overlapdurationinms)

* * *

### songId?[​](#songid "Direct link to songId?")

> `optional` **songId**: `null` | `string`

Defined in: [WAProto/index.d.ts:4096](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4096)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic).[`songId`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic#songid)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:4098](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4098)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic).[`title`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic#title)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4114](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4114)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`EmbeddedMusic`](/docs/api/namespaces/proto/classes/EmbeddedMusic)

Defined in: [WAProto/index.d.ts:4109](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4109)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic)

#### Returns[​](#returns-2 "Direct link to Returns")

[`EmbeddedMusic`](/docs/api/namespaces/proto/classes/EmbeddedMusic)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`EmbeddedMusic`](/docs/api/namespaces/proto/classes/EmbeddedMusic)

Defined in: [WAProto/index.d.ts:4111](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4111)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`EmbeddedMusic`](/docs/api/namespaces/proto/classes/EmbeddedMusic)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4110](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4110)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`EmbeddedMusic`](/docs/api/namespaces/proto/classes/EmbeddedMusic)

Defined in: [WAProto/index.d.ts:4112](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4112)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`EmbeddedMusic`](/docs/api/namespaces/proto/classes/EmbeddedMusic)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4115](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4115)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4113](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4113)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`EmbeddedMusic`](/docs/api/namespaces/proto/classes/EmbeddedMusic)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-encryptedpairingrequest"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/EncryptedPairingRequest](https://baileys.wiki/docs/api/namespaces/proto/classes/EncryptedPairingRequest)

Defined in: [WAProto/index.d.ts:4123](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4123)

## Implements[​](#implements "Direct link to Implements")

*   [`IEncryptedPairingRequest`](/docs/api/namespaces/proto/interfaces/IEncryptedPairingRequest)

## Constructors[​](#constructors "Direct link to Constructors")

### new EncryptedPairingRequest()[​](#new-encryptedpairingrequest "Direct link to new EncryptedPairingRequest()")

> **new EncryptedPairingRequest**(`p`?): [`EncryptedPairingRequest`](/docs/api/namespaces/proto/classes/EncryptedPairingRequest)

Defined in: [WAProto/index.d.ts:4124](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4124)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IEncryptedPairingRequest`](/docs/api/namespaces/proto/interfaces/IEncryptedPairingRequest)

#### Returns[​](#returns "Direct link to Returns")

[`EncryptedPairingRequest`](/docs/api/namespaces/proto/classes/EncryptedPairingRequest)

## Properties[​](#properties "Direct link to Properties")

### encryptedPayload?[​](#encryptedpayload "Direct link to encryptedPayload?")

> `optional` **encryptedPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4125](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4125)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IEncryptedPairingRequest`](/docs/api/namespaces/proto/interfaces/IEncryptedPairingRequest).[`encryptedPayload`](/docs/api/namespaces/proto/interfaces/IEncryptedPairingRequest#encryptedpayload)

* * *

### iv?[​](#iv "Direct link to iv?")

> `optional` **iv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4126](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4126)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IEncryptedPairingRequest`](/docs/api/namespaces/proto/interfaces/IEncryptedPairingRequest).[`iv`](/docs/api/namespaces/proto/interfaces/IEncryptedPairingRequest#iv)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4132](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4132)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`EncryptedPairingRequest`](/docs/api/namespaces/proto/classes/EncryptedPairingRequest)

Defined in: [WAProto/index.d.ts:4127](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4127)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IEncryptedPairingRequest`](/docs/api/namespaces/proto/interfaces/IEncryptedPairingRequest)

#### Returns[​](#returns-2 "Direct link to Returns")

[`EncryptedPairingRequest`](/docs/api/namespaces/proto/classes/EncryptedPairingRequest)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`EncryptedPairingRequest`](/docs/api/namespaces/proto/classes/EncryptedPairingRequest)

Defined in: [WAProto/index.d.ts:4129](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4129)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`EncryptedPairingRequest`](/docs/api/namespaces/proto/classes/EncryptedPairingRequest)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4128](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4128)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IEncryptedPairingRequest`](/docs/api/namespaces/proto/interfaces/IEncryptedPairingRequest)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`EncryptedPairingRequest`](/docs/api/namespaces/proto/classes/EncryptedPairingRequest)

Defined in: [WAProto/index.d.ts:4130](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4130)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`EncryptedPairingRequest`](/docs/api/namespaces/proto/classes/EncryptedPairingRequest)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4133](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4133)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4131](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4131)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`EncryptedPairingRequest`](/docs/api/namespaces/proto/classes/EncryptedPairingRequest)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-ephemeralsetting"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/EphemeralSetting](https://baileys.wiki/docs/api/namespaces/proto/classes/EphemeralSetting)

Defined in: [WAProto/index.d.ts:4141](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4141)

## Implements[​](#implements "Direct link to Implements")

*   [`IEphemeralSetting`](/docs/api/namespaces/proto/interfaces/IEphemeralSetting)

## Constructors[​](#constructors "Direct link to Constructors")

### new EphemeralSetting()[​](#new-ephemeralsetting "Direct link to new EphemeralSetting()")

> **new EphemeralSetting**(`p`?): [`EphemeralSetting`](/docs/api/namespaces/proto/classes/EphemeralSetting)

Defined in: [WAProto/index.d.ts:4142](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4142)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IEphemeralSetting`](/docs/api/namespaces/proto/interfaces/IEphemeralSetting)

#### Returns[​](#returns "Direct link to Returns")

[`EphemeralSetting`](/docs/api/namespaces/proto/classes/EphemeralSetting)

## Properties[​](#properties "Direct link to Properties")

### duration?[​](#duration "Direct link to duration?")

> `optional` **duration**: `null` | `number`

Defined in: [WAProto/index.d.ts:4143](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4143)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IEphemeralSetting`](/docs/api/namespaces/proto/interfaces/IEphemeralSetting).[`duration`](/docs/api/namespaces/proto/interfaces/IEphemeralSetting#duration)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4144](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4144)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IEphemeralSetting`](/docs/api/namespaces/proto/interfaces/IEphemeralSetting).[`timestamp`](/docs/api/namespaces/proto/interfaces/IEphemeralSetting#timestamp)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4150](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4150)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`EphemeralSetting`](/docs/api/namespaces/proto/classes/EphemeralSetting)

Defined in: [WAProto/index.d.ts:4145](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4145)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IEphemeralSetting`](/docs/api/namespaces/proto/interfaces/IEphemeralSetting)

#### Returns[​](#returns-2 "Direct link to Returns")

[`EphemeralSetting`](/docs/api/namespaces/proto/classes/EphemeralSetting)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`EphemeralSetting`](/docs/api/namespaces/proto/classes/EphemeralSetting)

Defined in: [WAProto/index.d.ts:4147](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4147)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`EphemeralSetting`](/docs/api/namespaces/proto/classes/EphemeralSetting)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4146](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4146)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IEphemeralSetting`](/docs/api/namespaces/proto/interfaces/IEphemeralSetting)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`EphemeralSetting`](/docs/api/namespaces/proto/classes/EphemeralSetting)

Defined in: [WAProto/index.d.ts:4148](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4148)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`EphemeralSetting`](/docs/api/namespaces/proto/classes/EphemeralSetting)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4151](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4151)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4149](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4149)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`EphemeralSetting`](/docs/api/namespaces/proto/classes/EphemeralSetting)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-eventadditionalmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/EventAdditionalMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/EventAdditionalMetadata)

Defined in: [WAProto/index.d.ts:4158](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4158)

## Implements[​](#implements "Direct link to Implements")

*   [`IEventAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IEventAdditionalMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new EventAdditionalMetadata()[​](#new-eventadditionalmetadata "Direct link to new EventAdditionalMetadata()")

> **new EventAdditionalMetadata**(`p`?): [`EventAdditionalMetadata`](/docs/api/namespaces/proto/classes/EventAdditionalMetadata)

Defined in: [WAProto/index.d.ts:4159](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4159)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IEventAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IEventAdditionalMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`EventAdditionalMetadata`](/docs/api/namespaces/proto/classes/EventAdditionalMetadata)

## Properties[​](#properties "Direct link to Properties")

### isStale?[​](#isstale "Direct link to isStale?")

> `optional` **isStale**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4160](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4160)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IEventAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IEventAdditionalMetadata).[`isStale`](/docs/api/namespaces/proto/interfaces/IEventAdditionalMetadata#isstale)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4166](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4166)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`EventAdditionalMetadata`](/docs/api/namespaces/proto/classes/EventAdditionalMetadata)

Defined in: [WAProto/index.d.ts:4161](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4161)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IEventAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IEventAdditionalMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`EventAdditionalMetadata`](/docs/api/namespaces/proto/classes/EventAdditionalMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`EventAdditionalMetadata`](/docs/api/namespaces/proto/classes/EventAdditionalMetadata)

Defined in: [WAProto/index.d.ts:4163](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4163)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`EventAdditionalMetadata`](/docs/api/namespaces/proto/classes/EventAdditionalMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4162](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4162)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IEventAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IEventAdditionalMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`EventAdditionalMetadata`](/docs/api/namespaces/proto/classes/EventAdditionalMetadata)

Defined in: [WAProto/index.d.ts:4164](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4164)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`EventAdditionalMetadata`](/docs/api/namespaces/proto/classes/EventAdditionalMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4167](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4167)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4165](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4165)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`EventAdditionalMetadata`](/docs/api/namespaces/proto/classes/EventAdditionalMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-eventresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/EventResponse](https://baileys.wiki/docs/api/namespaces/proto/classes/EventResponse)

Defined in: [WAProto/index.d.ts:4177](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4177)

## Implements[​](#implements "Direct link to Implements")

*   [`IEventResponse`](/docs/api/namespaces/proto/interfaces/IEventResponse)

## Constructors[​](#constructors "Direct link to Constructors")

### new EventResponse()[​](#new-eventresponse "Direct link to new EventResponse()")

> **new EventResponse**(`p`?): [`EventResponse`](/docs/api/namespaces/proto/classes/EventResponse)

Defined in: [WAProto/index.d.ts:4178](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4178)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IEventResponse`](/docs/api/namespaces/proto/interfaces/IEventResponse)

#### Returns[​](#returns "Direct link to Returns")

[`EventResponse`](/docs/api/namespaces/proto/classes/EventResponse)

## Properties[​](#properties "Direct link to Properties")

### eventResponseMessage?[​](#eventresponsemessage "Direct link to eventResponseMessage?")

> `optional` **eventResponseMessage**: `null` | [`IEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventResponseMessage)

Defined in: [WAProto/index.d.ts:4181](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4181)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IEventResponse`](/docs/api/namespaces/proto/interfaces/IEventResponse).[`eventResponseMessage`](/docs/api/namespaces/proto/interfaces/IEventResponse#eventresponsemessage)

* * *

### eventResponseMessageKey?[​](#eventresponsemessagekey "Direct link to eventResponseMessageKey?")

> `optional` **eventResponseMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:4179](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4179)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IEventResponse`](/docs/api/namespaces/proto/interfaces/IEventResponse).[`eventResponseMessageKey`](/docs/api/namespaces/proto/interfaces/IEventResponse#eventresponsemessagekey)

* * *

### timestampMs?[​](#timestampms "Direct link to timestampMs?")

> `optional` **timestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4180](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4180)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IEventResponse`](/docs/api/namespaces/proto/interfaces/IEventResponse).[`timestampMs`](/docs/api/namespaces/proto/interfaces/IEventResponse#timestampms)

* * *

### unread?[​](#unread "Direct link to unread?")

> `optional` **unread**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4182](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4182)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IEventResponse`](/docs/api/namespaces/proto/interfaces/IEventResponse).[`unread`](/docs/api/namespaces/proto/interfaces/IEventResponse#unread)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4188](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4188)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`EventResponse`](/docs/api/namespaces/proto/classes/EventResponse)

Defined in: [WAProto/index.d.ts:4183](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4183)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IEventResponse`](/docs/api/namespaces/proto/interfaces/IEventResponse)

#### Returns[​](#returns-2 "Direct link to Returns")

[`EventResponse`](/docs/api/namespaces/proto/classes/EventResponse)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`EventResponse`](/docs/api/namespaces/proto/classes/EventResponse)

Defined in: [WAProto/index.d.ts:4185](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4185)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`EventResponse`](/docs/api/namespaces/proto/classes/EventResponse)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4184](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4184)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IEventResponse`](/docs/api/namespaces/proto/interfaces/IEventResponse)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`EventResponse`](/docs/api/namespaces/proto/classes/EventResponse)

Defined in: [WAProto/index.d.ts:4186](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4186)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`EventResponse`](/docs/api/namespaces/proto/classes/EventResponse)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4189](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4189)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4187](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4187)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`EventResponse`](/docs/api/namespaces/proto/classes/EventResponse)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-exitcode"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/ExitCode](https://baileys.wiki/docs/api/namespaces/proto/classes/ExitCode)

Defined in: [WAProto/index.d.ts:4197](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4197)

## Implements[​](#implements "Direct link to Implements")

*   [`IExitCode`](/docs/api/namespaces/proto/interfaces/IExitCode)

## Constructors[​](#constructors "Direct link to Constructors")

### new ExitCode()[​](#new-exitcode "Direct link to new ExitCode()")

> **new ExitCode**(`p`?): [`ExitCode`](/docs/api/namespaces/proto/classes/ExitCode)

Defined in: [WAProto/index.d.ts:4198](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4198)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IExitCode`](/docs/api/namespaces/proto/interfaces/IExitCode)

#### Returns[​](#returns "Direct link to Returns")

[`ExitCode`](/docs/api/namespaces/proto/classes/ExitCode)

## Properties[​](#properties "Direct link to Properties")

### code?[​](#code "Direct link to code?")

> `optional` **code**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4199](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4199)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IExitCode`](/docs/api/namespaces/proto/interfaces/IExitCode).[`code`](/docs/api/namespaces/proto/interfaces/IExitCode#code)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:4200](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4200)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IExitCode`](/docs/api/namespaces/proto/interfaces/IExitCode).[`text`](/docs/api/namespaces/proto/interfaces/IExitCode#text)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4206](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4206)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ExitCode`](/docs/api/namespaces/proto/classes/ExitCode)

Defined in: [WAProto/index.d.ts:4201](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4201)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IExitCode`](/docs/api/namespaces/proto/interfaces/IExitCode)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ExitCode`](/docs/api/namespaces/proto/classes/ExitCode)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ExitCode`](/docs/api/namespaces/proto/classes/ExitCode)

Defined in: [WAProto/index.d.ts:4203](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4203)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ExitCode`](/docs/api/namespaces/proto/classes/ExitCode)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4202](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4202)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IExitCode`](/docs/api/namespaces/proto/interfaces/IExitCode)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ExitCode`](/docs/api/namespaces/proto/classes/ExitCode)

Defined in: [WAProto/index.d.ts:4204](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4204)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ExitCode`](/docs/api/namespaces/proto/classes/ExitCode)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4207](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4207)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4205](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4205)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ExitCode`](/docs/api/namespaces/proto/classes/ExitCode)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-externalblobreference"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/ExternalBlobReference](https://baileys.wiki/docs/api/namespaces/proto/classes/ExternalBlobReference)

Defined in: [WAProto/index.d.ts:4219](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4219)

## Implements[​](#implements "Direct link to Implements")

*   [`IExternalBlobReference`](/docs/api/namespaces/proto/interfaces/IExternalBlobReference)

## Constructors[​](#constructors "Direct link to Constructors")

### new ExternalBlobReference()[​](#new-externalblobreference "Direct link to new ExternalBlobReference()")

> **new ExternalBlobReference**(`p`?): [`ExternalBlobReference`](/docs/api/namespaces/proto/classes/ExternalBlobReference)

Defined in: [WAProto/index.d.ts:4220](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4220)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IExternalBlobReference`](/docs/api/namespaces/proto/interfaces/IExternalBlobReference)

#### Returns[​](#returns "Direct link to Returns")

[`ExternalBlobReference`](/docs/api/namespaces/proto/classes/ExternalBlobReference)

## Properties[​](#properties "Direct link to Properties")

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:4222](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4222)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IExternalBlobReference`](/docs/api/namespaces/proto/interfaces/IExternalBlobReference).[`directPath`](/docs/api/namespaces/proto/interfaces/IExternalBlobReference#directpath)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4226](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4226)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IExternalBlobReference`](/docs/api/namespaces/proto/interfaces/IExternalBlobReference).[`fileEncSha256`](/docs/api/namespaces/proto/interfaces/IExternalBlobReference#fileencsha256)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4225](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4225)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IExternalBlobReference`](/docs/api/namespaces/proto/interfaces/IExternalBlobReference).[`fileSha256`](/docs/api/namespaces/proto/interfaces/IExternalBlobReference#filesha256)

* * *

### fileSizeBytes?[​](#filesizebytes "Direct link to fileSizeBytes?")

> `optional` **fileSizeBytes**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4224](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4224)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IExternalBlobReference`](/docs/api/namespaces/proto/interfaces/IExternalBlobReference).[`fileSizeBytes`](/docs/api/namespaces/proto/interfaces/IExternalBlobReference#filesizebytes)

* * *

### handle?[​](#handle "Direct link to handle?")

> `optional` **handle**: `null` | `string`

Defined in: [WAProto/index.d.ts:4223](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4223)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IExternalBlobReference`](/docs/api/namespaces/proto/interfaces/IExternalBlobReference).[`handle`](/docs/api/namespaces/proto/interfaces/IExternalBlobReference#handle)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4221](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4221)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IExternalBlobReference`](/docs/api/namespaces/proto/interfaces/IExternalBlobReference).[`mediaKey`](/docs/api/namespaces/proto/interfaces/IExternalBlobReference#mediakey)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4232](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4232)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ExternalBlobReference`](/docs/api/namespaces/proto/classes/ExternalBlobReference)

Defined in: [WAProto/index.d.ts:4227](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4227)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IExternalBlobReference`](/docs/api/namespaces/proto/interfaces/IExternalBlobReference)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ExternalBlobReference`](/docs/api/namespaces/proto/classes/ExternalBlobReference)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ExternalBlobReference`](/docs/api/namespaces/proto/classes/ExternalBlobReference)

Defined in: [WAProto/index.d.ts:4229](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4229)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ExternalBlobReference`](/docs/api/namespaces/proto/classes/ExternalBlobReference)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4228](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4228)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IExternalBlobReference`](/docs/api/namespaces/proto/interfaces/IExternalBlobReference)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ExternalBlobReference`](/docs/api/namespaces/proto/classes/ExternalBlobReference)

Defined in: [WAProto/index.d.ts:4230](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4230)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ExternalBlobReference`](/docs/api/namespaces/proto/classes/ExternalBlobReference)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4233](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4233)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4231](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4231)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ExternalBlobReference`](/docs/api/namespaces/proto/classes/ExternalBlobReference)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-field"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/Field](https://baileys.wiki/docs/api/namespaces/proto/classes/Field)

Defined in: [WAProto/index.d.ts:4244](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4244)

## Implements[​](#implements "Direct link to Implements")

*   [`IField`](/docs/api/namespaces/proto/interfaces/IField)

## Constructors[​](#constructors "Direct link to Constructors")

### new Field()[​](#new-field "Direct link to new Field()")

> **new Field**(`p`?): [`Field`](/docs/api/namespaces/proto/classes/Field)

Defined in: [WAProto/index.d.ts:4245](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4245)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IField`](/docs/api/namespaces/proto/interfaces/IField)

#### Returns[​](#returns "Direct link to Returns")

[`Field`](/docs/api/namespaces/proto/classes/Field)

## Properties[​](#properties "Direct link to Properties")

### isMessage?[​](#ismessage "Direct link to isMessage?")

> `optional` **isMessage**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4249](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4249)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IField`](/docs/api/namespaces/proto/interfaces/IField).[`isMessage`](/docs/api/namespaces/proto/interfaces/IField#ismessage)

* * *

### maxVersion?[​](#maxversion "Direct link to maxVersion?")

> `optional` **maxVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:4247](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4247)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IField`](/docs/api/namespaces/proto/interfaces/IField).[`maxVersion`](/docs/api/namespaces/proto/interfaces/IField#maxversion)

* * *

### minVersion?[​](#minversion "Direct link to minVersion?")

> `optional` **minVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:4246](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4246)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IField`](/docs/api/namespaces/proto/interfaces/IField).[`minVersion`](/docs/api/namespaces/proto/interfaces/IField#minversion)

* * *

### notReportableMinVersion?[​](#notreportableminversion "Direct link to notReportableMinVersion?")

> `optional` **notReportableMinVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:4248](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4248)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IField`](/docs/api/namespaces/proto/interfaces/IField).[`notReportableMinVersion`](/docs/api/namespaces/proto/interfaces/IField#notreportableminversion)

* * *

### subfield[​](#subfield "Direct link to subfield")

> **subfield**: `object`

Defined in: [WAProto/index.d.ts:4250](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4250)

#### Index Signature[​](#index-signature "Direct link to Index Signature")

\[`k`: `string`\]: [`IField`](/docs/api/namespaces/proto/interfaces/IField)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IField`](/docs/api/namespaces/proto/interfaces/IField).[`subfield`](/docs/api/namespaces/proto/interfaces/IField#subfield)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4256](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4256)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Field`](/docs/api/namespaces/proto/classes/Field)

Defined in: [WAProto/index.d.ts:4251](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4251)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IField`](/docs/api/namespaces/proto/interfaces/IField)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Field`](/docs/api/namespaces/proto/classes/Field)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Field`](/docs/api/namespaces/proto/classes/Field)

Defined in: [WAProto/index.d.ts:4253](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4253)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Field`](/docs/api/namespaces/proto/classes/Field)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4252](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4252)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IField`](/docs/api/namespaces/proto/interfaces/IField)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Field`](/docs/api/namespaces/proto/classes/Field)

Defined in: [WAProto/index.d.ts:4254](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4254)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Field`](/docs/api/namespaces/proto/classes/Field)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4257](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4257)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4255](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4255)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Field`](/docs/api/namespaces/proto/classes/Field)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-forwardedaibotmessageinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/ForwardedAIBotMessageInfo](https://baileys.wiki/docs/api/namespaces/proto/classes/ForwardedAIBotMessageInfo)

Defined in: [WAProto/index.d.ts:4266](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4266)

## Implements[​](#implements "Direct link to Implements")

*   [`IForwardedAIBotMessageInfo`](/docs/api/namespaces/proto/interfaces/IForwardedAIBotMessageInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new ForwardedAIBotMessageInfo()[​](#new-forwardedaibotmessageinfo "Direct link to new ForwardedAIBotMessageInfo()")

> **new ForwardedAIBotMessageInfo**(`p`?): [`ForwardedAIBotMessageInfo`](/docs/api/namespaces/proto/classes/ForwardedAIBotMessageInfo)

Defined in: [WAProto/index.d.ts:4267](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4267)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IForwardedAIBotMessageInfo`](/docs/api/namespaces/proto/interfaces/IForwardedAIBotMessageInfo)

#### Returns[​](#returns "Direct link to Returns")

[`ForwardedAIBotMessageInfo`](/docs/api/namespaces/proto/classes/ForwardedAIBotMessageInfo)

## Properties[​](#properties "Direct link to Properties")

### botJid?[​](#botjid "Direct link to botJid?")

> `optional` **botJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:4269](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4269)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IForwardedAIBotMessageInfo`](/docs/api/namespaces/proto/interfaces/IForwardedAIBotMessageInfo).[`botJid`](/docs/api/namespaces/proto/interfaces/IForwardedAIBotMessageInfo#botjid)

* * *

### botName?[​](#botname "Direct link to botName?")

> `optional` **botName**: `null` | `string`

Defined in: [WAProto/index.d.ts:4268](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4268)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IForwardedAIBotMessageInfo`](/docs/api/namespaces/proto/interfaces/IForwardedAIBotMessageInfo).[`botName`](/docs/api/namespaces/proto/interfaces/IForwardedAIBotMessageInfo#botname)

* * *

### creatorName?[​](#creatorname "Direct link to creatorName?")

> `optional` **creatorName**: `null` | `string`

Defined in: [WAProto/index.d.ts:4270](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4270)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IForwardedAIBotMessageInfo`](/docs/api/namespaces/proto/interfaces/IForwardedAIBotMessageInfo).[`creatorName`](/docs/api/namespaces/proto/interfaces/IForwardedAIBotMessageInfo#creatorname)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4276](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4276)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ForwardedAIBotMessageInfo`](/docs/api/namespaces/proto/classes/ForwardedAIBotMessageInfo)

Defined in: [WAProto/index.d.ts:4271](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4271)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IForwardedAIBotMessageInfo`](/docs/api/namespaces/proto/interfaces/IForwardedAIBotMessageInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ForwardedAIBotMessageInfo`](/docs/api/namespaces/proto/classes/ForwardedAIBotMessageInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ForwardedAIBotMessageInfo`](/docs/api/namespaces/proto/classes/ForwardedAIBotMessageInfo)

Defined in: [WAProto/index.d.ts:4273](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4273)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ForwardedAIBotMessageInfo`](/docs/api/namespaces/proto/classes/ForwardedAIBotMessageInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4272](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4272)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IForwardedAIBotMessageInfo`](/docs/api/namespaces/proto/interfaces/IForwardedAIBotMessageInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ForwardedAIBotMessageInfo`](/docs/api/namespaces/proto/classes/ForwardedAIBotMessageInfo)

Defined in: [WAProto/index.d.ts:4274](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4274)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ForwardedAIBotMessageInfo`](/docs/api/namespaces/proto/classes/ForwardedAIBotMessageInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4277](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4277)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4275](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4275)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ForwardedAIBotMessageInfo`](/docs/api/namespaces/proto/classes/ForwardedAIBotMessageInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-globalsettings"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/GlobalSettings](https://baileys.wiki/docs/api/namespaces/proto/classes/GlobalSettings)

Defined in: [WAProto/index.d.ts:4303](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4303)

## Implements[​](#implements "Direct link to Implements")

*   [`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings)

## Constructors[​](#constructors "Direct link to Constructors")

### new GlobalSettings()[​](#new-globalsettings "Direct link to new GlobalSettings()")

> **new GlobalSettings**(`p`?): [`GlobalSettings`](/docs/api/namespaces/proto/classes/GlobalSettings)

Defined in: [WAProto/index.d.ts:4304](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4304)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings)

#### Returns[​](#returns "Direct link to Returns")

[`GlobalSettings`](/docs/api/namespaces/proto/classes/GlobalSettings)

## Properties[​](#properties "Direct link to Properties")

### autoDownloadCellular?[​](#autodownloadcellular "Direct link to autoDownloadCellular?")

> `optional` **autoDownloadCellular**: `null` | [`IAutoDownloadSettings`](/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings)

Defined in: [WAProto/index.d.ts:4309](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4309)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings).[`autoDownloadCellular`](/docs/api/namespaces/proto/interfaces/IGlobalSettings#autodownloadcellular)

* * *

### autoDownloadRoaming?[​](#autodownloadroaming "Direct link to autoDownloadRoaming?")

> `optional` **autoDownloadRoaming**: `null` | [`IAutoDownloadSettings`](/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings)

Defined in: [WAProto/index.d.ts:4310](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4310)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings).[`autoDownloadRoaming`](/docs/api/namespaces/proto/interfaces/IGlobalSettings#autodownloadroaming)

* * *

### autoDownloadWiFi?[​](#autodownloadwifi "Direct link to autoDownloadWiFi?")

> `optional` **autoDownloadWiFi**: `null` | [`IAutoDownloadSettings`](/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings)

Defined in: [WAProto/index.d.ts:4308](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4308)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings).[`autoDownloadWiFi`](/docs/api/namespaces/proto/interfaces/IGlobalSettings#autodownloadwifi)

* * *

### autoUnarchiveChats?[​](#autounarchivechats "Direct link to autoUnarchiveChats?")

> `optional` **autoUnarchiveChats**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4318](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4318)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings).[`autoUnarchiveChats`](/docs/api/namespaces/proto/interfaces/IGlobalSettings#autounarchivechats)

* * *

### avatarUserSettings?[​](#avatarusersettings "Direct link to avatarUserSettings?")

> `optional` **avatarUserSettings**: `null` | [`IAvatarUserSettings`](/docs/api/namespaces/proto/interfaces/IAvatarUserSettings)

Defined in: [WAProto/index.d.ts:4315](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4315)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings).[`avatarUserSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings#avatarusersettings)

* * *

### chatDbLidMigrationTimestamp?[​](#chatdblidmigrationtimestamp "Direct link to chatDbLidMigrationTimestamp?")

> `optional` **chatDbLidMigrationTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4324](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4324)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings).[`chatDbLidMigrationTimestamp`](/docs/api/namespaces/proto/interfaces/IGlobalSettings#chatdblidmigrationtimestamp)

* * *

### chatLockSettings?[​](#chatlocksettings "Direct link to chatLockSettings?")

> `optional` **chatLockSettings**: `null` | [`IChatLockSettings`](/docs/api/namespaces/proto/interfaces/IChatLockSettings)

Defined in: [WAProto/index.d.ts:4323](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4323)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings).[`chatLockSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings#chatlocksettings)

* * *

### darkThemeWallpaper?[​](#darkthemewallpaper "Direct link to darkThemeWallpaper?")

> `optional` **darkThemeWallpaper**: `null` | [`IWallpaperSettings`](/docs/api/namespaces/proto/interfaces/IWallpaperSettings)

Defined in: [WAProto/index.d.ts:4307](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4307)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings).[`darkThemeWallpaper`](/docs/api/namespaces/proto/interfaces/IGlobalSettings#darkthemewallpaper)

* * *

### disappearingModeDuration?[​](#disappearingmodeduration "Direct link to disappearingModeDuration?")

> `optional` **disappearingModeDuration**: `null` | `number`

Defined in: [WAProto/index.d.ts:4313](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4313)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings).[`disappearingModeDuration`](/docs/api/namespaces/proto/interfaces/IGlobalSettings#disappearingmodeduration)

* * *

### disappearingModeTimestamp?[​](#disappearingmodetimestamp "Direct link to disappearingModeTimestamp?")

> `optional` **disappearingModeTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4314](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4314)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings).[`disappearingModeTimestamp`](/docs/api/namespaces/proto/interfaces/IGlobalSettings#disappearingmodetimestamp)

* * *

### fontSize?[​](#fontsize "Direct link to fontSize?")

> `optional` **fontSize**: `null` | `number`

Defined in: [WAProto/index.d.ts:4316](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4316)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings).[`fontSize`](/docs/api/namespaces/proto/interfaces/IGlobalSettings#fontsize)

* * *

### groupNotificationSettings?[​](#groupnotificationsettings "Direct link to groupNotificationSettings?")

> `optional` **groupNotificationSettings**: `null` | [`INotificationSettings`](/docs/api/namespaces/proto/interfaces/INotificationSettings)

Defined in: [WAProto/index.d.ts:4322](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4322)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings).[`groupNotificationSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings#groupnotificationsettings)

* * *

### individualNotificationSettings?[​](#individualnotificationsettings "Direct link to individualNotificationSettings?")

> `optional` **individualNotificationSettings**: `null` | [`INotificationSettings`](/docs/api/namespaces/proto/interfaces/INotificationSettings)

Defined in: [WAProto/index.d.ts:4321](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4321)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings).[`individualNotificationSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings#individualnotificationsettings)

* * *

### lightThemeWallpaper?[​](#lightthemewallpaper "Direct link to lightThemeWallpaper?")

> `optional` **lightThemeWallpaper**: `null` | [`IWallpaperSettings`](/docs/api/namespaces/proto/interfaces/IWallpaperSettings)

Defined in: [WAProto/index.d.ts:4305](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4305)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings).[`lightThemeWallpaper`](/docs/api/namespaces/proto/interfaces/IGlobalSettings#lightthemewallpaper)

* * *

### mediaVisibility?[​](#mediavisibility "Direct link to mediaVisibility?")

> `optional` **mediaVisibility**: `null` | [`MediaVisibility`](/docs/api/namespaces/proto/enumerations/MediaVisibility)

Defined in: [WAProto/index.d.ts:4306](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4306)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings).[`mediaVisibility`](/docs/api/namespaces/proto/interfaces/IGlobalSettings#mediavisibility)

* * *

### photoQualityMode?[​](#photoqualitymode "Direct link to photoQualityMode?")

> `optional` **photoQualityMode**: `null` | `number`

Defined in: [WAProto/index.d.ts:4320](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4320)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings).[`photoQualityMode`](/docs/api/namespaces/proto/interfaces/IGlobalSettings#photoqualitymode)

* * *

### securityNotifications?[​](#securitynotifications "Direct link to securityNotifications?")

> `optional` **securityNotifications**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4317](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4317)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings).[`securityNotifications`](/docs/api/namespaces/proto/interfaces/IGlobalSettings#securitynotifications)

* * *

### showGroupNotificationsPreview?[​](#showgroupnotificationspreview "Direct link to showGroupNotificationsPreview?")

> `optional` **showGroupNotificationsPreview**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4312](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4312)

#### Implementation of[​](#implementation-of-17 "Direct link to Implementation of")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings).[`showGroupNotificationsPreview`](/docs/api/namespaces/proto/interfaces/IGlobalSettings#showgroupnotificationspreview)

* * *

### showIndividualNotificationsPreview?[​](#showindividualnotificationspreview "Direct link to showIndividualNotificationsPreview?")

> `optional` **showIndividualNotificationsPreview**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4311](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4311)

#### Implementation of[​](#implementation-of-18 "Direct link to Implementation of")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings).[`showIndividualNotificationsPreview`](/docs/api/namespaces/proto/interfaces/IGlobalSettings#showindividualnotificationspreview)

* * *

### videoQualityMode?[​](#videoqualitymode "Direct link to videoQualityMode?")

> `optional` **videoQualityMode**: `null` | `number`

Defined in: [WAProto/index.d.ts:4319](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4319)

#### Implementation of[​](#implementation-of-19 "Direct link to Implementation of")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings).[`videoQualityMode`](/docs/api/namespaces/proto/interfaces/IGlobalSettings#videoqualitymode)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4330](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4330)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`GlobalSettings`](/docs/api/namespaces/proto/classes/GlobalSettings)

Defined in: [WAProto/index.d.ts:4325](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4325)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings)

#### Returns[​](#returns-2 "Direct link to Returns")

[`GlobalSettings`](/docs/api/namespaces/proto/classes/GlobalSettings)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`GlobalSettings`](/docs/api/namespaces/proto/classes/GlobalSettings)

Defined in: [WAProto/index.d.ts:4327](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4327)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`GlobalSettings`](/docs/api/namespaces/proto/classes/GlobalSettings)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4326](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4326)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`GlobalSettings`](/docs/api/namespaces/proto/classes/GlobalSettings)

Defined in: [WAProto/index.d.ts:4328](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4328)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`GlobalSettings`](/docs/api/namespaces/proto/classes/GlobalSettings)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4331](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4331)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4329](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4329)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`GlobalSettings`](/docs/api/namespaces/proto/classes/GlobalSettings)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-grouphistorybundleinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/GroupHistoryBundleInfo](https://baileys.wiki/docs/api/namespaces/proto/classes/GroupHistoryBundleInfo)

Defined in: [WAProto/index.d.ts:4339](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4339)

## Implements[​](#implements "Direct link to Implements")

*   [`IGroupHistoryBundleInfo`](/docs/api/namespaces/proto/interfaces/IGroupHistoryBundleInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new GroupHistoryBundleInfo()[​](#new-grouphistorybundleinfo "Direct link to new GroupHistoryBundleInfo()")

> **new GroupHistoryBundleInfo**(`p`?): [`GroupHistoryBundleInfo`](/docs/api/namespaces/proto/classes/GroupHistoryBundleInfo)

Defined in: [WAProto/index.d.ts:4340](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4340)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IGroupHistoryBundleInfo`](/docs/api/namespaces/proto/interfaces/IGroupHistoryBundleInfo)

#### Returns[​](#returns "Direct link to Returns")

[`GroupHistoryBundleInfo`](/docs/api/namespaces/proto/classes/GroupHistoryBundleInfo)

## Properties[​](#properties "Direct link to Properties")

### deprecatedMessageHistoryBundle?[​](#deprecatedmessagehistorybundle "Direct link to deprecatedMessageHistoryBundle?")

> `optional` **deprecatedMessageHistoryBundle**: `null` | [`IMessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle)

Defined in: [WAProto/index.d.ts:4341](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4341)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IGroupHistoryBundleInfo`](/docs/api/namespaces/proto/interfaces/IGroupHistoryBundleInfo).[`deprecatedMessageHistoryBundle`](/docs/api/namespaces/proto/interfaces/IGroupHistoryBundleInfo#deprecatedmessagehistorybundle)

* * *

### processState?[​](#processstate "Direct link to processState?")

> `optional` **processState**: `null` | [`ProcessState`](/docs/api/namespaces/proto/namespaces/GroupHistoryBundleInfo/enumerations/ProcessState)

Defined in: [WAProto/index.d.ts:4342](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4342)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IGroupHistoryBundleInfo`](/docs/api/namespaces/proto/interfaces/IGroupHistoryBundleInfo).[`processState`](/docs/api/namespaces/proto/interfaces/IGroupHistoryBundleInfo#processstate)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4348](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4348)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`GroupHistoryBundleInfo`](/docs/api/namespaces/proto/classes/GroupHistoryBundleInfo)

Defined in: [WAProto/index.d.ts:4343](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4343)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IGroupHistoryBundleInfo`](/docs/api/namespaces/proto/interfaces/IGroupHistoryBundleInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`GroupHistoryBundleInfo`](/docs/api/namespaces/proto/classes/GroupHistoryBundleInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`GroupHistoryBundleInfo`](/docs/api/namespaces/proto/classes/GroupHistoryBundleInfo)

Defined in: [WAProto/index.d.ts:4345](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4345)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`GroupHistoryBundleInfo`](/docs/api/namespaces/proto/classes/GroupHistoryBundleInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4344](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4344)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IGroupHistoryBundleInfo`](/docs/api/namespaces/proto/interfaces/IGroupHistoryBundleInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`GroupHistoryBundleInfo`](/docs/api/namespaces/proto/classes/GroupHistoryBundleInfo)

Defined in: [WAProto/index.d.ts:4346](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4346)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`GroupHistoryBundleInfo`](/docs/api/namespaces/proto/classes/GroupHistoryBundleInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4349](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4349)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4347](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4347)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`GroupHistoryBundleInfo`](/docs/api/namespaces/proto/classes/GroupHistoryBundleInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-grouphistoryindividualmessageinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/GroupHistoryIndividualMessageInfo](https://baileys.wiki/docs/api/namespaces/proto/classes/GroupHistoryIndividualMessageInfo)

Defined in: [WAProto/index.d.ts:4368](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4368)

## Implements[​](#implements "Direct link to Implements")

*   [`IGroupHistoryIndividualMessageInfo`](/docs/api/namespaces/proto/interfaces/IGroupHistoryIndividualMessageInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new GroupHistoryIndividualMessageInfo()[​](#new-grouphistoryindividualmessageinfo "Direct link to new GroupHistoryIndividualMessageInfo()")

> **new GroupHistoryIndividualMessageInfo**(`p`?): [`GroupHistoryIndividualMessageInfo`](/docs/api/namespaces/proto/classes/GroupHistoryIndividualMessageInfo)

Defined in: [WAProto/index.d.ts:4369](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4369)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IGroupHistoryIndividualMessageInfo`](/docs/api/namespaces/proto/interfaces/IGroupHistoryIndividualMessageInfo)

#### Returns[​](#returns "Direct link to Returns")

[`GroupHistoryIndividualMessageInfo`](/docs/api/namespaces/proto/classes/GroupHistoryIndividualMessageInfo)

## Properties[​](#properties "Direct link to Properties")

### bundleMessageKey?[​](#bundlemessagekey "Direct link to bundleMessageKey?")

> `optional` **bundleMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:4370](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4370)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IGroupHistoryIndividualMessageInfo`](/docs/api/namespaces/proto/interfaces/IGroupHistoryIndividualMessageInfo).[`bundleMessageKey`](/docs/api/namespaces/proto/interfaces/IGroupHistoryIndividualMessageInfo#bundlemessagekey)

* * *

### editedAfterReceivedAsHistory?[​](#editedafterreceivedashistory "Direct link to editedAfterReceivedAsHistory?")

> `optional` **editedAfterReceivedAsHistory**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4371](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4371)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IGroupHistoryIndividualMessageInfo`](/docs/api/namespaces/proto/interfaces/IGroupHistoryIndividualMessageInfo).[`editedAfterReceivedAsHistory`](/docs/api/namespaces/proto/interfaces/IGroupHistoryIndividualMessageInfo#editedafterreceivedashistory)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4377](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4377)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`GroupHistoryIndividualMessageInfo`](/docs/api/namespaces/proto/classes/GroupHistoryIndividualMessageInfo)

Defined in: [WAProto/index.d.ts:4372](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4372)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IGroupHistoryIndividualMessageInfo`](/docs/api/namespaces/proto/interfaces/IGroupHistoryIndividualMessageInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`GroupHistoryIndividualMessageInfo`](/docs/api/namespaces/proto/classes/GroupHistoryIndividualMessageInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`GroupHistoryIndividualMessageInfo`](/docs/api/namespaces/proto/classes/GroupHistoryIndividualMessageInfo)

Defined in: [WAProto/index.d.ts:4374](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4374)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`GroupHistoryIndividualMessageInfo`](/docs/api/namespaces/proto/classes/GroupHistoryIndividualMessageInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4373](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4373)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IGroupHistoryIndividualMessageInfo`](/docs/api/namespaces/proto/interfaces/IGroupHistoryIndividualMessageInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`GroupHistoryIndividualMessageInfo`](/docs/api/namespaces/proto/classes/GroupHistoryIndividualMessageInfo)

Defined in: [WAProto/index.d.ts:4375](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4375)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`GroupHistoryIndividualMessageInfo`](/docs/api/namespaces/proto/classes/GroupHistoryIndividualMessageInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4378](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4378)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4376](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4376)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`GroupHistoryIndividualMessageInfo`](/docs/api/namespaces/proto/classes/GroupHistoryIndividualMessageInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-groupmention"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/GroupMention](https://baileys.wiki/docs/api/namespaces/proto/classes/GroupMention)

Defined in: [WAProto/index.d.ts:4386](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4386)

## Implements[​](#implements "Direct link to Implements")

*   [`IGroupMention`](/docs/api/namespaces/proto/interfaces/IGroupMention)

## Constructors[​](#constructors "Direct link to Constructors")

### new GroupMention()[​](#new-groupmention "Direct link to new GroupMention()")

> **new GroupMention**(`p`?): [`GroupMention`](/docs/api/namespaces/proto/classes/GroupMention)

Defined in: [WAProto/index.d.ts:4387](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4387)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IGroupMention`](/docs/api/namespaces/proto/interfaces/IGroupMention)

#### Returns[​](#returns "Direct link to Returns")

[`GroupMention`](/docs/api/namespaces/proto/classes/GroupMention)

## Properties[​](#properties "Direct link to Properties")

### groupJid?[​](#groupjid "Direct link to groupJid?")

> `optional` **groupJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:4388](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4388)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IGroupMention`](/docs/api/namespaces/proto/interfaces/IGroupMention).[`groupJid`](/docs/api/namespaces/proto/interfaces/IGroupMention#groupjid)

* * *

### groupSubject?[​](#groupsubject "Direct link to groupSubject?")

> `optional` **groupSubject**: `null` | `string`

Defined in: [WAProto/index.d.ts:4389](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4389)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IGroupMention`](/docs/api/namespaces/proto/interfaces/IGroupMention).[`groupSubject`](/docs/api/namespaces/proto/interfaces/IGroupMention#groupsubject)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4395](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4395)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`GroupMention`](/docs/api/namespaces/proto/classes/GroupMention)

Defined in: [WAProto/index.d.ts:4390](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4390)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IGroupMention`](/docs/api/namespaces/proto/interfaces/IGroupMention)

#### Returns[​](#returns-2 "Direct link to Returns")

[`GroupMention`](/docs/api/namespaces/proto/classes/GroupMention)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`GroupMention`](/docs/api/namespaces/proto/classes/GroupMention)

Defined in: [WAProto/index.d.ts:4392](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4392)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`GroupMention`](/docs/api/namespaces/proto/classes/GroupMention)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4391](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4391)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IGroupMention`](/docs/api/namespaces/proto/interfaces/IGroupMention)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`GroupMention`](/docs/api/namespaces/proto/classes/GroupMention)

Defined in: [WAProto/index.d.ts:4393](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4393)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`GroupMention`](/docs/api/namespaces/proto/classes/GroupMention)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4396](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4396)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4394](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4394)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`GroupMention`](/docs/api/namespaces/proto/classes/GroupMention)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-groupparticipant"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/GroupParticipant](https://baileys.wiki/docs/api/namespaces/proto/classes/GroupParticipant)

Defined in: [WAProto/index.d.ts:4405](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4405)

## Implements[​](#implements "Direct link to Implements")

*   [`IGroupParticipant`](/docs/api/namespaces/proto/interfaces/IGroupParticipant)

## Constructors[​](#constructors "Direct link to Constructors")

### new GroupParticipant()[​](#new-groupparticipant "Direct link to new GroupParticipant()")

> **new GroupParticipant**(`p`?): [`GroupParticipant`](/docs/api/namespaces/proto/classes/GroupParticipant)

Defined in: [WAProto/index.d.ts:4406](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4406)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IGroupParticipant`](/docs/api/namespaces/proto/interfaces/IGroupParticipant)

#### Returns[​](#returns "Direct link to Returns")

[`GroupParticipant`](/docs/api/namespaces/proto/classes/GroupParticipant)

## Properties[​](#properties "Direct link to Properties")

### memberLabel?[​](#memberlabel "Direct link to memberLabel?")

> `optional` **memberLabel**: `null` | [`IMemberLabel`](/docs/api/namespaces/proto/interfaces/IMemberLabel)

Defined in: [WAProto/index.d.ts:4409](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4409)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IGroupParticipant`](/docs/api/namespaces/proto/interfaces/IGroupParticipant).[`memberLabel`](/docs/api/namespaces/proto/interfaces/IGroupParticipant#memberlabel)

* * *

### rank?[​](#rank "Direct link to rank?")

> `optional` **rank**: `null` | [`Rank`](/docs/api/namespaces/proto/namespaces/GroupParticipant/enumerations/Rank)

Defined in: [WAProto/index.d.ts:4408](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4408)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IGroupParticipant`](/docs/api/namespaces/proto/interfaces/IGroupParticipant).[`rank`](/docs/api/namespaces/proto/interfaces/IGroupParticipant#rank)

* * *

### userJid[​](#userjid "Direct link to userJid")

> **userJid**: `string`

Defined in: [WAProto/index.d.ts:4407](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4407)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IGroupParticipant`](/docs/api/namespaces/proto/interfaces/IGroupParticipant).[`userJid`](/docs/api/namespaces/proto/interfaces/IGroupParticipant#userjid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4415](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4415)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`GroupParticipant`](/docs/api/namespaces/proto/classes/GroupParticipant)

Defined in: [WAProto/index.d.ts:4410](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4410)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IGroupParticipant`](/docs/api/namespaces/proto/interfaces/IGroupParticipant)

#### Returns[​](#returns-2 "Direct link to Returns")

[`GroupParticipant`](/docs/api/namespaces/proto/classes/GroupParticipant)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`GroupParticipant`](/docs/api/namespaces/proto/classes/GroupParticipant)

Defined in: [WAProto/index.d.ts:4412](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4412)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`GroupParticipant`](/docs/api/namespaces/proto/classes/GroupParticipant)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4411](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4411)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IGroupParticipant`](/docs/api/namespaces/proto/interfaces/IGroupParticipant)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`GroupParticipant`](/docs/api/namespaces/proto/classes/GroupParticipant)

Defined in: [WAProto/index.d.ts:4413](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4413)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`GroupParticipant`](/docs/api/namespaces/proto/classes/GroupParticipant)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4416](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4416)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4414](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4414)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`GroupParticipant`](/docs/api/namespaces/proto/classes/GroupParticipant)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-handshakemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/HandshakeMessage](https://baileys.wiki/docs/api/namespaces/proto/classes/HandshakeMessage)

Defined in: [WAProto/index.d.ts:4434](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4434)

## Implements[​](#implements "Direct link to Implements")

*   [`IHandshakeMessage`](/docs/api/namespaces/proto/interfaces/IHandshakeMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new HandshakeMessage()[​](#new-handshakemessage "Direct link to new HandshakeMessage()")

> **new HandshakeMessage**(`p`?): [`HandshakeMessage`](/docs/api/namespaces/proto/classes/HandshakeMessage)

Defined in: [WAProto/index.d.ts:4435](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4435)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHandshakeMessage`](/docs/api/namespaces/proto/interfaces/IHandshakeMessage)

#### Returns[​](#returns "Direct link to Returns")

[`HandshakeMessage`](/docs/api/namespaces/proto/classes/HandshakeMessage)

## Properties[​](#properties "Direct link to Properties")

### clientFinish?[​](#clientfinish "Direct link to clientFinish?")

> `optional` **clientFinish**: `null` | [`IClientFinish`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientFinish)

Defined in: [WAProto/index.d.ts:4438](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4438)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHandshakeMessage`](/docs/api/namespaces/proto/interfaces/IHandshakeMessage).[`clientFinish`](/docs/api/namespaces/proto/interfaces/IHandshakeMessage#clientfinish)

* * *

### clientHello?[​](#clienthello "Direct link to clientHello?")

> `optional` **clientHello**: `null` | [`IClientHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientHello)

Defined in: [WAProto/index.d.ts:4436](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4436)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IHandshakeMessage`](/docs/api/namespaces/proto/interfaces/IHandshakeMessage).[`clientHello`](/docs/api/namespaces/proto/interfaces/IHandshakeMessage#clienthello)

* * *

### serverHello?[​](#serverhello "Direct link to serverHello?")

> `optional` **serverHello**: `null` | [`IServerHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IServerHello)

Defined in: [WAProto/index.d.ts:4437](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4437)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IHandshakeMessage`](/docs/api/namespaces/proto/interfaces/IHandshakeMessage).[`serverHello`](/docs/api/namespaces/proto/interfaces/IHandshakeMessage#serverhello)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4444](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4444)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`HandshakeMessage`](/docs/api/namespaces/proto/classes/HandshakeMessage)

Defined in: [WAProto/index.d.ts:4439](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4439)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHandshakeMessage`](/docs/api/namespaces/proto/interfaces/IHandshakeMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`HandshakeMessage`](/docs/api/namespaces/proto/classes/HandshakeMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`HandshakeMessage`](/docs/api/namespaces/proto/classes/HandshakeMessage)

Defined in: [WAProto/index.d.ts:4441](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4441)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`HandshakeMessage`](/docs/api/namespaces/proto/classes/HandshakeMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4440](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4440)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHandshakeMessage`](/docs/api/namespaces/proto/interfaces/IHandshakeMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`HandshakeMessage`](/docs/api/namespaces/proto/classes/HandshakeMessage)

Defined in: [WAProto/index.d.ts:4442](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4442)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`HandshakeMessage`](/docs/api/namespaces/proto/classes/HandshakeMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4445](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4445)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4443](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4443)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`HandshakeMessage`](/docs/api/namespaces/proto/classes/HandshakeMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-historysync"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/HistorySync](https://baileys.wiki/docs/api/namespaces/proto/classes/HistorySync)

Defined in: [WAProto/index.d.ts:4537](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4537)

## Implements[​](#implements "Direct link to Implements")

*   [`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync)

## Constructors[​](#constructors "Direct link to Constructors")

### new HistorySync()[​](#new-historysync "Direct link to new HistorySync()")

> **new HistorySync**(`p`?): [`HistorySync`](/docs/api/namespaces/proto/classes/HistorySync)

Defined in: [WAProto/index.d.ts:4538](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4538)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync)

#### Returns[​](#returns "Direct link to Returns")

[`HistorySync`](/docs/api/namespaces/proto/classes/HistorySync)

## Properties[​](#properties "Direct link to Properties")

### accounts[​](#accounts "Direct link to accounts")

> **accounts**: [`IAccount`](/docs/api/namespaces/proto/interfaces/IAccount)\[\]

Defined in: [WAProto/index.d.ts:4555](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4555)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync).[`accounts`](/docs/api/namespaces/proto/interfaces/IHistorySync#accounts)

* * *

### aiWaitListState?[​](#aiwaitliststate "Direct link to aiWaitListState?")

> `optional` **aiWaitListState**: `null` | [`BotAIWaitListState`](/docs/api/namespaces/proto/namespaces/HistorySync/enumerations/BotAIWaitListState)

Defined in: [WAProto/index.d.ts:4551](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4551)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync).[`aiWaitListState`](/docs/api/namespaces/proto/interfaces/IHistorySync#aiwaitliststate)

* * *

### callLogRecords[​](#calllogrecords "Direct link to callLogRecords")

> **callLogRecords**: [`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord)\[\]

Defined in: [WAProto/index.d.ts:4550](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4550)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync).[`callLogRecords`](/docs/api/namespaces/proto/interfaces/IHistorySync#calllogrecords)

* * *

### chunkOrder?[​](#chunkorder "Direct link to chunkOrder?")

> `optional` **chunkOrder**: `null` | `number`

Defined in: [WAProto/index.d.ts:4542](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4542)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync).[`chunkOrder`](/docs/api/namespaces/proto/interfaces/IHistorySync#chunkorder)

* * *

### companionMetaNonce?[​](#companionmetanonce "Direct link to companionMetaNonce?")

> `optional` **companionMetaNonce**: `null` | `string`

Defined in: [WAProto/index.d.ts:4553](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4553)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync).[`companionMetaNonce`](/docs/api/namespaces/proto/interfaces/IHistorySync#companionmetanonce)

* * *

### conversations[​](#conversations "Direct link to conversations")

> **conversations**: [`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation)\[\]

Defined in: [WAProto/index.d.ts:4540](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4540)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync).[`conversations`](/docs/api/namespaces/proto/interfaces/IHistorySync#conversations)

* * *

### globalSettings?[​](#globalsettings "Direct link to globalSettings?")

> `optional` **globalSettings**: `null` | [`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings)

Defined in: [WAProto/index.d.ts:4545](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4545)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync).[`globalSettings`](/docs/api/namespaces/proto/interfaces/IHistorySync#globalsettings)

* * *

### pastParticipants[​](#pastparticipants "Direct link to pastParticipants")

> **pastParticipants**: [`IPastParticipants`](/docs/api/namespaces/proto/interfaces/IPastParticipants)\[\]

Defined in: [WAProto/index.d.ts:4549](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4549)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync).[`pastParticipants`](/docs/api/namespaces/proto/interfaces/IHistorySync#pastparticipants)

* * *

### phoneNumberToLidMappings[​](#phonenumbertolidmappings "Direct link to phoneNumberToLidMappings")

> **phoneNumberToLidMappings**: [`IPhoneNumberToLIDMapping`](/docs/api/namespaces/proto/interfaces/IPhoneNumberToLIDMapping)\[\]

Defined in: [WAProto/index.d.ts:4552](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4552)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync).[`phoneNumberToLidMappings`](/docs/api/namespaces/proto/interfaces/IHistorySync#phonenumbertolidmappings)

* * *

### progress?[​](#progress "Direct link to progress?")

> `optional` **progress**: `null` | `number`

Defined in: [WAProto/index.d.ts:4543](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4543)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync).[`progress`](/docs/api/namespaces/proto/interfaces/IHistorySync#progress)

* * *

### pushnames[​](#pushnames "Direct link to pushnames")

> **pushnames**: [`IPushname`](/docs/api/namespaces/proto/interfaces/IPushname)\[\]

Defined in: [WAProto/index.d.ts:4544](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4544)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync).[`pushnames`](/docs/api/namespaces/proto/interfaces/IHistorySync#pushnames)

* * *

### recentStickers[​](#recentstickers "Direct link to recentStickers")

> **recentStickers**: [`IStickerMetadata`](/docs/api/namespaces/proto/interfaces/IStickerMetadata)\[\]

Defined in: [WAProto/index.d.ts:4548](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4548)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync).[`recentStickers`](/docs/api/namespaces/proto/interfaces/IHistorySync#recentstickers)

* * *

### shareableChatIdentifierEncryptionKey?[​](#shareablechatidentifierencryptionkey "Direct link to shareableChatIdentifierEncryptionKey?")

> `optional` **shareableChatIdentifierEncryptionKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4554](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4554)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync).[`shareableChatIdentifierEncryptionKey`](/docs/api/namespaces/proto/interfaces/IHistorySync#shareablechatidentifierencryptionkey)

* * *

### statusV3Messages[​](#statusv3messages "Direct link to statusV3Messages")

> **statusV3Messages**: [`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo)\[\]

Defined in: [WAProto/index.d.ts:4541](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4541)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync).[`statusV3Messages`](/docs/api/namespaces/proto/interfaces/IHistorySync#statusv3messages)

* * *

### syncType[​](#synctype "Direct link to syncType")

> **syncType**: [`HistorySyncType`](/docs/api/namespaces/proto/namespaces/HistorySync/enumerations/HistorySyncType)

Defined in: [WAProto/index.d.ts:4539](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4539)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync).[`syncType`](/docs/api/namespaces/proto/interfaces/IHistorySync#synctype)

* * *

### threadDsTimeframeOffset?[​](#threaddstimeframeoffset "Direct link to threadDsTimeframeOffset?")

> `optional` **threadDsTimeframeOffset**: `null` | `number`

Defined in: [WAProto/index.d.ts:4547](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4547)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync).[`threadDsTimeframeOffset`](/docs/api/namespaces/proto/interfaces/IHistorySync#threaddstimeframeoffset)

* * *

### threadIdUserSecret?[​](#threadidusersecret "Direct link to threadIdUserSecret?")

> `optional` **threadIdUserSecret**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4546](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4546)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync).[`threadIdUserSecret`](/docs/api/namespaces/proto/interfaces/IHistorySync#threadidusersecret)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4561](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4561)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`HistorySync`](/docs/api/namespaces/proto/classes/HistorySync)

Defined in: [WAProto/index.d.ts:4556](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4556)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync)

#### Returns[​](#returns-2 "Direct link to Returns")

[`HistorySync`](/docs/api/namespaces/proto/classes/HistorySync)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`HistorySync`](/docs/api/namespaces/proto/classes/HistorySync)

Defined in: [WAProto/index.d.ts:4558](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4558)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`HistorySync`](/docs/api/namespaces/proto/classes/HistorySync)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4557](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4557)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHistorySync`](/docs/api/namespaces/proto/interfaces/IHistorySync)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`HistorySync`](/docs/api/namespaces/proto/classes/HistorySync)

Defined in: [WAProto/index.d.ts:4559](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4559)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`HistorySync`](/docs/api/namespaces/proto/classes/HistorySync)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4562](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4562)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4560](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4560)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`HistorySync`](/docs/api/namespaces/proto/classes/HistorySync)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-historysyncmsg"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/HistorySyncMsg](https://baileys.wiki/docs/api/namespaces/proto/classes/HistorySyncMsg)

Defined in: [WAProto/index.d.ts:4588](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4588)

## Implements[​](#implements "Direct link to Implements")

*   [`IHistorySyncMsg`](/docs/api/namespaces/proto/interfaces/IHistorySyncMsg)

## Constructors[​](#constructors "Direct link to Constructors")

### new HistorySyncMsg()[​](#new-historysyncmsg "Direct link to new HistorySyncMsg()")

> **new HistorySyncMsg**(`p`?): [`HistorySyncMsg`](/docs/api/namespaces/proto/classes/HistorySyncMsg)

Defined in: [WAProto/index.d.ts:4589](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4589)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHistorySyncMsg`](/docs/api/namespaces/proto/interfaces/IHistorySyncMsg)

#### Returns[​](#returns "Direct link to Returns")

[`HistorySyncMsg`](/docs/api/namespaces/proto/classes/HistorySyncMsg)

## Properties[​](#properties "Direct link to Properties")

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | [`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo)

Defined in: [WAProto/index.d.ts:4590](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4590)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHistorySyncMsg`](/docs/api/namespaces/proto/interfaces/IHistorySyncMsg).[`message`](/docs/api/namespaces/proto/interfaces/IHistorySyncMsg#message)

* * *

### msgOrderId?[​](#msgorderid "Direct link to msgOrderId?")

> `optional` **msgOrderId**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4591](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4591)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IHistorySyncMsg`](/docs/api/namespaces/proto/interfaces/IHistorySyncMsg).[`msgOrderId`](/docs/api/namespaces/proto/interfaces/IHistorySyncMsg#msgorderid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4597](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4597)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`HistorySyncMsg`](/docs/api/namespaces/proto/classes/HistorySyncMsg)

Defined in: [WAProto/index.d.ts:4592](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4592)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHistorySyncMsg`](/docs/api/namespaces/proto/interfaces/IHistorySyncMsg)

#### Returns[​](#returns-2 "Direct link to Returns")

[`HistorySyncMsg`](/docs/api/namespaces/proto/classes/HistorySyncMsg)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`HistorySyncMsg`](/docs/api/namespaces/proto/classes/HistorySyncMsg)

Defined in: [WAProto/index.d.ts:4594](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4594)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`HistorySyncMsg`](/docs/api/namespaces/proto/classes/HistorySyncMsg)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4593](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4593)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHistorySyncMsg`](/docs/api/namespaces/proto/interfaces/IHistorySyncMsg)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`HistorySyncMsg`](/docs/api/namespaces/proto/classes/HistorySyncMsg)

Defined in: [WAProto/index.d.ts:4595](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4595)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`HistorySyncMsg`](/docs/api/namespaces/proto/classes/HistorySyncMsg)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4598](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4598)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4596](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4596)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`HistorySyncMsg`](/docs/api/namespaces/proto/classes/HistorySyncMsg)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-hydratedtemplatebutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/HydratedTemplateButton](https://baileys.wiki/docs/api/namespaces/proto/classes/HydratedTemplateButton)

Defined in: [WAProto/index.d.ts:4608](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4608)

## Implements[​](#implements "Direct link to Implements")

*   [`IHydratedTemplateButton`](/docs/api/namespaces/proto/interfaces/IHydratedTemplateButton)

## Constructors[​](#constructors "Direct link to Constructors")

### new HydratedTemplateButton()[​](#new-hydratedtemplatebutton "Direct link to new HydratedTemplateButton()")

> **new HydratedTemplateButton**(`p`?): [`HydratedTemplateButton`](/docs/api/namespaces/proto/classes/HydratedTemplateButton)

Defined in: [WAProto/index.d.ts:4609](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4609)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHydratedTemplateButton`](/docs/api/namespaces/proto/interfaces/IHydratedTemplateButton)

#### Returns[​](#returns "Direct link to Returns")

[`HydratedTemplateButton`](/docs/api/namespaces/proto/classes/HydratedTemplateButton)

## Properties[​](#properties "Direct link to Properties")

### callButton?[​](#callbutton "Direct link to callButton?")

> `optional` **callButton**: `null` | [`IHydratedCallButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedCallButton)

Defined in: [WAProto/index.d.ts:4613](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4613)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHydratedTemplateButton`](/docs/api/namespaces/proto/interfaces/IHydratedTemplateButton).[`callButton`](/docs/api/namespaces/proto/interfaces/IHydratedTemplateButton#callbutton)

* * *

### hydratedButton?[​](#hydratedbutton "Direct link to hydratedButton?")

> `optional` **hydratedButton**: `"quickReplyButton"` | `"urlButton"` | `"callButton"`

Defined in: [WAProto/index.d.ts:4614](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4614)

* * *

### index?[​](#index "Direct link to index?")

> `optional` **index**: `null` | `number`

Defined in: [WAProto/index.d.ts:4610](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4610)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IHydratedTemplateButton`](/docs/api/namespaces/proto/interfaces/IHydratedTemplateButton).[`index`](/docs/api/namespaces/proto/interfaces/IHydratedTemplateButton#index)

* * *

### quickReplyButton?[​](#quickreplybutton "Direct link to quickReplyButton?")

> `optional` **quickReplyButton**: `null` | [`IHydratedQuickReplyButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedQuickReplyButton)

Defined in: [WAProto/index.d.ts:4611](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4611)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IHydratedTemplateButton`](/docs/api/namespaces/proto/interfaces/IHydratedTemplateButton).[`quickReplyButton`](/docs/api/namespaces/proto/interfaces/IHydratedTemplateButton#quickreplybutton)

* * *

### urlButton?[​](#urlbutton "Direct link to urlButton?")

> `optional` **urlButton**: `null` | [`IHydratedURLButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedURLButton)

Defined in: [WAProto/index.d.ts:4612](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4612)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IHydratedTemplateButton`](/docs/api/namespaces/proto/interfaces/IHydratedTemplateButton).[`urlButton`](/docs/api/namespaces/proto/interfaces/IHydratedTemplateButton#urlbutton)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4620](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4620)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`HydratedTemplateButton`](/docs/api/namespaces/proto/classes/HydratedTemplateButton)

Defined in: [WAProto/index.d.ts:4615](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4615)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHydratedTemplateButton`](/docs/api/namespaces/proto/interfaces/IHydratedTemplateButton)

#### Returns[​](#returns-2 "Direct link to Returns")

[`HydratedTemplateButton`](/docs/api/namespaces/proto/classes/HydratedTemplateButton)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`HydratedTemplateButton`](/docs/api/namespaces/proto/classes/HydratedTemplateButton)

Defined in: [WAProto/index.d.ts:4617](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4617)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`HydratedTemplateButton`](/docs/api/namespaces/proto/classes/HydratedTemplateButton)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4616](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4616)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHydratedTemplateButton`](/docs/api/namespaces/proto/interfaces/IHydratedTemplateButton)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`HydratedTemplateButton`](/docs/api/namespaces/proto/classes/HydratedTemplateButton)

Defined in: [WAProto/index.d.ts:4618](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4618)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`HydratedTemplateButton`](/docs/api/namespaces/proto/classes/HydratedTemplateButton)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4621](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4621)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4619](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4619)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`HydratedTemplateButton`](/docs/api/namespaces/proto/classes/HydratedTemplateButton)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-identitykeypairstructure"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/IdentityKeyPairStructure](https://baileys.wiki/docs/api/namespaces/proto/classes/IdentityKeyPairStructure)

Defined in: [WAProto/index.d.ts:4699](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4699)

## Implements[​](#implements "Direct link to Implements")

*   [`IIdentityKeyPairStructure`](/docs/api/namespaces/proto/interfaces/IIdentityKeyPairStructure)

## Constructors[​](#constructors "Direct link to Constructors")

### new IdentityKeyPairStructure()[​](#new-identitykeypairstructure "Direct link to new IdentityKeyPairStructure()")

> **new IdentityKeyPairStructure**(`p`?): [`IdentityKeyPairStructure`](/docs/api/namespaces/proto/classes/IdentityKeyPairStructure)

Defined in: [WAProto/index.d.ts:4700](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4700)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IIdentityKeyPairStructure`](/docs/api/namespaces/proto/interfaces/IIdentityKeyPairStructure)

#### Returns[​](#returns "Direct link to Returns")

[`IdentityKeyPairStructure`](/docs/api/namespaces/proto/classes/IdentityKeyPairStructure)

## Properties[​](#properties "Direct link to Properties")

### privateKey?[​](#privatekey "Direct link to privateKey?")

> `optional` **privateKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4702](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4702)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IIdentityKeyPairStructure`](/docs/api/namespaces/proto/interfaces/IIdentityKeyPairStructure).[`privateKey`](/docs/api/namespaces/proto/interfaces/IIdentityKeyPairStructure#privatekey)

* * *

### publicKey?[​](#publickey "Direct link to publicKey?")

> `optional` **publicKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4701](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4701)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IIdentityKeyPairStructure`](/docs/api/namespaces/proto/interfaces/IIdentityKeyPairStructure).[`publicKey`](/docs/api/namespaces/proto/interfaces/IIdentityKeyPairStructure#publickey)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4708](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4708)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`IdentityKeyPairStructure`](/docs/api/namespaces/proto/classes/IdentityKeyPairStructure)

Defined in: [WAProto/index.d.ts:4703](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4703)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IIdentityKeyPairStructure`](/docs/api/namespaces/proto/interfaces/IIdentityKeyPairStructure)

#### Returns[​](#returns-2 "Direct link to Returns")

[`IdentityKeyPairStructure`](/docs/api/namespaces/proto/classes/IdentityKeyPairStructure)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`IdentityKeyPairStructure`](/docs/api/namespaces/proto/classes/IdentityKeyPairStructure)

Defined in: [WAProto/index.d.ts:4705](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4705)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`IdentityKeyPairStructure`](/docs/api/namespaces/proto/classes/IdentityKeyPairStructure)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4704](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4704)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IIdentityKeyPairStructure`](/docs/api/namespaces/proto/interfaces/IIdentityKeyPairStructure)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`IdentityKeyPairStructure`](/docs/api/namespaces/proto/classes/IdentityKeyPairStructure)

Defined in: [WAProto/index.d.ts:4706](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4706)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`IdentityKeyPairStructure`](/docs/api/namespaces/proto/classes/IdentityKeyPairStructure)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4709](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4709)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4707](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4707)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`IdentityKeyPairStructure`](/docs/api/namespaces/proto/classes/IdentityKeyPairStructure)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-inthreadsurveymetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/InThreadSurveyMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/InThreadSurveyMetadata)

Defined in: [WAProto/index.d.ts:4732](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4732)

## Implements[​](#implements "Direct link to Implements")

*   [`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new InThreadSurveyMetadata()[​](#new-inthreadsurveymetadata "Direct link to new InThreadSurveyMetadata()")

> **new InThreadSurveyMetadata**(`p`?): [`InThreadSurveyMetadata`](/docs/api/namespaces/proto/classes/InThreadSurveyMetadata)

Defined in: [WAProto/index.d.ts:4733](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4733)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`InThreadSurveyMetadata`](/docs/api/namespaces/proto/classes/InThreadSurveyMetadata)

## Properties[​](#properties "Direct link to Properties")

### feedbackToastText?[​](#feedbacktoasttext "Direct link to feedbackToastText?")

> `optional` **feedbackToastText**: `null` | `string`

Defined in: [WAProto/index.d.ts:4750](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4750)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata).[`feedbackToastText`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata#feedbacktoasttext)

* * *

### invitationBodyText?[​](#invitationbodytext "Direct link to invitationBodyText?")

> `optional` **invitationBodyText**: `null` | `string`

Defined in: [WAProto/index.d.ts:4741](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4741)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata).[`invitationBodyText`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata#invitationbodytext)

* * *

### invitationCtaText?[​](#invitationctatext "Direct link to invitationCtaText?")

> `optional` **invitationCtaText**: `null` | `string`

Defined in: [WAProto/index.d.ts:4742](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4742)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata).[`invitationCtaText`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata#invitationctatext)

* * *

### invitationCtaUrl?[​](#invitationctaurl "Direct link to invitationCtaUrl?")

> `optional` **invitationCtaUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:4743](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4743)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata).[`invitationCtaUrl`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata#invitationctaurl)

* * *

### invitationHeaderText?[​](#invitationheadertext "Direct link to invitationHeaderText?")

> `optional` **invitationHeaderText**: `null` | `string`

Defined in: [WAProto/index.d.ts:4740](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4740)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata).[`invitationHeaderText`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata#invitationheadertext)

* * *

### privacyStatementFull?[​](#privacystatementfull "Direct link to privacyStatementFull?")

> `optional` **privacyStatementFull**: `null` | `string`

Defined in: [WAProto/index.d.ts:4748](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4748)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata).[`privacyStatementFull`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata#privacystatementfull)

* * *

### privacyStatementParts[​](#privacystatementparts "Direct link to privacyStatementParts")

> **privacyStatementParts**: [`IInThreadSurveyPrivacyStatementPart`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyPrivacyStatementPart)\[\]

Defined in: [WAProto/index.d.ts:4749](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4749)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata).[`privacyStatementParts`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata#privacystatementparts)

* * *

### questions[​](#questions "Direct link to questions")

> **questions**: [`IInThreadSurveyQuestion`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyQuestion)\[\]

Defined in: [WAProto/index.d.ts:4745](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4745)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata).[`questions`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata#questions)

* * *

### requestId?[​](#requestid "Direct link to requestId?")

> `optional` **requestId**: `null` | `string`

Defined in: [WAProto/index.d.ts:4738](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4738)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata).[`requestId`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata#requestid)

* * *

### simonSessionId?[​](#simonsessionid "Direct link to simonSessionId?")

> `optional` **simonSessionId**: `null` | `string`

Defined in: [WAProto/index.d.ts:4735](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4735)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata).[`simonSessionId`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata#simonsessionid)

* * *

### simonSurveyId?[​](#simonsurveyid "Direct link to simonSurveyId?")

> `optional` **simonSurveyId**: `null` | `string`

Defined in: [WAProto/index.d.ts:4736](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4736)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata).[`simonSurveyId`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata#simonsurveyid)

* * *

### surveyContinueButtonText?[​](#surveycontinuebuttontext "Direct link to surveyContinueButtonText?")

> `optional` **surveyContinueButtonText**: `null` | `string`

Defined in: [WAProto/index.d.ts:4746](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4746)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata).[`surveyContinueButtonText`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata#surveycontinuebuttontext)

* * *

### surveySubmitButtonText?[​](#surveysubmitbuttontext "Direct link to surveySubmitButtonText?")

> `optional` **surveySubmitButtonText**: `null` | `string`

Defined in: [WAProto/index.d.ts:4747](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4747)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata).[`surveySubmitButtonText`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata#surveysubmitbuttontext)

* * *

### surveyTitle?[​](#surveytitle "Direct link to surveyTitle?")

> `optional` **surveyTitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:4744](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4744)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata).[`surveyTitle`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata#surveytitle)

* * *

### tessaEvent?[​](#tessaevent "Direct link to tessaEvent?")

> `optional` **tessaEvent**: `null` | `string`

Defined in: [WAProto/index.d.ts:4739](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4739)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata).[`tessaEvent`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata#tessaevent)

* * *

### tessaRootId?[​](#tessarootid "Direct link to tessaRootId?")

> `optional` **tessaRootId**: `null` | `string`

Defined in: [WAProto/index.d.ts:4737](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4737)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata).[`tessaRootId`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata#tessarootid)

* * *

### tessaSessionId?[​](#tessasessionid "Direct link to tessaSessionId?")

> `optional` **tessaSessionId**: `null` | `string`

Defined in: [WAProto/index.d.ts:4734](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4734)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata).[`tessaSessionId`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata#tessasessionid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4756](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4756)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`InThreadSurveyMetadata`](/docs/api/namespaces/proto/classes/InThreadSurveyMetadata)

Defined in: [WAProto/index.d.ts:4751](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4751)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`InThreadSurveyMetadata`](/docs/api/namespaces/proto/classes/InThreadSurveyMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`InThreadSurveyMetadata`](/docs/api/namespaces/proto/classes/InThreadSurveyMetadata)

Defined in: [WAProto/index.d.ts:4753](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4753)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`InThreadSurveyMetadata`](/docs/api/namespaces/proto/classes/InThreadSurveyMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4752](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4752)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`InThreadSurveyMetadata`](/docs/api/namespaces/proto/classes/InThreadSurveyMetadata)

Defined in: [WAProto/index.d.ts:4754](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4754)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`InThreadSurveyMetadata`](/docs/api/namespaces/proto/classes/InThreadSurveyMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4757](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4757)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4755](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4755)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`InThreadSurveyMetadata`](/docs/api/namespaces/proto/classes/InThreadSurveyMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-interactiveannotation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/InteractiveAnnotation](https://baileys.wiki/docs/api/namespaces/proto/classes/InteractiveAnnotation)

Defined in: [WAProto/index.d.ts:4832](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4832)

## Implements[​](#implements "Direct link to Implements")

*   [`IInteractiveAnnotation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation)

## Constructors[​](#constructors "Direct link to Constructors")

### new InteractiveAnnotation()[​](#new-interactiveannotation "Direct link to new InteractiveAnnotation()")

> **new InteractiveAnnotation**(`p`?): [`InteractiveAnnotation`](/docs/api/namespaces/proto/classes/InteractiveAnnotation)

Defined in: [WAProto/index.d.ts:4833](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4833)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IInteractiveAnnotation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation)

#### Returns[​](#returns "Direct link to Returns")

[`InteractiveAnnotation`](/docs/api/namespaces/proto/classes/InteractiveAnnotation)

## Properties[​](#properties "Direct link to Properties")

### action?[​](#action "Direct link to action?")

> `optional` **action**: `"location"` | `"newsletter"` | `"embeddedAction"` | `"tapAction"`

Defined in: [WAProto/index.d.ts:4842](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4842)

* * *

### embeddedAction?[​](#embeddedaction "Direct link to embeddedAction?")

> `optional` **embeddedAction**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4840](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4840)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IInteractiveAnnotation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation).[`embeddedAction`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation#embeddedaction)

* * *

### embeddedContent?[​](#embeddedcontent "Direct link to embeddedContent?")

> `optional` **embeddedContent**: `null` | [`IEmbeddedContent`](/docs/api/namespaces/proto/interfaces/IEmbeddedContent)

Defined in: [WAProto/index.d.ts:4836](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4836)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IInteractiveAnnotation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation).[`embeddedContent`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation#embeddedcontent)

* * *

### location?[​](#location "Direct link to location?")

> `optional` **location**: `null` | [`ILocation`](/docs/api/namespaces/proto/interfaces/ILocation)

Defined in: [WAProto/index.d.ts:4838](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4838)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IInteractiveAnnotation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation).[`location`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation#location)

* * *

### newsletter?[​](#newsletter "Direct link to newsletter?")

> `optional` **newsletter**: `null` | [`IForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo)

Defined in: [WAProto/index.d.ts:4839](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4839)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IInteractiveAnnotation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation).[`newsletter`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation#newsletter)

* * *

### polygonVertices[​](#polygonvertices "Direct link to polygonVertices")

> **polygonVertices**: [`IPoint`](/docs/api/namespaces/proto/interfaces/IPoint)\[\]

Defined in: [WAProto/index.d.ts:4834](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4834)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IInteractiveAnnotation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation).[`polygonVertices`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation#polygonvertices)

* * *

### shouldSkipConfirmation?[​](#shouldskipconfirmation "Direct link to shouldSkipConfirmation?")

> `optional` **shouldSkipConfirmation**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4835](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4835)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IInteractiveAnnotation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation).[`shouldSkipConfirmation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation#shouldskipconfirmation)

* * *

### statusLinkType?[​](#statuslinktype "Direct link to statusLinkType?")

> `optional` **statusLinkType**: `null` | [`StatusLinkType`](/docs/api/namespaces/proto/namespaces/InteractiveAnnotation/enumerations/StatusLinkType)

Defined in: [WAProto/index.d.ts:4837](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4837)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IInteractiveAnnotation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation).[`statusLinkType`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation#statuslinktype)

* * *

### tapAction?[​](#tapaction "Direct link to tapAction?")

> `optional` **tapAction**: `null` | [`ITapLinkAction`](/docs/api/namespaces/proto/interfaces/ITapLinkAction)

Defined in: [WAProto/index.d.ts:4841](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4841)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IInteractiveAnnotation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation).[`tapAction`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation#tapaction)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4848](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4848)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`InteractiveAnnotation`](/docs/api/namespaces/proto/classes/InteractiveAnnotation)

Defined in: [WAProto/index.d.ts:4843](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4843)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IInteractiveAnnotation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation)

#### Returns[​](#returns-2 "Direct link to Returns")

[`InteractiveAnnotation`](/docs/api/namespaces/proto/classes/InteractiveAnnotation)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`InteractiveAnnotation`](/docs/api/namespaces/proto/classes/InteractiveAnnotation)

Defined in: [WAProto/index.d.ts:4845](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4845)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`InteractiveAnnotation`](/docs/api/namespaces/proto/classes/InteractiveAnnotation)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4844](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4844)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IInteractiveAnnotation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`InteractiveAnnotation`](/docs/api/namespaces/proto/classes/InteractiveAnnotation)

Defined in: [WAProto/index.d.ts:4846](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4846)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`InteractiveAnnotation`](/docs/api/namespaces/proto/classes/InteractiveAnnotation)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4849](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4849)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4847](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4847)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`InteractiveAnnotation`](/docs/api/namespaces/proto/classes/InteractiveAnnotation)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-interactivemessageadditionalmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/InteractiveMessageAdditionalMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/InteractiveMessageAdditionalMetadata)

Defined in: [WAProto/index.d.ts:4865](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4865)

## Implements[​](#implements "Direct link to Implements")

*   [`IInteractiveMessageAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IInteractiveMessageAdditionalMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new InteractiveMessageAdditionalMetadata()[​](#new-interactivemessageadditionalmetadata "Direct link to new InteractiveMessageAdditionalMetadata()")

> **new InteractiveMessageAdditionalMetadata**(`p`?): [`InteractiveMessageAdditionalMetadata`](/docs/api/namespaces/proto/classes/InteractiveMessageAdditionalMetadata)

Defined in: [WAProto/index.d.ts:4866](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4866)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IInteractiveMessageAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IInteractiveMessageAdditionalMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`InteractiveMessageAdditionalMetadata`](/docs/api/namespaces/proto/classes/InteractiveMessageAdditionalMetadata)

## Properties[​](#properties "Direct link to Properties")

### isGalaxyFlowCompleted?[​](#isgalaxyflowcompleted "Direct link to isGalaxyFlowCompleted?")

> `optional` **isGalaxyFlowCompleted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4867](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4867)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IInteractiveMessageAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IInteractiveMessageAdditionalMetadata).[`isGalaxyFlowCompleted`](/docs/api/namespaces/proto/interfaces/IInteractiveMessageAdditionalMetadata#isgalaxyflowcompleted)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4873](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4873)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`InteractiveMessageAdditionalMetadata`](/docs/api/namespaces/proto/classes/InteractiveMessageAdditionalMetadata)

Defined in: [WAProto/index.d.ts:4868](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4868)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IInteractiveMessageAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IInteractiveMessageAdditionalMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`InteractiveMessageAdditionalMetadata`](/docs/api/namespaces/proto/classes/InteractiveMessageAdditionalMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`InteractiveMessageAdditionalMetadata`](/docs/api/namespaces/proto/classes/InteractiveMessageAdditionalMetadata)

Defined in: [WAProto/index.d.ts:4870](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4870)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`InteractiveMessageAdditionalMetadata`](/docs/api/namespaces/proto/classes/InteractiveMessageAdditionalMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4869](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4869)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IInteractiveMessageAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IInteractiveMessageAdditionalMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`InteractiveMessageAdditionalMetadata`](/docs/api/namespaces/proto/classes/InteractiveMessageAdditionalMetadata)

Defined in: [WAProto/index.d.ts:4871](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4871)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`InteractiveMessageAdditionalMetadata`](/docs/api/namespaces/proto/classes/InteractiveMessageAdditionalMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4874](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4874)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4872](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4872)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`InteractiveMessageAdditionalMetadata`](/docs/api/namespaces/proto/classes/InteractiveMessageAdditionalMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-keepinchat"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/KeepInChat](https://baileys.wiki/docs/api/namespaces/proto/classes/KeepInChat)

Defined in: [WAProto/index.d.ts:4886](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4886)

## Implements[​](#implements "Direct link to Implements")

*   [`IKeepInChat`](/docs/api/namespaces/proto/interfaces/IKeepInChat)

## Constructors[​](#constructors "Direct link to Constructors")

### new KeepInChat()[​](#new-keepinchat "Direct link to new KeepInChat()")

> **new KeepInChat**(`p`?): [`KeepInChat`](/docs/api/namespaces/proto/classes/KeepInChat)

Defined in: [WAProto/index.d.ts:4887](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4887)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IKeepInChat`](/docs/api/namespaces/proto/interfaces/IKeepInChat)

#### Returns[​](#returns "Direct link to Returns")

[`KeepInChat`](/docs/api/namespaces/proto/classes/KeepInChat)

## Properties[​](#properties "Direct link to Properties")

### clientTimestampMs?[​](#clienttimestampms "Direct link to clientTimestampMs?")

> `optional` **clientTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4892](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4892)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IKeepInChat`](/docs/api/namespaces/proto/interfaces/IKeepInChat).[`clientTimestampMs`](/docs/api/namespaces/proto/interfaces/IKeepInChat#clienttimestampms)

* * *

### deviceJid?[​](#devicejid "Direct link to deviceJid?")

> `optional` **deviceJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:4891](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4891)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IKeepInChat`](/docs/api/namespaces/proto/interfaces/IKeepInChat).[`deviceJid`](/docs/api/namespaces/proto/interfaces/IKeepInChat#devicejid)

* * *

### keepType?[​](#keeptype "Direct link to keepType?")

> `optional` **keepType**: `null` | [`KeepType`](/docs/api/namespaces/proto/enumerations/KeepType)

Defined in: [WAProto/index.d.ts:4888](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4888)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IKeepInChat`](/docs/api/namespaces/proto/interfaces/IKeepInChat).[`keepType`](/docs/api/namespaces/proto/interfaces/IKeepInChat#keeptype)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:4890](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4890)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IKeepInChat`](/docs/api/namespaces/proto/interfaces/IKeepInChat).[`key`](/docs/api/namespaces/proto/interfaces/IKeepInChat#key)

* * *

### serverTimestamp?[​](#servertimestamp "Direct link to serverTimestamp?")

> `optional` **serverTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4889](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4889)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IKeepInChat`](/docs/api/namespaces/proto/interfaces/IKeepInChat).[`serverTimestamp`](/docs/api/namespaces/proto/interfaces/IKeepInChat#servertimestamp)

* * *

### serverTimestampMs?[​](#servertimestampms "Direct link to serverTimestampMs?")

> `optional` **serverTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4893](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4893)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IKeepInChat`](/docs/api/namespaces/proto/interfaces/IKeepInChat).[`serverTimestampMs`](/docs/api/namespaces/proto/interfaces/IKeepInChat#servertimestampms)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4899](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4899)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`KeepInChat`](/docs/api/namespaces/proto/classes/KeepInChat)

Defined in: [WAProto/index.d.ts:4894](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4894)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IKeepInChat`](/docs/api/namespaces/proto/interfaces/IKeepInChat)

#### Returns[​](#returns-2 "Direct link to Returns")

[`KeepInChat`](/docs/api/namespaces/proto/classes/KeepInChat)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`KeepInChat`](/docs/api/namespaces/proto/classes/KeepInChat)

Defined in: [WAProto/index.d.ts:4896](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4896)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`KeepInChat`](/docs/api/namespaces/proto/classes/KeepInChat)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4895](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4895)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IKeepInChat`](/docs/api/namespaces/proto/interfaces/IKeepInChat)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`KeepInChat`](/docs/api/namespaces/proto/classes/KeepInChat)

Defined in: [WAProto/index.d.ts:4897](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4897)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`KeepInChat`](/docs/api/namespaces/proto/classes/KeepInChat)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4900](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4900)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4898](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4898)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`KeepInChat`](/docs/api/namespaces/proto/classes/KeepInChat)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-keyexchangemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/KeyExchangeMessage](https://baileys.wiki/docs/api/namespaces/proto/classes/KeyExchangeMessage)

Defined in: [WAProto/index.d.ts:4917](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4917)

## Implements[​](#implements "Direct link to Implements")

*   [`IKeyExchangeMessage`](/docs/api/namespaces/proto/interfaces/IKeyExchangeMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new KeyExchangeMessage()[​](#new-keyexchangemessage "Direct link to new KeyExchangeMessage()")

> **new KeyExchangeMessage**(`p`?): [`KeyExchangeMessage`](/docs/api/namespaces/proto/classes/KeyExchangeMessage)

Defined in: [WAProto/index.d.ts:4918](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4918)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IKeyExchangeMessage`](/docs/api/namespaces/proto/interfaces/IKeyExchangeMessage)

#### Returns[​](#returns "Direct link to Returns")

[`KeyExchangeMessage`](/docs/api/namespaces/proto/classes/KeyExchangeMessage)

## Properties[​](#properties "Direct link to Properties")

### baseKey?[​](#basekey "Direct link to baseKey?")

> `optional` **baseKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4920](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4920)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IKeyExchangeMessage`](/docs/api/namespaces/proto/interfaces/IKeyExchangeMessage).[`baseKey`](/docs/api/namespaces/proto/interfaces/IKeyExchangeMessage#basekey)

* * *

### baseKeySignature?[​](#basekeysignature "Direct link to baseKeySignature?")

> `optional` **baseKeySignature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4923](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4923)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IKeyExchangeMessage`](/docs/api/namespaces/proto/interfaces/IKeyExchangeMessage).[`baseKeySignature`](/docs/api/namespaces/proto/interfaces/IKeyExchangeMessage#basekeysignature)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `number`

Defined in: [WAProto/index.d.ts:4919](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4919)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IKeyExchangeMessage`](/docs/api/namespaces/proto/interfaces/IKeyExchangeMessage).[`id`](/docs/api/namespaces/proto/interfaces/IKeyExchangeMessage#id)

* * *

### identityKey?[​](#identitykey "Direct link to identityKey?")

> `optional` **identityKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4922](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4922)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IKeyExchangeMessage`](/docs/api/namespaces/proto/interfaces/IKeyExchangeMessage).[`identityKey`](/docs/api/namespaces/proto/interfaces/IKeyExchangeMessage#identitykey)

* * *

### ratchetKey?[​](#ratchetkey "Direct link to ratchetKey?")

> `optional` **ratchetKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4921](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4921)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IKeyExchangeMessage`](/docs/api/namespaces/proto/interfaces/IKeyExchangeMessage).[`ratchetKey`](/docs/api/namespaces/proto/interfaces/IKeyExchangeMessage#ratchetkey)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4929](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4929)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`KeyExchangeMessage`](/docs/api/namespaces/proto/classes/KeyExchangeMessage)

Defined in: [WAProto/index.d.ts:4924](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4924)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IKeyExchangeMessage`](/docs/api/namespaces/proto/interfaces/IKeyExchangeMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`KeyExchangeMessage`](/docs/api/namespaces/proto/classes/KeyExchangeMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`KeyExchangeMessage`](/docs/api/namespaces/proto/classes/KeyExchangeMessage)

Defined in: [WAProto/index.d.ts:4926](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4926)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`KeyExchangeMessage`](/docs/api/namespaces/proto/classes/KeyExchangeMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4925](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4925)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IKeyExchangeMessage`](/docs/api/namespaces/proto/interfaces/IKeyExchangeMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`KeyExchangeMessage`](/docs/api/namespaces/proto/classes/KeyExchangeMessage)

Defined in: [WAProto/index.d.ts:4927](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4927)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`KeyExchangeMessage`](/docs/api/namespaces/proto/classes/KeyExchangeMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4930](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4930)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4928](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4928)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`KeyExchangeMessage`](/docs/api/namespaces/proto/classes/KeyExchangeMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-keyid"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/KeyId](https://baileys.wiki/docs/api/namespaces/proto/classes/KeyId)

Defined in: [WAProto/index.d.ts:4937](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4937)

## Implements[​](#implements "Direct link to Implements")

*   [`IKeyId`](/docs/api/namespaces/proto/interfaces/IKeyId)

## Constructors[​](#constructors "Direct link to Constructors")

### new KeyId()[​](#new-keyid "Direct link to new KeyId()")

> **new KeyId**(`p`?): [`KeyId`](/docs/api/namespaces/proto/classes/KeyId)

Defined in: [WAProto/index.d.ts:4938](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4938)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IKeyId`](/docs/api/namespaces/proto/interfaces/IKeyId)

#### Returns[​](#returns "Direct link to Returns")

[`KeyId`](/docs/api/namespaces/proto/classes/KeyId)

## Properties[​](#properties "Direct link to Properties")

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4939](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4939)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IKeyId`](/docs/api/namespaces/proto/interfaces/IKeyId).[`id`](/docs/api/namespaces/proto/interfaces/IKeyId#id)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4945](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4945)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`KeyId`](/docs/api/namespaces/proto/classes/KeyId)

Defined in: [WAProto/index.d.ts:4940](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4940)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IKeyId`](/docs/api/namespaces/proto/interfaces/IKeyId)

#### Returns[​](#returns-2 "Direct link to Returns")

[`KeyId`](/docs/api/namespaces/proto/classes/KeyId)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`KeyId`](/docs/api/namespaces/proto/classes/KeyId)

Defined in: [WAProto/index.d.ts:4942](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4942)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`KeyId`](/docs/api/namespaces/proto/classes/KeyId)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4941](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4941)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IKeyId`](/docs/api/namespaces/proto/interfaces/IKeyId)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`KeyId`](/docs/api/namespaces/proto/classes/KeyId)

Defined in: [WAProto/index.d.ts:4943](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4943)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`KeyId`](/docs/api/namespaces/proto/classes/KeyId)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4946](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4946)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4944](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4944)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`KeyId`](/docs/api/namespaces/proto/classes/KeyId)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-lidmigrationmapping"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/LIDMigrationMapping](https://baileys.wiki/docs/api/namespaces/proto/classes/LIDMigrationMapping)

Defined in: [WAProto/index.d.ts:4955](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4955)

## Implements[​](#implements "Direct link to Implements")

*   [`ILIDMigrationMapping`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMapping)

## Constructors[​](#constructors "Direct link to Constructors")

### new LIDMigrationMapping()[​](#new-lidmigrationmapping "Direct link to new LIDMigrationMapping()")

> **new LIDMigrationMapping**(`p`?): [`LIDMigrationMapping`](/docs/api/namespaces/proto/classes/LIDMigrationMapping)

Defined in: [WAProto/index.d.ts:4956](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4956)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ILIDMigrationMapping`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMapping)

#### Returns[​](#returns "Direct link to Returns")

[`LIDMigrationMapping`](/docs/api/namespaces/proto/classes/LIDMigrationMapping)

## Properties[​](#properties "Direct link to Properties")

### assignedLid[​](#assignedlid "Direct link to assignedLid")

> **assignedLid**: `number` | `Long`

Defined in: [WAProto/index.d.ts:4958](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4958)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILIDMigrationMapping`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMapping).[`assignedLid`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMapping#assignedlid)

* * *

### latestLid?[​](#latestlid "Direct link to latestLid?")

> `optional` **latestLid**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4959](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4959)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ILIDMigrationMapping`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMapping).[`latestLid`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMapping#latestlid)

* * *

### pn[​](#pn "Direct link to pn")

> **pn**: `number` | `Long`

Defined in: [WAProto/index.d.ts:4957](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4957)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ILIDMigrationMapping`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMapping).[`pn`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMapping#pn)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4965](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4965)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`LIDMigrationMapping`](/docs/api/namespaces/proto/classes/LIDMigrationMapping)

Defined in: [WAProto/index.d.ts:4960](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4960)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ILIDMigrationMapping`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMapping)

#### Returns[​](#returns-2 "Direct link to Returns")

[`LIDMigrationMapping`](/docs/api/namespaces/proto/classes/LIDMigrationMapping)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`LIDMigrationMapping`](/docs/api/namespaces/proto/classes/LIDMigrationMapping)

Defined in: [WAProto/index.d.ts:4962](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4962)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`LIDMigrationMapping`](/docs/api/namespaces/proto/classes/LIDMigrationMapping)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4961](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4961)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ILIDMigrationMapping`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMapping)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`LIDMigrationMapping`](/docs/api/namespaces/proto/classes/LIDMigrationMapping)

Defined in: [WAProto/index.d.ts:4963](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4963)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`LIDMigrationMapping`](/docs/api/namespaces/proto/classes/LIDMigrationMapping)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4966](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4966)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4964](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4964)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`LIDMigrationMapping`](/docs/api/namespaces/proto/classes/LIDMigrationMapping)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-lidmigrationmappingsyncmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncMessage](https://baileys.wiki/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncMessage)

Defined in: [WAProto/index.d.ts:4973](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4973)

## Implements[​](#implements "Direct link to Implements")

*   [`ILIDMigrationMappingSyncMessage`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new LIDMigrationMappingSyncMessage()[​](#new-lidmigrationmappingsyncmessage "Direct link to new LIDMigrationMappingSyncMessage()")

> **new LIDMigrationMappingSyncMessage**(`p`?): [`LIDMigrationMappingSyncMessage`](/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncMessage)

Defined in: [WAProto/index.d.ts:4974](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4974)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ILIDMigrationMappingSyncMessage`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncMessage)

#### Returns[​](#returns "Direct link to Returns")

[`LIDMigrationMappingSyncMessage`](/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncMessage)

## Properties[​](#properties "Direct link to Properties")

### encodedMappingPayload?[​](#encodedmappingpayload "Direct link to encodedMappingPayload?")

> `optional` **encodedMappingPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4975](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4975)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILIDMigrationMappingSyncMessage`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncMessage).[`encodedMappingPayload`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncMessage#encodedmappingpayload)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4981](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4981)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`LIDMigrationMappingSyncMessage`](/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncMessage)

Defined in: [WAProto/index.d.ts:4976](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4976)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ILIDMigrationMappingSyncMessage`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`LIDMigrationMappingSyncMessage`](/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`LIDMigrationMappingSyncMessage`](/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncMessage)

Defined in: [WAProto/index.d.ts:4978](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4978)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`LIDMigrationMappingSyncMessage`](/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4977](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4977)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ILIDMigrationMappingSyncMessage`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`LIDMigrationMappingSyncMessage`](/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncMessage)

Defined in: [WAProto/index.d.ts:4979](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4979)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`LIDMigrationMappingSyncMessage`](/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4982](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4982)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4980](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4980)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`LIDMigrationMappingSyncMessage`](/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-lidmigrationmappingsyncpayload"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncPayload](https://baileys.wiki/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncPayload)

Defined in: [WAProto/index.d.ts:4990](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4990)

## Implements[​](#implements "Direct link to Implements")

*   [`ILIDMigrationMappingSyncPayload`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncPayload)

## Constructors[​](#constructors "Direct link to Constructors")

### new LIDMigrationMappingSyncPayload()[​](#new-lidmigrationmappingsyncpayload "Direct link to new LIDMigrationMappingSyncPayload()")

> **new LIDMigrationMappingSyncPayload**(`p`?): [`LIDMigrationMappingSyncPayload`](/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncPayload)

Defined in: [WAProto/index.d.ts:4991](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4991)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ILIDMigrationMappingSyncPayload`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncPayload)

#### Returns[​](#returns "Direct link to Returns")

[`LIDMigrationMappingSyncPayload`](/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncPayload)

## Properties[​](#properties "Direct link to Properties")

### chatDbMigrationTimestamp?[​](#chatdbmigrationtimestamp "Direct link to chatDbMigrationTimestamp?")

> `optional` **chatDbMigrationTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4993](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4993)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILIDMigrationMappingSyncPayload`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncPayload).[`chatDbMigrationTimestamp`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncPayload#chatdbmigrationtimestamp)

* * *

### pnToLidMappings[​](#pntolidmappings "Direct link to pnToLidMappings")

> **pnToLidMappings**: [`ILIDMigrationMapping`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMapping)\[\]

Defined in: [WAProto/index.d.ts:4992](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4992)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ILIDMigrationMappingSyncPayload`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncPayload).[`pnToLidMappings`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncPayload#pntolidmappings)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4999](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4999)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`LIDMigrationMappingSyncPayload`](/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncPayload)

Defined in: [WAProto/index.d.ts:4994](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4994)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ILIDMigrationMappingSyncPayload`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncPayload)

#### Returns[​](#returns-2 "Direct link to Returns")

[`LIDMigrationMappingSyncPayload`](/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncPayload)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`LIDMigrationMappingSyncPayload`](/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncPayload)

Defined in: [WAProto/index.d.ts:4996](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4996)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`LIDMigrationMappingSyncPayload`](/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncPayload)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4995](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4995)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ILIDMigrationMappingSyncPayload`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncPayload)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`LIDMigrationMappingSyncPayload`](/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncPayload)

Defined in: [WAProto/index.d.ts:4997](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4997)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`LIDMigrationMappingSyncPayload`](/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncPayload)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5000](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5000)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4998](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4998)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`LIDMigrationMappingSyncPayload`](/docs/api/namespaces/proto/classes/LIDMigrationMappingSyncPayload)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-legacymessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/LegacyMessage](https://baileys.wiki/docs/api/namespaces/proto/classes/LegacyMessage)

Defined in: [WAProto/index.d.ts:5008](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5008)

## Implements[​](#implements "Direct link to Implements")

*   [`ILegacyMessage`](/docs/api/namespaces/proto/interfaces/ILegacyMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new LegacyMessage()[​](#new-legacymessage "Direct link to new LegacyMessage()")

> **new LegacyMessage**(`p`?): [`LegacyMessage`](/docs/api/namespaces/proto/classes/LegacyMessage)

Defined in: [WAProto/index.d.ts:5009](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5009)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ILegacyMessage`](/docs/api/namespaces/proto/interfaces/ILegacyMessage)

#### Returns[​](#returns "Direct link to Returns")

[`LegacyMessage`](/docs/api/namespaces/proto/classes/LegacyMessage)

## Properties[​](#properties "Direct link to Properties")

### eventResponseMessage?[​](#eventresponsemessage "Direct link to eventResponseMessage?")

> `optional` **eventResponseMessage**: `null` | [`IEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventResponseMessage)

Defined in: [WAProto/index.d.ts:5010](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5010)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILegacyMessage`](/docs/api/namespaces/proto/interfaces/ILegacyMessage).[`eventResponseMessage`](/docs/api/namespaces/proto/interfaces/ILegacyMessage#eventresponsemessage)

* * *

### pollVote?[​](#pollvote "Direct link to pollVote?")

> `optional` **pollVote**: `null` | [`IPollVoteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollVoteMessage)

Defined in: [WAProto/index.d.ts:5011](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5011)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ILegacyMessage`](/docs/api/namespaces/proto/interfaces/ILegacyMessage).[`pollVote`](/docs/api/namespaces/proto/interfaces/ILegacyMessage#pollvote)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5017](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5017)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`LegacyMessage`](/docs/api/namespaces/proto/classes/LegacyMessage)

Defined in: [WAProto/index.d.ts:5012](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5012)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ILegacyMessage`](/docs/api/namespaces/proto/interfaces/ILegacyMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`LegacyMessage`](/docs/api/namespaces/proto/classes/LegacyMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`LegacyMessage`](/docs/api/namespaces/proto/classes/LegacyMessage)

Defined in: [WAProto/index.d.ts:5014](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5014)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`LegacyMessage`](/docs/api/namespaces/proto/classes/LegacyMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5013](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5013)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ILegacyMessage`](/docs/api/namespaces/proto/interfaces/ILegacyMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`LegacyMessage`](/docs/api/namespaces/proto/classes/LegacyMessage)

Defined in: [WAProto/index.d.ts:5015](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5015)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`LegacyMessage`](/docs/api/namespaces/proto/classes/LegacyMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5018](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5018)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5016](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5016)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`LegacyMessage`](/docs/api/namespaces/proto/classes/LegacyMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-limitsharing"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/LimitSharing](https://baileys.wiki/docs/api/namespaces/proto/classes/LimitSharing)

Defined in: [WAProto/index.d.ts:5028](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5028)

## Implements[​](#implements "Direct link to Implements")

*   [`ILimitSharing`](/docs/api/namespaces/proto/interfaces/ILimitSharing)

## Constructors[​](#constructors "Direct link to Constructors")

### new LimitSharing()[​](#new-limitsharing "Direct link to new LimitSharing()")

> **new LimitSharing**(`p`?): [`LimitSharing`](/docs/api/namespaces/proto/classes/LimitSharing)

Defined in: [WAProto/index.d.ts:5029](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5029)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ILimitSharing`](/docs/api/namespaces/proto/interfaces/ILimitSharing)

#### Returns[​](#returns "Direct link to Returns")

[`LimitSharing`](/docs/api/namespaces/proto/classes/LimitSharing)

## Properties[​](#properties "Direct link to Properties")

### initiatedByMe?[​](#initiatedbyme "Direct link to initiatedByMe?")

> `optional` **initiatedByMe**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:5033](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5033)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILimitSharing`](/docs/api/namespaces/proto/interfaces/ILimitSharing).[`initiatedByMe`](/docs/api/namespaces/proto/interfaces/ILimitSharing#initiatedbyme)

* * *

### limitSharingSettingTimestamp?[​](#limitsharingsettingtimestamp "Direct link to limitSharingSettingTimestamp?")

> `optional` **limitSharingSettingTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:5032](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5032)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ILimitSharing`](/docs/api/namespaces/proto/interfaces/ILimitSharing).[`limitSharingSettingTimestamp`](/docs/api/namespaces/proto/interfaces/ILimitSharing#limitsharingsettingtimestamp)

* * *

### sharingLimited?[​](#sharinglimited "Direct link to sharingLimited?")

> `optional` **sharingLimited**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:5030](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5030)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ILimitSharing`](/docs/api/namespaces/proto/interfaces/ILimitSharing).[`sharingLimited`](/docs/api/namespaces/proto/interfaces/ILimitSharing#sharinglimited)

* * *

### trigger?[​](#trigger "Direct link to trigger?")

> `optional` **trigger**: `null` | [`TriggerType`](/docs/api/namespaces/proto/namespaces/LimitSharing/enumerations/TriggerType)

Defined in: [WAProto/index.d.ts:5031](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5031)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ILimitSharing`](/docs/api/namespaces/proto/interfaces/ILimitSharing).[`trigger`](/docs/api/namespaces/proto/interfaces/ILimitSharing#trigger)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5039](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5039)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`LimitSharing`](/docs/api/namespaces/proto/classes/LimitSharing)

Defined in: [WAProto/index.d.ts:5034](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5034)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ILimitSharing`](/docs/api/namespaces/proto/interfaces/ILimitSharing)

#### Returns[​](#returns-2 "Direct link to Returns")

[`LimitSharing`](/docs/api/namespaces/proto/classes/LimitSharing)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`LimitSharing`](/docs/api/namespaces/proto/classes/LimitSharing)

Defined in: [WAProto/index.d.ts:5036](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5036)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`LimitSharing`](/docs/api/namespaces/proto/classes/LimitSharing)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5035](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5035)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ILimitSharing`](/docs/api/namespaces/proto/interfaces/ILimitSharing)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`LimitSharing`](/docs/api/namespaces/proto/classes/LimitSharing)

Defined in: [WAProto/index.d.ts:5037](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5037)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`LimitSharing`](/docs/api/namespaces/proto/classes/LimitSharing)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5040](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5040)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5038](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5038)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`LimitSharing`](/docs/api/namespaces/proto/classes/LimitSharing)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-localizedname"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/LocalizedName](https://baileys.wiki/docs/api/namespaces/proto/classes/LocalizedName)

Defined in: [WAProto/index.d.ts:5059](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5059)

## Implements[​](#implements "Direct link to Implements")

*   [`ILocalizedName`](/docs/api/namespaces/proto/interfaces/ILocalizedName)

## Constructors[​](#constructors "Direct link to Constructors")

### new LocalizedName()[​](#new-localizedname "Direct link to new LocalizedName()")

> **new LocalizedName**(`p`?): [`LocalizedName`](/docs/api/namespaces/proto/classes/LocalizedName)

Defined in: [WAProto/index.d.ts:5060](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5060)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ILocalizedName`](/docs/api/namespaces/proto/interfaces/ILocalizedName)

#### Returns[​](#returns "Direct link to Returns")

[`LocalizedName`](/docs/api/namespaces/proto/classes/LocalizedName)

## Properties[​](#properties "Direct link to Properties")

### lc?[​](#lc "Direct link to lc?")

> `optional` **lc**: `null` | `string`

Defined in: [WAProto/index.d.ts:5062](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5062)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILocalizedName`](/docs/api/namespaces/proto/interfaces/ILocalizedName).[`lc`](/docs/api/namespaces/proto/interfaces/ILocalizedName#lc)

* * *

### lg?[​](#lg "Direct link to lg?")

> `optional` **lg**: `null` | `string`

Defined in: [WAProto/index.d.ts:5061](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5061)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ILocalizedName`](/docs/api/namespaces/proto/interfaces/ILocalizedName).[`lg`](/docs/api/namespaces/proto/interfaces/ILocalizedName#lg)

* * *

### verifiedName?[​](#verifiedname "Direct link to verifiedName?")

> `optional` **verifiedName**: `null` | `string`

Defined in: [WAProto/index.d.ts:5063](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5063)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ILocalizedName`](/docs/api/namespaces/proto/interfaces/ILocalizedName).[`verifiedName`](/docs/api/namespaces/proto/interfaces/ILocalizedName#verifiedname)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5069](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5069)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`LocalizedName`](/docs/api/namespaces/proto/classes/LocalizedName)

Defined in: [WAProto/index.d.ts:5064](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5064)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ILocalizedName`](/docs/api/namespaces/proto/interfaces/ILocalizedName)

#### Returns[​](#returns-2 "Direct link to Returns")

[`LocalizedName`](/docs/api/namespaces/proto/classes/LocalizedName)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`LocalizedName`](/docs/api/namespaces/proto/classes/LocalizedName)

Defined in: [WAProto/index.d.ts:5066](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5066)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`LocalizedName`](/docs/api/namespaces/proto/classes/LocalizedName)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5065](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5065)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ILocalizedName`](/docs/api/namespaces/proto/interfaces/ILocalizedName)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`LocalizedName`](/docs/api/namespaces/proto/classes/LocalizedName)

Defined in: [WAProto/index.d.ts:5067](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5067)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`LocalizedName`](/docs/api/namespaces/proto/classes/LocalizedName)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5070](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5070)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5068](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5068)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`LocalizedName`](/docs/api/namespaces/proto/classes/LocalizedName)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-location"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/Location](https://baileys.wiki/docs/api/namespaces/proto/classes/Location)

Defined in: [WAProto/index.d.ts:5079](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5079)

## Implements[​](#implements "Direct link to Implements")

*   [`ILocation`](/docs/api/namespaces/proto/interfaces/ILocation)

## Constructors[​](#constructors "Direct link to Constructors")

### new Location()[​](#new-location "Direct link to new Location()")

> **new Location**(`p`?): [`Location`](/docs/api/namespaces/proto/classes/Location)

Defined in: [WAProto/index.d.ts:5080](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5080)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ILocation`](/docs/api/namespaces/proto/interfaces/ILocation)

#### Returns[​](#returns "Direct link to Returns")

[`Location`](/docs/api/namespaces/proto/classes/Location)

## Properties[​](#properties "Direct link to Properties")

### degreesLatitude?[​](#degreeslatitude "Direct link to degreesLatitude?")

> `optional` **degreesLatitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:5081](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5081)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILocation`](/docs/api/namespaces/proto/interfaces/ILocation).[`degreesLatitude`](/docs/api/namespaces/proto/interfaces/ILocation#degreeslatitude)

* * *

### degreesLongitude?[​](#degreeslongitude "Direct link to degreesLongitude?")

> `optional` **degreesLongitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:5082](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5082)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ILocation`](/docs/api/namespaces/proto/interfaces/ILocation).[`degreesLongitude`](/docs/api/namespaces/proto/interfaces/ILocation#degreeslongitude)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:5083](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5083)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ILocation`](/docs/api/namespaces/proto/interfaces/ILocation).[`name`](/docs/api/namespaces/proto/interfaces/ILocation#name)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5089](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5089)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Location`](/docs/api/namespaces/proto/classes/Location)

Defined in: [WAProto/index.d.ts:5084](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5084)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ILocation`](/docs/api/namespaces/proto/interfaces/ILocation)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Location`](/docs/api/namespaces/proto/classes/Location)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Location`](/docs/api/namespaces/proto/classes/Location)

Defined in: [WAProto/index.d.ts:5086](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5086)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Location`](/docs/api/namespaces/proto/classes/Location)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5085](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5085)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ILocation`](/docs/api/namespaces/proto/interfaces/ILocation)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Location`](/docs/api/namespaces/proto/classes/Location)

Defined in: [WAProto/index.d.ts:5087](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5087)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Location`](/docs/api/namespaces/proto/classes/Location)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5090](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5090)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5088](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5088)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Location`](/docs/api/namespaces/proto/classes/Location)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-mediadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/MediaData](https://baileys.wiki/docs/api/namespaces/proto/classes/MediaData)

Defined in: [WAProto/index.d.ts:5097](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5097)

## Implements[​](#implements "Direct link to Implements")

*   [`IMediaData`](/docs/api/namespaces/proto/interfaces/IMediaData)

## Constructors[​](#constructors "Direct link to Constructors")

### new MediaData()[​](#new-mediadata "Direct link to new MediaData()")

> **new MediaData**(`p`?): [`MediaData`](/docs/api/namespaces/proto/classes/MediaData)

Defined in: [WAProto/index.d.ts:5098](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5098)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMediaData`](/docs/api/namespaces/proto/interfaces/IMediaData)

#### Returns[​](#returns "Direct link to Returns")

[`MediaData`](/docs/api/namespaces/proto/classes/MediaData)

## Properties[​](#properties "Direct link to Properties")

### localPath?[​](#localpath "Direct link to localPath?")

> `optional` **localPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:5099](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5099)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMediaData`](/docs/api/namespaces/proto/interfaces/IMediaData).[`localPath`](/docs/api/namespaces/proto/interfaces/IMediaData#localpath)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5105](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5105)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MediaData`](/docs/api/namespaces/proto/classes/MediaData)

Defined in: [WAProto/index.d.ts:5100](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5100)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMediaData`](/docs/api/namespaces/proto/interfaces/IMediaData)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MediaData`](/docs/api/namespaces/proto/classes/MediaData)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MediaData`](/docs/api/namespaces/proto/classes/MediaData)

Defined in: [WAProto/index.d.ts:5102](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5102)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MediaData`](/docs/api/namespaces/proto/classes/MediaData)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5101](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5101)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMediaData`](/docs/api/namespaces/proto/interfaces/IMediaData)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MediaData`](/docs/api/namespaces/proto/classes/MediaData)

Defined in: [WAProto/index.d.ts:5103](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5103)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MediaData`](/docs/api/namespaces/proto/classes/MediaData)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5106](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5106)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5104](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5104)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MediaData`](/docs/api/namespaces/proto/classes/MediaData)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-medianotifymessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/MediaNotifyMessage](https://baileys.wiki/docs/api/namespaces/proto/classes/MediaNotifyMessage)

Defined in: [WAProto/index.d.ts:5115](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5115)

## Implements[​](#implements "Direct link to Implements")

*   [`IMediaNotifyMessage`](/docs/api/namespaces/proto/interfaces/IMediaNotifyMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new MediaNotifyMessage()[​](#new-medianotifymessage "Direct link to new MediaNotifyMessage()")

> **new MediaNotifyMessage**(`p`?): [`MediaNotifyMessage`](/docs/api/namespaces/proto/classes/MediaNotifyMessage)

Defined in: [WAProto/index.d.ts:5116](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5116)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMediaNotifyMessage`](/docs/api/namespaces/proto/interfaces/IMediaNotifyMessage)

#### Returns[​](#returns "Direct link to Returns")

[`MediaNotifyMessage`](/docs/api/namespaces/proto/classes/MediaNotifyMessage)

## Properties[​](#properties "Direct link to Properties")

### expressPathUrl?[​](#expresspathurl "Direct link to expressPathUrl?")

> `optional` **expressPathUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:5117](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5117)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMediaNotifyMessage`](/docs/api/namespaces/proto/interfaces/IMediaNotifyMessage).[`expressPathUrl`](/docs/api/namespaces/proto/interfaces/IMediaNotifyMessage#expresspathurl)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5118](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5118)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMediaNotifyMessage`](/docs/api/namespaces/proto/interfaces/IMediaNotifyMessage).[`fileEncSha256`](/docs/api/namespaces/proto/interfaces/IMediaNotifyMessage#fileencsha256)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:5119](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5119)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMediaNotifyMessage`](/docs/api/namespaces/proto/interfaces/IMediaNotifyMessage).[`fileLength`](/docs/api/namespaces/proto/interfaces/IMediaNotifyMessage#filelength)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5125](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5125)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MediaNotifyMessage`](/docs/api/namespaces/proto/classes/MediaNotifyMessage)

Defined in: [WAProto/index.d.ts:5120](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5120)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMediaNotifyMessage`](/docs/api/namespaces/proto/interfaces/IMediaNotifyMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MediaNotifyMessage`](/docs/api/namespaces/proto/classes/MediaNotifyMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MediaNotifyMessage`](/docs/api/namespaces/proto/classes/MediaNotifyMessage)

Defined in: [WAProto/index.d.ts:5122](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5122)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MediaNotifyMessage`](/docs/api/namespaces/proto/classes/MediaNotifyMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5121](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5121)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMediaNotifyMessage`](/docs/api/namespaces/proto/interfaces/IMediaNotifyMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MediaNotifyMessage`](/docs/api/namespaces/proto/classes/MediaNotifyMessage)

Defined in: [WAProto/index.d.ts:5123](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5123)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MediaNotifyMessage`](/docs/api/namespaces/proto/classes/MediaNotifyMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5126](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5126)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5124](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5124)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MediaNotifyMessage`](/docs/api/namespaces/proto/classes/MediaNotifyMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-mediaretrynotification"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/MediaRetryNotification](https://baileys.wiki/docs/api/namespaces/proto/classes/MediaRetryNotification)

Defined in: [WAProto/index.d.ts:5136](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5136)

## Implements[​](#implements "Direct link to Implements")

*   [`IMediaRetryNotification`](/docs/api/namespaces/proto/interfaces/IMediaRetryNotification)

## Constructors[​](#constructors "Direct link to Constructors")

### new MediaRetryNotification()[​](#new-mediaretrynotification "Direct link to new MediaRetryNotification()")

> **new MediaRetryNotification**(`p`?): [`MediaRetryNotification`](/docs/api/namespaces/proto/classes/MediaRetryNotification)

Defined in: [WAProto/index.d.ts:5137](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5137)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMediaRetryNotification`](/docs/api/namespaces/proto/interfaces/IMediaRetryNotification)

#### Returns[​](#returns "Direct link to Returns")

[`MediaRetryNotification`](/docs/api/namespaces/proto/classes/MediaRetryNotification)

## Properties[​](#properties "Direct link to Properties")

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:5139](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5139)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMediaRetryNotification`](/docs/api/namespaces/proto/interfaces/IMediaRetryNotification).[`directPath`](/docs/api/namespaces/proto/interfaces/IMediaRetryNotification#directpath)

* * *

### messageSecret?[​](#messagesecret "Direct link to messageSecret?")

> `optional` **messageSecret**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5141](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5141)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMediaRetryNotification`](/docs/api/namespaces/proto/interfaces/IMediaRetryNotification).[`messageSecret`](/docs/api/namespaces/proto/interfaces/IMediaRetryNotification#messagesecret)

* * *

### result?[​](#result "Direct link to result?")

> `optional` **result**: `null` | [`ResultType`](/docs/api/namespaces/proto/namespaces/MediaRetryNotification/enumerations/ResultType)

Defined in: [WAProto/index.d.ts:5140](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5140)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMediaRetryNotification`](/docs/api/namespaces/proto/interfaces/IMediaRetryNotification).[`result`](/docs/api/namespaces/proto/interfaces/IMediaRetryNotification#result)

* * *

### stanzaId?[​](#stanzaid "Direct link to stanzaId?")

> `optional` **stanzaId**: `null` | `string`

Defined in: [WAProto/index.d.ts:5138](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5138)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IMediaRetryNotification`](/docs/api/namespaces/proto/interfaces/IMediaRetryNotification).[`stanzaId`](/docs/api/namespaces/proto/interfaces/IMediaRetryNotification#stanzaid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5147](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5147)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MediaRetryNotification`](/docs/api/namespaces/proto/classes/MediaRetryNotification)

Defined in: [WAProto/index.d.ts:5142](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5142)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMediaRetryNotification`](/docs/api/namespaces/proto/interfaces/IMediaRetryNotification)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MediaRetryNotification`](/docs/api/namespaces/proto/classes/MediaRetryNotification)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MediaRetryNotification`](/docs/api/namespaces/proto/classes/MediaRetryNotification)

Defined in: [WAProto/index.d.ts:5144](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5144)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MediaRetryNotification`](/docs/api/namespaces/proto/classes/MediaRetryNotification)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5143](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5143)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMediaRetryNotification`](/docs/api/namespaces/proto/interfaces/IMediaRetryNotification)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MediaRetryNotification`](/docs/api/namespaces/proto/classes/MediaRetryNotification)

Defined in: [WAProto/index.d.ts:5145](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5145)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MediaRetryNotification`](/docs/api/namespaces/proto/classes/MediaRetryNotification)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5148](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5148)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5146](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5146)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MediaRetryNotification`](/docs/api/namespaces/proto/classes/MediaRetryNotification)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-memberlabel"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/MemberLabel](https://baileys.wiki/docs/api/namespaces/proto/classes/MemberLabel)

Defined in: [WAProto/index.d.ts:5172](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5172)

## Implements[​](#implements "Direct link to Implements")

*   [`IMemberLabel`](/docs/api/namespaces/proto/interfaces/IMemberLabel)

## Constructors[​](#constructors "Direct link to Constructors")

### new MemberLabel()[​](#new-memberlabel "Direct link to new MemberLabel()")

> **new MemberLabel**(`p`?): [`MemberLabel`](/docs/api/namespaces/proto/classes/MemberLabel)

Defined in: [WAProto/index.d.ts:5173](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5173)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMemberLabel`](/docs/api/namespaces/proto/interfaces/IMemberLabel)

#### Returns[​](#returns "Direct link to Returns")

[`MemberLabel`](/docs/api/namespaces/proto/classes/MemberLabel)

## Properties[​](#properties "Direct link to Properties")

### label?[​](#label "Direct link to label?")

> `optional` **label**: `null` | `string`

Defined in: [WAProto/index.d.ts:5174](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5174)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMemberLabel`](/docs/api/namespaces/proto/interfaces/IMemberLabel).[`label`](/docs/api/namespaces/proto/interfaces/IMemberLabel#label)

* * *

### labelTimestamp?[​](#labeltimestamp "Direct link to labelTimestamp?")

> `optional` **labelTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:5175](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5175)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMemberLabel`](/docs/api/namespaces/proto/interfaces/IMemberLabel).[`labelTimestamp`](/docs/api/namespaces/proto/interfaces/IMemberLabel#labeltimestamp)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5181](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5181)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MemberLabel`](/docs/api/namespaces/proto/classes/MemberLabel)

Defined in: [WAProto/index.d.ts:5176](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5176)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMemberLabel`](/docs/api/namespaces/proto/interfaces/IMemberLabel)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MemberLabel`](/docs/api/namespaces/proto/classes/MemberLabel)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MemberLabel`](/docs/api/namespaces/proto/classes/MemberLabel)

Defined in: [WAProto/index.d.ts:5178](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5178)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MemberLabel`](/docs/api/namespaces/proto/classes/MemberLabel)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5177](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5177)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMemberLabel`](/docs/api/namespaces/proto/interfaces/IMemberLabel)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MemberLabel`](/docs/api/namespaces/proto/classes/MemberLabel)

Defined in: [WAProto/index.d.ts:5179](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5179)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MemberLabel`](/docs/api/namespaces/proto/classes/MemberLabel)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5182](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5182)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5180](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5180)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MemberLabel`](/docs/api/namespaces/proto/classes/MemberLabel)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-message"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/Message](https://baileys.wiki/docs/api/namespaces/proto/classes/Message)

Defined in: [WAProto/index.d.ts:5283](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5283)

## Implements[​](#implements "Direct link to Implements")

*   [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new Message()[​](#new-message "Direct link to new Message()")

> **new Message**(`p`?): [`Message`](/docs/api/namespaces/proto/classes/Message)

Defined in: [WAProto/index.d.ts:5284](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5284)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

#### Returns[​](#returns "Direct link to Returns")

[`Message`](/docs/api/namespaces/proto/classes/Message)

## Properties[​](#properties "Direct link to Properties")

### albumMessage?[​](#albummessage "Direct link to albumMessage?")

> `optional` **albumMessage**: `null` | [`IAlbumMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAlbumMessage)

Defined in: [WAProto/index.d.ts:5353](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5353)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`albumMessage`](/docs/api/namespaces/proto/interfaces/IMessage#albummessage)

* * *

### associatedChildMessage?[​](#associatedchildmessage "Direct link to associatedChildMessage?")

> `optional` **associatedChildMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5359](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5359)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`associatedChildMessage`](/docs/api/namespaces/proto/interfaces/IMessage#associatedchildmessage)

* * *

### audioMessage?[​](#audiomessage "Direct link to audioMessage?")

> `optional` **audioMessage**: `null` | [`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage)

Defined in: [WAProto/index.d.ts:5292](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5292)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`audioMessage`](/docs/api/namespaces/proto/interfaces/IMessage#audiomessage)

* * *

### bcallMessage?[​](#bcallmessage "Direct link to bcallMessage?")

> `optional` **bcallMessage**: `null` | [`IBCallMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IBCallMessage)

Defined in: [WAProto/index.d.ts:5345](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5345)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`bcallMessage`](/docs/api/namespaces/proto/interfaces/IMessage#bcallmessage)

* * *

### botForwardedMessage?[​](#botforwardedmessage "Direct link to botForwardedMessage?")

> `optional` **botForwardedMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5371](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5371)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`botForwardedMessage`](/docs/api/namespaces/proto/interfaces/IMessage#botforwardedmessage)

* * *

### botInvokeMessage?[​](#botinvokemessage "Direct link to botInvokeMessage?")

> `optional` **botInvokeMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5341](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5341)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`botInvokeMessage`](/docs/api/namespaces/proto/interfaces/IMessage#botinvokemessage)

* * *

### botTaskMessage?[​](#bottaskmessage "Direct link to botTaskMessage?")

> `optional` **botTaskMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5367](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5367)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`botTaskMessage`](/docs/api/namespaces/proto/interfaces/IMessage#bottaskmessage)

* * *

### buttonsMessage?[​](#buttonsmessage "Direct link to buttonsMessage?")

> `optional` **buttonsMessage**: `null` | [`IButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage)

Defined in: [WAProto/index.d.ts:5318](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5318)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`buttonsMessage`](/docs/api/namespaces/proto/interfaces/IMessage#buttonsmessage)

* * *

### buttonsResponseMessage?[​](#buttonsresponsemessage "Direct link to buttonsResponseMessage?")

> `optional` **buttonsResponseMessage**: `null` | [`IButtonsResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsResponseMessage)

Defined in: [WAProto/index.d.ts:5319](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5319)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`buttonsResponseMessage`](/docs/api/namespaces/proto/interfaces/IMessage#buttonsresponsemessage)

* * *

### call?[​](#call "Direct link to call?")

> `optional` **call**: `null` | [`ICall`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall)

Defined in: [WAProto/index.d.ts:5294](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5294)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`call`](/docs/api/namespaces/proto/interfaces/IMessage#call)

* * *

### callLogMesssage?[​](#calllogmesssage "Direct link to callLogMesssage?")

> `optional` **callLogMesssage**: `null` | [`ICallLogMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICallLogMessage)

Defined in: [WAProto/index.d.ts:5342](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5342)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`callLogMesssage`](/docs/api/namespaces/proto/interfaces/IMessage#calllogmesssage)

* * *

### cancelPaymentRequestMessage?[​](#cancelpaymentrequestmessage "Direct link to cancelPaymentRequestMessage?")

> `optional` **cancelPaymentRequestMessage**: `null` | [`ICancelPaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICancelPaymentRequestMessage)

Defined in: [WAProto/index.d.ts:5304](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5304)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`cancelPaymentRequestMessage`](/docs/api/namespaces/proto/interfaces/IMessage#cancelpaymentrequestmessage)

* * *

### chat?[​](#chat "Direct link to chat?")

> `optional` **chat**: `null` | [`IChat`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IChat)

Defined in: [WAProto/index.d.ts:5295](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5295)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`chat`](/docs/api/namespaces/proto/interfaces/IMessage#chat)

* * *

### commentMessage?[​](#commentmessage "Direct link to commentMessage?")

> `optional` **commentMessage**: `null` | [`ICommentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICommentMessage)

Defined in: [WAProto/index.d.ts:5349](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5349)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`commentMessage`](/docs/api/namespaces/proto/interfaces/IMessage#commentmessage)

* * *

### contactMessage?[​](#contactmessage "Direct link to contactMessage?")

> `optional` **contactMessage**: `null` | [`IContactMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactMessage)

Defined in: [WAProto/index.d.ts:5288](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5288)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`contactMessage`](/docs/api/namespaces/proto/interfaces/IMessage#contactmessage)

* * *

### contactsArrayMessage?[​](#contactsarraymessage "Direct link to contactsArrayMessage?")

> `optional` **contactsArrayMessage**: `null` | [`IContactsArrayMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactsArrayMessage)

Defined in: [WAProto/index.d.ts:5297](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5297)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`contactsArrayMessage`](/docs/api/namespaces/proto/interfaces/IMessage#contactsarraymessage)

* * *

### conversation?[​](#conversation "Direct link to conversation?")

> `optional` **conversation**: `null` | `string`

Defined in: [WAProto/index.d.ts:5285](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5285)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`conversation`](/docs/api/namespaces/proto/interfaces/IMessage#conversation)

* * *

### declinePaymentRequestMessage?[​](#declinepaymentrequestmessage "Direct link to declinePaymentRequestMessage?")

> `optional` **declinePaymentRequestMessage**: `null` | [`IDeclinePaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeclinePaymentRequestMessage)

Defined in: [WAProto/index.d.ts:5303](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5303)

#### Implementation of[​](#implementation-of-17 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`declinePaymentRequestMessage`](/docs/api/namespaces/proto/interfaces/IMessage#declinepaymentrequestmessage)

* * *

### deviceSentMessage?[​](#devicesentmessage "Direct link to deviceSentMessage?")

> `optional` **deviceSentMessage**: `null` | [`IDeviceSentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeviceSentMessage)

Defined in: [WAProto/index.d.ts:5310](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5310)

#### Implementation of[​](#implementation-of-18 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`deviceSentMessage`](/docs/api/namespaces/proto/interfaces/IMessage#devicesentmessage)

* * *

### documentMessage?[​](#documentmessage "Direct link to documentMessage?")

> `optional` **documentMessage**: `null` | [`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage)

Defined in: [WAProto/index.d.ts:5291](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5291)

#### Implementation of[​](#implementation-of-19 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`documentMessage`](/docs/api/namespaces/proto/interfaces/IMessage#documentmessage)

* * *

### documentWithCaptionMessage?[​](#documentwithcaptionmessage "Direct link to documentWithCaptionMessage?")

> `optional` **documentWithCaptionMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5328](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5328)

#### Implementation of[​](#implementation-of-20 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`documentWithCaptionMessage`](/docs/api/namespaces/proto/interfaces/IMessage#documentwithcaptionmessage)

* * *

### editedMessage?[​](#editedmessage "Direct link to editedMessage?")

> `optional` **editedMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5332](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5332)

#### Implementation of[​](#implementation-of-21 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`editedMessage`](/docs/api/namespaces/proto/interfaces/IMessage#editedmessage)

* * *

### encCommentMessage?[​](#enccommentmessage "Direct link to encCommentMessage?")

> `optional` **encCommentMessage**: `null` | [`IEncCommentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncCommentMessage)

Defined in: [WAProto/index.d.ts:5344](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5344)

#### Implementation of[​](#implementation-of-22 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`encCommentMessage`](/docs/api/namespaces/proto/interfaces/IMessage#enccommentmessage)

* * *

### encEventResponseMessage?[​](#enceventresponsemessage "Direct link to encEventResponseMessage?")

> `optional` **encEventResponseMessage**: `null` | [`IEncEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncEventResponseMessage)

Defined in: [WAProto/index.d.ts:5348](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5348)

#### Implementation of[​](#implementation-of-23 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`encEventResponseMessage`](/docs/api/namespaces/proto/interfaces/IMessage#enceventresponsemessage)

* * *

### encReactionMessage?[​](#encreactionmessage "Direct link to encReactionMessage?")

> `optional` **encReactionMessage**: `null` | [`IEncReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncReactionMessage)

Defined in: [WAProto/index.d.ts:5331](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5331)

#### Implementation of[​](#implementation-of-24 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`encReactionMessage`](/docs/api/namespaces/proto/interfaces/IMessage#encreactionmessage)

* * *

### ephemeralMessage?[​](#ephemeralmessage "Direct link to ephemeralMessage?")

> `optional` **ephemeralMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5316](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5316)

#### Implementation of[​](#implementation-of-25 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`ephemeralMessage`](/docs/api/namespaces/proto/interfaces/IMessage#ephemeralmessage)

* * *

### eventCoverImage?[​](#eventcoverimage "Direct link to eventCoverImage?")

> `optional` **eventCoverImage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5354](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5354)

#### Implementation of[​](#implementation-of-26 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`eventCoverImage`](/docs/api/namespaces/proto/interfaces/IMessage#eventcoverimage)

* * *

### eventMessage?[​](#eventmessage "Direct link to eventMessage?")

> `optional` **eventMessage**: `null` | [`IEventMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage)

Defined in: [WAProto/index.d.ts:5347](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5347)

#### Implementation of[​](#implementation-of-27 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`eventMessage`](/docs/api/namespaces/proto/interfaces/IMessage#eventmessage)

* * *

### extendedTextMessage?[​](#extendedtextmessage "Direct link to extendedTextMessage?")

> `optional` **extendedTextMessage**: `null` | [`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage)

Defined in: [WAProto/index.d.ts:5290](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5290)

#### Implementation of[​](#implementation-of-28 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`extendedTextMessage`](/docs/api/namespaces/proto/interfaces/IMessage#extendedtextmessage)

* * *

### fastRatchetKeySenderKeyDistributionMessage?[​](#fastratchetkeysenderkeydistributionmessage "Direct link to fastRatchetKeySenderKeyDistributionMessage?")

> `optional` **fastRatchetKeySenderKeyDistributionMessage**: `null` | [`ISenderKeyDistributionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISenderKeyDistributionMessage)

Defined in: [WAProto/index.d.ts:5299](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5299)

#### Implementation of[​](#implementation-of-29 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`fastRatchetKeySenderKeyDistributionMessage`](/docs/api/namespaces/proto/interfaces/IMessage#fastratchetkeysenderkeydistributionmessage)

* * *

### groupInviteMessage?[​](#groupinvitemessage "Direct link to groupInviteMessage?")

> `optional` **groupInviteMessage**: `null` | [`IGroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage)

Defined in: [WAProto/index.d.ts:5307](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5307)

#### Implementation of[​](#implementation-of-30 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`groupInviteMessage`](/docs/api/namespaces/proto/interfaces/IMessage#groupinvitemessage)

* * *

### groupMentionedMessage?[​](#groupmentionedmessage "Direct link to groupMentionedMessage?")

> `optional` **groupMentionedMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5336](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5336)

#### Implementation of[​](#implementation-of-31 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`groupMentionedMessage`](/docs/api/namespaces/proto/interfaces/IMessage#groupmentionedmessage)

* * *

### groupStatusMentionMessage?[​](#groupstatusmentionmessage "Direct link to groupStatusMentionMessage?")

> `optional` **groupStatusMentionMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5360](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5360)

#### Implementation of[​](#implementation-of-32 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`groupStatusMentionMessage`](/docs/api/namespaces/proto/interfaces/IMessage#groupstatusmentionmessage)

* * *

### groupStatusMessage?[​](#groupstatusmessage "Direct link to groupStatusMessage?")

> `optional` **groupStatusMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5363](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5363)

#### Implementation of[​](#implementation-of-33 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`groupStatusMessage`](/docs/api/namespaces/proto/interfaces/IMessage#groupstatusmessage)

* * *

### groupStatusMessageV2?[​](#groupstatusmessagev2 "Direct link to groupStatusMessageV2?")

> `optional` **groupStatusMessageV2**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5370](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5370)

#### Implementation of[​](#implementation-of-34 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`groupStatusMessageV2`](/docs/api/namespaces/proto/interfaces/IMessage#groupstatusmessagev2)

* * *

### highlyStructuredMessage?[​](#highlystructuredmessage "Direct link to highlyStructuredMessage?")

> `optional` **highlyStructuredMessage**: `null` | [`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:5298](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5298)

#### Implementation of[​](#implementation-of-35 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`highlyStructuredMessage`](/docs/api/namespaces/proto/interfaces/IMessage#highlystructuredmessage)

* * *

### imageMessage?[​](#imagemessage "Direct link to imageMessage?")

> `optional` **imageMessage**: `null` | [`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage)

Defined in: [WAProto/index.d.ts:5287](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5287)

#### Implementation of[​](#implementation-of-36 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`imageMessage`](/docs/api/namespaces/proto/interfaces/IMessage#imagemessage)

* * *

### interactiveMessage?[​](#interactivemessage "Direct link to interactiveMessage?")

> `optional` **interactiveMessage**: `null` | [`IInteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage)

Defined in: [WAProto/index.d.ts:5321](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5321)

#### Implementation of[​](#implementation-of-37 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`interactiveMessage`](/docs/api/namespaces/proto/interfaces/IMessage#interactivemessage)

* * *

### interactiveResponseMessage?[​](#interactiveresponsemessage "Direct link to interactiveResponseMessage?")

> `optional` **interactiveResponseMessage**: `null` | [`IInteractiveResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveResponseMessage)

Defined in: [WAProto/index.d.ts:5324](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5324)

#### Implementation of[​](#implementation-of-38 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`interactiveResponseMessage`](/docs/api/namespaces/proto/interfaces/IMessage#interactiveresponsemessage)

* * *

### invoiceMessage?[​](#invoicemessage "Direct link to invoiceMessage?")

> `optional` **invoiceMessage**: `null` | [`IInvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage)

Defined in: [WAProto/index.d.ts:5317](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5317)

#### Implementation of[​](#implementation-of-39 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`invoiceMessage`](/docs/api/namespaces/proto/interfaces/IMessage#invoicemessage)

* * *

### keepInChatMessage?[​](#keepinchatmessage "Direct link to keepInChatMessage?")

> `optional` **keepInChatMessage**: `null` | [`IKeepInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IKeepInChatMessage)

Defined in: [WAProto/index.d.ts:5327](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5327)

#### Implementation of[​](#implementation-of-40 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`keepInChatMessage`](/docs/api/namespaces/proto/interfaces/IMessage#keepinchatmessage)

* * *

### limitSharingMessage?[​](#limitsharingmessage "Direct link to limitSharingMessage?")

> `optional` **limitSharingMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5366](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5366)

#### Implementation of[​](#implementation-of-41 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`limitSharingMessage`](/docs/api/namespaces/proto/interfaces/IMessage#limitsharingmessage)

* * *

### listMessage?[​](#listmessage "Direct link to listMessage?")

> `optional` **listMessage**: `null` | [`IListMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage)

Defined in: [WAProto/index.d.ts:5312](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5312)

#### Implementation of[​](#implementation-of-42 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`listMessage`](/docs/api/namespaces/proto/interfaces/IMessage#listmessage)

* * *

### listResponseMessage?[​](#listresponsemessage "Direct link to listResponseMessage?")

> `optional` **listResponseMessage**: `null` | [`IListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListResponseMessage)

Defined in: [WAProto/index.d.ts:5315](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5315)

#### Implementation of[​](#implementation-of-43 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`listResponseMessage`](/docs/api/namespaces/proto/interfaces/IMessage#listresponsemessage)

* * *

### liveLocationMessage?[​](#livelocationmessage "Direct link to liveLocationMessage?")

> `optional` **liveLocationMessage**: `null` | [`ILiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage)

Defined in: [WAProto/index.d.ts:5301](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5301)

#### Implementation of[​](#implementation-of-44 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`liveLocationMessage`](/docs/api/namespaces/proto/interfaces/IMessage#livelocationmessage)

* * *

### locationMessage?[​](#locationmessage "Direct link to locationMessage?")

> `optional` **locationMessage**: `null` | [`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage)

Defined in: [WAProto/index.d.ts:5289](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5289)

#### Implementation of[​](#implementation-of-45 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`locationMessage`](/docs/api/namespaces/proto/interfaces/IMessage#locationmessage)

* * *

### lottieStickerMessage?[​](#lottiestickermessage "Direct link to lottieStickerMessage?")

> `optional` **lottieStickerMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5346](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5346)

#### Implementation of[​](#implementation-of-46 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`lottieStickerMessage`](/docs/api/namespaces/proto/interfaces/IMessage#lottiestickermessage)

* * *

### messageContextInfo?[​](#messagecontextinfo "Direct link to messageContextInfo?")

> `optional` **messageContextInfo**: `null` | [`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo)

Defined in: [WAProto/index.d.ts:5311](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5311)

#### Implementation of[​](#implementation-of-47 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`messageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessage#messagecontextinfo)

* * *

### messageHistoryBundle?[​](#messagehistorybundle "Direct link to messageHistoryBundle?")

> `optional` **messageHistoryBundle**: `null` | [`IMessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle)

Defined in: [WAProto/index.d.ts:5343](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5343)

#### Implementation of[​](#implementation-of-48 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`messageHistoryBundle`](/docs/api/namespaces/proto/interfaces/IMessage#messagehistorybundle)

* * *

### messageHistoryNotice?[​](#messagehistorynotice "Direct link to messageHistoryNotice?")

> `optional` **messageHistoryNotice**: `null` | [`IMessageHistoryNotice`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryNotice)

Defined in: [WAProto/index.d.ts:5369](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5369)

#### Implementation of[​](#implementation-of-49 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`messageHistoryNotice`](/docs/api/namespaces/proto/interfaces/IMessage#messagehistorynotice)

* * *

### newsletterAdminInviteMessage?[​](#newsletteradmininvitemessage "Direct link to newsletterAdminInviteMessage?")

> `optional` **newsletterAdminInviteMessage**: `null` | [`INewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage)

Defined in: [WAProto/index.d.ts:5350](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5350)

#### Implementation of[​](#implementation-of-50 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`newsletterAdminInviteMessage`](/docs/api/namespaces/proto/interfaces/IMessage#newsletteradmininvitemessage)

* * *

### newsletterFollowerInviteMessageV2?[​](#newsletterfollowerinvitemessagev2 "Direct link to newsletterFollowerInviteMessageV2?")

> `optional` **newsletterFollowerInviteMessageV2**: `null` | [`INewsletterFollowerInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterFollowerInviteMessage)

Defined in: [WAProto/index.d.ts:5378](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5378)

#### Implementation of[​](#implementation-of-51 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`newsletterFollowerInviteMessageV2`](/docs/api/namespaces/proto/interfaces/IMessage#newsletterfollowerinvitemessagev2)

* * *

### orderMessage?[​](#ordermessage "Direct link to orderMessage?")

> `optional` **orderMessage**: `null` | [`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage)

Defined in: [WAProto/index.d.ts:5314](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5314)

#### Implementation of[​](#implementation-of-52 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`orderMessage`](/docs/api/namespaces/proto/interfaces/IMessage#ordermessage)

* * *

### paymentInviteMessage?[​](#paymentinvitemessage "Direct link to paymentInviteMessage?")

> `optional` **paymentInviteMessage**: `null` | [`IPaymentInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentInviteMessage)

Defined in: [WAProto/index.d.ts:5320](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5320)

#### Implementation of[​](#implementation-of-53 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`paymentInviteMessage`](/docs/api/namespaces/proto/interfaces/IMessage#paymentinvitemessage)

* * *

### pinInChatMessage?[​](#pininchatmessage "Direct link to pinInChatMessage?")

> `optional` **pinInChatMessage**: `null` | [`IPinInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPinInChatMessage)

Defined in: [WAProto/index.d.ts:5337](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5337)

#### Implementation of[​](#implementation-of-54 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`pinInChatMessage`](/docs/api/namespaces/proto/interfaces/IMessage#pininchatmessage)

* * *

### placeholderMessage?[​](#placeholdermessage "Direct link to placeholderMessage?")

> `optional` **placeholderMessage**: `null` | [`IPlaceholderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPlaceholderMessage)

Defined in: [WAProto/index.d.ts:5351](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5351)

#### Implementation of[​](#implementation-of-55 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`placeholderMessage`](/docs/api/namespaces/proto/interfaces/IMessage#placeholdermessage)

* * *

### pollCreationMessage?[​](#pollcreationmessage "Direct link to pollCreationMessage?")

> `optional` **pollCreationMessage**: `null` | [`IPollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage)

Defined in: [WAProto/index.d.ts:5325](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5325)

#### Implementation of[​](#implementation-of-56 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`pollCreationMessage`](/docs/api/namespaces/proto/interfaces/IMessage#pollcreationmessage)

* * *

### pollCreationMessageV2?[​](#pollcreationmessagev2 "Direct link to pollCreationMessageV2?")

> `optional` **pollCreationMessageV2**: `null` | [`IPollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage)

Defined in: [WAProto/index.d.ts:5334](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5334)

#### Implementation of[​](#implementation-of-57 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`pollCreationMessageV2`](/docs/api/namespaces/proto/interfaces/IMessage#pollcreationmessagev2)

* * *

### pollCreationMessageV3?[​](#pollcreationmessagev3 "Direct link to pollCreationMessageV3?")

> `optional` **pollCreationMessageV3**: `null` | [`IPollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage)

Defined in: [WAProto/index.d.ts:5338](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5338)

#### Implementation of[​](#implementation-of-58 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`pollCreationMessageV3`](/docs/api/namespaces/proto/interfaces/IMessage#pollcreationmessagev3)

* * *

### pollCreationMessageV4?[​](#pollcreationmessagev4 "Direct link to pollCreationMessageV4?")

> `optional` **pollCreationMessageV4**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5361](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5361)

#### Implementation of[​](#implementation-of-59 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`pollCreationMessageV4`](/docs/api/namespaces/proto/interfaces/IMessage#pollcreationmessagev4)

* * *

### pollCreationMessageV5?[​](#pollcreationmessagev5 "Direct link to pollCreationMessageV5?")

> `optional` **pollCreationMessageV5**: `null` | [`IPollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage)

Defined in: [WAProto/index.d.ts:5377](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5377)

#### Implementation of[​](#implementation-of-60 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`pollCreationMessageV5`](/docs/api/namespaces/proto/interfaces/IMessage#pollcreationmessagev5)

* * *

### pollCreationOptionImageMessage?[​](#pollcreationoptionimagemessage "Direct link to pollCreationOptionImageMessage?")

> `optional` **pollCreationOptionImageMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5358](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5358)

#### Implementation of[​](#implementation-of-61 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`pollCreationOptionImageMessage`](/docs/api/namespaces/proto/interfaces/IMessage#pollcreationoptionimagemessage)

* * *

### pollResultSnapshotMessage?[​](#pollresultsnapshotmessage "Direct link to pollResultSnapshotMessage?")

> `optional` **pollResultSnapshotMessage**: `null` | [`IPollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollResultSnapshotMessage)

Defined in: [WAProto/index.d.ts:5357](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5357)

#### Implementation of[​](#implementation-of-62 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`pollResultSnapshotMessage`](/docs/api/namespaces/proto/interfaces/IMessage#pollresultsnapshotmessage)

* * *

### pollResultSnapshotMessageV3?[​](#pollresultsnapshotmessagev3 "Direct link to pollResultSnapshotMessageV3?")

> `optional` **pollResultSnapshotMessageV3**: `null` | [`IPollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollResultSnapshotMessage)

Defined in: [WAProto/index.d.ts:5379](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5379)

#### Implementation of[​](#implementation-of-63 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`pollResultSnapshotMessageV3`](/docs/api/namespaces/proto/interfaces/IMessage#pollresultsnapshotmessagev3)

* * *

### pollUpdateMessage?[​](#pollupdatemessage "Direct link to pollUpdateMessage?")

> `optional` **pollUpdateMessage**: `null` | [`IPollUpdateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessage)

Defined in: [WAProto/index.d.ts:5326](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5326)

#### Implementation of[​](#implementation-of-64 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`pollUpdateMessage`](/docs/api/namespaces/proto/interfaces/IMessage#pollupdatemessage)

* * *

### productMessage?[​](#productmessage "Direct link to productMessage?")

> `optional` **productMessage**: `null` | [`IProductMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage)

Defined in: [WAProto/index.d.ts:5309](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5309)

#### Implementation of[​](#implementation-of-65 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`productMessage`](/docs/api/namespaces/proto/interfaces/IMessage#productmessage)

* * *

### protocolMessage?[​](#protocolmessage "Direct link to protocolMessage?")

> `optional` **protocolMessage**: `null` | [`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage)

Defined in: [WAProto/index.d.ts:5296](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5296)

#### Implementation of[​](#implementation-of-66 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`protocolMessage`](/docs/api/namespaces/proto/interfaces/IMessage#protocolmessage)

* * *

### ptvMessage?[​](#ptvmessage "Direct link to ptvMessage?")

> `optional` **ptvMessage**: `null` | [`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage)

Defined in: [WAProto/index.d.ts:5340](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5340)

#### Implementation of[​](#implementation-of-67 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`ptvMessage`](/docs/api/namespaces/proto/interfaces/IMessage#ptvmessage)

* * *

### questionMessage?[​](#questionmessage "Direct link to questionMessage?")

> `optional` **questionMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5368](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5368)

#### Implementation of[​](#implementation-of-68 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`questionMessage`](/docs/api/namespaces/proto/interfaces/IMessage#questionmessage)

* * *

### questionReplyMessage?[​](#questionreplymessage "Direct link to questionReplyMessage?")

> `optional` **questionReplyMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5373](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5373)

#### Implementation of[​](#implementation-of-69 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`questionReplyMessage`](/docs/api/namespaces/proto/interfaces/IMessage#questionreplymessage)

* * *

### questionResponseMessage?[​](#questionresponsemessage "Direct link to questionResponseMessage?")

> `optional` **questionResponseMessage**: `null` | [`IQuestionResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IQuestionResponseMessage)

Defined in: [WAProto/index.d.ts:5374](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5374)

#### Implementation of[​](#implementation-of-70 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`questionResponseMessage`](/docs/api/namespaces/proto/interfaces/IMessage#questionresponsemessage)

* * *

### reactionMessage?[​](#reactionmessage "Direct link to reactionMessage?")

> `optional` **reactionMessage**: `null` | [`IReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IReactionMessage)

Defined in: [WAProto/index.d.ts:5322](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5322)

#### Implementation of[​](#implementation-of-71 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`reactionMessage`](/docs/api/namespaces/proto/interfaces/IMessage#reactionmessage)

* * *

### requestPaymentMessage?[​](#requestpaymentmessage "Direct link to requestPaymentMessage?")

> `optional` **requestPaymentMessage**: `null` | [`IRequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage)

Defined in: [WAProto/index.d.ts:5302](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5302)

#### Implementation of[​](#implementation-of-72 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`requestPaymentMessage`](/docs/api/namespaces/proto/interfaces/IMessage#requestpaymentmessage)

* * *

### requestPhoneNumberMessage?[​](#requestphonenumbermessage "Direct link to requestPhoneNumberMessage?")

> `optional` **requestPhoneNumberMessage**: `null` | [`IRequestPhoneNumberMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPhoneNumberMessage)

Defined in: [WAProto/index.d.ts:5329](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5329)

#### Implementation of[​](#implementation-of-73 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`requestPhoneNumberMessage`](/docs/api/namespaces/proto/interfaces/IMessage#requestphonenumbermessage)

* * *

### richResponseMessage?[​](#richresponsemessage "Direct link to richResponseMessage?")

> `optional` **richResponseMessage**: `null` | [`IAIRichResponseMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMessage)

Defined in: [WAProto/index.d.ts:5364](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5364)

#### Implementation of[​](#implementation-of-74 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`richResponseMessage`](/docs/api/namespaces/proto/interfaces/IMessage#richresponsemessage)

* * *

### scheduledCallCreationMessage?[​](#scheduledcallcreationmessage "Direct link to scheduledCallCreationMessage?")

> `optional` **scheduledCallCreationMessage**: `null` | [`IScheduledCallCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallCreationMessage)

Defined in: [WAProto/index.d.ts:5335](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5335)

#### Implementation of[​](#implementation-of-75 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`scheduledCallCreationMessage`](/docs/api/namespaces/proto/interfaces/IMessage#scheduledcallcreationmessage)

* * *

### scheduledCallEditMessage?[​](#scheduledcalleditmessage "Direct link to scheduledCallEditMessage?")

> `optional` **scheduledCallEditMessage**: `null` | [`IScheduledCallEditMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallEditMessage)

Defined in: [WAProto/index.d.ts:5339](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5339)

#### Implementation of[​](#implementation-of-76 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`scheduledCallEditMessage`](/docs/api/namespaces/proto/interfaces/IMessage#scheduledcalleditmessage)

* * *

### secretEncryptedMessage?[​](#secretencryptedmessage "Direct link to secretEncryptedMessage?")

> `optional` **secretEncryptedMessage**: `null` | [`ISecretEncryptedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISecretEncryptedMessage)

Defined in: [WAProto/index.d.ts:5352](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5352)

#### Implementation of[​](#implementation-of-77 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`secretEncryptedMessage`](/docs/api/namespaces/proto/interfaces/IMessage#secretencryptedmessage)

* * *

### senderKeyDistributionMessage?[​](#senderkeydistributionmessage "Direct link to senderKeyDistributionMessage?")

> `optional` **senderKeyDistributionMessage**: `null` | [`ISenderKeyDistributionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISenderKeyDistributionMessage)

Defined in: [WAProto/index.d.ts:5286](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5286)

#### Implementation of[​](#implementation-of-78 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`senderKeyDistributionMessage`](/docs/api/namespaces/proto/interfaces/IMessage#senderkeydistributionmessage)

* * *

### sendPaymentMessage?[​](#sendpaymentmessage "Direct link to sendPaymentMessage?")

> `optional` **sendPaymentMessage**: `null` | [`ISendPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISendPaymentMessage)

Defined in: [WAProto/index.d.ts:5300](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5300)

#### Implementation of[​](#implementation-of-79 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`sendPaymentMessage`](/docs/api/namespaces/proto/interfaces/IMessage#sendpaymentmessage)

* * *

### statusAddYours?[​](#statusaddyours "Direct link to statusAddYours?")

> `optional` **statusAddYours**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5362](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5362)

#### Implementation of[​](#implementation-of-80 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`statusAddYours`](/docs/api/namespaces/proto/interfaces/IMessage#statusaddyours)

* * *

### statusMentionMessage?[​](#statusmentionmessage "Direct link to statusMentionMessage?")

> `optional` **statusMentionMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5356](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5356)

#### Implementation of[​](#implementation-of-81 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`statusMentionMessage`](/docs/api/namespaces/proto/interfaces/IMessage#statusmentionmessage)

* * *

### statusNotificationMessage?[​](#statusnotificationmessage "Direct link to statusNotificationMessage?")

> `optional` **statusNotificationMessage**: `null` | [`IStatusNotificationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusNotificationMessage)

Defined in: [WAProto/index.d.ts:5365](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5365)

#### Implementation of[​](#implementation-of-82 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`statusNotificationMessage`](/docs/api/namespaces/proto/interfaces/IMessage#statusnotificationmessage)

* * *

### statusQuestionAnswerMessage?[​](#statusquestionanswermessage "Direct link to statusQuestionAnswerMessage?")

> `optional` **statusQuestionAnswerMessage**: `null` | [`IStatusQuestionAnswerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuestionAnswerMessage)

Defined in: [WAProto/index.d.ts:5372](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5372)

#### Implementation of[​](#implementation-of-83 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`statusQuestionAnswerMessage`](/docs/api/namespaces/proto/interfaces/IMessage#statusquestionanswermessage)

* * *

### statusQuotedMessage?[​](#statusquotedmessage "Direct link to statusQuotedMessage?")

> `optional` **statusQuotedMessage**: `null` | [`IStatusQuotedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuotedMessage)

Defined in: [WAProto/index.d.ts:5375](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5375)

#### Implementation of[​](#implementation-of-84 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`statusQuotedMessage`](/docs/api/namespaces/proto/interfaces/IMessage#statusquotedmessage)

* * *

### statusStickerInteractionMessage?[​](#statusstickerinteractionmessage "Direct link to statusStickerInteractionMessage?")

> `optional` **statusStickerInteractionMessage**: `null` | [`IStatusStickerInteractionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusStickerInteractionMessage)

Defined in: [WAProto/index.d.ts:5376](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5376)

#### Implementation of[​](#implementation-of-85 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`statusStickerInteractionMessage`](/docs/api/namespaces/proto/interfaces/IMessage#statusstickerinteractionmessage)

* * *

### stickerMessage?[​](#stickermessage "Direct link to stickerMessage?")

> `optional` **stickerMessage**: `null` | [`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage)

Defined in: [WAProto/index.d.ts:5306](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5306)

#### Implementation of[​](#implementation-of-86 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`stickerMessage`](/docs/api/namespaces/proto/interfaces/IMessage#stickermessage)

* * *

### stickerPackMessage?[​](#stickerpackmessage "Direct link to stickerPackMessage?")

> `optional` **stickerPackMessage**: `null` | [`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage)

Defined in: [WAProto/index.d.ts:5355](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5355)

#### Implementation of[​](#implementation-of-87 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`stickerPackMessage`](/docs/api/namespaces/proto/interfaces/IMessage#stickerpackmessage)

* * *

### stickerSyncRmrMessage?[​](#stickersyncrmrmessage "Direct link to stickerSyncRmrMessage?")

> `optional` **stickerSyncRmrMessage**: `null` | [`IStickerSyncRMRMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerSyncRMRMessage)

Defined in: [WAProto/index.d.ts:5323](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5323)

#### Implementation of[​](#implementation-of-88 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`stickerSyncRmrMessage`](/docs/api/namespaces/proto/interfaces/IMessage#stickersyncrmrmessage)

* * *

### templateButtonReplyMessage?[​](#templatebuttonreplymessage "Direct link to templateButtonReplyMessage?")

> `optional` **templateButtonReplyMessage**: `null` | [`ITemplateButtonReplyMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateButtonReplyMessage)

Defined in: [WAProto/index.d.ts:5308](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5308)

#### Implementation of[​](#implementation-of-89 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`templateButtonReplyMessage`](/docs/api/namespaces/proto/interfaces/IMessage#templatebuttonreplymessage)

* * *

### templateMessage?[​](#templatemessage "Direct link to templateMessage?")

> `optional` **templateMessage**: `null` | [`ITemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage)

Defined in: [WAProto/index.d.ts:5305](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5305)

#### Implementation of[​](#implementation-of-90 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`templateMessage`](/docs/api/namespaces/proto/interfaces/IMessage#templatemessage)

* * *

### videoMessage?[​](#videomessage "Direct link to videoMessage?")

> `optional` **videoMessage**: `null` | [`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage)

Defined in: [WAProto/index.d.ts:5293](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5293)

#### Implementation of[​](#implementation-of-91 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`videoMessage`](/docs/api/namespaces/proto/interfaces/IMessage#videomessage)

* * *

### viewOnceMessage?[​](#viewoncemessage "Direct link to viewOnceMessage?")

> `optional` **viewOnceMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5313](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5313)

#### Implementation of[​](#implementation-of-92 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`viewOnceMessage`](/docs/api/namespaces/proto/interfaces/IMessage#viewoncemessage)

* * *

### viewOnceMessageV2?[​](#viewoncemessagev2 "Direct link to viewOnceMessageV2?")

> `optional` **viewOnceMessageV2**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5330](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5330)

#### Implementation of[​](#implementation-of-93 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`viewOnceMessageV2`](/docs/api/namespaces/proto/interfaces/IMessage#viewoncemessagev2)

* * *

### viewOnceMessageV2Extension?[​](#viewoncemessagev2extension "Direct link to viewOnceMessageV2Extension?")

> `optional` **viewOnceMessageV2Extension**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5333](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5333)

#### Implementation of[​](#implementation-of-94 "Direct link to Implementation of")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage).[`viewOnceMessageV2Extension`](/docs/api/namespaces/proto/interfaces/IMessage#viewoncemessagev2extension)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5385](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5385)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Message`](/docs/api/namespaces/proto/classes/Message)

Defined in: [WAProto/index.d.ts:5380](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5380)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Message`](/docs/api/namespaces/proto/classes/Message)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Message`](/docs/api/namespaces/proto/classes/Message)

Defined in: [WAProto/index.d.ts:5382](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5382)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Message`](/docs/api/namespaces/proto/classes/Message)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5381](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5381)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Message`](/docs/api/namespaces/proto/classes/Message)

Defined in: [WAProto/index.d.ts:5383](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5383)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Message`](/docs/api/namespaces/proto/classes/Message)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5386](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5386)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5384](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5384)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Message`](/docs/api/namespaces/proto/classes/Message)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-messageaddon"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/MessageAddOn](https://baileys.wiki/docs/api/namespaces/proto/classes/MessageAddOn)

Defined in: [WAProto/index.d.ts:9419](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9419)

## Implements[​](#implements "Direct link to Implements")

*   [`IMessageAddOn`](/docs/api/namespaces/proto/interfaces/IMessageAddOn)

## Constructors[​](#constructors "Direct link to Constructors")

### new MessageAddOn()[​](#new-messageaddon "Direct link to new MessageAddOn()")

> **new MessageAddOn**(`p`?): [`MessageAddOn`](/docs/api/namespaces/proto/classes/MessageAddOn)

Defined in: [WAProto/index.d.ts:9420](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9420)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMessageAddOn`](/docs/api/namespaces/proto/interfaces/IMessageAddOn)

#### Returns[​](#returns "Direct link to Returns")

[`MessageAddOn`](/docs/api/namespaces/proto/classes/MessageAddOn)

## Properties[​](#properties "Direct link to Properties")

### addOnContextInfo?[​](#addoncontextinfo "Direct link to addOnContextInfo?")

> `optional` **addOnContextInfo**: `null` | [`IMessageAddOnContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageAddOnContextInfo)

Defined in: [WAProto/index.d.ts:9426](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9426)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMessageAddOn`](/docs/api/namespaces/proto/interfaces/IMessageAddOn).[`addOnContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageAddOn#addoncontextinfo)

* * *

### legacyMessage?[​](#legacymessage "Direct link to legacyMessage?")

> `optional` **legacyMessage**: `null` | [`ILegacyMessage`](/docs/api/namespaces/proto/interfaces/ILegacyMessage)

Defined in: [WAProto/index.d.ts:9428](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9428)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMessageAddOn`](/docs/api/namespaces/proto/interfaces/IMessageAddOn).[`legacyMessage`](/docs/api/namespaces/proto/interfaces/IMessageAddOn#legacymessage)

* * *

### messageAddOn?[​](#messageaddon "Direct link to messageAddOn?")

> `optional` **messageAddOn**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:9422](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9422)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMessageAddOn`](/docs/api/namespaces/proto/interfaces/IMessageAddOn).[`messageAddOn`](/docs/api/namespaces/proto/interfaces/IMessageAddOn#messageaddon)

* * *

### messageAddOnKey?[​](#messageaddonkey "Direct link to messageAddOnKey?")

> `optional` **messageAddOnKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:9427](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9427)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IMessageAddOn`](/docs/api/namespaces/proto/interfaces/IMessageAddOn).[`messageAddOnKey`](/docs/api/namespaces/proto/interfaces/IMessageAddOn#messageaddonkey)

* * *

### messageAddOnType?[​](#messageaddontype "Direct link to messageAddOnType?")

> `optional` **messageAddOnType**: `null` | [`MessageAddOnType`](/docs/api/namespaces/proto/namespaces/MessageAddOn/enumerations/MessageAddOnType)

Defined in: [WAProto/index.d.ts:9421](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9421)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IMessageAddOn`](/docs/api/namespaces/proto/interfaces/IMessageAddOn).[`messageAddOnType`](/docs/api/namespaces/proto/interfaces/IMessageAddOn#messageaddontype)

* * *

### senderTimestampMs?[​](#sendertimestampms "Direct link to senderTimestampMs?")

> `optional` **senderTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9423](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9423)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IMessageAddOn`](/docs/api/namespaces/proto/interfaces/IMessageAddOn).[`senderTimestampMs`](/docs/api/namespaces/proto/interfaces/IMessageAddOn#sendertimestampms)

* * *

### serverTimestampMs?[​](#servertimestampms "Direct link to serverTimestampMs?")

> `optional` **serverTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9424](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9424)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IMessageAddOn`](/docs/api/namespaces/proto/interfaces/IMessageAddOn).[`serverTimestampMs`](/docs/api/namespaces/proto/interfaces/IMessageAddOn#servertimestampms)

* * *

### status?[​](#status "Direct link to status?")

> `optional` **status**: `null` | [`Status`](/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/Status)

Defined in: [WAProto/index.d.ts:9425](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9425)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IMessageAddOn`](/docs/api/namespaces/proto/interfaces/IMessageAddOn).[`status`](/docs/api/namespaces/proto/interfaces/IMessageAddOn#status)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9434](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9434)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MessageAddOn`](/docs/api/namespaces/proto/classes/MessageAddOn)

Defined in: [WAProto/index.d.ts:9429](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9429)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMessageAddOn`](/docs/api/namespaces/proto/interfaces/IMessageAddOn)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MessageAddOn`](/docs/api/namespaces/proto/classes/MessageAddOn)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MessageAddOn`](/docs/api/namespaces/proto/classes/MessageAddOn)

Defined in: [WAProto/index.d.ts:9431](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9431)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MessageAddOn`](/docs/api/namespaces/proto/classes/MessageAddOn)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9430](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9430)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMessageAddOn`](/docs/api/namespaces/proto/interfaces/IMessageAddOn)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MessageAddOn`](/docs/api/namespaces/proto/classes/MessageAddOn)

Defined in: [WAProto/index.d.ts:9432](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9432)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MessageAddOn`](/docs/api/namespaces/proto/classes/MessageAddOn)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9435](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9435)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9433](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9433)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MessageAddOn`](/docs/api/namespaces/proto/classes/MessageAddOn)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-messageaddoncontextinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/MessageAddOnContextInfo](https://baileys.wiki/docs/api/namespaces/proto/classes/MessageAddOnContextInfo)

Defined in: [WAProto/index.d.ts:9454](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9454)

## Implements[​](#implements "Direct link to Implements")

*   [`IMessageAddOnContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageAddOnContextInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new MessageAddOnContextInfo()[​](#new-messageaddoncontextinfo "Direct link to new MessageAddOnContextInfo()")

> **new MessageAddOnContextInfo**(`p`?): [`MessageAddOnContextInfo`](/docs/api/namespaces/proto/classes/MessageAddOnContextInfo)

Defined in: [WAProto/index.d.ts:9455](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9455)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMessageAddOnContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageAddOnContextInfo)

#### Returns[​](#returns "Direct link to Returns")

[`MessageAddOnContextInfo`](/docs/api/namespaces/proto/classes/MessageAddOnContextInfo)

## Properties[​](#properties "Direct link to Properties")

### messageAddOnDurationInSecs?[​](#messageaddondurationinsecs "Direct link to messageAddOnDurationInSecs?")

> `optional` **messageAddOnDurationInSecs**: `null` | `number`

Defined in: [WAProto/index.d.ts:9456](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9456)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMessageAddOnContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageAddOnContextInfo).[`messageAddOnDurationInSecs`](/docs/api/namespaces/proto/interfaces/IMessageAddOnContextInfo#messageaddondurationinsecs)

* * *

### messageAddOnExpiryType?[​](#messageaddonexpirytype "Direct link to messageAddOnExpiryType?")

> `optional` **messageAddOnExpiryType**: `null` | [`MessageAddonExpiryType`](/docs/api/namespaces/proto/namespaces/MessageContextInfo/enumerations/MessageAddonExpiryType)

Defined in: [WAProto/index.d.ts:9457](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9457)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMessageAddOnContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageAddOnContextInfo).[`messageAddOnExpiryType`](/docs/api/namespaces/proto/interfaces/IMessageAddOnContextInfo#messageaddonexpirytype)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9463](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9463)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MessageAddOnContextInfo`](/docs/api/namespaces/proto/classes/MessageAddOnContextInfo)

Defined in: [WAProto/index.d.ts:9458](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9458)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMessageAddOnContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageAddOnContextInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MessageAddOnContextInfo`](/docs/api/namespaces/proto/classes/MessageAddOnContextInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MessageAddOnContextInfo`](/docs/api/namespaces/proto/classes/MessageAddOnContextInfo)

Defined in: [WAProto/index.d.ts:9460](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9460)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MessageAddOnContextInfo`](/docs/api/namespaces/proto/classes/MessageAddOnContextInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9459](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9459)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMessageAddOnContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageAddOnContextInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MessageAddOnContextInfo`](/docs/api/namespaces/proto/classes/MessageAddOnContextInfo)

Defined in: [WAProto/index.d.ts:9461](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9461)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MessageAddOnContextInfo`](/docs/api/namespaces/proto/classes/MessageAddOnContextInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9464](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9464)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9462](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9462)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MessageAddOnContextInfo`](/docs/api/namespaces/proto/classes/MessageAddOnContextInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-messageassociation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/MessageAssociation](https://baileys.wiki/docs/api/namespaces/proto/classes/MessageAssociation)

Defined in: [WAProto/index.d.ts:9473](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9473)

## Implements[​](#implements "Direct link to Implements")

*   [`IMessageAssociation`](/docs/api/namespaces/proto/interfaces/IMessageAssociation)

## Constructors[​](#constructors "Direct link to Constructors")

### new MessageAssociation()[​](#new-messageassociation "Direct link to new MessageAssociation()")

> **new MessageAssociation**(`p`?): [`MessageAssociation`](/docs/api/namespaces/proto/classes/MessageAssociation)

Defined in: [WAProto/index.d.ts:9474](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9474)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMessageAssociation`](/docs/api/namespaces/proto/interfaces/IMessageAssociation)

#### Returns[​](#returns "Direct link to Returns")

[`MessageAssociation`](/docs/api/namespaces/proto/classes/MessageAssociation)

## Properties[​](#properties "Direct link to Properties")

### associationType?[​](#associationtype "Direct link to associationType?")

> `optional` **associationType**: `null` | [`AssociationType`](/docs/api/namespaces/proto/namespaces/MessageAssociation/enumerations/AssociationType)

Defined in: [WAProto/index.d.ts:9475](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9475)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMessageAssociation`](/docs/api/namespaces/proto/interfaces/IMessageAssociation).[`associationType`](/docs/api/namespaces/proto/interfaces/IMessageAssociation#associationtype)

* * *

### messageIndex?[​](#messageindex "Direct link to messageIndex?")

> `optional` **messageIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:9477](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9477)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMessageAssociation`](/docs/api/namespaces/proto/interfaces/IMessageAssociation).[`messageIndex`](/docs/api/namespaces/proto/interfaces/IMessageAssociation#messageindex)

* * *

### parentMessageKey?[​](#parentmessagekey "Direct link to parentMessageKey?")

> `optional` **parentMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:9476](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9476)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMessageAssociation`](/docs/api/namespaces/proto/interfaces/IMessageAssociation).[`parentMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageAssociation#parentmessagekey)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9483](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9483)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MessageAssociation`](/docs/api/namespaces/proto/classes/MessageAssociation)

Defined in: [WAProto/index.d.ts:9478](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9478)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMessageAssociation`](/docs/api/namespaces/proto/interfaces/IMessageAssociation)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MessageAssociation`](/docs/api/namespaces/proto/classes/MessageAssociation)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MessageAssociation`](/docs/api/namespaces/proto/classes/MessageAssociation)

Defined in: [WAProto/index.d.ts:9480](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9480)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MessageAssociation`](/docs/api/namespaces/proto/classes/MessageAssociation)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9479](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9479)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMessageAssociation`](/docs/api/namespaces/proto/interfaces/IMessageAssociation)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MessageAssociation`](/docs/api/namespaces/proto/classes/MessageAssociation)

Defined in: [WAProto/index.d.ts:9481](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9481)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MessageAssociation`](/docs/api/namespaces/proto/classes/MessageAssociation)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9484](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9484)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9482](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9482)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MessageAssociation`](/docs/api/namespaces/proto/classes/MessageAssociation)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-messagecontextinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/MessageContextInfo](https://baileys.wiki/docs/api/namespaces/proto/classes/MessageContextInfo)

Defined in: [WAProto/index.d.ts:9532](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9532)

## Implements[​](#implements "Direct link to Implements")

*   [`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new MessageContextInfo()[​](#new-messagecontextinfo "Direct link to new MessageContextInfo()")

> **new MessageContextInfo**(`p`?): [`MessageContextInfo`](/docs/api/namespaces/proto/classes/MessageContextInfo)

Defined in: [WAProto/index.d.ts:9533](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9533)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo)

#### Returns[​](#returns "Direct link to Returns")

[`MessageContextInfo`](/docs/api/namespaces/proto/classes/MessageContextInfo)

## Properties[​](#properties "Direct link to Properties")

### botMessageSecret?[​](#botmessagesecret "Direct link to botMessageSecret?")

> `optional` **botMessageSecret**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9539](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9539)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo).[`botMessageSecret`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo#botmessagesecret)

* * *

### botMetadata?[​](#botmetadata "Direct link to botMetadata?")

> `optional` **botMetadata**: `null` | [`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata)

Defined in: [WAProto/index.d.ts:9540](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9540)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo).[`botMetadata`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo#botmetadata)

* * *

### capiCreatedGroup?[​](#capicreatedgroup "Direct link to capiCreatedGroup?")

> `optional` **capiCreatedGroup**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9544](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9544)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo).[`capiCreatedGroup`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo#capicreatedgroup)

* * *

### deviceListMetadata?[​](#devicelistmetadata "Direct link to deviceListMetadata?")

> `optional` **deviceListMetadata**: `null` | [`IDeviceListMetadata`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata)

Defined in: [WAProto/index.d.ts:9534](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9534)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo).[`deviceListMetadata`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo#devicelistmetadata)

* * *

### deviceListMetadataVersion?[​](#devicelistmetadataversion "Direct link to deviceListMetadataVersion?")

> `optional` **deviceListMetadataVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:9535](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9535)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo).[`deviceListMetadataVersion`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo#devicelistmetadataversion)

* * *

### limitSharing?[​](#limitsharing "Direct link to limitSharing?")

> `optional` **limitSharing**: `null` | [`ILimitSharing`](/docs/api/namespaces/proto/interfaces/ILimitSharing)

Defined in: [WAProto/index.d.ts:9546](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9546)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo).[`limitSharing`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo#limitsharing)

* * *

### limitSharingV2?[​](#limitsharingv2 "Direct link to limitSharingV2?")

> `optional` **limitSharingV2**: `null` | [`ILimitSharing`](/docs/api/namespaces/proto/interfaces/ILimitSharing)

Defined in: [WAProto/index.d.ts:9547](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9547)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo).[`limitSharingV2`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo#limitsharingv2)

* * *

### messageAddOnDurationInSecs?[​](#messageaddondurationinsecs "Direct link to messageAddOnDurationInSecs?")

> `optional` **messageAddOnDurationInSecs**: `null` | `number`

Defined in: [WAProto/index.d.ts:9538](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9538)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo).[`messageAddOnDurationInSecs`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo#messageaddondurationinsecs)

* * *

### messageAddOnExpiryType?[​](#messageaddonexpirytype "Direct link to messageAddOnExpiryType?")

> `optional` **messageAddOnExpiryType**: `null` | [`MessageAddonExpiryType`](/docs/api/namespaces/proto/namespaces/MessageContextInfo/enumerations/MessageAddonExpiryType)

Defined in: [WAProto/index.d.ts:9542](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9542)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo).[`messageAddOnExpiryType`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo#messageaddonexpirytype)

* * *

### messageAssociation?[​](#messageassociation "Direct link to messageAssociation?")

> `optional` **messageAssociation**: `null` | [`IMessageAssociation`](/docs/api/namespaces/proto/interfaces/IMessageAssociation)

Defined in: [WAProto/index.d.ts:9543](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9543)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo).[`messageAssociation`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo#messageassociation)

* * *

### messageSecret?[​](#messagesecret "Direct link to messageSecret?")

> `optional` **messageSecret**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9536](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9536)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo).[`messageSecret`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo#messagesecret)

* * *

### paddingBytes?[​](#paddingbytes "Direct link to paddingBytes?")

> `optional` **paddingBytes**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9537](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9537)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo).[`paddingBytes`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo#paddingbytes)

* * *

### reportingTokenVersion?[​](#reportingtokenversion "Direct link to reportingTokenVersion?")

> `optional` **reportingTokenVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:9541](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9541)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo).[`reportingTokenVersion`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo#reportingtokenversion)

* * *

### supportPayload?[​](#supportpayload "Direct link to supportPayload?")

> `optional` **supportPayload**: `null` | `string`

Defined in: [WAProto/index.d.ts:9545](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9545)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo).[`supportPayload`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo#supportpayload)

* * *

### threadId[​](#threadid "Direct link to threadId")

> **threadId**: [`IThreadID`](/docs/api/namespaces/proto/interfaces/IThreadID)\[\]

Defined in: [WAProto/index.d.ts:9548](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9548)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo).[`threadId`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo#threadid)

* * *

### weblinkRenderConfig?[​](#weblinkrenderconfig "Direct link to weblinkRenderConfig?")

> `optional` **weblinkRenderConfig**: `null` | [`WebLinkRenderConfig`](/docs/api/namespaces/proto/enumerations/WebLinkRenderConfig)

Defined in: [WAProto/index.d.ts:9549](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9549)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo).[`weblinkRenderConfig`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo#weblinkrenderconfig)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9555](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9555)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MessageContextInfo`](/docs/api/namespaces/proto/classes/MessageContextInfo)

Defined in: [WAProto/index.d.ts:9550](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9550)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MessageContextInfo`](/docs/api/namespaces/proto/classes/MessageContextInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MessageContextInfo`](/docs/api/namespaces/proto/classes/MessageContextInfo)

Defined in: [WAProto/index.d.ts:9552](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9552)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MessageContextInfo`](/docs/api/namespaces/proto/classes/MessageContextInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9551](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9551)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MessageContextInfo`](/docs/api/namespaces/proto/classes/MessageContextInfo)

Defined in: [WAProto/index.d.ts:9553](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9553)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MessageContextInfo`](/docs/api/namespaces/proto/classes/MessageContextInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9556](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9556)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9554](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9554)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MessageContextInfo`](/docs/api/namespaces/proto/classes/MessageContextInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-messagekey"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/MessageKey](https://baileys.wiki/docs/api/namespaces/proto/classes/MessageKey)

Defined in: [WAProto/index.d.ts:9574](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9574)

## Implements[​](#implements "Direct link to Implements")

*   [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

## Constructors[​](#constructors "Direct link to Constructors")

### new MessageKey()[​](#new-messagekey "Direct link to new MessageKey()")

> **new MessageKey**(`p`?): [`MessageKey`](/docs/api/namespaces/proto/classes/MessageKey)

Defined in: [WAProto/index.d.ts:9575](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9575)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

#### Returns[​](#returns "Direct link to Returns")

[`MessageKey`](/docs/api/namespaces/proto/classes/MessageKey)

## Properties[​](#properties "Direct link to Properties")

### fromMe?[​](#fromme "Direct link to fromMe?")

> `optional` **fromMe**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9577](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9577)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey).[`fromMe`](/docs/api/namespaces/proto/interfaces/IMessageKey#fromme)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:9578](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9578)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey).[`id`](/docs/api/namespaces/proto/interfaces/IMessageKey#id)

* * *

### participant?[​](#participant "Direct link to participant?")

> `optional` **participant**: `null` | `string`

Defined in: [WAProto/index.d.ts:9579](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9579)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey).[`participant`](/docs/api/namespaces/proto/interfaces/IMessageKey#participant)

* * *

### remoteJid?[​](#remotejid "Direct link to remoteJid?")

> `optional` **remoteJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:9576](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9576)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey).[`remoteJid`](/docs/api/namespaces/proto/interfaces/IMessageKey#remotejid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9585](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9585)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MessageKey`](/docs/api/namespaces/proto/classes/MessageKey)

Defined in: [WAProto/index.d.ts:9580](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9580)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MessageKey`](/docs/api/namespaces/proto/classes/MessageKey)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MessageKey`](/docs/api/namespaces/proto/classes/MessageKey)

Defined in: [WAProto/index.d.ts:9582](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9582)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MessageKey`](/docs/api/namespaces/proto/classes/MessageKey)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9581](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9581)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MessageKey`](/docs/api/namespaces/proto/classes/MessageKey)

Defined in: [WAProto/index.d.ts:9583](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9583)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MessageKey`](/docs/api/namespaces/proto/classes/MessageKey)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9586](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9586)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9584](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9584)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MessageKey`](/docs/api/namespaces/proto/classes/MessageKey)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-messagesecretmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/MessageSecretMessage](https://baileys.wiki/docs/api/namespaces/proto/classes/MessageSecretMessage)

Defined in: [WAProto/index.d.ts:9595](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9595)

## Implements[​](#implements "Direct link to Implements")

*   [`IMessageSecretMessage`](/docs/api/namespaces/proto/interfaces/IMessageSecretMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new MessageSecretMessage()[​](#new-messagesecretmessage "Direct link to new MessageSecretMessage()")

> **new MessageSecretMessage**(`p`?): [`MessageSecretMessage`](/docs/api/namespaces/proto/classes/MessageSecretMessage)

Defined in: [WAProto/index.d.ts:9596](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9596)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMessageSecretMessage`](/docs/api/namespaces/proto/interfaces/IMessageSecretMessage)

#### Returns[​](#returns "Direct link to Returns")

[`MessageSecretMessage`](/docs/api/namespaces/proto/classes/MessageSecretMessage)

## Properties[​](#properties "Direct link to Properties")

### encIv?[​](#enciv "Direct link to encIv?")

> `optional` **encIv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9598](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9598)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMessageSecretMessage`](/docs/api/namespaces/proto/interfaces/IMessageSecretMessage).[`encIv`](/docs/api/namespaces/proto/interfaces/IMessageSecretMessage#enciv)

* * *

### encPayload?[​](#encpayload "Direct link to encPayload?")

> `optional` **encPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9599](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9599)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMessageSecretMessage`](/docs/api/namespaces/proto/interfaces/IMessageSecretMessage).[`encPayload`](/docs/api/namespaces/proto/interfaces/IMessageSecretMessage#encpayload)

* * *

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | `number`

Defined in: [WAProto/index.d.ts:9597](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9597)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMessageSecretMessage`](/docs/api/namespaces/proto/interfaces/IMessageSecretMessage).[`version`](/docs/api/namespaces/proto/interfaces/IMessageSecretMessage#version)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9605](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9605)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MessageSecretMessage`](/docs/api/namespaces/proto/classes/MessageSecretMessage)

Defined in: [WAProto/index.d.ts:9600](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9600)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMessageSecretMessage`](/docs/api/namespaces/proto/interfaces/IMessageSecretMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MessageSecretMessage`](/docs/api/namespaces/proto/classes/MessageSecretMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MessageSecretMessage`](/docs/api/namespaces/proto/classes/MessageSecretMessage)

Defined in: [WAProto/index.d.ts:9602](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9602)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MessageSecretMessage`](/docs/api/namespaces/proto/classes/MessageSecretMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9601](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9601)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMessageSecretMessage`](/docs/api/namespaces/proto/interfaces/IMessageSecretMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MessageSecretMessage`](/docs/api/namespaces/proto/classes/MessageSecretMessage)

Defined in: [WAProto/index.d.ts:9603](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9603)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MessageSecretMessage`](/docs/api/namespaces/proto/classes/MessageSecretMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9606](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9606)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9604](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9604)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MessageSecretMessage`](/docs/api/namespaces/proto/classes/MessageSecretMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-money"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/Money](https://baileys.wiki/docs/api/namespaces/proto/classes/Money)

Defined in: [WAProto/index.d.ts:9615](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9615)

## Implements[​](#implements "Direct link to Implements")

*   [`IMoney`](/docs/api/namespaces/proto/interfaces/IMoney)

## Constructors[​](#constructors "Direct link to Constructors")

### new Money()[​](#new-money "Direct link to new Money()")

> **new Money**(`p`?): [`Money`](/docs/api/namespaces/proto/classes/Money)

Defined in: [WAProto/index.d.ts:9616](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9616)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMoney`](/docs/api/namespaces/proto/interfaces/IMoney)

#### Returns[​](#returns "Direct link to Returns")

[`Money`](/docs/api/namespaces/proto/classes/Money)

## Properties[​](#properties "Direct link to Properties")

### currencyCode?[​](#currencycode "Direct link to currencyCode?")

> `optional` **currencyCode**: `null` | `string`

Defined in: [WAProto/index.d.ts:9619](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9619)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMoney`](/docs/api/namespaces/proto/interfaces/IMoney).[`currencyCode`](/docs/api/namespaces/proto/interfaces/IMoney#currencycode)

* * *

### offset?[​](#offset "Direct link to offset?")

> `optional` **offset**: `null` | `number`

Defined in: [WAProto/index.d.ts:9618](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9618)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMoney`](/docs/api/namespaces/proto/interfaces/IMoney).[`offset`](/docs/api/namespaces/proto/interfaces/IMoney#offset)

* * *

### value?[​](#value "Direct link to value?")

> `optional` **value**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9617](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9617)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMoney`](/docs/api/namespaces/proto/interfaces/IMoney).[`value`](/docs/api/namespaces/proto/interfaces/IMoney#value)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9625](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9625)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Money`](/docs/api/namespaces/proto/classes/Money)

Defined in: [WAProto/index.d.ts:9620](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9620)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMoney`](/docs/api/namespaces/proto/interfaces/IMoney)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Money`](/docs/api/namespaces/proto/classes/Money)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Money`](/docs/api/namespaces/proto/classes/Money)

Defined in: [WAProto/index.d.ts:9622](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9622)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Money`](/docs/api/namespaces/proto/classes/Money)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9621](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9621)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMoney`](/docs/api/namespaces/proto/interfaces/IMoney)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Money`](/docs/api/namespaces/proto/classes/Money)

Defined in: [WAProto/index.d.ts:9623](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9623)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Money`](/docs/api/namespaces/proto/classes/Money)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9626](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9626)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9624](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9624)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Money`](/docs/api/namespaces/proto/classes/Money)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-msgopaquedata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/MsgOpaqueData](https://baileys.wiki/docs/api/namespaces/proto/classes/MsgOpaqueData)

Defined in: [WAProto/index.d.ts:9675](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9675)

## Implements[​](#implements "Direct link to Implements")

*   [`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData)

## Constructors[​](#constructors "Direct link to Constructors")

### new MsgOpaqueData()[​](#new-msgopaquedata "Direct link to new MsgOpaqueData()")

> **new MsgOpaqueData**(`p`?): [`MsgOpaqueData`](/docs/api/namespaces/proto/classes/MsgOpaqueData)

Defined in: [WAProto/index.d.ts:9676](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9676)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData)

#### Returns[​](#returns "Direct link to Returns")

[`MsgOpaqueData`](/docs/api/namespaces/proto/classes/MsgOpaqueData)

## Properties[​](#properties "Direct link to Properties")

### body?[​](#body "Direct link to body?")

> `optional` **body**: `null` | `string`

Defined in: [WAProto/index.d.ts:9677](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9677)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`body`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#body)

* * *

### botMessageSecret?[​](#botmessagesecret "Direct link to botMessageSecret?")

> `optional` **botMessageSecret**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9706](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9706)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`botMessageSecret`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#botmessagesecret)

* * *

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:9678](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9678)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`caption`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#caption)

* * *

### clientUrl?[​](#clienturl "Direct link to clientUrl?")

> `optional` **clientUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:9688](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9688)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`clientUrl`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#clienturl)

* * *

### correctOptionIndex?[​](#correctoptionindex "Direct link to correctOptionIndex?")

> `optional` **correctOptionIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:9701](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9701)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`correctOptionIndex`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#correctoptionindex)

* * *

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:9686](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9686)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`description`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#description)

* * *

### encIv?[​](#enciv "Direct link to encIv?")

> `optional` **encIv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9709](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9709)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`encIv`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#enciv)

* * *

### encPayload?[​](#encpayload "Direct link to encPayload?")

> `optional` **encPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9708](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9708)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`encPayload`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#encpayload)

* * *

### encPollVote?[​](#encpollvote "Direct link to encPollVote?")

> `optional` **encPollVote**: `null` | [`IPollEncValue`](/docs/api/namespaces/proto/interfaces/IPollEncValue)

Defined in: [WAProto/index.d.ts:9697](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9697)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`encPollVote`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#encpollvote)

* * *

### encReactionEncIv?[​](#encreactionenciv "Direct link to encReactionEncIv?")

> `optional` **encReactionEncIv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9705](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9705)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`encReactionEncIv`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#encreactionenciv)

* * *

### encReactionEncPayload?[​](#encreactionencpayload "Direct link to encReactionEncPayload?")

> `optional` **encReactionEncPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9704](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9704)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`encReactionEncPayload`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#encreactionencpayload)

* * *

### encReactionTargetMessageKey?[​](#encreactiontargetmessagekey "Direct link to encReactionTargetMessageKey?")

> `optional` **encReactionTargetMessageKey**: `null` | `string`

Defined in: [WAProto/index.d.ts:9703](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9703)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`encReactionTargetMessageKey`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#encreactiontargetmessagekey)

* * *

### eventDescription?[​](#eventdescription "Direct link to eventDescription?")

> `optional` **eventDescription**: `null` | `string`

Defined in: [WAProto/index.d.ts:9712](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9712)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`eventDescription`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#eventdescription)

* * *

### eventEndTime?[​](#eventendtime "Direct link to eventEndTime?")

> `optional` **eventEndTime**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9716](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9716)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`eventEndTime`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#eventendtime)

* * *

### eventExtraGuestsAllowed?[​](#eventextraguestsallowed "Direct link to eventExtraGuestsAllowed?")

> `optional` **eventExtraGuestsAllowed**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9718](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9718)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`eventExtraGuestsAllowed`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#eventextraguestsallowed)

* * *

### eventIsScheduledCall?[​](#eventisscheduledcall "Direct link to eventIsScheduledCall?")

> `optional` **eventIsScheduledCall**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9717](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9717)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`eventIsScheduledCall`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#eventisscheduledcall)

* * *

### eventJoinLink?[​](#eventjoinlink "Direct link to eventJoinLink?")

> `optional` **eventJoinLink**: `null` | `string`

Defined in: [WAProto/index.d.ts:9713](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9713)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`eventJoinLink`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#eventjoinlink)

* * *

### eventLocation?[​](#eventlocation "Direct link to eventLocation?")

> `optional` **eventLocation**: `null` | [`IEventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation)

Defined in: [WAProto/index.d.ts:9715](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9715)

#### Implementation of[​](#implementation-of-17 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`eventLocation`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#eventlocation)

* * *

### eventName?[​](#eventname "Direct link to eventName?")

> `optional` **eventName**: `null` | `string`

Defined in: [WAProto/index.d.ts:9710](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9710)

#### Implementation of[​](#implementation-of-18 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`eventName`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#eventname)

* * *

### eventStartTime?[​](#eventstarttime "Direct link to eventStartTime?")

> `optional` **eventStartTime**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9714](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9714)

#### Implementation of[​](#implementation-of-19 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`eventStartTime`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#eventstarttime)

* * *

### futureproofBuffer?[​](#futureproofbuffer "Direct link to futureproofBuffer?")

> `optional` **futureproofBuffer**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9687](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9687)

#### Implementation of[​](#implementation-of-20 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`futureproofBuffer`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#futureproofbuffer)

* * *

### isEventCanceled?[​](#iseventcanceled "Direct link to isEventCanceled?")

> `optional` **isEventCanceled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9711](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9711)

#### Implementation of[​](#implementation-of-21 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`isEventCanceled`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#iseventcanceled)

* * *

### isLive?[​](#islive "Direct link to isLive?")

> `optional` **isLive**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9680](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9680)

#### Implementation of[​](#implementation-of-22 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`isLive`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#islive)

* * *

### isSentCagPollCreation?[​](#issentcagpollcreation "Direct link to isSentCagPollCreation?")

> `optional` **isSentCagPollCreation**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9698](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9698)

#### Implementation of[​](#implementation-of-23 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`isSentCagPollCreation`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#issentcagpollcreation)

* * *

### lat?[​](#lat "Direct link to lat?")

> `optional` **lat**: `null` | `number`

Defined in: [WAProto/index.d.ts:9681](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9681)

#### Implementation of[​](#implementation-of-24 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`lat`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#lat)

* * *

### lng?[​](#lng "Direct link to lng?")

> `optional` **lng**: `null` | `number`

Defined in: [WAProto/index.d.ts:9679](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9679)

#### Implementation of[​](#implementation-of-25 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`lng`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#lng)

* * *

### loc?[​](#loc "Direct link to loc?")

> `optional` **loc**: `null` | `string`

Defined in: [WAProto/index.d.ts:9689](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9689)

#### Implementation of[​](#implementation-of-26 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`loc`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#loc)

* * *

### matchedText?[​](#matchedtext "Direct link to matchedText?")

> `optional` **matchedText**: `null` | `string`

Defined in: [WAProto/index.d.ts:9684](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9684)

#### Implementation of[​](#implementation-of-27 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`matchedText`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#matchedtext)

* * *

### messageSecret?[​](#messagesecret "Direct link to messageSecret?")

> `optional` **messageSecret**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9693](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9693)

#### Implementation of[​](#implementation-of-28 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`messageSecret`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#messagesecret)

* * *

### originalSelfAuthor?[​](#originalselfauthor "Direct link to originalSelfAuthor?")

> `optional` **originalSelfAuthor**: `null` | `string`

Defined in: [WAProto/index.d.ts:9694](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9694)

#### Implementation of[​](#implementation-of-29 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`originalSelfAuthor`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#originalselfauthor)

* * *

### paymentAmount1000?[​](#paymentamount1000 "Direct link to paymentAmount1000?")

> `optional` **paymentAmount1000**: `null` | `number`

Defined in: [WAProto/index.d.ts:9682](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9682)

#### Implementation of[​](#implementation-of-30 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`paymentAmount1000`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#paymentamount1000)

* * *

### paymentNoteMsgBody?[​](#paymentnotemsgbody "Direct link to paymentNoteMsgBody?")

> `optional` **paymentNoteMsgBody**: `null` | `string`

Defined in: [WAProto/index.d.ts:9683](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9683)

#### Implementation of[​](#implementation-of-31 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`paymentNoteMsgBody`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#paymentnotemsgbody)

* * *

### plainProtobufBytes?[​](#plainprotobufbytes "Direct link to plainProtobufBytes?")

> `optional` **plainProtobufBytes**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9719](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9719)

#### Implementation of[​](#implementation-of-32 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`plainProtobufBytes`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#plainprotobufbytes)

* * *

### pollContentType?[​](#pollcontenttype "Direct link to pollContentType?")

> `optional` **pollContentType**: `null` | [`PollContentType`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/enumerations/PollContentType)

Defined in: [WAProto/index.d.ts:9699](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9699)

#### Implementation of[​](#implementation-of-33 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`pollContentType`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#pollcontenttype)

* * *

### pollName?[​](#pollname "Direct link to pollName?")

> `optional` **pollName**: `null` | `string`

Defined in: [WAProto/index.d.ts:9690](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9690)

#### Implementation of[​](#implementation-of-34 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`pollName`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#pollname)

* * *

### pollOptions[​](#polloptions "Direct link to pollOptions")

> **pollOptions**: [`IPollOption`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollOption)\[\]

Defined in: [WAProto/index.d.ts:9691](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9691)

#### Implementation of[​](#implementation-of-35 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`pollOptions`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#polloptions)

* * *

### pollSelectableOptionsCount?[​](#pollselectableoptionscount "Direct link to pollSelectableOptionsCount?")

> `optional` **pollSelectableOptionsCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:9692](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9692)

#### Implementation of[​](#implementation-of-36 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`pollSelectableOptionsCount`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#pollselectableoptionscount)

* * *

### pollType?[​](#polltype "Direct link to pollType?")

> `optional` **pollType**: `null` | [`PollType`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/enumerations/PollType)

Defined in: [WAProto/index.d.ts:9700](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9700)

#### Implementation of[​](#implementation-of-37 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`pollType`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#polltype)

* * *

### pollUpdateParentKey?[​](#pollupdateparentkey "Direct link to pollUpdateParentKey?")

> `optional` **pollUpdateParentKey**: `null` | `string`

Defined in: [WAProto/index.d.ts:9696](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9696)

#### Implementation of[​](#implementation-of-38 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`pollUpdateParentKey`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#pollupdateparentkey)

* * *

### pollVotesSnapshot?[​](#pollvotessnapshot "Direct link to pollVotesSnapshot?")

> `optional` **pollVotesSnapshot**: `null` | [`IPollVotesSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVotesSnapshot)

Defined in: [WAProto/index.d.ts:9702](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9702)

#### Implementation of[​](#implementation-of-39 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`pollVotesSnapshot`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#pollvotessnapshot)

* * *

### senderTimestampMs?[​](#sendertimestampms "Direct link to senderTimestampMs?")

> `optional` **senderTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9695](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9695)

#### Implementation of[​](#implementation-of-40 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`senderTimestampMs`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#sendertimestampms)

* * *

### targetMessageKey?[​](#targetmessagekey "Direct link to targetMessageKey?")

> `optional` **targetMessageKey**: `null` | `string`

Defined in: [WAProto/index.d.ts:9707](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9707)

#### Implementation of[​](#implementation-of-41 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`targetMessageKey`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#targetmessagekey)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:9685](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9685)

#### Implementation of[​](#implementation-of-42 "Direct link to Implementation of")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData).[`title`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData#title)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9725](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9725)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MsgOpaqueData`](/docs/api/namespaces/proto/classes/MsgOpaqueData)

Defined in: [WAProto/index.d.ts:9720](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9720)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MsgOpaqueData`](/docs/api/namespaces/proto/classes/MsgOpaqueData)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MsgOpaqueData`](/docs/api/namespaces/proto/classes/MsgOpaqueData)

Defined in: [WAProto/index.d.ts:9722](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9722)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MsgOpaqueData`](/docs/api/namespaces/proto/classes/MsgOpaqueData)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9721](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9721)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MsgOpaqueData`](/docs/api/namespaces/proto/classes/MsgOpaqueData)

Defined in: [WAProto/index.d.ts:9723](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9723)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MsgOpaqueData`](/docs/api/namespaces/proto/classes/MsgOpaqueData)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9726](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9726)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9724](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9724)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MsgOpaqueData`](/docs/api/namespaces/proto/classes/MsgOpaqueData)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-msgrowopaquedata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/MsgRowOpaqueData](https://baileys.wiki/docs/api/namespaces/proto/classes/MsgRowOpaqueData)

Defined in: [WAProto/index.d.ts:9826](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9826)

## Implements[​](#implements "Direct link to Implements")

*   [`IMsgRowOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgRowOpaqueData)

## Constructors[​](#constructors "Direct link to Constructors")

### new MsgRowOpaqueData()[​](#new-msgrowopaquedata "Direct link to new MsgRowOpaqueData()")

> **new MsgRowOpaqueData**(`p`?): [`MsgRowOpaqueData`](/docs/api/namespaces/proto/classes/MsgRowOpaqueData)

Defined in: [WAProto/index.d.ts:9827](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9827)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMsgRowOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgRowOpaqueData)

#### Returns[​](#returns "Direct link to Returns")

[`MsgRowOpaqueData`](/docs/api/namespaces/proto/classes/MsgRowOpaqueData)

## Properties[​](#properties "Direct link to Properties")

### currentMsg?[​](#currentmsg "Direct link to currentMsg?")

> `optional` **currentMsg**: `null` | [`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData)

Defined in: [WAProto/index.d.ts:9828](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9828)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMsgRowOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgRowOpaqueData).[`currentMsg`](/docs/api/namespaces/proto/interfaces/IMsgRowOpaqueData#currentmsg)

* * *

### quotedMsg?[​](#quotedmsg "Direct link to quotedMsg?")

> `optional` **quotedMsg**: `null` | [`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData)

Defined in: [WAProto/index.d.ts:9829](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9829)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMsgRowOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgRowOpaqueData).[`quotedMsg`](/docs/api/namespaces/proto/interfaces/IMsgRowOpaqueData#quotedmsg)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9835](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9835)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MsgRowOpaqueData`](/docs/api/namespaces/proto/classes/MsgRowOpaqueData)

Defined in: [WAProto/index.d.ts:9830](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9830)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMsgRowOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgRowOpaqueData)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MsgRowOpaqueData`](/docs/api/namespaces/proto/classes/MsgRowOpaqueData)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MsgRowOpaqueData`](/docs/api/namespaces/proto/classes/MsgRowOpaqueData)

Defined in: [WAProto/index.d.ts:9832](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9832)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MsgRowOpaqueData`](/docs/api/namespaces/proto/classes/MsgRowOpaqueData)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9831](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9831)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMsgRowOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgRowOpaqueData)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MsgRowOpaqueData`](/docs/api/namespaces/proto/classes/MsgRowOpaqueData)

Defined in: [WAProto/index.d.ts:9833](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9833)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MsgRowOpaqueData`](/docs/api/namespaces/proto/classes/MsgRowOpaqueData)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9836](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9836)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9834](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9834)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MsgRowOpaqueData`](/docs/api/namespaces/proto/classes/MsgRowOpaqueData)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-noisecertificate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/NoiseCertificate](https://baileys.wiki/docs/api/namespaces/proto/classes/NoiseCertificate)

Defined in: [WAProto/index.d.ts:9920](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9920)

## Implements[​](#implements "Direct link to Implements")

*   [`INoiseCertificate`](/docs/api/namespaces/proto/interfaces/INoiseCertificate)

## Constructors[​](#constructors "Direct link to Constructors")

### new NoiseCertificate()[​](#new-noisecertificate "Direct link to new NoiseCertificate()")

> **new NoiseCertificate**(`p`?): [`NoiseCertificate`](/docs/api/namespaces/proto/classes/NoiseCertificate)

Defined in: [WAProto/index.d.ts:9921](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9921)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`INoiseCertificate`](/docs/api/namespaces/proto/interfaces/INoiseCertificate)

#### Returns[​](#returns "Direct link to Returns")

[`NoiseCertificate`](/docs/api/namespaces/proto/classes/NoiseCertificate)

## Properties[​](#properties "Direct link to Properties")

### details?[​](#details "Direct link to details?")

> `optional` **details**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9922](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9922)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`INoiseCertificate`](/docs/api/namespaces/proto/interfaces/INoiseCertificate).[`details`](/docs/api/namespaces/proto/interfaces/INoiseCertificate#details)

* * *

### signature?[​](#signature "Direct link to signature?")

> `optional` **signature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9923](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9923)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`INoiseCertificate`](/docs/api/namespaces/proto/interfaces/INoiseCertificate).[`signature`](/docs/api/namespaces/proto/interfaces/INoiseCertificate#signature)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9929](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9929)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`NoiseCertificate`](/docs/api/namespaces/proto/classes/NoiseCertificate)

Defined in: [WAProto/index.d.ts:9924](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9924)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`INoiseCertificate`](/docs/api/namespaces/proto/interfaces/INoiseCertificate)

#### Returns[​](#returns-2 "Direct link to Returns")

[`NoiseCertificate`](/docs/api/namespaces/proto/classes/NoiseCertificate)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`NoiseCertificate`](/docs/api/namespaces/proto/classes/NoiseCertificate)

Defined in: [WAProto/index.d.ts:9926](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9926)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`NoiseCertificate`](/docs/api/namespaces/proto/classes/NoiseCertificate)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9925](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9925)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`INoiseCertificate`](/docs/api/namespaces/proto/interfaces/INoiseCertificate)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`NoiseCertificate`](/docs/api/namespaces/proto/classes/NoiseCertificate)

Defined in: [WAProto/index.d.ts:9927](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9927)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`NoiseCertificate`](/docs/api/namespaces/proto/classes/NoiseCertificate)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9930](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9930)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9928](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9928)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`NoiseCertificate`](/docs/api/namespaces/proto/classes/NoiseCertificate)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-notificationmessageinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/NotificationMessageInfo](https://baileys.wiki/docs/api/namespaces/proto/classes/NotificationMessageInfo)

Defined in: [WAProto/index.d.ts:9967](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9967)

## Implements[​](#implements "Direct link to Implements")

*   [`INotificationMessageInfo`](/docs/api/namespaces/proto/interfaces/INotificationMessageInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new NotificationMessageInfo()[​](#new-notificationmessageinfo "Direct link to new NotificationMessageInfo()")

> **new NotificationMessageInfo**(`p`?): [`NotificationMessageInfo`](/docs/api/namespaces/proto/classes/NotificationMessageInfo)

Defined in: [WAProto/index.d.ts:9968](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9968)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`INotificationMessageInfo`](/docs/api/namespaces/proto/interfaces/INotificationMessageInfo)

#### Returns[​](#returns "Direct link to Returns")

[`NotificationMessageInfo`](/docs/api/namespaces/proto/classes/NotificationMessageInfo)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:9969](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9969)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`INotificationMessageInfo`](/docs/api/namespaces/proto/interfaces/INotificationMessageInfo).[`key`](/docs/api/namespaces/proto/interfaces/INotificationMessageInfo#key)

* * *

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:9970](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9970)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`INotificationMessageInfo`](/docs/api/namespaces/proto/interfaces/INotificationMessageInfo).[`message`](/docs/api/namespaces/proto/interfaces/INotificationMessageInfo#message)

* * *

### messageTimestamp?[​](#messagetimestamp "Direct link to messageTimestamp?")

> `optional` **messageTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9971](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9971)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`INotificationMessageInfo`](/docs/api/namespaces/proto/interfaces/INotificationMessageInfo).[`messageTimestamp`](/docs/api/namespaces/proto/interfaces/INotificationMessageInfo#messagetimestamp)

* * *

### participant?[​](#participant "Direct link to participant?")

> `optional` **participant**: `null` | `string`

Defined in: [WAProto/index.d.ts:9972](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9972)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`INotificationMessageInfo`](/docs/api/namespaces/proto/interfaces/INotificationMessageInfo).[`participant`](/docs/api/namespaces/proto/interfaces/INotificationMessageInfo#participant)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9978](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9978)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`NotificationMessageInfo`](/docs/api/namespaces/proto/classes/NotificationMessageInfo)

Defined in: [WAProto/index.d.ts:9973](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9973)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`INotificationMessageInfo`](/docs/api/namespaces/proto/interfaces/INotificationMessageInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`NotificationMessageInfo`](/docs/api/namespaces/proto/classes/NotificationMessageInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`NotificationMessageInfo`](/docs/api/namespaces/proto/classes/NotificationMessageInfo)

Defined in: [WAProto/index.d.ts:9975](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9975)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`NotificationMessageInfo`](/docs/api/namespaces/proto/classes/NotificationMessageInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9974](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9974)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`INotificationMessageInfo`](/docs/api/namespaces/proto/interfaces/INotificationMessageInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`NotificationMessageInfo`](/docs/api/namespaces/proto/classes/NotificationMessageInfo)

Defined in: [WAProto/index.d.ts:9976](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9976)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`NotificationMessageInfo`](/docs/api/namespaces/proto/classes/NotificationMessageInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9979](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9979)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9977](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9977)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`NotificationMessageInfo`](/docs/api/namespaces/proto/classes/NotificationMessageInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-notificationsettings"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/NotificationSettings](https://baileys.wiki/docs/api/namespaces/proto/classes/NotificationSettings)

Defined in: [WAProto/index.d.ts:9991](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9991)

## Implements[​](#implements "Direct link to Implements")

*   [`INotificationSettings`](/docs/api/namespaces/proto/interfaces/INotificationSettings)

## Constructors[​](#constructors "Direct link to Constructors")

### new NotificationSettings()[​](#new-notificationsettings "Direct link to new NotificationSettings()")

> **new NotificationSettings**(`p`?): [`NotificationSettings`](/docs/api/namespaces/proto/classes/NotificationSettings)

Defined in: [WAProto/index.d.ts:9992](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9992)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`INotificationSettings`](/docs/api/namespaces/proto/interfaces/INotificationSettings)

#### Returns[​](#returns "Direct link to Returns")

[`NotificationSettings`](/docs/api/namespaces/proto/classes/NotificationSettings)

## Properties[​](#properties "Direct link to Properties")

### callVibrate?[​](#callvibrate "Direct link to callVibrate?")

> `optional` **callVibrate**: `null` | `string`

Defined in: [WAProto/index.d.ts:9998](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9998)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`INotificationSettings`](/docs/api/namespaces/proto/interfaces/INotificationSettings).[`callVibrate`](/docs/api/namespaces/proto/interfaces/INotificationSettings#callvibrate)

* * *

### lowPriorityNotifications?[​](#lowprioritynotifications "Direct link to lowPriorityNotifications?")

> `optional` **lowPriorityNotifications**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9996](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9996)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`INotificationSettings`](/docs/api/namespaces/proto/interfaces/INotificationSettings).[`lowPriorityNotifications`](/docs/api/namespaces/proto/interfaces/INotificationSettings#lowprioritynotifications)

* * *

### messageLight?[​](#messagelight "Direct link to messageLight?")

> `optional` **messageLight**: `null` | `string`

Defined in: [WAProto/index.d.ts:9995](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9995)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`INotificationSettings`](/docs/api/namespaces/proto/interfaces/INotificationSettings).[`messageLight`](/docs/api/namespaces/proto/interfaces/INotificationSettings#messagelight)

* * *

### messagePopup?[​](#messagepopup "Direct link to messagePopup?")

> `optional` **messagePopup**: `null` | `string`

Defined in: [WAProto/index.d.ts:9994](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9994)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`INotificationSettings`](/docs/api/namespaces/proto/interfaces/INotificationSettings).[`messagePopup`](/docs/api/namespaces/proto/interfaces/INotificationSettings#messagepopup)

* * *

### messageVibrate?[​](#messagevibrate "Direct link to messageVibrate?")

> `optional` **messageVibrate**: `null` | `string`

Defined in: [WAProto/index.d.ts:9993](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9993)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`INotificationSettings`](/docs/api/namespaces/proto/interfaces/INotificationSettings).[`messageVibrate`](/docs/api/namespaces/proto/interfaces/INotificationSettings#messagevibrate)

* * *

### reactionsMuted?[​](#reactionsmuted "Direct link to reactionsMuted?")

> `optional` **reactionsMuted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9997](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9997)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`INotificationSettings`](/docs/api/namespaces/proto/interfaces/INotificationSettings).[`reactionsMuted`](/docs/api/namespaces/proto/interfaces/INotificationSettings#reactionsmuted)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10004](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10004)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`NotificationSettings`](/docs/api/namespaces/proto/classes/NotificationSettings)

Defined in: [WAProto/index.d.ts:9999](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9999)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`INotificationSettings`](/docs/api/namespaces/proto/interfaces/INotificationSettings)

#### Returns[​](#returns-2 "Direct link to Returns")

[`NotificationSettings`](/docs/api/namespaces/proto/classes/NotificationSettings)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`NotificationSettings`](/docs/api/namespaces/proto/classes/NotificationSettings)

Defined in: [WAProto/index.d.ts:10001](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10001)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`NotificationSettings`](/docs/api/namespaces/proto/classes/NotificationSettings)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10000](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10000)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`INotificationSettings`](/docs/api/namespaces/proto/interfaces/INotificationSettings)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`NotificationSettings`](/docs/api/namespaces/proto/classes/NotificationSettings)

Defined in: [WAProto/index.d.ts:10002](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10002)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`NotificationSettings`](/docs/api/namespaces/proto/classes/NotificationSettings)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10005](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10005)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10003](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10003)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`NotificationSettings`](/docs/api/namespaces/proto/classes/NotificationSettings)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pairingrequest"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/PairingRequest](https://baileys.wiki/docs/api/namespaces/proto/classes/PairingRequest)

Defined in: [WAProto/index.d.ts:10014](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10014)

## Implements[​](#implements "Direct link to Implements")

*   [`IPairingRequest`](/docs/api/namespaces/proto/interfaces/IPairingRequest)

## Constructors[​](#constructors "Direct link to Constructors")

### new PairingRequest()[​](#new-pairingrequest "Direct link to new PairingRequest()")

> **new PairingRequest**(`p`?): [`PairingRequest`](/docs/api/namespaces/proto/classes/PairingRequest)

Defined in: [WAProto/index.d.ts:10015](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10015)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPairingRequest`](/docs/api/namespaces/proto/interfaces/IPairingRequest)

#### Returns[​](#returns "Direct link to Returns")

[`PairingRequest`](/docs/api/namespaces/proto/classes/PairingRequest)

## Properties[​](#properties "Direct link to Properties")

### advSecret?[​](#advsecret "Direct link to advSecret?")

> `optional` **advSecret**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10018](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10018)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPairingRequest`](/docs/api/namespaces/proto/interfaces/IPairingRequest).[`advSecret`](/docs/api/namespaces/proto/interfaces/IPairingRequest#advsecret)

* * *

### companionIdentityKey?[​](#companionidentitykey "Direct link to companionIdentityKey?")

> `optional` **companionIdentityKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10017](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10017)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPairingRequest`](/docs/api/namespaces/proto/interfaces/IPairingRequest).[`companionIdentityKey`](/docs/api/namespaces/proto/interfaces/IPairingRequest#companionidentitykey)

* * *

### companionPublicKey?[​](#companionpublickey "Direct link to companionPublicKey?")

> `optional` **companionPublicKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10016](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10016)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPairingRequest`](/docs/api/namespaces/proto/interfaces/IPairingRequest).[`companionPublicKey`](/docs/api/namespaces/proto/interfaces/IPairingRequest#companionpublickey)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10024](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10024)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PairingRequest`](/docs/api/namespaces/proto/classes/PairingRequest)

Defined in: [WAProto/index.d.ts:10019](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10019)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPairingRequest`](/docs/api/namespaces/proto/interfaces/IPairingRequest)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PairingRequest`](/docs/api/namespaces/proto/classes/PairingRequest)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PairingRequest`](/docs/api/namespaces/proto/classes/PairingRequest)

Defined in: [WAProto/index.d.ts:10021](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10021)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PairingRequest`](/docs/api/namespaces/proto/classes/PairingRequest)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10020](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10020)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPairingRequest`](/docs/api/namespaces/proto/interfaces/IPairingRequest)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PairingRequest`](/docs/api/namespaces/proto/classes/PairingRequest)

Defined in: [WAProto/index.d.ts:10022](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10022)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PairingRequest`](/docs/api/namespaces/proto/classes/PairingRequest)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10025](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10025)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10023](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10023)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PairingRequest`](/docs/api/namespaces/proto/classes/PairingRequest)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pastparticipant"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/PastParticipant](https://baileys.wiki/docs/api/namespaces/proto/classes/PastParticipant)

Defined in: [WAProto/index.d.ts:10034](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10034)

## Implements[​](#implements "Direct link to Implements")

*   [`IPastParticipant`](/docs/api/namespaces/proto/interfaces/IPastParticipant)

## Constructors[​](#constructors "Direct link to Constructors")

### new PastParticipant()[​](#new-pastparticipant "Direct link to new PastParticipant()")

> **new PastParticipant**(`p`?): [`PastParticipant`](/docs/api/namespaces/proto/classes/PastParticipant)

Defined in: [WAProto/index.d.ts:10035](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10035)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPastParticipant`](/docs/api/namespaces/proto/interfaces/IPastParticipant)

#### Returns[​](#returns "Direct link to Returns")

[`PastParticipant`](/docs/api/namespaces/proto/classes/PastParticipant)

## Properties[​](#properties "Direct link to Properties")

### leaveReason?[​](#leavereason "Direct link to leaveReason?")

> `optional` **leaveReason**: `null` | [`LeaveReason`](/docs/api/namespaces/proto/namespaces/PastParticipant/enumerations/LeaveReason)

Defined in: [WAProto/index.d.ts:10037](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10037)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPastParticipant`](/docs/api/namespaces/proto/interfaces/IPastParticipant).[`leaveReason`](/docs/api/namespaces/proto/interfaces/IPastParticipant#leavereason)

* * *

### leaveTs?[​](#leavets "Direct link to leaveTs?")

> `optional` **leaveTs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10038](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10038)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPastParticipant`](/docs/api/namespaces/proto/interfaces/IPastParticipant).[`leaveTs`](/docs/api/namespaces/proto/interfaces/IPastParticipant#leavets)

* * *

### userJid?[​](#userjid "Direct link to userJid?")

> `optional` **userJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:10036](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10036)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPastParticipant`](/docs/api/namespaces/proto/interfaces/IPastParticipant).[`userJid`](/docs/api/namespaces/proto/interfaces/IPastParticipant#userjid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10044](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10044)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PastParticipant`](/docs/api/namespaces/proto/classes/PastParticipant)

Defined in: [WAProto/index.d.ts:10039](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10039)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPastParticipant`](/docs/api/namespaces/proto/interfaces/IPastParticipant)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PastParticipant`](/docs/api/namespaces/proto/classes/PastParticipant)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PastParticipant`](/docs/api/namespaces/proto/classes/PastParticipant)

Defined in: [WAProto/index.d.ts:10041](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10041)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PastParticipant`](/docs/api/namespaces/proto/classes/PastParticipant)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10040](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10040)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPastParticipant`](/docs/api/namespaces/proto/interfaces/IPastParticipant)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PastParticipant`](/docs/api/namespaces/proto/classes/PastParticipant)

Defined in: [WAProto/index.d.ts:10042](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10042)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PastParticipant`](/docs/api/namespaces/proto/classes/PastParticipant)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10045](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10045)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10043](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10043)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PastParticipant`](/docs/api/namespaces/proto/classes/PastParticipant)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pastparticipants"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/PastParticipants](https://baileys.wiki/docs/api/namespaces/proto/classes/PastParticipants)

Defined in: [WAProto/index.d.ts:10061](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10061)

## Implements[​](#implements "Direct link to Implements")

*   [`IPastParticipants`](/docs/api/namespaces/proto/interfaces/IPastParticipants)

## Constructors[​](#constructors "Direct link to Constructors")

### new PastParticipants()[​](#new-pastparticipants "Direct link to new PastParticipants()")

> **new PastParticipants**(`p`?): [`PastParticipants`](/docs/api/namespaces/proto/classes/PastParticipants)

Defined in: [WAProto/index.d.ts:10062](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10062)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPastParticipants`](/docs/api/namespaces/proto/interfaces/IPastParticipants)

#### Returns[​](#returns "Direct link to Returns")

[`PastParticipants`](/docs/api/namespaces/proto/classes/PastParticipants)

## Properties[​](#properties "Direct link to Properties")

### groupJid?[​](#groupjid "Direct link to groupJid?")

> `optional` **groupJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:10063](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10063)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPastParticipants`](/docs/api/namespaces/proto/interfaces/IPastParticipants).[`groupJid`](/docs/api/namespaces/proto/interfaces/IPastParticipants#groupjid)

* * *

### pastParticipants[​](#pastparticipants "Direct link to pastParticipants")

> **pastParticipants**: [`IPastParticipant`](/docs/api/namespaces/proto/interfaces/IPastParticipant)\[\]

Defined in: [WAProto/index.d.ts:10064](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10064)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPastParticipants`](/docs/api/namespaces/proto/interfaces/IPastParticipants).[`pastParticipants`](/docs/api/namespaces/proto/interfaces/IPastParticipants#pastparticipants)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10070](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10070)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PastParticipants`](/docs/api/namespaces/proto/classes/PastParticipants)

Defined in: [WAProto/index.d.ts:10065](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10065)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPastParticipants`](/docs/api/namespaces/proto/interfaces/IPastParticipants)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PastParticipants`](/docs/api/namespaces/proto/classes/PastParticipants)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PastParticipants`](/docs/api/namespaces/proto/classes/PastParticipants)

Defined in: [WAProto/index.d.ts:10067](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10067)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PastParticipants`](/docs/api/namespaces/proto/classes/PastParticipants)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10066](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10066)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPastParticipants`](/docs/api/namespaces/proto/interfaces/IPastParticipants)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PastParticipants`](/docs/api/namespaces/proto/classes/PastParticipants)

Defined in: [WAProto/index.d.ts:10068](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10068)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PastParticipants`](/docs/api/namespaces/proto/classes/PastParticipants)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10071](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10071)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10069](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10069)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PastParticipants`](/docs/api/namespaces/proto/classes/PastParticipants)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-patchdebugdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/PatchDebugData](https://baileys.wiki/docs/api/namespaces/proto/classes/PatchDebugData)

Defined in: [WAProto/index.d.ts:10088](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10088)

## Implements[​](#implements "Direct link to Implements")

*   [`IPatchDebugData`](/docs/api/namespaces/proto/interfaces/IPatchDebugData)

## Constructors[​](#constructors "Direct link to Constructors")

### new PatchDebugData()[​](#new-patchdebugdata "Direct link to new PatchDebugData()")

> **new PatchDebugData**(`p`?): [`PatchDebugData`](/docs/api/namespaces/proto/classes/PatchDebugData)

Defined in: [WAProto/index.d.ts:10089](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10089)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPatchDebugData`](/docs/api/namespaces/proto/interfaces/IPatchDebugData)

#### Returns[​](#returns "Direct link to Returns")

[`PatchDebugData`](/docs/api/namespaces/proto/classes/PatchDebugData)

## Properties[​](#properties "Direct link to Properties")

### collectionName?[​](#collectionname "Direct link to collectionName?")

> `optional` **collectionName**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10093](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10093)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPatchDebugData`](/docs/api/namespaces/proto/interfaces/IPatchDebugData).[`collectionName`](/docs/api/namespaces/proto/interfaces/IPatchDebugData#collectionname)

* * *

### currentLthash?[​](#currentlthash "Direct link to currentLthash?")

> `optional` **currentLthash**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10090](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10090)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPatchDebugData`](/docs/api/namespaces/proto/interfaces/IPatchDebugData).[`currentLthash`](/docs/api/namespaces/proto/interfaces/IPatchDebugData#currentlthash)

* * *

### firstFourBytesFromAHashOfSnapshotMacKey?[​](#firstfourbytesfromahashofsnapshotmackey "Direct link to firstFourBytesFromAHashOfSnapshotMacKey?")

> `optional` **firstFourBytesFromAHashOfSnapshotMacKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10094](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10094)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPatchDebugData`](/docs/api/namespaces/proto/interfaces/IPatchDebugData).[`firstFourBytesFromAHashOfSnapshotMacKey`](/docs/api/namespaces/proto/interfaces/IPatchDebugData#firstfourbytesfromahashofsnapshotmackey)

* * *

### isSenderPrimary?[​](#issenderprimary "Direct link to isSenderPrimary?")

> `optional` **isSenderPrimary**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:10100](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10100)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IPatchDebugData`](/docs/api/namespaces/proto/interfaces/IPatchDebugData).[`isSenderPrimary`](/docs/api/namespaces/proto/interfaces/IPatchDebugData#issenderprimary)

* * *

### newLthash?[​](#newlthash "Direct link to newLthash?")

> `optional` **newLthash**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10091](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10091)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IPatchDebugData`](/docs/api/namespaces/proto/interfaces/IPatchDebugData).[`newLthash`](/docs/api/namespaces/proto/interfaces/IPatchDebugData#newlthash)

* * *

### newLthashSubtract?[​](#newlthashsubtract "Direct link to newLthashSubtract?")

> `optional` **newLthashSubtract**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10095](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10095)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IPatchDebugData`](/docs/api/namespaces/proto/interfaces/IPatchDebugData).[`newLthashSubtract`](/docs/api/namespaces/proto/interfaces/IPatchDebugData#newlthashsubtract)

* * *

### numberAdd?[​](#numberadd "Direct link to numberAdd?")

> `optional` **numberAdd**: `null` | `number`

Defined in: [WAProto/index.d.ts:10096](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10096)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IPatchDebugData`](/docs/api/namespaces/proto/interfaces/IPatchDebugData).[`numberAdd`](/docs/api/namespaces/proto/interfaces/IPatchDebugData#numberadd)

* * *

### numberOverride?[​](#numberoverride "Direct link to numberOverride?")

> `optional` **numberOverride**: `null` | `number`

Defined in: [WAProto/index.d.ts:10098](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10098)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IPatchDebugData`](/docs/api/namespaces/proto/interfaces/IPatchDebugData).[`numberOverride`](/docs/api/namespaces/proto/interfaces/IPatchDebugData#numberoverride)

* * *

### numberRemove?[​](#numberremove "Direct link to numberRemove?")

> `optional` **numberRemove**: `null` | `number`

Defined in: [WAProto/index.d.ts:10097](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10097)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IPatchDebugData`](/docs/api/namespaces/proto/interfaces/IPatchDebugData).[`numberRemove`](/docs/api/namespaces/proto/interfaces/IPatchDebugData#numberremove)

* * *

### patchVersion?[​](#patchversion "Direct link to patchVersion?")

> `optional` **patchVersion**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10092](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10092)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IPatchDebugData`](/docs/api/namespaces/proto/interfaces/IPatchDebugData).[`patchVersion`](/docs/api/namespaces/proto/interfaces/IPatchDebugData#patchversion)

* * *

### senderPlatform?[​](#senderplatform "Direct link to senderPlatform?")

> `optional` **senderPlatform**: `null` | [`Platform`](/docs/api/namespaces/proto/namespaces/PatchDebugData/enumerations/Platform)

Defined in: [WAProto/index.d.ts:10099](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10099)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IPatchDebugData`](/docs/api/namespaces/proto/interfaces/IPatchDebugData).[`senderPlatform`](/docs/api/namespaces/proto/interfaces/IPatchDebugData#senderplatform)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10106](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10106)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PatchDebugData`](/docs/api/namespaces/proto/classes/PatchDebugData)

Defined in: [WAProto/index.d.ts:10101](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10101)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPatchDebugData`](/docs/api/namespaces/proto/interfaces/IPatchDebugData)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PatchDebugData`](/docs/api/namespaces/proto/classes/PatchDebugData)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PatchDebugData`](/docs/api/namespaces/proto/classes/PatchDebugData)

Defined in: [WAProto/index.d.ts:10103](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10103)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PatchDebugData`](/docs/api/namespaces/proto/classes/PatchDebugData)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10102](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10102)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPatchDebugData`](/docs/api/namespaces/proto/interfaces/IPatchDebugData)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PatchDebugData`](/docs/api/namespaces/proto/classes/PatchDebugData)

Defined in: [WAProto/index.d.ts:10104](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10104)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PatchDebugData`](/docs/api/namespaces/proto/classes/PatchDebugData)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10107](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10107)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10105](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10105)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PatchDebugData`](/docs/api/namespaces/proto/classes/PatchDebugData)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-paymentbackground"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/PaymentBackground](https://baileys.wiki/docs/api/namespaces/proto/classes/PaymentBackground)

Defined in: [WAProto/index.d.ts:10141](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10141)

## Implements[​](#implements "Direct link to Implements")

*   [`IPaymentBackground`](/docs/api/namespaces/proto/interfaces/IPaymentBackground)

## Constructors[​](#constructors "Direct link to Constructors")

### new PaymentBackground()[​](#new-paymentbackground "Direct link to new PaymentBackground()")

> **new PaymentBackground**(`p`?): [`PaymentBackground`](/docs/api/namespaces/proto/classes/PaymentBackground)

Defined in: [WAProto/index.d.ts:10142](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10142)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPaymentBackground`](/docs/api/namespaces/proto/interfaces/IPaymentBackground)

#### Returns[​](#returns "Direct link to Returns")

[`PaymentBackground`](/docs/api/namespaces/proto/classes/PaymentBackground)

## Properties[​](#properties "Direct link to Properties")

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10144](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10144)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPaymentBackground`](/docs/api/namespaces/proto/interfaces/IPaymentBackground).[`fileLength`](/docs/api/namespaces/proto/interfaces/IPaymentBackground#filelength)

* * *

### height?[​](#height "Direct link to height?")

> `optional` **height**: `null` | `number`

Defined in: [WAProto/index.d.ts:10146](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10146)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPaymentBackground`](/docs/api/namespaces/proto/interfaces/IPaymentBackground).[`height`](/docs/api/namespaces/proto/interfaces/IPaymentBackground#height)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:10143](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10143)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPaymentBackground`](/docs/api/namespaces/proto/interfaces/IPaymentBackground).[`id`](/docs/api/namespaces/proto/interfaces/IPaymentBackground#id)

* * *

### mediaData?[​](#mediadata "Direct link to mediaData?")

> `optional` **mediaData**: `null` | [`IMediaData`](/docs/api/namespaces/proto/namespaces/PaymentBackground/interfaces/IMediaData)

Defined in: [WAProto/index.d.ts:10151](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10151)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IPaymentBackground`](/docs/api/namespaces/proto/interfaces/IPaymentBackground).[`mediaData`](/docs/api/namespaces/proto/interfaces/IPaymentBackground#mediadata)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:10147](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10147)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IPaymentBackground`](/docs/api/namespaces/proto/interfaces/IPaymentBackground).[`mimetype`](/docs/api/namespaces/proto/interfaces/IPaymentBackground#mimetype)

* * *

### placeholderArgb?[​](#placeholderargb "Direct link to placeholderArgb?")

> `optional` **placeholderArgb**: `null` | `number`

Defined in: [WAProto/index.d.ts:10148](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10148)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IPaymentBackground`](/docs/api/namespaces/proto/interfaces/IPaymentBackground).[`placeholderArgb`](/docs/api/namespaces/proto/interfaces/IPaymentBackground#placeholderargb)

* * *

### subtextArgb?[​](#subtextargb "Direct link to subtextArgb?")

> `optional` **subtextArgb**: `null` | `number`

Defined in: [WAProto/index.d.ts:10150](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10150)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IPaymentBackground`](/docs/api/namespaces/proto/interfaces/IPaymentBackground).[`subtextArgb`](/docs/api/namespaces/proto/interfaces/IPaymentBackground#subtextargb)

* * *

### textArgb?[​](#textargb "Direct link to textArgb?")

> `optional` **textArgb**: `null` | `number`

Defined in: [WAProto/index.d.ts:10149](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10149)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IPaymentBackground`](/docs/api/namespaces/proto/interfaces/IPaymentBackground).[`textArgb`](/docs/api/namespaces/proto/interfaces/IPaymentBackground#textargb)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`Type`](/docs/api/namespaces/proto/namespaces/PaymentBackground/enumerations/Type)

Defined in: [WAProto/index.d.ts:10152](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10152)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IPaymentBackground`](/docs/api/namespaces/proto/interfaces/IPaymentBackground).[`type`](/docs/api/namespaces/proto/interfaces/IPaymentBackground#type)

* * *

### width?[​](#width "Direct link to width?")

> `optional` **width**: `null` | `number`

Defined in: [WAProto/index.d.ts:10145](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10145)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IPaymentBackground`](/docs/api/namespaces/proto/interfaces/IPaymentBackground).[`width`](/docs/api/namespaces/proto/interfaces/IPaymentBackground#width)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10158](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10158)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PaymentBackground`](/docs/api/namespaces/proto/classes/PaymentBackground)

Defined in: [WAProto/index.d.ts:10153](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10153)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPaymentBackground`](/docs/api/namespaces/proto/interfaces/IPaymentBackground)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PaymentBackground`](/docs/api/namespaces/proto/classes/PaymentBackground)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PaymentBackground`](/docs/api/namespaces/proto/classes/PaymentBackground)

Defined in: [WAProto/index.d.ts:10155](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10155)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PaymentBackground`](/docs/api/namespaces/proto/classes/PaymentBackground)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10154](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10154)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPaymentBackground`](/docs/api/namespaces/proto/interfaces/IPaymentBackground)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PaymentBackground`](/docs/api/namespaces/proto/classes/PaymentBackground)

Defined in: [WAProto/index.d.ts:10156](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10156)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PaymentBackground`](/docs/api/namespaces/proto/classes/PaymentBackground)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10159](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10159)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10157](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10157)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PaymentBackground`](/docs/api/namespaces/proto/classes/PaymentBackground)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-paymentinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/PaymentInfo](https://baileys.wiki/docs/api/namespaces/proto/classes/PaymentInfo)

Defined in: [WAProto/index.d.ts:10210](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10210)

## Implements[​](#implements "Direct link to Implements")

*   [`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new PaymentInfo()[​](#new-paymentinfo "Direct link to new PaymentInfo()")

> **new PaymentInfo**(`p`?): [`PaymentInfo`](/docs/api/namespaces/proto/classes/PaymentInfo)

Defined in: [WAProto/index.d.ts:10211](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10211)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo)

#### Returns[​](#returns "Direct link to Returns")

[`PaymentInfo`](/docs/api/namespaces/proto/classes/PaymentInfo)

## Properties[​](#properties "Direct link to Properties")

### amount1000?[​](#amount1000 "Direct link to amount1000?")

> `optional` **amount1000**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10213](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10213)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo).[`amount1000`](/docs/api/namespaces/proto/interfaces/IPaymentInfo#amount1000)

* * *

### currency?[​](#currency "Direct link to currency?")

> `optional` **currency**: `null` | `string`

Defined in: [WAProto/index.d.ts:10220](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10220)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo).[`currency`](/docs/api/namespaces/proto/interfaces/IPaymentInfo#currency)

* * *

### currencyDeprecated?[​](#currencydeprecated "Direct link to currencyDeprecated?")

> `optional` **currencyDeprecated**: `null` | [`Currency`](/docs/api/namespaces/proto/namespaces/PaymentInfo/enumerations/Currency)

Defined in: [WAProto/index.d.ts:10212](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10212)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo).[`currencyDeprecated`](/docs/api/namespaces/proto/interfaces/IPaymentInfo#currencydeprecated)

* * *

### exchangeAmount?[​](#exchangeamount "Direct link to exchangeAmount?")

> `optional` **exchangeAmount**: `null` | [`IMoney`](/docs/api/namespaces/proto/interfaces/IMoney)

Defined in: [WAProto/index.d.ts:10224](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10224)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo).[`exchangeAmount`](/docs/api/namespaces/proto/interfaces/IPaymentInfo#exchangeamount)

* * *

### expiryTimestamp?[​](#expirytimestamp "Direct link to expiryTimestamp?")

> `optional` **expiryTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10218](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10218)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo).[`expiryTimestamp`](/docs/api/namespaces/proto/interfaces/IPaymentInfo#expirytimestamp)

* * *

### futureproofed?[​](#futureproofed "Direct link to futureproofed?")

> `optional` **futureproofed**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:10219](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10219)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo).[`futureproofed`](/docs/api/namespaces/proto/interfaces/IPaymentInfo#futureproofed)

* * *

### primaryAmount?[​](#primaryamount "Direct link to primaryAmount?")

> `optional` **primaryAmount**: `null` | [`IMoney`](/docs/api/namespaces/proto/interfaces/IMoney)

Defined in: [WAProto/index.d.ts:10223](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10223)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo).[`primaryAmount`](/docs/api/namespaces/proto/interfaces/IPaymentInfo#primaryamount)

* * *

### receiverJid?[​](#receiverjid "Direct link to receiverJid?")

> `optional` **receiverJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:10214](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10214)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo).[`receiverJid`](/docs/api/namespaces/proto/interfaces/IPaymentInfo#receiverjid)

* * *

### requestMessageKey?[​](#requestmessagekey "Direct link to requestMessageKey?")

> `optional` **requestMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:10217](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10217)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo).[`requestMessageKey`](/docs/api/namespaces/proto/interfaces/IPaymentInfo#requestmessagekey)

* * *

### status?[​](#status "Direct link to status?")

> `optional` **status**: `null` | [`Status`](/docs/api/namespaces/proto/namespaces/PaymentInfo/enumerations/Status)

Defined in: [WAProto/index.d.ts:10215](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10215)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo).[`status`](/docs/api/namespaces/proto/interfaces/IPaymentInfo#status)

* * *

### transactionTimestamp?[​](#transactiontimestamp "Direct link to transactionTimestamp?")

> `optional` **transactionTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10216](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10216)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo).[`transactionTimestamp`](/docs/api/namespaces/proto/interfaces/IPaymentInfo#transactiontimestamp)

* * *

### txnStatus?[​](#txnstatus "Direct link to txnStatus?")

> `optional` **txnStatus**: `null` | [`TxnStatus`](/docs/api/namespaces/proto/namespaces/PaymentInfo/enumerations/TxnStatus)

Defined in: [WAProto/index.d.ts:10221](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10221)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo).[`txnStatus`](/docs/api/namespaces/proto/interfaces/IPaymentInfo#txnstatus)

* * *

### useNoviFiatFormat?[​](#usenovifiatformat "Direct link to useNoviFiatFormat?")

> `optional` **useNoviFiatFormat**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:10222](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10222)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo).[`useNoviFiatFormat`](/docs/api/namespaces/proto/interfaces/IPaymentInfo#usenovifiatformat)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10230](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10230)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PaymentInfo`](/docs/api/namespaces/proto/classes/PaymentInfo)

Defined in: [WAProto/index.d.ts:10225](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10225)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PaymentInfo`](/docs/api/namespaces/proto/classes/PaymentInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PaymentInfo`](/docs/api/namespaces/proto/classes/PaymentInfo)

Defined in: [WAProto/index.d.ts:10227](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10227)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PaymentInfo`](/docs/api/namespaces/proto/classes/PaymentInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10226](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10226)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PaymentInfo`](/docs/api/namespaces/proto/classes/PaymentInfo)

Defined in: [WAProto/index.d.ts:10228](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10228)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PaymentInfo`](/docs/api/namespaces/proto/classes/PaymentInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10231](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10231)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10229](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10229)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PaymentInfo`](/docs/api/namespaces/proto/classes/PaymentInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-phonenumbertolidmapping"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/PhoneNumberToLIDMapping](https://baileys.wiki/docs/api/namespaces/proto/classes/PhoneNumberToLIDMapping)

Defined in: [WAProto/index.d.ts:10297](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10297)

## Implements[​](#implements "Direct link to Implements")

*   [`IPhoneNumberToLIDMapping`](/docs/api/namespaces/proto/interfaces/IPhoneNumberToLIDMapping)

## Constructors[​](#constructors "Direct link to Constructors")

### new PhoneNumberToLIDMapping()[​](#new-phonenumbertolidmapping "Direct link to new PhoneNumberToLIDMapping()")

> **new PhoneNumberToLIDMapping**(`p`?): [`PhoneNumberToLIDMapping`](/docs/api/namespaces/proto/classes/PhoneNumberToLIDMapping)

Defined in: [WAProto/index.d.ts:10298](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10298)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPhoneNumberToLIDMapping`](/docs/api/namespaces/proto/interfaces/IPhoneNumberToLIDMapping)

#### Returns[​](#returns "Direct link to Returns")

[`PhoneNumberToLIDMapping`](/docs/api/namespaces/proto/classes/PhoneNumberToLIDMapping)

## Properties[​](#properties "Direct link to Properties")

### lidJid?[​](#lidjid "Direct link to lidJid?")

> `optional` **lidJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:10300](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10300)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPhoneNumberToLIDMapping`](/docs/api/namespaces/proto/interfaces/IPhoneNumberToLIDMapping).[`lidJid`](/docs/api/namespaces/proto/interfaces/IPhoneNumberToLIDMapping#lidjid)

* * *

### pnJid?[​](#pnjid "Direct link to pnJid?")

> `optional` **pnJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:10299](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10299)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPhoneNumberToLIDMapping`](/docs/api/namespaces/proto/interfaces/IPhoneNumberToLIDMapping).[`pnJid`](/docs/api/namespaces/proto/interfaces/IPhoneNumberToLIDMapping#pnjid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10306](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10306)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PhoneNumberToLIDMapping`](/docs/api/namespaces/proto/classes/PhoneNumberToLIDMapping)

Defined in: [WAProto/index.d.ts:10301](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10301)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPhoneNumberToLIDMapping`](/docs/api/namespaces/proto/interfaces/IPhoneNumberToLIDMapping)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PhoneNumberToLIDMapping`](/docs/api/namespaces/proto/classes/PhoneNumberToLIDMapping)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PhoneNumberToLIDMapping`](/docs/api/namespaces/proto/classes/PhoneNumberToLIDMapping)

Defined in: [WAProto/index.d.ts:10303](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10303)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PhoneNumberToLIDMapping`](/docs/api/namespaces/proto/classes/PhoneNumberToLIDMapping)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10302](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10302)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPhoneNumberToLIDMapping`](/docs/api/namespaces/proto/interfaces/IPhoneNumberToLIDMapping)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PhoneNumberToLIDMapping`](/docs/api/namespaces/proto/classes/PhoneNumberToLIDMapping)

Defined in: [WAProto/index.d.ts:10304](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10304)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PhoneNumberToLIDMapping`](/docs/api/namespaces/proto/classes/PhoneNumberToLIDMapping)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10307](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10307)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10305](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10305)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PhoneNumberToLIDMapping`](/docs/api/namespaces/proto/classes/PhoneNumberToLIDMapping)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-photochange"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/PhotoChange](https://baileys.wiki/docs/api/namespaces/proto/classes/PhotoChange)

Defined in: [WAProto/index.d.ts:10316](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10316)

## Implements[​](#implements "Direct link to Implements")

*   [`IPhotoChange`](/docs/api/namespaces/proto/interfaces/IPhotoChange)

## Constructors[​](#constructors "Direct link to Constructors")

### new PhotoChange()[​](#new-photochange "Direct link to new PhotoChange()")

> **new PhotoChange**(`p`?): [`PhotoChange`](/docs/api/namespaces/proto/classes/PhotoChange)

Defined in: [WAProto/index.d.ts:10317](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10317)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPhotoChange`](/docs/api/namespaces/proto/interfaces/IPhotoChange)

#### Returns[​](#returns "Direct link to Returns")

[`PhotoChange`](/docs/api/namespaces/proto/classes/PhotoChange)

## Properties[​](#properties "Direct link to Properties")

### newPhoto?[​](#newphoto "Direct link to newPhoto?")

> `optional` **newPhoto**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10319](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10319)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPhotoChange`](/docs/api/namespaces/proto/interfaces/IPhotoChange).[`newPhoto`](/docs/api/namespaces/proto/interfaces/IPhotoChange#newphoto)

* * *

### newPhotoId?[​](#newphotoid "Direct link to newPhotoId?")

> `optional` **newPhotoId**: `null` | `number`

Defined in: [WAProto/index.d.ts:10320](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10320)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPhotoChange`](/docs/api/namespaces/proto/interfaces/IPhotoChange).[`newPhotoId`](/docs/api/namespaces/proto/interfaces/IPhotoChange#newphotoid)

* * *

### oldPhoto?[​](#oldphoto "Direct link to oldPhoto?")

> `optional` **oldPhoto**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10318](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10318)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPhotoChange`](/docs/api/namespaces/proto/interfaces/IPhotoChange).[`oldPhoto`](/docs/api/namespaces/proto/interfaces/IPhotoChange#oldphoto)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10326](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10326)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PhotoChange`](/docs/api/namespaces/proto/classes/PhotoChange)

Defined in: [WAProto/index.d.ts:10321](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10321)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPhotoChange`](/docs/api/namespaces/proto/interfaces/IPhotoChange)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PhotoChange`](/docs/api/namespaces/proto/classes/PhotoChange)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PhotoChange`](/docs/api/namespaces/proto/classes/PhotoChange)

Defined in: [WAProto/index.d.ts:10323](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10323)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PhotoChange`](/docs/api/namespaces/proto/classes/PhotoChange)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10322](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10322)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPhotoChange`](/docs/api/namespaces/proto/interfaces/IPhotoChange)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PhotoChange`](/docs/api/namespaces/proto/classes/PhotoChange)

Defined in: [WAProto/index.d.ts:10324](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10324)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PhotoChange`](/docs/api/namespaces/proto/classes/PhotoChange)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10327](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10327)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10325](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10325)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PhotoChange`](/docs/api/namespaces/proto/classes/PhotoChange)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pininchat"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/PinInChat](https://baileys.wiki/docs/api/namespaces/proto/classes/PinInChat)

Defined in: [WAProto/index.d.ts:10338](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10338)

## Implements[​](#implements "Direct link to Implements")

*   [`IPinInChat`](/docs/api/namespaces/proto/interfaces/IPinInChat)

## Constructors[​](#constructors "Direct link to Constructors")

### new PinInChat()[​](#new-pininchat "Direct link to new PinInChat()")

> **new PinInChat**(`p`?): [`PinInChat`](/docs/api/namespaces/proto/classes/PinInChat)

Defined in: [WAProto/index.d.ts:10339](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10339)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPinInChat`](/docs/api/namespaces/proto/interfaces/IPinInChat)

#### Returns[​](#returns "Direct link to Returns")

[`PinInChat`](/docs/api/namespaces/proto/classes/PinInChat)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:10341](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10341)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPinInChat`](/docs/api/namespaces/proto/interfaces/IPinInChat).[`key`](/docs/api/namespaces/proto/interfaces/IPinInChat#key)

* * *

### messageAddOnContextInfo?[​](#messageaddoncontextinfo "Direct link to messageAddOnContextInfo?")

> `optional` **messageAddOnContextInfo**: `null` | [`IMessageAddOnContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageAddOnContextInfo)

Defined in: [WAProto/index.d.ts:10344](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10344)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPinInChat`](/docs/api/namespaces/proto/interfaces/IPinInChat).[`messageAddOnContextInfo`](/docs/api/namespaces/proto/interfaces/IPinInChat#messageaddoncontextinfo)

* * *

### senderTimestampMs?[​](#sendertimestampms "Direct link to senderTimestampMs?")

> `optional` **senderTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10342](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10342)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPinInChat`](/docs/api/namespaces/proto/interfaces/IPinInChat).[`senderTimestampMs`](/docs/api/namespaces/proto/interfaces/IPinInChat#sendertimestampms)

* * *

### serverTimestampMs?[​](#servertimestampms "Direct link to serverTimestampMs?")

> `optional` **serverTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10343](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10343)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IPinInChat`](/docs/api/namespaces/proto/interfaces/IPinInChat).[`serverTimestampMs`](/docs/api/namespaces/proto/interfaces/IPinInChat#servertimestampms)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`Type`](/docs/api/namespaces/proto/namespaces/PinInChat/enumerations/Type)

Defined in: [WAProto/index.d.ts:10340](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10340)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IPinInChat`](/docs/api/namespaces/proto/interfaces/IPinInChat).[`type`](/docs/api/namespaces/proto/interfaces/IPinInChat#type)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10350](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10350)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PinInChat`](/docs/api/namespaces/proto/classes/PinInChat)

Defined in: [WAProto/index.d.ts:10345](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10345)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPinInChat`](/docs/api/namespaces/proto/interfaces/IPinInChat)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PinInChat`](/docs/api/namespaces/proto/classes/PinInChat)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PinInChat`](/docs/api/namespaces/proto/classes/PinInChat)

Defined in: [WAProto/index.d.ts:10347](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10347)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PinInChat`](/docs/api/namespaces/proto/classes/PinInChat)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10346](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10346)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPinInChat`](/docs/api/namespaces/proto/interfaces/IPinInChat)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PinInChat`](/docs/api/namespaces/proto/classes/PinInChat)

Defined in: [WAProto/index.d.ts:10348](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10348)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PinInChat`](/docs/api/namespaces/proto/classes/PinInChat)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10351](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10351)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10349](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10349)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PinInChat`](/docs/api/namespaces/proto/classes/PinInChat)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-point"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/Point](https://baileys.wiki/docs/api/namespaces/proto/classes/Point)

Defined in: [WAProto/index.d.ts:10370](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10370)

## Implements[​](#implements "Direct link to Implements")

*   [`IPoint`](/docs/api/namespaces/proto/interfaces/IPoint)

## Constructors[​](#constructors "Direct link to Constructors")

### new Point()[​](#new-point "Direct link to new Point()")

> **new Point**(`p`?): [`Point`](/docs/api/namespaces/proto/classes/Point)

Defined in: [WAProto/index.d.ts:10371](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10371)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPoint`](/docs/api/namespaces/proto/interfaces/IPoint)

#### Returns[​](#returns "Direct link to Returns")

[`Point`](/docs/api/namespaces/proto/classes/Point)

## Properties[​](#properties "Direct link to Properties")

### x?[​](#x "Direct link to x?")

> `optional` **x**: `null` | `number`

Defined in: [WAProto/index.d.ts:10374](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10374)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPoint`](/docs/api/namespaces/proto/interfaces/IPoint).[`x`](/docs/api/namespaces/proto/interfaces/IPoint#x)

* * *

### xDeprecated?[​](#xdeprecated "Direct link to xDeprecated?")

> `optional` **xDeprecated**: `null` | `number`

Defined in: [WAProto/index.d.ts:10372](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10372)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPoint`](/docs/api/namespaces/proto/interfaces/IPoint).[`xDeprecated`](/docs/api/namespaces/proto/interfaces/IPoint#xdeprecated)

* * *

### y?[​](#y "Direct link to y?")

> `optional` **y**: `null` | `number`

Defined in: [WAProto/index.d.ts:10375](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10375)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPoint`](/docs/api/namespaces/proto/interfaces/IPoint).[`y`](/docs/api/namespaces/proto/interfaces/IPoint#y)

* * *

### yDeprecated?[​](#ydeprecated "Direct link to yDeprecated?")

> `optional` **yDeprecated**: `null` | `number`

Defined in: [WAProto/index.d.ts:10373](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10373)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IPoint`](/docs/api/namespaces/proto/interfaces/IPoint).[`yDeprecated`](/docs/api/namespaces/proto/interfaces/IPoint#ydeprecated)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10381](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10381)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Point`](/docs/api/namespaces/proto/classes/Point)

Defined in: [WAProto/index.d.ts:10376](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10376)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPoint`](/docs/api/namespaces/proto/interfaces/IPoint)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Point`](/docs/api/namespaces/proto/classes/Point)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Point`](/docs/api/namespaces/proto/classes/Point)

Defined in: [WAProto/index.d.ts:10378](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10378)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Point`](/docs/api/namespaces/proto/classes/Point)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10377](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10377)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPoint`](/docs/api/namespaces/proto/interfaces/IPoint)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Point`](/docs/api/namespaces/proto/classes/Point)

Defined in: [WAProto/index.d.ts:10379](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10379)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Point`](/docs/api/namespaces/proto/classes/Point)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10382](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10382)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10380](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10380)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Point`](/docs/api/namespaces/proto/classes/Point)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-polladditionalmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/PollAdditionalMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/PollAdditionalMetadata)

Defined in: [WAProto/index.d.ts:10389](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10389)

## Implements[​](#implements "Direct link to Implements")

*   [`IPollAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IPollAdditionalMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new PollAdditionalMetadata()[​](#new-polladditionalmetadata "Direct link to new PollAdditionalMetadata()")

> **new PollAdditionalMetadata**(`p`?): [`PollAdditionalMetadata`](/docs/api/namespaces/proto/classes/PollAdditionalMetadata)

Defined in: [WAProto/index.d.ts:10390](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10390)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPollAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IPollAdditionalMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`PollAdditionalMetadata`](/docs/api/namespaces/proto/classes/PollAdditionalMetadata)

## Properties[​](#properties "Direct link to Properties")

### pollInvalidated?[​](#pollinvalidated "Direct link to pollInvalidated?")

> `optional` **pollInvalidated**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:10391](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10391)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPollAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IPollAdditionalMetadata).[`pollInvalidated`](/docs/api/namespaces/proto/interfaces/IPollAdditionalMetadata#pollinvalidated)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10397](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10397)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PollAdditionalMetadata`](/docs/api/namespaces/proto/classes/PollAdditionalMetadata)

Defined in: [WAProto/index.d.ts:10392](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10392)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPollAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IPollAdditionalMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PollAdditionalMetadata`](/docs/api/namespaces/proto/classes/PollAdditionalMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PollAdditionalMetadata`](/docs/api/namespaces/proto/classes/PollAdditionalMetadata)

Defined in: [WAProto/index.d.ts:10394](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10394)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PollAdditionalMetadata`](/docs/api/namespaces/proto/classes/PollAdditionalMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10393](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10393)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPollAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IPollAdditionalMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PollAdditionalMetadata`](/docs/api/namespaces/proto/classes/PollAdditionalMetadata)

Defined in: [WAProto/index.d.ts:10395](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10395)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PollAdditionalMetadata`](/docs/api/namespaces/proto/classes/PollAdditionalMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10398](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10398)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10396](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10396)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PollAdditionalMetadata`](/docs/api/namespaces/proto/classes/PollAdditionalMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pollencvalue"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/PollEncValue](https://baileys.wiki/docs/api/namespaces/proto/classes/PollEncValue)

Defined in: [WAProto/index.d.ts:10406](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10406)

## Implements[​](#implements "Direct link to Implements")

*   [`IPollEncValue`](/docs/api/namespaces/proto/interfaces/IPollEncValue)

## Constructors[​](#constructors "Direct link to Constructors")

### new PollEncValue()[​](#new-pollencvalue "Direct link to new PollEncValue()")

> **new PollEncValue**(`p`?): [`PollEncValue`](/docs/api/namespaces/proto/classes/PollEncValue)

Defined in: [WAProto/index.d.ts:10407](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10407)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPollEncValue`](/docs/api/namespaces/proto/interfaces/IPollEncValue)

#### Returns[​](#returns "Direct link to Returns")

[`PollEncValue`](/docs/api/namespaces/proto/classes/PollEncValue)

## Properties[​](#properties "Direct link to Properties")

### encIv?[​](#enciv "Direct link to encIv?")

> `optional` **encIv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10409](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10409)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPollEncValue`](/docs/api/namespaces/proto/interfaces/IPollEncValue).[`encIv`](/docs/api/namespaces/proto/interfaces/IPollEncValue#enciv)

* * *

### encPayload?[​](#encpayload "Direct link to encPayload?")

> `optional` **encPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10408](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10408)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPollEncValue`](/docs/api/namespaces/proto/interfaces/IPollEncValue).[`encPayload`](/docs/api/namespaces/proto/interfaces/IPollEncValue#encpayload)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10415](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10415)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PollEncValue`](/docs/api/namespaces/proto/classes/PollEncValue)

Defined in: [WAProto/index.d.ts:10410](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10410)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPollEncValue`](/docs/api/namespaces/proto/interfaces/IPollEncValue)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PollEncValue`](/docs/api/namespaces/proto/classes/PollEncValue)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PollEncValue`](/docs/api/namespaces/proto/classes/PollEncValue)

Defined in: [WAProto/index.d.ts:10412](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10412)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PollEncValue`](/docs/api/namespaces/proto/classes/PollEncValue)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10411](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10411)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPollEncValue`](/docs/api/namespaces/proto/interfaces/IPollEncValue)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PollEncValue`](/docs/api/namespaces/proto/classes/PollEncValue)

Defined in: [WAProto/index.d.ts:10413](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10413)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PollEncValue`](/docs/api/namespaces/proto/classes/PollEncValue)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10416](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10416)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10414](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10414)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PollEncValue`](/docs/api/namespaces/proto/classes/PollEncValue)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pollupdate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/PollUpdate](https://baileys.wiki/docs/api/namespaces/proto/classes/PollUpdate)

Defined in: [WAProto/index.d.ts:10427](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10427)

## Implements[​](#implements "Direct link to Implements")

*   [`IPollUpdate`](/docs/api/namespaces/proto/interfaces/IPollUpdate)

## Constructors[​](#constructors "Direct link to Constructors")

### new PollUpdate()[​](#new-pollupdate "Direct link to new PollUpdate()")

> **new PollUpdate**(`p`?): [`PollUpdate`](/docs/api/namespaces/proto/classes/PollUpdate)

Defined in: [WAProto/index.d.ts:10428](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10428)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPollUpdate`](/docs/api/namespaces/proto/interfaces/IPollUpdate)

#### Returns[​](#returns "Direct link to Returns")

[`PollUpdate`](/docs/api/namespaces/proto/classes/PollUpdate)

## Properties[​](#properties "Direct link to Properties")

### pollUpdateMessageKey?[​](#pollupdatemessagekey "Direct link to pollUpdateMessageKey?")

> `optional` **pollUpdateMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:10429](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10429)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPollUpdate`](/docs/api/namespaces/proto/interfaces/IPollUpdate).[`pollUpdateMessageKey`](/docs/api/namespaces/proto/interfaces/IPollUpdate#pollupdatemessagekey)

* * *

### senderTimestampMs?[​](#sendertimestampms "Direct link to senderTimestampMs?")

> `optional` **senderTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10431](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10431)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPollUpdate`](/docs/api/namespaces/proto/interfaces/IPollUpdate).[`senderTimestampMs`](/docs/api/namespaces/proto/interfaces/IPollUpdate#sendertimestampms)

* * *

### serverTimestampMs?[​](#servertimestampms "Direct link to serverTimestampMs?")

> `optional` **serverTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10432](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10432)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPollUpdate`](/docs/api/namespaces/proto/interfaces/IPollUpdate).[`serverTimestampMs`](/docs/api/namespaces/proto/interfaces/IPollUpdate#servertimestampms)

* * *

### unread?[​](#unread "Direct link to unread?")

> `optional` **unread**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:10433](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10433)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IPollUpdate`](/docs/api/namespaces/proto/interfaces/IPollUpdate).[`unread`](/docs/api/namespaces/proto/interfaces/IPollUpdate#unread)

* * *

### vote?[​](#vote "Direct link to vote?")

> `optional` **vote**: `null` | [`IPollVoteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollVoteMessage)

Defined in: [WAProto/index.d.ts:10430](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10430)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IPollUpdate`](/docs/api/namespaces/proto/interfaces/IPollUpdate).[`vote`](/docs/api/namespaces/proto/interfaces/IPollUpdate#vote)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10439](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10439)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PollUpdate`](/docs/api/namespaces/proto/classes/PollUpdate)

Defined in: [WAProto/index.d.ts:10434](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10434)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPollUpdate`](/docs/api/namespaces/proto/interfaces/IPollUpdate)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PollUpdate`](/docs/api/namespaces/proto/classes/PollUpdate)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PollUpdate`](/docs/api/namespaces/proto/classes/PollUpdate)

Defined in: [WAProto/index.d.ts:10436](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10436)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PollUpdate`](/docs/api/namespaces/proto/classes/PollUpdate)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10435](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10435)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPollUpdate`](/docs/api/namespaces/proto/interfaces/IPollUpdate)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PollUpdate`](/docs/api/namespaces/proto/classes/PollUpdate)

Defined in: [WAProto/index.d.ts:10437](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10437)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PollUpdate`](/docs/api/namespaces/proto/classes/PollUpdate)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10440](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10440)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10438](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10438)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PollUpdate`](/docs/api/namespaces/proto/classes/PollUpdate)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-prekeyrecordstructure"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/PreKeyRecordStructure](https://baileys.wiki/docs/api/namespaces/proto/classes/PreKeyRecordStructure)

Defined in: [WAProto/index.d.ts:10449](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10449)

## Implements[​](#implements "Direct link to Implements")

*   [`IPreKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/IPreKeyRecordStructure)

## Constructors[​](#constructors "Direct link to Constructors")

### new PreKeyRecordStructure()[​](#new-prekeyrecordstructure "Direct link to new PreKeyRecordStructure()")

> **new PreKeyRecordStructure**(`p`?): [`PreKeyRecordStructure`](/docs/api/namespaces/proto/classes/PreKeyRecordStructure)

Defined in: [WAProto/index.d.ts:10450](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10450)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPreKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/IPreKeyRecordStructure)

#### Returns[​](#returns "Direct link to Returns")

[`PreKeyRecordStructure`](/docs/api/namespaces/proto/classes/PreKeyRecordStructure)

## Properties[​](#properties "Direct link to Properties")

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `number`

Defined in: [WAProto/index.d.ts:10451](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10451)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPreKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/IPreKeyRecordStructure).[`id`](/docs/api/namespaces/proto/interfaces/IPreKeyRecordStructure#id)

* * *

### privateKey?[​](#privatekey "Direct link to privateKey?")

> `optional` **privateKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10453](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10453)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPreKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/IPreKeyRecordStructure).[`privateKey`](/docs/api/namespaces/proto/interfaces/IPreKeyRecordStructure#privatekey)

* * *

### publicKey?[​](#publickey "Direct link to publicKey?")

> `optional` **publicKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10452](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10452)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPreKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/IPreKeyRecordStructure).[`publicKey`](/docs/api/namespaces/proto/interfaces/IPreKeyRecordStructure#publickey)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10459](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10459)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PreKeyRecordStructure`](/docs/api/namespaces/proto/classes/PreKeyRecordStructure)

Defined in: [WAProto/index.d.ts:10454](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10454)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPreKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/IPreKeyRecordStructure)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PreKeyRecordStructure`](/docs/api/namespaces/proto/classes/PreKeyRecordStructure)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PreKeyRecordStructure`](/docs/api/namespaces/proto/classes/PreKeyRecordStructure)

Defined in: [WAProto/index.d.ts:10456](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10456)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PreKeyRecordStructure`](/docs/api/namespaces/proto/classes/PreKeyRecordStructure)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10455](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10455)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPreKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/IPreKeyRecordStructure)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PreKeyRecordStructure`](/docs/api/namespaces/proto/classes/PreKeyRecordStructure)

Defined in: [WAProto/index.d.ts:10457](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10457)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PreKeyRecordStructure`](/docs/api/namespaces/proto/classes/PreKeyRecordStructure)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10460](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10460)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10458](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10458)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PreKeyRecordStructure`](/docs/api/namespaces/proto/classes/PreKeyRecordStructure)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-prekeysignalmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/PreKeySignalMessage](https://baileys.wiki/docs/api/namespaces/proto/classes/PreKeySignalMessage)

Defined in: [WAProto/index.d.ts:10472](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10472)

## Implements[​](#implements "Direct link to Implements")

*   [`IPreKeySignalMessage`](/docs/api/namespaces/proto/interfaces/IPreKeySignalMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new PreKeySignalMessage()[​](#new-prekeysignalmessage "Direct link to new PreKeySignalMessage()")

> **new PreKeySignalMessage**(`p`?): [`PreKeySignalMessage`](/docs/api/namespaces/proto/classes/PreKeySignalMessage)

Defined in: [WAProto/index.d.ts:10473](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10473)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPreKeySignalMessage`](/docs/api/namespaces/proto/interfaces/IPreKeySignalMessage)

#### Returns[​](#returns "Direct link to Returns")

[`PreKeySignalMessage`](/docs/api/namespaces/proto/classes/PreKeySignalMessage)

## Properties[​](#properties "Direct link to Properties")

### baseKey?[​](#basekey "Direct link to baseKey?")

> `optional` **baseKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10477](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10477)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPreKeySignalMessage`](/docs/api/namespaces/proto/interfaces/IPreKeySignalMessage).[`baseKey`](/docs/api/namespaces/proto/interfaces/IPreKeySignalMessage#basekey)

* * *

### identityKey?[​](#identitykey "Direct link to identityKey?")

> `optional` **identityKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10478](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10478)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPreKeySignalMessage`](/docs/api/namespaces/proto/interfaces/IPreKeySignalMessage).[`identityKey`](/docs/api/namespaces/proto/interfaces/IPreKeySignalMessage#identitykey)

* * *

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10479](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10479)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPreKeySignalMessage`](/docs/api/namespaces/proto/interfaces/IPreKeySignalMessage).[`message`](/docs/api/namespaces/proto/interfaces/IPreKeySignalMessage#message)

* * *

### preKeyId?[​](#prekeyid "Direct link to preKeyId?")

> `optional` **preKeyId**: `null` | `number`

Defined in: [WAProto/index.d.ts:10475](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10475)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IPreKeySignalMessage`](/docs/api/namespaces/proto/interfaces/IPreKeySignalMessage).[`preKeyId`](/docs/api/namespaces/proto/interfaces/IPreKeySignalMessage#prekeyid)

* * *

### registrationId?[​](#registrationid "Direct link to registrationId?")

> `optional` **registrationId**: `null` | `number`

Defined in: [WAProto/index.d.ts:10474](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10474)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IPreKeySignalMessage`](/docs/api/namespaces/proto/interfaces/IPreKeySignalMessage).[`registrationId`](/docs/api/namespaces/proto/interfaces/IPreKeySignalMessage#registrationid)

* * *

### signedPreKeyId?[​](#signedprekeyid "Direct link to signedPreKeyId?")

> `optional` **signedPreKeyId**: `null` | `number`

Defined in: [WAProto/index.d.ts:10476](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10476)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IPreKeySignalMessage`](/docs/api/namespaces/proto/interfaces/IPreKeySignalMessage).[`signedPreKeyId`](/docs/api/namespaces/proto/interfaces/IPreKeySignalMessage#signedprekeyid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10485](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10485)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PreKeySignalMessage`](/docs/api/namespaces/proto/classes/PreKeySignalMessage)

Defined in: [WAProto/index.d.ts:10480](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10480)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPreKeySignalMessage`](/docs/api/namespaces/proto/interfaces/IPreKeySignalMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PreKeySignalMessage`](/docs/api/namespaces/proto/classes/PreKeySignalMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PreKeySignalMessage`](/docs/api/namespaces/proto/classes/PreKeySignalMessage)

Defined in: [WAProto/index.d.ts:10482](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10482)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PreKeySignalMessage`](/docs/api/namespaces/proto/classes/PreKeySignalMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10481](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10481)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPreKeySignalMessage`](/docs/api/namespaces/proto/interfaces/IPreKeySignalMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PreKeySignalMessage`](/docs/api/namespaces/proto/classes/PreKeySignalMessage)

Defined in: [WAProto/index.d.ts:10483](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10483)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PreKeySignalMessage`](/docs/api/namespaces/proto/classes/PreKeySignalMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10486](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10486)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10484](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10484)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PreKeySignalMessage`](/docs/api/namespaces/proto/classes/PreKeySignalMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-premiummessageinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/PremiumMessageInfo](https://baileys.wiki/docs/api/namespaces/proto/classes/PremiumMessageInfo)

Defined in: [WAProto/index.d.ts:10493](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10493)

## Implements[​](#implements "Direct link to Implements")

*   [`IPremiumMessageInfo`](/docs/api/namespaces/proto/interfaces/IPremiumMessageInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new PremiumMessageInfo()[​](#new-premiummessageinfo "Direct link to new PremiumMessageInfo()")

> **new PremiumMessageInfo**(`p`?): [`PremiumMessageInfo`](/docs/api/namespaces/proto/classes/PremiumMessageInfo)

Defined in: [WAProto/index.d.ts:10494](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10494)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPremiumMessageInfo`](/docs/api/namespaces/proto/interfaces/IPremiumMessageInfo)

#### Returns[​](#returns "Direct link to Returns")

[`PremiumMessageInfo`](/docs/api/namespaces/proto/classes/PremiumMessageInfo)

## Properties[​](#properties "Direct link to Properties")

### serverCampaignId?[​](#servercampaignid "Direct link to serverCampaignId?")

> `optional` **serverCampaignId**: `null` | `string`

Defined in: [WAProto/index.d.ts:10495](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10495)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPremiumMessageInfo`](/docs/api/namespaces/proto/interfaces/IPremiumMessageInfo).[`serverCampaignId`](/docs/api/namespaces/proto/interfaces/IPremiumMessageInfo#servercampaignid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10501](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10501)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PremiumMessageInfo`](/docs/api/namespaces/proto/classes/PremiumMessageInfo)

Defined in: [WAProto/index.d.ts:10496](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10496)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPremiumMessageInfo`](/docs/api/namespaces/proto/interfaces/IPremiumMessageInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PremiumMessageInfo`](/docs/api/namespaces/proto/classes/PremiumMessageInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PremiumMessageInfo`](/docs/api/namespaces/proto/classes/PremiumMessageInfo)

Defined in: [WAProto/index.d.ts:10498](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10498)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PremiumMessageInfo`](/docs/api/namespaces/proto/classes/PremiumMessageInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10497](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10497)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPremiumMessageInfo`](/docs/api/namespaces/proto/interfaces/IPremiumMessageInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PremiumMessageInfo`](/docs/api/namespaces/proto/classes/PremiumMessageInfo)

Defined in: [WAProto/index.d.ts:10499](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10499)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PremiumMessageInfo`](/docs/api/namespaces/proto/classes/PremiumMessageInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10502](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10502)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10500](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10500)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PremiumMessageInfo`](/docs/api/namespaces/proto/classes/PremiumMessageInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-primaryephemeralidentity"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/PrimaryEphemeralIdentity](https://baileys.wiki/docs/api/namespaces/proto/classes/PrimaryEphemeralIdentity)

Defined in: [WAProto/index.d.ts:10510](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10510)

## Implements[​](#implements "Direct link to Implements")

*   [`IPrimaryEphemeralIdentity`](/docs/api/namespaces/proto/interfaces/IPrimaryEphemeralIdentity)

## Constructors[​](#constructors "Direct link to Constructors")

### new PrimaryEphemeralIdentity()[​](#new-primaryephemeralidentity "Direct link to new PrimaryEphemeralIdentity()")

> **new PrimaryEphemeralIdentity**(`p`?): [`PrimaryEphemeralIdentity`](/docs/api/namespaces/proto/classes/PrimaryEphemeralIdentity)

Defined in: [WAProto/index.d.ts:10511](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10511)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPrimaryEphemeralIdentity`](/docs/api/namespaces/proto/interfaces/IPrimaryEphemeralIdentity)

#### Returns[​](#returns "Direct link to Returns")

[`PrimaryEphemeralIdentity`](/docs/api/namespaces/proto/classes/PrimaryEphemeralIdentity)

## Properties[​](#properties "Direct link to Properties")

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10513](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10513)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPrimaryEphemeralIdentity`](/docs/api/namespaces/proto/interfaces/IPrimaryEphemeralIdentity).[`nonce`](/docs/api/namespaces/proto/interfaces/IPrimaryEphemeralIdentity#nonce)

* * *

### publicKey?[​](#publickey "Direct link to publicKey?")

> `optional` **publicKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10512](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10512)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPrimaryEphemeralIdentity`](/docs/api/namespaces/proto/interfaces/IPrimaryEphemeralIdentity).[`publicKey`](/docs/api/namespaces/proto/interfaces/IPrimaryEphemeralIdentity#publickey)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10519](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10519)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PrimaryEphemeralIdentity`](/docs/api/namespaces/proto/classes/PrimaryEphemeralIdentity)

Defined in: [WAProto/index.d.ts:10514](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10514)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPrimaryEphemeralIdentity`](/docs/api/namespaces/proto/interfaces/IPrimaryEphemeralIdentity)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PrimaryEphemeralIdentity`](/docs/api/namespaces/proto/classes/PrimaryEphemeralIdentity)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PrimaryEphemeralIdentity`](/docs/api/namespaces/proto/classes/PrimaryEphemeralIdentity)

Defined in: [WAProto/index.d.ts:10516](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10516)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PrimaryEphemeralIdentity`](/docs/api/namespaces/proto/classes/PrimaryEphemeralIdentity)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10515](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10515)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPrimaryEphemeralIdentity`](/docs/api/namespaces/proto/interfaces/IPrimaryEphemeralIdentity)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PrimaryEphemeralIdentity`](/docs/api/namespaces/proto/classes/PrimaryEphemeralIdentity)

Defined in: [WAProto/index.d.ts:10517](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10517)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PrimaryEphemeralIdentity`](/docs/api/namespaces/proto/classes/PrimaryEphemeralIdentity)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10520](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10520)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10518](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10518)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PrimaryEphemeralIdentity`](/docs/api/namespaces/proto/classes/PrimaryEphemeralIdentity)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-processedvideo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/ProcessedVideo](https://baileys.wiki/docs/api/namespaces/proto/classes/ProcessedVideo)

Defined in: [WAProto/index.d.ts:10540](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10540)

## Implements[​](#implements "Direct link to Implements")

*   [`IProcessedVideo`](/docs/api/namespaces/proto/interfaces/IProcessedVideo)

## Constructors[​](#constructors "Direct link to Constructors")

### new ProcessedVideo()[​](#new-processedvideo "Direct link to new ProcessedVideo()")

> **new ProcessedVideo**(`p`?): [`ProcessedVideo`](/docs/api/namespaces/proto/classes/ProcessedVideo)

Defined in: [WAProto/index.d.ts:10541](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10541)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IProcessedVideo`](/docs/api/namespaces/proto/interfaces/IProcessedVideo)

#### Returns[​](#returns "Direct link to Returns")

[`ProcessedVideo`](/docs/api/namespaces/proto/classes/ProcessedVideo)

## Properties[​](#properties "Direct link to Properties")

### bitrate?[​](#bitrate "Direct link to bitrate?")

> `optional` **bitrate**: `null` | `number`

Defined in: [WAProto/index.d.ts:10547](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10547)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IProcessedVideo`](/docs/api/namespaces/proto/interfaces/IProcessedVideo).[`bitrate`](/docs/api/namespaces/proto/interfaces/IProcessedVideo#bitrate)

* * *

### capabilities[​](#capabilities "Direct link to capabilities")

> **capabilities**: `string`\[\]

Defined in: [WAProto/index.d.ts:10549](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10549)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IProcessedVideo`](/docs/api/namespaces/proto/interfaces/IProcessedVideo).[`capabilities`](/docs/api/namespaces/proto/interfaces/IProcessedVideo#capabilities)

* * *

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:10542](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10542)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IProcessedVideo`](/docs/api/namespaces/proto/interfaces/IProcessedVideo).[`directPath`](/docs/api/namespaces/proto/interfaces/IProcessedVideo#directpath)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10546](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10546)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IProcessedVideo`](/docs/api/namespaces/proto/interfaces/IProcessedVideo).[`fileLength`](/docs/api/namespaces/proto/interfaces/IProcessedVideo#filelength)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10543](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10543)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IProcessedVideo`](/docs/api/namespaces/proto/interfaces/IProcessedVideo).[`fileSha256`](/docs/api/namespaces/proto/interfaces/IProcessedVideo#filesha256)

* * *

### height?[​](#height "Direct link to height?")

> `optional` **height**: `null` | `number`

Defined in: [WAProto/index.d.ts:10544](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10544)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IProcessedVideo`](/docs/api/namespaces/proto/interfaces/IProcessedVideo).[`height`](/docs/api/namespaces/proto/interfaces/IProcessedVideo#height)

* * *

### quality?[​](#quality "Direct link to quality?")

> `optional` **quality**: `null` | [`VideoQuality`](/docs/api/namespaces/proto/namespaces/ProcessedVideo/enumerations/VideoQuality)

Defined in: [WAProto/index.d.ts:10548](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10548)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IProcessedVideo`](/docs/api/namespaces/proto/interfaces/IProcessedVideo).[`quality`](/docs/api/namespaces/proto/interfaces/IProcessedVideo#quality)

* * *

### width?[​](#width "Direct link to width?")

> `optional` **width**: `null` | `number`

Defined in: [WAProto/index.d.ts:10545](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10545)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IProcessedVideo`](/docs/api/namespaces/proto/interfaces/IProcessedVideo).[`width`](/docs/api/namespaces/proto/interfaces/IProcessedVideo#width)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10555](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10555)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ProcessedVideo`](/docs/api/namespaces/proto/classes/ProcessedVideo)

Defined in: [WAProto/index.d.ts:10550](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10550)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IProcessedVideo`](/docs/api/namespaces/proto/interfaces/IProcessedVideo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ProcessedVideo`](/docs/api/namespaces/proto/classes/ProcessedVideo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ProcessedVideo`](/docs/api/namespaces/proto/classes/ProcessedVideo)

Defined in: [WAProto/index.d.ts:10552](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10552)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ProcessedVideo`](/docs/api/namespaces/proto/classes/ProcessedVideo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10551](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10551)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IProcessedVideo`](/docs/api/namespaces/proto/interfaces/IProcessedVideo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ProcessedVideo`](/docs/api/namespaces/proto/classes/ProcessedVideo)

Defined in: [WAProto/index.d.ts:10553](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10553)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ProcessedVideo`](/docs/api/namespaces/proto/classes/ProcessedVideo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10556](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10556)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10554](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10554)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ProcessedVideo`](/docs/api/namespaces/proto/classes/ProcessedVideo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-prologuepayload"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/ProloguePayload](https://baileys.wiki/docs/api/namespaces/proto/classes/ProloguePayload)

Defined in: [WAProto/index.d.ts:10574](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10574)

## Implements[​](#implements "Direct link to Implements")

*   [`IProloguePayload`](/docs/api/namespaces/proto/interfaces/IProloguePayload)

## Constructors[​](#constructors "Direct link to Constructors")

### new ProloguePayload()[​](#new-prologuepayload "Direct link to new ProloguePayload()")

> **new ProloguePayload**(`p`?): [`ProloguePayload`](/docs/api/namespaces/proto/classes/ProloguePayload)

Defined in: [WAProto/index.d.ts:10575](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10575)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IProloguePayload`](/docs/api/namespaces/proto/interfaces/IProloguePayload)

#### Returns[​](#returns "Direct link to Returns")

[`ProloguePayload`](/docs/api/namespaces/proto/classes/ProloguePayload)

## Properties[​](#properties "Direct link to Properties")

### commitment?[​](#commitment "Direct link to commitment?")

> `optional` **commitment**: `null` | [`ICompanionCommitment`](/docs/api/namespaces/proto/interfaces/ICompanionCommitment)

Defined in: [WAProto/index.d.ts:10577](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10577)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IProloguePayload`](/docs/api/namespaces/proto/interfaces/IProloguePayload).[`commitment`](/docs/api/namespaces/proto/interfaces/IProloguePayload#commitment)

* * *

### companionEphemeralIdentity?[​](#companionephemeralidentity "Direct link to companionEphemeralIdentity?")

> `optional` **companionEphemeralIdentity**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10576](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10576)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IProloguePayload`](/docs/api/namespaces/proto/interfaces/IProloguePayload).[`companionEphemeralIdentity`](/docs/api/namespaces/proto/interfaces/IProloguePayload#companionephemeralidentity)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10583](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10583)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ProloguePayload`](/docs/api/namespaces/proto/classes/ProloguePayload)

Defined in: [WAProto/index.d.ts:10578](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10578)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IProloguePayload`](/docs/api/namespaces/proto/interfaces/IProloguePayload)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ProloguePayload`](/docs/api/namespaces/proto/classes/ProloguePayload)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ProloguePayload`](/docs/api/namespaces/proto/classes/ProloguePayload)

Defined in: [WAProto/index.d.ts:10580](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10580)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ProloguePayload`](/docs/api/namespaces/proto/classes/ProloguePayload)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10579](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10579)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IProloguePayload`](/docs/api/namespaces/proto/interfaces/IProloguePayload)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ProloguePayload`](/docs/api/namespaces/proto/classes/ProloguePayload)

Defined in: [WAProto/index.d.ts:10581](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10581)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ProloguePayload`](/docs/api/namespaces/proto/classes/ProloguePayload)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10584](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10584)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10582](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10582)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ProloguePayload`](/docs/api/namespaces/proto/classes/ProloguePayload)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pushname"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/Pushname](https://baileys.wiki/docs/api/namespaces/proto/classes/Pushname)

Defined in: [WAProto/index.d.ts:10592](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10592)

## Implements[​](#implements "Direct link to Implements")

*   [`IPushname`](/docs/api/namespaces/proto/interfaces/IPushname)

## Constructors[​](#constructors "Direct link to Constructors")

### new Pushname()[​](#new-pushname "Direct link to new Pushname()")

> **new Pushname**(`p`?): [`Pushname`](/docs/api/namespaces/proto/classes/Pushname)

Defined in: [WAProto/index.d.ts:10593](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10593)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPushname`](/docs/api/namespaces/proto/interfaces/IPushname)

#### Returns[​](#returns "Direct link to Returns")

[`Pushname`](/docs/api/namespaces/proto/classes/Pushname)

## Properties[​](#properties "Direct link to Properties")

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:10594](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10594)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPushname`](/docs/api/namespaces/proto/interfaces/IPushname).[`id`](/docs/api/namespaces/proto/interfaces/IPushname#id)

* * *

### pushname?[​](#pushname "Direct link to pushname?")

> `optional` **pushname**: `null` | `string`

Defined in: [WAProto/index.d.ts:10595](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10595)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPushname`](/docs/api/namespaces/proto/interfaces/IPushname).[`pushname`](/docs/api/namespaces/proto/interfaces/IPushname#pushname)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10601](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10601)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Pushname`](/docs/api/namespaces/proto/classes/Pushname)

Defined in: [WAProto/index.d.ts:10596](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10596)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPushname`](/docs/api/namespaces/proto/interfaces/IPushname)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Pushname`](/docs/api/namespaces/proto/classes/Pushname)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Pushname`](/docs/api/namespaces/proto/classes/Pushname)

Defined in: [WAProto/index.d.ts:10598](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10598)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Pushname`](/docs/api/namespaces/proto/classes/Pushname)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10597](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10597)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPushname`](/docs/api/namespaces/proto/interfaces/IPushname)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Pushname`](/docs/api/namespaces/proto/classes/Pushname)

Defined in: [WAProto/index.d.ts:10599](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10599)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Pushname`](/docs/api/namespaces/proto/classes/Pushname)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10602](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10602)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10600](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10600)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Pushname`](/docs/api/namespaces/proto/classes/Pushname)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-quarantinedmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/QuarantinedMessage](https://baileys.wiki/docs/api/namespaces/proto/classes/QuarantinedMessage)

Defined in: [WAProto/index.d.ts:10610](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10610)

## Implements[​](#implements "Direct link to Implements")

*   [`IQuarantinedMessage`](/docs/api/namespaces/proto/interfaces/IQuarantinedMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new QuarantinedMessage()[​](#new-quarantinedmessage "Direct link to new QuarantinedMessage()")

> **new QuarantinedMessage**(`p`?): [`QuarantinedMessage`](/docs/api/namespaces/proto/classes/QuarantinedMessage)

Defined in: [WAProto/index.d.ts:10611](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10611)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IQuarantinedMessage`](/docs/api/namespaces/proto/interfaces/IQuarantinedMessage)

#### Returns[​](#returns "Direct link to Returns")

[`QuarantinedMessage`](/docs/api/namespaces/proto/classes/QuarantinedMessage)

## Properties[​](#properties "Direct link to Properties")

### extractedText?[​](#extractedtext "Direct link to extractedText?")

> `optional` **extractedText**: `null` | `string`

Defined in: [WAProto/index.d.ts:10613](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10613)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IQuarantinedMessage`](/docs/api/namespaces/proto/interfaces/IQuarantinedMessage).[`extractedText`](/docs/api/namespaces/proto/interfaces/IQuarantinedMessage#extractedtext)

* * *

### originalData?[​](#originaldata "Direct link to originalData?")

> `optional` **originalData**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10612](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10612)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IQuarantinedMessage`](/docs/api/namespaces/proto/interfaces/IQuarantinedMessage).[`originalData`](/docs/api/namespaces/proto/interfaces/IQuarantinedMessage#originaldata)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10619](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10619)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`QuarantinedMessage`](/docs/api/namespaces/proto/classes/QuarantinedMessage)

Defined in: [WAProto/index.d.ts:10614](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10614)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IQuarantinedMessage`](/docs/api/namespaces/proto/interfaces/IQuarantinedMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`QuarantinedMessage`](/docs/api/namespaces/proto/classes/QuarantinedMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`QuarantinedMessage`](/docs/api/namespaces/proto/classes/QuarantinedMessage)

Defined in: [WAProto/index.d.ts:10616](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10616)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`QuarantinedMessage`](/docs/api/namespaces/proto/classes/QuarantinedMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10615](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10615)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IQuarantinedMessage`](/docs/api/namespaces/proto/interfaces/IQuarantinedMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`QuarantinedMessage`](/docs/api/namespaces/proto/classes/QuarantinedMessage)

Defined in: [WAProto/index.d.ts:10617](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10617)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`QuarantinedMessage`](/docs/api/namespaces/proto/classes/QuarantinedMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10620](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10620)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10618](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10618)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`QuarantinedMessage`](/docs/api/namespaces/proto/classes/QuarantinedMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-reaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/Reaction](https://baileys.wiki/docs/api/namespaces/proto/classes/Reaction)

Defined in: [WAProto/index.d.ts:10631](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10631)

## Implements[​](#implements "Direct link to Implements")

*   [`IReaction`](/docs/api/namespaces/proto/interfaces/IReaction)

## Constructors[​](#constructors "Direct link to Constructors")

### new Reaction()[​](#new-reaction "Direct link to new Reaction()")

> **new Reaction**(`p`?): [`Reaction`](/docs/api/namespaces/proto/classes/Reaction)

Defined in: [WAProto/index.d.ts:10632](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10632)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IReaction`](/docs/api/namespaces/proto/interfaces/IReaction)

#### Returns[​](#returns "Direct link to Returns")

[`Reaction`](/docs/api/namespaces/proto/classes/Reaction)

## Properties[​](#properties "Direct link to Properties")

### groupingKey?[​](#groupingkey "Direct link to groupingKey?")

> `optional` **groupingKey**: `null` | `string`

Defined in: [WAProto/index.d.ts:10635](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10635)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IReaction`](/docs/api/namespaces/proto/interfaces/IReaction).[`groupingKey`](/docs/api/namespaces/proto/interfaces/IReaction#groupingkey)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:10633](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10633)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IReaction`](/docs/api/namespaces/proto/interfaces/IReaction).[`key`](/docs/api/namespaces/proto/interfaces/IReaction#key)

* * *

### senderTimestampMs?[​](#sendertimestampms "Direct link to senderTimestampMs?")

> `optional` **senderTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10636](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10636)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IReaction`](/docs/api/namespaces/proto/interfaces/IReaction).[`senderTimestampMs`](/docs/api/namespaces/proto/interfaces/IReaction#sendertimestampms)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:10634](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10634)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IReaction`](/docs/api/namespaces/proto/interfaces/IReaction).[`text`](/docs/api/namespaces/proto/interfaces/IReaction#text)

* * *

### unread?[​](#unread "Direct link to unread?")

> `optional` **unread**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:10637](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10637)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IReaction`](/docs/api/namespaces/proto/interfaces/IReaction).[`unread`](/docs/api/namespaces/proto/interfaces/IReaction#unread)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10643](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10643)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Reaction`](/docs/api/namespaces/proto/classes/Reaction)

Defined in: [WAProto/index.d.ts:10638](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10638)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IReaction`](/docs/api/namespaces/proto/interfaces/IReaction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Reaction`](/docs/api/namespaces/proto/classes/Reaction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Reaction`](/docs/api/namespaces/proto/classes/Reaction)

Defined in: [WAProto/index.d.ts:10640](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10640)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Reaction`](/docs/api/namespaces/proto/classes/Reaction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10639](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10639)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IReaction`](/docs/api/namespaces/proto/interfaces/IReaction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Reaction`](/docs/api/namespaces/proto/classes/Reaction)

Defined in: [WAProto/index.d.ts:10641](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10641)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Reaction`](/docs/api/namespaces/proto/classes/Reaction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10644](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10644)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10642](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10642)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Reaction`](/docs/api/namespaces/proto/classes/Reaction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-recentemojiweight"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/RecentEmojiWeight](https://baileys.wiki/docs/api/namespaces/proto/classes/RecentEmojiWeight)

Defined in: [WAProto/index.d.ts:10652](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10652)

## Implements[​](#implements "Direct link to Implements")

*   [`IRecentEmojiWeight`](/docs/api/namespaces/proto/interfaces/IRecentEmojiWeight)

## Constructors[​](#constructors "Direct link to Constructors")

### new RecentEmojiWeight()[​](#new-recentemojiweight "Direct link to new RecentEmojiWeight()")

> **new RecentEmojiWeight**(`p`?): [`RecentEmojiWeight`](/docs/api/namespaces/proto/classes/RecentEmojiWeight)

Defined in: [WAProto/index.d.ts:10653](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10653)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IRecentEmojiWeight`](/docs/api/namespaces/proto/interfaces/IRecentEmojiWeight)

#### Returns[​](#returns "Direct link to Returns")

[`RecentEmojiWeight`](/docs/api/namespaces/proto/classes/RecentEmojiWeight)

## Properties[​](#properties "Direct link to Properties")

### emoji?[​](#emoji "Direct link to emoji?")

> `optional` **emoji**: `null` | `string`

Defined in: [WAProto/index.d.ts:10654](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10654)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IRecentEmojiWeight`](/docs/api/namespaces/proto/interfaces/IRecentEmojiWeight).[`emoji`](/docs/api/namespaces/proto/interfaces/IRecentEmojiWeight#emoji)

* * *

### weight?[​](#weight "Direct link to weight?")

> `optional` **weight**: `null` | `number`

Defined in: [WAProto/index.d.ts:10655](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10655)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IRecentEmojiWeight`](/docs/api/namespaces/proto/interfaces/IRecentEmojiWeight).[`weight`](/docs/api/namespaces/proto/interfaces/IRecentEmojiWeight#weight)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10661](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10661)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`RecentEmojiWeight`](/docs/api/namespaces/proto/classes/RecentEmojiWeight)

Defined in: [WAProto/index.d.ts:10656](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10656)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IRecentEmojiWeight`](/docs/api/namespaces/proto/interfaces/IRecentEmojiWeight)

#### Returns[​](#returns-2 "Direct link to Returns")

[`RecentEmojiWeight`](/docs/api/namespaces/proto/classes/RecentEmojiWeight)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`RecentEmojiWeight`](/docs/api/namespaces/proto/classes/RecentEmojiWeight)

Defined in: [WAProto/index.d.ts:10658](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10658)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`RecentEmojiWeight`](/docs/api/namespaces/proto/classes/RecentEmojiWeight)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10657](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10657)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IRecentEmojiWeight`](/docs/api/namespaces/proto/interfaces/IRecentEmojiWeight)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`RecentEmojiWeight`](/docs/api/namespaces/proto/classes/RecentEmojiWeight)

Defined in: [WAProto/index.d.ts:10659](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10659)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`RecentEmojiWeight`](/docs/api/namespaces/proto/classes/RecentEmojiWeight)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10662](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10662)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10660](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10660)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`RecentEmojiWeight`](/docs/api/namespaces/proto/classes/RecentEmojiWeight)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-recordstructure"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/RecordStructure](https://baileys.wiki/docs/api/namespaces/proto/classes/RecordStructure)

Defined in: [WAProto/index.d.ts:10670](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10670)

## Implements[​](#implements "Direct link to Implements")

*   [`IRecordStructure`](/docs/api/namespaces/proto/interfaces/IRecordStructure)

## Constructors[​](#constructors "Direct link to Constructors")

### new RecordStructure()[​](#new-recordstructure "Direct link to new RecordStructure()")

> **new RecordStructure**(`p`?): [`RecordStructure`](/docs/api/namespaces/proto/classes/RecordStructure)

Defined in: [WAProto/index.d.ts:10671](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10671)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IRecordStructure`](/docs/api/namespaces/proto/interfaces/IRecordStructure)

#### Returns[​](#returns "Direct link to Returns")

[`RecordStructure`](/docs/api/namespaces/proto/classes/RecordStructure)

## Properties[​](#properties "Direct link to Properties")

### currentSession?[​](#currentsession "Direct link to currentSession?")

> `optional` **currentSession**: `null` | [`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure)

Defined in: [WAProto/index.d.ts:10672](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10672)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IRecordStructure`](/docs/api/namespaces/proto/interfaces/IRecordStructure).[`currentSession`](/docs/api/namespaces/proto/interfaces/IRecordStructure#currentsession)

* * *

### previousSessions[​](#previoussessions "Direct link to previousSessions")

> **previousSessions**: [`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure)\[\]

Defined in: [WAProto/index.d.ts:10673](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10673)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IRecordStructure`](/docs/api/namespaces/proto/interfaces/IRecordStructure).[`previousSessions`](/docs/api/namespaces/proto/interfaces/IRecordStructure#previoussessions)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10679](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10679)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`RecordStructure`](/docs/api/namespaces/proto/classes/RecordStructure)

Defined in: [WAProto/index.d.ts:10674](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10674)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IRecordStructure`](/docs/api/namespaces/proto/interfaces/IRecordStructure)

#### Returns[​](#returns-2 "Direct link to Returns")

[`RecordStructure`](/docs/api/namespaces/proto/classes/RecordStructure)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`RecordStructure`](/docs/api/namespaces/proto/classes/RecordStructure)

Defined in: [WAProto/index.d.ts:10676](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10676)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`RecordStructure`](/docs/api/namespaces/proto/classes/RecordStructure)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10675](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10675)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IRecordStructure`](/docs/api/namespaces/proto/interfaces/IRecordStructure)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`RecordStructure`](/docs/api/namespaces/proto/classes/RecordStructure)

Defined in: [WAProto/index.d.ts:10677](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10677)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`RecordStructure`](/docs/api/namespaces/proto/classes/RecordStructure)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10680](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10680)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10678](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10678)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`RecordStructure`](/docs/api/namespaces/proto/classes/RecordStructure)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-reportable"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/Reportable](https://baileys.wiki/docs/api/namespaces/proto/classes/Reportable)

Defined in: [WAProto/index.d.ts:10690](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10690)

## Implements[​](#implements "Direct link to Implements")

*   [`IReportable`](/docs/api/namespaces/proto/interfaces/IReportable)

## Constructors[​](#constructors "Direct link to Constructors")

### new Reportable()[​](#new-reportable "Direct link to new Reportable()")

> **new Reportable**(`p`?): [`Reportable`](/docs/api/namespaces/proto/classes/Reportable)

Defined in: [WAProto/index.d.ts:10691](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10691)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IReportable`](/docs/api/namespaces/proto/interfaces/IReportable)

#### Returns[​](#returns "Direct link to Returns")

[`Reportable`](/docs/api/namespaces/proto/classes/Reportable)

## Properties[​](#properties "Direct link to Properties")

### maxVersion?[​](#maxversion "Direct link to maxVersion?")

> `optional` **maxVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:10693](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10693)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IReportable`](/docs/api/namespaces/proto/interfaces/IReportable).[`maxVersion`](/docs/api/namespaces/proto/interfaces/IReportable#maxversion)

* * *

### minVersion?[​](#minversion "Direct link to minVersion?")

> `optional` **minVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:10692](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10692)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IReportable`](/docs/api/namespaces/proto/interfaces/IReportable).[`minVersion`](/docs/api/namespaces/proto/interfaces/IReportable#minversion)

* * *

### never?[​](#never "Direct link to never?")

> `optional` **never**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:10695](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10695)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IReportable`](/docs/api/namespaces/proto/interfaces/IReportable).[`never`](/docs/api/namespaces/proto/interfaces/IReportable#never)

* * *

### notReportableMinVersion?[​](#notreportableminversion "Direct link to notReportableMinVersion?")

> `optional` **notReportableMinVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:10694](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10694)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IReportable`](/docs/api/namespaces/proto/interfaces/IReportable).[`notReportableMinVersion`](/docs/api/namespaces/proto/interfaces/IReportable#notreportableminversion)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10701](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10701)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Reportable`](/docs/api/namespaces/proto/classes/Reportable)

Defined in: [WAProto/index.d.ts:10696](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10696)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IReportable`](/docs/api/namespaces/proto/interfaces/IReportable)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Reportable`](/docs/api/namespaces/proto/classes/Reportable)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Reportable`](/docs/api/namespaces/proto/classes/Reportable)

Defined in: [WAProto/index.d.ts:10698](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10698)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Reportable`](/docs/api/namespaces/proto/classes/Reportable)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10697](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10697)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IReportable`](/docs/api/namespaces/proto/interfaces/IReportable)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Reportable`](/docs/api/namespaces/proto/classes/Reportable)

Defined in: [WAProto/index.d.ts:10699](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10699)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Reportable`](/docs/api/namespaces/proto/classes/Reportable)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10702](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10702)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10700](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10700)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Reportable`](/docs/api/namespaces/proto/classes/Reportable)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-reportingtokeninfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/ReportingTokenInfo](https://baileys.wiki/docs/api/namespaces/proto/classes/ReportingTokenInfo)

Defined in: [WAProto/index.d.ts:10709](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10709)

## Implements[​](#implements "Direct link to Implements")

*   [`IReportingTokenInfo`](/docs/api/namespaces/proto/interfaces/IReportingTokenInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new ReportingTokenInfo()[​](#new-reportingtokeninfo "Direct link to new ReportingTokenInfo()")

> **new ReportingTokenInfo**(`p`?): [`ReportingTokenInfo`](/docs/api/namespaces/proto/classes/ReportingTokenInfo)

Defined in: [WAProto/index.d.ts:10710](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10710)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IReportingTokenInfo`](/docs/api/namespaces/proto/interfaces/IReportingTokenInfo)

#### Returns[​](#returns "Direct link to Returns")

[`ReportingTokenInfo`](/docs/api/namespaces/proto/classes/ReportingTokenInfo)

## Properties[​](#properties "Direct link to Properties")

### reportingTag?[​](#reportingtag "Direct link to reportingTag?")

> `optional` **reportingTag**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10711](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10711)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IReportingTokenInfo`](/docs/api/namespaces/proto/interfaces/IReportingTokenInfo).[`reportingTag`](/docs/api/namespaces/proto/interfaces/IReportingTokenInfo#reportingtag)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10717](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10717)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ReportingTokenInfo`](/docs/api/namespaces/proto/classes/ReportingTokenInfo)

Defined in: [WAProto/index.d.ts:10712](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10712)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IReportingTokenInfo`](/docs/api/namespaces/proto/interfaces/IReportingTokenInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ReportingTokenInfo`](/docs/api/namespaces/proto/classes/ReportingTokenInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ReportingTokenInfo`](/docs/api/namespaces/proto/classes/ReportingTokenInfo)

Defined in: [WAProto/index.d.ts:10714](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10714)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ReportingTokenInfo`](/docs/api/namespaces/proto/classes/ReportingTokenInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10713](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10713)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IReportingTokenInfo`](/docs/api/namespaces/proto/interfaces/IReportingTokenInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ReportingTokenInfo`](/docs/api/namespaces/proto/classes/ReportingTokenInfo)

Defined in: [WAProto/index.d.ts:10715](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10715)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ReportingTokenInfo`](/docs/api/namespaces/proto/classes/ReportingTokenInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10718](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10718)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10716](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10716)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ReportingTokenInfo`](/docs/api/namespaces/proto/classes/ReportingTokenInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-senderkeydistributionmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/SenderKeyDistributionMessage](https://baileys.wiki/docs/api/namespaces/proto/classes/SenderKeyDistributionMessage)

Defined in: [WAProto/index.d.ts:10728](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10728)

## Implements[​](#implements "Direct link to Implements")

*   [`ISenderKeyDistributionMessage`](/docs/api/namespaces/proto/interfaces/ISenderKeyDistributionMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new SenderKeyDistributionMessage()[​](#new-senderkeydistributionmessage "Direct link to new SenderKeyDistributionMessage()")

> **new SenderKeyDistributionMessage**(`p`?): [`SenderKeyDistributionMessage`](/docs/api/namespaces/proto/classes/SenderKeyDistributionMessage)

Defined in: [WAProto/index.d.ts:10729](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10729)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISenderKeyDistributionMessage`](/docs/api/namespaces/proto/interfaces/ISenderKeyDistributionMessage)

#### Returns[​](#returns "Direct link to Returns")

[`SenderKeyDistributionMessage`](/docs/api/namespaces/proto/classes/SenderKeyDistributionMessage)

## Properties[​](#properties "Direct link to Properties")

### chainKey?[​](#chainkey "Direct link to chainKey?")

> `optional` **chainKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10732](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10732)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISenderKeyDistributionMessage`](/docs/api/namespaces/proto/interfaces/ISenderKeyDistributionMessage).[`chainKey`](/docs/api/namespaces/proto/interfaces/ISenderKeyDistributionMessage#chainkey)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `number`

Defined in: [WAProto/index.d.ts:10730](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10730)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISenderKeyDistributionMessage`](/docs/api/namespaces/proto/interfaces/ISenderKeyDistributionMessage).[`id`](/docs/api/namespaces/proto/interfaces/ISenderKeyDistributionMessage#id)

* * *

### iteration?[​](#iteration "Direct link to iteration?")

> `optional` **iteration**: `null` | `number`

Defined in: [WAProto/index.d.ts:10731](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10731)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ISenderKeyDistributionMessage`](/docs/api/namespaces/proto/interfaces/ISenderKeyDistributionMessage).[`iteration`](/docs/api/namespaces/proto/interfaces/ISenderKeyDistributionMessage#iteration)

* * *

### signingKey?[​](#signingkey "Direct link to signingKey?")

> `optional` **signingKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10733](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10733)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ISenderKeyDistributionMessage`](/docs/api/namespaces/proto/interfaces/ISenderKeyDistributionMessage).[`signingKey`](/docs/api/namespaces/proto/interfaces/ISenderKeyDistributionMessage#signingkey)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10739](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10739)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SenderKeyDistributionMessage`](/docs/api/namespaces/proto/classes/SenderKeyDistributionMessage)

Defined in: [WAProto/index.d.ts:10734](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10734)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISenderKeyDistributionMessage`](/docs/api/namespaces/proto/interfaces/ISenderKeyDistributionMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SenderKeyDistributionMessage`](/docs/api/namespaces/proto/classes/SenderKeyDistributionMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SenderKeyDistributionMessage`](/docs/api/namespaces/proto/classes/SenderKeyDistributionMessage)

Defined in: [WAProto/index.d.ts:10736](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10736)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SenderKeyDistributionMessage`](/docs/api/namespaces/proto/classes/SenderKeyDistributionMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10735](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10735)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISenderKeyDistributionMessage`](/docs/api/namespaces/proto/interfaces/ISenderKeyDistributionMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SenderKeyDistributionMessage`](/docs/api/namespaces/proto/classes/SenderKeyDistributionMessage)

Defined in: [WAProto/index.d.ts:10737](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10737)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SenderKeyDistributionMessage`](/docs/api/namespaces/proto/classes/SenderKeyDistributionMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10740](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10740)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10738](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10738)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SenderKeyDistributionMessage`](/docs/api/namespaces/proto/classes/SenderKeyDistributionMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-senderkeymessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/SenderKeyMessage](https://baileys.wiki/docs/api/namespaces/proto/classes/SenderKeyMessage)

Defined in: [WAProto/index.d.ts:10749](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10749)

## Implements[​](#implements "Direct link to Implements")

*   [`ISenderKeyMessage`](/docs/api/namespaces/proto/interfaces/ISenderKeyMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new SenderKeyMessage()[​](#new-senderkeymessage "Direct link to new SenderKeyMessage()")

> **new SenderKeyMessage**(`p`?): [`SenderKeyMessage`](/docs/api/namespaces/proto/classes/SenderKeyMessage)

Defined in: [WAProto/index.d.ts:10750](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10750)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISenderKeyMessage`](/docs/api/namespaces/proto/interfaces/ISenderKeyMessage)

#### Returns[​](#returns "Direct link to Returns")

[`SenderKeyMessage`](/docs/api/namespaces/proto/classes/SenderKeyMessage)

## Properties[​](#properties "Direct link to Properties")

### ciphertext?[​](#ciphertext "Direct link to ciphertext?")

> `optional` **ciphertext**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10753](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10753)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISenderKeyMessage`](/docs/api/namespaces/proto/interfaces/ISenderKeyMessage).[`ciphertext`](/docs/api/namespaces/proto/interfaces/ISenderKeyMessage#ciphertext)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `number`

Defined in: [WAProto/index.d.ts:10751](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10751)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISenderKeyMessage`](/docs/api/namespaces/proto/interfaces/ISenderKeyMessage).[`id`](/docs/api/namespaces/proto/interfaces/ISenderKeyMessage#id)

* * *

### iteration?[​](#iteration "Direct link to iteration?")

> `optional` **iteration**: `null` | `number`

Defined in: [WAProto/index.d.ts:10752](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10752)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ISenderKeyMessage`](/docs/api/namespaces/proto/interfaces/ISenderKeyMessage).[`iteration`](/docs/api/namespaces/proto/interfaces/ISenderKeyMessage#iteration)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10759](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10759)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SenderKeyMessage`](/docs/api/namespaces/proto/classes/SenderKeyMessage)

Defined in: [WAProto/index.d.ts:10754](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10754)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISenderKeyMessage`](/docs/api/namespaces/proto/interfaces/ISenderKeyMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SenderKeyMessage`](/docs/api/namespaces/proto/classes/SenderKeyMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SenderKeyMessage`](/docs/api/namespaces/proto/classes/SenderKeyMessage)

Defined in: [WAProto/index.d.ts:10756](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10756)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SenderKeyMessage`](/docs/api/namespaces/proto/classes/SenderKeyMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10755](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10755)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISenderKeyMessage`](/docs/api/namespaces/proto/interfaces/ISenderKeyMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SenderKeyMessage`](/docs/api/namespaces/proto/classes/SenderKeyMessage)

Defined in: [WAProto/index.d.ts:10757](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10757)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SenderKeyMessage`](/docs/api/namespaces/proto/classes/SenderKeyMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10760](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10760)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10758](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10758)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SenderKeyMessage`](/docs/api/namespaces/proto/classes/SenderKeyMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-senderkeyrecordstructure"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/SenderKeyRecordStructure](https://baileys.wiki/docs/api/namespaces/proto/classes/SenderKeyRecordStructure)

Defined in: [WAProto/index.d.ts:10767](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10767)

## Implements[​](#implements "Direct link to Implements")

*   [`ISenderKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/ISenderKeyRecordStructure)

## Constructors[​](#constructors "Direct link to Constructors")

### new SenderKeyRecordStructure()[​](#new-senderkeyrecordstructure "Direct link to new SenderKeyRecordStructure()")

> **new SenderKeyRecordStructure**(`p`?): [`SenderKeyRecordStructure`](/docs/api/namespaces/proto/classes/SenderKeyRecordStructure)

Defined in: [WAProto/index.d.ts:10768](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10768)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISenderKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/ISenderKeyRecordStructure)

#### Returns[​](#returns "Direct link to Returns")

[`SenderKeyRecordStructure`](/docs/api/namespaces/proto/classes/SenderKeyRecordStructure)

## Properties[​](#properties "Direct link to Properties")

### senderKeyStates[​](#senderkeystates "Direct link to senderKeyStates")

> **senderKeyStates**: [`ISenderKeyStateStructure`](/docs/api/namespaces/proto/interfaces/ISenderKeyStateStructure)\[\]

Defined in: [WAProto/index.d.ts:10769](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10769)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISenderKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/ISenderKeyRecordStructure).[`senderKeyStates`](/docs/api/namespaces/proto/interfaces/ISenderKeyRecordStructure#senderkeystates)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10775](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10775)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SenderKeyRecordStructure`](/docs/api/namespaces/proto/classes/SenderKeyRecordStructure)

Defined in: [WAProto/index.d.ts:10770](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10770)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISenderKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/ISenderKeyRecordStructure)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SenderKeyRecordStructure`](/docs/api/namespaces/proto/classes/SenderKeyRecordStructure)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SenderKeyRecordStructure`](/docs/api/namespaces/proto/classes/SenderKeyRecordStructure)

Defined in: [WAProto/index.d.ts:10772](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10772)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SenderKeyRecordStructure`](/docs/api/namespaces/proto/classes/SenderKeyRecordStructure)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10771](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10771)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISenderKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/ISenderKeyRecordStructure)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SenderKeyRecordStructure`](/docs/api/namespaces/proto/classes/SenderKeyRecordStructure)

Defined in: [WAProto/index.d.ts:10773](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10773)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SenderKeyRecordStructure`](/docs/api/namespaces/proto/classes/SenderKeyRecordStructure)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10776](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10776)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10774](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10774)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SenderKeyRecordStructure`](/docs/api/namespaces/proto/classes/SenderKeyRecordStructure)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-senderkeystatestructure"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/SenderKeyStateStructure](https://baileys.wiki/docs/api/namespaces/proto/classes/SenderKeyStateStructure)

Defined in: [WAProto/index.d.ts:10786](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10786)

## Implements[​](#implements "Direct link to Implements")

*   [`ISenderKeyStateStructure`](/docs/api/namespaces/proto/interfaces/ISenderKeyStateStructure)

## Constructors[​](#constructors "Direct link to Constructors")

### new SenderKeyStateStructure()[​](#new-senderkeystatestructure "Direct link to new SenderKeyStateStructure()")

> **new SenderKeyStateStructure**(`p`?): [`SenderKeyStateStructure`](/docs/api/namespaces/proto/classes/SenderKeyStateStructure)

Defined in: [WAProto/index.d.ts:10787](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10787)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISenderKeyStateStructure`](/docs/api/namespaces/proto/interfaces/ISenderKeyStateStructure)

#### Returns[​](#returns "Direct link to Returns")

[`SenderKeyStateStructure`](/docs/api/namespaces/proto/classes/SenderKeyStateStructure)

## Properties[​](#properties "Direct link to Properties")

### senderChainKey?[​](#senderchainkey "Direct link to senderChainKey?")

> `optional` **senderChainKey**: `null` | [`ISenderChainKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderChainKey)

Defined in: [WAProto/index.d.ts:10789](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10789)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISenderKeyStateStructure`](/docs/api/namespaces/proto/interfaces/ISenderKeyStateStructure).[`senderChainKey`](/docs/api/namespaces/proto/interfaces/ISenderKeyStateStructure#senderchainkey)

* * *

### senderKeyId?[​](#senderkeyid "Direct link to senderKeyId?")

> `optional` **senderKeyId**: `null` | `number`

Defined in: [WAProto/index.d.ts:10788](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10788)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISenderKeyStateStructure`](/docs/api/namespaces/proto/interfaces/ISenderKeyStateStructure).[`senderKeyId`](/docs/api/namespaces/proto/interfaces/ISenderKeyStateStructure#senderkeyid)

* * *

### senderMessageKeys[​](#sendermessagekeys "Direct link to senderMessageKeys")

> **senderMessageKeys**: [`ISenderMessageKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderMessageKey)\[\]

Defined in: [WAProto/index.d.ts:10791](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10791)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ISenderKeyStateStructure`](/docs/api/namespaces/proto/interfaces/ISenderKeyStateStructure).[`senderMessageKeys`](/docs/api/namespaces/proto/interfaces/ISenderKeyStateStructure#sendermessagekeys)

* * *

### senderSigningKey?[​](#sendersigningkey "Direct link to senderSigningKey?")

> `optional` **senderSigningKey**: `null` | [`ISenderSigningKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderSigningKey)

Defined in: [WAProto/index.d.ts:10790](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10790)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ISenderKeyStateStructure`](/docs/api/namespaces/proto/interfaces/ISenderKeyStateStructure).[`senderSigningKey`](/docs/api/namespaces/proto/interfaces/ISenderKeyStateStructure#sendersigningkey)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10797](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10797)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SenderKeyStateStructure`](/docs/api/namespaces/proto/classes/SenderKeyStateStructure)

Defined in: [WAProto/index.d.ts:10792](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10792)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISenderKeyStateStructure`](/docs/api/namespaces/proto/interfaces/ISenderKeyStateStructure)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SenderKeyStateStructure`](/docs/api/namespaces/proto/classes/SenderKeyStateStructure)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SenderKeyStateStructure`](/docs/api/namespaces/proto/classes/SenderKeyStateStructure)

Defined in: [WAProto/index.d.ts:10794](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10794)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SenderKeyStateStructure`](/docs/api/namespaces/proto/classes/SenderKeyStateStructure)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10793](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10793)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISenderKeyStateStructure`](/docs/api/namespaces/proto/interfaces/ISenderKeyStateStructure)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SenderKeyStateStructure`](/docs/api/namespaces/proto/classes/SenderKeyStateStructure)

Defined in: [WAProto/index.d.ts:10795](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10795)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SenderKeyStateStructure`](/docs/api/namespaces/proto/classes/SenderKeyStateStructure)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10798](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10798)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10796](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10796)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SenderKeyStateStructure`](/docs/api/namespaces/proto/classes/SenderKeyStateStructure)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-servererrorreceipt"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/ServerErrorReceipt](https://baileys.wiki/docs/api/namespaces/proto/classes/ServerErrorReceipt)

Defined in: [WAProto/index.d.ts:10862](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10862)

## Implements[​](#implements "Direct link to Implements")

*   [`IServerErrorReceipt`](/docs/api/namespaces/proto/interfaces/IServerErrorReceipt)

## Constructors[​](#constructors "Direct link to Constructors")

### new ServerErrorReceipt()[​](#new-servererrorreceipt "Direct link to new ServerErrorReceipt()")

> **new ServerErrorReceipt**(`p`?): [`ServerErrorReceipt`](/docs/api/namespaces/proto/classes/ServerErrorReceipt)

Defined in: [WAProto/index.d.ts:10863](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10863)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IServerErrorReceipt`](/docs/api/namespaces/proto/interfaces/IServerErrorReceipt)

#### Returns[​](#returns "Direct link to Returns")

[`ServerErrorReceipt`](/docs/api/namespaces/proto/classes/ServerErrorReceipt)

## Properties[​](#properties "Direct link to Properties")

### stanzaId?[​](#stanzaid "Direct link to stanzaId?")

> `optional` **stanzaId**: `null` | `string`

Defined in: [WAProto/index.d.ts:10864](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10864)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IServerErrorReceipt`](/docs/api/namespaces/proto/interfaces/IServerErrorReceipt).[`stanzaId`](/docs/api/namespaces/proto/interfaces/IServerErrorReceipt#stanzaid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10870](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10870)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ServerErrorReceipt`](/docs/api/namespaces/proto/classes/ServerErrorReceipt)

Defined in: [WAProto/index.d.ts:10865](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10865)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IServerErrorReceipt`](/docs/api/namespaces/proto/interfaces/IServerErrorReceipt)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ServerErrorReceipt`](/docs/api/namespaces/proto/classes/ServerErrorReceipt)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ServerErrorReceipt`](/docs/api/namespaces/proto/classes/ServerErrorReceipt)

Defined in: [WAProto/index.d.ts:10867](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10867)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ServerErrorReceipt`](/docs/api/namespaces/proto/classes/ServerErrorReceipt)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10866](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10866)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IServerErrorReceipt`](/docs/api/namespaces/proto/interfaces/IServerErrorReceipt)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ServerErrorReceipt`](/docs/api/namespaces/proto/classes/ServerErrorReceipt)

Defined in: [WAProto/index.d.ts:10868](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10868)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ServerErrorReceipt`](/docs/api/namespaces/proto/classes/ServerErrorReceipt)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10871](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10871)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10869](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10869)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ServerErrorReceipt`](/docs/api/namespaces/proto/classes/ServerErrorReceipt)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-sessionstructure"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/SessionStructure](https://baileys.wiki/docs/api/namespaces/proto/classes/SessionStructure)

Defined in: [WAProto/index.d.ts:10890](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10890)

## Implements[​](#implements "Direct link to Implements")

*   [`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure)

## Constructors[​](#constructors "Direct link to Constructors")

### new SessionStructure()[​](#new-sessionstructure "Direct link to new SessionStructure()")

> **new SessionStructure**(`p`?): [`SessionStructure`](/docs/api/namespaces/proto/classes/SessionStructure)

Defined in: [WAProto/index.d.ts:10891](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10891)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure)

#### Returns[​](#returns "Direct link to Returns")

[`SessionStructure`](/docs/api/namespaces/proto/classes/SessionStructure)

## Properties[​](#properties "Direct link to Properties")

### aliceBaseKey?[​](#alicebasekey "Direct link to aliceBaseKey?")

> `optional` **aliceBaseKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10904](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10904)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure).[`aliceBaseKey`](/docs/api/namespaces/proto/interfaces/ISessionStructure#alicebasekey)

* * *

### localIdentityPublic?[​](#localidentitypublic "Direct link to localIdentityPublic?")

> `optional` **localIdentityPublic**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10893](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10893)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure).[`localIdentityPublic`](/docs/api/namespaces/proto/interfaces/ISessionStructure#localidentitypublic)

* * *

### localRegistrationId?[​](#localregistrationid "Direct link to localRegistrationId?")

> `optional` **localRegistrationId**: `null` | `number`

Defined in: [WAProto/index.d.ts:10902](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10902)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure).[`localRegistrationId`](/docs/api/namespaces/proto/interfaces/ISessionStructure#localregistrationid)

* * *

### needsRefresh?[​](#needsrefresh "Direct link to needsRefresh?")

> `optional` **needsRefresh**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:10903](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10903)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure).[`needsRefresh`](/docs/api/namespaces/proto/interfaces/ISessionStructure#needsrefresh)

* * *

### pendingKeyExchange?[​](#pendingkeyexchange "Direct link to pendingKeyExchange?")

> `optional` **pendingKeyExchange**: `null` | [`IPendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange)

Defined in: [WAProto/index.d.ts:10899](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10899)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure).[`pendingKeyExchange`](/docs/api/namespaces/proto/interfaces/ISessionStructure#pendingkeyexchange)

* * *

### pendingPreKey?[​](#pendingprekey "Direct link to pendingPreKey?")

> `optional` **pendingPreKey**: `null` | [`IPendingPreKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingPreKey)

Defined in: [WAProto/index.d.ts:10900](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10900)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure).[`pendingPreKey`](/docs/api/namespaces/proto/interfaces/ISessionStructure#pendingprekey)

* * *

### previousCounter?[​](#previouscounter "Direct link to previousCounter?")

> `optional` **previousCounter**: `null` | `number`

Defined in: [WAProto/index.d.ts:10896](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10896)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure).[`previousCounter`](/docs/api/namespaces/proto/interfaces/ISessionStructure#previouscounter)

* * *

### receiverChains[​](#receiverchains "Direct link to receiverChains")

> **receiverChains**: [`IChain`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IChain)\[\]

Defined in: [WAProto/index.d.ts:10898](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10898)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure).[`receiverChains`](/docs/api/namespaces/proto/interfaces/ISessionStructure#receiverchains)

* * *

### remoteIdentityPublic?[​](#remoteidentitypublic "Direct link to remoteIdentityPublic?")

> `optional` **remoteIdentityPublic**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10894](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10894)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure).[`remoteIdentityPublic`](/docs/api/namespaces/proto/interfaces/ISessionStructure#remoteidentitypublic)

* * *

### remoteRegistrationId?[​](#remoteregistrationid "Direct link to remoteRegistrationId?")

> `optional` **remoteRegistrationId**: `null` | `number`

Defined in: [WAProto/index.d.ts:10901](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10901)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure).[`remoteRegistrationId`](/docs/api/namespaces/proto/interfaces/ISessionStructure#remoteregistrationid)

* * *

### rootKey?[​](#rootkey "Direct link to rootKey?")

> `optional` **rootKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10895](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10895)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure).[`rootKey`](/docs/api/namespaces/proto/interfaces/ISessionStructure#rootkey)

* * *

### senderChain?[​](#senderchain "Direct link to senderChain?")

> `optional` **senderChain**: `null` | [`IChain`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IChain)

Defined in: [WAProto/index.d.ts:10897](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10897)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure).[`senderChain`](/docs/api/namespaces/proto/interfaces/ISessionStructure#senderchain)

* * *

### sessionVersion?[​](#sessionversion "Direct link to sessionVersion?")

> `optional` **sessionVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:10892](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10892)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure).[`sessionVersion`](/docs/api/namespaces/proto/interfaces/ISessionStructure#sessionversion)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10910](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10910)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SessionStructure`](/docs/api/namespaces/proto/classes/SessionStructure)

Defined in: [WAProto/index.d.ts:10905](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10905)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SessionStructure`](/docs/api/namespaces/proto/classes/SessionStructure)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SessionStructure`](/docs/api/namespaces/proto/classes/SessionStructure)

Defined in: [WAProto/index.d.ts:10907](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10907)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SessionStructure`](/docs/api/namespaces/proto/classes/SessionStructure)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10906](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10906)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SessionStructure`](/docs/api/namespaces/proto/classes/SessionStructure)

Defined in: [WAProto/index.d.ts:10908](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10908)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SessionStructure`](/docs/api/namespaces/proto/classes/SessionStructure)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10911](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10911)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10909](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10909)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SessionStructure`](/docs/api/namespaces/proto/classes/SessionStructure)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-sessiontransparencymetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/SessionTransparencyMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/SessionTransparencyMetadata)

Defined in: [WAProto/index.d.ts:11036](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11036)

## Implements[​](#implements "Direct link to Implements")

*   [`ISessionTransparencyMetadata`](/docs/api/namespaces/proto/interfaces/ISessionTransparencyMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new SessionTransparencyMetadata()[​](#new-sessiontransparencymetadata "Direct link to new SessionTransparencyMetadata()")

> **new SessionTransparencyMetadata**(`p`?): [`SessionTransparencyMetadata`](/docs/api/namespaces/proto/classes/SessionTransparencyMetadata)

Defined in: [WAProto/index.d.ts:11037](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11037)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISessionTransparencyMetadata`](/docs/api/namespaces/proto/interfaces/ISessionTransparencyMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`SessionTransparencyMetadata`](/docs/api/namespaces/proto/classes/SessionTransparencyMetadata)

## Properties[​](#properties "Direct link to Properties")

### disclaimerText?[​](#disclaimertext "Direct link to disclaimerText?")

> `optional` **disclaimerText**: `null` | `string`

Defined in: [WAProto/index.d.ts:11038](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11038)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISessionTransparencyMetadata`](/docs/api/namespaces/proto/interfaces/ISessionTransparencyMetadata).[`disclaimerText`](/docs/api/namespaces/proto/interfaces/ISessionTransparencyMetadata#disclaimertext)

* * *

### hcaId?[​](#hcaid "Direct link to hcaId?")

> `optional` **hcaId**: `null` | `string`

Defined in: [WAProto/index.d.ts:11039](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11039)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISessionTransparencyMetadata`](/docs/api/namespaces/proto/interfaces/ISessionTransparencyMetadata).[`hcaId`](/docs/api/namespaces/proto/interfaces/ISessionTransparencyMetadata#hcaid)

* * *

### sessionTransparencyType?[​](#sessiontransparencytype "Direct link to sessionTransparencyType?")

> `optional` **sessionTransparencyType**: `null` | [`SessionTransparencyType`](/docs/api/namespaces/proto/enumerations/SessionTransparencyType)

Defined in: [WAProto/index.d.ts:11040](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11040)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ISessionTransparencyMetadata`](/docs/api/namespaces/proto/interfaces/ISessionTransparencyMetadata).[`sessionTransparencyType`](/docs/api/namespaces/proto/interfaces/ISessionTransparencyMetadata#sessiontransparencytype)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11046](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11046)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SessionTransparencyMetadata`](/docs/api/namespaces/proto/classes/SessionTransparencyMetadata)

Defined in: [WAProto/index.d.ts:11041](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11041)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISessionTransparencyMetadata`](/docs/api/namespaces/proto/interfaces/ISessionTransparencyMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SessionTransparencyMetadata`](/docs/api/namespaces/proto/classes/SessionTransparencyMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SessionTransparencyMetadata`](/docs/api/namespaces/proto/classes/SessionTransparencyMetadata)

Defined in: [WAProto/index.d.ts:11043](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11043)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SessionTransparencyMetadata`](/docs/api/namespaces/proto/classes/SessionTransparencyMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11042](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11042)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISessionTransparencyMetadata`](/docs/api/namespaces/proto/interfaces/ISessionTransparencyMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SessionTransparencyMetadata`](/docs/api/namespaces/proto/classes/SessionTransparencyMetadata)

Defined in: [WAProto/index.d.ts:11044](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11044)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SessionTransparencyMetadata`](/docs/api/namespaces/proto/classes/SessionTransparencyMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11047](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11047)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11045](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11045)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SessionTransparencyMetadata`](/docs/api/namespaces/proto/classes/SessionTransparencyMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-signalmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/SignalMessage](https://baileys.wiki/docs/api/namespaces/proto/classes/SignalMessage)

Defined in: [WAProto/index.d.ts:11062](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11062)

## Implements[​](#implements "Direct link to Implements")

*   [`ISignalMessage`](/docs/api/namespaces/proto/interfaces/ISignalMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new SignalMessage()[​](#new-signalmessage "Direct link to new SignalMessage()")

> **new SignalMessage**(`p`?): [`SignalMessage`](/docs/api/namespaces/proto/classes/SignalMessage)

Defined in: [WAProto/index.d.ts:11063](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11063)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISignalMessage`](/docs/api/namespaces/proto/interfaces/ISignalMessage)

#### Returns[​](#returns "Direct link to Returns")

[`SignalMessage`](/docs/api/namespaces/proto/classes/SignalMessage)

## Properties[​](#properties "Direct link to Properties")

### ciphertext?[​](#ciphertext "Direct link to ciphertext?")

> `optional` **ciphertext**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11067](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11067)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISignalMessage`](/docs/api/namespaces/proto/interfaces/ISignalMessage).[`ciphertext`](/docs/api/namespaces/proto/interfaces/ISignalMessage#ciphertext)

* * *

### counter?[​](#counter "Direct link to counter?")

> `optional` **counter**: `null` | `number`

Defined in: [WAProto/index.d.ts:11065](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11065)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISignalMessage`](/docs/api/namespaces/proto/interfaces/ISignalMessage).[`counter`](/docs/api/namespaces/proto/interfaces/ISignalMessage#counter)

* * *

### previousCounter?[​](#previouscounter "Direct link to previousCounter?")

> `optional` **previousCounter**: `null` | `number`

Defined in: [WAProto/index.d.ts:11066](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11066)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ISignalMessage`](/docs/api/namespaces/proto/interfaces/ISignalMessage).[`previousCounter`](/docs/api/namespaces/proto/interfaces/ISignalMessage#previouscounter)

* * *

### ratchetKey?[​](#ratchetkey "Direct link to ratchetKey?")

> `optional` **ratchetKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11064](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11064)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ISignalMessage`](/docs/api/namespaces/proto/interfaces/ISignalMessage).[`ratchetKey`](/docs/api/namespaces/proto/interfaces/ISignalMessage#ratchetkey)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11073](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11073)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SignalMessage`](/docs/api/namespaces/proto/classes/SignalMessage)

Defined in: [WAProto/index.d.ts:11068](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11068)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISignalMessage`](/docs/api/namespaces/proto/interfaces/ISignalMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SignalMessage`](/docs/api/namespaces/proto/classes/SignalMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SignalMessage`](/docs/api/namespaces/proto/classes/SignalMessage)

Defined in: [WAProto/index.d.ts:11070](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11070)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SignalMessage`](/docs/api/namespaces/proto/classes/SignalMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11069](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11069)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISignalMessage`](/docs/api/namespaces/proto/interfaces/ISignalMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SignalMessage`](/docs/api/namespaces/proto/classes/SignalMessage)

Defined in: [WAProto/index.d.ts:11071](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11071)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SignalMessage`](/docs/api/namespaces/proto/classes/SignalMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11074](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11074)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11072](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11072)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SignalMessage`](/docs/api/namespaces/proto/classes/SignalMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-signedprekeyrecordstructure"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/SignedPreKeyRecordStructure](https://baileys.wiki/docs/api/namespaces/proto/classes/SignedPreKeyRecordStructure)

Defined in: [WAProto/index.d.ts:11085](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11085)

## Implements[​](#implements "Direct link to Implements")

*   [`ISignedPreKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/ISignedPreKeyRecordStructure)

## Constructors[​](#constructors "Direct link to Constructors")

### new SignedPreKeyRecordStructure()[​](#new-signedprekeyrecordstructure "Direct link to new SignedPreKeyRecordStructure()")

> **new SignedPreKeyRecordStructure**(`p`?): [`SignedPreKeyRecordStructure`](/docs/api/namespaces/proto/classes/SignedPreKeyRecordStructure)

Defined in: [WAProto/index.d.ts:11086](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11086)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISignedPreKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/ISignedPreKeyRecordStructure)

#### Returns[​](#returns "Direct link to Returns")

[`SignedPreKeyRecordStructure`](/docs/api/namespaces/proto/classes/SignedPreKeyRecordStructure)

## Properties[​](#properties "Direct link to Properties")

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `number`

Defined in: [WAProto/index.d.ts:11087](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11087)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISignedPreKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/ISignedPreKeyRecordStructure).[`id`](/docs/api/namespaces/proto/interfaces/ISignedPreKeyRecordStructure#id)

* * *

### privateKey?[​](#privatekey "Direct link to privateKey?")

> `optional` **privateKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11089](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11089)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISignedPreKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/ISignedPreKeyRecordStructure).[`privateKey`](/docs/api/namespaces/proto/interfaces/ISignedPreKeyRecordStructure#privatekey)

* * *

### publicKey?[​](#publickey "Direct link to publicKey?")

> `optional` **publicKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11088](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11088)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ISignedPreKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/ISignedPreKeyRecordStructure).[`publicKey`](/docs/api/namespaces/proto/interfaces/ISignedPreKeyRecordStructure#publickey)

* * *

### signature?[​](#signature "Direct link to signature?")

> `optional` **signature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11090](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11090)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ISignedPreKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/ISignedPreKeyRecordStructure).[`signature`](/docs/api/namespaces/proto/interfaces/ISignedPreKeyRecordStructure#signature)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:11091](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11091)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ISignedPreKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/ISignedPreKeyRecordStructure).[`timestamp`](/docs/api/namespaces/proto/interfaces/ISignedPreKeyRecordStructure#timestamp)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11097](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11097)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SignedPreKeyRecordStructure`](/docs/api/namespaces/proto/classes/SignedPreKeyRecordStructure)

Defined in: [WAProto/index.d.ts:11092](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11092)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISignedPreKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/ISignedPreKeyRecordStructure)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SignedPreKeyRecordStructure`](/docs/api/namespaces/proto/classes/SignedPreKeyRecordStructure)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SignedPreKeyRecordStructure`](/docs/api/namespaces/proto/classes/SignedPreKeyRecordStructure)

Defined in: [WAProto/index.d.ts:11094](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11094)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SignedPreKeyRecordStructure`](/docs/api/namespaces/proto/classes/SignedPreKeyRecordStructure)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11093](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11093)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISignedPreKeyRecordStructure`](/docs/api/namespaces/proto/interfaces/ISignedPreKeyRecordStructure)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SignedPreKeyRecordStructure`](/docs/api/namespaces/proto/classes/SignedPreKeyRecordStructure)

Defined in: [WAProto/index.d.ts:11095](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11095)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SignedPreKeyRecordStructure`](/docs/api/namespaces/proto/classes/SignedPreKeyRecordStructure)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11098](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11098)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11096](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11096)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SignedPreKeyRecordStructure`](/docs/api/namespaces/proto/classes/SignedPreKeyRecordStructure)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-statusattribution"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/StatusAttribution](https://baileys.wiki/docs/api/namespaces/proto/classes/StatusAttribution)

Defined in: [WAProto/index.d.ts:11112](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11112)

## Implements[​](#implements "Direct link to Implements")

*   [`IStatusAttribution`](/docs/api/namespaces/proto/interfaces/IStatusAttribution)

## Constructors[​](#constructors "Direct link to Constructors")

### new StatusAttribution()[​](#new-statusattribution "Direct link to new StatusAttribution()")

> **new StatusAttribution**(`p`?): [`StatusAttribution`](/docs/api/namespaces/proto/classes/StatusAttribution)

Defined in: [WAProto/index.d.ts:11113](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11113)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IStatusAttribution`](/docs/api/namespaces/proto/interfaces/IStatusAttribution)

#### Returns[​](#returns "Direct link to Returns")

[`StatusAttribution`](/docs/api/namespaces/proto/classes/StatusAttribution)

## Properties[​](#properties "Direct link to Properties")

### actionUrl?[​](#actionurl "Direct link to actionUrl?")

> `optional` **actionUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:11115](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11115)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IStatusAttribution`](/docs/api/namespaces/proto/interfaces/IStatusAttribution).[`actionUrl`](/docs/api/namespaces/proto/interfaces/IStatusAttribution#actionurl)

* * *

### aiCreatedAttribution?[​](#aicreatedattribution "Direct link to aiCreatedAttribution?")

> `optional` **aiCreatedAttribution**: `null` | [`IAiCreatedAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IAiCreatedAttribution)

Defined in: [WAProto/index.d.ts:11121](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11121)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IStatusAttribution`](/docs/api/namespaces/proto/interfaces/IStatusAttribution).[`aiCreatedAttribution`](/docs/api/namespaces/proto/interfaces/IStatusAttribution#aicreatedattribution)

* * *

### attributionData?[​](#attributiondata "Direct link to attributionData?")

> `optional` **attributionData**: `"statusReshare"` | `"externalShare"` | `"music"` | `"groupStatus"` | `"rlAttribution"` | `"aiCreatedAttribution"`

Defined in: [WAProto/index.d.ts:11122](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11122)

* * *

### externalShare?[​](#externalshare "Direct link to externalShare?")

> `optional` **externalShare**: `null` | [`IExternalShare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IExternalShare)

Defined in: [WAProto/index.d.ts:11117](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11117)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IStatusAttribution`](/docs/api/namespaces/proto/interfaces/IStatusAttribution).[`externalShare`](/docs/api/namespaces/proto/interfaces/IStatusAttribution#externalshare)

* * *

### groupStatus?[​](#groupstatus "Direct link to groupStatus?")

> `optional` **groupStatus**: `null` | [`IGroupStatus`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IGroupStatus)

Defined in: [WAProto/index.d.ts:11119](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11119)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IStatusAttribution`](/docs/api/namespaces/proto/interfaces/IStatusAttribution).[`groupStatus`](/docs/api/namespaces/proto/interfaces/IStatusAttribution#groupstatus)

* * *

### music?[​](#music "Direct link to music?")

> `optional` **music**: `null` | [`IMusic`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic)

Defined in: [WAProto/index.d.ts:11118](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11118)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IStatusAttribution`](/docs/api/namespaces/proto/interfaces/IStatusAttribution).[`music`](/docs/api/namespaces/proto/interfaces/IStatusAttribution#music)

* * *

### rlAttribution?[​](#rlattribution "Direct link to rlAttribution?")

> `optional` **rlAttribution**: `null` | [`IRLAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IRLAttribution)

Defined in: [WAProto/index.d.ts:11120](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11120)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IStatusAttribution`](/docs/api/namespaces/proto/interfaces/IStatusAttribution).[`rlAttribution`](/docs/api/namespaces/proto/interfaces/IStatusAttribution#rlattribution)

* * *

### statusReshare?[​](#statusreshare "Direct link to statusReshare?")

> `optional` **statusReshare**: `null` | [`IStatusReshare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IStatusReshare)

Defined in: [WAProto/index.d.ts:11116](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11116)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IStatusAttribution`](/docs/api/namespaces/proto/interfaces/IStatusAttribution).[`statusReshare`](/docs/api/namespaces/proto/interfaces/IStatusAttribution#statusreshare)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`Type`](/docs/api/namespaces/proto/namespaces/StatusAttribution/enumerations/Type)

Defined in: [WAProto/index.d.ts:11114](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11114)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IStatusAttribution`](/docs/api/namespaces/proto/interfaces/IStatusAttribution).[`type`](/docs/api/namespaces/proto/interfaces/IStatusAttribution#type)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11128](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11128)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`StatusAttribution`](/docs/api/namespaces/proto/classes/StatusAttribution)

Defined in: [WAProto/index.d.ts:11123](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11123)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IStatusAttribution`](/docs/api/namespaces/proto/interfaces/IStatusAttribution)

#### Returns[​](#returns-2 "Direct link to Returns")

[`StatusAttribution`](/docs/api/namespaces/proto/classes/StatusAttribution)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`StatusAttribution`](/docs/api/namespaces/proto/classes/StatusAttribution)

Defined in: [WAProto/index.d.ts:11125](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11125)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`StatusAttribution`](/docs/api/namespaces/proto/classes/StatusAttribution)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11124](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11124)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IStatusAttribution`](/docs/api/namespaces/proto/interfaces/IStatusAttribution)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`StatusAttribution`](/docs/api/namespaces/proto/classes/StatusAttribution)

Defined in: [WAProto/index.d.ts:11126](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11126)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`StatusAttribution`](/docs/api/namespaces/proto/classes/StatusAttribution)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11129](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11129)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11127](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11127)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`StatusAttribution`](/docs/api/namespaces/proto/classes/StatusAttribution)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-statusmentionmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/StatusMentionMessage](https://baileys.wiki/docs/api/namespaces/proto/classes/StatusMentionMessage)

Defined in: [WAProto/index.d.ts:11333](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11333)

## Implements[​](#implements "Direct link to Implements")

*   [`IStatusMentionMessage`](/docs/api/namespaces/proto/interfaces/IStatusMentionMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new StatusMentionMessage()[​](#new-statusmentionmessage "Direct link to new StatusMentionMessage()")

> **new StatusMentionMessage**(`p`?): [`StatusMentionMessage`](/docs/api/namespaces/proto/classes/StatusMentionMessage)

Defined in: [WAProto/index.d.ts:11334](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11334)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IStatusMentionMessage`](/docs/api/namespaces/proto/interfaces/IStatusMentionMessage)

#### Returns[​](#returns "Direct link to Returns")

[`StatusMentionMessage`](/docs/api/namespaces/proto/classes/StatusMentionMessage)

## Properties[​](#properties "Direct link to Properties")

### quotedStatus?[​](#quotedstatus "Direct link to quotedStatus?")

> `optional` **quotedStatus**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:11335](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11335)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IStatusMentionMessage`](/docs/api/namespaces/proto/interfaces/IStatusMentionMessage).[`quotedStatus`](/docs/api/namespaces/proto/interfaces/IStatusMentionMessage#quotedstatus)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11341](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11341)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`StatusMentionMessage`](/docs/api/namespaces/proto/classes/StatusMentionMessage)

Defined in: [WAProto/index.d.ts:11336](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11336)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IStatusMentionMessage`](/docs/api/namespaces/proto/interfaces/IStatusMentionMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`StatusMentionMessage`](/docs/api/namespaces/proto/classes/StatusMentionMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`StatusMentionMessage`](/docs/api/namespaces/proto/classes/StatusMentionMessage)

Defined in: [WAProto/index.d.ts:11338](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11338)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`StatusMentionMessage`](/docs/api/namespaces/proto/classes/StatusMentionMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11337](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11337)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IStatusMentionMessage`](/docs/api/namespaces/proto/interfaces/IStatusMentionMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`StatusMentionMessage`](/docs/api/namespaces/proto/classes/StatusMentionMessage)

Defined in: [WAProto/index.d.ts:11339](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11339)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`StatusMentionMessage`](/docs/api/namespaces/proto/classes/StatusMentionMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11342](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11342)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11340](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11340)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`StatusMentionMessage`](/docs/api/namespaces/proto/classes/StatusMentionMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-statuspsa"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/StatusPSA](https://baileys.wiki/docs/api/namespaces/proto/classes/StatusPSA)

Defined in: [WAProto/index.d.ts:11350](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11350)

## Implements[​](#implements "Direct link to Implements")

*   [`IStatusPSA`](/docs/api/namespaces/proto/interfaces/IStatusPSA)

## Constructors[​](#constructors "Direct link to Constructors")

### new StatusPSA()[​](#new-statuspsa "Direct link to new StatusPSA()")

> **new StatusPSA**(`p`?): [`StatusPSA`](/docs/api/namespaces/proto/classes/StatusPSA)

Defined in: [WAProto/index.d.ts:11351](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11351)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IStatusPSA`](/docs/api/namespaces/proto/interfaces/IStatusPSA)

#### Returns[​](#returns "Direct link to Returns")

[`StatusPSA`](/docs/api/namespaces/proto/classes/StatusPSA)

## Properties[​](#properties "Direct link to Properties")

### campaignExpirationTimestamp?[​](#campaignexpirationtimestamp "Direct link to campaignExpirationTimestamp?")

> `optional` **campaignExpirationTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:11353](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11353)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IStatusPSA`](/docs/api/namespaces/proto/interfaces/IStatusPSA).[`campaignExpirationTimestamp`](/docs/api/namespaces/proto/interfaces/IStatusPSA#campaignexpirationtimestamp)

* * *

### campaignId[​](#campaignid "Direct link to campaignId")

> **campaignId**: `number` | `Long`

Defined in: [WAProto/index.d.ts:11352](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11352)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IStatusPSA`](/docs/api/namespaces/proto/interfaces/IStatusPSA).[`campaignId`](/docs/api/namespaces/proto/interfaces/IStatusPSA#campaignid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11359](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11359)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`StatusPSA`](/docs/api/namespaces/proto/classes/StatusPSA)

Defined in: [WAProto/index.d.ts:11354](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11354)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IStatusPSA`](/docs/api/namespaces/proto/interfaces/IStatusPSA)

#### Returns[​](#returns-2 "Direct link to Returns")

[`StatusPSA`](/docs/api/namespaces/proto/classes/StatusPSA)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`StatusPSA`](/docs/api/namespaces/proto/classes/StatusPSA)

Defined in: [WAProto/index.d.ts:11356](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11356)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`StatusPSA`](/docs/api/namespaces/proto/classes/StatusPSA)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11355](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11355)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IStatusPSA`](/docs/api/namespaces/proto/interfaces/IStatusPSA)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`StatusPSA`](/docs/api/namespaces/proto/classes/StatusPSA)

Defined in: [WAProto/index.d.ts:11357](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11357)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`StatusPSA`](/docs/api/namespaces/proto/classes/StatusPSA)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11360](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11360)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11358](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11358)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`StatusPSA`](/docs/api/namespaces/proto/classes/StatusPSA)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-stickermetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/StickerMetadata](https://baileys.wiki/docs/api/namespaces/proto/classes/StickerMetadata)

Defined in: [WAProto/index.d.ts:11380](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11380)

## Implements[​](#implements "Direct link to Implements")

*   [`IStickerMetadata`](/docs/api/namespaces/proto/interfaces/IStickerMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new StickerMetadata()[​](#new-stickermetadata "Direct link to new StickerMetadata()")

> **new StickerMetadata**(`p`?): [`StickerMetadata`](/docs/api/namespaces/proto/classes/StickerMetadata)

Defined in: [WAProto/index.d.ts:11381](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11381)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IStickerMetadata`](/docs/api/namespaces/proto/interfaces/IStickerMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`StickerMetadata`](/docs/api/namespaces/proto/classes/StickerMetadata)

## Properties[​](#properties "Direct link to Properties")

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:11389](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11389)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IStickerMetadata`](/docs/api/namespaces/proto/interfaces/IStickerMetadata).[`directPath`](/docs/api/namespaces/proto/interfaces/IStickerMetadata#directpath)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11384](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11384)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IStickerMetadata`](/docs/api/namespaces/proto/interfaces/IStickerMetadata).[`fileEncSha256`](/docs/api/namespaces/proto/interfaces/IStickerMetadata#fileencsha256)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:11390](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11390)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IStickerMetadata`](/docs/api/namespaces/proto/interfaces/IStickerMetadata).[`fileLength`](/docs/api/namespaces/proto/interfaces/IStickerMetadata#filelength)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11383](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11383)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IStickerMetadata`](/docs/api/namespaces/proto/interfaces/IStickerMetadata).[`fileSha256`](/docs/api/namespaces/proto/interfaces/IStickerMetadata#filesha256)

* * *

### height?[​](#height "Direct link to height?")

> `optional` **height**: `null` | `number`

Defined in: [WAProto/index.d.ts:11387](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11387)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IStickerMetadata`](/docs/api/namespaces/proto/interfaces/IStickerMetadata).[`height`](/docs/api/namespaces/proto/interfaces/IStickerMetadata#height)

* * *

### imageHash?[​](#imagehash "Direct link to imageHash?")

> `optional` **imageHash**: `null` | `string`

Defined in: [WAProto/index.d.ts:11394](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11394)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IStickerMetadata`](/docs/api/namespaces/proto/interfaces/IStickerMetadata).[`imageHash`](/docs/api/namespaces/proto/interfaces/IStickerMetadata#imagehash)

* * *

### isAvatarSticker?[​](#isavatarsticker "Direct link to isAvatarSticker?")

> `optional` **isAvatarSticker**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11395](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11395)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IStickerMetadata`](/docs/api/namespaces/proto/interfaces/IStickerMetadata).[`isAvatarSticker`](/docs/api/namespaces/proto/interfaces/IStickerMetadata#isavatarsticker)

* * *

### isLottie?[​](#islottie "Direct link to isLottie?")

> `optional` **isLottie**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11393](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11393)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IStickerMetadata`](/docs/api/namespaces/proto/interfaces/IStickerMetadata).[`isLottie`](/docs/api/namespaces/proto/interfaces/IStickerMetadata#islottie)

* * *

### lastStickerSentTs?[​](#laststickersentts "Direct link to lastStickerSentTs?")

> `optional` **lastStickerSentTs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:11392](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11392)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IStickerMetadata`](/docs/api/namespaces/proto/interfaces/IStickerMetadata).[`lastStickerSentTs`](/docs/api/namespaces/proto/interfaces/IStickerMetadata#laststickersentts)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11385](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11385)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IStickerMetadata`](/docs/api/namespaces/proto/interfaces/IStickerMetadata).[`mediaKey`](/docs/api/namespaces/proto/interfaces/IStickerMetadata#mediakey)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:11386](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11386)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IStickerMetadata`](/docs/api/namespaces/proto/interfaces/IStickerMetadata).[`mimetype`](/docs/api/namespaces/proto/interfaces/IStickerMetadata#mimetype)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:11382](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11382)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IStickerMetadata`](/docs/api/namespaces/proto/interfaces/IStickerMetadata).[`url`](/docs/api/namespaces/proto/interfaces/IStickerMetadata#url)

* * *

### weight?[​](#weight "Direct link to weight?")

> `optional` **weight**: `null` | `number`

Defined in: [WAProto/index.d.ts:11391](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11391)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IStickerMetadata`](/docs/api/namespaces/proto/interfaces/IStickerMetadata).[`weight`](/docs/api/namespaces/proto/interfaces/IStickerMetadata#weight)

* * *

### width?[​](#width "Direct link to width?")

> `optional` **width**: `null` | `number`

Defined in: [WAProto/index.d.ts:11388](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11388)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IStickerMetadata`](/docs/api/namespaces/proto/interfaces/IStickerMetadata).[`width`](/docs/api/namespaces/proto/interfaces/IStickerMetadata#width)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11401](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11401)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`StickerMetadata`](/docs/api/namespaces/proto/classes/StickerMetadata)

Defined in: [WAProto/index.d.ts:11396](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11396)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IStickerMetadata`](/docs/api/namespaces/proto/interfaces/IStickerMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`StickerMetadata`](/docs/api/namespaces/proto/classes/StickerMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`StickerMetadata`](/docs/api/namespaces/proto/classes/StickerMetadata)

Defined in: [WAProto/index.d.ts:11398](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11398)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`StickerMetadata`](/docs/api/namespaces/proto/classes/StickerMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11397](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11397)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IStickerMetadata`](/docs/api/namespaces/proto/interfaces/IStickerMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`StickerMetadata`](/docs/api/namespaces/proto/classes/StickerMetadata)

Defined in: [WAProto/index.d.ts:11399](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11399)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`StickerMetadata`](/docs/api/namespaces/proto/classes/StickerMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11402](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11402)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11400](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11400)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`StickerMetadata`](/docs/api/namespaces/proto/classes/StickerMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-syncactiondata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/SyncActionData](https://baileys.wiki/docs/api/namespaces/proto/classes/SyncActionData)

Defined in: [WAProto/index.d.ts:11412](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11412)

## Implements[​](#implements "Direct link to Implements")

*   [`ISyncActionData`](/docs/api/namespaces/proto/interfaces/ISyncActionData)

## Constructors[​](#constructors "Direct link to Constructors")

### new SyncActionData()[​](#new-syncactiondata "Direct link to new SyncActionData()")

> **new SyncActionData**(`p`?): [`SyncActionData`](/docs/api/namespaces/proto/classes/SyncActionData)

Defined in: [WAProto/index.d.ts:11413](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11413)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISyncActionData`](/docs/api/namespaces/proto/interfaces/ISyncActionData)

#### Returns[​](#returns "Direct link to Returns")

[`SyncActionData`](/docs/api/namespaces/proto/classes/SyncActionData)

## Properties[​](#properties "Direct link to Properties")

### index?[​](#index "Direct link to index?")

> `optional` **index**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11414](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11414)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISyncActionData`](/docs/api/namespaces/proto/interfaces/ISyncActionData).[`index`](/docs/api/namespaces/proto/interfaces/ISyncActionData#index)

* * *

### padding?[​](#padding "Direct link to padding?")

> `optional` **padding**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11416](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11416)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISyncActionData`](/docs/api/namespaces/proto/interfaces/ISyncActionData).[`padding`](/docs/api/namespaces/proto/interfaces/ISyncActionData#padding)

* * *

### value?[​](#value "Direct link to value?")

> `optional` **value**: `null` | [`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue)

Defined in: [WAProto/index.d.ts:11415](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11415)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ISyncActionData`](/docs/api/namespaces/proto/interfaces/ISyncActionData).[`value`](/docs/api/namespaces/proto/interfaces/ISyncActionData#value)

* * *

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | `number`

Defined in: [WAProto/index.d.ts:11417](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11417)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ISyncActionData`](/docs/api/namespaces/proto/interfaces/ISyncActionData).[`version`](/docs/api/namespaces/proto/interfaces/ISyncActionData#version)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11423](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11423)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SyncActionData`](/docs/api/namespaces/proto/classes/SyncActionData)

Defined in: [WAProto/index.d.ts:11418](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11418)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISyncActionData`](/docs/api/namespaces/proto/interfaces/ISyncActionData)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SyncActionData`](/docs/api/namespaces/proto/classes/SyncActionData)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SyncActionData`](/docs/api/namespaces/proto/classes/SyncActionData)

Defined in: [WAProto/index.d.ts:11420](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11420)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SyncActionData`](/docs/api/namespaces/proto/classes/SyncActionData)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11419](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11419)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISyncActionData`](/docs/api/namespaces/proto/interfaces/ISyncActionData)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SyncActionData`](/docs/api/namespaces/proto/classes/SyncActionData)

Defined in: [WAProto/index.d.ts:11421](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11421)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SyncActionData`](/docs/api/namespaces/proto/classes/SyncActionData)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11424](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11424)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11422](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11422)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SyncActionData`](/docs/api/namespaces/proto/classes/SyncActionData)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-syncactionvalue"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/SyncActionValue](https://baileys.wiki/docs/api/namespaces/proto/classes/SyncActionValue)

Defined in: [WAProto/index.d.ts:11499](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11499)

## Implements[​](#implements "Direct link to Implements")

*   [`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue)

## Constructors[​](#constructors "Direct link to Constructors")

### new SyncActionValue()[​](#new-syncactionvalue "Direct link to new SyncActionValue()")

> **new SyncActionValue**(`p`?): [`SyncActionValue`](/docs/api/namespaces/proto/classes/SyncActionValue)

Defined in: [WAProto/index.d.ts:11500](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11500)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue)

#### Returns[​](#returns "Direct link to Returns")

[`SyncActionValue`](/docs/api/namespaces/proto/classes/SyncActionValue)

## Properties[​](#properties "Direct link to Properties")

### agentAction?[​](#agentaction "Direct link to agentAction?")

> `optional` **agentAction**: `null` | [`IAgentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAgentAction)

Defined in: [WAProto/index.d.ts:11521](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11521)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`agentAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#agentaction)

* * *

### aiThreadRenameAction?[​](#aithreadrenameaction "Direct link to aiThreadRenameAction?")

> `optional` **aiThreadRenameAction**: `null` | [`IAiThreadRenameAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAiThreadRenameAction)

Defined in: [WAProto/index.d.ts:11568](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11568)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`aiThreadRenameAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#aithreadrenameaction)

* * *

### androidUnsupportedActions?[​](#androidunsupportedactions "Direct link to androidUnsupportedActions?")

> `optional` **androidUnsupportedActions**: `null` | [`IAndroidUnsupportedActions`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAndroidUnsupportedActions)

Defined in: [WAProto/index.d.ts:11520](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11520)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`androidUnsupportedActions`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#androidunsupportedactions)

* * *

### archiveChatAction?[​](#archivechataction "Direct link to archiveChatAction?")

> `optional` **archiveChatAction**: `null` | [`IArchiveChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IArchiveChatAction)

Defined in: [WAProto/index.d.ts:11512](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11512)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`archiveChatAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#archivechataction)

* * *

### avatarUpdatedAction?[​](#avatarupdatedaction "Direct link to avatarUpdatedAction?")

> `optional` **avatarUpdatedAction**: `null` | [`IAvatarUpdatedAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAvatarUpdatedAction)

Defined in: [WAProto/index.d.ts:11565](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11565)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`avatarUpdatedAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#avatarupdatedaction)

* * *

### botWelcomeRequestAction?[​](#botwelcomerequestaction "Direct link to botWelcomeRequestAction?")

> `optional` **botWelcomeRequestAction**: `null` | [`IBotWelcomeRequestAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBotWelcomeRequestAction)

Defined in: [WAProto/index.d.ts:11539](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11539)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`botWelcomeRequestAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#botwelcomerequestaction)

* * *

### businessBroadcastAssociationAction?[​](#businessbroadcastassociationaction "Direct link to businessBroadcastAssociationAction?")

> `optional` **businessBroadcastAssociationAction**: `null` | [`IBusinessBroadcastAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastAssociationAction)

Defined in: [WAProto/index.d.ts:11559](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11559)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`businessBroadcastAssociationAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#businessbroadcastassociationaction)

* * *

### businessBroadcastListAction?[​](#businessbroadcastlistaction "Direct link to businessBroadcastListAction?")

> `optional` **businessBroadcastListAction**: `null` | [`IBusinessBroadcastListAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastListAction)

Defined in: [WAProto/index.d.ts:11562](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11562)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`businessBroadcastListAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#businessbroadcastlistaction)

* * *

### callLogAction?[​](#calllogaction "Direct link to callLogAction?")

> `optional` **callLogAction**: `null` | [`ICallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICallLogAction)

Defined in: [WAProto/index.d.ts:11536](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11536)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`callLogAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#calllogaction)

* * *

### chatAssignment?[​](#chatassignment "Direct link to chatAssignment?")

> `optional` **chatAssignment**: `null` | [`IChatAssignmentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentAction)

Defined in: [WAProto/index.d.ts:11529](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11529)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`chatAssignment`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#chatassignment)

* * *

### chatAssignmentOpenedStatus?[​](#chatassignmentopenedstatus "Direct link to chatAssignmentOpenedStatus?")

> `optional` **chatAssignmentOpenedStatus**: `null` | [`IChatAssignmentOpenedStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentOpenedStatusAction)

Defined in: [WAProto/index.d.ts:11530](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11530)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`chatAssignmentOpenedStatus`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#chatassignmentopenedstatus)

* * *

### chatLockSettings?[​](#chatlocksettings "Direct link to chatLockSettings?")

> `optional` **chatLockSettings**: `null` | [`IChatLockSettings`](/docs/api/namespaces/proto/interfaces/IChatLockSettings)

Defined in: [WAProto/index.d.ts:11545](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11545)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`chatLockSettings`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#chatlocksettings)

* * *

### clearChatAction?[​](#clearchataction "Direct link to clearChatAction?")

> `optional` **clearChatAction**: `null` | [`IClearChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IClearChatAction)

Defined in: [WAProto/index.d.ts:11516](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11516)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`clearChatAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#clearchataction)

* * *

### contactAction?[​](#contactaction "Direct link to contactAction?")

> `optional` **contactAction**: `null` | [`IContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction)

Defined in: [WAProto/index.d.ts:11503](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11503)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`contactAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#contactaction)

* * *

### ctwaPerCustomerDataSharingAction?[​](#ctwapercustomerdatasharingaction "Direct link to ctwaPerCustomerDataSharingAction?")

> `optional` **ctwaPerCustomerDataSharingAction**: `null` | [`ICtwaPerCustomerDataSharingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICtwaPerCustomerDataSharingAction)

Defined in: [WAProto/index.d.ts:11556](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11556)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`ctwaPerCustomerDataSharingAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#ctwapercustomerdatasharingaction)

* * *

### customPaymentMethodsAction?[​](#custompaymentmethodsaction "Direct link to customPaymentMethodsAction?")

> `optional` **customPaymentMethodsAction**: `null` | [`ICustomPaymentMethodsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodsAction)

Defined in: [WAProto/index.d.ts:11543](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11543)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`customPaymentMethodsAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#custompaymentmethodsaction)

* * *

### deleteChatAction?[​](#deletechataction "Direct link to deleteChatAction?")

> `optional` **deleteChatAction**: `null` | [`IDeleteChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteChatAction)

Defined in: [WAProto/index.d.ts:11517](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11517)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`deleteChatAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#deletechataction)

* * *

### deleteIndividualCallLog?[​](#deleteindividualcalllog "Direct link to deleteIndividualCallLog?")

> `optional` **deleteIndividualCallLog**: `null` | [`IDeleteIndividualCallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteIndividualCallLogAction)

Defined in: [WAProto/index.d.ts:11540](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11540)

#### Implementation of[​](#implementation-of-17 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`deleteIndividualCallLog`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#deleteindividualcalllog)

* * *

### deleteMessageForMeAction?[​](#deletemessageformeaction "Direct link to deleteMessageForMeAction?")

> `optional` **deleteMessageForMeAction**: `null` | [`IDeleteMessageForMeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteMessageForMeAction)

Defined in: [WAProto/index.d.ts:11513](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11513)

#### Implementation of[​](#implementation-of-18 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`deleteMessageForMeAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#deletemessageformeaction)

* * *

### detectedOutcomesStatusAction?[​](#detectedoutcomesstatusaction "Direct link to detectedOutcomesStatusAction?")

> `optional` **detectedOutcomesStatusAction**: `null` | [`IDetectedOutcomesStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDetectedOutcomesStatusAction)

Defined in: [WAProto/index.d.ts:11560](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11560)

#### Implementation of[​](#implementation-of-19 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`detectedOutcomesStatusAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#detectedoutcomesstatusaction)

* * *

### deviceCapabilities?[​](#devicecapabilities "Direct link to deviceCapabilities?")

> `optional` **deviceCapabilities**: `null` | [`IDeviceCapabilities`](/docs/api/namespaces/proto/interfaces/IDeviceCapabilities)

Defined in: [WAProto/index.d.ts:11548](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11548)

#### Implementation of[​](#implementation-of-20 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`deviceCapabilities`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#devicecapabilities)

* * *

### externalWebBetaAction?[​](#externalwebbetaaction "Direct link to externalWebBetaAction?")

> `optional` **externalWebBetaAction**: `null` | [`IExternalWebBetaAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IExternalWebBetaAction)

Defined in: [WAProto/index.d.ts:11534](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11534)

#### Implementation of[​](#implementation-of-21 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`externalWebBetaAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#externalwebbetaaction)

* * *

### favoritesAction?[​](#favoritesaction "Direct link to favoritesAction?")

> `optional` **favoritesAction**: `null` | [`IFavoritesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IFavoritesAction)

Defined in: [WAProto/index.d.ts:11550](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11550)

#### Implementation of[​](#implementation-of-22 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`favoritesAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#favoritesaction)

* * *

### interactiveMessageAction?[​](#interactivemessageaction "Direct link to interactiveMessageAction?")

> `optional` **interactiveMessageAction**: `null` | [`IInteractiveMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IInteractiveMessageAction)

Defined in: [WAProto/index.d.ts:11569](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11569)

#### Implementation of[​](#implementation-of-23 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`interactiveMessageAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#interactivemessageaction)

* * *

### keyExpiration?[​](#keyexpiration "Direct link to keyExpiration?")

> `optional` **keyExpiration**: `null` | [`IKeyExpiration`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IKeyExpiration)

Defined in: [WAProto/index.d.ts:11514](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11514)

#### Implementation of[​](#implementation-of-24 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`keyExpiration`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#keyexpiration)

* * *

### labelAssociationAction?[​](#labelassociationaction "Direct link to labelAssociationAction?")

> `optional` **labelAssociationAction**: `null` | [`ILabelAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelAssociationAction)

Defined in: [WAProto/index.d.ts:11510](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11510)

#### Implementation of[​](#implementation-of-25 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`labelAssociationAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#labelassociationaction)

* * *

### labelEditAction?[​](#labeleditaction "Direct link to labelEditAction?")

> `optional` **labelEditAction**: `null` | [`ILabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction)

Defined in: [WAProto/index.d.ts:11509](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11509)

#### Implementation of[​](#implementation-of-26 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`labelEditAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#labeleditaction)

* * *

### labelReorderingAction?[​](#labelreorderingaction "Direct link to labelReorderingAction?")

> `optional` **labelReorderingAction**: `null` | [`ILabelReorderingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelReorderingAction)

Defined in: [WAProto/index.d.ts:11541](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11541)

#### Implementation of[​](#implementation-of-27 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`labelReorderingAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#labelreorderingaction)

* * *

### lidContactAction?[​](#lidcontactaction "Direct link to lidContactAction?")

> `optional` **lidContactAction**: `null` | [`ILidContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILidContactAction)

Defined in: [WAProto/index.d.ts:11555](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11555)

#### Implementation of[​](#implementation-of-28 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`lidContactAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#lidcontactaction)

* * *

### localeSetting?[​](#localesetting "Direct link to localeSetting?")

> `optional` **localeSetting**: `null` | [`ILocaleSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILocaleSetting)

Defined in: [WAProto/index.d.ts:11511](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11511)

#### Implementation of[​](#implementation-of-29 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`localeSetting`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#localesetting)

* * *

### lockChatAction?[​](#lockchataction "Direct link to lockChatAction?")

> `optional` **lockChatAction**: `null` | [`ILockChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILockChatAction)

Defined in: [WAProto/index.d.ts:11544](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11544)

#### Implementation of[​](#implementation-of-30 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`lockChatAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#lockchataction)

* * *

### maibaAiFeaturesControlAction?[​](#maibaaifeaturescontrolaction "Direct link to maibaAiFeaturesControlAction?")

> `optional` **maibaAiFeaturesControlAction**: `null` | [`IMaibaAIFeaturesControlAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMaibaAIFeaturesControlAction)

Defined in: [WAProto/index.d.ts:11561](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11561)

#### Implementation of[​](#implementation-of-31 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`maibaAiFeaturesControlAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#maibaaifeaturescontrolaction)

* * *

### markChatAsReadAction?[​](#markchatasreadaction "Direct link to markChatAsReadAction?")

> `optional` **markChatAsReadAction**: `null` | [`IMarkChatAsReadAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarkChatAsReadAction)

Defined in: [WAProto/index.d.ts:11515](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11515)

#### Implementation of[​](#implementation-of-32 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`markChatAsReadAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#markchatasreadaction)

* * *

### marketingMessageAction?[​](#marketingmessageaction "Direct link to marketingMessageAction?")

> `optional` **marketingMessageAction**: `null` | [`IMarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction)

Defined in: [WAProto/index.d.ts:11532](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11532)

#### Implementation of[​](#implementation-of-33 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`marketingMessageAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#marketingmessageaction)

* * *

### marketingMessageBroadcastAction?[​](#marketingmessagebroadcastaction "Direct link to marketingMessageBroadcastAction?")

> `optional` **marketingMessageBroadcastAction**: `null` | [`IMarketingMessageBroadcastAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageBroadcastAction)

Defined in: [WAProto/index.d.ts:11533](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11533)

#### Implementation of[​](#implementation-of-34 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`marketingMessageBroadcastAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#marketingmessagebroadcastaction)

* * *

### merchantPaymentPartnerAction?[​](#merchantpaymentpartneraction "Direct link to merchantPaymentPartnerAction?")

> `optional` **merchantPaymentPartnerAction**: `null` | [`IMerchantPaymentPartnerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMerchantPaymentPartnerAction)

Defined in: [WAProto/index.d.ts:11551](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11551)

#### Implementation of[​](#implementation-of-35 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`merchantPaymentPartnerAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#merchantpaymentpartneraction)

* * *

### musicUserIdAction?[​](#musicuseridaction "Direct link to musicUserIdAction?")

> `optional` **musicUserIdAction**: `null` | [`IMusicUserIdAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMusicUserIdAction)

Defined in: [WAProto/index.d.ts:11563](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11563)

#### Implementation of[​](#implementation-of-36 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`musicUserIdAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#musicuseridaction)

* * *

### muteAction?[​](#muteaction "Direct link to muteAction?")

> `optional` **muteAction**: `null` | [`IMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMuteAction)

Defined in: [WAProto/index.d.ts:11504](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11504)

#### Implementation of[​](#implementation-of-37 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`muteAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#muteaction)

* * *

### newsletterSavedInterestsAction?[​](#newslettersavedinterestsaction "Direct link to newsletterSavedInterestsAction?")

> `optional` **newsletterSavedInterestsAction**: `null` | [`INewsletterSavedInterestsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INewsletterSavedInterestsAction)

Defined in: [WAProto/index.d.ts:11567](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11567)

#### Implementation of[​](#implementation-of-38 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`newsletterSavedInterestsAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#newslettersavedinterestsaction)

* * *

### noteEditAction?[​](#noteeditaction "Direct link to noteEditAction?")

> `optional` **noteEditAction**: `null` | [`INoteEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INoteEditAction)

Defined in: [WAProto/index.d.ts:11549](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11549)

#### Implementation of[​](#implementation-of-39 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`noteEditAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#noteeditaction)

* * *

### notificationActivitySettingAction?[​](#notificationactivitysettingaction "Direct link to notificationActivitySettingAction?")

> `optional` **notificationActivitySettingAction**: `null` | [`INotificationActivitySettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INotificationActivitySettingAction)

Defined in: [WAProto/index.d.ts:11554](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11554)

#### Implementation of[​](#implementation-of-40 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`notificationActivitySettingAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#notificationactivitysettingaction)

* * *

### nuxAction?[​](#nuxaction "Direct link to nuxAction?")

> `optional` **nuxAction**: `null` | [`INuxAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INuxAction)

Defined in: [WAProto/index.d.ts:11525](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11525)

#### Implementation of[​](#implementation-of-41 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`nuxAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#nuxaction)

* * *

### paymentInfoAction?[​](#paymentinfoaction "Direct link to paymentInfoAction?")

> `optional` **paymentInfoAction**: `null` | [`IPaymentInfoAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentInfoAction)

Defined in: [WAProto/index.d.ts:11542](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11542)

#### Implementation of[​](#implementation-of-42 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`paymentInfoAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#paymentinfoaction)

* * *

### paymentTosAction?[​](#paymenttosaction "Direct link to paymentTosAction?")

> `optional` **paymentTosAction**: `null` | [`IPaymentTosAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentTosAction)

Defined in: [WAProto/index.d.ts:11557](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11557)

#### Implementation of[​](#implementation-of-43 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`paymentTosAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#paymenttosaction)

* * *

### pinAction?[​](#pinaction "Direct link to pinAction?")

> `optional` **pinAction**: `null` | [`IPinAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPinAction)

Defined in: [WAProto/index.d.ts:11505](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11505)

#### Implementation of[​](#implementation-of-44 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`pinAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#pinaction)

* * *

### pnForLidChatAction?[​](#pnforlidchataction "Direct link to pnForLidChatAction?")

> `optional` **pnForLidChatAction**: `null` | [`IPnForLidChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPnForLidChatAction)

Defined in: [WAProto/index.d.ts:11531](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11531)

#### Implementation of[​](#implementation-of-45 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`pnForLidChatAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#pnforlidchataction)

* * *

### primaryFeature?[​](#primaryfeature "Direct link to primaryFeature?")

> `optional` **primaryFeature**: `null` | [`IPrimaryFeature`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryFeature)

Defined in: [WAProto/index.d.ts:11519](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11519)

#### Implementation of[​](#implementation-of-46 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`primaryFeature`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#primaryfeature)

* * *

### primaryVersionAction?[​](#primaryversionaction "Direct link to primaryVersionAction?")

> `optional` **primaryVersionAction**: `null` | [`IPrimaryVersionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryVersionAction)

Defined in: [WAProto/index.d.ts:11526](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11526)

#### Implementation of[​](#implementation-of-47 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`primaryVersionAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#primaryversionaction)

* * *

### privacySettingChannelsPersonalisedRecommendationAction?[​](#privacysettingchannelspersonalisedrecommendationaction "Direct link to privacySettingChannelsPersonalisedRecommendationAction?")

> `optional` **privacySettingChannelsPersonalisedRecommendationAction**: `null` | [`IPrivacySettingChannelsPersonalisedRecommendationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingChannelsPersonalisedRecommendationAction)

Defined in: [WAProto/index.d.ts:11558](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11558)

#### Implementation of[​](#implementation-of-48 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`privacySettingChannelsPersonalisedRecommendationAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#privacysettingchannelspersonalisedrecommendationaction)

* * *

### privacySettingDisableLinkPreviewsAction?[​](#privacysettingdisablelinkpreviewsaction "Direct link to privacySettingDisableLinkPreviewsAction?")

> `optional` **privacySettingDisableLinkPreviewsAction**: `null` | [`IPrivacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingDisableLinkPreviewsAction)

Defined in: [WAProto/index.d.ts:11547](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11547)

#### Implementation of[​](#implementation-of-49 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`privacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#privacysettingdisablelinkpreviewsaction)

* * *

### privacySettingRelayAllCalls?[​](#privacysettingrelayallcalls "Direct link to privacySettingRelayAllCalls?")

> `optional` **privacySettingRelayAllCalls**: `null` | [`IPrivacySettingRelayAllCalls`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingRelayAllCalls)

Defined in: [WAProto/index.d.ts:11535](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11535)

#### Implementation of[​](#implementation-of-50 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`privacySettingRelayAllCalls`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#privacysettingrelayallcalls)

* * *

### privateProcessingSettingAction?[​](#privateprocessingsettingaction "Direct link to privateProcessingSettingAction?")

> `optional` **privateProcessingSettingAction**: `null` | [`IPrivateProcessingSettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivateProcessingSettingAction)

Defined in: [WAProto/index.d.ts:11566](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11566)

#### Implementation of[​](#implementation-of-51 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`privateProcessingSettingAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#privateprocessingsettingaction)

* * *

### pushNameSetting?[​](#pushnamesetting "Direct link to pushNameSetting?")

> `optional` **pushNameSetting**: `null` | [`IPushNameSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPushNameSetting)

Defined in: [WAProto/index.d.ts:11506](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11506)

#### Implementation of[​](#implementation-of-52 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`pushNameSetting`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#pushnamesetting)

* * *

### quickReplyAction?[​](#quickreplyaction "Direct link to quickReplyAction?")

> `optional` **quickReplyAction**: `null` | [`IQuickReplyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IQuickReplyAction)

Defined in: [WAProto/index.d.ts:11507](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11507)

#### Implementation of[​](#implementation-of-53 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`quickReplyAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#quickreplyaction)

* * *

### recentEmojiWeightsAction?[​](#recentemojiweightsaction "Direct link to recentEmojiWeightsAction?")

> `optional` **recentEmojiWeightsAction**: `null` | [`IRecentEmojiWeightsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRecentEmojiWeightsAction)

Defined in: [WAProto/index.d.ts:11508](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11508)

#### Implementation of[​](#implementation-of-54 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`recentEmojiWeightsAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#recentemojiweightsaction)

* * *

### removeRecentStickerAction?[​](#removerecentstickeraction "Direct link to removeRecentStickerAction?")

> `optional` **removeRecentStickerAction**: `null` | [`IRemoveRecentStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRemoveRecentStickerAction)

Defined in: [WAProto/index.d.ts:11528](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11528)

#### Implementation of[​](#implementation-of-55 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`removeRecentStickerAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#removerecentstickeraction)

* * *

### starAction?[​](#staraction "Direct link to starAction?")

> `optional` **starAction**: `null` | [`IStarAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStarAction)

Defined in: [WAProto/index.d.ts:11502](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11502)

#### Implementation of[​](#implementation-of-56 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`starAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#staraction)

* * *

### statusPostOptInNotificationPreferencesAction?[​](#statuspostoptinnotificationpreferencesaction "Direct link to statusPostOptInNotificationPreferencesAction?")

> `optional` **statusPostOptInNotificationPreferencesAction**: `null` | [`IStatusPostOptInNotificationPreferencesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPostOptInNotificationPreferencesAction)

Defined in: [WAProto/index.d.ts:11564](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11564)

#### Implementation of[​](#implementation-of-57 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`statusPostOptInNotificationPreferencesAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#statuspostoptinnotificationpreferencesaction)

* * *

### statusPrivacy?[​](#statusprivacy "Direct link to statusPrivacy?")

> `optional` **statusPrivacy**: `null` | [`IStatusPrivacyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPrivacyAction)

Defined in: [WAProto/index.d.ts:11538](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11538)

#### Implementation of[​](#implementation-of-58 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`statusPrivacy`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#statusprivacy)

* * *

### stickerAction?[​](#stickeraction "Direct link to stickerAction?")

> `optional` **stickerAction**: `null` | [`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction)

Defined in: [WAProto/index.d.ts:11527](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11527)

#### Implementation of[​](#implementation-of-59 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`stickerAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#stickeraction)

* * *

### subscriptionAction?[​](#subscriptionaction "Direct link to subscriptionAction?")

> `optional` **subscriptionAction**: `null` | [`ISubscriptionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISubscriptionAction)

Defined in: [WAProto/index.d.ts:11522](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11522)

#### Implementation of[​](#implementation-of-60 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`subscriptionAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#subscriptionaction)

* * *

### timeFormatAction?[​](#timeformataction "Direct link to timeFormatAction?")

> `optional` **timeFormatAction**: `null` | [`ITimeFormatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ITimeFormatAction)

Defined in: [WAProto/index.d.ts:11524](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11524)

#### Implementation of[​](#implementation-of-61 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`timeFormatAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#timeformataction)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:11501](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11501)

#### Implementation of[​](#implementation-of-62 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`timestamp`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#timestamp)

* * *

### ugcBot?[​](#ugcbot "Direct link to ugcBot?")

> `optional` **ugcBot**: `null` | [`IUGCBot`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUGCBot)

Defined in: [WAProto/index.d.ts:11537](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11537)

#### Implementation of[​](#implementation-of-63 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`ugcBot`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#ugcbot)

* * *

### unarchiveChatsSetting?[​](#unarchivechatssetting "Direct link to unarchiveChatsSetting?")

> `optional` **unarchiveChatsSetting**: `null` | [`IUnarchiveChatsSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUnarchiveChatsSetting)

Defined in: [WAProto/index.d.ts:11518](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11518)

#### Implementation of[​](#implementation-of-64 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`unarchiveChatsSetting`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#unarchivechatssetting)

* * *

### usernameChatStartMode?[​](#usernamechatstartmode "Direct link to usernameChatStartMode?")

> `optional` **usernameChatStartMode**: `null` | [`IUsernameChatStartModeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUsernameChatStartModeAction)

Defined in: [WAProto/index.d.ts:11553](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11553)

#### Implementation of[​](#implementation-of-65 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`usernameChatStartMode`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#usernamechatstartmode)

* * *

### userStatusMuteAction?[​](#userstatusmuteaction "Direct link to userStatusMuteAction?")

> `optional` **userStatusMuteAction**: `null` | [`IUserStatusMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUserStatusMuteAction)

Defined in: [WAProto/index.d.ts:11523](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11523)

#### Implementation of[​](#implementation-of-66 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`userStatusMuteAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#userstatusmuteaction)

* * *

### waffleAccountLinkStateAction?[​](#waffleaccountlinkstateaction "Direct link to waffleAccountLinkStateAction?")

> `optional` **waffleAccountLinkStateAction**: `null` | [`IWaffleAccountLinkStateAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWaffleAccountLinkStateAction)

Defined in: [WAProto/index.d.ts:11552](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11552)

#### Implementation of[​](#implementation-of-67 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`waffleAccountLinkStateAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#waffleaccountlinkstateaction)

* * *

### wamoUserIdentifierAction?[​](#wamouseridentifieraction "Direct link to wamoUserIdentifierAction?")

> `optional` **wamoUserIdentifierAction**: `null` | [`IWamoUserIdentifierAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWamoUserIdentifierAction)

Defined in: [WAProto/index.d.ts:11546](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11546)

#### Implementation of[​](#implementation-of-68 "Direct link to Implementation of")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue).[`wamoUserIdentifierAction`](/docs/api/namespaces/proto/interfaces/ISyncActionValue#wamouseridentifieraction)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11575](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11575)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SyncActionValue`](/docs/api/namespaces/proto/classes/SyncActionValue)

Defined in: [WAProto/index.d.ts:11570](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11570)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SyncActionValue`](/docs/api/namespaces/proto/classes/SyncActionValue)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SyncActionValue`](/docs/api/namespaces/proto/classes/SyncActionValue)

Defined in: [WAProto/index.d.ts:11572](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11572)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SyncActionValue`](/docs/api/namespaces/proto/classes/SyncActionValue)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11571](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11571)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SyncActionValue`](/docs/api/namespaces/proto/classes/SyncActionValue)

Defined in: [WAProto/index.d.ts:11573](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11573)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SyncActionValue`](/docs/api/namespaces/proto/classes/SyncActionValue)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11576](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11576)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11574](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11574)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SyncActionValue`](/docs/api/namespaces/proto/classes/SyncActionValue)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-syncdindex"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/SyncdIndex](https://baileys.wiki/docs/api/namespaces/proto/classes/SyncdIndex)

Defined in: [WAProto/index.d.ts:12994](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12994)

## Implements[​](#implements "Direct link to Implements")

*   [`ISyncdIndex`](/docs/api/namespaces/proto/interfaces/ISyncdIndex)

## Constructors[​](#constructors "Direct link to Constructors")

### new SyncdIndex()[​](#new-syncdindex "Direct link to new SyncdIndex()")

> **new SyncdIndex**(`p`?): [`SyncdIndex`](/docs/api/namespaces/proto/classes/SyncdIndex)

Defined in: [WAProto/index.d.ts:12995](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12995)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISyncdIndex`](/docs/api/namespaces/proto/interfaces/ISyncdIndex)

#### Returns[​](#returns "Direct link to Returns")

[`SyncdIndex`](/docs/api/namespaces/proto/classes/SyncdIndex)

## Properties[​](#properties "Direct link to Properties")

### blob?[​](#blob "Direct link to blob?")

> `optional` **blob**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:12996](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12996)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISyncdIndex`](/docs/api/namespaces/proto/interfaces/ISyncdIndex).[`blob`](/docs/api/namespaces/proto/interfaces/ISyncdIndex#blob)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13002](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13002)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SyncdIndex`](/docs/api/namespaces/proto/classes/SyncdIndex)

Defined in: [WAProto/index.d.ts:12997](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12997)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISyncdIndex`](/docs/api/namespaces/proto/interfaces/ISyncdIndex)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SyncdIndex`](/docs/api/namespaces/proto/classes/SyncdIndex)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SyncdIndex`](/docs/api/namespaces/proto/classes/SyncdIndex)

Defined in: [WAProto/index.d.ts:12999](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12999)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SyncdIndex`](/docs/api/namespaces/proto/classes/SyncdIndex)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12998](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12998)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISyncdIndex`](/docs/api/namespaces/proto/interfaces/ISyncdIndex)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SyncdIndex`](/docs/api/namespaces/proto/classes/SyncdIndex)

Defined in: [WAProto/index.d.ts:13000](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13000)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SyncdIndex`](/docs/api/namespaces/proto/classes/SyncdIndex)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13003](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13003)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13001](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13001)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SyncdIndex`](/docs/api/namespaces/proto/classes/SyncdIndex)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-syncdmutation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/SyncdMutation](https://baileys.wiki/docs/api/namespaces/proto/classes/SyncdMutation)

Defined in: [WAProto/index.d.ts:13011](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13011)

## Implements[​](#implements "Direct link to Implements")

*   [`ISyncdMutation`](/docs/api/namespaces/proto/interfaces/ISyncdMutation)

## Constructors[​](#constructors "Direct link to Constructors")

### new SyncdMutation()[​](#new-syncdmutation "Direct link to new SyncdMutation()")

> **new SyncdMutation**(`p`?): [`SyncdMutation`](/docs/api/namespaces/proto/classes/SyncdMutation)

Defined in: [WAProto/index.d.ts:13012](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13012)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISyncdMutation`](/docs/api/namespaces/proto/interfaces/ISyncdMutation)

#### Returns[​](#returns "Direct link to Returns")

[`SyncdMutation`](/docs/api/namespaces/proto/classes/SyncdMutation)

## Properties[​](#properties "Direct link to Properties")

### operation?[​](#operation "Direct link to operation?")

> `optional` **operation**: `null` | [`SyncdOperation`](/docs/api/namespaces/proto/namespaces/SyncdMutation/enumerations/SyncdOperation)

Defined in: [WAProto/index.d.ts:13013](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13013)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISyncdMutation`](/docs/api/namespaces/proto/interfaces/ISyncdMutation).[`operation`](/docs/api/namespaces/proto/interfaces/ISyncdMutation#operation)

* * *

### record?[​](#record "Direct link to record?")

> `optional` **record**: `null` | [`ISyncdRecord`](/docs/api/namespaces/proto/interfaces/ISyncdRecord)

Defined in: [WAProto/index.d.ts:13014](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13014)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISyncdMutation`](/docs/api/namespaces/proto/interfaces/ISyncdMutation).[`record`](/docs/api/namespaces/proto/interfaces/ISyncdMutation#record)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13020](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13020)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SyncdMutation`](/docs/api/namespaces/proto/classes/SyncdMutation)

Defined in: [WAProto/index.d.ts:13015](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13015)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISyncdMutation`](/docs/api/namespaces/proto/interfaces/ISyncdMutation)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SyncdMutation`](/docs/api/namespaces/proto/classes/SyncdMutation)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SyncdMutation`](/docs/api/namespaces/proto/classes/SyncdMutation)

Defined in: [WAProto/index.d.ts:13017](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13017)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SyncdMutation`](/docs/api/namespaces/proto/classes/SyncdMutation)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13016](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13016)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISyncdMutation`](/docs/api/namespaces/proto/interfaces/ISyncdMutation)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SyncdMutation`](/docs/api/namespaces/proto/classes/SyncdMutation)

Defined in: [WAProto/index.d.ts:13018](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13018)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SyncdMutation`](/docs/api/namespaces/proto/classes/SyncdMutation)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13021](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13021)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13019](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13019)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SyncdMutation`](/docs/api/namespaces/proto/classes/SyncdMutation)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-syncdmutations"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/SyncdMutations](https://baileys.wiki/docs/api/namespaces/proto/classes/SyncdMutations)

Defined in: [WAProto/index.d.ts:13036](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13036)

## Implements[​](#implements "Direct link to Implements")

*   [`ISyncdMutations`](/docs/api/namespaces/proto/interfaces/ISyncdMutations)

## Constructors[​](#constructors "Direct link to Constructors")

### new SyncdMutations()[​](#new-syncdmutations "Direct link to new SyncdMutations()")

> **new SyncdMutations**(`p`?): [`SyncdMutations`](/docs/api/namespaces/proto/classes/SyncdMutations)

Defined in: [WAProto/index.d.ts:13037](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13037)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISyncdMutations`](/docs/api/namespaces/proto/interfaces/ISyncdMutations)

#### Returns[​](#returns "Direct link to Returns")

[`SyncdMutations`](/docs/api/namespaces/proto/classes/SyncdMutations)

## Properties[​](#properties "Direct link to Properties")

### mutations[​](#mutations "Direct link to mutations")

> **mutations**: [`ISyncdMutation`](/docs/api/namespaces/proto/interfaces/ISyncdMutation)\[\]

Defined in: [WAProto/index.d.ts:13038](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13038)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISyncdMutations`](/docs/api/namespaces/proto/interfaces/ISyncdMutations).[`mutations`](/docs/api/namespaces/proto/interfaces/ISyncdMutations#mutations)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13044](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13044)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SyncdMutations`](/docs/api/namespaces/proto/classes/SyncdMutations)

Defined in: [WAProto/index.d.ts:13039](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13039)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISyncdMutations`](/docs/api/namespaces/proto/interfaces/ISyncdMutations)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SyncdMutations`](/docs/api/namespaces/proto/classes/SyncdMutations)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SyncdMutations`](/docs/api/namespaces/proto/classes/SyncdMutations)

Defined in: [WAProto/index.d.ts:13041](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13041)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SyncdMutations`](/docs/api/namespaces/proto/classes/SyncdMutations)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13040](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13040)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISyncdMutations`](/docs/api/namespaces/proto/interfaces/ISyncdMutations)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SyncdMutations`](/docs/api/namespaces/proto/classes/SyncdMutations)

Defined in: [WAProto/index.d.ts:13042](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13042)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SyncdMutations`](/docs/api/namespaces/proto/classes/SyncdMutations)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13045](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13045)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13043](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13043)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SyncdMutations`](/docs/api/namespaces/proto/classes/SyncdMutations)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-syncdpatch"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/SyncdPatch](https://baileys.wiki/docs/api/namespaces/proto/classes/SyncdPatch)

Defined in: [WAProto/index.d.ts:13060](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13060)

## Implements[​](#implements "Direct link to Implements")

*   [`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch)

## Constructors[​](#constructors "Direct link to Constructors")

### new SyncdPatch()[​](#new-syncdpatch "Direct link to new SyncdPatch()")

> **new SyncdPatch**(`p`?): [`SyncdPatch`](/docs/api/namespaces/proto/classes/SyncdPatch)

Defined in: [WAProto/index.d.ts:13061](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13061)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch)

#### Returns[​](#returns "Direct link to Returns")

[`SyncdPatch`](/docs/api/namespaces/proto/classes/SyncdPatch)

## Properties[​](#properties "Direct link to Properties")

### clientDebugData?[​](#clientdebugdata "Direct link to clientDebugData?")

> `optional` **clientDebugData**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13070](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13070)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch).[`clientDebugData`](/docs/api/namespaces/proto/interfaces/ISyncdPatch#clientdebugdata)

* * *

### deviceIndex?[​](#deviceindex "Direct link to deviceIndex?")

> `optional` **deviceIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:13069](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13069)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch).[`deviceIndex`](/docs/api/namespaces/proto/interfaces/ISyncdPatch#deviceindex)

* * *

### exitCode?[​](#exitcode "Direct link to exitCode?")

> `optional` **exitCode**: `null` | [`IExitCode`](/docs/api/namespaces/proto/interfaces/IExitCode)

Defined in: [WAProto/index.d.ts:13068](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13068)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch).[`exitCode`](/docs/api/namespaces/proto/interfaces/ISyncdPatch#exitcode)

* * *

### externalMutations?[​](#externalmutations "Direct link to externalMutations?")

> `optional` **externalMutations**: `null` | [`IExternalBlobReference`](/docs/api/namespaces/proto/interfaces/IExternalBlobReference)

Defined in: [WAProto/index.d.ts:13064](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13064)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch).[`externalMutations`](/docs/api/namespaces/proto/interfaces/ISyncdPatch#externalmutations)

* * *

### keyId?[​](#keyid "Direct link to keyId?")

> `optional` **keyId**: `null` | [`IKeyId`](/docs/api/namespaces/proto/interfaces/IKeyId)

Defined in: [WAProto/index.d.ts:13067](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13067)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch).[`keyId`](/docs/api/namespaces/proto/interfaces/ISyncdPatch#keyid)

* * *

### mutations[​](#mutations "Direct link to mutations")

> **mutations**: [`ISyncdMutation`](/docs/api/namespaces/proto/interfaces/ISyncdMutation)\[\]

Defined in: [WAProto/index.d.ts:13063](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13063)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch).[`mutations`](/docs/api/namespaces/proto/interfaces/ISyncdPatch#mutations)

* * *

### patchMac?[​](#patchmac "Direct link to patchMac?")

> `optional` **patchMac**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13066](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13066)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch).[`patchMac`](/docs/api/namespaces/proto/interfaces/ISyncdPatch#patchmac)

* * *

### snapshotMac?[​](#snapshotmac "Direct link to snapshotMac?")

> `optional` **snapshotMac**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13065](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13065)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch).[`snapshotMac`](/docs/api/namespaces/proto/interfaces/ISyncdPatch#snapshotmac)

* * *

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | [`ISyncdVersion`](/docs/api/namespaces/proto/interfaces/ISyncdVersion)

Defined in: [WAProto/index.d.ts:13062](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13062)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch).[`version`](/docs/api/namespaces/proto/interfaces/ISyncdPatch#version)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13076](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13076)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SyncdPatch`](/docs/api/namespaces/proto/classes/SyncdPatch)

Defined in: [WAProto/index.d.ts:13071](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13071)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SyncdPatch`](/docs/api/namespaces/proto/classes/SyncdPatch)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SyncdPatch`](/docs/api/namespaces/proto/classes/SyncdPatch)

Defined in: [WAProto/index.d.ts:13073](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13073)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SyncdPatch`](/docs/api/namespaces/proto/classes/SyncdPatch)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13072](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13072)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISyncdPatch`](/docs/api/namespaces/proto/interfaces/ISyncdPatch)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SyncdPatch`](/docs/api/namespaces/proto/classes/SyncdPatch)

Defined in: [WAProto/index.d.ts:13074](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13074)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SyncdPatch`](/docs/api/namespaces/proto/classes/SyncdPatch)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13077](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13077)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13075](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13075)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SyncdPatch`](/docs/api/namespaces/proto/classes/SyncdPatch)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-syncdrecord"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/SyncdRecord](https://baileys.wiki/docs/api/namespaces/proto/classes/SyncdRecord)

Defined in: [WAProto/index.d.ts:13086](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13086)

## Implements[​](#implements "Direct link to Implements")

*   [`ISyncdRecord`](/docs/api/namespaces/proto/interfaces/ISyncdRecord)

## Constructors[​](#constructors "Direct link to Constructors")

### new SyncdRecord()[​](#new-syncdrecord "Direct link to new SyncdRecord()")

> **new SyncdRecord**(`p`?): [`SyncdRecord`](/docs/api/namespaces/proto/classes/SyncdRecord)

Defined in: [WAProto/index.d.ts:13087](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13087)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISyncdRecord`](/docs/api/namespaces/proto/interfaces/ISyncdRecord)

#### Returns[​](#returns "Direct link to Returns")

[`SyncdRecord`](/docs/api/namespaces/proto/classes/SyncdRecord)

## Properties[​](#properties "Direct link to Properties")

### index?[​](#index "Direct link to index?")

> `optional` **index**: `null` | [`ISyncdIndex`](/docs/api/namespaces/proto/interfaces/ISyncdIndex)

Defined in: [WAProto/index.d.ts:13088](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13088)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISyncdRecord`](/docs/api/namespaces/proto/interfaces/ISyncdRecord).[`index`](/docs/api/namespaces/proto/interfaces/ISyncdRecord#index)

* * *

### keyId?[​](#keyid "Direct link to keyId?")

> `optional` **keyId**: `null` | [`IKeyId`](/docs/api/namespaces/proto/interfaces/IKeyId)

Defined in: [WAProto/index.d.ts:13090](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13090)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISyncdRecord`](/docs/api/namespaces/proto/interfaces/ISyncdRecord).[`keyId`](/docs/api/namespaces/proto/interfaces/ISyncdRecord#keyid)

* * *

### value?[​](#value "Direct link to value?")

> `optional` **value**: `null` | [`ISyncdValue`](/docs/api/namespaces/proto/interfaces/ISyncdValue)

Defined in: [WAProto/index.d.ts:13089](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13089)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ISyncdRecord`](/docs/api/namespaces/proto/interfaces/ISyncdRecord).[`value`](/docs/api/namespaces/proto/interfaces/ISyncdRecord#value)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13096](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13096)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SyncdRecord`](/docs/api/namespaces/proto/classes/SyncdRecord)

Defined in: [WAProto/index.d.ts:13091](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13091)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISyncdRecord`](/docs/api/namespaces/proto/interfaces/ISyncdRecord)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SyncdRecord`](/docs/api/namespaces/proto/classes/SyncdRecord)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SyncdRecord`](/docs/api/namespaces/proto/classes/SyncdRecord)

Defined in: [WAProto/index.d.ts:13093](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13093)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SyncdRecord`](/docs/api/namespaces/proto/classes/SyncdRecord)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13092](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13092)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISyncdRecord`](/docs/api/namespaces/proto/interfaces/ISyncdRecord)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SyncdRecord`](/docs/api/namespaces/proto/classes/SyncdRecord)

Defined in: [WAProto/index.d.ts:13094](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13094)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SyncdRecord`](/docs/api/namespaces/proto/classes/SyncdRecord)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13097](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13097)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13095](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13095)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SyncdRecord`](/docs/api/namespaces/proto/classes/SyncdRecord)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-syncdsnapshot"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/SyncdSnapshot](https://baileys.wiki/docs/api/namespaces/proto/classes/SyncdSnapshot)

Defined in: [WAProto/index.d.ts:13107](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13107)

## Implements[​](#implements "Direct link to Implements")

*   [`ISyncdSnapshot`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot)

## Constructors[​](#constructors "Direct link to Constructors")

### new SyncdSnapshot()[​](#new-syncdsnapshot "Direct link to new SyncdSnapshot()")

> **new SyncdSnapshot**(`p`?): [`SyncdSnapshot`](/docs/api/namespaces/proto/classes/SyncdSnapshot)

Defined in: [WAProto/index.d.ts:13108](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13108)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISyncdSnapshot`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot)

#### Returns[​](#returns "Direct link to Returns")

[`SyncdSnapshot`](/docs/api/namespaces/proto/classes/SyncdSnapshot)

## Properties[​](#properties "Direct link to Properties")

### keyId?[​](#keyid "Direct link to keyId?")

> `optional` **keyId**: `null` | [`IKeyId`](/docs/api/namespaces/proto/interfaces/IKeyId)

Defined in: [WAProto/index.d.ts:13112](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13112)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISyncdSnapshot`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot).[`keyId`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot#keyid)

* * *

### mac?[​](#mac "Direct link to mac?")

> `optional` **mac**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13111](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13111)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISyncdSnapshot`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot).[`mac`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot#mac)

* * *

### records[​](#records "Direct link to records")

> **records**: [`ISyncdRecord`](/docs/api/namespaces/proto/interfaces/ISyncdRecord)\[\]

Defined in: [WAProto/index.d.ts:13110](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13110)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ISyncdSnapshot`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot).[`records`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot#records)

* * *

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | [`ISyncdVersion`](/docs/api/namespaces/proto/interfaces/ISyncdVersion)

Defined in: [WAProto/index.d.ts:13109](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13109)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ISyncdSnapshot`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot).[`version`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot#version)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13118](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13118)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SyncdSnapshot`](/docs/api/namespaces/proto/classes/SyncdSnapshot)

Defined in: [WAProto/index.d.ts:13113](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13113)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISyncdSnapshot`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SyncdSnapshot`](/docs/api/namespaces/proto/classes/SyncdSnapshot)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SyncdSnapshot`](/docs/api/namespaces/proto/classes/SyncdSnapshot)

Defined in: [WAProto/index.d.ts:13115](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13115)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SyncdSnapshot`](/docs/api/namespaces/proto/classes/SyncdSnapshot)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13114](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13114)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISyncdSnapshot`](/docs/api/namespaces/proto/interfaces/ISyncdSnapshot)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SyncdSnapshot`](/docs/api/namespaces/proto/classes/SyncdSnapshot)

Defined in: [WAProto/index.d.ts:13116](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13116)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SyncdSnapshot`](/docs/api/namespaces/proto/classes/SyncdSnapshot)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13119](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13119)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13117](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13117)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SyncdSnapshot`](/docs/api/namespaces/proto/classes/SyncdSnapshot)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-syncdvalue"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/SyncdValue](https://baileys.wiki/docs/api/namespaces/proto/classes/SyncdValue)

Defined in: [WAProto/index.d.ts:13126](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13126)

## Implements[​](#implements "Direct link to Implements")

*   [`ISyncdValue`](/docs/api/namespaces/proto/interfaces/ISyncdValue)

## Constructors[​](#constructors "Direct link to Constructors")

### new SyncdValue()[​](#new-syncdvalue "Direct link to new SyncdValue()")

> **new SyncdValue**(`p`?): [`SyncdValue`](/docs/api/namespaces/proto/classes/SyncdValue)

Defined in: [WAProto/index.d.ts:13127](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13127)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISyncdValue`](/docs/api/namespaces/proto/interfaces/ISyncdValue)

#### Returns[​](#returns "Direct link to Returns")

[`SyncdValue`](/docs/api/namespaces/proto/classes/SyncdValue)

## Properties[​](#properties "Direct link to Properties")

### blob?[​](#blob "Direct link to blob?")

> `optional` **blob**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13128](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13128)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISyncdValue`](/docs/api/namespaces/proto/interfaces/ISyncdValue).[`blob`](/docs/api/namespaces/proto/interfaces/ISyncdValue#blob)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13134](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13134)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SyncdValue`](/docs/api/namespaces/proto/classes/SyncdValue)

Defined in: [WAProto/index.d.ts:13129](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13129)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISyncdValue`](/docs/api/namespaces/proto/interfaces/ISyncdValue)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SyncdValue`](/docs/api/namespaces/proto/classes/SyncdValue)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SyncdValue`](/docs/api/namespaces/proto/classes/SyncdValue)

Defined in: [WAProto/index.d.ts:13131](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13131)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SyncdValue`](/docs/api/namespaces/proto/classes/SyncdValue)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13130](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13130)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISyncdValue`](/docs/api/namespaces/proto/interfaces/ISyncdValue)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SyncdValue`](/docs/api/namespaces/proto/classes/SyncdValue)

Defined in: [WAProto/index.d.ts:13132](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13132)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SyncdValue`](/docs/api/namespaces/proto/classes/SyncdValue)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13135](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13135)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13133](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13133)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SyncdValue`](/docs/api/namespaces/proto/classes/SyncdValue)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-syncdversion"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/SyncdVersion](https://baileys.wiki/docs/api/namespaces/proto/classes/SyncdVersion)

Defined in: [WAProto/index.d.ts:13142](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13142)

## Implements[​](#implements "Direct link to Implements")

*   [`ISyncdVersion`](/docs/api/namespaces/proto/interfaces/ISyncdVersion)

## Constructors[​](#constructors "Direct link to Constructors")

### new SyncdVersion()[​](#new-syncdversion "Direct link to new SyncdVersion()")

> **new SyncdVersion**(`p`?): [`SyncdVersion`](/docs/api/namespaces/proto/classes/SyncdVersion)

Defined in: [WAProto/index.d.ts:13143](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13143)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISyncdVersion`](/docs/api/namespaces/proto/interfaces/ISyncdVersion)

#### Returns[​](#returns "Direct link to Returns")

[`SyncdVersion`](/docs/api/namespaces/proto/classes/SyncdVersion)

## Properties[​](#properties "Direct link to Properties")

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13144](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13144)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISyncdVersion`](/docs/api/namespaces/proto/interfaces/ISyncdVersion).[`version`](/docs/api/namespaces/proto/interfaces/ISyncdVersion#version)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13150](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13150)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SyncdVersion`](/docs/api/namespaces/proto/classes/SyncdVersion)

Defined in: [WAProto/index.d.ts:13145](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13145)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISyncdVersion`](/docs/api/namespaces/proto/interfaces/ISyncdVersion)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SyncdVersion`](/docs/api/namespaces/proto/classes/SyncdVersion)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SyncdVersion`](/docs/api/namespaces/proto/classes/SyncdVersion)

Defined in: [WAProto/index.d.ts:13147](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13147)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SyncdVersion`](/docs/api/namespaces/proto/classes/SyncdVersion)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13146](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13146)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISyncdVersion`](/docs/api/namespaces/proto/interfaces/ISyncdVersion)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SyncdVersion`](/docs/api/namespaces/proto/classes/SyncdVersion)

Defined in: [WAProto/index.d.ts:13148](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13148)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SyncdVersion`](/docs/api/namespaces/proto/classes/SyncdVersion)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13151](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13151)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13149](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13149)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SyncdVersion`](/docs/api/namespaces/proto/classes/SyncdVersion)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-taplinkaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/TapLinkAction](https://baileys.wiki/docs/api/namespaces/proto/classes/TapLinkAction)

Defined in: [WAProto/index.d.ts:13159](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13159)

## Implements[​](#implements "Direct link to Implements")

*   [`ITapLinkAction`](/docs/api/namespaces/proto/interfaces/ITapLinkAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new TapLinkAction()[​](#new-taplinkaction "Direct link to new TapLinkAction()")

> **new TapLinkAction**(`p`?): [`TapLinkAction`](/docs/api/namespaces/proto/classes/TapLinkAction)

Defined in: [WAProto/index.d.ts:13160](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13160)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ITapLinkAction`](/docs/api/namespaces/proto/interfaces/ITapLinkAction)

#### Returns[​](#returns "Direct link to Returns")

[`TapLinkAction`](/docs/api/namespaces/proto/classes/TapLinkAction)

## Properties[​](#properties "Direct link to Properties")

### tapUrl?[​](#tapurl "Direct link to tapUrl?")

> `optional` **tapUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:13162](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13162)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ITapLinkAction`](/docs/api/namespaces/proto/interfaces/ITapLinkAction).[`tapUrl`](/docs/api/namespaces/proto/interfaces/ITapLinkAction#tapurl)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:13161](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13161)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ITapLinkAction`](/docs/api/namespaces/proto/interfaces/ITapLinkAction).[`title`](/docs/api/namespaces/proto/interfaces/ITapLinkAction#title)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13168](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13168)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`TapLinkAction`](/docs/api/namespaces/proto/classes/TapLinkAction)

Defined in: [WAProto/index.d.ts:13163](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13163)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ITapLinkAction`](/docs/api/namespaces/proto/interfaces/ITapLinkAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`TapLinkAction`](/docs/api/namespaces/proto/classes/TapLinkAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`TapLinkAction`](/docs/api/namespaces/proto/classes/TapLinkAction)

Defined in: [WAProto/index.d.ts:13165](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13165)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`TapLinkAction`](/docs/api/namespaces/proto/classes/TapLinkAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13164](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13164)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ITapLinkAction`](/docs/api/namespaces/proto/interfaces/ITapLinkAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`TapLinkAction`](/docs/api/namespaces/proto/classes/TapLinkAction)

Defined in: [WAProto/index.d.ts:13166](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13166)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`TapLinkAction`](/docs/api/namespaces/proto/classes/TapLinkAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13169](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13169)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13167](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13167)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`TapLinkAction`](/docs/api/namespaces/proto/classes/TapLinkAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-templatebutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/TemplateButton](https://baileys.wiki/docs/api/namespaces/proto/classes/TemplateButton)

Defined in: [WAProto/index.d.ts:13179](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13179)

## Implements[​](#implements "Direct link to Implements")

*   [`ITemplateButton`](/docs/api/namespaces/proto/interfaces/ITemplateButton)

## Constructors[​](#constructors "Direct link to Constructors")

### new TemplateButton()[​](#new-templatebutton "Direct link to new TemplateButton()")

> **new TemplateButton**(`p`?): [`TemplateButton`](/docs/api/namespaces/proto/classes/TemplateButton)

Defined in: [WAProto/index.d.ts:13180](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13180)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ITemplateButton`](/docs/api/namespaces/proto/interfaces/ITemplateButton)

#### Returns[​](#returns "Direct link to Returns")

[`TemplateButton`](/docs/api/namespaces/proto/classes/TemplateButton)

## Properties[​](#properties "Direct link to Properties")

### button?[​](#button "Direct link to button?")

> `optional` **button**: `"quickReplyButton"` | `"urlButton"` | `"callButton"`

Defined in: [WAProto/index.d.ts:13185](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13185)

* * *

### callButton?[​](#callbutton "Direct link to callButton?")

> `optional` **callButton**: `null` | [`ICallButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/ICallButton)

Defined in: [WAProto/index.d.ts:13184](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13184)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ITemplateButton`](/docs/api/namespaces/proto/interfaces/ITemplateButton).[`callButton`](/docs/api/namespaces/proto/interfaces/ITemplateButton#callbutton)

* * *

### index?[​](#index "Direct link to index?")

> `optional` **index**: `null` | `number`

Defined in: [WAProto/index.d.ts:13181](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13181)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ITemplateButton`](/docs/api/namespaces/proto/interfaces/ITemplateButton).[`index`](/docs/api/namespaces/proto/interfaces/ITemplateButton#index)

* * *

### quickReplyButton?[​](#quickreplybutton "Direct link to quickReplyButton?")

> `optional` **quickReplyButton**: `null` | [`IQuickReplyButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IQuickReplyButton)

Defined in: [WAProto/index.d.ts:13182](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13182)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ITemplateButton`](/docs/api/namespaces/proto/interfaces/ITemplateButton).[`quickReplyButton`](/docs/api/namespaces/proto/interfaces/ITemplateButton#quickreplybutton)

* * *

### urlButton?[​](#urlbutton "Direct link to urlButton?")

> `optional` **urlButton**: `null` | [`IURLButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IURLButton)

Defined in: [WAProto/index.d.ts:13183](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13183)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ITemplateButton`](/docs/api/namespaces/proto/interfaces/ITemplateButton).[`urlButton`](/docs/api/namespaces/proto/interfaces/ITemplateButton#urlbutton)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13191](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13191)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`TemplateButton`](/docs/api/namespaces/proto/classes/TemplateButton)

Defined in: [WAProto/index.d.ts:13186](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13186)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ITemplateButton`](/docs/api/namespaces/proto/interfaces/ITemplateButton)

#### Returns[​](#returns-2 "Direct link to Returns")

[`TemplateButton`](/docs/api/namespaces/proto/classes/TemplateButton)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`TemplateButton`](/docs/api/namespaces/proto/classes/TemplateButton)

Defined in: [WAProto/index.d.ts:13188](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13188)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`TemplateButton`](/docs/api/namespaces/proto/classes/TemplateButton)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13187](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13187)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ITemplateButton`](/docs/api/namespaces/proto/interfaces/ITemplateButton)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`TemplateButton`](/docs/api/namespaces/proto/classes/TemplateButton)

Defined in: [WAProto/index.d.ts:13189](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13189)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`TemplateButton`](/docs/api/namespaces/proto/classes/TemplateButton)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13192](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13192)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13190](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13190)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`TemplateButton`](/docs/api/namespaces/proto/classes/TemplateButton)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-threadid"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/ThreadID](https://baileys.wiki/docs/api/namespaces/proto/classes/ThreadID)

Defined in: [WAProto/index.d.ts:13257](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13257)

## Implements[​](#implements "Direct link to Implements")

*   [`IThreadID`](/docs/api/namespaces/proto/interfaces/IThreadID)

## Constructors[​](#constructors "Direct link to Constructors")

### new ThreadID()[​](#new-threadid "Direct link to new ThreadID()")

> **new ThreadID**(`p`?): [`ThreadID`](/docs/api/namespaces/proto/classes/ThreadID)

Defined in: [WAProto/index.d.ts:13258](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13258)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IThreadID`](/docs/api/namespaces/proto/interfaces/IThreadID)

#### Returns[​](#returns "Direct link to Returns")

[`ThreadID`](/docs/api/namespaces/proto/classes/ThreadID)

## Properties[​](#properties "Direct link to Properties")

### threadKey?[​](#threadkey "Direct link to threadKey?")

> `optional` **threadKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:13260](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13260)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IThreadID`](/docs/api/namespaces/proto/interfaces/IThreadID).[`threadKey`](/docs/api/namespaces/proto/interfaces/IThreadID#threadkey)

* * *

### threadType?[​](#threadtype "Direct link to threadType?")

> `optional` **threadType**: `null` | [`ThreadType`](/docs/api/namespaces/proto/namespaces/ThreadID/enumerations/ThreadType)

Defined in: [WAProto/index.d.ts:13259](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13259)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IThreadID`](/docs/api/namespaces/proto/interfaces/IThreadID).[`threadType`](/docs/api/namespaces/proto/interfaces/IThreadID#threadtype)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13266](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13266)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ThreadID`](/docs/api/namespaces/proto/classes/ThreadID)

Defined in: [WAProto/index.d.ts:13261](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13261)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IThreadID`](/docs/api/namespaces/proto/interfaces/IThreadID)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ThreadID`](/docs/api/namespaces/proto/classes/ThreadID)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ThreadID`](/docs/api/namespaces/proto/classes/ThreadID)

Defined in: [WAProto/index.d.ts:13263](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13263)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ThreadID`](/docs/api/namespaces/proto/classes/ThreadID)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13262](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13262)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IThreadID`](/docs/api/namespaces/proto/interfaces/IThreadID)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ThreadID`](/docs/api/namespaces/proto/classes/ThreadID)

Defined in: [WAProto/index.d.ts:13264](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13264)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ThreadID`](/docs/api/namespaces/proto/classes/ThreadID)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13267](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13267)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13265](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13265)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ThreadID`](/docs/api/namespaces/proto/classes/ThreadID)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-urltrackingmap"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/UrlTrackingMap](https://baileys.wiki/docs/api/namespaces/proto/classes/UrlTrackingMap)

Defined in: [WAProto/index.d.ts:13283](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13283)

## Implements[​](#implements "Direct link to Implements")

*   [`IUrlTrackingMap`](/docs/api/namespaces/proto/interfaces/IUrlTrackingMap)

## Constructors[​](#constructors "Direct link to Constructors")

### new UrlTrackingMap()[​](#new-urltrackingmap "Direct link to new UrlTrackingMap()")

> **new UrlTrackingMap**(`p`?): [`UrlTrackingMap`](/docs/api/namespaces/proto/classes/UrlTrackingMap)

Defined in: [WAProto/index.d.ts:13284](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13284)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IUrlTrackingMap`](/docs/api/namespaces/proto/interfaces/IUrlTrackingMap)

#### Returns[​](#returns "Direct link to Returns")

[`UrlTrackingMap`](/docs/api/namespaces/proto/classes/UrlTrackingMap)

## Properties[​](#properties "Direct link to Properties")

### urlTrackingMapElements[​](#urltrackingmapelements "Direct link to urlTrackingMapElements")

> **urlTrackingMapElements**: [`IUrlTrackingMapElement`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/interfaces/IUrlTrackingMapElement)\[\]

Defined in: [WAProto/index.d.ts:13285](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13285)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IUrlTrackingMap`](/docs/api/namespaces/proto/interfaces/IUrlTrackingMap).[`urlTrackingMapElements`](/docs/api/namespaces/proto/interfaces/IUrlTrackingMap#urltrackingmapelements)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13291](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13291)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`UrlTrackingMap`](/docs/api/namespaces/proto/classes/UrlTrackingMap)

Defined in: [WAProto/index.d.ts:13286](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13286)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IUrlTrackingMap`](/docs/api/namespaces/proto/interfaces/IUrlTrackingMap)

#### Returns[​](#returns-2 "Direct link to Returns")

[`UrlTrackingMap`](/docs/api/namespaces/proto/classes/UrlTrackingMap)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`UrlTrackingMap`](/docs/api/namespaces/proto/classes/UrlTrackingMap)

Defined in: [WAProto/index.d.ts:13288](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13288)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`UrlTrackingMap`](/docs/api/namespaces/proto/classes/UrlTrackingMap)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13287](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13287)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IUrlTrackingMap`](/docs/api/namespaces/proto/interfaces/IUrlTrackingMap)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`UrlTrackingMap`](/docs/api/namespaces/proto/classes/UrlTrackingMap)

Defined in: [WAProto/index.d.ts:13289](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13289)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`UrlTrackingMap`](/docs/api/namespaces/proto/classes/UrlTrackingMap)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13292](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13292)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13290](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13290)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`UrlTrackingMap`](/docs/api/namespaces/proto/classes/UrlTrackingMap)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-userpassword"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/UserPassword](https://baileys.wiki/docs/api/namespaces/proto/classes/UserPassword)

Defined in: [WAProto/index.d.ts:13327](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13327)

## Implements[​](#implements "Direct link to Implements")

*   [`IUserPassword`](/docs/api/namespaces/proto/interfaces/IUserPassword)

## Constructors[​](#constructors "Direct link to Constructors")

### new UserPassword()[​](#new-userpassword "Direct link to new UserPassword()")

> **new UserPassword**(`p`?): [`UserPassword`](/docs/api/namespaces/proto/classes/UserPassword)

Defined in: [WAProto/index.d.ts:13328](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13328)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IUserPassword`](/docs/api/namespaces/proto/interfaces/IUserPassword)

#### Returns[​](#returns "Direct link to Returns")

[`UserPassword`](/docs/api/namespaces/proto/classes/UserPassword)

## Properties[​](#properties "Direct link to Properties")

### encoding?[​](#encoding "Direct link to encoding?")

> `optional` **encoding**: `null` | [`Encoding`](/docs/api/namespaces/proto/namespaces/UserPassword/enumerations/Encoding)

Defined in: [WAProto/index.d.ts:13329](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13329)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IUserPassword`](/docs/api/namespaces/proto/interfaces/IUserPassword).[`encoding`](/docs/api/namespaces/proto/interfaces/IUserPassword#encoding)

* * *

### transformedData?[​](#transformeddata "Direct link to transformedData?")

> `optional` **transformedData**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13332](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13332)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IUserPassword`](/docs/api/namespaces/proto/interfaces/IUserPassword).[`transformedData`](/docs/api/namespaces/proto/interfaces/IUserPassword#transformeddata)

* * *

### transformer?[​](#transformer "Direct link to transformer?")

> `optional` **transformer**: `null` | [`Transformer`](/docs/api/namespaces/proto/namespaces/UserPassword/enumerations/Transformer)

Defined in: [WAProto/index.d.ts:13330](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13330)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IUserPassword`](/docs/api/namespaces/proto/interfaces/IUserPassword).[`transformer`](/docs/api/namespaces/proto/interfaces/IUserPassword#transformer)

* * *

### transformerArg[​](#transformerarg "Direct link to transformerArg")

> **transformerArg**: [`ITransformerArg`](/docs/api/namespaces/proto/namespaces/UserPassword/interfaces/ITransformerArg)\[\]

Defined in: [WAProto/index.d.ts:13331](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13331)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IUserPassword`](/docs/api/namespaces/proto/interfaces/IUserPassword).[`transformerArg`](/docs/api/namespaces/proto/interfaces/IUserPassword#transformerarg)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13338](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13338)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`UserPassword`](/docs/api/namespaces/proto/classes/UserPassword)

Defined in: [WAProto/index.d.ts:13333](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13333)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IUserPassword`](/docs/api/namespaces/proto/interfaces/IUserPassword)

#### Returns[​](#returns-2 "Direct link to Returns")

[`UserPassword`](/docs/api/namespaces/proto/classes/UserPassword)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`UserPassword`](/docs/api/namespaces/proto/classes/UserPassword)

Defined in: [WAProto/index.d.ts:13335](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13335)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`UserPassword`](/docs/api/namespaces/proto/classes/UserPassword)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13334](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13334)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IUserPassword`](/docs/api/namespaces/proto/interfaces/IUserPassword)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`UserPassword`](/docs/api/namespaces/proto/classes/UserPassword)

Defined in: [WAProto/index.d.ts:13336](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13336)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`UserPassword`](/docs/api/namespaces/proto/classes/UserPassword)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13339](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13339)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13337](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13337)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`UserPassword`](/docs/api/namespaces/proto/classes/UserPassword)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-userreceipt"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/UserReceipt](https://baileys.wiki/docs/api/namespaces/proto/classes/UserReceipt)

Defined in: [WAProto/index.d.ts:13405](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13405)

## Implements[​](#implements "Direct link to Implements")

*   [`IUserReceipt`](/docs/api/namespaces/proto/interfaces/IUserReceipt)

## Constructors[​](#constructors "Direct link to Constructors")

### new UserReceipt()[​](#new-userreceipt "Direct link to new UserReceipt()")

> **new UserReceipt**(`p`?): [`UserReceipt`](/docs/api/namespaces/proto/classes/UserReceipt)

Defined in: [WAProto/index.d.ts:13406](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13406)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IUserReceipt`](/docs/api/namespaces/proto/interfaces/IUserReceipt)

#### Returns[​](#returns "Direct link to Returns")

[`UserReceipt`](/docs/api/namespaces/proto/classes/UserReceipt)

## Properties[​](#properties "Direct link to Properties")

### deliveredDeviceJid[​](#delivereddevicejid "Direct link to deliveredDeviceJid")

> **deliveredDeviceJid**: `string`\[\]

Defined in: [WAProto/index.d.ts:13412](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13412)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IUserReceipt`](/docs/api/namespaces/proto/interfaces/IUserReceipt).[`deliveredDeviceJid`](/docs/api/namespaces/proto/interfaces/IUserReceipt#delivereddevicejid)

* * *

### pendingDeviceJid[​](#pendingdevicejid "Direct link to pendingDeviceJid")

> **pendingDeviceJid**: `string`\[\]

Defined in: [WAProto/index.d.ts:13411](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13411)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IUserReceipt`](/docs/api/namespaces/proto/interfaces/IUserReceipt).[`pendingDeviceJid`](/docs/api/namespaces/proto/interfaces/IUserReceipt#pendingdevicejid)

* * *

### playedTimestamp?[​](#playedtimestamp "Direct link to playedTimestamp?")

> `optional` **playedTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13410](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13410)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IUserReceipt`](/docs/api/namespaces/proto/interfaces/IUserReceipt).[`playedTimestamp`](/docs/api/namespaces/proto/interfaces/IUserReceipt#playedtimestamp)

* * *

### readTimestamp?[​](#readtimestamp "Direct link to readTimestamp?")

> `optional` **readTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13409](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13409)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IUserReceipt`](/docs/api/namespaces/proto/interfaces/IUserReceipt).[`readTimestamp`](/docs/api/namespaces/proto/interfaces/IUserReceipt#readtimestamp)

* * *

### receiptTimestamp?[​](#receipttimestamp "Direct link to receiptTimestamp?")

> `optional` **receiptTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13408](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13408)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IUserReceipt`](/docs/api/namespaces/proto/interfaces/IUserReceipt).[`receiptTimestamp`](/docs/api/namespaces/proto/interfaces/IUserReceipt#receipttimestamp)

* * *

### userJid[​](#userjid "Direct link to userJid")

> **userJid**: `string`

Defined in: [WAProto/index.d.ts:13407](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13407)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IUserReceipt`](/docs/api/namespaces/proto/interfaces/IUserReceipt).[`userJid`](/docs/api/namespaces/proto/interfaces/IUserReceipt#userjid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13418](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13418)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`UserReceipt`](/docs/api/namespaces/proto/classes/UserReceipt)

Defined in: [WAProto/index.d.ts:13413](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13413)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IUserReceipt`](/docs/api/namespaces/proto/interfaces/IUserReceipt)

#### Returns[​](#returns-2 "Direct link to Returns")

[`UserReceipt`](/docs/api/namespaces/proto/classes/UserReceipt)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`UserReceipt`](/docs/api/namespaces/proto/classes/UserReceipt)

Defined in: [WAProto/index.d.ts:13415](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13415)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`UserReceipt`](/docs/api/namespaces/proto/classes/UserReceipt)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13414](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13414)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IUserReceipt`](/docs/api/namespaces/proto/interfaces/IUserReceipt)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`UserReceipt`](/docs/api/namespaces/proto/classes/UserReceipt)

Defined in: [WAProto/index.d.ts:13416](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13416)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`UserReceipt`](/docs/api/namespaces/proto/classes/UserReceipt)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13419](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13419)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13417](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13417)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`UserReceipt`](/docs/api/namespaces/proto/classes/UserReceipt)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-verifiednamecertificate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/VerifiedNameCertificate](https://baileys.wiki/docs/api/namespaces/proto/classes/VerifiedNameCertificate)

Defined in: [WAProto/index.d.ts:13428](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13428)

## Implements[​](#implements "Direct link to Implements")

*   [`IVerifiedNameCertificate`](/docs/api/namespaces/proto/interfaces/IVerifiedNameCertificate)

## Constructors[​](#constructors "Direct link to Constructors")

### new VerifiedNameCertificate()[​](#new-verifiednamecertificate "Direct link to new VerifiedNameCertificate()")

> **new VerifiedNameCertificate**(`p`?): [`VerifiedNameCertificate`](/docs/api/namespaces/proto/classes/VerifiedNameCertificate)

Defined in: [WAProto/index.d.ts:13429](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13429)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IVerifiedNameCertificate`](/docs/api/namespaces/proto/interfaces/IVerifiedNameCertificate)

#### Returns[​](#returns "Direct link to Returns")

[`VerifiedNameCertificate`](/docs/api/namespaces/proto/classes/VerifiedNameCertificate)

## Properties[​](#properties "Direct link to Properties")

### details?[​](#details "Direct link to details?")

> `optional` **details**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13430](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13430)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IVerifiedNameCertificate`](/docs/api/namespaces/proto/interfaces/IVerifiedNameCertificate).[`details`](/docs/api/namespaces/proto/interfaces/IVerifiedNameCertificate#details)

* * *

### serverSignature?[​](#serversignature "Direct link to serverSignature?")

> `optional` **serverSignature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13432](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13432)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IVerifiedNameCertificate`](/docs/api/namespaces/proto/interfaces/IVerifiedNameCertificate).[`serverSignature`](/docs/api/namespaces/proto/interfaces/IVerifiedNameCertificate#serversignature)

* * *

### signature?[​](#signature "Direct link to signature?")

> `optional` **signature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13431](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13431)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IVerifiedNameCertificate`](/docs/api/namespaces/proto/interfaces/IVerifiedNameCertificate).[`signature`](/docs/api/namespaces/proto/interfaces/IVerifiedNameCertificate#signature)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13438](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13438)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`VerifiedNameCertificate`](/docs/api/namespaces/proto/classes/VerifiedNameCertificate)

Defined in: [WAProto/index.d.ts:13433](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13433)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IVerifiedNameCertificate`](/docs/api/namespaces/proto/interfaces/IVerifiedNameCertificate)

#### Returns[​](#returns-2 "Direct link to Returns")

[`VerifiedNameCertificate`](/docs/api/namespaces/proto/classes/VerifiedNameCertificate)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`VerifiedNameCertificate`](/docs/api/namespaces/proto/classes/VerifiedNameCertificate)

Defined in: [WAProto/index.d.ts:13435](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13435)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`VerifiedNameCertificate`](/docs/api/namespaces/proto/classes/VerifiedNameCertificate)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13434](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13434)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IVerifiedNameCertificate`](/docs/api/namespaces/proto/interfaces/IVerifiedNameCertificate)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`VerifiedNameCertificate`](/docs/api/namespaces/proto/classes/VerifiedNameCertificate)

Defined in: [WAProto/index.d.ts:13436](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13436)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`VerifiedNameCertificate`](/docs/api/namespaces/proto/classes/VerifiedNameCertificate)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13439](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13439)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13437](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13437)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`VerifiedNameCertificate`](/docs/api/namespaces/proto/classes/VerifiedNameCertificate)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-wallpapersettings"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/WallpaperSettings](https://baileys.wiki/docs/api/namespaces/proto/classes/WallpaperSettings)

Defined in: [WAProto/index.d.ts:13474](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13474)

## Implements[​](#implements "Direct link to Implements")

*   [`IWallpaperSettings`](/docs/api/namespaces/proto/interfaces/IWallpaperSettings)

## Constructors[​](#constructors "Direct link to Constructors")

### new WallpaperSettings()[​](#new-wallpapersettings "Direct link to new WallpaperSettings()")

> **new WallpaperSettings**(`p`?): [`WallpaperSettings`](/docs/api/namespaces/proto/classes/WallpaperSettings)

Defined in: [WAProto/index.d.ts:13475](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13475)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IWallpaperSettings`](/docs/api/namespaces/proto/interfaces/IWallpaperSettings)

#### Returns[​](#returns "Direct link to Returns")

[`WallpaperSettings`](/docs/api/namespaces/proto/classes/WallpaperSettings)

## Properties[​](#properties "Direct link to Properties")

### filename?[​](#filename "Direct link to filename?")

> `optional` **filename**: `null` | `string`

Defined in: [WAProto/index.d.ts:13476](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13476)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IWallpaperSettings`](/docs/api/namespaces/proto/interfaces/IWallpaperSettings).[`filename`](/docs/api/namespaces/proto/interfaces/IWallpaperSettings#filename)

* * *

### opacity?[​](#opacity "Direct link to opacity?")

> `optional` **opacity**: `null` | `number`

Defined in: [WAProto/index.d.ts:13477](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13477)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IWallpaperSettings`](/docs/api/namespaces/proto/interfaces/IWallpaperSettings).[`opacity`](/docs/api/namespaces/proto/interfaces/IWallpaperSettings#opacity)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13483](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13483)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`WallpaperSettings`](/docs/api/namespaces/proto/classes/WallpaperSettings)

Defined in: [WAProto/index.d.ts:13478](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13478)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IWallpaperSettings`](/docs/api/namespaces/proto/interfaces/IWallpaperSettings)

#### Returns[​](#returns-2 "Direct link to Returns")

[`WallpaperSettings`](/docs/api/namespaces/proto/classes/WallpaperSettings)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`WallpaperSettings`](/docs/api/namespaces/proto/classes/WallpaperSettings)

Defined in: [WAProto/index.d.ts:13480](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13480)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`WallpaperSettings`](/docs/api/namespaces/proto/classes/WallpaperSettings)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13479](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13479)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IWallpaperSettings`](/docs/api/namespaces/proto/interfaces/IWallpaperSettings)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`WallpaperSettings`](/docs/api/namespaces/proto/classes/WallpaperSettings)

Defined in: [WAProto/index.d.ts:13481](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13481)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`WallpaperSettings`](/docs/api/namespaces/proto/classes/WallpaperSettings)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13484](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13484)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13482](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13482)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`WallpaperSettings`](/docs/api/namespaces/proto/classes/WallpaperSettings)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-webfeatures"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/WebFeatures](https://baileys.wiki/docs/api/namespaces/proto/classes/WebFeatures)

Defined in: [WAProto/index.d.ts:13535](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13535)

## Implements[​](#implements "Direct link to Implements")

*   [`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures)

## Constructors[​](#constructors "Direct link to Constructors")

### new WebFeatures()[​](#new-webfeatures "Direct link to new WebFeatures()")

> **new WebFeatures**(`p`?): [`WebFeatures`](/docs/api/namespaces/proto/classes/WebFeatures)

Defined in: [WAProto/index.d.ts:13536](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13536)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures)

#### Returns[​](#returns "Direct link to Returns")

[`WebFeatures`](/docs/api/namespaces/proto/classes/WebFeatures)

## Properties[​](#properties "Direct link to Properties")

### archiveV2?[​](#archivev2 "Direct link to archiveV2?")

> `optional` **archiveV2**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13575](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13575)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`archiveV2`](/docs/api/namespaces/proto/interfaces/IWebFeatures#archivev2)

* * *

### catalog?[​](#catalog "Direct link to catalog?")

> `optional` **catalog**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13561](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13561)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`catalog`](/docs/api/namespaces/proto/interfaces/IWebFeatures#catalog)

* * *

### changeNumberV2?[​](#changenumberv2 "Direct link to changeNumberV2?")

> `optional` **changeNumberV2**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13541](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13541)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`changeNumberV2`](/docs/api/namespaces/proto/interfaces/IWebFeatures#changenumberv2)

* * *

### disappearingMode?[​](#disappearingmode "Direct link to disappearingMode?")

> `optional` **disappearingMode**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13579](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13579)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`disappearingMode`](/docs/api/namespaces/proto/interfaces/IWebFeatures#disappearingmode)

* * *

### e2ENotificationSync?[​](#e2enotificationsync "Direct link to e2ENotificationSync?")

> `optional` **e2ENotificationSync**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13567](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13567)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`e2ENotificationSync`](/docs/api/namespaces/proto/interfaces/IWebFeatures#e2enotificationsync)

* * *

### ephemeral24HDuration?[​](#ephemeral24hduration "Direct link to ephemeral24HDuration?")

> `optional` **ephemeral24HDuration**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13577](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13577)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`ephemeral24HDuration`](/docs/api/namespaces/proto/interfaces/IWebFeatures#ephemeral24hduration)

* * *

### ephemeralAllowGroupMembers?[​](#ephemeralallowgroupmembers "Direct link to ephemeralAllowGroupMembers?")

> `optional` **ephemeralAllowGroupMembers**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13576](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13576)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`ephemeralAllowGroupMembers`](/docs/api/namespaces/proto/interfaces/IWebFeatures#ephemeralallowgroupmembers)

* * *

### ephemeralMessages?[​](#ephemeralmessages "Direct link to ephemeralMessages?")

> `optional` **ephemeralMessages**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13566](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13566)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`ephemeralMessages`](/docs/api/namespaces/proto/interfaces/IWebFeatures#ephemeralmessages)

* * *

### externalMdOptInAvailable?[​](#externalmdoptinavailable "Direct link to externalMdOptInAvailable?")

> `optional` **externalMdOptInAvailable**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13580](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13580)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`externalMdOptInAvailable`](/docs/api/namespaces/proto/interfaces/IWebFeatures#externalmdoptinavailable)

* * *

### frequentlyForwardedSetting?[​](#frequentlyforwardedsetting "Direct link to frequentlyForwardedSetting?")

> `optional` **frequentlyForwardedSetting**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13558](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13558)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`frequentlyForwardedSetting`](/docs/api/namespaces/proto/interfaces/IWebFeatures#frequentlyforwardedsetting)

* * *

### groupDogfoodingInternalOnly?[​](#groupdogfoodinginternalonly "Direct link to groupDogfoodingInternalOnly?")

> `optional` **groupDogfoodingInternalOnly**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13573](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13573)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`groupDogfoodingInternalOnly`](/docs/api/namespaces/proto/interfaces/IWebFeatures#groupdogfoodinginternalonly)

* * *

### groupsV3?[​](#groupsv3 "Direct link to groupsV3?")

> `optional` **groupsV3**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13539](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13539)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`groupsV3`](/docs/api/namespaces/proto/interfaces/IWebFeatures#groupsv3)

* * *

### groupsV3Create?[​](#groupsv3create "Direct link to groupsV3Create?")

> `optional` **groupsV3Create**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13540](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13540)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`groupsV3Create`](/docs/api/namespaces/proto/interfaces/IWebFeatures#groupsv3create)

* * *

### groupsV4JoinPermission?[​](#groupsv4joinpermission "Direct link to groupsV4JoinPermission?")

> `optional` **groupsV4JoinPermission**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13559](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13559)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`groupsV4JoinPermission`](/docs/api/namespaces/proto/interfaces/IWebFeatures#groupsv4joinpermission)

* * *

### groupUiiCleanup?[​](#groupuiicleanup "Direct link to groupUiiCleanup?")

> `optional` **groupUiiCleanup**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13572](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13572)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`groupUiiCleanup`](/docs/api/namespaces/proto/interfaces/IWebFeatures#groupuiicleanup)

* * *

### labelsDisplay?[​](#labelsdisplay "Direct link to labelsDisplay?")

> `optional` **labelsDisplay**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13537](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13537)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`labelsDisplay`](/docs/api/namespaces/proto/interfaces/IWebFeatures#labelsdisplay)

* * *

### labelsEdit?[​](#labelsedit "Direct link to labelsEdit?")

> `optional` **labelsEdit**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13550](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13550)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`labelsEdit`](/docs/api/namespaces/proto/interfaces/IWebFeatures#labelsedit)

* * *

### liveLocations?[​](#livelocations "Direct link to liveLocations?")

> `optional` **liveLocations**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13543](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13543)

#### Implementation of[​](#implementation-of-17 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`liveLocations`](/docs/api/namespaces/proto/interfaces/IWebFeatures#livelocations)

* * *

### liveLocationsFinal?[​](#livelocationsfinal "Direct link to liveLocationsFinal?")

> `optional` **liveLocationsFinal**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13549](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13549)

#### Implementation of[​](#implementation-of-18 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`liveLocationsFinal`](/docs/api/namespaces/proto/interfaces/IWebFeatures#livelocationsfinal)

* * *

### mdForceUpgrade?[​](#mdforceupgrade "Direct link to mdForceUpgrade?")

> `optional` **mdForceUpgrade**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13578](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13578)

#### Implementation of[​](#implementation-of-19 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`mdForceUpgrade`](/docs/api/namespaces/proto/interfaces/IWebFeatures#mdforceupgrade)

* * *

### mediaUpload?[​](#mediaupload "Direct link to mediaUpload?")

> `optional` **mediaUpload**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13551](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13551)

#### Implementation of[​](#implementation-of-20 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`mediaUpload`](/docs/api/namespaces/proto/interfaces/IWebFeatures#mediaupload)

* * *

### mediaUploadRichQuickReplies?[​](#mediauploadrichquickreplies "Direct link to mediaUploadRichQuickReplies?")

> `optional` **mediaUploadRichQuickReplies**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13552](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13552)

#### Implementation of[​](#implementation-of-21 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`mediaUploadRichQuickReplies`](/docs/api/namespaces/proto/interfaces/IWebFeatures#mediauploadrichquickreplies)

* * *

### noDeleteMessageTimeLimit?[​](#nodeletemessagetimelimit "Direct link to noDeleteMessageTimeLimit?")

> `optional` **noDeleteMessageTimeLimit**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13581](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13581)

#### Implementation of[​](#implementation-of-22 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`noDeleteMessageTimeLimit`](/docs/api/namespaces/proto/interfaces/IWebFeatures#nodeletemessagetimelimit)

* * *

### payments?[​](#payments "Direct link to payments?")

> `optional` **payments**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13547](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13547)

#### Implementation of[​](#implementation-of-23 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`payments`](/docs/api/namespaces/proto/interfaces/IWebFeatures#payments)

* * *

### queryStatusV3Thumbnail?[​](#querystatusv3thumbnail "Direct link to queryStatusV3Thumbnail?")

> `optional` **queryStatusV3Thumbnail**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13542](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13542)

#### Implementation of[​](#implementation-of-24 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`queryStatusV3Thumbnail`](/docs/api/namespaces/proto/interfaces/IWebFeatures#querystatusv3thumbnail)

* * *

### queryVname?[​](#queryvname "Direct link to queryVname?")

> `optional` **queryVname**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13544](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13544)

#### Implementation of[​](#implementation-of-25 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`queryVname`](/docs/api/namespaces/proto/interfaces/IWebFeatures#queryvname)

* * *

### quickRepliesQuery?[​](#quickrepliesquery "Direct link to quickRepliesQuery?")

> `optional` **quickRepliesQuery**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13546](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13546)

#### Implementation of[​](#implementation-of-26 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`quickRepliesQuery`](/docs/api/namespaces/proto/interfaces/IWebFeatures#quickrepliesquery)

* * *

### recentStickers?[​](#recentstickers "Direct link to recentStickers?")

> `optional` **recentStickers**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13560](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13560)

#### Implementation of[​](#implementation-of-27 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`recentStickers`](/docs/api/namespaces/proto/interfaces/IWebFeatures#recentstickers)

* * *

### recentStickersV2?[​](#recentstickersv2 "Direct link to recentStickersV2?")

> `optional` **recentStickersV2**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13568](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13568)

#### Implementation of[​](#implementation-of-28 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`recentStickersV2`](/docs/api/namespaces/proto/interfaces/IWebFeatures#recentstickersv2)

* * *

### recentStickersV3?[​](#recentstickersv3 "Direct link to recentStickersV3?")

> `optional` **recentStickersV3**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13569](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13569)

#### Implementation of[​](#implementation-of-29 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`recentStickersV3`](/docs/api/namespaces/proto/interfaces/IWebFeatures#recentstickersv3)

* * *

### settingsSync?[​](#settingssync "Direct link to settingsSync?")

> `optional` **settingsSync**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13574](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13574)

#### Implementation of[​](#implementation-of-30 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`settingsSync`](/docs/api/namespaces/proto/interfaces/IWebFeatures#settingssync)

* * *

### starredStickers?[​](#starredstickers "Direct link to starredStickers?")

> `optional` **starredStickers**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13562](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13562)

#### Implementation of[​](#implementation-of-31 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`starredStickers`](/docs/api/namespaces/proto/interfaces/IWebFeatures#starredstickers)

* * *

### statusRanking?[​](#statusranking "Direct link to statusRanking?")

> `optional` **statusRanking**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13555](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13555)

#### Implementation of[​](#implementation-of-32 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`statusRanking`](/docs/api/namespaces/proto/interfaces/IWebFeatures#statusranking)

* * *

### stickerPackQuery?[​](#stickerpackquery "Direct link to stickerPackQuery?")

> `optional` **stickerPackQuery**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13548](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13548)

#### Implementation of[​](#implementation-of-33 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`stickerPackQuery`](/docs/api/namespaces/proto/interfaces/IWebFeatures#stickerpackquery)

* * *

### support?[​](#support "Direct link to support?")

> `optional` **support**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13571](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13571)

#### Implementation of[​](#implementation-of-34 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`support`](/docs/api/namespaces/proto/interfaces/IWebFeatures#support)

* * *

### templateMessage?[​](#templatemessage "Direct link to templateMessage?")

> `optional` **templateMessage**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13564](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13564)

#### Implementation of[​](#implementation-of-35 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`templateMessage`](/docs/api/namespaces/proto/interfaces/IWebFeatures#templatemessage)

* * *

### templateMessageInteractivity?[​](#templatemessageinteractivity "Direct link to templateMessageInteractivity?")

> `optional` **templateMessageInteractivity**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13565](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13565)

#### Implementation of[​](#implementation-of-36 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`templateMessageInteractivity`](/docs/api/namespaces/proto/interfaces/IWebFeatures#templatemessageinteractivity)

* * *

### thirdPartyStickers?[​](#thirdpartystickers "Direct link to thirdPartyStickers?")

> `optional` **thirdPartyStickers**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13557](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13557)

#### Implementation of[​](#implementation-of-37 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`thirdPartyStickers`](/docs/api/namespaces/proto/interfaces/IWebFeatures#thirdpartystickers)

* * *

### userNotice?[​](#usernotice "Direct link to userNotice?")

> `optional` **userNotice**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13570](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13570)

#### Implementation of[​](#implementation-of-38 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`userNotice`](/docs/api/namespaces/proto/interfaces/IWebFeatures#usernotice)

* * *

### videoPlaybackUrl?[​](#videoplaybackurl "Direct link to videoPlaybackUrl?")

> `optional` **videoPlaybackUrl**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13554](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13554)

#### Implementation of[​](#implementation-of-39 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`videoPlaybackUrl`](/docs/api/namespaces/proto/interfaces/IWebFeatures#videoplaybackurl)

* * *

### vnameV2?[​](#vnamev2 "Direct link to vnameV2?")

> `optional` **vnameV2**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13553](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13553)

#### Implementation of[​](#implementation-of-40 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`vnameV2`](/docs/api/namespaces/proto/interfaces/IWebFeatures#vnamev2)

* * *

### voipGroupCall?[​](#voipgroupcall "Direct link to voipGroupCall?")

> `optional` **voipGroupCall**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13563](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13563)

#### Implementation of[​](#implementation-of-41 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`voipGroupCall`](/docs/api/namespaces/proto/interfaces/IWebFeatures#voipgroupcall)

* * *

### voipIndividualIncoming?[​](#voipindividualincoming "Direct link to voipIndividualIncoming?")

> `optional` **voipIndividualIncoming**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13545](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13545)

#### Implementation of[​](#implementation-of-42 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`voipIndividualIncoming`](/docs/api/namespaces/proto/interfaces/IWebFeatures#voipindividualincoming)

* * *

### voipIndividualOutgoing?[​](#voipindividualoutgoing "Direct link to voipIndividualOutgoing?")

> `optional` **voipIndividualOutgoing**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13538](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13538)

#### Implementation of[​](#implementation-of-43 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`voipIndividualOutgoing`](/docs/api/namespaces/proto/interfaces/IWebFeatures#voipindividualoutgoing)

* * *

### voipIndividualVideo?[​](#voipindividualvideo "Direct link to voipIndividualVideo?")

> `optional` **voipIndividualVideo**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13556](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13556)

#### Implementation of[​](#implementation-of-44 "Direct link to Implementation of")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures).[`voipIndividualVideo`](/docs/api/namespaces/proto/interfaces/IWebFeatures#voipindividualvideo)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13587](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13587)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`WebFeatures`](/docs/api/namespaces/proto/classes/WebFeatures)

Defined in: [WAProto/index.d.ts:13582](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13582)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures)

#### Returns[​](#returns-2 "Direct link to Returns")

[`WebFeatures`](/docs/api/namespaces/proto/classes/WebFeatures)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`WebFeatures`](/docs/api/namespaces/proto/classes/WebFeatures)

Defined in: [WAProto/index.d.ts:13584](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13584)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`WebFeatures`](/docs/api/namespaces/proto/classes/WebFeatures)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13583](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13583)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IWebFeatures`](/docs/api/namespaces/proto/interfaces/IWebFeatures)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`WebFeatures`](/docs/api/namespaces/proto/classes/WebFeatures)

Defined in: [WAProto/index.d.ts:13585](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13585)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`WebFeatures`](/docs/api/namespaces/proto/classes/WebFeatures)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13588](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13588)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13586](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13586)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`WebFeatures`](/docs/api/namespaces/proto/classes/WebFeatures)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-webmessageinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/WebMessageInfo](https://baileys.wiki/docs/api/namespaces/proto/classes/WebMessageInfo)

Defined in: [WAProto/index.d.ts:13675](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13675)

## Implements[​](#implements "Direct link to Implements")

*   [`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new WebMessageInfo()[​](#new-webmessageinfo "Direct link to new WebMessageInfo()")

> **new WebMessageInfo**(`p`?): [`WebMessageInfo`](/docs/api/namespaces/proto/classes/WebMessageInfo)

Defined in: [WAProto/index.d.ts:13676](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13676)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo)

#### Returns[​](#returns "Direct link to Returns")

[`WebMessageInfo`](/docs/api/namespaces/proto/classes/WebMessageInfo)

## Properties[​](#properties "Direct link to Properties")

### agentId?[​](#agentid "Direct link to agentId?")

> `optional` **agentId**: `null` | `string`

Defined in: [WAProto/index.d.ts:13714](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13714)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`agentId`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#agentid)

* * *

### bizPrivacyStatus?[​](#bizprivacystatus "Direct link to bizPrivacyStatus?")

> `optional` **bizPrivacyStatus**: `null` | [`BizPrivacyStatus`](/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/BizPrivacyStatus)

Defined in: [WAProto/index.d.ts:13703](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13703)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`bizPrivacyStatus`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#bizprivacystatus)

* * *

### botMessageInvokerJid?[​](#botmessageinvokerjid "Direct link to botMessageInvokerJid?")

> `optional` **botMessageInvokerJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:13724](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13724)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`botMessageInvokerJid`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#botmessageinvokerjid)

* * *

### botTargetId?[​](#bottargetid "Direct link to botTargetId?")

> `optional` **botTargetId**: `null` | `string`

Defined in: [WAProto/index.d.ts:13738](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13738)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`botTargetId`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#bottargetid)

* * *

### broadcast?[​](#broadcast "Direct link to broadcast?")

> `optional` **broadcast**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13685](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13685)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`broadcast`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#broadcast)

* * *

### clearMedia?[​](#clearmedia "Direct link to clearMedia?")

> `optional` **clearMedia**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13692](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13692)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`clearMedia`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#clearmedia)

* * *

### commentMetadata?[​](#commentmetadata "Direct link to commentMetadata?")

> `optional` **commentMetadata**: `null` | [`ICommentMetadata`](/docs/api/namespaces/proto/interfaces/ICommentMetadata)

Defined in: [WAProto/index.d.ts:13725](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13725)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`commentMetadata`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#commentmetadata)

* * *

### duration?[​](#duration "Direct link to duration?")

> `optional` **duration**: `null` | `number`

Defined in: [WAProto/index.d.ts:13694](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13694)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`duration`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#duration)

* * *

### ephemeralDuration?[​](#ephemeralduration "Direct link to ephemeralDuration?")

> `optional` **ephemeralDuration**: `null` | `number`

Defined in: [WAProto/index.d.ts:13700](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13700)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`ephemeralDuration`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#ephemeralduration)

* * *

### ephemeralOffToOn?[​](#ephemeralofftoon "Direct link to ephemeralOffToOn?")

> `optional` **ephemeralOffToOn**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13701](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13701)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`ephemeralOffToOn`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#ephemeralofftoon)

* * *

### ephemeralOutOfSync?[​](#ephemeraloutofsync "Direct link to ephemeralOutOfSync?")

> `optional` **ephemeralOutOfSync**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13702](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13702)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`ephemeralOutOfSync`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#ephemeraloutofsync)

* * *

### ephemeralStartTimestamp?[​](#ephemeralstarttimestamp "Direct link to ephemeralStartTimestamp?")

> `optional` **ephemeralStartTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13699](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13699)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`ephemeralStartTimestamp`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#ephemeralstarttimestamp)

* * *

### eventAdditionalMetadata?[​](#eventadditionalmetadata "Direct link to eventAdditionalMetadata?")

> `optional` **eventAdditionalMetadata**: `null` | [`IEventAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IEventAdditionalMetadata)

Defined in: [WAProto/index.d.ts:13729](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13729)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`eventAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#eventadditionalmetadata)

* * *

### eventResponses[​](#eventresponses "Direct link to eventResponses")

> **eventResponses**: [`IEventResponse`](/docs/api/namespaces/proto/interfaces/IEventResponse)\[\]

Defined in: [WAProto/index.d.ts:13726](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13726)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`eventResponses`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#eventresponses)

* * *

### finalLiveLocation?[​](#finallivelocation "Direct link to finalLiveLocation?")

> `optional` **finalLiveLocation**: `null` | [`ILiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage)

Defined in: [WAProto/index.d.ts:13697](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13697)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`finalLiveLocation`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#finallivelocation)

* * *

### futureproofData?[​](#futureproofdata "Direct link to futureproofData?")

> `optional` **futureproofData**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13710](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13710)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`futureproofData`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#futureproofdata)

* * *

### groupHistoryBundleInfo?[​](#grouphistorybundleinfo "Direct link to groupHistoryBundleInfo?")

> `optional` **groupHistoryBundleInfo**: `null` | [`IGroupHistoryBundleInfo`](/docs/api/namespaces/proto/interfaces/IGroupHistoryBundleInfo)

Defined in: [WAProto/index.d.ts:13740](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13740)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`groupHistoryBundleInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#grouphistorybundleinfo)

* * *

### groupHistoryIndividualMessageInfo?[​](#grouphistoryindividualmessageinfo "Direct link to groupHistoryIndividualMessageInfo?")

> `optional` **groupHistoryIndividualMessageInfo**: `null` | [`IGroupHistoryIndividualMessageInfo`](/docs/api/namespaces/proto/interfaces/IGroupHistoryIndividualMessageInfo)

Defined in: [WAProto/index.d.ts:13739](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13739)

#### Implementation of[​](#implementation-of-17 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`groupHistoryIndividualMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#grouphistoryindividualmessageinfo)

* * *

### ignore?[​](#ignore "Direct link to ignore?")

> `optional` **ignore**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13683](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13683)

#### Implementation of[​](#implementation-of-18 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`ignore`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#ignore)

* * *

### interactiveMessageAdditionalMetadata?[​](#interactivemessageadditionalmetadata "Direct link to interactiveMessageAdditionalMetadata?")

> `optional` **interactiveMessageAdditionalMetadata**: `null` | [`IInteractiveMessageAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IInteractiveMessageAdditionalMetadata)

Defined in: [WAProto/index.d.ts:13741](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13741)

#### Implementation of[​](#implementation-of-19 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`interactiveMessageAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#interactivemessageadditionalmetadata)

* * *

### is1PBizBotMessage?[​](#is1pbizbotmessage "Direct link to is1PBizBotMessage?")

> `optional` **is1PBizBotMessage**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13722](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13722)

#### Implementation of[​](#implementation-of-20 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`is1PBizBotMessage`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#is1pbizbotmessage)

* * *

### isGroupHistoryMessage?[​](#isgrouphistorymessage "Direct link to isGroupHistoryMessage?")

> `optional` **isGroupHistoryMessage**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13723](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13723)

#### Implementation of[​](#implementation-of-21 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`isGroupHistoryMessage`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#isgrouphistorymessage)

* * *

### isMentionedInStatus?[​](#ismentionedinstatus "Direct link to isMentionedInStatus?")

> `optional` **isMentionedInStatus**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13730](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13730)

#### Implementation of[​](#implementation-of-22 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`isMentionedInStatus`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#ismentionedinstatus)

* * *

### isSupportAiMessage?[​](#issupportaimessage "Direct link to isSupportAiMessage?")

> `optional` **isSupportAiMessage**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13735](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13735)

#### Implementation of[​](#implementation-of-23 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`isSupportAiMessage`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#issupportaimessage)

* * *

### keepInChat?[​](#keepinchat "Direct link to keepInChat?")

> `optional` **keepInChat**: `null` | [`IKeepInChat`](/docs/api/namespaces/proto/interfaces/IKeepInChat)

Defined in: [WAProto/index.d.ts:13717](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13717)

#### Implementation of[​](#implementation-of-24 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`keepInChat`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#keepinchat)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:13677](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13677)

#### Implementation of[​](#implementation-of-25 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`key`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#key)

* * *

### labels[​](#labels "Direct link to labels")

> **labels**: `string`\[\]

Defined in: [WAProto/index.d.ts:13695](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13695)

#### Implementation of[​](#implementation-of-26 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`labels`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#labels)

* * *

### mediaCiphertextSha256?[​](#mediaciphertextsha256 "Direct link to mediaCiphertextSha256?")

> `optional` **mediaCiphertextSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13687](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13687)

#### Implementation of[​](#implementation-of-27 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`mediaCiphertextSha256`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#mediaciphertextsha256)

* * *

### mediaData?[​](#mediadata "Direct link to mediaData?")

> `optional` **mediaData**: `null` | [`IMediaData`](/docs/api/namespaces/proto/interfaces/IMediaData)

Defined in: [WAProto/index.d.ts:13705](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13705)

#### Implementation of[​](#implementation-of-28 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`mediaData`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#mediadata)

* * *

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:13678](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13678)

#### Implementation of[​](#implementation-of-29 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`message`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#message)

* * *

### messageAddOns[​](#messageaddons "Direct link to messageAddOns")

> **messageAddOns**: [`IMessageAddOn`](/docs/api/namespaces/proto/interfaces/IMessageAddOn)\[\]

Defined in: [WAProto/index.d.ts:13733](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13733)

#### Implementation of[​](#implementation-of-30 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`messageAddOns`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#messageaddons)

* * *

### messageC2STimestamp?[​](#messagec2stimestamp "Direct link to messageC2STimestamp?")

> `optional` **messageC2STimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13682](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13682)

#### Implementation of[​](#implementation-of-31 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`messageC2STimestamp`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#messagec2stimestamp)

* * *

### messageSecret?[​](#messagesecret "Direct link to messageSecret?")

> `optional` **messageSecret**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13716](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13716)

#### Implementation of[​](#implementation-of-32 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`messageSecret`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#messagesecret)

* * *

### messageStubParameters[​](#messagestubparameters "Direct link to messageStubParameters")

> **messageStubParameters**: `string`\[\]

Defined in: [WAProto/index.d.ts:13693](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13693)

#### Implementation of[​](#implementation-of-33 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`messageStubParameters`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#messagestubparameters)

* * *

### messageStubType?[​](#messagestubtype "Direct link to messageStubType?")

> `optional` **messageStubType**: `null` | [`StubType`](/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/StubType)

Defined in: [WAProto/index.d.ts:13691](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13691)

#### Implementation of[​](#implementation-of-34 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`messageStubType`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#messagestubtype)

* * *

### messageTimestamp?[​](#messagetimestamp "Direct link to messageTimestamp?")

> `optional` **messageTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13679](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13679)

#### Implementation of[​](#implementation-of-35 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`messageTimestamp`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#messagetimestamp)

* * *

### multicast?[​](#multicast "Direct link to multicast?")

> `optional` **multicast**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13688](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13688)

#### Implementation of[​](#implementation-of-36 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`multicast`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#multicast)

* * *

### newsletterServerId?[​](#newsletterserverid "Direct link to newsletterServerId?")

> `optional` **newsletterServerId**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13728](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13728)

#### Implementation of[​](#implementation-of-37 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`newsletterServerId`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#newsletterserverid)

* * *

### originalSelfAuthorUserJidString?[​](#originalselfauthoruserjidstring "Direct link to originalSelfAuthorUserJidString?")

> `optional` **originalSelfAuthorUserJidString**: `null` | `string`

Defined in: [WAProto/index.d.ts:13718](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13718)

#### Implementation of[​](#implementation-of-38 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`originalSelfAuthorUserJidString`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#originalselfauthoruserjidstring)

* * *

### participant?[​](#participant "Direct link to participant?")

> `optional` **participant**: `null` | `string`

Defined in: [WAProto/index.d.ts:13681](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13681)

#### Implementation of[​](#implementation-of-39 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`participant`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#participant)

* * *

### paymentInfo?[​](#paymentinfo "Direct link to paymentInfo?")

> `optional` **paymentInfo**: `null` | [`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo)

Defined in: [WAProto/index.d.ts:13696](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13696)

#### Implementation of[​](#implementation-of-40 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`paymentInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#paymentinfo)

* * *

### photoChange?[​](#photochange "Direct link to photoChange?")

> `optional` **photoChange**: `null` | [`IPhotoChange`](/docs/api/namespaces/proto/interfaces/IPhotoChange)

Defined in: [WAProto/index.d.ts:13706](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13706)

#### Implementation of[​](#implementation-of-41 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`photoChange`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#photochange)

* * *

### pinInChat?[​](#pininchat "Direct link to pinInChat?")

> `optional` **pinInChat**: `null` | [`IPinInChat`](/docs/api/namespaces/proto/interfaces/IPinInChat)

Defined in: [WAProto/index.d.ts:13720](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13720)

#### Implementation of[​](#implementation-of-42 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`pinInChat`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#pininchat)

* * *

### pollAdditionalMetadata?[​](#polladditionalmetadata "Direct link to pollAdditionalMetadata?")

> `optional` **pollAdditionalMetadata**: `null` | [`IPollAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IPollAdditionalMetadata)

Defined in: [WAProto/index.d.ts:13713](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13713)

#### Implementation of[​](#implementation-of-43 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`pollAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#polladditionalmetadata)

* * *

### pollUpdates[​](#pollupdates "Direct link to pollUpdates")

> **pollUpdates**: [`IPollUpdate`](/docs/api/namespaces/proto/interfaces/IPollUpdate)\[\]

Defined in: [WAProto/index.d.ts:13712](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13712)

#### Implementation of[​](#implementation-of-44 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`pollUpdates`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#pollupdates)

* * *

### premiumMessageInfo?[​](#premiummessageinfo "Direct link to premiumMessageInfo?")

> `optional` **premiumMessageInfo**: `null` | [`IPremiumMessageInfo`](/docs/api/namespaces/proto/interfaces/IPremiumMessageInfo)

Defined in: [WAProto/index.d.ts:13721](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13721)

#### Implementation of[​](#implementation-of-45 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`premiumMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#premiummessageinfo)

* * *

### pushName?[​](#pushname "Direct link to pushName?")

> `optional` **pushName**: `null` | `string`

Defined in: [WAProto/index.d.ts:13686](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13686)

#### Implementation of[​](#implementation-of-46 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`pushName`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#pushname)

* * *

### quarantinedMessage?[​](#quarantinedmessage "Direct link to quarantinedMessage?")

> `optional` **quarantinedMessage**: `null` | [`IQuarantinedMessage`](/docs/api/namespaces/proto/interfaces/IQuarantinedMessage)

Defined in: [WAProto/index.d.ts:13742](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13742)

#### Implementation of[​](#implementation-of-47 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`quarantinedMessage`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#quarantinedmessage)

* * *

### quotedPaymentInfo?[​](#quotedpaymentinfo "Direct link to quotedPaymentInfo?")

> `optional` **quotedPaymentInfo**: `null` | [`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo)

Defined in: [WAProto/index.d.ts:13698](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13698)

#### Implementation of[​](#implementation-of-48 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`quotedPaymentInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#quotedpaymentinfo)

* * *

### quotedStickerData?[​](#quotedstickerdata "Direct link to quotedStickerData?")

> `optional` **quotedStickerData**: `null` | [`IMediaData`](/docs/api/namespaces/proto/interfaces/IMediaData)

Defined in: [WAProto/index.d.ts:13709](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13709)

#### Implementation of[​](#implementation-of-49 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`quotedStickerData`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#quotedstickerdata)

* * *

### reactions[​](#reactions "Direct link to reactions")

> **reactions**: [`IReaction`](/docs/api/namespaces/proto/interfaces/IReaction)\[\]

Defined in: [WAProto/index.d.ts:13708](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13708)

#### Implementation of[​](#implementation-of-50 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`reactions`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#reactions)

* * *

### reportingTokenInfo?[​](#reportingtokeninfo "Direct link to reportingTokenInfo?")

> `optional` **reportingTokenInfo**: `null` | [`IReportingTokenInfo`](/docs/api/namespaces/proto/interfaces/IReportingTokenInfo)

Defined in: [WAProto/index.d.ts:13727](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13727)

#### Implementation of[​](#implementation-of-51 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`reportingTokenInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#reportingtokeninfo)

* * *

### revokeMessageTimestamp?[​](#revokemessagetimestamp "Direct link to revokeMessageTimestamp?")

> `optional` **revokeMessageTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13719](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13719)

#### Implementation of[​](#implementation-of-52 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`revokeMessageTimestamp`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#revokemessagetimestamp)

* * *

### starred?[​](#starred "Direct link to starred?")

> `optional` **starred**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13684](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13684)

#### Implementation of[​](#implementation-of-53 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`starred`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#starred)

* * *

### status?[​](#status "Direct link to status?")

> `optional` **status**: `null` | [`Status`](/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/Status)

Defined in: [WAProto/index.d.ts:13680](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13680)

#### Implementation of[​](#implementation-of-54 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`status`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#status)

* * *

### statusAlreadyViewed?[​](#statusalreadyviewed "Direct link to statusAlreadyViewed?")

> `optional` **statusAlreadyViewed**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13715](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13715)

#### Implementation of[​](#implementation-of-55 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`statusAlreadyViewed`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#statusalreadyviewed)

* * *

### statusMentionMessageInfo?[​](#statusmentionmessageinfo "Direct link to statusMentionMessageInfo?")

> `optional` **statusMentionMessageInfo**: `null` | [`IStatusMentionMessage`](/docs/api/namespaces/proto/interfaces/IStatusMentionMessage)

Defined in: [WAProto/index.d.ts:13734](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13734)

#### Implementation of[​](#implementation-of-56 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`statusMentionMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#statusmentionmessageinfo)

* * *

### statusMentions[​](#statusmentions "Direct link to statusMentions")

> **statusMentions**: `string`\[\]

Defined in: [WAProto/index.d.ts:13731](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13731)

#### Implementation of[​](#implementation-of-57 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`statusMentions`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#statusmentions)

* * *

### statusMentionSources[​](#statusmentionsources "Direct link to statusMentionSources")

> **statusMentionSources**: `string`\[\]

Defined in: [WAProto/index.d.ts:13736](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13736)

#### Implementation of[​](#implementation-of-58 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`statusMentionSources`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#statusmentionsources)

* * *

### statusPsa?[​](#statuspsa "Direct link to statusPsa?")

> `optional` **statusPsa**: `null` | [`IStatusPSA`](/docs/api/namespaces/proto/interfaces/IStatusPSA)

Defined in: [WAProto/index.d.ts:13711](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13711)

#### Implementation of[​](#implementation-of-59 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`statusPsa`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#statuspsa)

* * *

### supportAiCitations[​](#supportaicitations "Direct link to supportAiCitations")

> **supportAiCitations**: [`ICitation`](/docs/api/namespaces/proto/interfaces/ICitation)\[\]

Defined in: [WAProto/index.d.ts:13737](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13737)

#### Implementation of[​](#implementation-of-60 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`supportAiCitations`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#supportaicitations)

* * *

### targetMessageId?[​](#targetmessageid "Direct link to targetMessageId?")

> `optional` **targetMessageId**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:13732](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13732)

#### Implementation of[​](#implementation-of-61 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`targetMessageId`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#targetmessageid)

* * *

### urlNumber?[​](#urlnumber "Direct link to urlNumber?")

> `optional` **urlNumber**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13690](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13690)

#### Implementation of[​](#implementation-of-62 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`urlNumber`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#urlnumber)

* * *

### urlText?[​](#urltext "Direct link to urlText?")

> `optional` **urlText**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13689](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13689)

#### Implementation of[​](#implementation-of-63 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`urlText`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#urltext)

* * *

### userReceipt[​](#userreceipt "Direct link to userReceipt")

> **userReceipt**: [`IUserReceipt`](/docs/api/namespaces/proto/interfaces/IUserReceipt)\[\]

Defined in: [WAProto/index.d.ts:13707](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13707)

#### Implementation of[​](#implementation-of-64 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`userReceipt`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#userreceipt)

* * *

### verifiedBizName?[​](#verifiedbizname "Direct link to verifiedBizName?")

> `optional` **verifiedBizName**: `null` | `string`

Defined in: [WAProto/index.d.ts:13704](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13704)

#### Implementation of[​](#implementation-of-65 "Direct link to Implementation of")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo).[`verifiedBizName`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo#verifiedbizname)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13748](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13748)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`WebMessageInfo`](/docs/api/namespaces/proto/classes/WebMessageInfo)

Defined in: [WAProto/index.d.ts:13743](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13743)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`WebMessageInfo`](/docs/api/namespaces/proto/classes/WebMessageInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`WebMessageInfo`](/docs/api/namespaces/proto/classes/WebMessageInfo)

Defined in: [WAProto/index.d.ts:13745](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13745)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`WebMessageInfo`](/docs/api/namespaces/proto/classes/WebMessageInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13744](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13744)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`WebMessageInfo`](/docs/api/namespaces/proto/classes/WebMessageInfo)

Defined in: [WAProto/index.d.ts:13746](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13746)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`WebMessageInfo`](/docs/api/namespaces/proto/classes/WebMessageInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13749](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13749)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13747](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13747)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`WebMessageInfo`](/docs/api/namespaces/proto/classes/WebMessageInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-webnotificationsinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/classes/WebNotificationsInfo](https://baileys.wiki/docs/api/namespaces/proto/classes/WebNotificationsInfo)

Defined in: [WAProto/index.d.ts:14003](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L14003)

## Implements[​](#implements "Direct link to Implements")

*   [`IWebNotificationsInfo`](/docs/api/namespaces/proto/interfaces/IWebNotificationsInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new WebNotificationsInfo()[​](#new-webnotificationsinfo "Direct link to new WebNotificationsInfo()")

> **new WebNotificationsInfo**(`p`?): [`WebNotificationsInfo`](/docs/api/namespaces/proto/classes/WebNotificationsInfo)

Defined in: [WAProto/index.d.ts:14004](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L14004)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IWebNotificationsInfo`](/docs/api/namespaces/proto/interfaces/IWebNotificationsInfo)

#### Returns[​](#returns "Direct link to Returns")

[`WebNotificationsInfo`](/docs/api/namespaces/proto/classes/WebNotificationsInfo)

## Properties[​](#properties "Direct link to Properties")

### notifyMessageCount?[​](#notifymessagecount "Direct link to notifyMessageCount?")

> `optional` **notifyMessageCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:14007](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L14007)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IWebNotificationsInfo`](/docs/api/namespaces/proto/interfaces/IWebNotificationsInfo).[`notifyMessageCount`](/docs/api/namespaces/proto/interfaces/IWebNotificationsInfo#notifymessagecount)

* * *

### notifyMessages[​](#notifymessages "Direct link to notifyMessages")

> **notifyMessages**: [`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo)\[\]

Defined in: [WAProto/index.d.ts:14008](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L14008)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IWebNotificationsInfo`](/docs/api/namespaces/proto/interfaces/IWebNotificationsInfo).[`notifyMessages`](/docs/api/namespaces/proto/interfaces/IWebNotificationsInfo#notifymessages)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:14005](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L14005)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IWebNotificationsInfo`](/docs/api/namespaces/proto/interfaces/IWebNotificationsInfo).[`timestamp`](/docs/api/namespaces/proto/interfaces/IWebNotificationsInfo#timestamp)

* * *

### unreadChats?[​](#unreadchats "Direct link to unreadChats?")

> `optional` **unreadChats**: `null` | `number`

Defined in: [WAProto/index.d.ts:14006](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L14006)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IWebNotificationsInfo`](/docs/api/namespaces/proto/interfaces/IWebNotificationsInfo).[`unreadChats`](/docs/api/namespaces/proto/interfaces/IWebNotificationsInfo#unreadchats)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:14014](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L14014)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`WebNotificationsInfo`](/docs/api/namespaces/proto/classes/WebNotificationsInfo)

Defined in: [WAProto/index.d.ts:14009](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L14009)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IWebNotificationsInfo`](/docs/api/namespaces/proto/interfaces/IWebNotificationsInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`WebNotificationsInfo`](/docs/api/namespaces/proto/classes/WebNotificationsInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`WebNotificationsInfo`](/docs/api/namespaces/proto/classes/WebNotificationsInfo)

Defined in: [WAProto/index.d.ts:14011](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L14011)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`WebNotificationsInfo`](/docs/api/namespaces/proto/classes/WebNotificationsInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:14010](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L14010)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IWebNotificationsInfo`](/docs/api/namespaces/proto/interfaces/IWebNotificationsInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`WebNotificationsInfo`](/docs/api/namespaces/proto/classes/WebNotificationsInfo)

Defined in: [WAProto/index.d.ts:14012](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L14012)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`WebNotificationsInfo`](/docs/api/namespaces/proto/classes/WebNotificationsInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:14015](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L14015)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:14013](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L14013)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`WebNotificationsInfo`](/docs/api/namespaces/proto/classes/WebNotificationsInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-advencryptiontype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/enumerations/ADVEncryptionType](https://baileys.wiki/docs/api/namespaces/proto/enumerations/ADVEncryptionType)

Defined in: [WAProto/index.d.ts:29](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L29)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### E2EE[​](#e2ee "Direct link to E2EE")

> **E2EE**: `0`

Defined in: [WAProto/index.d.ts:30](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L30)

* * *

### HOSTED[​](#hosted "Direct link to HOSTED")

> **HOSTED**: `1`

Defined in: [WAProto/index.d.ts:31](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L31)

---

<a name="enumeration-airichresponsemessagetype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/enumerations/AIRichResponseMessageType](https://baileys.wiki/docs/api/namespaces/proto/enumerations/AIRichResponseMessageType)

Defined in: [WAProto/index.d.ts:560](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L560)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AI\_RICH\_RESPONSE\_TYPE\_STANDARD[​](#ai_rich_response_type_standard "Direct link to AI_RICH_RESPONSE_TYPE_STANDARD")

> **AI\_RICH\_RESPONSE\_TYPE\_STANDARD**: `1`

Defined in: [WAProto/index.d.ts:562](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L562)

* * *

### AI\_RICH\_RESPONSE\_TYPE\_UNKNOWN[​](#ai_rich_response_type_unknown "Direct link to AI_RICH_RESPONSE_TYPE_UNKNOWN")

> **AI\_RICH\_RESPONSE\_TYPE\_UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:561](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L561)

---

<a name="enumeration-airichresponsesubmessagetype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/enumerations/AIRichResponseSubMessageType](https://baileys.wiki/docs/api/namespaces/proto/enumerations/AIRichResponseSubMessageType)

Defined in: [WAProto/index.d.ts:599](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L599)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AI\_RICH\_RESPONSE\_CODE[​](#ai_rich_response_code "Direct link to AI_RICH_RESPONSE_CODE")

> **AI\_RICH\_RESPONSE\_CODE**: `5`

Defined in: [WAProto/index.d.ts:605](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L605)

* * *

### AI\_RICH\_RESPONSE\_CONTENT\_ITEMS[​](#ai_rich_response_content_items "Direct link to AI_RICH_RESPONSE_CONTENT_ITEMS")

> **AI\_RICH\_RESPONSE\_CONTENT\_ITEMS**: `9`

Defined in: [WAProto/index.d.ts:609](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L609)

* * *

### AI\_RICH\_RESPONSE\_DYNAMIC[​](#ai_rich_response_dynamic "Direct link to AI_RICH_RESPONSE_DYNAMIC")

> **AI\_RICH\_RESPONSE\_DYNAMIC**: `6`

Defined in: [WAProto/index.d.ts:606](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L606)

* * *

### AI\_RICH\_RESPONSE\_GRID\_IMAGE[​](#ai_rich_response_grid_image "Direct link to AI_RICH_RESPONSE_GRID_IMAGE")

> **AI\_RICH\_RESPONSE\_GRID\_IMAGE**: `1`

Defined in: [WAProto/index.d.ts:601](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L601)

* * *

### AI\_RICH\_RESPONSE\_INLINE\_IMAGE[​](#ai_rich_response_inline_image "Direct link to AI_RICH_RESPONSE_INLINE_IMAGE")

> **AI\_RICH\_RESPONSE\_INLINE\_IMAGE**: `3`

Defined in: [WAProto/index.d.ts:603](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L603)

* * *

### AI\_RICH\_RESPONSE\_LATEX[​](#ai_rich_response_latex "Direct link to AI_RICH_RESPONSE_LATEX")

> **AI\_RICH\_RESPONSE\_LATEX**: `8`

Defined in: [WAProto/index.d.ts:608](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L608)

* * *

### AI\_RICH\_RESPONSE\_MAP[​](#ai_rich_response_map "Direct link to AI_RICH_RESPONSE_MAP")

> **AI\_RICH\_RESPONSE\_MAP**: `7`

Defined in: [WAProto/index.d.ts:607](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L607)

* * *

### AI\_RICH\_RESPONSE\_TABLE[​](#ai_rich_response_table "Direct link to AI_RICH_RESPONSE_TABLE")

> **AI\_RICH\_RESPONSE\_TABLE**: `4`

Defined in: [WAProto/index.d.ts:604](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L604)

* * *

### AI\_RICH\_RESPONSE\_TEXT[​](#ai_rich_response_text "Direct link to AI_RICH_RESPONSE_TEXT")

> **AI\_RICH\_RESPONSE\_TEXT**: `2`

Defined in: [WAProto/index.d.ts:602](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L602)

* * *

### AI\_RICH\_RESPONSE\_UNKNOWN[​](#ai_rich_response_unknown "Direct link to AI_RICH_RESPONSE_UNKNOWN")

> **AI\_RICH\_RESPONSE\_UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:600](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L600)

---

<a name="enumeration-botmetricsentrypoint"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/enumerations/BotMetricsEntryPoint](https://baileys.wiki/docs/api/namespaces/proto/enumerations/BotMetricsEntryPoint)

Defined in: [WAProto/index.d.ts:1578](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1578)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AI\_DEEPLINK[​](#ai_deeplink "Direct link to AI_DEEPLINK")

> **AI\_DEEPLINK**: `21`

Defined in: [WAProto/index.d.ts:1600](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1600)

* * *

### AI\_DEEPLINK\_IMMERSIVE[​](#ai_deeplink_immersive "Direct link to AI_DEEPLINK_IMMERSIVE")

> **AI\_DEEPLINK\_IMMERSIVE**: `20`

Defined in: [WAProto/index.d.ts:1599](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1599)

* * *

### AI\_HOME[​](#ai_home "Direct link to AI_HOME")

> **AI\_HOME**: `19`

Defined in: [WAProto/index.d.ts:1598](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1598)

* * *

### AI\_TAB[​](#ai_tab "Direct link to AI_TAB")

> **AI\_TAB**: `18`

Defined in: [WAProto/index.d.ts:1597](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1597)

* * *

### AISEARCH\_NULL\_STATE\_PAPER\_PLANE[​](#aisearch_null_state_paper_plane "Direct link to AISEARCH_NULL_STATE_PAPER_PLANE")

> **AISEARCH\_NULL\_STATE\_PAPER\_PLANE**: `3`

Defined in: [WAProto/index.d.ts:1582](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1582)

* * *

### AISEARCH\_NULL\_STATE\_SUGGESTION[​](#aisearch_null_state_suggestion "Direct link to AISEARCH_NULL_STATE_SUGGESTION")

> **AISEARCH\_NULL\_STATE\_SUGGESTION**: `4`

Defined in: [WAProto/index.d.ts:1583](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1583)

* * *

### AISEARCH\_TYPE\_AHEAD\_PAPER\_PLANE[​](#aisearch_type_ahead_paper_plane "Direct link to AISEARCH_TYPE_AHEAD_PAPER_PLANE")

> **AISEARCH\_TYPE\_AHEAD\_PAPER\_PLANE**: `6`

Defined in: [WAProto/index.d.ts:1585](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1585)

* * *

### AISEARCH\_TYPE\_AHEAD\_RESULT\_CHATLIST[​](#aisearch_type_ahead_result_chatlist "Direct link to AISEARCH_TYPE_AHEAD_RESULT_CHATLIST")

> **AISEARCH\_TYPE\_AHEAD\_RESULT\_CHATLIST**: `7`

Defined in: [WAProto/index.d.ts:1586](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1586)

* * *

### AISEARCH\_TYPE\_AHEAD\_RESULT\_MESSAGES[​](#aisearch_type_ahead_result_messages "Direct link to AISEARCH_TYPE_AHEAD_RESULT_MESSAGES")

> **AISEARCH\_TYPE\_AHEAD\_RESULT\_MESSAGES**: `8`

Defined in: [WAProto/index.d.ts:1587](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1587)

* * *

### AISEARCH\_TYPE\_AHEAD\_SUGGESTION[​](#aisearch_type_ahead_suggestion "Direct link to AISEARCH_TYPE_AHEAD_SUGGESTION")

> **AISEARCH\_TYPE\_AHEAD\_SUGGESTION**: `5`

Defined in: [WAProto/index.d.ts:1584](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1584)

* * *

### AISTUDIO[​](#aistudio "Direct link to AISTUDIO")

> **AISTUDIO**: `11`

Defined in: [WAProto/index.d.ts:1590](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1590)

* * *

### AIVOICE\_FAVICON[​](#aivoice_favicon "Direct link to AIVOICE_FAVICON")

> **AIVOICE\_FAVICON**: `10`

Defined in: [WAProto/index.d.ts:1589](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1589)

* * *

### AIVOICE\_FAVICON\_CALL\_HISTORY[​](#aivoice_favicon_call_history "Direct link to AIVOICE_FAVICON_CALL_HISTORY")

> **AIVOICE\_FAVICON\_CALL\_HISTORY**: `25`

Defined in: [WAProto/index.d.ts:1604](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1604)

* * *

### AIVOICE\_SEARCH\_BAR[​](#aivoice_search_bar "Direct link to AIVOICE_SEARCH_BAR")

> **AIVOICE\_SEARCH\_BAR**: `9`

Defined in: [WAProto/index.d.ts:1588](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1588)

* * *

### APP\_SHORTCUT[​](#app_shortcut "Direct link to APP_SHORTCUT")

> **APP\_SHORTCUT**: `16`

Defined in: [WAProto/index.d.ts:1595](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1595)

* * *

### ASK\_META\_AI\_CONTEXT\_MENU[​](#ask_meta_ai_context_menu "Direct link to ASK_META_AI_CONTEXT_MENU")

> **ASK\_META\_AI\_CONTEXT\_MENU**: `26`

Defined in: [WAProto/index.d.ts:1605](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1605)

* * *

### ASK\_META\_AI\_CONTEXT\_MENU\_1ON1[​](#ask_meta_ai_context_menu_1on1 "Direct link to ASK_META_AI_CONTEXT_MENU_1ON1")

> **ASK\_META\_AI\_CONTEXT\_MENU\_1ON1**: `27`

Defined in: [WAProto/index.d.ts:1606](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1606)

* * *

### ASK\_META\_AI\_CONTEXT\_MENU\_GROUP[​](#ask_meta_ai_context_menu_group "Direct link to ASK_META_AI_CONTEXT_MENU_GROUP")

> **ASK\_META\_AI\_CONTEXT\_MENU\_GROUP**: `28`

Defined in: [WAProto/index.d.ts:1607](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1607)

* * *

### ASK\_META\_AI\_MEDIA\_VIEWER\_1ON1[​](#ask_meta_ai_media_viewer_1on1 "Direct link to ASK_META_AI_MEDIA_VIEWER_1ON1")

> **ASK\_META\_AI\_MEDIA\_VIEWER\_1ON1**: `37`

Defined in: [WAProto/index.d.ts:1616](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1616)

* * *

### ASK\_META\_AI\_MEDIA\_VIEWER\_GROUP[​](#ask_meta_ai_media_viewer_group "Direct link to ASK_META_AI_MEDIA_VIEWER_GROUP")

> **ASK\_META\_AI\_MEDIA\_VIEWER\_GROUP**: `38`

Defined in: [WAProto/index.d.ts:1617](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1617)

* * *

### ATTACHMENT\_TRAY\_1\_ON\_1\_CHAT[​](#attachment_tray_1_on_1_chat "Direct link to ATTACHMENT_TRAY_1_ON_1_CHAT")

> **ATTACHMENT\_TRAY\_1\_ON\_1\_CHAT**: `35`

Defined in: [WAProto/index.d.ts:1614](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1614)

* * *

### ATTACHMENT\_TRAY\_GROUP\_CHAT[​](#attachment_tray_group_chat "Direct link to ATTACHMENT_TRAY_GROUP_CHAT")

> **ATTACHMENT\_TRAY\_GROUP\_CHAT**: `36`

Defined in: [WAProto/index.d.ts:1615](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1615)

* * *

### CHATLIST[​](#chatlist "Direct link to CHATLIST")

> **CHATLIST**: `2`

Defined in: [WAProto/index.d.ts:1581](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1581)

* * *

### DEEPLINK[​](#deeplink "Direct link to DEEPLINK")

> **DEEPLINK**: `12`

Defined in: [WAProto/index.d.ts:1591](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1591)

* * *

### FAVICON[​](#favicon "Direct link to FAVICON")

> **FAVICON**: `1`

Defined in: [WAProto/index.d.ts:1580](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1580)

* * *

### FF\_FAMILY[​](#ff_family "Direct link to FF_FAMILY")

> **FF\_FAMILY**: `17`

Defined in: [WAProto/index.d.ts:1596](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1596)

* * *

### FORWARD[​](#forward "Direct link to FORWARD")

> **FORWARD**: `15`

Defined in: [WAProto/index.d.ts:1594](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1594)

* * *

### INVOKE\_META\_AI\_1ON1[​](#invoke_meta_ai_1on1 "Direct link to INVOKE_META_AI_1ON1")

> **INVOKE\_META\_AI\_1ON1**: `29`

Defined in: [WAProto/index.d.ts:1608](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1608)

* * *

### INVOKE\_META\_AI\_GROUP[​](#invoke_meta_ai_group "Direct link to INVOKE_META_AI_GROUP")

> **INVOKE\_META\_AI\_GROUP**: `30`

Defined in: [WAProto/index.d.ts:1609](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1609)

* * *

### MESSAGE\_QUICK\_ACTION\_1\_ON\_1\_CHAT[​](#message_quick_action_1_on_1_chat "Direct link to MESSAGE_QUICK_ACTION_1_ON_1_CHAT")

> **MESSAGE\_QUICK\_ACTION\_1\_ON\_1\_CHAT**: `33`

Defined in: [WAProto/index.d.ts:1612](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1612)

* * *

### MESSAGE\_QUICK\_ACTION\_GROUP\_CHAT[​](#message_quick_action_group_chat "Direct link to MESSAGE_QUICK_ACTION_GROUP_CHAT")

> **MESSAGE\_QUICK\_ACTION\_GROUP\_CHAT**: `34`

Defined in: [WAProto/index.d.ts:1613](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1613)

* * *

### META\_AI\_CHAT\_SHORTCUT\_AI\_STUDIO[​](#meta_ai_chat_shortcut_ai_studio "Direct link to META_AI_CHAT_SHORTCUT_AI_STUDIO")

> **META\_AI\_CHAT\_SHORTCUT\_AI\_STUDIO**: `22`

Defined in: [WAProto/index.d.ts:1601](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1601)

* * *

### META\_AI\_FORWARD[​](#meta_ai_forward "Direct link to META_AI_FORWARD")

> **META\_AI\_FORWARD**: `31`

Defined in: [WAProto/index.d.ts:1610](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1610)

* * *

### NEW\_CHAT\_AI\_CONTACT[​](#new_chat_ai_contact "Direct link to NEW_CHAT_AI_CONTACT")

> **NEW\_CHAT\_AI\_CONTACT**: `32`

Defined in: [WAProto/index.d.ts:1611](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1611)

* * *

### NEW\_CHAT\_AI\_STUDIO[​](#new_chat_ai_studio "Direct link to NEW_CHAT_AI_STUDIO")

> **NEW\_CHAT\_AI\_STUDIO**: `24`

Defined in: [WAProto/index.d.ts:1603](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1603)

* * *

### NOTIFICATION[​](#notification "Direct link to NOTIFICATION")

> **NOTIFICATION**: `13`

Defined in: [WAProto/index.d.ts:1592](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1592)

* * *

### PROFILE\_MESSAGE\_BUTTON[​](#profile_message_button "Direct link to PROFILE_MESSAGE_BUTTON")

> **PROFILE\_MESSAGE\_BUTTON**: `14`

Defined in: [WAProto/index.d.ts:1593](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1593)

* * *

### UGC\_CHAT\_SHORTCUT\_AI\_STUDIO[​](#ugc_chat_shortcut_ai_studio "Direct link to UGC_CHAT_SHORTCUT_AI_STUDIO")

> **UGC\_CHAT\_SHORTCUT\_AI\_STUDIO**: `23`

Defined in: [WAProto/index.d.ts:1602](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1602)

* * *

### UNDEFINED\_ENTRY\_POINT[​](#undefined_entry_point "Direct link to UNDEFINED_ENTRY_POINT")

> **UNDEFINED\_ENTRY\_POINT**: `0`

Defined in: [WAProto/index.d.ts:1579](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1579)

---

<a name="enumeration-botmetricsthreadentrypoint"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/enumerations/BotMetricsThreadEntryPoint](https://baileys.wiki/docs/api/namespaces/proto/enumerations/BotMetricsThreadEntryPoint)

Defined in: [WAProto/index.d.ts:1640](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1640)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AI\_DEEPLINK\_IMMERSIVE\_THREAD[​](#ai_deeplink_immersive_thread "Direct link to AI_DEEPLINK_IMMERSIVE_THREAD")

> **AI\_DEEPLINK\_IMMERSIVE\_THREAD**: `3`

Defined in: [WAProto/index.d.ts:1643](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1643)

* * *

### AI\_DEEPLINK\_THREAD[​](#ai_deeplink_thread "Direct link to AI_DEEPLINK_THREAD")

> **AI\_DEEPLINK\_THREAD**: `4`

Defined in: [WAProto/index.d.ts:1644](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1644)

* * *

### AI\_HOME\_THREAD[​](#ai_home_thread "Direct link to AI_HOME_THREAD")

> **AI\_HOME\_THREAD**: `2`

Defined in: [WAProto/index.d.ts:1642](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1642)

* * *

### AI\_TAB\_THREAD[​](#ai_tab_thread "Direct link to AI_TAB_THREAD")

> **AI\_TAB\_THREAD**: `1`

Defined in: [WAProto/index.d.ts:1641](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1641)

* * *

### ASK\_META\_AI\_CONTEXT\_MENU\_THREAD[​](#ask_meta_ai_context_menu_thread "Direct link to ASK_META_AI_CONTEXT_MENU_THREAD")

> **ASK\_META\_AI\_CONTEXT\_MENU\_THREAD**: `5`

Defined in: [WAProto/index.d.ts:1645](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1645)

---

<a name="enumeration-botsessionsource"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/enumerations/BotSessionSource](https://baileys.wiki/docs/api/namespaces/proto/enumerations/BotSessionSource)

Defined in: [WAProto/index.d.ts:2104](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2104)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### EMU\_FLASH[​](#emu_flash "Direct link to EMU_FLASH")

> **EMU\_FLASH**: `4`

Defined in: [WAProto/index.d.ts:2109](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2109)

* * *

### EMU\_FLASH\_FOLLOWUP[​](#emu_flash_followup "Direct link to EMU_FLASH_FOLLOWUP")

> **EMU\_FLASH\_FOLLOWUP**: `5`

Defined in: [WAProto/index.d.ts:2110](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2110)

* * *

### NONE[​](#none "Direct link to NONE")

> **NONE**: `0`

Defined in: [WAProto/index.d.ts:2105](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2105)

* * *

### NULL\_STATE[​](#null_state "Direct link to NULL_STATE")

> **NULL\_STATE**: `1`

Defined in: [WAProto/index.d.ts:2106](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2106)

* * *

### TYPEAHEAD[​](#typeahead "Direct link to TYPEAHEAD")

> **TYPEAHEAD**: `2`

Defined in: [WAProto/index.d.ts:2107](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2107)

* * *

### USER\_INPUT[​](#user_input "Direct link to USER_INPUT")

> **USER\_INPUT**: `3`

Defined in: [WAProto/index.d.ts:2108](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2108)

* * *

### VOICE[​](#voice "Direct link to VOICE")

> **VOICE**: `6`

Defined in: [WAProto/index.d.ts:2111](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2111)

---

<a name="enumeration-collectionname"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/enumerations/CollectionName](https://baileys.wiki/docs/api/namespaces/proto/enumerations/CollectionName)

Defined in: [WAProto/index.d.ts:3048](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3048)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### COLLECTION\_NAME\_UNKNOWN[​](#collection_name_unknown "Direct link to COLLECTION_NAME_UNKNOWN")

> **COLLECTION\_NAME\_UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:3049](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3049)

* * *

### CRITICAL\_BLOCK[​](#critical_block "Direct link to CRITICAL_BLOCK")

> **CRITICAL\_BLOCK**: `4`

Defined in: [WAProto/index.d.ts:3053](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3053)

* * *

### CRITICAL\_UNBLOCK\_LOW[​](#critical_unblock_low "Direct link to CRITICAL_UNBLOCK_LOW")

> **CRITICAL\_UNBLOCK\_LOW**: `5`

Defined in: [WAProto/index.d.ts:3054](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3054)

* * *

### REGULAR[​](#regular "Direct link to REGULAR")

> **REGULAR**: `1`

Defined in: [WAProto/index.d.ts:3050](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3050)

* * *

### REGULAR\_HIGH[​](#regular_high "Direct link to REGULAR_HIGH")

> **REGULAR\_HIGH**: `3`

Defined in: [WAProto/index.d.ts:3052](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3052)

* * *

### REGULAR\_LOW[​](#regular_low "Direct link to REGULAR_LOW")

> **REGULAR\_LOW**: `2`

Defined in: [WAProto/index.d.ts:3051](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3051)

---

<a name="enumeration-keeptype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/enumerations/KeepType](https://baileys.wiki/docs/api/namespaces/proto/enumerations/KeepType)

Defined in: [WAProto/index.d.ts:4903](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4903)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### KEEP\_FOR\_ALL[​](#keep_for_all "Direct link to KEEP_FOR_ALL")

> **KEEP\_FOR\_ALL**: `1`

Defined in: [WAProto/index.d.ts:4905](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4905)

* * *

### UNDO\_KEEP\_FOR\_ALL[​](#undo_keep_for_all "Direct link to UNDO_KEEP_FOR_ALL")

> **UNDO\_KEEP\_FOR\_ALL**: `2`

Defined in: [WAProto/index.d.ts:4906](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4906)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:4904](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4904)

---

<a name="enumeration-mediavisibility"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/enumerations/MediaVisibility](https://baileys.wiki/docs/api/namespaces/proto/enumerations/MediaVisibility)

Defined in: [WAProto/index.d.ts:5161](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5161)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### DEFAULT[​](#default "Direct link to DEFAULT")

> **DEFAULT**: `0`

Defined in: [WAProto/index.d.ts:5162](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5162)

* * *

### OFF[​](#off "Direct link to OFF")

> **OFF**: `1`

Defined in: [WAProto/index.d.ts:5163](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5163)

* * *

### ON[​](#on "Direct link to ON")

> **ON**: `2`

Defined in: [WAProto/index.d.ts:5164](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5164)

---

<a name="enumeration-mutationprops"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/enumerations/MutationProps](https://baileys.wiki/docs/api/namespaces/proto/enumerations/MutationProps)

Defined in: [WAProto/index.d.ts:9839](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9839)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AGENT\_ACTION[​](#agent_action "Direct link to AGENT_ACTION")

> **AGENT\_ACTION**: `27`

Defined in: [WAProto/index.d.ts:9861](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9861)

* * *

### AI\_THREAD\_RENAME\_ACTION[​](#ai_thread_rename_action "Direct link to AI_THREAD_RENAME_ACTION")

> **AI\_THREAD\_RENAME\_ACTION**: `76`

Defined in: [WAProto/index.d.ts:9909](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9909)

* * *

### ANDROID\_UNSUPPORTED\_ACTIONS[​](#android_unsupported_actions "Direct link to ANDROID_UNSUPPORTED_ACTIONS")

> **ANDROID\_UNSUPPORTED\_ACTIONS**: `26`

Defined in: [WAProto/index.d.ts:9860](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9860)

* * *

### ARCHIVE\_CHAT\_ACTION[​](#archive_chat_action "Direct link to ARCHIVE_CHAT_ACTION")

> **ARCHIVE\_CHAT\_ACTION**: `17`

Defined in: [WAProto/index.d.ts:9852](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9852)

* * *

### AVATAR\_UPDATED\_ACTION[​](#avatar_updated_action "Direct link to AVATAR_UPDATED_ACTION")

> **AVATAR\_UPDATED\_ACTION**: `72`

Defined in: [WAProto/index.d.ts:9905](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9905)

* * *

### BOT\_WELCOME\_REQUEST\_ACTION[​](#bot_welcome_request_action "Direct link to BOT_WELCOME_REQUEST_ACTION")

> **BOT\_WELCOME\_REQUEST\_ACTION**: `45`

Defined in: [WAProto/index.d.ts:9879](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9879)

* * *

### BUSINESS\_BROADCAST\_ACTION[​](#business_broadcast_action "Direct link to BUSINESS_BROADCAST_ACTION")

> **BUSINESS\_BROADCAST\_ACTION**: `10002`

Defined in: [WAProto/index.d.ts:9912](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9912)

* * *

### BUSINESS\_BROADCAST\_ASSOCIATION\_ACTION[​](#business_broadcast_association_action "Direct link to BUSINESS_BROADCAST_ASSOCIATION_ACTION")

> **BUSINESS\_BROADCAST\_ASSOCIATION\_ACTION**: `65`

Defined in: [WAProto/index.d.ts:9899](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9899)

* * *

### BUSINESS\_BROADCAST\_LIST\_ACTION[​](#business_broadcast_list_action "Direct link to BUSINESS_BROADCAST_LIST_ACTION")

> **BUSINESS\_BROADCAST\_LIST\_ACTION**: `69`

Defined in: [WAProto/index.d.ts:9902](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9902)

* * *

### CALL\_LOG\_ACTION[​](#call_log_action "Direct link to CALL_LOG_ACTION")

> **CALL\_LOG\_ACTION**: `42`

Defined in: [WAProto/index.d.ts:9876](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9876)

* * *

### CHAT\_ASSIGNMENT[​](#chat_assignment "Direct link to CHAT_ASSIGNMENT")

> **CHAT\_ASSIGNMENT**: `35`

Defined in: [WAProto/index.d.ts:9869](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9869)

* * *

### CHAT\_ASSIGNMENT\_OPENED\_STATUS[​](#chat_assignment_opened_status "Direct link to CHAT_ASSIGNMENT_OPENED_STATUS")

> **CHAT\_ASSIGNMENT\_OPENED\_STATUS**: `36`

Defined in: [WAProto/index.d.ts:9870](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9870)

* * *

### CHAT\_LOCK\_SETTINGS[​](#chat_lock_settings "Direct link to CHAT_LOCK_SETTINGS")

> **CHAT\_LOCK\_SETTINGS**: `51`

Defined in: [WAProto/index.d.ts:9885](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9885)

* * *

### CLEAR\_CHAT\_ACTION[​](#clear_chat_action "Direct link to CLEAR_CHAT_ACTION")

> **CLEAR\_CHAT\_ACTION**: `21`

Defined in: [WAProto/index.d.ts:9856](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9856)

* * *

### CONTACT\_ACTION[​](#contact_action "Direct link to CONTACT_ACTION")

> **CONTACT\_ACTION**: `3`

Defined in: [WAProto/index.d.ts:9841](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9841)

* * *

### CTWA\_PER\_CUSTOMER\_DATA\_SHARING\_ACTION[​](#ctwa_per_customer_data_sharing_action "Direct link to CTWA_PER_CUSTOMER_DATA_SHARING_ACTION")

> **CTWA\_PER\_CUSTOMER\_DATA\_SHARING\_ACTION**: `62`

Defined in: [WAProto/index.d.ts:9896](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9896)

* * *

### CUSTOM\_PAYMENT\_METHODS\_ACTION[​](#custom_payment_methods_action "Direct link to CUSTOM_PAYMENT_METHODS_ACTION")

> **CUSTOM\_PAYMENT\_METHODS\_ACTION**: `49`

Defined in: [WAProto/index.d.ts:9883](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9883)

* * *

### DELETE\_CHAT\_ACTION[​](#delete_chat_action "Direct link to DELETE_CHAT_ACTION")

> **DELETE\_CHAT\_ACTION**: `22`

Defined in: [WAProto/index.d.ts:9857](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9857)

* * *

### DELETE\_INDIVIDUAL\_CALL\_LOG[​](#delete_individual_call_log "Direct link to DELETE_INDIVIDUAL_CALL_LOG")

> **DELETE\_INDIVIDUAL\_CALL\_LOG**: `46`

Defined in: [WAProto/index.d.ts:9880](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9880)

* * *

### DELETE\_MESSAGE\_FOR\_ME\_ACTION[​](#delete_message_for_me_action "Direct link to DELETE_MESSAGE_FOR_ME_ACTION")

> **DELETE\_MESSAGE\_FOR\_ME\_ACTION**: `18`

Defined in: [WAProto/index.d.ts:9853](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9853)

* * *

### DETECTED\_OUTCOMES\_STATUS\_ACTION[​](#detected_outcomes_status_action "Direct link to DETECTED_OUTCOMES_STATUS_ACTION")

> **DETECTED\_OUTCOMES\_STATUS\_ACTION**: `66`

Defined in: [WAProto/index.d.ts:9900](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9900)

* * *

### DEVICE\_CAPABILITIES[​](#device_capabilities "Direct link to DEVICE_CAPABILITIES")

> **DEVICE\_CAPABILITIES**: `54`

Defined in: [WAProto/index.d.ts:9888](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9888)

* * *

### EXTERNAL\_WEB\_BETA\_ACTION[​](#external_web_beta_action "Direct link to EXTERNAL_WEB_BETA_ACTION")

> **EXTERNAL\_WEB\_BETA\_ACTION**: `40`

Defined in: [WAProto/index.d.ts:9874](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9874)

* * *

### FAVORITES\_ACTION[​](#favorites_action "Direct link to FAVORITES_ACTION")

> **FAVORITES\_ACTION**: `56`

Defined in: [WAProto/index.d.ts:9890](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9890)

* * *

### GALAXY\_FLOW\_ACTION[​](#galaxy_flow_action "Direct link to GALAXY_FLOW_ACTION")

> **GALAXY\_FLOW\_ACTION**: `73`

Defined in: [WAProto/index.d.ts:9906](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9906)

* * *

### INTERACTIVE\_MESSAGE\_ACTION[​](#interactive_message_action "Direct link to INTERACTIVE_MESSAGE_ACTION")

> **INTERACTIVE\_MESSAGE\_ACTION**: `77`

Defined in: [WAProto/index.d.ts:9910](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9910)

* * *

### KEY\_EXPIRATION[​](#key_expiration "Direct link to KEY_EXPIRATION")

> **KEY\_EXPIRATION**: `19`

Defined in: [WAProto/index.d.ts:9854](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9854)

* * *

### LABEL\_ASSOCIATION\_ACTION[​](#label_association_action "Direct link to LABEL_ASSOCIATION_ACTION")

> **LABEL\_ASSOCIATION\_ACTION**: `15`

Defined in: [WAProto/index.d.ts:9850](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9850)

* * *

### LABEL\_EDIT\_ACTION[​](#label_edit_action "Direct link to LABEL_EDIT_ACTION")

> **LABEL\_EDIT\_ACTION**: `14`

Defined in: [WAProto/index.d.ts:9849](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9849)

* * *

### LABEL\_MESSAGE\_ACTION[​](#label_message_action "Direct link to LABEL_MESSAGE_ACTION")

> **LABEL\_MESSAGE\_ACTION**: `13`

Defined in: [WAProto/index.d.ts:9848](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9848)

* * *

### LABEL\_REORDERING\_ACTION[​](#label_reordering_action "Direct link to LABEL_REORDERING_ACTION")

> **LABEL\_REORDERING\_ACTION**: `47`

Defined in: [WAProto/index.d.ts:9881](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9881)

* * *

### LID\_CONTACT\_ACTION[​](#lid_contact_action "Direct link to LID_CONTACT_ACTION")

> **LID\_CONTACT\_ACTION**: `61`

Defined in: [WAProto/index.d.ts:9895](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9895)

* * *

### LOCALE\_SETTING[​](#locale_setting "Direct link to LOCALE_SETTING")

> **LOCALE\_SETTING**: `16`

Defined in: [WAProto/index.d.ts:9851](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9851)

* * *

### LOCK\_CHAT\_ACTION[​](#lock_chat_action "Direct link to LOCK_CHAT_ACTION")

> **LOCK\_CHAT\_ACTION**: `50`

Defined in: [WAProto/index.d.ts:9884](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9884)

* * *

### MAIBA\_AI\_FEATURES\_CONTROL\_ACTION[​](#maiba_ai_features_control_action "Direct link to MAIBA_AI_FEATURES_CONTROL_ACTION")

> **MAIBA\_AI\_FEATURES\_CONTROL\_ACTION**: `68`

Defined in: [WAProto/index.d.ts:9901](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9901)

* * *

### MARK\_CHAT\_AS\_READ\_ACTION[​](#mark_chat_as_read_action "Direct link to MARK_CHAT_AS_READ_ACTION")

> **MARK\_CHAT\_AS\_READ\_ACTION**: `20`

Defined in: [WAProto/index.d.ts:9855](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9855)

* * *

### MARKETING\_MESSAGE\_ACTION[​](#marketing_message_action "Direct link to MARKETING_MESSAGE_ACTION")

> **MARKETING\_MESSAGE\_ACTION**: `38`

Defined in: [WAProto/index.d.ts:9872](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9872)

* * *

### MARKETING\_MESSAGE\_BROADCAST\_ACTION[​](#marketing_message_broadcast_action "Direct link to MARKETING_MESSAGE_BROADCAST_ACTION")

> **MARKETING\_MESSAGE\_BROADCAST\_ACTION**: `39`

Defined in: [WAProto/index.d.ts:9873](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9873)

* * *

### MERCHANT\_PAYMENT\_PARTNER\_ACTION[​](#merchant_payment_partner_action "Direct link to MERCHANT_PAYMENT_PARTNER_ACTION")

> **MERCHANT\_PAYMENT\_PARTNER\_ACTION**: `57`

Defined in: [WAProto/index.d.ts:9891](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9891)

* * *

### MUSIC\_USER\_ID\_ACTION[​](#music_user_id_action "Direct link to MUSIC_USER_ID_ACTION")

> **MUSIC\_USER\_ID\_ACTION**: `70`

Defined in: [WAProto/index.d.ts:9903](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9903)

* * *

### MUTE\_ACTION[​](#mute_action "Direct link to MUTE_ACTION")

> **MUTE\_ACTION**: `4`

Defined in: [WAProto/index.d.ts:9842](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9842)

* * *

### NEWSLETTER\_SAVED\_INTERESTS\_ACTION[​](#newsletter_saved_interests_action "Direct link to NEWSLETTER_SAVED_INTERESTS_ACTION")

> **NEWSLETTER\_SAVED\_INTERESTS\_ACTION**: `75`

Defined in: [WAProto/index.d.ts:9908](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9908)

* * *

### NOTE\_EDIT\_ACTION[​](#note_edit_action "Direct link to NOTE_EDIT_ACTION")

> **NOTE\_EDIT\_ACTION**: `55`

Defined in: [WAProto/index.d.ts:9889](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9889)

* * *

### NOTIFICATION\_ACTIVITY\_SETTING\_ACTION[​](#notification_activity_setting_action "Direct link to NOTIFICATION_ACTIVITY_SETTING_ACTION")

> **NOTIFICATION\_ACTIVITY\_SETTING\_ACTION**: `60`

Defined in: [WAProto/index.d.ts:9894](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9894)

* * *

### NUX\_ACTION[​](#nux_action "Direct link to NUX_ACTION")

> **NUX\_ACTION**: `31`

Defined in: [WAProto/index.d.ts:9865](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9865)

* * *

### PAYMENT\_INFO\_ACTION[​](#payment_info_action "Direct link to PAYMENT_INFO_ACTION")

> **PAYMENT\_INFO\_ACTION**: `48`

Defined in: [WAProto/index.d.ts:9882](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9882)

* * *

### PAYMENT\_TOS\_ACTION[​](#payment_tos_action "Direct link to PAYMENT_TOS_ACTION")

> **PAYMENT\_TOS\_ACTION**: `63`

Defined in: [WAProto/index.d.ts:9897](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9897)

* * *

### PIN\_ACTION[​](#pin_action "Direct link to PIN_ACTION")

> **PIN\_ACTION**: `5`

Defined in: [WAProto/index.d.ts:9843](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9843)

* * *

### PN\_FOR\_LID\_CHAT\_ACTION[​](#pn_for_lid_chat_action "Direct link to PN_FOR_LID_CHAT_ACTION")

> **PN\_FOR\_LID\_CHAT\_ACTION**: `37`

Defined in: [WAProto/index.d.ts:9871](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9871)

* * *

### PRIMARY\_FEATURE[​](#primary_feature "Direct link to PRIMARY_FEATURE")

> **PRIMARY\_FEATURE**: `24`

Defined in: [WAProto/index.d.ts:9859](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9859)

* * *

### PRIMARY\_VERSION\_ACTION[​](#primary_version_action "Direct link to PRIMARY_VERSION_ACTION")

> **PRIMARY\_VERSION\_ACTION**: `32`

Defined in: [WAProto/index.d.ts:9866](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9866)

* * *

### PRIVACY\_SETTING\_CHANNELS\_PERSONALISED\_RECOMMENDATION\_ACTION[​](#privacy_setting_channels_personalised_recommendation_action "Direct link to PRIVACY_SETTING_CHANNELS_PERSONALISED_RECOMMENDATION_ACTION")

> **PRIVACY\_SETTING\_CHANNELS\_PERSONALISED\_RECOMMENDATION\_ACTION**: `64`

Defined in: [WAProto/index.d.ts:9898](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9898)

* * *

### PRIVACY\_SETTING\_DISABLE\_LINK\_PREVIEWS\_ACTION[​](#privacy_setting_disable_link_previews_action "Direct link to PRIVACY_SETTING_DISABLE_LINK_PREVIEWS_ACTION")

> **PRIVACY\_SETTING\_DISABLE\_LINK\_PREVIEWS\_ACTION**: `53`

Defined in: [WAProto/index.d.ts:9887](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9887)

* * *

### PRIVACY\_SETTING\_RELAY\_ALL\_CALLS[​](#privacy_setting_relay_all_calls "Direct link to PRIVACY_SETTING_RELAY_ALL_CALLS")

> **PRIVACY\_SETTING\_RELAY\_ALL\_CALLS**: `41`

Defined in: [WAProto/index.d.ts:9875](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9875)

* * *

### PRIVATE\_PROCESSING\_SETTING\_ACTION[​](#private_processing_setting_action "Direct link to PRIVATE_PROCESSING_SETTING_ACTION")

> **PRIVATE\_PROCESSING\_SETTING\_ACTION**: `74`

Defined in: [WAProto/index.d.ts:9907](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9907)

* * *

### PUSH\_NAME\_SETTING[​](#push_name_setting "Direct link to PUSH_NAME_SETTING")

> **PUSH\_NAME\_SETTING**: `7`

Defined in: [WAProto/index.d.ts:9845](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9845)

* * *

### QUICK\_REPLY\_ACTION[​](#quick_reply_action "Direct link to QUICK_REPLY_ACTION")

> **QUICK\_REPLY\_ACTION**: `8`

Defined in: [WAProto/index.d.ts:9846](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9846)

* * *

### RECENT\_EMOJI\_WEIGHTS\_ACTION[​](#recent_emoji_weights_action "Direct link to RECENT_EMOJI_WEIGHTS_ACTION")

> **RECENT\_EMOJI\_WEIGHTS\_ACTION**: `11`

Defined in: [WAProto/index.d.ts:9847](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9847)

* * *

### REMOVE\_RECENT\_STICKER\_ACTION[​](#remove_recent_sticker_action "Direct link to REMOVE_RECENT_STICKER_ACTION")

> **REMOVE\_RECENT\_STICKER\_ACTION**: `34`

Defined in: [WAProto/index.d.ts:9868](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9868)

* * *

### SECURITY\_NOTIFICATION\_SETTING[​](#security_notification_setting "Direct link to SECURITY_NOTIFICATION_SETTING")

> **SECURITY\_NOTIFICATION\_SETTING**: `6`

Defined in: [WAProto/index.d.ts:9844](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9844)

* * *

### SHARE\_OWN\_PN[​](#share_own_pn "Direct link to SHARE_OWN_PN")

> **SHARE\_OWN\_PN**: `10001`

Defined in: [WAProto/index.d.ts:9911](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9911)

* * *

### STAR\_ACTION[​](#star_action "Direct link to STAR_ACTION")

> **STAR\_ACTION**: `2`

Defined in: [WAProto/index.d.ts:9840](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9840)

* * *

### STATUS\_POST\_OPT\_IN\_NOTIFICATION\_PREFERENCES\_ACTION[​](#status_post_opt_in_notification_preferences_action "Direct link to STATUS_POST_OPT_IN_NOTIFICATION_PREFERENCES_ACTION")

> **STATUS\_POST\_OPT\_IN\_NOTIFICATION\_PREFERENCES\_ACTION**: `71`

Defined in: [WAProto/index.d.ts:9904](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9904)

* * *

### STATUS\_PRIVACY[​](#status_privacy "Direct link to STATUS_PRIVACY")

> **STATUS\_PRIVACY**: `44`

Defined in: [WAProto/index.d.ts:9878](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9878)

* * *

### STICKER\_ACTION[​](#sticker_action "Direct link to STICKER_ACTION")

> **STICKER\_ACTION**: `33`

Defined in: [WAProto/index.d.ts:9867](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9867)

* * *

### SUBSCRIPTION\_ACTION[​](#subscription_action "Direct link to SUBSCRIPTION_ACTION")

> **SUBSCRIPTION\_ACTION**: `28`

Defined in: [WAProto/index.d.ts:9862](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9862)

* * *

### TIME\_FORMAT\_ACTION[​](#time_format_action "Direct link to TIME_FORMAT_ACTION")

> **TIME\_FORMAT\_ACTION**: `30`

Defined in: [WAProto/index.d.ts:9864](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9864)

* * *

### UGC\_BOT[​](#ugc_bot "Direct link to UGC_BOT")

> **UGC\_BOT**: `43`

Defined in: [WAProto/index.d.ts:9877](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9877)

* * *

### UNARCHIVE\_CHATS\_SETTING[​](#unarchive_chats_setting "Direct link to UNARCHIVE_CHATS_SETTING")

> **UNARCHIVE\_CHATS\_SETTING**: `23`

Defined in: [WAProto/index.d.ts:9858](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9858)

* * *

### USER\_STATUS\_MUTE\_ACTION[​](#user_status_mute_action "Direct link to USER_STATUS_MUTE_ACTION")

> **USER\_STATUS\_MUTE\_ACTION**: `29`

Defined in: [WAProto/index.d.ts:9863](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9863)

* * *

### USERNAME\_CHAT\_START\_MODE[​](#username_chat_start_mode "Direct link to USERNAME_CHAT_START_MODE")

> **USERNAME\_CHAT\_START\_MODE**: `59`

Defined in: [WAProto/index.d.ts:9893](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9893)

* * *

### WAFFLE\_ACCOUNT\_LINK\_STATE\_ACTION[​](#waffle_account_link_state_action "Direct link to WAFFLE_ACCOUNT_LINK_STATE_ACTION")

> **WAFFLE\_ACCOUNT\_LINK\_STATE\_ACTION**: `58`

Defined in: [WAProto/index.d.ts:9892](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9892)

* * *

### WAMO\_USER\_IDENTIFIER\_ACTION[​](#wamo_user_identifier_action "Direct link to WAMO_USER_IDENTIFIER_ACTION")

> **WAMO\_USER\_IDENTIFIER\_ACTION**: `52`

Defined in: [WAProto/index.d.ts:9886](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9886)

---

<a name="enumeration-privacysystemmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/enumerations/PrivacySystemMessage](https://baileys.wiki/docs/api/namespaces/proto/enumerations/PrivacySystemMessage)

Defined in: [WAProto/index.d.ts:10523](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10523)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### E2EE\_MSG[​](#e2ee_msg "Direct link to E2EE_MSG")

> **E2EE\_MSG**: `1`

Defined in: [WAProto/index.d.ts:10524](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10524)

* * *

### NE2EE\_OTHER[​](#ne2ee_other "Direct link to NE2EE_OTHER")

> **NE2EE\_OTHER**: `3`

Defined in: [WAProto/index.d.ts:10526](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10526)

* * *

### NE2EE\_SELF[​](#ne2ee_self "Direct link to NE2EE_SELF")

> **NE2EE\_SELF**: `2`

Defined in: [WAProto/index.d.ts:10525](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10525)

---

<a name="enumeration-sessiontransparencytype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/enumerations/SessionTransparencyType](https://baileys.wiki/docs/api/namespaces/proto/enumerations/SessionTransparencyType)

Defined in: [WAProto/index.d.ts:11050](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11050)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### NY\_AI\_SAFETY\_DISCLAIMER[​](#ny_ai_safety_disclaimer "Direct link to NY_AI_SAFETY_DISCLAIMER")

> **NY\_AI\_SAFETY\_DISCLAIMER**: `1`

Defined in: [WAProto/index.d.ts:11052](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11052)

* * *

### UNKNOWN\_TYPE[​](#unknown_type "Direct link to UNKNOWN_TYPE")

> **UNKNOWN\_TYPE**: `0`

Defined in: [WAProto/index.d.ts:11051](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11051)

---

<a name="enumeration-weblinkrenderconfig"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/enumerations/WebLinkRenderConfig](https://baileys.wiki/docs/api/namespaces/proto/enumerations/WebLinkRenderConfig)

Defined in: [WAProto/index.d.ts:13601](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13601)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### SYSTEM[​](#system "Direct link to SYSTEM")

> **SYSTEM**: `1`

Defined in: [WAProto/index.d.ts:13603](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13603)

* * *

### WEBVIEW[​](#webview "Direct link to WEBVIEW")

> **WEBVIEW**: `0`

Defined in: [WAProto/index.d.ts:13602](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13602)

---

<a name="interface-iadvdeviceidentity"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IADVDeviceIdentity](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IADVDeviceIdentity)

Defined in: [WAProto/index.d.ts:5](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5)

## Properties[​](#properties "Direct link to Properties")

### accountType?[​](#accounttype "Direct link to accountType?")

> `optional` **accountType**: `null` | [`ADVEncryptionType`](/docs/api/namespaces/proto/enumerations/ADVEncryptionType)

Defined in: [WAProto/index.d.ts:9](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9)

* * *

### deviceType?[​](#devicetype "Direct link to deviceType?")

> `optional` **deviceType**: `null` | [`ADVEncryptionType`](/docs/api/namespaces/proto/enumerations/ADVEncryptionType)

Defined in: [WAProto/index.d.ts:10](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10)

* * *

### keyIndex?[​](#keyindex "Direct link to keyIndex?")

> `optional` **keyIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:8](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8)

* * *

### rawId?[​](#rawid "Direct link to rawId?")

> `optional` **rawId**: `null` | `number`

Defined in: [WAProto/index.d.ts:6](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7)

---

<a name="interface-iadvkeyindexlist"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IADVKeyIndexList](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IADVKeyIndexList)

Defined in: [WAProto/index.d.ts:34](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L34)

## Properties[​](#properties "Direct link to Properties")

### accountType?[​](#accounttype "Direct link to accountType?")

> `optional` **accountType**: `null` | [`ADVEncryptionType`](/docs/api/namespaces/proto/enumerations/ADVEncryptionType)

Defined in: [WAProto/index.d.ts:39](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L39)

* * *

### currentIndex?[​](#currentindex "Direct link to currentIndex?")

> `optional` **currentIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:37](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L37)

* * *

### rawId?[​](#rawid "Direct link to rawId?")

> `optional` **rawId**: `null` | `number`

Defined in: [WAProto/index.d.ts:35](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L35)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:36](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L36)

* * *

### validIndexes?[​](#validindexes "Direct link to validIndexes?")

> `optional` **validIndexes**: `null` | `number`\[\]

Defined in: [WAProto/index.d.ts:38](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L38)

---

<a name="interface-iadvsigneddeviceidentity"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentity](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentity)

Defined in: [WAProto/index.d.ts:58](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L58)

## Properties[​](#properties "Direct link to Properties")

### accountSignature?[​](#accountsignature "Direct link to accountSignature?")

> `optional` **accountSignature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:61](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L61)

* * *

### accountSignatureKey?[​](#accountsignaturekey "Direct link to accountSignatureKey?")

> `optional` **accountSignatureKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:60](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L60)

* * *

### details?[​](#details "Direct link to details?")

> `optional` **details**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:59](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L59)

* * *

### deviceSignature?[​](#devicesignature "Direct link to deviceSignature?")

> `optional` **deviceSignature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:62](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L62)

---

<a name="interface-iadvsigneddeviceidentityhmac"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentityHMAC](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentityHMAC)

Defined in: [WAProto/index.d.ts:80](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L80)

## Properties[​](#properties "Direct link to Properties")

### accountType?[​](#accounttype "Direct link to accountType?")

> `optional` **accountType**: `null` | [`ADVEncryptionType`](/docs/api/namespaces/proto/enumerations/ADVEncryptionType)

Defined in: [WAProto/index.d.ts:83](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L83)

* * *

### details?[​](#details "Direct link to details?")

> `optional` **details**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:81](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L81)

* * *

### hmac?[​](#hmac "Direct link to hmac?")

> `optional` **hmac**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:82](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L82)

---

<a name="interface-iadvsignedkeyindexlist"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IADVSignedKeyIndexList](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IADVSignedKeyIndexList)

Defined in: [WAProto/index.d.ts:100](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L100)

## Properties[​](#properties "Direct link to Properties")

### accountSignature?[​](#accountsignature "Direct link to accountSignature?")

> `optional` **accountSignature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:102](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L102)

* * *

### accountSignatureKey?[​](#accountsignaturekey "Direct link to accountSignatureKey?")

> `optional` **accountSignatureKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:103](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L103)

* * *

### details?[​](#details "Direct link to details?")

> `optional` **details**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:101](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L101)

---

<a name="interface-iaihomestate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIHomeState](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIHomeState)

Defined in: [WAProto/index.d.ts:120](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L120)

## Properties[​](#properties "Direct link to Properties")

### capabilityOptions?[​](#capabilityoptions "Direct link to capabilityOptions?")

> `optional` **capabilityOptions**: `null` | [`IAIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption)\[\]

Defined in: [WAProto/index.d.ts:122](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L122)

* * *

### conversationOptions?[​](#conversationoptions "Direct link to conversationOptions?")

> `optional` **conversationOptions**: `null` | [`IAIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption)\[\]

Defined in: [WAProto/index.d.ts:123](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L123)

* * *

### lastFetchTime?[​](#lastfetchtime "Direct link to lastFetchTime?")

> `optional` **lastFetchTime**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:121](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L121)

---

<a name="interface-iaiqueryfanout"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIQueryFanout](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIQueryFanout)

Defined in: [WAProto/index.d.ts:181](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L181)

## Properties[​](#properties "Direct link to Properties")

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:183](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L183)

* * *

### messageKey?[​](#messagekey "Direct link to messageKey?")

> `optional` **messageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:182](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L182)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:184](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L184)

---

<a name="interface-iairegeneratemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRegenerateMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRegenerateMetadata)

Defined in: [WAProto/index.d.ts:201](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L201)

## Properties[​](#properties "Direct link to Properties")

### messageKey?[​](#messagekey "Direct link to messageKey?")

> `optional` **messageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:202](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L202)

* * *

### responseTimestampMs?[​](#responsetimestampms "Direct link to responseTimestampMs?")

> `optional` **responseTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:203](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L203)

---

<a name="interface-iairichresponsecodemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseCodeMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseCodeMetadata)

Defined in: [WAProto/index.d.ts:219](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L219)

## Properties[​](#properties "Direct link to Properties")

### codeBlocks?[​](#codeblocks "Direct link to codeBlocks?")

> `optional` **codeBlocks**: `null` | [`IAIRichResponseCodeBlock`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/interfaces/IAIRichResponseCodeBlock)\[\]

Defined in: [WAProto/index.d.ts:221](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L221)

* * *

### codeLanguage?[​](#codelanguage "Direct link to codeLanguage?")

> `optional` **codeLanguage**: `null` | `string`

Defined in: [WAProto/index.d.ts:220](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L220)

---

<a name="interface-iairichresponsecontentitemsmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseContentItemsMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseContentItemsMetadata)

Defined in: [WAProto/index.d.ts:267](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L267)

## Properties[​](#properties "Direct link to Properties")

### contentType?[​](#contenttype "Direct link to contentType?")

> `optional` **contentType**: `null` | [`ContentType`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/enumerations/ContentType)

Defined in: [WAProto/index.d.ts:269](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L269)

* * *

### itemsMetadata?[​](#itemsmetadata "Direct link to itemsMetadata?")

> `optional` **itemsMetadata**: `null` | [`IAIRichResponseContentItemMetadata`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseContentItemMetadata)\[\]

Defined in: [WAProto/index.d.ts:268](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L268)

---

<a name="interface-iairichresponsedynamicmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseDynamicMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseDynamicMetadata)

Defined in: [WAProto/index.d.ts:332](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L332)

## Properties[​](#properties "Direct link to Properties")

### loopCount?[​](#loopcount "Direct link to loopCount?")

> `optional` **loopCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:336](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L336)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`AIRichResponseDynamicMetadataType`](/docs/api/namespaces/proto/namespaces/AIRichResponseDynamicMetadata/enumerations/AIRichResponseDynamicMetadataType)

Defined in: [WAProto/index.d.ts:333](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L333)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:335](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L335)

* * *

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:334](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L334)

---

<a name="interface-iairichresponsegridimagemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseGridImageMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseGridImageMetadata)

Defined in: [WAProto/index.d.ts:363](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L363)

## Properties[​](#properties "Direct link to Properties")

### gridImageUrl?[​](#gridimageurl "Direct link to gridImageUrl?")

> `optional` **gridImageUrl**: `null` | [`IAIRichResponseImageURL`](/docs/api/namespaces/proto/interfaces/IAIRichResponseImageURL)

Defined in: [WAProto/index.d.ts:364](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L364)

* * *

### imageUrls?[​](#imageurls "Direct link to imageUrls?")

> `optional` **imageUrls**: `null` | [`IAIRichResponseImageURL`](/docs/api/namespaces/proto/interfaces/IAIRichResponseImageURL)\[\]

Defined in: [WAProto/index.d.ts:365](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L365)

---

<a name="interface-iairichresponseimageurl"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseImageURL](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseImageURL)

Defined in: [WAProto/index.d.ts:381](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L381)

## Properties[​](#properties "Direct link to Properties")

### imageHighResUrl?[​](#imagehighresurl "Direct link to imageHighResUrl?")

> `optional` **imageHighResUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:383](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L383)

* * *

### imagePreviewUrl?[​](#imagepreviewurl "Direct link to imagePreviewUrl?")

> `optional` **imagePreviewUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:382](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L382)

* * *

### sourceUrl?[​](#sourceurl "Direct link to sourceUrl?")

> `optional` **sourceUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:384](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L384)

---

<a name="interface-iairichresponseinlineimagemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseInlineImageMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseInlineImageMetadata)

Defined in: [WAProto/index.d.ts:401](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L401)

## Properties[​](#properties "Direct link to Properties")

### alignment?[​](#alignment "Direct link to alignment?")

> `optional` **alignment**: `null` | [`AIRichResponseImageAlignment`](/docs/api/namespaces/proto/namespaces/AIRichResponseInlineImageMetadata/enumerations/AIRichResponseImageAlignment)

Defined in: [WAProto/index.d.ts:404](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L404)

* * *

### imageText?[​](#imagetext "Direct link to imageText?")

> `optional` **imageText**: `null` | `string`

Defined in: [WAProto/index.d.ts:403](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L403)

* * *

### imageUrl?[​](#imageurl "Direct link to imageUrl?")

> `optional` **imageUrl**: `null` | [`IAIRichResponseImageURL`](/docs/api/namespaces/proto/interfaces/IAIRichResponseImageURL)

Defined in: [WAProto/index.d.ts:402](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L402)

* * *

### tapLinkUrl?[​](#taplinkurl "Direct link to tapLinkUrl?")

> `optional` **tapLinkUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:405](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L405)

---

<a name="interface-iairichresponselatexmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseLatexMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseLatexMetadata)

Defined in: [WAProto/index.d.ts:432](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L432)

## Properties[​](#properties "Direct link to Properties")

### expressions?[​](#expressions "Direct link to expressions?")

> `optional` **expressions**: `null` | [`IAIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression)\[\]

Defined in: [WAProto/index.d.ts:434](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L434)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:433](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L433)

---

<a name="interface-iairichresponsemapmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata)

Defined in: [WAProto/index.d.ts:485](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L485)

## Properties[​](#properties "Direct link to Properties")

### annotations?[​](#annotations "Direct link to annotations?")

> `optional` **annotations**: `null` | [`IAIRichResponseMapAnnotation`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/interfaces/IAIRichResponseMapAnnotation)\[\]

Defined in: [WAProto/index.d.ts:490](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L490)

* * *

### centerLatitude?[​](#centerlatitude "Direct link to centerLatitude?")

> `optional` **centerLatitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:486](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L486)

* * *

### centerLongitude?[​](#centerlongitude "Direct link to centerLongitude?")

> `optional` **centerLongitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:487](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L487)

* * *

### latitudeDelta?[​](#latitudedelta "Direct link to latitudeDelta?")

> `optional` **latitudeDelta**: `null` | `number`

Defined in: [WAProto/index.d.ts:488](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L488)

* * *

### longitudeDelta?[​](#longitudedelta "Direct link to longitudeDelta?")

> `optional` **longitudeDelta**: `null` | `number`

Defined in: [WAProto/index.d.ts:489](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L489)

* * *

### showInfoList?[​](#showinfolist "Direct link to showInfoList?")

> `optional` **showInfoList**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:491](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L491)

---

<a name="interface-iairichresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseMessage](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseMessage)

Defined in: [WAProto/index.d.ts:538](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L538)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:542](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L542)

* * *

### messageType?[​](#messagetype "Direct link to messageType?")

> `optional` **messageType**: `null` | [`AIRichResponseMessageType`](/docs/api/namespaces/proto/enumerations/AIRichResponseMessageType)

Defined in: [WAProto/index.d.ts:539](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L539)

* * *

### submessages?[​](#submessages "Direct link to submessages?")

> `optional` **submessages**: `null` | [`IAIRichResponseSubMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage)\[\]

Defined in: [WAProto/index.d.ts:540](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L540)

* * *

### unifiedResponse?[​](#unifiedresponse "Direct link to unifiedResponse?")

> `optional` **unifiedResponse**: `null` | [`IAIRichResponseUnifiedResponse`](/docs/api/namespaces/proto/interfaces/IAIRichResponseUnifiedResponse)

Defined in: [WAProto/index.d.ts:541](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L541)

---

<a name="interface-iairichresponsesubmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseSubMessage)

Defined in: [WAProto/index.d.ts:565](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L565)

## Properties[​](#properties "Direct link to Properties")

### codeMetadata?[​](#codemetadata "Direct link to codeMetadata?")

> `optional` **codeMetadata**: `null` | [`IAIRichResponseCodeMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseCodeMetadata)

Defined in: [WAProto/index.d.ts:570](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L570)

* * *

### contentItemsMetadata?[​](#contentitemsmetadata "Direct link to contentItemsMetadata?")

> `optional` **contentItemsMetadata**: `null` | [`IAIRichResponseContentItemsMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseContentItemsMetadata)

Defined in: [WAProto/index.d.ts:575](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L575)

* * *

### dynamicMetadata?[​](#dynamicmetadata "Direct link to dynamicMetadata?")

> `optional` **dynamicMetadata**: `null` | [`IAIRichResponseDynamicMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseDynamicMetadata)

Defined in: [WAProto/index.d.ts:572](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L572)

* * *

### gridImageMetadata?[​](#gridimagemetadata "Direct link to gridImageMetadata?")

> `optional` **gridImageMetadata**: `null` | [`IAIRichResponseGridImageMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseGridImageMetadata)

Defined in: [WAProto/index.d.ts:567](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L567)

* * *

### imageMetadata?[​](#imagemetadata "Direct link to imageMetadata?")

> `optional` **imageMetadata**: `null` | [`IAIRichResponseInlineImageMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseInlineImageMetadata)

Defined in: [WAProto/index.d.ts:569](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L569)

* * *

### latexMetadata?[​](#latexmetadata "Direct link to latexMetadata?")

> `optional` **latexMetadata**: `null` | [`IAIRichResponseLatexMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseLatexMetadata)

Defined in: [WAProto/index.d.ts:573](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L573)

* * *

### mapMetadata?[​](#mapmetadata "Direct link to mapMetadata?")

> `optional` **mapMetadata**: `null` | [`IAIRichResponseMapMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMapMetadata)

Defined in: [WAProto/index.d.ts:574](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L574)

* * *

### messageText?[​](#messagetext "Direct link to messageText?")

> `optional` **messageText**: `null` | `string`

Defined in: [WAProto/index.d.ts:568](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L568)

* * *

### messageType?[​](#messagetype "Direct link to messageType?")

> `optional` **messageType**: `null` | [`AIRichResponseSubMessageType`](/docs/api/namespaces/proto/enumerations/AIRichResponseSubMessageType)

Defined in: [WAProto/index.d.ts:566](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L566)

* * *

### tableMetadata?[​](#tablemetadata "Direct link to tableMetadata?")

> `optional` **tableMetadata**: `null` | [`IAIRichResponseTableMetadata`](/docs/api/namespaces/proto/interfaces/IAIRichResponseTableMetadata)

Defined in: [WAProto/index.d.ts:571](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L571)

---

<a name="interface-iairichresponsetablemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseTableMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseTableMetadata)

Defined in: [WAProto/index.d.ts:612](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L612)

## Properties[​](#properties "Direct link to Properties")

### rows?[​](#rows "Direct link to rows?")

> `optional` **rows**: `null` | [`IAIRichResponseTableRow`](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/interfaces/IAIRichResponseTableRow)\[\]

Defined in: [WAProto/index.d.ts:613](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L613)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:614](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L614)

---

<a name="interface-iairichresponseunifiedresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseUnifiedResponse](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIRichResponseUnifiedResponse)

Defined in: [WAProto/index.d.ts:651](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L651)

## Properties[​](#properties "Direct link to Properties")

### data?[​](#data "Direct link to data?")

> `optional` **data**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:652](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L652)

---

<a name="interface-iaithreadinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIThreadInfo](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAIThreadInfo)

Defined in: [WAProto/index.d.ts:667](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L667)

## Properties[​](#properties "Direct link to Properties")

### clientInfo?[​](#clientinfo "Direct link to clientInfo?")

> `optional` **clientInfo**: `null` | [`IAIThreadClientInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadClientInfo)

Defined in: [WAProto/index.d.ts:669](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L669)

* * *

### serverInfo?[​](#serverinfo "Direct link to serverInfo?")

> `optional` **serverInfo**: `null` | [`IAIThreadServerInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadServerInfo)

Defined in: [WAProto/index.d.ts:668](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L668)

---

<a name="interface-iaccount"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAccount](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAccount)

Defined in: [WAProto/index.d.ts:729](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L729)

## Properties[​](#properties "Direct link to Properties")

### countryCode?[​](#countrycode "Direct link to countryCode?")

> `optional` **countryCode**: `null` | `string`

Defined in: [WAProto/index.d.ts:732](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L732)

* * *

### isUsernameDeleted?[​](#isusernamedeleted "Direct link to isUsernameDeleted?")

> `optional` **isUsernameDeleted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:733](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L733)

* * *

### lid?[​](#lid "Direct link to lid?")

> `optional` **lid**: `null` | `string`

Defined in: [WAProto/index.d.ts:730](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L730)

* * *

### username?[​](#username "Direct link to username?")

> `optional` **username**: `null` | `string`

Defined in: [WAProto/index.d.ts:731](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L731)

---

<a name="interface-iactionlink"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IActionLink](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IActionLink)

Defined in: [WAProto/index.d.ts:751](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L751)

## Properties[​](#properties "Direct link to Properties")

### buttonTitle?[​](#buttontitle "Direct link to buttonTitle?")

> `optional` **buttonTitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:753](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L753)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:752](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L752)

---

<a name="interface-iautodownloadsettings"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings)

Defined in: [WAProto/index.d.ts:769](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L769)

## Properties[​](#properties "Direct link to Properties")

### downloadAudio?[​](#downloadaudio "Direct link to downloadAudio?")

> `optional` **downloadAudio**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:771](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L771)

* * *

### downloadDocuments?[​](#downloaddocuments "Direct link to downloadDocuments?")

> `optional` **downloadDocuments**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:773](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L773)

* * *

### downloadImages?[​](#downloadimages "Direct link to downloadImages?")

> `optional` **downloadImages**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:770](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L770)

* * *

### downloadVideo?[​](#downloadvideo "Direct link to downloadVideo?")

> `optional` **downloadVideo**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:772](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L772)

---

<a name="interface-iavatarusersettings"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAvatarUserSettings](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IAvatarUserSettings)

Defined in: [WAProto/index.d.ts:791](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L791)

## Properties[​](#properties "Direct link to Properties")

### fbid?[​](#fbid "Direct link to fbid?")

> `optional` **fbid**: `null` | `string`

Defined in: [WAProto/index.d.ts:792](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L792)

* * *

### password?[​](#password "Direct link to password?")

> `optional` **password**: `null` | `string`

Defined in: [WAProto/index.d.ts:793](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L793)

---

<a name="interface-ibizaccountlinkinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBizAccountLinkInfo](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBizAccountLinkInfo)

Defined in: [WAProto/index.d.ts:809](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L809)

## Properties[​](#properties "Direct link to Properties")

### accountType?[​](#accounttype "Direct link to accountType?")

> `optional` **accountType**: `null` | [`ENTERPRISE`](/docs/api/namespaces/proto/namespaces/BizAccountLinkInfo/enumerations/AccountType#enterprise)

Defined in: [WAProto/index.d.ts:814](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L814)

* * *

### hostStorage?[​](#hoststorage "Direct link to hostStorage?")

> `optional` **hostStorage**: `null` | [`HostStorageType`](/docs/api/namespaces/proto/namespaces/BizAccountLinkInfo/enumerations/HostStorageType)

Defined in: [WAProto/index.d.ts:813](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L813)

* * *

### issueTime?[​](#issuetime "Direct link to issueTime?")

> `optional` **issueTime**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:812](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L812)

* * *

### whatsappAcctNumber?[​](#whatsappacctnumber "Direct link to whatsappAcctNumber?")

> `optional` **whatsappAcctNumber**: `null` | `string`

Defined in: [WAProto/index.d.ts:811](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L811)

* * *

### whatsappBizAcctFbid?[​](#whatsappbizacctfbid "Direct link to whatsappBizAcctFbid?")

> `optional` **whatsappBizAcctFbid**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:810](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L810)

---

<a name="interface-ibizaccountpayload"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBizAccountPayload](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBizAccountPayload)

Defined in: [WAProto/index.d.ts:845](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L845)

## Properties[​](#properties "Direct link to Properties")

### bizAcctLinkInfo?[​](#bizacctlinkinfo "Direct link to bizAcctLinkInfo?")

> `optional` **bizAcctLinkInfo**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:847](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L847)

* * *

### vnameCert?[​](#vnamecert "Direct link to vnameCert?")

> `optional` **vnameCert**: `null` | [`IVerifiedNameCertificate`](/docs/api/namespaces/proto/interfaces/IVerifiedNameCertificate)

Defined in: [WAProto/index.d.ts:846](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L846)

---

<a name="interface-ibizidentityinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBizIdentityInfo](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBizIdentityInfo)

Defined in: [WAProto/index.d.ts:863](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L863)

## Properties[​](#properties "Direct link to Properties")

### actualActors?[​](#actualactors "Direct link to actualActors?")

> `optional` **actualActors**: `null` | [`ActualActorsType`](/docs/api/namespaces/proto/namespaces/BizIdentityInfo/enumerations/ActualActorsType)

Defined in: [WAProto/index.d.ts:869](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L869)

* * *

### featureControls?[​](#featurecontrols "Direct link to featureControls?")

> `optional` **featureControls**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:871](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L871)

* * *

### hostStorage?[​](#hoststorage "Direct link to hostStorage?")

> `optional` **hostStorage**: `null` | [`HostStorageType`](/docs/api/namespaces/proto/namespaces/BizIdentityInfo/enumerations/HostStorageType)

Defined in: [WAProto/index.d.ts:868](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L868)

* * *

### privacyModeTs?[​](#privacymodets "Direct link to privacyModeTs?")

> `optional` **privacyModeTs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:870](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L870)

* * *

### revoked?[​](#revoked "Direct link to revoked?")

> `optional` **revoked**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:867](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L867)

* * *

### signed?[​](#signed "Direct link to signed?")

> `optional` **signed**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:866](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L866)

* * *

### vlevel?[​](#vlevel "Direct link to vlevel?")

> `optional` **vlevel**: `null` | [`VerifiedLevelValue`](/docs/api/namespaces/proto/namespaces/BizIdentityInfo/enumerations/VerifiedLevelValue)

Defined in: [WAProto/index.d.ts:864](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L864)

* * *

### vnameCert?[​](#vnamecert "Direct link to vnameCert?")

> `optional` **vnameCert**: `null` | [`IVerifiedNameCertificate`](/docs/api/namespaces/proto/interfaces/IVerifiedNameCertificate)

Defined in: [WAProto/index.d.ts:865](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L865)

---

<a name="interface-ibotagecollectionmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotAgeCollectionMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotAgeCollectionMetadata)

Defined in: [WAProto/index.d.ts:912](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L912)

## Properties[​](#properties "Direct link to Properties")

### ageCollectionEligible?[​](#agecollectioneligible "Direct link to ageCollectionEligible?")

> `optional` **ageCollectionEligible**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:913](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L913)

* * *

### ageCollectionType?[​](#agecollectiontype "Direct link to ageCollectionType?")

> `optional` **ageCollectionType**: `null` | [`AgeCollectionType`](/docs/api/namespaces/proto/namespaces/BotAgeCollectionMetadata/enumerations/AgeCollectionType)

Defined in: [WAProto/index.d.ts:915](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L915)

* * *

### shouldTriggerAgeCollectionOnClient?[​](#shouldtriggeragecollectiononclient "Direct link to shouldTriggerAgeCollectionOnClient?")

> `optional` **shouldTriggerAgeCollectionOnClient**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:914](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L914)

---

<a name="interface-ibotavatarmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotAvatarMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotAvatarMetadata)

Defined in: [WAProto/index.d.ts:940](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L940)

## Properties[​](#properties "Direct link to Properties")

### action?[​](#action "Direct link to action?")

> `optional` **action**: `null` | `number`

Defined in: [WAProto/index.d.ts:943](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L943)

* * *

### behaviorGraph?[​](#behaviorgraph "Direct link to behaviorGraph?")

> `optional` **behaviorGraph**: `null` | `string`

Defined in: [WAProto/index.d.ts:942](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L942)

* * *

### intensity?[​](#intensity "Direct link to intensity?")

> `optional` **intensity**: `null` | `number`

Defined in: [WAProto/index.d.ts:944](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L944)

* * *

### sentiment?[​](#sentiment "Direct link to sentiment?")

> `optional` **sentiment**: `null` | `number`

Defined in: [WAProto/index.d.ts:941](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L941)

* * *

### wordCount?[​](#wordcount "Direct link to wordCount?")

> `optional` **wordCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:945](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L945)

---

<a name="interface-ibotcapabilitymetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotCapabilityMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotCapabilityMetadata)

Defined in: [WAProto/index.d.ts:964](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L964)

## Properties[​](#properties "Direct link to Properties")

### capabilities?[​](#capabilities "Direct link to capabilities?")

> `optional` **capabilities**: `null` | [`BotCapabilityType`](/docs/api/namespaces/proto/namespaces/BotCapabilityMetadata/enumerations/BotCapabilityType)\[\]

Defined in: [WAProto/index.d.ts:965](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L965)

---

<a name="interface-ibotfeedbackmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage)

Defined in: [WAProto/index.d.ts:1036](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1036)

## Properties[​](#properties "Direct link to Properties")

### kind?[​](#kind "Direct link to kind?")

> `optional` **kind**: `null` | [`BotFeedbackKind`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/enumerations/BotFeedbackKind)

Defined in: [WAProto/index.d.ts:1038](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1038)

* * *

### kindNegative?[​](#kindnegative "Direct link to kindNegative?")

> `optional` **kindNegative**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:1040](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1040)

* * *

### kindPositive?[​](#kindpositive "Direct link to kindPositive?")

> `optional` **kindPositive**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:1041](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1041)

* * *

### kindReport?[​](#kindreport "Direct link to kindReport?")

> `optional` **kindReport**: `null` | [`ReportKind`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/enumerations/ReportKind)

Defined in: [WAProto/index.d.ts:1042](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1042)

* * *

### messageKey?[​](#messagekey "Direct link to messageKey?")

> `optional` **messageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:1037](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1037)

* * *

### sideBySideSurveyMetadata?[​](#sidebysidesurveymetadata "Direct link to sideBySideSurveyMetadata?")

> `optional` **sideBySideSurveyMetadata**: `null` | [`ISideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata)

Defined in: [WAProto/index.d.ts:1043](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1043)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:1039](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1039)

---

<a name="interface-ibotimaginemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotImagineMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotImagineMetadata)

Defined in: [WAProto/index.d.ts:1278](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1278)

## Properties[​](#properties "Direct link to Properties")

### imagineType?[​](#imaginetype "Direct link to imagineType?")

> `optional` **imagineType**: `null` | [`ImagineType`](/docs/api/namespaces/proto/namespaces/BotImagineMetadata/enumerations/ImagineType)

Defined in: [WAProto/index.d.ts:1279](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1279)

---

<a name="interface-ibotlinkedaccount"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotLinkedAccount](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotLinkedAccount)

Defined in: [WAProto/index.d.ts:1305](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1305)

## Properties[​](#properties "Direct link to Properties")

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`BOT_LINKED_ACCOUNT_TYPE_1P`](/docs/api/namespaces/proto/namespaces/BotLinkedAccount/enumerations/BotLinkedAccountType#bot_linked_account_type_1p)

Defined in: [WAProto/index.d.ts:1306](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1306)

---

<a name="interface-ibotlinkedaccountsmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotLinkedAccountsMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotLinkedAccountsMetadata)

Defined in: [WAProto/index.d.ts:1328](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1328)

## Properties[​](#properties "Direct link to Properties")

### acAuthTokens?[​](#acauthtokens "Direct link to acAuthTokens?")

> `optional` **acAuthTokens**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:1330](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1330)

* * *

### accounts?[​](#accounts "Direct link to accounts?")

> `optional` **accounts**: `null` | [`IBotLinkedAccount`](/docs/api/namespaces/proto/interfaces/IBotLinkedAccount)\[\]

Defined in: [WAProto/index.d.ts:1329](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1329)

* * *

### acErrorCode?[​](#acerrorcode "Direct link to acErrorCode?")

> `optional` **acErrorCode**: `null` | `number`

Defined in: [WAProto/index.d.ts:1331](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1331)

---

<a name="interface-ibotmediametadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotMediaMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotMediaMetadata)

Defined in: [WAProto/index.d.ts:1348](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1348)

## Properties[​](#properties "Direct link to Properties")

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:1352](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1352)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `string`

Defined in: [WAProto/index.d.ts:1351](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1351)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `string`

Defined in: [WAProto/index.d.ts:1349](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1349)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `string`

Defined in: [WAProto/index.d.ts:1350](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1350)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:1353](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1353)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:1354](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1354)

* * *

### orientationType?[​](#orientationtype "Direct link to orientationType?")

> `optional` **orientationType**: `null` | [`OrientationType`](/docs/api/namespaces/proto/namespaces/BotMediaMetadata/enumerations/OrientationType)

Defined in: [WAProto/index.d.ts:1355](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1355)

---

<a name="interface-ibotmemoryfact"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotMemoryFact](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotMemoryFact)

Defined in: [WAProto/index.d.ts:1385](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1385)

## Properties[​](#properties "Direct link to Properties")

### fact?[​](#fact "Direct link to fact?")

> `optional` **fact**: `null` | `string`

Defined in: [WAProto/index.d.ts:1386](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1386)

* * *

### factId?[​](#factid "Direct link to factId?")

> `optional` **factId**: `null` | `string`

Defined in: [WAProto/index.d.ts:1387](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1387)

---

<a name="interface-ibotmemorymetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotMemoryMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotMemoryMetadata)

Defined in: [WAProto/index.d.ts:1403](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1403)

## Properties[​](#properties "Direct link to Properties")

### addedFacts?[​](#addedfacts "Direct link to addedFacts?")

> `optional` **addedFacts**: `null` | [`IBotMemoryFact`](/docs/api/namespaces/proto/interfaces/IBotMemoryFact)\[\]

Defined in: [WAProto/index.d.ts:1404](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1404)

* * *

### disclaimer?[​](#disclaimer "Direct link to disclaimer?")

> `optional` **disclaimer**: `null` | `string`

Defined in: [WAProto/index.d.ts:1406](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1406)

* * *

### removedFacts?[​](#removedfacts "Direct link to removedFacts?")

> `optional` **removedFacts**: `null` | [`IBotMemoryFact`](/docs/api/namespaces/proto/interfaces/IBotMemoryFact)\[\]

Defined in: [WAProto/index.d.ts:1405](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1405)

---

<a name="interface-ibotmemumetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotMemuMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotMemuMetadata)

Defined in: [WAProto/index.d.ts:1423](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1423)

## Properties[​](#properties "Direct link to Properties")

### faceImages?[​](#faceimages "Direct link to faceImages?")

> `optional` **faceImages**: `null` | [`IBotMediaMetadata`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata)\[\]

Defined in: [WAProto/index.d.ts:1424](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1424)

---

<a name="interface-ibotmessageorigin"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotMessageOrigin](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotMessageOrigin)

Defined in: [WAProto/index.d.ts:1439](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1439)

## Properties[​](#properties "Direct link to Properties")

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`BOT_MESSAGE_ORIGIN_TYPE_AI_INITIATED`](/docs/api/namespaces/proto/namespaces/BotMessageOrigin/enumerations/BotMessageOriginType#bot_message_origin_type_ai_initiated)

Defined in: [WAProto/index.d.ts:1440](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1440)

---

<a name="interface-ibotmessageoriginmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotMessageOriginMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotMessageOriginMetadata)

Defined in: [WAProto/index.d.ts:1462](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1462)

## Properties[​](#properties "Direct link to Properties")

### origins?[​](#origins "Direct link to origins?")

> `optional` **origins**: `null` | [`IBotMessageOrigin`](/docs/api/namespaces/proto/interfaces/IBotMessageOrigin)\[\]

Defined in: [WAProto/index.d.ts:1463](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1463)

---

<a name="interface-ibotmessagesharinginfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotMessageSharingInfo](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotMessageSharingInfo)

Defined in: [WAProto/index.d.ts:1478](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1478)

## Properties[​](#properties "Direct link to Properties")

### botEntryPointOrigin?[​](#botentrypointorigin "Direct link to botEntryPointOrigin?")

> `optional` **botEntryPointOrigin**: `null` | [`BotMetricsEntryPoint`](/docs/api/namespaces/proto/enumerations/BotMetricsEntryPoint)

Defined in: [WAProto/index.d.ts:1479](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1479)

* * *

### forwardScore?[​](#forwardscore "Direct link to forwardScore?")

> `optional` **forwardScore**: `null` | `number`

Defined in: [WAProto/index.d.ts:1480](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1480)

---

<a name="interface-ibotmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotMetadata)

Defined in: [WAProto/index.d.ts:1496](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1496)

## Properties[​](#properties "Direct link to Properties")

### aiConversationContext?[​](#aiconversationcontext "Direct link to aiConversationContext?")

> `optional` **aiConversationContext**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:1516](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1516)

* * *

### avatarMetadata?[​](#avatarmetadata "Direct link to avatarMetadata?")

> `optional` **avatarMetadata**: `null` | [`IBotAvatarMetadata`](/docs/api/namespaces/proto/interfaces/IBotAvatarMetadata)

Defined in: [WAProto/index.d.ts:1497](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1497)

* * *

### botAgeCollectionMetadata?[​](#botagecollectionmetadata "Direct link to botAgeCollectionMetadata?")

> `optional` **botAgeCollectionMetadata**: `null` | [`IBotAgeCollectionMetadata`](/docs/api/namespaces/proto/interfaces/IBotAgeCollectionMetadata)

Defined in: [WAProto/index.d.ts:1520](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1520)

* * *

### botLinkedAccountsMetadata?[​](#botlinkedaccountsmetadata "Direct link to botLinkedAccountsMetadata?")

> `optional` **botLinkedAccountsMetadata**: `null` | [`IBotLinkedAccountsMetadata`](/docs/api/namespaces/proto/interfaces/IBotLinkedAccountsMetadata)

Defined in: [WAProto/index.d.ts:1514](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1514)

* * *

### botMessageOriginMetadata?[​](#botmessageoriginmetadata "Direct link to botMessageOriginMetadata?")

> `optional` **botMessageOriginMetadata**: `null` | [`IBotMessageOriginMetadata`](/docs/api/namespaces/proto/interfaces/IBotMessageOriginMetadata)

Defined in: [WAProto/index.d.ts:1525](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1525)

* * *

### botMetricsMetadata?[​](#botmetricsmetadata "Direct link to botMetricsMetadata?")

> `optional` **botMetricsMetadata**: `null` | [`IBotMetricsMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetricsMetadata)

Defined in: [WAProto/index.d.ts:1513](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1513)

* * *

### botModeSelectionMetadata?[​](#botmodeselectionmetadata "Direct link to botModeSelectionMetadata?")

> `optional` **botModeSelectionMetadata**: `null` | [`IBotModeSelectionMetadata`](/docs/api/namespaces/proto/interfaces/IBotModeSelectionMetadata)

Defined in: [WAProto/index.d.ts:1518](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1518)

* * *

### botPromotionMessageMetadata?[​](#botpromotionmessagemetadata "Direct link to botPromotionMessageMetadata?")

> `optional` **botPromotionMessageMetadata**: `null` | [`IBotPromotionMessageMetadata`](/docs/api/namespaces/proto/interfaces/IBotPromotionMessageMetadata)

Defined in: [WAProto/index.d.ts:1517](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1517)

* * *

### botQuotaMetadata?[​](#botquotametadata "Direct link to botQuotaMetadata?")

> `optional` **botQuotaMetadata**: `null` | [`IBotQuotaMetadata`](/docs/api/namespaces/proto/interfaces/IBotQuotaMetadata)

Defined in: [WAProto/index.d.ts:1519](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1519)

* * *

### botResponseId?[​](#botresponseid "Direct link to botResponseId?")

> `optional` **botResponseId**: `null` | `string`

Defined in: [WAProto/index.d.ts:1522](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1522)

* * *

### botThreadInfo?[​](#botthreadinfo "Direct link to botThreadInfo?")

> `optional` **botThreadInfo**: `null` | [`IAIThreadInfo`](/docs/api/namespaces/proto/interfaces/IAIThreadInfo)

Defined in: [WAProto/index.d.ts:1527](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1527)

* * *

### capabilityMetadata?[​](#capabilitymetadata "Direct link to capabilityMetadata?")

> `optional` **capabilityMetadata**: `null` | [`IBotCapabilityMetadata`](/docs/api/namespaces/proto/interfaces/IBotCapabilityMetadata)

Defined in: [WAProto/index.d.ts:1509](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1509)

* * *

### conversationStarterPromptId?[​](#conversationstarterpromptid "Direct link to conversationStarterPromptId?")

> `optional` **conversationStarterPromptId**: `null` | `string`

Defined in: [WAProto/index.d.ts:1521](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1521)

* * *

### imagineMetadata?[​](#imaginemetadata "Direct link to imagineMetadata?")

> `optional` **imagineMetadata**: `null` | [`IBotImagineMetadata`](/docs/api/namespaces/proto/interfaces/IBotImagineMetadata)

Defined in: [WAProto/index.d.ts:1510](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1510)

* * *

### internalMetadata?[​](#internalmetadata "Direct link to internalMetadata?")

> `optional` **internalMetadata**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:1530](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1530)

* * *

### inThreadSurveyMetadata?[​](#inthreadsurveymetadata "Direct link to inThreadSurveyMetadata?")

> `optional` **inThreadSurveyMetadata**: `null` | [`IInThreadSurveyMetadata`](/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata)

Defined in: [WAProto/index.d.ts:1526](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1526)

* * *

### invokerJid?[​](#invokerjid "Direct link to invokerJid?")

> `optional` **invokerJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:1501](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1501)

* * *

### memoryMetadata?[​](#memorymetadata "Direct link to memoryMetadata?")

> `optional` **memoryMetadata**: `null` | [`IBotMemoryMetadata`](/docs/api/namespaces/proto/interfaces/IBotMemoryMetadata)

Defined in: [WAProto/index.d.ts:1511](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1511)

* * *

### memuMetadata?[​](#memumetadata "Direct link to memuMetadata?")

> `optional` **memuMetadata**: `null` | [`IBotMemuMetadata`](/docs/api/namespaces/proto/interfaces/IBotMemuMetadata)

Defined in: [WAProto/index.d.ts:1503](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1503)

* * *

### messageDisclaimerText?[​](#messagedisclaimertext "Direct link to messageDisclaimerText?")

> `optional` **messageDisclaimerText**: `null` | `string`

Defined in: [WAProto/index.d.ts:1507](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1507)

* * *

### modelMetadata?[​](#modelmetadata "Direct link to modelMetadata?")

> `optional` **modelMetadata**: `null` | [`IBotModelMetadata`](/docs/api/namespaces/proto/interfaces/IBotModelMetadata)

Defined in: [WAProto/index.d.ts:1506](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1506)

* * *

### personaId?[​](#personaid "Direct link to personaId?")

> `optional` **personaId**: `null` | `string`

Defined in: [WAProto/index.d.ts:1498](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1498)

* * *

### pluginMetadata?[​](#pluginmetadata "Direct link to pluginMetadata?")

> `optional` **pluginMetadata**: `null` | [`IBotPluginMetadata`](/docs/api/namespaces/proto/interfaces/IBotPluginMetadata)

Defined in: [WAProto/index.d.ts:1499](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1499)

* * *

### progressIndicatorMetadata?[​](#progressindicatormetadata "Direct link to progressIndicatorMetadata?")

> `optional` **progressIndicatorMetadata**: `null` | [`IBotProgressIndicatorMetadata`](/docs/api/namespaces/proto/interfaces/IBotProgressIndicatorMetadata)

Defined in: [WAProto/index.d.ts:1508](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1508)

* * *

### regenerateMetadata?[​](#regeneratemetadata "Direct link to regenerateMetadata?")

> `optional` **regenerateMetadata**: `null` | [`IAIRegenerateMetadata`](/docs/api/namespaces/proto/interfaces/IAIRegenerateMetadata)

Defined in: [WAProto/index.d.ts:1528](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1528)

* * *

### reminderMetadata?[​](#remindermetadata "Direct link to reminderMetadata?")

> `optional` **reminderMetadata**: `null` | [`IBotReminderMetadata`](/docs/api/namespaces/proto/interfaces/IBotReminderMetadata)

Defined in: [WAProto/index.d.ts:1505](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1505)

* * *

### renderingMetadata?[​](#renderingmetadata "Direct link to renderingMetadata?")

> `optional` **renderingMetadata**: `null` | [`IBotRenderingMetadata`](/docs/api/namespaces/proto/interfaces/IBotRenderingMetadata)

Defined in: [WAProto/index.d.ts:1512](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1512)

* * *

### richResponseSourcesMetadata?[​](#richresponsesourcesmetadata "Direct link to richResponseSourcesMetadata?")

> `optional` **richResponseSourcesMetadata**: `null` | [`IBotSourcesMetadata`](/docs/api/namespaces/proto/interfaces/IBotSourcesMetadata)

Defined in: [WAProto/index.d.ts:1515](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1515)

* * *

### sessionMetadata?[​](#sessionmetadata "Direct link to sessionMetadata?")

> `optional` **sessionMetadata**: `null` | [`IBotSessionMetadata`](/docs/api/namespaces/proto/interfaces/IBotSessionMetadata)

Defined in: [WAProto/index.d.ts:1502](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1502)

* * *

### sessionTransparencyMetadata?[​](#sessiontransparencymetadata "Direct link to sessionTransparencyMetadata?")

> `optional` **sessionTransparencyMetadata**: `null` | [`ISessionTransparencyMetadata`](/docs/api/namespaces/proto/interfaces/ISessionTransparencyMetadata)

Defined in: [WAProto/index.d.ts:1529](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1529)

* * *

### suggestedPromptMetadata?[​](#suggestedpromptmetadata "Direct link to suggestedPromptMetadata?")

> `optional` **suggestedPromptMetadata**: `null` | [`IBotSuggestedPromptMetadata`](/docs/api/namespaces/proto/interfaces/IBotSuggestedPromptMetadata)

Defined in: [WAProto/index.d.ts:1500](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1500)

* * *

### timezone?[​](#timezone "Direct link to timezone?")

> `optional` **timezone**: `null` | `string`

Defined in: [WAProto/index.d.ts:1504](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1504)

* * *

### unifiedResponseMutation?[​](#unifiedresponsemutation "Direct link to unifiedResponseMutation?")

> `optional` **unifiedResponseMutation**: `null` | [`IBotUnifiedResponseMutation`](/docs/api/namespaces/proto/interfaces/IBotUnifiedResponseMutation)

Defined in: [WAProto/index.d.ts:1524](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1524)

* * *

### verificationMetadata?[​](#verificationmetadata "Direct link to verificationMetadata?")

> `optional` **verificationMetadata**: `null` | [`IBotSignatureVerificationMetadata`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationMetadata)

Defined in: [WAProto/index.d.ts:1523](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1523)

---

<a name="interface-ibotmetricsmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotMetricsMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotMetricsMetadata)

Defined in: [WAProto/index.d.ts:1620](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1620)

## Properties[​](#properties "Direct link to Properties")

### destinationEntryPoint?[​](#destinationentrypoint "Direct link to destinationEntryPoint?")

> `optional` **destinationEntryPoint**: `null` | [`BotMetricsEntryPoint`](/docs/api/namespaces/proto/enumerations/BotMetricsEntryPoint)

Defined in: [WAProto/index.d.ts:1622](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1622)

* * *

### destinationId?[​](#destinationid "Direct link to destinationId?")

> `optional` **destinationId**: `null` | `string`

Defined in: [WAProto/index.d.ts:1621](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1621)

* * *

### threadOrigin?[​](#threadorigin "Direct link to threadOrigin?")

> `optional` **threadOrigin**: `null` | [`BotMetricsThreadEntryPoint`](/docs/api/namespaces/proto/enumerations/BotMetricsThreadEntryPoint)

Defined in: [WAProto/index.d.ts:1623](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1623)

---

<a name="interface-ibotmodeselectionmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotModeSelectionMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotModeSelectionMetadata)

Defined in: [WAProto/index.d.ts:1648](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1648)

## Properties[​](#properties "Direct link to Properties")

### mode?[​](#mode "Direct link to mode?")

> `optional` **mode**: `null` | [`BotUserSelectionMode`](/docs/api/namespaces/proto/namespaces/BotModeSelectionMetadata/enumerations/BotUserSelectionMode)\[\]

Defined in: [WAProto/index.d.ts:1649](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1649)

---

<a name="interface-ibotmodelmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotModelMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotModelMetadata)

Defined in: [WAProto/index.d.ts:1672](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1672)

## Properties[​](#properties "Direct link to Properties")

### modelNameOverride?[​](#modelnameoverride "Direct link to modelNameOverride?")

> `optional` **modelNameOverride**: `null` | `string`

Defined in: [WAProto/index.d.ts:1675](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1675)

* * *

### modelType?[​](#modeltype "Direct link to modelType?")

> `optional` **modelType**: `null` | [`ModelType`](/docs/api/namespaces/proto/namespaces/BotModelMetadata/enumerations/ModelType)

Defined in: [WAProto/index.d.ts:1673](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1673)

* * *

### premiumModelStatus?[​](#premiummodelstatus "Direct link to premiumModelStatus?")

> `optional` **premiumModelStatus**: `null` | [`PremiumModelStatus`](/docs/api/namespaces/proto/namespaces/BotModelMetadata/enumerations/PremiumModelStatus)

Defined in: [WAProto/index.d.ts:1674](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1674)

---

<a name="interface-ibotpluginmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotPluginMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotPluginMetadata)

Defined in: [WAProto/index.d.ts:1707](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1707)

## Properties[​](#properties "Direct link to Properties")

### deprecatedField?[​](#deprecatedfield "Direct link to deprecatedField?")

> `optional` **deprecatedField**: `null` | [`PluginType`](/docs/api/namespaces/proto/namespaces/BotPluginMetadata/enumerations/PluginType)

Defined in: [WAProto/index.d.ts:1717](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1717)

* * *

### expectedLinksCount?[​](#expectedlinkscount "Direct link to expectedLinksCount?")

> `optional` **expectedLinksCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:1714](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1714)

* * *

### faviconCdnUrl?[​](#faviconcdnurl "Direct link to faviconCdnUrl?")

> `optional` **faviconCdnUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:1719](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1719)

* * *

### parentPluginMessageKey?[​](#parentpluginmessagekey "Direct link to parentPluginMessageKey?")

> `optional` **parentPluginMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:1716](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1716)

* * *

### parentPluginType?[​](#parentplugintype "Direct link to parentPluginType?")

> `optional` **parentPluginType**: `null` | [`PluginType`](/docs/api/namespaces/proto/namespaces/BotPluginMetadata/enumerations/PluginType)

Defined in: [WAProto/index.d.ts:1718](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1718)

* * *

### pluginType?[​](#plugintype "Direct link to pluginType?")

> `optional` **pluginType**: `null` | [`PluginType`](/docs/api/namespaces/proto/namespaces/BotPluginMetadata/enumerations/PluginType)

Defined in: [WAProto/index.d.ts:1709](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1709)

* * *

### profilePhotoCdnUrl?[​](#profilephotocdnurl "Direct link to profilePhotoCdnUrl?")

> `optional` **profilePhotoCdnUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:1711](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1711)

* * *

### provider?[​](#provider "Direct link to provider?")

> `optional` **provider**: `null` | [`SearchProvider`](/docs/api/namespaces/proto/namespaces/BotPluginMetadata/enumerations/SearchProvider)

Defined in: [WAProto/index.d.ts:1708](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1708)

* * *

### referenceIndex?[​](#referenceindex "Direct link to referenceIndex?")

> `optional` **referenceIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:1713](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1713)

* * *

### searchProviderUrl?[​](#searchproviderurl "Direct link to searchProviderUrl?")

> `optional` **searchProviderUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:1712](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1712)

* * *

### searchQuery?[​](#searchquery "Direct link to searchQuery?")

> `optional` **searchQuery**: `null` | `string`

Defined in: [WAProto/index.d.ts:1715](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1715)

* * *

### thumbnailCdnUrl?[​](#thumbnailcdnurl "Direct link to thumbnailCdnUrl?")

> `optional` **thumbnailCdnUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:1710](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1710)

---

<a name="interface-ibotprogressindicatormetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotProgressIndicatorMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotProgressIndicatorMetadata)

Defined in: [WAProto/index.d.ts:1761](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1761)

## Properties[​](#properties "Direct link to Properties")

### progressDescription?[​](#progressdescription "Direct link to progressDescription?")

> `optional` **progressDescription**: `null` | `string`

Defined in: [WAProto/index.d.ts:1762](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1762)

* * *

### stepsMetadata?[​](#stepsmetadata "Direct link to stepsMetadata?")

> `optional` **stepsMetadata**: `null` | [`IBotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata)\[\]

Defined in: [WAProto/index.d.ts:1763](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1763)

---

<a name="interface-ibotpromotionmessagemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotPromotionMessageMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotPromotionMessageMetadata)

Defined in: [WAProto/index.d.ts:1899](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1899)

## Properties[​](#properties "Direct link to Properties")

### buttonTitle?[​](#buttontitle "Direct link to buttonTitle?")

> `optional` **buttonTitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:1901](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1901)

* * *

### promotionType?[​](#promotiontype "Direct link to promotionType?")

> `optional` **promotionType**: `null` | [`BotPromotionType`](/docs/api/namespaces/proto/namespaces/BotPromotionMessageMetadata/enumerations/BotPromotionType)

Defined in: [WAProto/index.d.ts:1900](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1900)

---

<a name="interface-ibotpromptsuggestion"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotPromptSuggestion](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotPromptSuggestion)

Defined in: [WAProto/index.d.ts:1926](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1926)

## Properties[​](#properties "Direct link to Properties")

### prompt?[​](#prompt "Direct link to prompt?")

> `optional` **prompt**: `null` | `string`

Defined in: [WAProto/index.d.ts:1927](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1927)

* * *

### promptId?[​](#promptid "Direct link to promptId?")

> `optional` **promptId**: `null` | `string`

Defined in: [WAProto/index.d.ts:1928](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1928)

---

<a name="interface-ibotpromptsuggestions"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotPromptSuggestions](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotPromptSuggestions)

Defined in: [WAProto/index.d.ts:1944](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1944)

## Properties[​](#properties "Direct link to Properties")

### suggestions?[​](#suggestions "Direct link to suggestions?")

> `optional` **suggestions**: `null` | [`IBotPromptSuggestion`](/docs/api/namespaces/proto/interfaces/IBotPromptSuggestion)\[\]

Defined in: [WAProto/index.d.ts:1945](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1945)

---

<a name="interface-ibotquotametadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotQuotaMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotQuotaMetadata)

Defined in: [WAProto/index.d.ts:1960](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1960)

## Properties[​](#properties "Direct link to Properties")

### botFeatureQuotaMetadata?[​](#botfeaturequotametadata "Direct link to botFeatureQuotaMetadata?")

> `optional` **botFeatureQuotaMetadata**: `null` | [`IBotFeatureQuotaMetadata`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/interfaces/IBotFeatureQuotaMetadata)\[\]

Defined in: [WAProto/index.d.ts:1961](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1961)

---

<a name="interface-ibotremindermetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotReminderMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotReminderMetadata)

Defined in: [WAProto/index.d.ts:2007](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2007)

## Properties[​](#properties "Direct link to Properties")

### action?[​](#action "Direct link to action?")

> `optional` **action**: `null` | [`ReminderAction`](/docs/api/namespaces/proto/namespaces/BotReminderMetadata/enumerations/ReminderAction)

Defined in: [WAProto/index.d.ts:2009](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2009)

* * *

### frequency?[​](#frequency "Direct link to frequency?")

> `optional` **frequency**: `null` | [`ReminderFrequency`](/docs/api/namespaces/proto/namespaces/BotReminderMetadata/enumerations/ReminderFrequency)

Defined in: [WAProto/index.d.ts:2012](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2012)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:2010](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2010)

* * *

### nextTriggerTimestamp?[​](#nexttriggertimestamp "Direct link to nextTriggerTimestamp?")

> `optional` **nextTriggerTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:2011](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2011)

* * *

### requestMessageKey?[​](#requestmessagekey "Direct link to requestMessageKey?")

> `optional` **requestMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:2008](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2008)

---

<a name="interface-ibotrenderingmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotRenderingMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotRenderingMetadata)

Defined in: [WAProto/index.d.ts:2049](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2049)

## Properties[​](#properties "Direct link to Properties")

### keywords?[​](#keywords "Direct link to keywords?")

> `optional` **keywords**: `null` | [`IKeyword`](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/interfaces/IKeyword)\[\]

Defined in: [WAProto/index.d.ts:2050](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2050)

---

<a name="interface-ibotsessionmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotSessionMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotSessionMetadata)

Defined in: [WAProto/index.d.ts:2086](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2086)

## Properties[​](#properties "Direct link to Properties")

### sessionId?[​](#sessionid "Direct link to sessionId?")

> `optional` **sessionId**: `null` | `string`

Defined in: [WAProto/index.d.ts:2087](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2087)

* * *

### sessionSource?[​](#sessionsource "Direct link to sessionSource?")

> `optional` **sessionSource**: `null` | [`BotSessionSource`](/docs/api/namespaces/proto/enumerations/BotSessionSource)

Defined in: [WAProto/index.d.ts:2088](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2088)

---

<a name="interface-ibotsignatureverificationmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationMetadata)

Defined in: [WAProto/index.d.ts:2114](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2114)

## Properties[​](#properties "Direct link to Properties")

### proofs?[​](#proofs "Direct link to proofs?")

> `optional` **proofs**: `null` | [`IBotSignatureVerificationUseCaseProof`](/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationUseCaseProof)\[\]

Defined in: [WAProto/index.d.ts:2115](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2115)

---

<a name="interface-ibotsignatureverificationusecaseproof"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationUseCaseProof](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotSignatureVerificationUseCaseProof)

Defined in: [WAProto/index.d.ts:2130](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2130)

## Properties[​](#properties "Direct link to Properties")

### certificateChain?[​](#certificatechain "Direct link to certificateChain?")

> `optional` **certificateChain**: `null` | `Uint8Array`<`ArrayBufferLike`\>\[\]

Defined in: [WAProto/index.d.ts:2134](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2134)

* * *

### signature?[​](#signature "Direct link to signature?")

> `optional` **signature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2133](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2133)

* * *

### useCase?[​](#usecase "Direct link to useCase?")

> `optional` **useCase**: `null` | [`BotSignatureUseCase`](/docs/api/namespaces/proto/namespaces/BotSignatureVerificationUseCaseProof/enumerations/BotSignatureUseCase)

Defined in: [WAProto/index.d.ts:2132](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2132)

* * *

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | `number`

Defined in: [WAProto/index.d.ts:2131](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2131)

---

<a name="interface-ibotsourcesmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotSourcesMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotSourcesMetadata)

Defined in: [WAProto/index.d.ts:2160](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2160)

## Properties[​](#properties "Direct link to Properties")

### sources?[​](#sources "Direct link to sources?")

> `optional` **sources**: `null` | [`IBotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem)\[\]

Defined in: [WAProto/index.d.ts:2161](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2161)

---

<a name="interface-ibotsuggestedpromptmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotSuggestedPromptMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotSuggestedPromptMetadata)

Defined in: [WAProto/index.d.ts:2218](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2218)

## Properties[​](#properties "Direct link to Properties")

### promptSuggestions?[​](#promptsuggestions "Direct link to promptSuggestions?")

> `optional` **promptSuggestions**: `null` | [`IBotPromptSuggestions`](/docs/api/namespaces/proto/interfaces/IBotPromptSuggestions)

Defined in: [WAProto/index.d.ts:2221](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2221)

* * *

### selectedPromptId?[​](#selectedpromptid "Direct link to selectedPromptId?")

> `optional` **selectedPromptId**: `null` | `string`

Defined in: [WAProto/index.d.ts:2222](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2222)

* * *

### selectedPromptIndex?[​](#selectedpromptindex "Direct link to selectedPromptIndex?")

> `optional` **selectedPromptIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:2220](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2220)

* * *

### suggestedPrompts?[​](#suggestedprompts "Direct link to suggestedPrompts?")

> `optional` **suggestedPrompts**: `null` | `string`\[\]

Defined in: [WAProto/index.d.ts:2219](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2219)

---

<a name="interface-ibotunifiedresponsemutation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotUnifiedResponseMutation](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IBotUnifiedResponseMutation)

Defined in: [WAProto/index.d.ts:2240](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2240)

## Properties[​](#properties "Direct link to Properties")

### mediaDetailsMetadataList?[​](#mediadetailsmetadatalist "Direct link to mediaDetailsMetadataList?")

> `optional` **mediaDetailsMetadataList**: `null` | [`IMediaDetailsMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/IMediaDetailsMetadata)\[\]

Defined in: [WAProto/index.d.ts:2242](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2242)

* * *

### sbsMetadata?[​](#sbsmetadata "Direct link to sbsMetadata?")

> `optional` **sbsMetadata**: `null` | [`ISideBySideMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/ISideBySideMetadata)

Defined in: [WAProto/index.d.ts:2241](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2241)

---

<a name="interface-icalllogrecord"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ICallLogRecord](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ICallLogRecord)

Defined in: [WAProto/index.d.ts:2299](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2299)

## Properties[​](#properties "Direct link to Properties")

### callCreatorJid?[​](#callcreatorjid "Direct link to callCreatorJid?")

> `optional` **callCreatorJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:2311](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2311)

* * *

### callId?[​](#callid "Direct link to callId?")

> `optional` **callId**: `null` | `string`

Defined in: [WAProto/index.d.ts:2310](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2310)

* * *

### callLinkToken?[​](#calllinktoken "Direct link to callLinkToken?")

> `optional` **callLinkToken**: `null` | `string`

Defined in: [WAProto/index.d.ts:2308](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2308)

* * *

### callResult?[​](#callresult "Direct link to callResult?")

> `optional` **callResult**: `null` | [`CallResult`](/docs/api/namespaces/proto/namespaces/CallLogRecord/enumerations/CallResult)

Defined in: [WAProto/index.d.ts:2300](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2300)

* * *

### callType?[​](#calltype "Direct link to callType?")

> `optional` **callType**: `null` | [`CallType`](/docs/api/namespaces/proto/namespaces/CallLogRecord/enumerations/CallType)

Defined in: [WAProto/index.d.ts:2314](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2314)

* * *

### duration?[​](#duration "Direct link to duration?")

> `optional` **duration**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:2303](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2303)

* * *

### groupJid?[​](#groupjid "Direct link to groupJid?")

> `optional` **groupJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:2312](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2312)

* * *

### isCallLink?[​](#iscalllink "Direct link to isCallLink?")

> `optional` **isCallLink**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2307](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2307)

* * *

### isDndMode?[​](#isdndmode "Direct link to isDndMode?")

> `optional` **isDndMode**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2301](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2301)

* * *

### isIncoming?[​](#isincoming "Direct link to isIncoming?")

> `optional` **isIncoming**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2305](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2305)

* * *

### isVideo?[​](#isvideo "Direct link to isVideo?")

> `optional` **isVideo**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2306](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2306)

* * *

### participants?[​](#participants "Direct link to participants?")

> `optional` **participants**: `null` | [`IParticipantInfo`](/docs/api/namespaces/proto/namespaces/CallLogRecord/interfaces/IParticipantInfo)\[\]

Defined in: [WAProto/index.d.ts:2313](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2313)

* * *

### scheduledCallId?[​](#scheduledcallid "Direct link to scheduledCallId?")

> `optional` **scheduledCallId**: `null` | `string`

Defined in: [WAProto/index.d.ts:2309](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2309)

* * *

### silenceReason?[​](#silencereason "Direct link to silenceReason?")

> `optional` **silenceReason**: `null` | [`SilenceReason`](/docs/api/namespaces/proto/namespaces/CallLogRecord/enumerations/SilenceReason)

Defined in: [WAProto/index.d.ts:2302](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2302)

* * *

### startTime?[​](#starttime "Direct link to startTime?")

> `optional` **startTime**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:2304](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2304)

---

<a name="interface-icertchain"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ICertChain](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ICertChain)

Defined in: [WAProto/index.d.ts:2391](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2391)

## Properties[​](#properties "Direct link to Properties")

### intermediate?[​](#intermediate "Direct link to intermediate?")

> `optional` **intermediate**: `null` | [`INoiseCertificate`](/docs/api/namespaces/proto/namespaces/CertChain/interfaces/INoiseCertificate)

Defined in: [WAProto/index.d.ts:2393](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2393)

* * *

### leaf?[​](#leaf "Direct link to leaf?")

> `optional` **leaf**: `null` | [`INoiseCertificate`](/docs/api/namespaces/proto/namespaces/CertChain/interfaces/INoiseCertificate)

Defined in: [WAProto/index.d.ts:2392](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2392)

---

<a name="interface-ichatlocksettings"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IChatLockSettings](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IChatLockSettings)

Defined in: [WAProto/index.d.ts:2457](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2457)

## Properties[​](#properties "Direct link to Properties")

### hideLockedChats?[​](#hidelockedchats "Direct link to hideLockedChats?")

> `optional` **hideLockedChats**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2458](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2458)

* * *

### secretCode?[​](#secretcode "Direct link to secretCode?")

> `optional` **secretCode**: `null` | [`IUserPassword`](/docs/api/namespaces/proto/interfaces/IUserPassword)

Defined in: [WAProto/index.d.ts:2459](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2459)

---

<a name="interface-ichatrowopaquedata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IChatRowOpaqueData](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IChatRowOpaqueData)

Defined in: [WAProto/index.d.ts:2475](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2475)

## Properties[​](#properties "Direct link to Properties")

### draftMessage?[​](#draftmessage "Direct link to draftMessage?")

> `optional` **draftMessage**: `null` | [`IDraftMessage`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/interfaces/IDraftMessage)

Defined in: [WAProto/index.d.ts:2476](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2476)

---

<a name="interface-icitation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ICitation](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ICitation)

Defined in: [WAProto/index.d.ts:2590](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2590)

## Properties[​](#properties "Direct link to Properties")

### cmsId?[​](#cmsid "Direct link to cmsId?")

> `optional` **cmsId**: `null` | `string`

Defined in: [WAProto/index.d.ts:2593](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2593)

* * *

### imageUrl?[​](#imageurl "Direct link to imageUrl?")

> `optional` **imageUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:2594](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2594)

* * *

### subtitle?[​](#subtitle "Direct link to subtitle?")

> `optional` **subtitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:2592](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2592)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:2591](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2591)

---

<a name="interface-iclientpairingprops"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IClientPairingProps](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IClientPairingProps)

Defined in: [WAProto/index.d.ts:2612](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2612)

## Properties[​](#properties "Direct link to Properties")

### isChatDbLidMigrated?[​](#ischatdblidmigrated "Direct link to isChatDbLidMigrated?")

> `optional` **isChatDbLidMigrated**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2613](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2613)

* * *

### isSyncdPureLidSession?[​](#issyncdpurelidsession "Direct link to isSyncdPureLidSession?")

> `optional` **isSyncdPureLidSession**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2614](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2614)

* * *

### isSyncdSnapshotRecoveryEnabled?[​](#issyncdsnapshotrecoveryenabled "Direct link to isSyncdSnapshotRecoveryEnabled?")

> `optional` **isSyncdSnapshotRecoveryEnabled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2615](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2615)

---

<a name="interface-iclientpayload"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IClientPayload](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IClientPayload)

Defined in: [WAProto/index.d.ts:2632](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2632)

## Properties[​](#properties "Direct link to Properties")

### accountType?[​](#accounttype "Direct link to accountType?")

> `optional` **accountType**: `null` | [`AccountType`](/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/AccountType)

Defined in: [WAProto/index.d.ts:2662](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2662)

* * *

### connectAttemptCount?[​](#connectattemptcount "Direct link to connectAttemptCount?")

> `optional` **connectAttemptCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:2644](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2644)

* * *

### connectionSequenceInfo?[​](#connectionsequenceinfo "Direct link to connectionSequenceInfo?")

> `optional` **connectionSequenceInfo**: `null` | `number`

Defined in: [WAProto/index.d.ts:2663](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2663)

* * *

### connectReason?[​](#connectreason "Direct link to connectReason?")

> `optional` **connectReason**: `null` | [`ConnectReason`](/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/ConnectReason)

Defined in: [WAProto/index.d.ts:2641](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2641)

* * *

### connectType?[​](#connecttype "Direct link to connectType?")

> `optional` **connectType**: `null` | [`ConnectType`](/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/ConnectType)

Defined in: [WAProto/index.d.ts:2640](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2640)

* * *

### device?[​](#device "Direct link to device?")

> `optional` **device**: `null` | `number`

Defined in: [WAProto/index.d.ts:2645](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2645)

* * *

### devicePairingData?[​](#devicepairingdata "Direct link to devicePairingData?")

> `optional` **devicePairingData**: `null` | [`IDevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData)

Defined in: [WAProto/index.d.ts:2646](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2646)

* * *

### dnsSource?[​](#dnssource "Direct link to dnsSource?")

> `optional` **dnsSource**: `null` | [`IDNSSource`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDNSSource)

Defined in: [WAProto/index.d.ts:2643](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2643)

* * *

### fbAppId?[​](#fbappid "Direct link to fbAppId?")

> `optional` **fbAppId**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:2653](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2653)

* * *

### fbCat?[​](#fbcat "Direct link to fbCat?")

> `optional` **fbCat**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2648](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2648)

* * *

### fbDeviceId?[​](#fbdeviceid "Direct link to fbDeviceId?")

> `optional` **fbDeviceId**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2654](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2654)

* * *

### fbUserAgent?[​](#fbuseragent "Direct link to fbUserAgent?")

> `optional` **fbUserAgent**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2649](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2649)

* * *

### interopData?[​](#interopdata "Direct link to interopData?")

> `optional` **interopData**: `null` | [`IInteropData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IInteropData)

Defined in: [WAProto/index.d.ts:2659](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2659)

* * *

### iosAppExtension?[​](#iosappextension "Direct link to iosAppExtension?")

> `optional` **iosAppExtension**: `null` | [`IOSAppExtension`](/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/IOSAppExtension)

Defined in: [WAProto/index.d.ts:2652](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2652)

* * *

### lc?[​](#lc "Direct link to lc?")

> `optional` **lc**: `null` | `number`

Defined in: [WAProto/index.d.ts:2651](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2651)

* * *

### lidDbMigrated?[​](#liddbmigrated "Direct link to lidDbMigrated?")

> `optional` **lidDbMigrated**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2661](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2661)

* * *

### memClass?[​](#memclass "Direct link to memClass?")

> `optional` **memClass**: `null` | `number`

Defined in: [WAProto/index.d.ts:2658](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2658)

* * *

### oc?[​](#oc "Direct link to oc?")

> `optional` **oc**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2650](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2650)

* * *

### paaLink?[​](#paalink "Direct link to paaLink?")

> `optional` **paaLink**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2664](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2664)

* * *

### paddingBytes?[​](#paddingbytes "Direct link to paddingBytes?")

> `optional` **paddingBytes**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2656](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2656)

* * *

### passive?[​](#passive "Direct link to passive?")

> `optional` **passive**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2634](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2634)

* * *

### preacksCount?[​](#preackscount "Direct link to preacksCount?")

> `optional` **preacksCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:2665](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2665)

* * *

### processingQueueSize?[​](#processingqueuesize "Direct link to processingQueueSize?")

> `optional` **processingQueueSize**: `null` | `number`

Defined in: [WAProto/index.d.ts:2666](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2666)

* * *

### product?[​](#product "Direct link to product?")

> `optional` **product**: `null` | [`Product`](/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/Product)

Defined in: [WAProto/index.d.ts:2647](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2647)

* * *

### pull?[​](#pull "Direct link to pull?")

> `optional` **pull**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2655](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2655)

* * *

### pushName?[​](#pushname "Direct link to pushName?")

> `optional` **pushName**: `null` | `string`

Defined in: [WAProto/index.d.ts:2637](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2637)

* * *

### sessionId?[​](#sessionid "Direct link to sessionId?")

> `optional` **sessionId**: `null` | `number`

Defined in: [WAProto/index.d.ts:2638](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2638)

* * *

### shards?[​](#shards "Direct link to shards?")

> `optional` **shards**: `null` | `number`\[\]

Defined in: [WAProto/index.d.ts:2642](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2642)

* * *

### shortConnect?[​](#shortconnect "Direct link to shortConnect?")

> `optional` **shortConnect**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2639](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2639)

* * *

### trafficAnonymization?[​](#trafficanonymization "Direct link to trafficAnonymization?")

> `optional` **trafficAnonymization**: `null` | [`TrafficAnonymization`](/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/TrafficAnonymization)

Defined in: [WAProto/index.d.ts:2660](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2660)

* * *

### userAgent?[​](#useragent "Direct link to userAgent?")

> `optional` **userAgent**: `null` | [`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent)

Defined in: [WAProto/index.d.ts:2635](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2635)

* * *

### username?[​](#username "Direct link to username?")

> `optional` **username**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:2633](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2633)

* * *

### webInfo?[​](#webinfo "Direct link to webInfo?")

> `optional` **webInfo**: `null` | [`IWebInfo`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IWebInfo)

Defined in: [WAProto/index.d.ts:2636](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2636)

* * *

### yearClass?[​](#yearclass "Direct link to yearClass?")

> `optional` **yearClass**: `null` | `number`

Defined in: [WAProto/index.d.ts:2657](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2657)

---

<a name="interface-icommentmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ICommentMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ICommentMetadata)

Defined in: [WAProto/index.d.ts:3057](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3057)

## Properties[​](#properties "Direct link to Properties")

### commentParentKey?[​](#commentparentkey "Direct link to commentParentKey?")

> `optional` **commentParentKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:3058](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3058)

* * *

### replyCount?[​](#replycount "Direct link to replyCount?")

> `optional` **replyCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:3059](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3059)

---

<a name="interface-icompanioncommitment"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ICompanionCommitment](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ICompanionCommitment)

Defined in: [WAProto/index.d.ts:3075](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3075)

## Properties[​](#properties "Direct link to Properties")

### hash?[​](#hash "Direct link to hash?")

> `optional` **hash**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3076](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3076)

---

<a name="interface-icompanionephemeralidentity"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ICompanionEphemeralIdentity](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ICompanionEphemeralIdentity)

Defined in: [WAProto/index.d.ts:3091](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3091)

## Properties[​](#properties "Direct link to Properties")

### deviceType?[​](#devicetype "Direct link to deviceType?")

> `optional` **deviceType**: `null` | [`PlatformType`](/docs/api/namespaces/proto/namespaces/DeviceProps/enumerations/PlatformType)

Defined in: [WAProto/index.d.ts:3093](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3093)

* * *

### publicKey?[​](#publickey "Direct link to publicKey?")

> `optional` **publicKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3092](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3092)

* * *

### ref?[​](#ref "Direct link to ref?")

> `optional` **ref**: `null` | `string`

Defined in: [WAProto/index.d.ts:3094](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3094)

---

<a name="interface-iconfig"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IConfig](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IConfig)

Defined in: [WAProto/index.d.ts:3111](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3111)

## Properties[​](#properties "Direct link to Properties")

### field?[​](#field "Direct link to field?")

> `optional` **field**: `null` | {}

Defined in: [WAProto/index.d.ts:3112](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3112)

* * *

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | `number`

Defined in: [WAProto/index.d.ts:3113](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3113)

---

<a name="interface-icontextinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IContextInfo](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:3129](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3129)

## Properties[​](#properties "Direct link to Properties")

### actionLink?[​](#actionlink "Direct link to actionLink?")

> `optional` **actionLink**: `null` | [`IActionLink`](/docs/api/namespaces/proto/interfaces/IActionLink)

Defined in: [WAProto/index.d.ts:3150](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3150)

* * *

### alwaysShowAdAttribution?[​](#alwaysshowadattribution "Direct link to alwaysShowAdAttribution?")

> `optional` **alwaysShowAdAttribution**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3163](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3163)

* * *

### botMessageSharingInfo?[​](#botmessagesharinginfo "Direct link to botMessageSharingInfo?")

> `optional` **botMessageSharingInfo**: `null` | [`IBotMessageSharingInfo`](/docs/api/namespaces/proto/interfaces/IBotMessageSharingInfo)

Defined in: [WAProto/index.d.ts:3184](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3184)

* * *

### businessMessageForwardInfo?[​](#businessmessageforwardinfo "Direct link to businessMessageForwardInfo?")

> `optional` **businessMessageForwardInfo**: `null` | [`IBusinessMessageForwardInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IBusinessMessageForwardInfo)

Defined in: [WAProto/index.d.ts:3159](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3159)

* * *

### conversionData?[​](#conversiondata "Direct link to conversionData?")

> `optional` **conversionData**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3136](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3136)

* * *

### conversionDelaySeconds?[​](#conversiondelayseconds "Direct link to conversionDelaySeconds?")

> `optional` **conversionDelaySeconds**: `null` | `number`

Defined in: [WAProto/index.d.ts:3137](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3137)

* * *

### conversionSource?[​](#conversionsource "Direct link to conversionSource?")

> `optional` **conversionSource**: `null` | `string`

Defined in: [WAProto/index.d.ts:3135](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3135)

* * *

### ctwaPayload?[​](#ctwapayload "Direct link to ctwaPayload?")

> `optional` **ctwaPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3168](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3168)

* * *

### ctwaSignals?[​](#ctwasignals "Direct link to ctwaSignals?")

> `optional` **ctwaSignals**: `null` | `string`

Defined in: [WAProto/index.d.ts:3167](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3167)

* * *

### dataSharingContext?[​](#datasharingcontext "Direct link to dataSharingContext?")

> `optional` **dataSharingContext**: `null` | [`IDataSharingContext`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IDataSharingContext)

Defined in: [WAProto/index.d.ts:3162](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3162)

* * *

### disappearingMode?[​](#disappearingmode "Direct link to disappearingMode?")

> `optional` **disappearingMode**: `null` | [`IDisappearingMode`](/docs/api/namespaces/proto/interfaces/IDisappearingMode)

Defined in: [WAProto/index.d.ts:3149](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3149)

* * *

### entryPointConversionApp?[​](#entrypointconversionapp "Direct link to entryPointConversionApp?")

> `optional` **entryPointConversionApp**: `null` | `string`

Defined in: [WAProto/index.d.ts:3147](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3147)

* * *

### entryPointConversionDelaySeconds?[​](#entrypointconversiondelayseconds "Direct link to entryPointConversionDelaySeconds?")

> `optional` **entryPointConversionDelaySeconds**: `null` | `number`

Defined in: [WAProto/index.d.ts:3148](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3148)

* * *

### entryPointConversionExternalMedium?[​](#entrypointconversionexternalmedium "Direct link to entryPointConversionExternalMedium?")

> `optional` **entryPointConversionExternalMedium**: `null` | `string`

Defined in: [WAProto/index.d.ts:3166](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3166)

* * *

### entryPointConversionExternalSource?[​](#entrypointconversionexternalsource "Direct link to entryPointConversionExternalSource?")

> `optional` **entryPointConversionExternalSource**: `null` | `string`

Defined in: [WAProto/index.d.ts:3165](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3165)

* * *

### entryPointConversionSource?[​](#entrypointconversionsource "Direct link to entryPointConversionSource?")

> `optional` **entryPointConversionSource**: `null` | `string`

Defined in: [WAProto/index.d.ts:3146](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3146)

* * *

### ephemeralSettingTimestamp?[​](#ephemeralsettingtimestamp "Direct link to ephemeralSettingTimestamp?")

> `optional` **ephemeralSettingTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3143](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3143)

* * *

### ephemeralSharedSecret?[​](#ephemeralsharedsecret "Direct link to ephemeralSharedSecret?")

> `optional` **ephemeralSharedSecret**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3144](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3144)

* * *

### expiration?[​](#expiration "Direct link to expiration?")

> `optional` **expiration**: `null` | `number`

Defined in: [WAProto/index.d.ts:3142](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3142)

* * *

### externalAdReply?[​](#externaladreply "Direct link to externalAdReply?")

> `optional` **externalAdReply**: `null` | [`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo)

Defined in: [WAProto/index.d.ts:3145](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3145)

* * *

### featureEligibilities?[​](#featureeligibilities "Direct link to featureEligibilities?")

> `optional` **featureEligibilities**: `null` | [`IFeatureEligibilities`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IFeatureEligibilities)

Defined in: [WAProto/index.d.ts:3164](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3164)

* * *

### forwardedAiBotMessageInfo?[​](#forwardedaibotmessageinfo "Direct link to forwardedAiBotMessageInfo?")

> `optional` **forwardedAiBotMessageInfo**: `null` | [`IForwardedAIBotMessageInfo`](/docs/api/namespaces/proto/interfaces/IForwardedAIBotMessageInfo)

Defined in: [WAProto/index.d.ts:3169](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3169)

* * *

### forwardedNewsletterMessageInfo?[​](#forwardednewslettermessageinfo "Direct link to forwardedNewsletterMessageInfo?")

> `optional` **forwardedNewsletterMessageInfo**: `null` | [`IForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo)

Defined in: [WAProto/index.d.ts:3158](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3158)

* * *

### forwardingScore?[​](#forwardingscore "Direct link to forwardingScore?")

> `optional` **forwardingScore**: `null` | `number`

Defined in: [WAProto/index.d.ts:3138](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3138)

* * *

### forwardOrigin?[​](#forwardorigin "Direct link to forwardOrigin?")

> `optional` **forwardOrigin**: `null` | [`ForwardOrigin`](/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/ForwardOrigin)

Defined in: [WAProto/index.d.ts:3179](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3179)

* * *

### groupMentions?[​](#groupmentions "Direct link to groupMentions?")

> `optional` **groupMentions**: `null` | [`IGroupMention`](/docs/api/namespaces/proto/interfaces/IGroupMention)\[\]

Defined in: [WAProto/index.d.ts:3156](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3156)

* * *

### groupSubject?[​](#groupsubject "Direct link to groupSubject?")

> `optional` **groupSubject**: `null` | `string`

Defined in: [WAProto/index.d.ts:3151](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3151)

* * *

### isForwarded?[​](#isforwarded "Direct link to isForwarded?")

> `optional` **isForwarded**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3139](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3139)

* * *

### isGroupStatus?[​](#isgroupstatus "Direct link to isGroupStatus?")

> `optional` **isGroupStatus**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3178](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3178)

* * *

### isQuestion?[​](#isquestion "Direct link to isQuestion?")

> `optional` **isQuestion**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3175](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3175)

* * *

### isSampled?[​](#issampled "Direct link to isSampled?")

> `optional` **isSampled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3155](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3155)

* * *

### memberLabel?[​](#memberlabel "Direct link to memberLabel?")

> `optional` **memberLabel**: `null` | [`IMemberLabel`](/docs/api/namespaces/proto/interfaces/IMemberLabel)

Defined in: [WAProto/index.d.ts:3174](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3174)

* * *

### mentionedJid?[​](#mentionedjid "Direct link to mentionedJid?")

> `optional` **mentionedJid**: `null` | `string`\[\]

Defined in: [WAProto/index.d.ts:3134](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3134)

* * *

### nonJidMentions?[​](#nonjidmentions "Direct link to nonJidMentions?")

> `optional` **nonJidMentions**: `null` | `number`

Defined in: [WAProto/index.d.ts:3182](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3182)

* * *

### pairedMediaType?[​](#pairedmediatype "Direct link to pairedMediaType?")

> `optional` **pairedMediaType**: `null` | [`PairedMediaType`](/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/PairedMediaType)

Defined in: [WAProto/index.d.ts:3172](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3172)

* * *

### parentGroupJid?[​](#parentgroupjid "Direct link to parentGroupJid?")

> `optional` **parentGroupJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:3152](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3152)

* * *

### participant?[​](#participant "Direct link to participant?")

> `optional` **participant**: `null` | `string`

Defined in: [WAProto/index.d.ts:3131](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3131)

* * *

### placeholderKey?[​](#placeholderkey "Direct link to placeholderKey?")

> `optional` **placeholderKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:3141](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3141)

* * *

### questionReplyQuotedMessage?[​](#questionreplyquotedmessage "Direct link to questionReplyQuotedMessage?")

> `optional` **questionReplyQuotedMessage**: `null` | [`IQuestionReplyQuotedMessage`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IQuestionReplyQuotedMessage)

Defined in: [WAProto/index.d.ts:3180](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3180)

* * *

### quotedAd?[​](#quotedad "Direct link to quotedAd?")

> `optional` **quotedAd**: `null` | [`IAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IAdReplyInfo)

Defined in: [WAProto/index.d.ts:3140](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3140)

* * *

### quotedMessage?[​](#quotedmessage "Direct link to quotedMessage?")

> `optional` **quotedMessage**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:3132](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3132)

* * *

### quotedType?[​](#quotedtype "Direct link to quotedType?")

> `optional` **quotedType**: `null` | [`QuotedType`](/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/QuotedType)

Defined in: [WAProto/index.d.ts:3183](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3183)

* * *

### rankingVersion?[​](#rankingversion "Direct link to rankingVersion?")

> `optional` **rankingVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:3173](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3173)

* * *

### remoteJid?[​](#remotejid "Direct link to remoteJid?")

> `optional` **remoteJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:3133](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3133)

* * *

### smbClientCampaignId?[​](#smbclientcampaignid "Direct link to smbClientCampaignId?")

> `optional` **smbClientCampaignId**: `null` | `string`

Defined in: [WAProto/index.d.ts:3160](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3160)

* * *

### smbServerCampaignId?[​](#smbservercampaignid "Direct link to smbServerCampaignId?")

> `optional` **smbServerCampaignId**: `null` | `string`

Defined in: [WAProto/index.d.ts:3161](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3161)

* * *

### stanzaId?[​](#stanzaid "Direct link to stanzaId?")

> `optional` **stanzaId**: `null` | `string`

Defined in: [WAProto/index.d.ts:3130](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3130)

* * *

### statusAttributions?[​](#statusattributions "Direct link to statusAttributions?")

> `optional` **statusAttributions**: `null` | [`IStatusAttribution`](/docs/api/namespaces/proto/interfaces/IStatusAttribution)\[\]

Defined in: [WAProto/index.d.ts:3177](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3177)

* * *

### statusAttributionType?[​](#statusattributiontype "Direct link to statusAttributionType?")

> `optional` **statusAttributionType**: `null` | [`StatusAttributionType`](/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/StatusAttributionType)

Defined in: [WAProto/index.d.ts:3170](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3170)

* * *

### statusAudienceMetadata?[​](#statusaudiencemetadata "Direct link to statusAudienceMetadata?")

> `optional` **statusAudienceMetadata**: `null` | [`IStatusAudienceMetadata`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IStatusAudienceMetadata)

Defined in: [WAProto/index.d.ts:3181](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3181)

* * *

### statusSourceType?[​](#statussourcetype "Direct link to statusSourceType?")

> `optional` **statusSourceType**: `null` | [`StatusSourceType`](/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/StatusSourceType)

Defined in: [WAProto/index.d.ts:3176](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3176)

* * *

### trustBannerAction?[​](#trustbanneraction "Direct link to trustBannerAction?")

> `optional` **trustBannerAction**: `null` | `number`

Defined in: [WAProto/index.d.ts:3154](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3154)

* * *

### trustBannerType?[​](#trustbannertype "Direct link to trustBannerType?")

> `optional` **trustBannerType**: `null` | `string`

Defined in: [WAProto/index.d.ts:3153](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3153)

* * *

### urlTrackingMap?[​](#urltrackingmap "Direct link to urlTrackingMap?")

> `optional` **urlTrackingMap**: `null` | [`IUrlTrackingMap`](/docs/api/namespaces/proto/interfaces/IUrlTrackingMap)

Defined in: [WAProto/index.d.ts:3171](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3171)

* * *

### utm?[​](#utm "Direct link to utm?")

> `optional` **utm**: `null` | [`IUTMInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IUTMInfo)

Defined in: [WAProto/index.d.ts:3157](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3157)

---

<a name="interface-iconversation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IConversation](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IConversation)

Defined in: [WAProto/index.d.ts:3601](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3601)

## Properties[​](#properties "Direct link to Properties")

### accountLid?[​](#accountlid "Direct link to accountLid?")

> `optional` **accountLid**: `null` | `string`

Defined in: [WAProto/index.d.ts:3650](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3650)

* * *

### archived?[​](#archived "Direct link to archived?")

> `optional` **archived**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3617](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3617)

* * *

### capiCreatedGroup?[​](#capicreatedgroup "Direct link to capiCreatedGroup?")

> `optional` **capiCreatedGroup**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3649](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3649)

* * *

### commentsCount?[​](#commentscount "Direct link to commentsCount?")

> `optional` **commentsCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:3646](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3646)

* * *

### contactPrimaryIdentityKey?[​](#contactprimaryidentitykey "Direct link to contactPrimaryIdentityKey?")

> `optional` **contactPrimaryIdentityKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3624](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3624)

* * *

### conversationTimestamp?[​](#conversationtimestamp "Direct link to conversationTimestamp?")

> `optional` **conversationTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3613](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3613)

* * *

### createdAt?[​](#createdat "Direct link to createdAt?")

> `optional` **createdAt**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3632](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3632)

* * *

### createdBy?[​](#createdby "Direct link to createdBy?")

> `optional` **createdBy**: `null` | `string`

Defined in: [WAProto/index.d.ts:3633](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3633)

* * *

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:3634](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3634)

* * *

### disappearingMode?[​](#disappearingmode "Direct link to disappearingMode?")

> `optional` **disappearingMode**: `null` | [`IDisappearingMode`](/docs/api/namespaces/proto/interfaces/IDisappearingMode)

Defined in: [WAProto/index.d.ts:3618](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3618)

* * *

### displayName?[​](#displayname "Direct link to displayName?")

> `optional` **displayName**: `null` | `string`

Defined in: [WAProto/index.d.ts:3639](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3639)

* * *

### endOfHistoryTransfer?[​](#endofhistorytransfer "Direct link to endOfHistoryTransfer?")

> `optional` **endOfHistoryTransfer**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3609](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3609)

* * *

### endOfHistoryTransferType?[​](#endofhistorytransfertype "Direct link to endOfHistoryTransferType?")

> `optional` **endOfHistoryTransferType**: `null` | [`EndOfHistoryTransferType`](/docs/api/namespaces/proto/namespaces/Conversation/enumerations/EndOfHistoryTransferType)

Defined in: [WAProto/index.d.ts:3612](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3612)

* * *

### ephemeralExpiration?[​](#ephemeralexpiration "Direct link to ephemeralExpiration?")

> `optional` **ephemeralExpiration**: `null` | `number`

Defined in: [WAProto/index.d.ts:3610](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3610)

* * *

### ephemeralSettingTimestamp?[​](#ephemeralsettingtimestamp "Direct link to ephemeralSettingTimestamp?")

> `optional` **ephemeralSettingTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3611](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3611)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:3602](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3602)

* * *

### isDefaultSubgroup?[​](#isdefaultsubgroup "Direct link to isDefaultSubgroup?")

> `optional` **isDefaultSubgroup**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3638](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3638)

* * *

### isParentGroup?[​](#isparentgroup "Direct link to isParentGroup?")

> `optional` **isParentGroup**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3636](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3636)

* * *

### lastMsgTimestamp?[​](#lastmsgtimestamp "Direct link to lastMsgTimestamp?")

> `optional` **lastMsgTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3606](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3606)

* * *

### lidJid?[​](#lidjid "Direct link to lidJid?")

> `optional` **lidJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:3643](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3643)

* * *

### lidOriginType?[​](#lidorigintype "Direct link to lidOriginType?")

> `optional` **lidOriginType**: `null` | `string`

Defined in: [WAProto/index.d.ts:3645](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3645)

* * *

### limitSharing?[​](#limitsharing "Direct link to limitSharing?")

> `optional` **limitSharing**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3651](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3651)

* * *

### limitSharingInitiatedByMe?[​](#limitsharinginitiatedbyme "Direct link to limitSharingInitiatedByMe?")

> `optional` **limitSharingInitiatedByMe**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3654](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3654)

* * *

### limitSharingSettingTimestamp?[​](#limitsharingsettingtimestamp "Direct link to limitSharingSettingTimestamp?")

> `optional` **limitSharingSettingTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3652](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3652)

* * *

### limitSharingTrigger?[​](#limitsharingtrigger "Direct link to limitSharingTrigger?")

> `optional` **limitSharingTrigger**: `null` | [`TriggerType`](/docs/api/namespaces/proto/namespaces/LimitSharing/enumerations/TriggerType)

Defined in: [WAProto/index.d.ts:3653](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3653)

* * *

### locked?[​](#locked "Direct link to locked?")

> `optional` **locked**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3647](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3647)

* * *

### maibaAiThreadEnabled?[​](#maibaaithreadenabled "Direct link to maibaAiThreadEnabled?")

> `optional` **maibaAiThreadEnabled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3655](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3655)

* * *

### markedAsUnread?[​](#markedasunread "Direct link to markedAsUnread?")

> `optional` **markedAsUnread**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3620](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3620)

* * *

### mediaVisibility?[​](#mediavisibility "Direct link to mediaVisibility?")

> `optional` **mediaVisibility**: `null` | [`MediaVisibility`](/docs/api/namespaces/proto/enumerations/MediaVisibility)

Defined in: [WAProto/index.d.ts:3628](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3628)

* * *

### messages?[​](#messages "Direct link to messages?")

> `optional` **messages**: `null` | [`IHistorySyncMsg`](/docs/api/namespaces/proto/interfaces/IHistorySyncMsg)\[\]

Defined in: [WAProto/index.d.ts:3603](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3603)

* * *

### muteEndTime?[​](#muteendtime "Direct link to muteEndTime?")

> `optional` **muteEndTime**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3626](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3626)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:3614](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3614)

* * *

### newJid?[​](#newjid "Direct link to newJid?")

> `optional` **newJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:3604](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3604)

* * *

### notSpam?[​](#notspam "Direct link to notSpam?")

> `optional` **notSpam**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3616](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3616)

* * *

### oldJid?[​](#oldjid "Direct link to oldJid?")

> `optional` **oldJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:3605](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3605)

* * *

### parentGroupId?[​](#parentgroupid "Direct link to parentGroupId?")

> `optional` **parentGroupId**: `null` | `string`

Defined in: [WAProto/index.d.ts:3637](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3637)

* * *

### participant?[​](#participant "Direct link to participant?")

> `optional` **participant**: `null` | [`IGroupParticipant`](/docs/api/namespaces/proto/interfaces/IGroupParticipant)\[\]

Defined in: [WAProto/index.d.ts:3621](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3621)

* * *

### pHash?[​](#phash "Direct link to pHash?")

> `optional` **pHash**: `null` | `string`

Defined in: [WAProto/index.d.ts:3615](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3615)

* * *

### pinned?[​](#pinned "Direct link to pinned?")

> `optional` **pinned**: `null` | `number`

Defined in: [WAProto/index.d.ts:3625](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3625)

* * *

### pnhDuplicateLidThread?[​](#pnhduplicatelidthread "Direct link to pnhDuplicateLidThread?")

> `optional` **pnhDuplicateLidThread**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3642](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3642)

* * *

### pnJid?[​](#pnjid "Direct link to pnJid?")

> `optional` **pnJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:3640](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3640)

* * *

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3608](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3608)

* * *

### shareOwnPn?[​](#shareownpn "Direct link to shareOwnPn?")

> `optional` **shareOwnPn**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3641](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3641)

* * *

### support?[​](#support "Direct link to support?")

> `optional` **support**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3635](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3635)

* * *

### suspended?[​](#suspended "Direct link to suspended?")

> `optional` **suspended**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3630](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3630)

* * *

### systemMessageToInsert?[​](#systemmessagetoinsert "Direct link to systemMessageToInsert?")

> `optional` **systemMessageToInsert**: `null` | [`PrivacySystemMessage`](/docs/api/namespaces/proto/enumerations/PrivacySystemMessage)

Defined in: [WAProto/index.d.ts:3648](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3648)

* * *

### tcToken?[​](#tctoken "Direct link to tcToken?")

> `optional` **tcToken**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3622](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3622)

* * *

### tcTokenSenderTimestamp?[​](#tctokensendertimestamp "Direct link to tcTokenSenderTimestamp?")

> `optional` **tcTokenSenderTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3629](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3629)

* * *

### tcTokenTimestamp?[​](#tctokentimestamp "Direct link to tcTokenTimestamp?")

> `optional` **tcTokenTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3623](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3623)

* * *

### terminated?[​](#terminated "Direct link to terminated?")

> `optional` **terminated**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3631](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3631)

* * *

### unreadCount?[​](#unreadcount "Direct link to unreadCount?")

> `optional` **unreadCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:3607](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3607)

* * *

### unreadMentionCount?[​](#unreadmentioncount "Direct link to unreadMentionCount?")

> `optional` **unreadMentionCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:3619](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3619)

* * *

### username?[​](#username "Direct link to username?")

> `optional` **username**: `null` | `string`

Defined in: [WAProto/index.d.ts:3644](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3644)

* * *

### wallpaper?[​](#wallpaper "Direct link to wallpaper?")

> `optional` **wallpaper**: `null` | [`IWallpaperSettings`](/docs/api/namespaces/proto/interfaces/IWallpaperSettings)

Defined in: [WAProto/index.d.ts:3627](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3627)

---

<a name="interface-idevicecapabilities"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IDeviceCapabilities](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IDeviceCapabilities)

Defined in: [WAProto/index.d.ts:3732](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3732)

## Properties[​](#properties "Direct link to Properties")

### businessBroadcast?[​](#businessbroadcast "Direct link to businessBroadcast?")

> `optional` **businessBroadcast**: `null` | [`IBusinessBroadcast`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IBusinessBroadcast)

Defined in: [WAProto/index.d.ts:3735](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3735)

* * *

### chatLockSupportLevel?[​](#chatlocksupportlevel "Direct link to chatLockSupportLevel?")

> `optional` **chatLockSupportLevel**: `null` | [`ChatLockSupportLevel`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/enumerations/ChatLockSupportLevel)

Defined in: [WAProto/index.d.ts:3733](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3733)

* * *

### lidMigration?[​](#lidmigration "Direct link to lidMigration?")

> `optional` **lidMigration**: `null` | [`ILIDMigration`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/ILIDMigration)

Defined in: [WAProto/index.d.ts:3734](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3734)

* * *

### memberNameTagPrimarySupport?[​](#membernametagprimarysupport "Direct link to memberNameTagPrimarySupport?")

> `optional` **memberNameTagPrimarySupport**: `null` | [`MemberNameTagPrimarySupport`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/enumerations/MemberNameTagPrimarySupport)

Defined in: [WAProto/index.d.ts:3737](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3737)

* * *

### userHasAvatar?[​](#userhasavatar "Direct link to userHasAvatar?")

> `optional` **userHasAvatar**: `null` | [`IUserHasAvatar`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IUserHasAvatar)

Defined in: [WAProto/index.d.ts:3736](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3736)

---

<a name="interface-ideviceconsistencycodemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IDeviceConsistencyCodeMessage](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IDeviceConsistencyCodeMessage)

Defined in: [WAProto/index.d.ts:3819](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3819)

## Properties[​](#properties "Direct link to Properties")

### generation?[​](#generation "Direct link to generation?")

> `optional` **generation**: `null` | `number`

Defined in: [WAProto/index.d.ts:3820](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3820)

* * *

### signature?[​](#signature "Direct link to signature?")

> `optional` **signature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3821](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3821)

---

<a name="interface-idevicelistmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IDeviceListMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IDeviceListMetadata)

Defined in: [WAProto/index.d.ts:3837](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3837)

## Properties[​](#properties "Direct link to Properties")

### receiverAccountType?[​](#receiveraccounttype "Direct link to receiverAccountType?")

> `optional` **receiverAccountType**: `null` | [`ADVEncryptionType`](/docs/api/namespaces/proto/enumerations/ADVEncryptionType)

Defined in: [WAProto/index.d.ts:3842](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3842)

* * *

### recipientKeyHash?[​](#recipientkeyhash "Direct link to recipientKeyHash?")

> `optional` **recipientKeyHash**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3843](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3843)

* * *

### recipientKeyIndexes?[​](#recipientkeyindexes "Direct link to recipientKeyIndexes?")

> `optional` **recipientKeyIndexes**: `null` | `number`\[\]

Defined in: [WAProto/index.d.ts:3845](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3845)

* * *

### recipientTimestamp?[​](#recipienttimestamp "Direct link to recipientTimestamp?")

> `optional` **recipientTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3844](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3844)

* * *

### senderAccountType?[​](#senderaccounttype "Direct link to senderAccountType?")

> `optional` **senderAccountType**: `null` | [`ADVEncryptionType`](/docs/api/namespaces/proto/enumerations/ADVEncryptionType)

Defined in: [WAProto/index.d.ts:3841](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3841)

* * *

### senderKeyHash?[​](#senderkeyhash "Direct link to senderKeyHash?")

> `optional` **senderKeyHash**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3838](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3838)

* * *

### senderKeyIndexes?[​](#senderkeyindexes "Direct link to senderKeyIndexes?")

> `optional` **senderKeyIndexes**: `null` | `number`\[\]

Defined in: [WAProto/index.d.ts:3840](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3840)

* * *

### senderTimestamp?[​](#sendertimestamp "Direct link to senderTimestamp?")

> `optional` **senderTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3839](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3839)

---

<a name="interface-ideviceprops"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IDeviceProps](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IDeviceProps)

Defined in: [WAProto/index.d.ts:3867](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3867)

## Properties[​](#properties "Direct link to Properties")

### historySyncConfig?[​](#historysyncconfig "Direct link to historySyncConfig?")

> `optional` **historySyncConfig**: `null` | [`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig)

Defined in: [WAProto/index.d.ts:3872](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3872)

* * *

### os?[​](#os "Direct link to os?")

> `optional` **os**: `null` | `string`

Defined in: [WAProto/index.d.ts:3868](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3868)

* * *

### platformType?[​](#platformtype "Direct link to platformType?")

> `optional` **platformType**: `null` | [`PlatformType`](/docs/api/namespaces/proto/namespaces/DeviceProps/enumerations/PlatformType)

Defined in: [WAProto/index.d.ts:3870](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3870)

* * *

### requireFullSync?[​](#requirefullsync "Direct link to requireFullSync?")

> `optional` **requireFullSync**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3871](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3871)

* * *

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | [`IAppVersion`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IAppVersion)

Defined in: [WAProto/index.d.ts:3869](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3869)

---

<a name="interface-idisappearingmode"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IDisappearingMode](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IDisappearingMode)

Defined in: [WAProto/index.d.ts:3998](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3998)

## Properties[​](#properties "Direct link to Properties")

### initiatedByMe?[​](#initiatedbyme "Direct link to initiatedByMe?")

> `optional` **initiatedByMe**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4002](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4002)

* * *

### initiator?[​](#initiator "Direct link to initiator?")

> `optional` **initiator**: `null` | [`Initiator`](/docs/api/namespaces/proto/namespaces/DisappearingMode/enumerations/Initiator)

Defined in: [WAProto/index.d.ts:3999](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3999)

* * *

### initiatorDeviceJid?[​](#initiatordevicejid "Direct link to initiatorDeviceJid?")

> `optional` **initiatorDeviceJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:4001](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4001)

* * *

### trigger?[​](#trigger "Direct link to trigger?")

> `optional` **trigger**: `null` | [`Trigger`](/docs/api/namespaces/proto/namespaces/DisappearingMode/enumerations/Trigger)

Defined in: [WAProto/index.d.ts:4000](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4000)

---

<a name="interface-iembeddedcontent"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IEmbeddedContent](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IEmbeddedContent)

Defined in: [WAProto/index.d.ts:4039](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4039)

## Properties[​](#properties "Direct link to Properties")

### embeddedMessage?[​](#embeddedmessage "Direct link to embeddedMessage?")

> `optional` **embeddedMessage**: `null` | [`IEmbeddedMessage`](/docs/api/namespaces/proto/interfaces/IEmbeddedMessage)

Defined in: [WAProto/index.d.ts:4040](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4040)

* * *

### embeddedMusic?[​](#embeddedmusic "Direct link to embeddedMusic?")

> `optional` **embeddedMusic**: `null` | [`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic)

Defined in: [WAProto/index.d.ts:4041](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4041)

---

<a name="interface-iembeddedmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IEmbeddedMessage](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IEmbeddedMessage)

Defined in: [WAProto/index.d.ts:4058](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4058)

## Properties[​](#properties "Direct link to Properties")

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:4060](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4060)

* * *

### stanzaId?[​](#stanzaid "Direct link to stanzaId?")

> `optional` **stanzaId**: `null` | `string`

Defined in: [WAProto/index.d.ts:4059](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4059)

---

<a name="interface-iembeddedmusic"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IEmbeddedMusic](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IEmbeddedMusic)

Defined in: [WAProto/index.d.ts:4076](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4076)

## Properties[​](#properties "Direct link to Properties")

### artistAttribution?[​](#artistattribution "Direct link to artistAttribution?")

> `optional` **artistAttribution**: `null` | `string`

Defined in: [WAProto/index.d.ts:4084](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4084)

* * *

### artworkDirectPath?[​](#artworkdirectpath "Direct link to artworkDirectPath?")

> `optional` **artworkDirectPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:4081](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4081)

* * *

### artworkEncSha256?[​](#artworkencsha256 "Direct link to artworkEncSha256?")

> `optional` **artworkEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4083](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4083)

* * *

### artworkMediaKey?[​](#artworkmediakey "Direct link to artworkMediaKey?")

> `optional` **artworkMediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4087](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4087)

* * *

### artworkSha256?[​](#artworksha256 "Direct link to artworkSha256?")

> `optional` **artworkSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4082](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4082)

* * *

### author?[​](#author "Direct link to author?")

> `optional` **author**: `null` | `string`

Defined in: [WAProto/index.d.ts:4079](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4079)

* * *

### countryBlocklist?[​](#countryblocklist "Direct link to countryBlocklist?")

> `optional` **countryBlocklist**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4085](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4085)

* * *

### derivedContentStartTimeInMs?[​](#derivedcontentstarttimeinms "Direct link to derivedContentStartTimeInMs?")

> `optional` **derivedContentStartTimeInMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4089](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4089)

* * *

### isExplicit?[​](#isexplicit "Direct link to isExplicit?")

> `optional` **isExplicit**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4086](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4086)

* * *

### musicContentMediaId?[​](#musiccontentmediaid "Direct link to musicContentMediaId?")

> `optional` **musicContentMediaId**: `null` | `string`

Defined in: [WAProto/index.d.ts:4077](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4077)

* * *

### musicSongStartTimeInMs?[​](#musicsongstarttimeinms "Direct link to musicSongStartTimeInMs?")

> `optional` **musicSongStartTimeInMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4088](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4088)

* * *

### overlapDurationInMs?[​](#overlapdurationinms "Direct link to overlapDurationInMs?")

> `optional` **overlapDurationInMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4090](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4090)

* * *

### songId?[​](#songid "Direct link to songId?")

> `optional` **songId**: `null` | `string`

Defined in: [WAProto/index.d.ts:4078](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4078)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:4080](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4080)

---

<a name="interface-iencryptedpairingrequest"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IEncryptedPairingRequest](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IEncryptedPairingRequest)

Defined in: [WAProto/index.d.ts:4118](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4118)

## Properties[​](#properties "Direct link to Properties")

### encryptedPayload?[​](#encryptedpayload "Direct link to encryptedPayload?")

> `optional` **encryptedPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4119](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4119)

* * *

### iv?[​](#iv "Direct link to iv?")

> `optional` **iv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4120](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4120)

---

<a name="interface-iephemeralsetting"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IEphemeralSetting](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IEphemeralSetting)

Defined in: [WAProto/index.d.ts:4136](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4136)

## Properties[​](#properties "Direct link to Properties")

### duration?[​](#duration "Direct link to duration?")

> `optional` **duration**: `null` | `number`

Defined in: [WAProto/index.d.ts:4137](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4137)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4138](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4138)

---

<a name="interface-ieventadditionalmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IEventAdditionalMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IEventAdditionalMetadata)

Defined in: [WAProto/index.d.ts:4154](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4154)

## Properties[​](#properties "Direct link to Properties")

### isStale?[​](#isstale "Direct link to isStale?")

> `optional` **isStale**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4155](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4155)

---

<a name="interface-ieventresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IEventResponse](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IEventResponse)

Defined in: [WAProto/index.d.ts:4170](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4170)

## Properties[​](#properties "Direct link to Properties")

### eventResponseMessage?[​](#eventresponsemessage "Direct link to eventResponseMessage?")

> `optional` **eventResponseMessage**: `null` | [`IEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventResponseMessage)

Defined in: [WAProto/index.d.ts:4173](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4173)

* * *

### eventResponseMessageKey?[​](#eventresponsemessagekey "Direct link to eventResponseMessageKey?")

> `optional` **eventResponseMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:4171](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4171)

* * *

### timestampMs?[​](#timestampms "Direct link to timestampMs?")

> `optional` **timestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4172](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4172)

* * *

### unread?[​](#unread "Direct link to unread?")

> `optional` **unread**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4174](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4174)

---

<a name="interface-iexitcode"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IExitCode](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IExitCode)

Defined in: [WAProto/index.d.ts:4192](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4192)

## Properties[​](#properties "Direct link to Properties")

### code?[​](#code "Direct link to code?")

> `optional` **code**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4193](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4193)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:4194](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4194)

---

<a name="interface-iexternalblobreference"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IExternalBlobReference](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IExternalBlobReference)

Defined in: [WAProto/index.d.ts:4210](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4210)

## Properties[​](#properties "Direct link to Properties")

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:4212](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4212)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4216](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4216)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4215](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4215)

* * *

### fileSizeBytes?[​](#filesizebytes "Direct link to fileSizeBytes?")

> `optional` **fileSizeBytes**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4214](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4214)

* * *

### handle?[​](#handle "Direct link to handle?")

> `optional` **handle**: `null` | `string`

Defined in: [WAProto/index.d.ts:4213](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4213)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4211](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4211)

---

<a name="interface-ifield"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IField](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IField)

Defined in: [WAProto/index.d.ts:4236](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4236)

## Properties[​](#properties "Direct link to Properties")

### isMessage?[​](#ismessage "Direct link to isMessage?")

> `optional` **isMessage**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4240](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4240)

* * *

### maxVersion?[​](#maxversion "Direct link to maxVersion?")

> `optional` **maxVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:4238](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4238)

* * *

### minVersion?[​](#minversion "Direct link to minVersion?")

> `optional` **minVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:4237](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4237)

* * *

### notReportableMinVersion?[​](#notreportableminversion "Direct link to notReportableMinVersion?")

> `optional` **notReportableMinVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:4239](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4239)

* * *

### subfield?[​](#subfield "Direct link to subfield?")

> `optional` **subfield**: `null` | {}

Defined in: [WAProto/index.d.ts:4241](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4241)

---

<a name="interface-iforwardedaibotmessageinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IForwardedAIBotMessageInfo](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IForwardedAIBotMessageInfo)

Defined in: [WAProto/index.d.ts:4260](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4260)

## Properties[​](#properties "Direct link to Properties")

### botJid?[​](#botjid "Direct link to botJid?")

> `optional` **botJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:4262](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4262)

* * *

### botName?[​](#botname "Direct link to botName?")

> `optional` **botName**: `null` | `string`

Defined in: [WAProto/index.d.ts:4261](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4261)

* * *

### creatorName?[​](#creatorname "Direct link to creatorName?")

> `optional` **creatorName**: `null` | `string`

Defined in: [WAProto/index.d.ts:4263](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4263)

---

<a name="interface-iglobalsettings"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IGlobalSettings](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IGlobalSettings)

Defined in: [WAProto/index.d.ts:4280](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4280)

## Properties[​](#properties "Direct link to Properties")

### autoDownloadCellular?[​](#autodownloadcellular "Direct link to autoDownloadCellular?")

> `optional` **autoDownloadCellular**: `null` | [`IAutoDownloadSettings`](/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings)

Defined in: [WAProto/index.d.ts:4285](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4285)

* * *

### autoDownloadRoaming?[​](#autodownloadroaming "Direct link to autoDownloadRoaming?")

> `optional` **autoDownloadRoaming**: `null` | [`IAutoDownloadSettings`](/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings)

Defined in: [WAProto/index.d.ts:4286](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4286)

* * *

### autoDownloadWiFi?[​](#autodownloadwifi "Direct link to autoDownloadWiFi?")

> `optional` **autoDownloadWiFi**: `null` | [`IAutoDownloadSettings`](/docs/api/namespaces/proto/interfaces/IAutoDownloadSettings)

Defined in: [WAProto/index.d.ts:4284](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4284)

* * *

### autoUnarchiveChats?[​](#autounarchivechats "Direct link to autoUnarchiveChats?")

> `optional` **autoUnarchiveChats**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4294](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4294)

* * *

### avatarUserSettings?[​](#avatarusersettings "Direct link to avatarUserSettings?")

> `optional` **avatarUserSettings**: `null` | [`IAvatarUserSettings`](/docs/api/namespaces/proto/interfaces/IAvatarUserSettings)

Defined in: [WAProto/index.d.ts:4291](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4291)

* * *

### chatDbLidMigrationTimestamp?[​](#chatdblidmigrationtimestamp "Direct link to chatDbLidMigrationTimestamp?")

> `optional` **chatDbLidMigrationTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4300](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4300)

* * *

### chatLockSettings?[​](#chatlocksettings "Direct link to chatLockSettings?")

> `optional` **chatLockSettings**: `null` | [`IChatLockSettings`](/docs/api/namespaces/proto/interfaces/IChatLockSettings)

Defined in: [WAProto/index.d.ts:4299](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4299)

* * *

### darkThemeWallpaper?[​](#darkthemewallpaper "Direct link to darkThemeWallpaper?")

> `optional` **darkThemeWallpaper**: `null` | [`IWallpaperSettings`](/docs/api/namespaces/proto/interfaces/IWallpaperSettings)

Defined in: [WAProto/index.d.ts:4283](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4283)

* * *

### disappearingModeDuration?[​](#disappearingmodeduration "Direct link to disappearingModeDuration?")

> `optional` **disappearingModeDuration**: `null` | `number`

Defined in: [WAProto/index.d.ts:4289](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4289)

* * *

### disappearingModeTimestamp?[​](#disappearingmodetimestamp "Direct link to disappearingModeTimestamp?")

> `optional` **disappearingModeTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4290](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4290)

* * *

### fontSize?[​](#fontsize "Direct link to fontSize?")

> `optional` **fontSize**: `null` | `number`

Defined in: [WAProto/index.d.ts:4292](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4292)

* * *

### groupNotificationSettings?[​](#groupnotificationsettings "Direct link to groupNotificationSettings?")

> `optional` **groupNotificationSettings**: `null` | [`INotificationSettings`](/docs/api/namespaces/proto/interfaces/INotificationSettings)

Defined in: [WAProto/index.d.ts:4298](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4298)

* * *

### individualNotificationSettings?[​](#individualnotificationsettings "Direct link to individualNotificationSettings?")

> `optional` **individualNotificationSettings**: `null` | [`INotificationSettings`](/docs/api/namespaces/proto/interfaces/INotificationSettings)

Defined in: [WAProto/index.d.ts:4297](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4297)

* * *

### lightThemeWallpaper?[​](#lightthemewallpaper "Direct link to lightThemeWallpaper?")

> `optional` **lightThemeWallpaper**: `null` | [`IWallpaperSettings`](/docs/api/namespaces/proto/interfaces/IWallpaperSettings)

Defined in: [WAProto/index.d.ts:4281](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4281)

* * *

### mediaVisibility?[​](#mediavisibility "Direct link to mediaVisibility?")

> `optional` **mediaVisibility**: `null` | [`MediaVisibility`](/docs/api/namespaces/proto/enumerations/MediaVisibility)

Defined in: [WAProto/index.d.ts:4282](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4282)

* * *

### photoQualityMode?[​](#photoqualitymode "Direct link to photoQualityMode?")

> `optional` **photoQualityMode**: `null` | `number`

Defined in: [WAProto/index.d.ts:4296](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4296)

* * *

### securityNotifications?[​](#securitynotifications "Direct link to securityNotifications?")

> `optional` **securityNotifications**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4293](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4293)

* * *

### showGroupNotificationsPreview?[​](#showgroupnotificationspreview "Direct link to showGroupNotificationsPreview?")

> `optional` **showGroupNotificationsPreview**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4288](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4288)

* * *

### showIndividualNotificationsPreview?[​](#showindividualnotificationspreview "Direct link to showIndividualNotificationsPreview?")

> `optional` **showIndividualNotificationsPreview**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4287](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4287)

* * *

### videoQualityMode?[​](#videoqualitymode "Direct link to videoQualityMode?")

> `optional` **videoQualityMode**: `null` | `number`

Defined in: [WAProto/index.d.ts:4295](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4295)

---

<a name="interface-igrouphistorybundleinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IGroupHistoryBundleInfo](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IGroupHistoryBundleInfo)

Defined in: [WAProto/index.d.ts:4334](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4334)

## Properties[​](#properties "Direct link to Properties")

### deprecatedMessageHistoryBundle?[​](#deprecatedmessagehistorybundle "Direct link to deprecatedMessageHistoryBundle?")

> `optional` **deprecatedMessageHistoryBundle**: `null` | [`IMessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle)

Defined in: [WAProto/index.d.ts:4335](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4335)

* * *

### processState?[​](#processstate "Direct link to processState?")

> `optional` **processState**: `null` | [`ProcessState`](/docs/api/namespaces/proto/namespaces/GroupHistoryBundleInfo/enumerations/ProcessState)

Defined in: [WAProto/index.d.ts:4336](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4336)

---

<a name="interface-igrouphistoryindividualmessageinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IGroupHistoryIndividualMessageInfo](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IGroupHistoryIndividualMessageInfo)

Defined in: [WAProto/index.d.ts:4363](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4363)

## Properties[​](#properties "Direct link to Properties")

### bundleMessageKey?[​](#bundlemessagekey "Direct link to bundleMessageKey?")

> `optional` **bundleMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:4364](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4364)

* * *

### editedAfterReceivedAsHistory?[​](#editedafterreceivedashistory "Direct link to editedAfterReceivedAsHistory?")

> `optional` **editedAfterReceivedAsHistory**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4365](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4365)

---

<a name="interface-igroupmention"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IGroupMention](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IGroupMention)

Defined in: [WAProto/index.d.ts:4381](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4381)

## Properties[​](#properties "Direct link to Properties")

### groupJid?[​](#groupjid "Direct link to groupJid?")

> `optional` **groupJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:4382](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4382)

* * *

### groupSubject?[​](#groupsubject "Direct link to groupSubject?")

> `optional` **groupSubject**: `null` | `string`

Defined in: [WAProto/index.d.ts:4383](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4383)

---

<a name="interface-igroupparticipant"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IGroupParticipant](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IGroupParticipant)

Defined in: [WAProto/index.d.ts:4399](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4399)

## Properties[​](#properties "Direct link to Properties")

### memberLabel?[​](#memberlabel "Direct link to memberLabel?")

> `optional` **memberLabel**: `null` | [`IMemberLabel`](/docs/api/namespaces/proto/interfaces/IMemberLabel)

Defined in: [WAProto/index.d.ts:4402](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4402)

* * *

### rank?[​](#rank "Direct link to rank?")

> `optional` **rank**: `null` | [`Rank`](/docs/api/namespaces/proto/namespaces/GroupParticipant/enumerations/Rank)

Defined in: [WAProto/index.d.ts:4401](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4401)

* * *

### userJid?[​](#userjid "Direct link to userJid?")

> `optional` **userJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:4400](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4400)

---

<a name="interface-ihandshakemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IHandshakeMessage](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IHandshakeMessage)

Defined in: [WAProto/index.d.ts:4428](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4428)

## Properties[​](#properties "Direct link to Properties")

### clientFinish?[​](#clientfinish "Direct link to clientFinish?")

> `optional` **clientFinish**: `null` | [`IClientFinish`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientFinish)

Defined in: [WAProto/index.d.ts:4431](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4431)

* * *

### clientHello?[​](#clienthello "Direct link to clientHello?")

> `optional` **clientHello**: `null` | [`IClientHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientHello)

Defined in: [WAProto/index.d.ts:4429](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4429)

* * *

### serverHello?[​](#serverhello "Direct link to serverHello?")

> `optional` **serverHello**: `null` | [`IServerHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IServerHello)

Defined in: [WAProto/index.d.ts:4430](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4430)

---

<a name="interface-ihistorysync"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IHistorySync](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IHistorySync)

Defined in: [WAProto/index.d.ts:4517](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4517)

## Properties[​](#properties "Direct link to Properties")

### accounts?[​](#accounts "Direct link to accounts?")

> `optional` **accounts**: `null` | [`IAccount`](/docs/api/namespaces/proto/interfaces/IAccount)\[\]

Defined in: [WAProto/index.d.ts:4534](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4534)

* * *

### aiWaitListState?[​](#aiwaitliststate "Direct link to aiWaitListState?")

> `optional` **aiWaitListState**: `null` | [`BotAIWaitListState`](/docs/api/namespaces/proto/namespaces/HistorySync/enumerations/BotAIWaitListState)

Defined in: [WAProto/index.d.ts:4530](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4530)

* * *

### callLogRecords?[​](#calllogrecords "Direct link to callLogRecords?")

> `optional` **callLogRecords**: `null` | [`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord)\[\]

Defined in: [WAProto/index.d.ts:4529](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4529)

* * *

### chunkOrder?[​](#chunkorder "Direct link to chunkOrder?")

> `optional` **chunkOrder**: `null` | `number`

Defined in: [WAProto/index.d.ts:4521](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4521)

* * *

### companionMetaNonce?[​](#companionmetanonce "Direct link to companionMetaNonce?")

> `optional` **companionMetaNonce**: `null` | `string`

Defined in: [WAProto/index.d.ts:4532](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4532)

* * *

### conversations?[​](#conversations "Direct link to conversations?")

> `optional` **conversations**: `null` | [`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation)\[\]

Defined in: [WAProto/index.d.ts:4519](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4519)

* * *

### globalSettings?[​](#globalsettings "Direct link to globalSettings?")

> `optional` **globalSettings**: `null` | [`IGlobalSettings`](/docs/api/namespaces/proto/interfaces/IGlobalSettings)

Defined in: [WAProto/index.d.ts:4524](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4524)

* * *

### pastParticipants?[​](#pastparticipants "Direct link to pastParticipants?")

> `optional` **pastParticipants**: `null` | [`IPastParticipants`](/docs/api/namespaces/proto/interfaces/IPastParticipants)\[\]

Defined in: [WAProto/index.d.ts:4528](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4528)

* * *

### phoneNumberToLidMappings?[​](#phonenumbertolidmappings "Direct link to phoneNumberToLidMappings?")

> `optional` **phoneNumberToLidMappings**: `null` | [`IPhoneNumberToLIDMapping`](/docs/api/namespaces/proto/interfaces/IPhoneNumberToLIDMapping)\[\]

Defined in: [WAProto/index.d.ts:4531](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4531)

* * *

### progress?[​](#progress "Direct link to progress?")

> `optional` **progress**: `null` | `number`

Defined in: [WAProto/index.d.ts:4522](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4522)

* * *

### pushnames?[​](#pushnames "Direct link to pushnames?")

> `optional` **pushnames**: `null` | [`IPushname`](/docs/api/namespaces/proto/interfaces/IPushname)\[\]

Defined in: [WAProto/index.d.ts:4523](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4523)

* * *

### recentStickers?[​](#recentstickers "Direct link to recentStickers?")

> `optional` **recentStickers**: `null` | [`IStickerMetadata`](/docs/api/namespaces/proto/interfaces/IStickerMetadata)\[\]

Defined in: [WAProto/index.d.ts:4527](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4527)

* * *

### shareableChatIdentifierEncryptionKey?[​](#shareablechatidentifierencryptionkey "Direct link to shareableChatIdentifierEncryptionKey?")

> `optional` **shareableChatIdentifierEncryptionKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4533](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4533)

* * *

### statusV3Messages?[​](#statusv3messages "Direct link to statusV3Messages?")

> `optional` **statusV3Messages**: `null` | [`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo)\[\]

Defined in: [WAProto/index.d.ts:4520](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4520)

* * *

### syncType?[​](#synctype "Direct link to syncType?")

> `optional` **syncType**: `null` | [`HistorySyncType`](/docs/api/namespaces/proto/namespaces/HistorySync/enumerations/HistorySyncType)

Defined in: [WAProto/index.d.ts:4518](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4518)

* * *

### threadDsTimeframeOffset?[​](#threaddstimeframeoffset "Direct link to threadDsTimeframeOffset?")

> `optional` **threadDsTimeframeOffset**: `null` | `number`

Defined in: [WAProto/index.d.ts:4526](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4526)

* * *

### threadIdUserSecret?[​](#threadidusersecret "Direct link to threadIdUserSecret?")

> `optional` **threadIdUserSecret**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4525](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4525)

---

<a name="interface-ihistorysyncmsg"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IHistorySyncMsg](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IHistorySyncMsg)

Defined in: [WAProto/index.d.ts:4583](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4583)

## Properties[​](#properties "Direct link to Properties")

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | [`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo)

Defined in: [WAProto/index.d.ts:4584](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4584)

* * *

### msgOrderId?[​](#msgorderid "Direct link to msgOrderId?")

> `optional` **msgOrderId**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4585](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4585)

---

<a name="interface-ihydratedtemplatebutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IHydratedTemplateButton](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IHydratedTemplateButton)

Defined in: [WAProto/index.d.ts:4601](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4601)

## Properties[​](#properties "Direct link to Properties")

### callButton?[​](#callbutton "Direct link to callButton?")

> `optional` **callButton**: `null` | [`IHydratedCallButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedCallButton)

Defined in: [WAProto/index.d.ts:4605](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4605)

* * *

### index?[​](#index "Direct link to index?")

> `optional` **index**: `null` | `number`

Defined in: [WAProto/index.d.ts:4602](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4602)

* * *

### quickReplyButton?[​](#quickreplybutton "Direct link to quickReplyButton?")

> `optional` **quickReplyButton**: `null` | [`IHydratedQuickReplyButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedQuickReplyButton)

Defined in: [WAProto/index.d.ts:4603](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4603)

* * *

### urlButton?[​](#urlbutton "Direct link to urlButton?")

> `optional` **urlButton**: `null` | [`IHydratedURLButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedURLButton)

Defined in: [WAProto/index.d.ts:4604](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4604)

---

<a name="interface-iidentitykeypairstructure"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IIdentityKeyPairStructure](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IIdentityKeyPairStructure)

Defined in: [WAProto/index.d.ts:4694](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4694)

## Properties[​](#properties "Direct link to Properties")

### privateKey?[​](#privatekey "Direct link to privateKey?")

> `optional` **privateKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4696](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4696)

* * *

### publicKey?[​](#publickey "Direct link to publicKey?")

> `optional` **publicKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4695](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4695)

---

<a name="interface-iinthreadsurveymetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IInThreadSurveyMetadata)

Defined in: [WAProto/index.d.ts:4712](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4712)

## Properties[​](#properties "Direct link to Properties")

### feedbackToastText?[​](#feedbacktoasttext "Direct link to feedbackToastText?")

> `optional` **feedbackToastText**: `null` | `string`

Defined in: [WAProto/index.d.ts:4729](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4729)

* * *

### invitationBodyText?[​](#invitationbodytext "Direct link to invitationBodyText?")

> `optional` **invitationBodyText**: `null` | `string`

Defined in: [WAProto/index.d.ts:4720](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4720)

* * *

### invitationCtaText?[​](#invitationctatext "Direct link to invitationCtaText?")

> `optional` **invitationCtaText**: `null` | `string`

Defined in: [WAProto/index.d.ts:4721](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4721)

* * *

### invitationCtaUrl?[​](#invitationctaurl "Direct link to invitationCtaUrl?")

> `optional` **invitationCtaUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:4722](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4722)

* * *

### invitationHeaderText?[​](#invitationheadertext "Direct link to invitationHeaderText?")

> `optional` **invitationHeaderText**: `null` | `string`

Defined in: [WAProto/index.d.ts:4719](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4719)

* * *

### privacyStatementFull?[​](#privacystatementfull "Direct link to privacyStatementFull?")

> `optional` **privacyStatementFull**: `null` | `string`

Defined in: [WAProto/index.d.ts:4727](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4727)

* * *

### privacyStatementParts?[​](#privacystatementparts "Direct link to privacyStatementParts?")

> `optional` **privacyStatementParts**: `null` | [`IInThreadSurveyPrivacyStatementPart`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyPrivacyStatementPart)\[\]

Defined in: [WAProto/index.d.ts:4728](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4728)

* * *

### questions?[​](#questions "Direct link to questions?")

> `optional` **questions**: `null` | [`IInThreadSurveyQuestion`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyQuestion)\[\]

Defined in: [WAProto/index.d.ts:4724](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4724)

* * *

### requestId?[​](#requestid "Direct link to requestId?")

> `optional` **requestId**: `null` | `string`

Defined in: [WAProto/index.d.ts:4717](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4717)

* * *

### simonSessionId?[​](#simonsessionid "Direct link to simonSessionId?")

> `optional` **simonSessionId**: `null` | `string`

Defined in: [WAProto/index.d.ts:4714](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4714)

* * *

### simonSurveyId?[​](#simonsurveyid "Direct link to simonSurveyId?")

> `optional` **simonSurveyId**: `null` | `string`

Defined in: [WAProto/index.d.ts:4715](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4715)

* * *

### surveyContinueButtonText?[​](#surveycontinuebuttontext "Direct link to surveyContinueButtonText?")

> `optional` **surveyContinueButtonText**: `null` | `string`

Defined in: [WAProto/index.d.ts:4725](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4725)

* * *

### surveySubmitButtonText?[​](#surveysubmitbuttontext "Direct link to surveySubmitButtonText?")

> `optional` **surveySubmitButtonText**: `null` | `string`

Defined in: [WAProto/index.d.ts:4726](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4726)

* * *

### surveyTitle?[​](#surveytitle "Direct link to surveyTitle?")

> `optional` **surveyTitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:4723](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4723)

* * *

### tessaEvent?[​](#tessaevent "Direct link to tessaEvent?")

> `optional` **tessaEvent**: `null` | `string`

Defined in: [WAProto/index.d.ts:4718](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4718)

* * *

### tessaRootId?[​](#tessarootid "Direct link to tessaRootId?")

> `optional` **tessaRootId**: `null` | `string`

Defined in: [WAProto/index.d.ts:4716](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4716)

* * *

### tessaSessionId?[​](#tessasessionid "Direct link to tessaSessionId?")

> `optional` **tessaSessionId**: `null` | `string`

Defined in: [WAProto/index.d.ts:4713](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4713)

---

<a name="interface-iinteractiveannotation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation)

Defined in: [WAProto/index.d.ts:4821](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4821)

## Properties[​](#properties "Direct link to Properties")

### embeddedAction?[​](#embeddedaction "Direct link to embeddedAction?")

> `optional` **embeddedAction**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4828](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4828)

* * *

### embeddedContent?[​](#embeddedcontent "Direct link to embeddedContent?")

> `optional` **embeddedContent**: `null` | [`IEmbeddedContent`](/docs/api/namespaces/proto/interfaces/IEmbeddedContent)

Defined in: [WAProto/index.d.ts:4824](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4824)

* * *

### location?[​](#location "Direct link to location?")

> `optional` **location**: `null` | [`ILocation`](/docs/api/namespaces/proto/interfaces/ILocation)

Defined in: [WAProto/index.d.ts:4826](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4826)

* * *

### newsletter?[​](#newsletter "Direct link to newsletter?")

> `optional` **newsletter**: `null` | [`IForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo)

Defined in: [WAProto/index.d.ts:4827](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4827)

* * *

### polygonVertices?[​](#polygonvertices "Direct link to polygonVertices?")

> `optional` **polygonVertices**: `null` | [`IPoint`](/docs/api/namespaces/proto/interfaces/IPoint)\[\]

Defined in: [WAProto/index.d.ts:4822](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4822)

* * *

### shouldSkipConfirmation?[​](#shouldskipconfirmation "Direct link to shouldSkipConfirmation?")

> `optional` **shouldSkipConfirmation**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4823](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4823)

* * *

### statusLinkType?[​](#statuslinktype "Direct link to statusLinkType?")

> `optional` **statusLinkType**: `null` | [`StatusLinkType`](/docs/api/namespaces/proto/namespaces/InteractiveAnnotation/enumerations/StatusLinkType)

Defined in: [WAProto/index.d.ts:4825](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4825)

* * *

### tapAction?[​](#tapaction "Direct link to tapAction?")

> `optional` **tapAction**: `null` | [`ITapLinkAction`](/docs/api/namespaces/proto/interfaces/ITapLinkAction)

Defined in: [WAProto/index.d.ts:4829](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4829)

---

<a name="interface-iinteractivemessageadditionalmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IInteractiveMessageAdditionalMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IInteractiveMessageAdditionalMetadata)

Defined in: [WAProto/index.d.ts:4861](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4861)

## Properties[​](#properties "Direct link to Properties")

### isGalaxyFlowCompleted?[​](#isgalaxyflowcompleted "Direct link to isGalaxyFlowCompleted?")

> `optional` **isGalaxyFlowCompleted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4862](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4862)

---

<a name="interface-ikeepinchat"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IKeepInChat](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IKeepInChat)

Defined in: [WAProto/index.d.ts:4877](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4877)

## Properties[​](#properties "Direct link to Properties")

### clientTimestampMs?[​](#clienttimestampms "Direct link to clientTimestampMs?")

> `optional` **clientTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4882](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4882)

* * *

### deviceJid?[​](#devicejid "Direct link to deviceJid?")

> `optional` **deviceJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:4881](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4881)

* * *

### keepType?[​](#keeptype "Direct link to keepType?")

> `optional` **keepType**: `null` | [`KeepType`](/docs/api/namespaces/proto/enumerations/KeepType)

Defined in: [WAProto/index.d.ts:4878](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4878)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:4880](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4880)

* * *

### serverTimestamp?[​](#servertimestamp "Direct link to serverTimestamp?")

> `optional` **serverTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4879](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4879)

* * *

### serverTimestampMs?[​](#servertimestampms "Direct link to serverTimestampMs?")

> `optional` **serverTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4883](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4883)

---

<a name="interface-ikeyexchangemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IKeyExchangeMessage](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IKeyExchangeMessage)

Defined in: [WAProto/index.d.ts:4909](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4909)

## Properties[​](#properties "Direct link to Properties")

### baseKey?[​](#basekey "Direct link to baseKey?")

> `optional` **baseKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4911](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4911)

* * *

### baseKeySignature?[​](#basekeysignature "Direct link to baseKeySignature?")

> `optional` **baseKeySignature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4914](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4914)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `number`

Defined in: [WAProto/index.d.ts:4910](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4910)

* * *

### identityKey?[​](#identitykey "Direct link to identityKey?")

> `optional` **identityKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4913](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4913)

* * *

### ratchetKey?[​](#ratchetkey "Direct link to ratchetKey?")

> `optional` **ratchetKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4912](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4912)

---

<a name="interface-ikeyid"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IKeyId](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IKeyId)

Defined in: [WAProto/index.d.ts:4933](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4933)

## Properties[​](#properties "Direct link to Properties")

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4934](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4934)

---

<a name="interface-ilidmigrationmapping"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ILIDMigrationMapping](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ILIDMigrationMapping)

Defined in: [WAProto/index.d.ts:4949](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4949)

## Properties[​](#properties "Direct link to Properties")

### assignedLid?[​](#assignedlid "Direct link to assignedLid?")

> `optional` **assignedLid**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4951](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4951)

* * *

### latestLid?[​](#latestlid "Direct link to latestLid?")

> `optional` **latestLid**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4952](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4952)

* * *

### pn?[​](#pn "Direct link to pn?")

> `optional` **pn**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4950](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4950)

---

<a name="interface-ilidmigrationmappingsyncmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncMessage](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncMessage)

Defined in: [WAProto/index.d.ts:4969](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4969)

## Properties[​](#properties "Direct link to Properties")

### encodedMappingPayload?[​](#encodedmappingpayload "Direct link to encodedMappingPayload?")

> `optional` **encodedMappingPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4970](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4970)

---

<a name="interface-ilidmigrationmappingsyncpayload"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncPayload](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncPayload)

Defined in: [WAProto/index.d.ts:4985](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4985)

## Properties[​](#properties "Direct link to Properties")

### chatDbMigrationTimestamp?[​](#chatdbmigrationtimestamp "Direct link to chatDbMigrationTimestamp?")

> `optional` **chatDbMigrationTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:4987](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4987)

* * *

### pnToLidMappings?[​](#pntolidmappings "Direct link to pnToLidMappings?")

> `optional` **pnToLidMappings**: `null` | [`ILIDMigrationMapping`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMapping)\[\]

Defined in: [WAProto/index.d.ts:4986](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4986)

---

<a name="interface-ilegacymessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ILegacyMessage](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ILegacyMessage)

Defined in: [WAProto/index.d.ts:5003](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5003)

## Properties[​](#properties "Direct link to Properties")

### eventResponseMessage?[​](#eventresponsemessage "Direct link to eventResponseMessage?")

> `optional` **eventResponseMessage**: `null` | [`IEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventResponseMessage)

Defined in: [WAProto/index.d.ts:5004](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5004)

* * *

### pollVote?[​](#pollvote "Direct link to pollVote?")

> `optional` **pollVote**: `null` | [`IPollVoteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollVoteMessage)

Defined in: [WAProto/index.d.ts:5005](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5005)

---

<a name="interface-ilimitsharing"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ILimitSharing](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ILimitSharing)

Defined in: [WAProto/index.d.ts:5021](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5021)

## Properties[​](#properties "Direct link to Properties")

### initiatedByMe?[​](#initiatedbyme "Direct link to initiatedByMe?")

> `optional` **initiatedByMe**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:5025](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5025)

* * *

### limitSharingSettingTimestamp?[​](#limitsharingsettingtimestamp "Direct link to limitSharingSettingTimestamp?")

> `optional` **limitSharingSettingTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:5024](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5024)

* * *

### sharingLimited?[​](#sharinglimited "Direct link to sharingLimited?")

> `optional` **sharingLimited**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:5022](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5022)

* * *

### trigger?[​](#trigger "Direct link to trigger?")

> `optional` **trigger**: `null` | [`TriggerType`](/docs/api/namespaces/proto/namespaces/LimitSharing/enumerations/TriggerType)

Defined in: [WAProto/index.d.ts:5023](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5023)

---

<a name="interface-ilocalizedname"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ILocalizedName](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ILocalizedName)

Defined in: [WAProto/index.d.ts:5053](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5053)

## Properties[​](#properties "Direct link to Properties")

### lc?[​](#lc "Direct link to lc?")

> `optional` **lc**: `null` | `string`

Defined in: [WAProto/index.d.ts:5055](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5055)

* * *

### lg?[​](#lg "Direct link to lg?")

> `optional` **lg**: `null` | `string`

Defined in: [WAProto/index.d.ts:5054](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5054)

* * *

### verifiedName?[​](#verifiedname "Direct link to verifiedName?")

> `optional` **verifiedName**: `null` | `string`

Defined in: [WAProto/index.d.ts:5056](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5056)

---

<a name="interface-ilocation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ILocation](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ILocation)

Defined in: [WAProto/index.d.ts:5073](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5073)

## Properties[​](#properties "Direct link to Properties")

### degreesLatitude?[​](#degreeslatitude "Direct link to degreesLatitude?")

> `optional` **degreesLatitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:5074](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5074)

* * *

### degreesLongitude?[​](#degreeslongitude "Direct link to degreesLongitude?")

> `optional` **degreesLongitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:5075](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5075)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:5076](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5076)

---

<a name="interface-imediadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMediaData](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMediaData)

Defined in: [WAProto/index.d.ts:5093](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5093)

## Properties[​](#properties "Direct link to Properties")

### localPath?[​](#localpath "Direct link to localPath?")

> `optional` **localPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:5094](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5094)

---

<a name="interface-imedianotifymessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMediaNotifyMessage](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMediaNotifyMessage)

Defined in: [WAProto/index.d.ts:5109](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5109)

## Properties[​](#properties "Direct link to Properties")

### expressPathUrl?[​](#expresspathurl "Direct link to expressPathUrl?")

> `optional` **expressPathUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:5110](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5110)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5111](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5111)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:5112](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5112)

---

<a name="interface-imediaretrynotification"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMediaRetryNotification](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMediaRetryNotification)

Defined in: [WAProto/index.d.ts:5129](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5129)

## Properties[​](#properties "Direct link to Properties")

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:5131](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5131)

* * *

### messageSecret?[​](#messagesecret "Direct link to messageSecret?")

> `optional` **messageSecret**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5133](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5133)

* * *

### result?[​](#result "Direct link to result?")

> `optional` **result**: `null` | [`ResultType`](/docs/api/namespaces/proto/namespaces/MediaRetryNotification/enumerations/ResultType)

Defined in: [WAProto/index.d.ts:5132](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5132)

* * *

### stanzaId?[​](#stanzaid "Direct link to stanzaId?")

> `optional` **stanzaId**: `null` | `string`

Defined in: [WAProto/index.d.ts:5130](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5130)

---

<a name="interface-imemberlabel"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMemberLabel](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMemberLabel)

Defined in: [WAProto/index.d.ts:5167](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5167)

## Properties[​](#properties "Direct link to Properties")

### label?[​](#label "Direct link to label?")

> `optional` **label**: `null` | `string`

Defined in: [WAProto/index.d.ts:5168](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5168)

* * *

### labelTimestamp?[​](#labeltimestamp "Direct link to labelTimestamp?")

> `optional` **labelTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:5169](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5169)

---

<a name="interface-imessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMessage](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:5185](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5185)

## Properties[​](#properties "Direct link to Properties")

### albumMessage?[​](#albummessage "Direct link to albumMessage?")

> `optional` **albumMessage**: `null` | [`IAlbumMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAlbumMessage)

Defined in: [WAProto/index.d.ts:5254](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5254)

* * *

### associatedChildMessage?[​](#associatedchildmessage "Direct link to associatedChildMessage?")

> `optional` **associatedChildMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5260](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5260)

* * *

### audioMessage?[​](#audiomessage "Direct link to audioMessage?")

> `optional` **audioMessage**: `null` | [`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage)

Defined in: [WAProto/index.d.ts:5193](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5193)

* * *

### bcallMessage?[​](#bcallmessage "Direct link to bcallMessage?")

> `optional` **bcallMessage**: `null` | [`IBCallMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IBCallMessage)

Defined in: [WAProto/index.d.ts:5246](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5246)

* * *

### botForwardedMessage?[​](#botforwardedmessage "Direct link to botForwardedMessage?")

> `optional` **botForwardedMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5272](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5272)

* * *

### botInvokeMessage?[​](#botinvokemessage "Direct link to botInvokeMessage?")

> `optional` **botInvokeMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5242](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5242)

* * *

### botTaskMessage?[​](#bottaskmessage "Direct link to botTaskMessage?")

> `optional` **botTaskMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5268](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5268)

* * *

### buttonsMessage?[​](#buttonsmessage "Direct link to buttonsMessage?")

> `optional` **buttonsMessage**: `null` | [`IButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage)

Defined in: [WAProto/index.d.ts:5219](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5219)

* * *

### buttonsResponseMessage?[​](#buttonsresponsemessage "Direct link to buttonsResponseMessage?")

> `optional` **buttonsResponseMessage**: `null` | [`IButtonsResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsResponseMessage)

Defined in: [WAProto/index.d.ts:5220](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5220)

* * *

### call?[​](#call "Direct link to call?")

> `optional` **call**: `null` | [`ICall`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall)

Defined in: [WAProto/index.d.ts:5195](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5195)

* * *

### callLogMesssage?[​](#calllogmesssage "Direct link to callLogMesssage?")

> `optional` **callLogMesssage**: `null` | [`ICallLogMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICallLogMessage)

Defined in: [WAProto/index.d.ts:5243](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5243)

* * *

### cancelPaymentRequestMessage?[​](#cancelpaymentrequestmessage "Direct link to cancelPaymentRequestMessage?")

> `optional` **cancelPaymentRequestMessage**: `null` | [`ICancelPaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICancelPaymentRequestMessage)

Defined in: [WAProto/index.d.ts:5205](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5205)

* * *

### chat?[​](#chat "Direct link to chat?")

> `optional` **chat**: `null` | [`IChat`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IChat)

Defined in: [WAProto/index.d.ts:5196](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5196)

* * *

### commentMessage?[​](#commentmessage "Direct link to commentMessage?")

> `optional` **commentMessage**: `null` | [`ICommentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICommentMessage)

Defined in: [WAProto/index.d.ts:5250](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5250)

* * *

### contactMessage?[​](#contactmessage "Direct link to contactMessage?")

> `optional` **contactMessage**: `null` | [`IContactMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactMessage)

Defined in: [WAProto/index.d.ts:5189](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5189)

* * *

### contactsArrayMessage?[​](#contactsarraymessage "Direct link to contactsArrayMessage?")

> `optional` **contactsArrayMessage**: `null` | [`IContactsArrayMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactsArrayMessage)

Defined in: [WAProto/index.d.ts:5198](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5198)

* * *

### conversation?[​](#conversation "Direct link to conversation?")

> `optional` **conversation**: `null` | `string`

Defined in: [WAProto/index.d.ts:5186](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5186)

* * *

### declinePaymentRequestMessage?[​](#declinepaymentrequestmessage "Direct link to declinePaymentRequestMessage?")

> `optional` **declinePaymentRequestMessage**: `null` | [`IDeclinePaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeclinePaymentRequestMessage)

Defined in: [WAProto/index.d.ts:5204](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5204)

* * *

### deviceSentMessage?[​](#devicesentmessage "Direct link to deviceSentMessage?")

> `optional` **deviceSentMessage**: `null` | [`IDeviceSentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeviceSentMessage)

Defined in: [WAProto/index.d.ts:5211](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5211)

* * *

### documentMessage?[​](#documentmessage "Direct link to documentMessage?")

> `optional` **documentMessage**: `null` | [`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage)

Defined in: [WAProto/index.d.ts:5192](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5192)

* * *

### documentWithCaptionMessage?[​](#documentwithcaptionmessage "Direct link to documentWithCaptionMessage?")

> `optional` **documentWithCaptionMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5229](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5229)

* * *

### editedMessage?[​](#editedmessage "Direct link to editedMessage?")

> `optional` **editedMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5233](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5233)

* * *

### encCommentMessage?[​](#enccommentmessage "Direct link to encCommentMessage?")

> `optional` **encCommentMessage**: `null` | [`IEncCommentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncCommentMessage)

Defined in: [WAProto/index.d.ts:5245](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5245)

* * *

### encEventResponseMessage?[​](#enceventresponsemessage "Direct link to encEventResponseMessage?")

> `optional` **encEventResponseMessage**: `null` | [`IEncEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncEventResponseMessage)

Defined in: [WAProto/index.d.ts:5249](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5249)

* * *

### encReactionMessage?[​](#encreactionmessage "Direct link to encReactionMessage?")

> `optional` **encReactionMessage**: `null` | [`IEncReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncReactionMessage)

Defined in: [WAProto/index.d.ts:5232](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5232)

* * *

### ephemeralMessage?[​](#ephemeralmessage "Direct link to ephemeralMessage?")

> `optional` **ephemeralMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5217](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5217)

* * *

### eventCoverImage?[​](#eventcoverimage "Direct link to eventCoverImage?")

> `optional` **eventCoverImage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5255](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5255)

* * *

### eventMessage?[​](#eventmessage "Direct link to eventMessage?")

> `optional` **eventMessage**: `null` | [`IEventMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage)

Defined in: [WAProto/index.d.ts:5248](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5248)

* * *

### extendedTextMessage?[​](#extendedtextmessage "Direct link to extendedTextMessage?")

> `optional` **extendedTextMessage**: `null` | [`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage)

Defined in: [WAProto/index.d.ts:5191](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5191)

* * *

### fastRatchetKeySenderKeyDistributionMessage?[​](#fastratchetkeysenderkeydistributionmessage "Direct link to fastRatchetKeySenderKeyDistributionMessage?")

> `optional` **fastRatchetKeySenderKeyDistributionMessage**: `null` | [`ISenderKeyDistributionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISenderKeyDistributionMessage)

Defined in: [WAProto/index.d.ts:5200](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5200)

* * *

### groupInviteMessage?[​](#groupinvitemessage "Direct link to groupInviteMessage?")

> `optional` **groupInviteMessage**: `null` | [`IGroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage)

Defined in: [WAProto/index.d.ts:5208](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5208)

* * *

### groupMentionedMessage?[​](#groupmentionedmessage "Direct link to groupMentionedMessage?")

> `optional` **groupMentionedMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5237](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5237)

* * *

### groupStatusMentionMessage?[​](#groupstatusmentionmessage "Direct link to groupStatusMentionMessage?")

> `optional` **groupStatusMentionMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5261](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5261)

* * *

### groupStatusMessage?[​](#groupstatusmessage "Direct link to groupStatusMessage?")

> `optional` **groupStatusMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5264](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5264)

* * *

### groupStatusMessageV2?[​](#groupstatusmessagev2 "Direct link to groupStatusMessageV2?")

> `optional` **groupStatusMessageV2**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5271](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5271)

* * *

### highlyStructuredMessage?[​](#highlystructuredmessage "Direct link to highlyStructuredMessage?")

> `optional` **highlyStructuredMessage**: `null` | [`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:5199](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5199)

* * *

### imageMessage?[​](#imagemessage "Direct link to imageMessage?")

> `optional` **imageMessage**: `null` | [`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage)

Defined in: [WAProto/index.d.ts:5188](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5188)

* * *

### interactiveMessage?[​](#interactivemessage "Direct link to interactiveMessage?")

> `optional` **interactiveMessage**: `null` | [`IInteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage)

Defined in: [WAProto/index.d.ts:5222](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5222)

* * *

### interactiveResponseMessage?[​](#interactiveresponsemessage "Direct link to interactiveResponseMessage?")

> `optional` **interactiveResponseMessage**: `null` | [`IInteractiveResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveResponseMessage)

Defined in: [WAProto/index.d.ts:5225](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5225)

* * *

### invoiceMessage?[​](#invoicemessage "Direct link to invoiceMessage?")

> `optional` **invoiceMessage**: `null` | [`IInvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage)

Defined in: [WAProto/index.d.ts:5218](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5218)

* * *

### keepInChatMessage?[​](#keepinchatmessage "Direct link to keepInChatMessage?")

> `optional` **keepInChatMessage**: `null` | [`IKeepInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IKeepInChatMessage)

Defined in: [WAProto/index.d.ts:5228](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5228)

* * *

### limitSharingMessage?[​](#limitsharingmessage "Direct link to limitSharingMessage?")

> `optional` **limitSharingMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5267](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5267)

* * *

### listMessage?[​](#listmessage "Direct link to listMessage?")

> `optional` **listMessage**: `null` | [`IListMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage)

Defined in: [WAProto/index.d.ts:5213](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5213)

* * *

### listResponseMessage?[​](#listresponsemessage "Direct link to listResponseMessage?")

> `optional` **listResponseMessage**: `null` | [`IListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListResponseMessage)

Defined in: [WAProto/index.d.ts:5216](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5216)

* * *

### liveLocationMessage?[​](#livelocationmessage "Direct link to liveLocationMessage?")

> `optional` **liveLocationMessage**: `null` | [`ILiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage)

Defined in: [WAProto/index.d.ts:5202](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5202)

* * *

### locationMessage?[​](#locationmessage "Direct link to locationMessage?")

> `optional` **locationMessage**: `null` | [`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage)

Defined in: [WAProto/index.d.ts:5190](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5190)

* * *

### lottieStickerMessage?[​](#lottiestickermessage "Direct link to lottieStickerMessage?")

> `optional` **lottieStickerMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5247](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5247)

* * *

### messageContextInfo?[​](#messagecontextinfo "Direct link to messageContextInfo?")

> `optional` **messageContextInfo**: `null` | [`IMessageContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageContextInfo)

Defined in: [WAProto/index.d.ts:5212](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5212)

* * *

### messageHistoryBundle?[​](#messagehistorybundle "Direct link to messageHistoryBundle?")

> `optional` **messageHistoryBundle**: `null` | [`IMessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle)

Defined in: [WAProto/index.d.ts:5244](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5244)

* * *

### messageHistoryNotice?[​](#messagehistorynotice "Direct link to messageHistoryNotice?")

> `optional` **messageHistoryNotice**: `null` | [`IMessageHistoryNotice`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryNotice)

Defined in: [WAProto/index.d.ts:5270](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5270)

* * *

### newsletterAdminInviteMessage?[​](#newsletteradmininvitemessage "Direct link to newsletterAdminInviteMessage?")

> `optional` **newsletterAdminInviteMessage**: `null` | [`INewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage)

Defined in: [WAProto/index.d.ts:5251](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5251)

* * *

### newsletterFollowerInviteMessageV2?[​](#newsletterfollowerinvitemessagev2 "Direct link to newsletterFollowerInviteMessageV2?")

> `optional` **newsletterFollowerInviteMessageV2**: `null` | [`INewsletterFollowerInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterFollowerInviteMessage)

Defined in: [WAProto/index.d.ts:5279](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5279)

* * *

### orderMessage?[​](#ordermessage "Direct link to orderMessage?")

> `optional` **orderMessage**: `null` | [`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage)

Defined in: [WAProto/index.d.ts:5215](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5215)

* * *

### paymentInviteMessage?[​](#paymentinvitemessage "Direct link to paymentInviteMessage?")

> `optional` **paymentInviteMessage**: `null` | [`IPaymentInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentInviteMessage)

Defined in: [WAProto/index.d.ts:5221](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5221)

* * *

### pinInChatMessage?[​](#pininchatmessage "Direct link to pinInChatMessage?")

> `optional` **pinInChatMessage**: `null` | [`IPinInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPinInChatMessage)

Defined in: [WAProto/index.d.ts:5238](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5238)

* * *

### placeholderMessage?[​](#placeholdermessage "Direct link to placeholderMessage?")

> `optional` **placeholderMessage**: `null` | [`IPlaceholderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPlaceholderMessage)

Defined in: [WAProto/index.d.ts:5252](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5252)

* * *

### pollCreationMessage?[​](#pollcreationmessage "Direct link to pollCreationMessage?")

> `optional` **pollCreationMessage**: `null` | [`IPollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage)

Defined in: [WAProto/index.d.ts:5226](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5226)

* * *

### pollCreationMessageV2?[​](#pollcreationmessagev2 "Direct link to pollCreationMessageV2?")

> `optional` **pollCreationMessageV2**: `null` | [`IPollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage)

Defined in: [WAProto/index.d.ts:5235](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5235)

* * *

### pollCreationMessageV3?[​](#pollcreationmessagev3 "Direct link to pollCreationMessageV3?")

> `optional` **pollCreationMessageV3**: `null` | [`IPollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage)

Defined in: [WAProto/index.d.ts:5239](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5239)

* * *

### pollCreationMessageV4?[​](#pollcreationmessagev4 "Direct link to pollCreationMessageV4?")

> `optional` **pollCreationMessageV4**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5262](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5262)

* * *

### pollCreationMessageV5?[​](#pollcreationmessagev5 "Direct link to pollCreationMessageV5?")

> `optional` **pollCreationMessageV5**: `null` | [`IPollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage)

Defined in: [WAProto/index.d.ts:5278](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5278)

* * *

### pollCreationOptionImageMessage?[​](#pollcreationoptionimagemessage "Direct link to pollCreationOptionImageMessage?")

> `optional` **pollCreationOptionImageMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5259](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5259)

* * *

### pollResultSnapshotMessage?[​](#pollresultsnapshotmessage "Direct link to pollResultSnapshotMessage?")

> `optional` **pollResultSnapshotMessage**: `null` | [`IPollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollResultSnapshotMessage)

Defined in: [WAProto/index.d.ts:5258](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5258)

* * *

### pollResultSnapshotMessageV3?[​](#pollresultsnapshotmessagev3 "Direct link to pollResultSnapshotMessageV3?")

> `optional` **pollResultSnapshotMessageV3**: `null` | [`IPollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollResultSnapshotMessage)

Defined in: [WAProto/index.d.ts:5280](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5280)

* * *

### pollUpdateMessage?[​](#pollupdatemessage "Direct link to pollUpdateMessage?")

> `optional` **pollUpdateMessage**: `null` | [`IPollUpdateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessage)

Defined in: [WAProto/index.d.ts:5227](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5227)

* * *

### productMessage?[​](#productmessage "Direct link to productMessage?")

> `optional` **productMessage**: `null` | [`IProductMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage)

Defined in: [WAProto/index.d.ts:5210](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5210)

* * *

### protocolMessage?[​](#protocolmessage "Direct link to protocolMessage?")

> `optional` **protocolMessage**: `null` | [`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage)

Defined in: [WAProto/index.d.ts:5197](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5197)

* * *

### ptvMessage?[​](#ptvmessage "Direct link to ptvMessage?")

> `optional` **ptvMessage**: `null` | [`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage)

Defined in: [WAProto/index.d.ts:5241](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5241)

* * *

### questionMessage?[​](#questionmessage "Direct link to questionMessage?")

> `optional` **questionMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5269](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5269)

* * *

### questionReplyMessage?[​](#questionreplymessage "Direct link to questionReplyMessage?")

> `optional` **questionReplyMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5274](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5274)

* * *

### questionResponseMessage?[​](#questionresponsemessage "Direct link to questionResponseMessage?")

> `optional` **questionResponseMessage**: `null` | [`IQuestionResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IQuestionResponseMessage)

Defined in: [WAProto/index.d.ts:5275](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5275)

* * *

### reactionMessage?[​](#reactionmessage "Direct link to reactionMessage?")

> `optional` **reactionMessage**: `null` | [`IReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IReactionMessage)

Defined in: [WAProto/index.d.ts:5223](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5223)

* * *

### requestPaymentMessage?[​](#requestpaymentmessage "Direct link to requestPaymentMessage?")

> `optional` **requestPaymentMessage**: `null` | [`IRequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage)

Defined in: [WAProto/index.d.ts:5203](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5203)

* * *

### requestPhoneNumberMessage?[​](#requestphonenumbermessage "Direct link to requestPhoneNumberMessage?")

> `optional` **requestPhoneNumberMessage**: `null` | [`IRequestPhoneNumberMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPhoneNumberMessage)

Defined in: [WAProto/index.d.ts:5230](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5230)

* * *

### richResponseMessage?[​](#richresponsemessage "Direct link to richResponseMessage?")

> `optional` **richResponseMessage**: `null` | [`IAIRichResponseMessage`](/docs/api/namespaces/proto/interfaces/IAIRichResponseMessage)

Defined in: [WAProto/index.d.ts:5265](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5265)

* * *

### scheduledCallCreationMessage?[​](#scheduledcallcreationmessage "Direct link to scheduledCallCreationMessage?")

> `optional` **scheduledCallCreationMessage**: `null` | [`IScheduledCallCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallCreationMessage)

Defined in: [WAProto/index.d.ts:5236](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5236)

* * *

### scheduledCallEditMessage?[​](#scheduledcalleditmessage "Direct link to scheduledCallEditMessage?")

> `optional` **scheduledCallEditMessage**: `null` | [`IScheduledCallEditMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallEditMessage)

Defined in: [WAProto/index.d.ts:5240](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5240)

* * *

### secretEncryptedMessage?[​](#secretencryptedmessage "Direct link to secretEncryptedMessage?")

> `optional` **secretEncryptedMessage**: `null` | [`ISecretEncryptedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISecretEncryptedMessage)

Defined in: [WAProto/index.d.ts:5253](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5253)

* * *

### senderKeyDistributionMessage?[​](#senderkeydistributionmessage "Direct link to senderKeyDistributionMessage?")

> `optional` **senderKeyDistributionMessage**: `null` | [`ISenderKeyDistributionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISenderKeyDistributionMessage)

Defined in: [WAProto/index.d.ts:5187](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5187)

* * *

### sendPaymentMessage?[​](#sendpaymentmessage "Direct link to sendPaymentMessage?")

> `optional` **sendPaymentMessage**: `null` | [`ISendPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISendPaymentMessage)

Defined in: [WAProto/index.d.ts:5201](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5201)

* * *

### statusAddYours?[​](#statusaddyours "Direct link to statusAddYours?")

> `optional` **statusAddYours**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5263](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5263)

* * *

### statusMentionMessage?[​](#statusmentionmessage "Direct link to statusMentionMessage?")

> `optional` **statusMentionMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5257](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5257)

* * *

### statusNotificationMessage?[​](#statusnotificationmessage "Direct link to statusNotificationMessage?")

> `optional` **statusNotificationMessage**: `null` | [`IStatusNotificationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusNotificationMessage)

Defined in: [WAProto/index.d.ts:5266](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5266)

* * *

### statusQuestionAnswerMessage?[​](#statusquestionanswermessage "Direct link to statusQuestionAnswerMessage?")

> `optional` **statusQuestionAnswerMessage**: `null` | [`IStatusQuestionAnswerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuestionAnswerMessage)

Defined in: [WAProto/index.d.ts:5273](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5273)

* * *

### statusQuotedMessage?[​](#statusquotedmessage "Direct link to statusQuotedMessage?")

> `optional` **statusQuotedMessage**: `null` | [`IStatusQuotedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuotedMessage)

Defined in: [WAProto/index.d.ts:5276](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5276)

* * *

### statusStickerInteractionMessage?[​](#statusstickerinteractionmessage "Direct link to statusStickerInteractionMessage?")

> `optional` **statusStickerInteractionMessage**: `null` | [`IStatusStickerInteractionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusStickerInteractionMessage)

Defined in: [WAProto/index.d.ts:5277](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5277)

* * *

### stickerMessage?[​](#stickermessage "Direct link to stickerMessage?")

> `optional` **stickerMessage**: `null` | [`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage)

Defined in: [WAProto/index.d.ts:5207](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5207)

* * *

### stickerPackMessage?[​](#stickerpackmessage "Direct link to stickerPackMessage?")

> `optional` **stickerPackMessage**: `null` | [`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage)

Defined in: [WAProto/index.d.ts:5256](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5256)

* * *

### stickerSyncRmrMessage?[​](#stickersyncrmrmessage "Direct link to stickerSyncRmrMessage?")

> `optional` **stickerSyncRmrMessage**: `null` | [`IStickerSyncRMRMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerSyncRMRMessage)

Defined in: [WAProto/index.d.ts:5224](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5224)

* * *

### templateButtonReplyMessage?[​](#templatebuttonreplymessage "Direct link to templateButtonReplyMessage?")

> `optional` **templateButtonReplyMessage**: `null` | [`ITemplateButtonReplyMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateButtonReplyMessage)

Defined in: [WAProto/index.d.ts:5209](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5209)

* * *

### templateMessage?[​](#templatemessage "Direct link to templateMessage?")

> `optional` **templateMessage**: `null` | [`ITemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage)

Defined in: [WAProto/index.d.ts:5206](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5206)

* * *

### videoMessage?[​](#videomessage "Direct link to videoMessage?")

> `optional` **videoMessage**: `null` | [`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage)

Defined in: [WAProto/index.d.ts:5194](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5194)

* * *

### viewOnceMessage?[​](#viewoncemessage "Direct link to viewOnceMessage?")

> `optional` **viewOnceMessage**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5214](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5214)

* * *

### viewOnceMessageV2?[​](#viewoncemessagev2 "Direct link to viewOnceMessageV2?")

> `optional` **viewOnceMessageV2**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5231](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5231)

* * *

### viewOnceMessageV2Extension?[​](#viewoncemessagev2extension "Direct link to viewOnceMessageV2Extension?")

> `optional` **viewOnceMessageV2Extension**: `null` | [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:5234](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5234)

---

<a name="interface-imessageaddon"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMessageAddOn](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMessageAddOn)

Defined in: [WAProto/index.d.ts:9408](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9408)

## Properties[​](#properties "Direct link to Properties")

### addOnContextInfo?[​](#addoncontextinfo "Direct link to addOnContextInfo?")

> `optional` **addOnContextInfo**: `null` | [`IMessageAddOnContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageAddOnContextInfo)

Defined in: [WAProto/index.d.ts:9414](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9414)

* * *

### legacyMessage?[​](#legacymessage "Direct link to legacyMessage?")

> `optional` **legacyMessage**: `null` | [`ILegacyMessage`](/docs/api/namespaces/proto/interfaces/ILegacyMessage)

Defined in: [WAProto/index.d.ts:9416](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9416)

* * *

### messageAddOn?[​](#messageaddon "Direct link to messageAddOn?")

> `optional` **messageAddOn**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:9410](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9410)

* * *

### messageAddOnKey?[​](#messageaddonkey "Direct link to messageAddOnKey?")

> `optional` **messageAddOnKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:9415](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9415)

* * *

### messageAddOnType?[​](#messageaddontype "Direct link to messageAddOnType?")

> `optional` **messageAddOnType**: `null` | [`MessageAddOnType`](/docs/api/namespaces/proto/namespaces/MessageAddOn/enumerations/MessageAddOnType)

Defined in: [WAProto/index.d.ts:9409](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9409)

* * *

### senderTimestampMs?[​](#sendertimestampms "Direct link to senderTimestampMs?")

> `optional` **senderTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9411](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9411)

* * *

### serverTimestampMs?[​](#servertimestampms "Direct link to serverTimestampMs?")

> `optional` **serverTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9412](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9412)

* * *

### status?[​](#status "Direct link to status?")

> `optional` **status**: `null` | [`Status`](/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/Status)

Defined in: [WAProto/index.d.ts:9413](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9413)

---

<a name="interface-imessageaddoncontextinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMessageAddOnContextInfo](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMessageAddOnContextInfo)

Defined in: [WAProto/index.d.ts:9449](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9449)

## Properties[​](#properties "Direct link to Properties")

### messageAddOnDurationInSecs?[​](#messageaddondurationinsecs "Direct link to messageAddOnDurationInSecs?")

> `optional` **messageAddOnDurationInSecs**: `null` | `number`

Defined in: [WAProto/index.d.ts:9450](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9450)

* * *

### messageAddOnExpiryType?[​](#messageaddonexpirytype "Direct link to messageAddOnExpiryType?")

> `optional` **messageAddOnExpiryType**: `null` | [`MessageAddonExpiryType`](/docs/api/namespaces/proto/namespaces/MessageContextInfo/enumerations/MessageAddonExpiryType)

Defined in: [WAProto/index.d.ts:9451](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9451)

---

<a name="interface-imessageassociation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMessageAssociation](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMessageAssociation)

Defined in: [WAProto/index.d.ts:9467](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9467)

## Properties[​](#properties "Direct link to Properties")

### associationType?[​](#associationtype "Direct link to associationType?")

> `optional` **associationType**: `null` | [`AssociationType`](/docs/api/namespaces/proto/namespaces/MessageAssociation/enumerations/AssociationType)

Defined in: [WAProto/index.d.ts:9468](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9468)

* * *

### messageIndex?[​](#messageindex "Direct link to messageIndex?")

> `optional` **messageIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:9470](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9470)

* * *

### parentMessageKey?[​](#parentmessagekey "Direct link to parentMessageKey?")

> `optional` **parentMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:9469](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9469)

---

<a name="interface-imessagecontextinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMessageContextInfo](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMessageContextInfo)

Defined in: [WAProto/index.d.ts:9513](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9513)

## Properties[​](#properties "Direct link to Properties")

### botMessageSecret?[​](#botmessagesecret "Direct link to botMessageSecret?")

> `optional` **botMessageSecret**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9519](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9519)

* * *

### botMetadata?[​](#botmetadata "Direct link to botMetadata?")

> `optional` **botMetadata**: `null` | [`IBotMetadata`](/docs/api/namespaces/proto/interfaces/IBotMetadata)

Defined in: [WAProto/index.d.ts:9520](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9520)

* * *

### capiCreatedGroup?[​](#capicreatedgroup "Direct link to capiCreatedGroup?")

> `optional` **capiCreatedGroup**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9524](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9524)

* * *

### deviceListMetadata?[​](#devicelistmetadata "Direct link to deviceListMetadata?")

> `optional` **deviceListMetadata**: `null` | [`IDeviceListMetadata`](/docs/api/namespaces/proto/interfaces/IDeviceListMetadata)

Defined in: [WAProto/index.d.ts:9514](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9514)

* * *

### deviceListMetadataVersion?[​](#devicelistmetadataversion "Direct link to deviceListMetadataVersion?")

> `optional` **deviceListMetadataVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:9515](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9515)

* * *

### limitSharing?[​](#limitsharing "Direct link to limitSharing?")

> `optional` **limitSharing**: `null` | [`ILimitSharing`](/docs/api/namespaces/proto/interfaces/ILimitSharing)

Defined in: [WAProto/index.d.ts:9526](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9526)

* * *

### limitSharingV2?[​](#limitsharingv2 "Direct link to limitSharingV2?")

> `optional` **limitSharingV2**: `null` | [`ILimitSharing`](/docs/api/namespaces/proto/interfaces/ILimitSharing)

Defined in: [WAProto/index.d.ts:9527](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9527)

* * *

### messageAddOnDurationInSecs?[​](#messageaddondurationinsecs "Direct link to messageAddOnDurationInSecs?")

> `optional` **messageAddOnDurationInSecs**: `null` | `number`

Defined in: [WAProto/index.d.ts:9518](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9518)

* * *

### messageAddOnExpiryType?[​](#messageaddonexpirytype "Direct link to messageAddOnExpiryType?")

> `optional` **messageAddOnExpiryType**: `null` | [`MessageAddonExpiryType`](/docs/api/namespaces/proto/namespaces/MessageContextInfo/enumerations/MessageAddonExpiryType)

Defined in: [WAProto/index.d.ts:9522](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9522)

* * *

### messageAssociation?[​](#messageassociation "Direct link to messageAssociation?")

> `optional` **messageAssociation**: `null` | [`IMessageAssociation`](/docs/api/namespaces/proto/interfaces/IMessageAssociation)

Defined in: [WAProto/index.d.ts:9523](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9523)

* * *

### messageSecret?[​](#messagesecret "Direct link to messageSecret?")

> `optional` **messageSecret**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9516](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9516)

* * *

### paddingBytes?[​](#paddingbytes "Direct link to paddingBytes?")

> `optional` **paddingBytes**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9517](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9517)

* * *

### reportingTokenVersion?[​](#reportingtokenversion "Direct link to reportingTokenVersion?")

> `optional` **reportingTokenVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:9521](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9521)

* * *

### supportPayload?[​](#supportpayload "Direct link to supportPayload?")

> `optional` **supportPayload**: `null` | `string`

Defined in: [WAProto/index.d.ts:9525](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9525)

* * *

### threadId?[​](#threadid "Direct link to threadId?")

> `optional` **threadId**: `null` | [`IThreadID`](/docs/api/namespaces/proto/interfaces/IThreadID)\[\]

Defined in: [WAProto/index.d.ts:9528](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9528)

* * *

### weblinkRenderConfig?[​](#weblinkrenderconfig "Direct link to weblinkRenderConfig?")

> `optional` **weblinkRenderConfig**: `null` | [`WebLinkRenderConfig`](/docs/api/namespaces/proto/enumerations/WebLinkRenderConfig)

Defined in: [WAProto/index.d.ts:9529](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9529)

---

<a name="interface-imessagekey"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMessageKey](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:9567](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9567)

## Properties[​](#properties "Direct link to Properties")

### fromMe?[​](#fromme "Direct link to fromMe?")

> `optional` **fromMe**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9569](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9569)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:9570](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9570)

* * *

### participant?[​](#participant "Direct link to participant?")

> `optional` **participant**: `null` | `string`

Defined in: [WAProto/index.d.ts:9571](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9571)

* * *

### remoteJid?[​](#remotejid "Direct link to remoteJid?")

> `optional` **remoteJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:9568](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9568)

---

<a name="interface-imessagesecretmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMessageSecretMessage](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMessageSecretMessage)

Defined in: [WAProto/index.d.ts:9589](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9589)

## Properties[​](#properties "Direct link to Properties")

### encIv?[​](#enciv "Direct link to encIv?")

> `optional` **encIv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9591](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9591)

* * *

### encPayload?[​](#encpayload "Direct link to encPayload?")

> `optional` **encPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9592](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9592)

* * *

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | `number`

Defined in: [WAProto/index.d.ts:9590](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9590)

---

<a name="interface-imoney"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMoney](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMoney)

Defined in: [WAProto/index.d.ts:9609](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9609)

## Properties[​](#properties "Direct link to Properties")

### currencyCode?[​](#currencycode "Direct link to currencyCode?")

> `optional` **currencyCode**: `null` | `string`

Defined in: [WAProto/index.d.ts:9612](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9612)

* * *

### offset?[​](#offset "Direct link to offset?")

> `optional` **offset**: `null` | `number`

Defined in: [WAProto/index.d.ts:9611](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9611)

* * *

### value?[​](#value "Direct link to value?")

> `optional` **value**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9610](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9610)

---

<a name="interface-imsgopaquedata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMsgOpaqueData](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMsgOpaqueData)

Defined in: [WAProto/index.d.ts:9629](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9629)

## Properties[​](#properties "Direct link to Properties")

### body?[​](#body "Direct link to body?")

> `optional` **body**: `null` | `string`

Defined in: [WAProto/index.d.ts:9630](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9630)

* * *

### botMessageSecret?[​](#botmessagesecret "Direct link to botMessageSecret?")

> `optional` **botMessageSecret**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9659](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9659)

* * *

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:9631](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9631)

* * *

### clientUrl?[​](#clienturl "Direct link to clientUrl?")

> `optional` **clientUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:9641](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9641)

* * *

### correctOptionIndex?[​](#correctoptionindex "Direct link to correctOptionIndex?")

> `optional` **correctOptionIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:9654](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9654)

* * *

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:9639](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9639)

* * *

### encIv?[​](#enciv "Direct link to encIv?")

> `optional` **encIv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9662](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9662)

* * *

### encPayload?[​](#encpayload "Direct link to encPayload?")

> `optional` **encPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9661](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9661)

* * *

### encPollVote?[​](#encpollvote "Direct link to encPollVote?")

> `optional` **encPollVote**: `null` | [`IPollEncValue`](/docs/api/namespaces/proto/interfaces/IPollEncValue)

Defined in: [WAProto/index.d.ts:9650](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9650)

* * *

### encReactionEncIv?[​](#encreactionenciv "Direct link to encReactionEncIv?")

> `optional` **encReactionEncIv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9658](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9658)

* * *

### encReactionEncPayload?[​](#encreactionencpayload "Direct link to encReactionEncPayload?")

> `optional` **encReactionEncPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9657](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9657)

* * *

### encReactionTargetMessageKey?[​](#encreactiontargetmessagekey "Direct link to encReactionTargetMessageKey?")

> `optional` **encReactionTargetMessageKey**: `null` | `string`

Defined in: [WAProto/index.d.ts:9656](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9656)

* * *

### eventDescription?[​](#eventdescription "Direct link to eventDescription?")

> `optional` **eventDescription**: `null` | `string`

Defined in: [WAProto/index.d.ts:9665](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9665)

* * *

### eventEndTime?[​](#eventendtime "Direct link to eventEndTime?")

> `optional` **eventEndTime**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9669](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9669)

* * *

### eventExtraGuestsAllowed?[​](#eventextraguestsallowed "Direct link to eventExtraGuestsAllowed?")

> `optional` **eventExtraGuestsAllowed**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9671](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9671)

* * *

### eventIsScheduledCall?[​](#eventisscheduledcall "Direct link to eventIsScheduledCall?")

> `optional` **eventIsScheduledCall**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9670](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9670)

* * *

### eventJoinLink?[​](#eventjoinlink "Direct link to eventJoinLink?")

> `optional` **eventJoinLink**: `null` | `string`

Defined in: [WAProto/index.d.ts:9666](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9666)

* * *

### eventLocation?[​](#eventlocation "Direct link to eventLocation?")

> `optional` **eventLocation**: `null` | [`IEventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation)

Defined in: [WAProto/index.d.ts:9668](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9668)

* * *

### eventName?[​](#eventname "Direct link to eventName?")

> `optional` **eventName**: `null` | `string`

Defined in: [WAProto/index.d.ts:9663](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9663)

* * *

### eventStartTime?[​](#eventstarttime "Direct link to eventStartTime?")

> `optional` **eventStartTime**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9667](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9667)

* * *

### futureproofBuffer?[​](#futureproofbuffer "Direct link to futureproofBuffer?")

> `optional` **futureproofBuffer**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9640](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9640)

* * *

### isEventCanceled?[​](#iseventcanceled "Direct link to isEventCanceled?")

> `optional` **isEventCanceled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9664](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9664)

* * *

### isLive?[​](#islive "Direct link to isLive?")

> `optional` **isLive**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9633](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9633)

* * *

### isSentCagPollCreation?[​](#issentcagpollcreation "Direct link to isSentCagPollCreation?")

> `optional` **isSentCagPollCreation**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9651](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9651)

* * *

### lat?[​](#lat "Direct link to lat?")

> `optional` **lat**: `null` | `number`

Defined in: [WAProto/index.d.ts:9634](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9634)

* * *

### lng?[​](#lng "Direct link to lng?")

> `optional` **lng**: `null` | `number`

Defined in: [WAProto/index.d.ts:9632](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9632)

* * *

### loc?[​](#loc "Direct link to loc?")

> `optional` **loc**: `null` | `string`

Defined in: [WAProto/index.d.ts:9642](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9642)

* * *

### matchedText?[​](#matchedtext "Direct link to matchedText?")

> `optional` **matchedText**: `null` | `string`

Defined in: [WAProto/index.d.ts:9637](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9637)

* * *

### messageSecret?[​](#messagesecret "Direct link to messageSecret?")

> `optional` **messageSecret**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9646](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9646)

* * *

### originalSelfAuthor?[​](#originalselfauthor "Direct link to originalSelfAuthor?")

> `optional` **originalSelfAuthor**: `null` | `string`

Defined in: [WAProto/index.d.ts:9647](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9647)

* * *

### paymentAmount1000?[​](#paymentamount1000 "Direct link to paymentAmount1000?")

> `optional` **paymentAmount1000**: `null` | `number`

Defined in: [WAProto/index.d.ts:9635](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9635)

* * *

### paymentNoteMsgBody?[​](#paymentnotemsgbody "Direct link to paymentNoteMsgBody?")

> `optional` **paymentNoteMsgBody**: `null` | `string`

Defined in: [WAProto/index.d.ts:9636](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9636)

* * *

### plainProtobufBytes?[​](#plainprotobufbytes "Direct link to plainProtobufBytes?")

> `optional` **plainProtobufBytes**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9672](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9672)

* * *

### pollContentType?[​](#pollcontenttype "Direct link to pollContentType?")

> `optional` **pollContentType**: `null` | [`PollContentType`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/enumerations/PollContentType)

Defined in: [WAProto/index.d.ts:9652](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9652)

* * *

### pollName?[​](#pollname "Direct link to pollName?")

> `optional` **pollName**: `null` | `string`

Defined in: [WAProto/index.d.ts:9643](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9643)

* * *

### pollOptions?[​](#polloptions "Direct link to pollOptions?")

> `optional` **pollOptions**: `null` | [`IPollOption`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollOption)\[\]

Defined in: [WAProto/index.d.ts:9644](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9644)

* * *

### pollSelectableOptionsCount?[​](#pollselectableoptionscount "Direct link to pollSelectableOptionsCount?")

> `optional` **pollSelectableOptionsCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:9645](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9645)

* * *

### pollType?[​](#polltype "Direct link to pollType?")

> `optional` **pollType**: `null` | [`PollType`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/enumerations/PollType)

Defined in: [WAProto/index.d.ts:9653](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9653)

* * *

### pollUpdateParentKey?[​](#pollupdateparentkey "Direct link to pollUpdateParentKey?")

> `optional` **pollUpdateParentKey**: `null` | `string`

Defined in: [WAProto/index.d.ts:9649](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9649)

* * *

### pollVotesSnapshot?[​](#pollvotessnapshot "Direct link to pollVotesSnapshot?")

> `optional` **pollVotesSnapshot**: `null` | [`IPollVotesSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVotesSnapshot)

Defined in: [WAProto/index.d.ts:9655](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9655)

* * *

### senderTimestampMs?[​](#sendertimestampms "Direct link to senderTimestampMs?")

> `optional` **senderTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9648](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9648)

* * *

### targetMessageKey?[​](#targetmessagekey "Direct link to targetMessageKey?")

> `optional` **targetMessageKey**: `null` | `string`

Defined in: [WAProto/index.d.ts:9660](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9660)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:9638](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9638)

---

<a name="interface-imsgrowopaquedata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMsgRowOpaqueData](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IMsgRowOpaqueData)

Defined in: [WAProto/index.d.ts:9821](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9821)

## Properties[​](#properties "Direct link to Properties")

### currentMsg?[​](#currentmsg "Direct link to currentMsg?")

> `optional` **currentMsg**: `null` | [`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData)

Defined in: [WAProto/index.d.ts:9822](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9822)

* * *

### quotedMsg?[​](#quotedmsg "Direct link to quotedMsg?")

> `optional` **quotedMsg**: `null` | [`IMsgOpaqueData`](/docs/api/namespaces/proto/interfaces/IMsgOpaqueData)

Defined in: [WAProto/index.d.ts:9823](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9823)

---

<a name="interface-inoisecertificate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/INoiseCertificate](https://baileys.wiki/docs/api/namespaces/proto/interfaces/INoiseCertificate)

Defined in: [WAProto/index.d.ts:9915](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9915)

## Properties[​](#properties "Direct link to Properties")

### details?[​](#details "Direct link to details?")

> `optional` **details**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9916](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9916)

* * *

### signature?[​](#signature "Direct link to signature?")

> `optional` **signature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9917](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9917)

---

<a name="interface-inotificationmessageinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/INotificationMessageInfo](https://baileys.wiki/docs/api/namespaces/proto/interfaces/INotificationMessageInfo)

Defined in: [WAProto/index.d.ts:9960](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9960)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:9961](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9961)

* * *

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:9962](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9962)

* * *

### messageTimestamp?[​](#messagetimestamp "Direct link to messageTimestamp?")

> `optional` **messageTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9963](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9963)

* * *

### participant?[​](#participant "Direct link to participant?")

> `optional` **participant**: `null` | `string`

Defined in: [WAProto/index.d.ts:9964](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9964)

---

<a name="interface-inotificationsettings"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/INotificationSettings](https://baileys.wiki/docs/api/namespaces/proto/interfaces/INotificationSettings)

Defined in: [WAProto/index.d.ts:9982](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9982)

## Properties[​](#properties "Direct link to Properties")

### callVibrate?[​](#callvibrate "Direct link to callVibrate?")

> `optional` **callVibrate**: `null` | `string`

Defined in: [WAProto/index.d.ts:9988](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9988)

* * *

### lowPriorityNotifications?[​](#lowprioritynotifications "Direct link to lowPriorityNotifications?")

> `optional` **lowPriorityNotifications**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9986](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9986)

* * *

### messageLight?[​](#messagelight "Direct link to messageLight?")

> `optional` **messageLight**: `null` | `string`

Defined in: [WAProto/index.d.ts:9985](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9985)

* * *

### messagePopup?[​](#messagepopup "Direct link to messagePopup?")

> `optional` **messagePopup**: `null` | `string`

Defined in: [WAProto/index.d.ts:9984](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9984)

* * *

### messageVibrate?[​](#messagevibrate "Direct link to messageVibrate?")

> `optional` **messageVibrate**: `null` | `string`

Defined in: [WAProto/index.d.ts:9983](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9983)

* * *

### reactionsMuted?[​](#reactionsmuted "Direct link to reactionsMuted?")

> `optional` **reactionsMuted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9987](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9987)

---

<a name="interface-ipairingrequest"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPairingRequest](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPairingRequest)

Defined in: [WAProto/index.d.ts:10008](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10008)

## Properties[​](#properties "Direct link to Properties")

### advSecret?[​](#advsecret "Direct link to advSecret?")

> `optional` **advSecret**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10011](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10011)

* * *

### companionIdentityKey?[​](#companionidentitykey "Direct link to companionIdentityKey?")

> `optional` **companionIdentityKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10010](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10010)

* * *

### companionPublicKey?[​](#companionpublickey "Direct link to companionPublicKey?")

> `optional` **companionPublicKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10009](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10009)

---

<a name="interface-ipastparticipant"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPastParticipant](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPastParticipant)

Defined in: [WAProto/index.d.ts:10028](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10028)

## Properties[​](#properties "Direct link to Properties")

### leaveReason?[​](#leavereason "Direct link to leaveReason?")

> `optional` **leaveReason**: `null` | [`LeaveReason`](/docs/api/namespaces/proto/namespaces/PastParticipant/enumerations/LeaveReason)

Defined in: [WAProto/index.d.ts:10030](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10030)

* * *

### leaveTs?[​](#leavets "Direct link to leaveTs?")

> `optional` **leaveTs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10031](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10031)

* * *

### userJid?[​](#userjid "Direct link to userJid?")

> `optional` **userJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:10029](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10029)

---

<a name="interface-ipastparticipants"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPastParticipants](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPastParticipants)

Defined in: [WAProto/index.d.ts:10056](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10056)

## Properties[​](#properties "Direct link to Properties")

### groupJid?[​](#groupjid "Direct link to groupJid?")

> `optional` **groupJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:10057](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10057)

* * *

### pastParticipants?[​](#pastparticipants "Direct link to pastParticipants?")

> `optional` **pastParticipants**: `null` | [`IPastParticipant`](/docs/api/namespaces/proto/interfaces/IPastParticipant)\[\]

Defined in: [WAProto/index.d.ts:10058](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10058)

---

<a name="interface-ipatchdebugdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPatchDebugData](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPatchDebugData)

Defined in: [WAProto/index.d.ts:10074](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10074)

## Properties[​](#properties "Direct link to Properties")

### collectionName?[​](#collectionname "Direct link to collectionName?")

> `optional` **collectionName**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10078](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10078)

* * *

### currentLthash?[​](#currentlthash "Direct link to currentLthash?")

> `optional` **currentLthash**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10075](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10075)

* * *

### firstFourBytesFromAHashOfSnapshotMacKey?[​](#firstfourbytesfromahashofsnapshotmackey "Direct link to firstFourBytesFromAHashOfSnapshotMacKey?")

> `optional` **firstFourBytesFromAHashOfSnapshotMacKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10079](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10079)

* * *

### isSenderPrimary?[​](#issenderprimary "Direct link to isSenderPrimary?")

> `optional` **isSenderPrimary**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:10085](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10085)

* * *

### newLthash?[​](#newlthash "Direct link to newLthash?")

> `optional` **newLthash**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10076](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10076)

* * *

### newLthashSubtract?[​](#newlthashsubtract "Direct link to newLthashSubtract?")

> `optional` **newLthashSubtract**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10080](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10080)

* * *

### numberAdd?[​](#numberadd "Direct link to numberAdd?")

> `optional` **numberAdd**: `null` | `number`

Defined in: [WAProto/index.d.ts:10081](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10081)

* * *

### numberOverride?[​](#numberoverride "Direct link to numberOverride?")

> `optional` **numberOverride**: `null` | `number`

Defined in: [WAProto/index.d.ts:10083](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10083)

* * *

### numberRemove?[​](#numberremove "Direct link to numberRemove?")

> `optional` **numberRemove**: `null` | `number`

Defined in: [WAProto/index.d.ts:10082](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10082)

* * *

### patchVersion?[​](#patchversion "Direct link to patchVersion?")

> `optional` **patchVersion**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10077](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10077)

* * *

### senderPlatform?[​](#senderplatform "Direct link to senderPlatform?")

> `optional` **senderPlatform**: `null` | [`Platform`](/docs/api/namespaces/proto/namespaces/PatchDebugData/enumerations/Platform)

Defined in: [WAProto/index.d.ts:10084](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10084)

---

<a name="interface-ipaymentbackground"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPaymentBackground](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPaymentBackground)

Defined in: [WAProto/index.d.ts:10128](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10128)

## Properties[​](#properties "Direct link to Properties")

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10130](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10130)

* * *

### height?[​](#height "Direct link to height?")

> `optional` **height**: `null` | `number`

Defined in: [WAProto/index.d.ts:10132](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10132)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:10129](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10129)

* * *

### mediaData?[​](#mediadata "Direct link to mediaData?")

> `optional` **mediaData**: `null` | [`IMediaData`](/docs/api/namespaces/proto/namespaces/PaymentBackground/interfaces/IMediaData)

Defined in: [WAProto/index.d.ts:10137](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10137)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:10133](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10133)

* * *

### placeholderArgb?[​](#placeholderargb "Direct link to placeholderArgb?")

> `optional` **placeholderArgb**: `null` | `number`

Defined in: [WAProto/index.d.ts:10134](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10134)

* * *

### subtextArgb?[​](#subtextargb "Direct link to subtextArgb?")

> `optional` **subtextArgb**: `null` | `number`

Defined in: [WAProto/index.d.ts:10136](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10136)

* * *

### textArgb?[​](#textargb "Direct link to textArgb?")

> `optional` **textArgb**: `null` | `number`

Defined in: [WAProto/index.d.ts:10135](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10135)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`Type`](/docs/api/namespaces/proto/namespaces/PaymentBackground/enumerations/Type)

Defined in: [WAProto/index.d.ts:10138](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10138)

* * *

### width?[​](#width "Direct link to width?")

> `optional` **width**: `null` | `number`

Defined in: [WAProto/index.d.ts:10131](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10131)

---

<a name="interface-ipaymentinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPaymentInfo](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPaymentInfo)

Defined in: [WAProto/index.d.ts:10194](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10194)

## Properties[​](#properties "Direct link to Properties")

### amount1000?[​](#amount1000 "Direct link to amount1000?")

> `optional` **amount1000**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10196](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10196)

* * *

### currency?[​](#currency "Direct link to currency?")

> `optional` **currency**: `null` | `string`

Defined in: [WAProto/index.d.ts:10203](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10203)

* * *

### currencyDeprecated?[​](#currencydeprecated "Direct link to currencyDeprecated?")

> `optional` **currencyDeprecated**: `null` | [`Currency`](/docs/api/namespaces/proto/namespaces/PaymentInfo/enumerations/Currency)

Defined in: [WAProto/index.d.ts:10195](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10195)

* * *

### exchangeAmount?[​](#exchangeamount "Direct link to exchangeAmount?")

> `optional` **exchangeAmount**: `null` | [`IMoney`](/docs/api/namespaces/proto/interfaces/IMoney)

Defined in: [WAProto/index.d.ts:10207](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10207)

* * *

### expiryTimestamp?[​](#expirytimestamp "Direct link to expiryTimestamp?")

> `optional` **expiryTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10201](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10201)

* * *

### futureproofed?[​](#futureproofed "Direct link to futureproofed?")

> `optional` **futureproofed**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:10202](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10202)

* * *

### primaryAmount?[​](#primaryamount "Direct link to primaryAmount?")

> `optional` **primaryAmount**: `null` | [`IMoney`](/docs/api/namespaces/proto/interfaces/IMoney)

Defined in: [WAProto/index.d.ts:10206](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10206)

* * *

### receiverJid?[​](#receiverjid "Direct link to receiverJid?")

> `optional` **receiverJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:10197](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10197)

* * *

### requestMessageKey?[​](#requestmessagekey "Direct link to requestMessageKey?")

> `optional` **requestMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:10200](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10200)

* * *

### status?[​](#status "Direct link to status?")

> `optional` **status**: `null` | [`Status`](/docs/api/namespaces/proto/namespaces/PaymentInfo/enumerations/Status)

Defined in: [WAProto/index.d.ts:10198](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10198)

* * *

### transactionTimestamp?[​](#transactiontimestamp "Direct link to transactionTimestamp?")

> `optional` **transactionTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10199](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10199)

* * *

### txnStatus?[​](#txnstatus "Direct link to txnStatus?")

> `optional` **txnStatus**: `null` | [`TxnStatus`](/docs/api/namespaces/proto/namespaces/PaymentInfo/enumerations/TxnStatus)

Defined in: [WAProto/index.d.ts:10204](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10204)

* * *

### useNoviFiatFormat?[​](#usenovifiatformat "Direct link to useNoviFiatFormat?")

> `optional` **useNoviFiatFormat**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:10205](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10205)

---

<a name="interface-iphonenumbertolidmapping"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPhoneNumberToLIDMapping](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPhoneNumberToLIDMapping)

Defined in: [WAProto/index.d.ts:10292](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10292)

## Properties[​](#properties "Direct link to Properties")

### lidJid?[​](#lidjid "Direct link to lidJid?")

> `optional` **lidJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:10294](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10294)

* * *

### pnJid?[​](#pnjid "Direct link to pnJid?")

> `optional` **pnJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:10293](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10293)

---

<a name="interface-iphotochange"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPhotoChange](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPhotoChange)

Defined in: [WAProto/index.d.ts:10310](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10310)

## Properties[​](#properties "Direct link to Properties")

### newPhoto?[​](#newphoto "Direct link to newPhoto?")

> `optional` **newPhoto**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10312](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10312)

* * *

### newPhotoId?[​](#newphotoid "Direct link to newPhotoId?")

> `optional` **newPhotoId**: `null` | `number`

Defined in: [WAProto/index.d.ts:10313](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10313)

* * *

### oldPhoto?[​](#oldphoto "Direct link to oldPhoto?")

> `optional` **oldPhoto**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10311](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10311)

---

<a name="interface-ipininchat"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPinInChat](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPinInChat)

Defined in: [WAProto/index.d.ts:10330](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10330)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:10332](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10332)

* * *

### messageAddOnContextInfo?[​](#messageaddoncontextinfo "Direct link to messageAddOnContextInfo?")

> `optional` **messageAddOnContextInfo**: `null` | [`IMessageAddOnContextInfo`](/docs/api/namespaces/proto/interfaces/IMessageAddOnContextInfo)

Defined in: [WAProto/index.d.ts:10335](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10335)

* * *

### senderTimestampMs?[​](#sendertimestampms "Direct link to senderTimestampMs?")

> `optional` **senderTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10333](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10333)

* * *

### serverTimestampMs?[​](#servertimestampms "Direct link to serverTimestampMs?")

> `optional` **serverTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10334](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10334)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`Type`](/docs/api/namespaces/proto/namespaces/PinInChat/enumerations/Type)

Defined in: [WAProto/index.d.ts:10331](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10331)

---

<a name="interface-ipoint"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPoint](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPoint)

Defined in: [WAProto/index.d.ts:10363](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10363)

## Properties[​](#properties "Direct link to Properties")

### x?[​](#x "Direct link to x?")

> `optional` **x**: `null` | `number`

Defined in: [WAProto/index.d.ts:10366](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10366)

* * *

### xDeprecated?[​](#xdeprecated "Direct link to xDeprecated?")

> `optional` **xDeprecated**: `null` | `number`

Defined in: [WAProto/index.d.ts:10364](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10364)

* * *

### y?[​](#y "Direct link to y?")

> `optional` **y**: `null` | `number`

Defined in: [WAProto/index.d.ts:10367](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10367)

* * *

### yDeprecated?[​](#ydeprecated "Direct link to yDeprecated?")

> `optional` **yDeprecated**: `null` | `number`

Defined in: [WAProto/index.d.ts:10365](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10365)

---

<a name="interface-ipolladditionalmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPollAdditionalMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPollAdditionalMetadata)

Defined in: [WAProto/index.d.ts:10385](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10385)

## Properties[​](#properties "Direct link to Properties")

### pollInvalidated?[​](#pollinvalidated "Direct link to pollInvalidated?")

> `optional` **pollInvalidated**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:10386](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10386)

---

<a name="interface-ipollencvalue"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPollEncValue](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPollEncValue)

Defined in: [WAProto/index.d.ts:10401](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10401)

## Properties[​](#properties "Direct link to Properties")

### encIv?[​](#enciv "Direct link to encIv?")

> `optional` **encIv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10403](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10403)

* * *

### encPayload?[​](#encpayload "Direct link to encPayload?")

> `optional` **encPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10402](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10402)

---

<a name="interface-ipollupdate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPollUpdate](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPollUpdate)

Defined in: [WAProto/index.d.ts:10419](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10419)

## Properties[​](#properties "Direct link to Properties")

### pollUpdateMessageKey?[​](#pollupdatemessagekey "Direct link to pollUpdateMessageKey?")

> `optional` **pollUpdateMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:10420](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10420)

* * *

### senderTimestampMs?[​](#sendertimestampms "Direct link to senderTimestampMs?")

> `optional` **senderTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10422](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10422)

* * *

### serverTimestampMs?[​](#servertimestampms "Direct link to serverTimestampMs?")

> `optional` **serverTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10423](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10423)

* * *

### unread?[​](#unread "Direct link to unread?")

> `optional` **unread**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:10424](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10424)

* * *

### vote?[​](#vote "Direct link to vote?")

> `optional` **vote**: `null` | [`IPollVoteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollVoteMessage)

Defined in: [WAProto/index.d.ts:10421](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10421)

---

<a name="interface-iprekeyrecordstructure"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPreKeyRecordStructure](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPreKeyRecordStructure)

Defined in: [WAProto/index.d.ts:10443](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10443)

## Properties[​](#properties "Direct link to Properties")

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `number`

Defined in: [WAProto/index.d.ts:10444](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10444)

* * *

### privateKey?[​](#privatekey "Direct link to privateKey?")

> `optional` **privateKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10446](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10446)

* * *

### publicKey?[​](#publickey "Direct link to publicKey?")

> `optional` **publicKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10445](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10445)

---

<a name="interface-iprekeysignalmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPreKeySignalMessage](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPreKeySignalMessage)

Defined in: [WAProto/index.d.ts:10463](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10463)

## Properties[​](#properties "Direct link to Properties")

### baseKey?[​](#basekey "Direct link to baseKey?")

> `optional` **baseKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10467](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10467)

* * *

### identityKey?[​](#identitykey "Direct link to identityKey?")

> `optional` **identityKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10468](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10468)

* * *

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10469](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10469)

* * *

### preKeyId?[​](#prekeyid "Direct link to preKeyId?")

> `optional` **preKeyId**: `null` | `number`

Defined in: [WAProto/index.d.ts:10465](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10465)

* * *

### registrationId?[​](#registrationid "Direct link to registrationId?")

> `optional` **registrationId**: `null` | `number`

Defined in: [WAProto/index.d.ts:10464](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10464)

* * *

### signedPreKeyId?[​](#signedprekeyid "Direct link to signedPreKeyId?")

> `optional` **signedPreKeyId**: `null` | `number`

Defined in: [WAProto/index.d.ts:10466](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10466)

---

<a name="interface-ipremiummessageinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPremiumMessageInfo](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPremiumMessageInfo)

Defined in: [WAProto/index.d.ts:10489](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10489)

## Properties[​](#properties "Direct link to Properties")

### serverCampaignId?[​](#servercampaignid "Direct link to serverCampaignId?")

> `optional` **serverCampaignId**: `null` | `string`

Defined in: [WAProto/index.d.ts:10490](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10490)

---

<a name="interface-iprimaryephemeralidentity"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPrimaryEphemeralIdentity](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPrimaryEphemeralIdentity)

Defined in: [WAProto/index.d.ts:10505](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10505)

## Properties[​](#properties "Direct link to Properties")

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10507](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10507)

* * *

### publicKey?[​](#publickey "Direct link to publicKey?")

> `optional` **publicKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10506](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10506)

---

<a name="interface-iprocessedvideo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IProcessedVideo](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IProcessedVideo)

Defined in: [WAProto/index.d.ts:10529](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10529)

## Properties[​](#properties "Direct link to Properties")

### bitrate?[​](#bitrate "Direct link to bitrate?")

> `optional` **bitrate**: `null` | `number`

Defined in: [WAProto/index.d.ts:10535](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10535)

* * *

### capabilities?[​](#capabilities "Direct link to capabilities?")

> `optional` **capabilities**: `null` | `string`\[\]

Defined in: [WAProto/index.d.ts:10537](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10537)

* * *

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:10530](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10530)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10534](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10534)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10531](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10531)

* * *

### height?[​](#height "Direct link to height?")

> `optional` **height**: `null` | `number`

Defined in: [WAProto/index.d.ts:10532](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10532)

* * *

### quality?[​](#quality "Direct link to quality?")

> `optional` **quality**: `null` | [`VideoQuality`](/docs/api/namespaces/proto/namespaces/ProcessedVideo/enumerations/VideoQuality)

Defined in: [WAProto/index.d.ts:10536](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10536)

* * *

### width?[​](#width "Direct link to width?")

> `optional` **width**: `null` | `number`

Defined in: [WAProto/index.d.ts:10533](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10533)

---

<a name="interface-iprologuepayload"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IProloguePayload](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IProloguePayload)

Defined in: [WAProto/index.d.ts:10569](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10569)

## Properties[​](#properties "Direct link to Properties")

### commitment?[​](#commitment "Direct link to commitment?")

> `optional` **commitment**: `null` | [`ICompanionCommitment`](/docs/api/namespaces/proto/interfaces/ICompanionCommitment)

Defined in: [WAProto/index.d.ts:10571](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10571)

* * *

### companionEphemeralIdentity?[​](#companionephemeralidentity "Direct link to companionEphemeralIdentity?")

> `optional` **companionEphemeralIdentity**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10570](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10570)

---

<a name="interface-ipushname"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPushname](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IPushname)

Defined in: [WAProto/index.d.ts:10587](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10587)

## Properties[​](#properties "Direct link to Properties")

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:10588](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10588)

* * *

### pushname?[​](#pushname "Direct link to pushname?")

> `optional` **pushname**: `null` | `string`

Defined in: [WAProto/index.d.ts:10589](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10589)

---

<a name="interface-iquarantinedmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IQuarantinedMessage](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IQuarantinedMessage)

Defined in: [WAProto/index.d.ts:10605](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10605)

## Properties[​](#properties "Direct link to Properties")

### extractedText?[​](#extractedtext "Direct link to extractedText?")

> `optional` **extractedText**: `null` | `string`

Defined in: [WAProto/index.d.ts:10607](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10607)

* * *

### originalData?[​](#originaldata "Direct link to originalData?")

> `optional` **originalData**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10606](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10606)

---

<a name="interface-ireaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IReaction](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IReaction)

Defined in: [WAProto/index.d.ts:10623](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10623)

## Properties[​](#properties "Direct link to Properties")

### groupingKey?[​](#groupingkey "Direct link to groupingKey?")

> `optional` **groupingKey**: `null` | `string`

Defined in: [WAProto/index.d.ts:10626](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10626)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:10624](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10624)

* * *

### senderTimestampMs?[​](#sendertimestampms "Direct link to senderTimestampMs?")

> `optional` **senderTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10627](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10627)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:10625](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10625)

* * *

### unread?[​](#unread "Direct link to unread?")

> `optional` **unread**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:10628](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10628)

---

<a name="interface-irecentemojiweight"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IRecentEmojiWeight](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IRecentEmojiWeight)

Defined in: [WAProto/index.d.ts:10647](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10647)

## Properties[​](#properties "Direct link to Properties")

### emoji?[​](#emoji "Direct link to emoji?")

> `optional` **emoji**: `null` | `string`

Defined in: [WAProto/index.d.ts:10648](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10648)

* * *

### weight?[​](#weight "Direct link to weight?")

> `optional` **weight**: `null` | `number`

Defined in: [WAProto/index.d.ts:10649](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10649)

---

<a name="interface-irecordstructure"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IRecordStructure](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IRecordStructure)

Defined in: [WAProto/index.d.ts:10665](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10665)

## Properties[​](#properties "Direct link to Properties")

### currentSession?[​](#currentsession "Direct link to currentSession?")

> `optional` **currentSession**: `null` | [`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure)

Defined in: [WAProto/index.d.ts:10666](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10666)

* * *

### previousSessions?[​](#previoussessions "Direct link to previousSessions?")

> `optional` **previousSessions**: `null` | [`ISessionStructure`](/docs/api/namespaces/proto/interfaces/ISessionStructure)\[\]

Defined in: [WAProto/index.d.ts:10667](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10667)

---

<a name="interface-ireportable"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IReportable](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IReportable)

Defined in: [WAProto/index.d.ts:10683](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10683)

## Properties[​](#properties "Direct link to Properties")

### maxVersion?[​](#maxversion "Direct link to maxVersion?")

> `optional` **maxVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:10685](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10685)

* * *

### minVersion?[​](#minversion "Direct link to minVersion?")

> `optional` **minVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:10684](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10684)

* * *

### never?[​](#never "Direct link to never?")

> `optional` **never**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:10687](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10687)

* * *

### notReportableMinVersion?[​](#notreportableminversion "Direct link to notReportableMinVersion?")

> `optional` **notReportableMinVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:10686](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10686)

---

<a name="interface-ireportingtokeninfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IReportingTokenInfo](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IReportingTokenInfo)

Defined in: [WAProto/index.d.ts:10705](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10705)

## Properties[​](#properties "Direct link to Properties")

### reportingTag?[​](#reportingtag "Direct link to reportingTag?")

> `optional` **reportingTag**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10706](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10706)

---

<a name="interface-isenderkeydistributionmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISenderKeyDistributionMessage](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISenderKeyDistributionMessage)

Defined in: [WAProto/index.d.ts:10721](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10721)

## Properties[​](#properties "Direct link to Properties")

### chainKey?[​](#chainkey "Direct link to chainKey?")

> `optional` **chainKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10724](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10724)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `number`

Defined in: [WAProto/index.d.ts:10722](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10722)

* * *

### iteration?[​](#iteration "Direct link to iteration?")

> `optional` **iteration**: `null` | `number`

Defined in: [WAProto/index.d.ts:10723](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10723)

* * *

### signingKey?[​](#signingkey "Direct link to signingKey?")

> `optional` **signingKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10725](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10725)

---

<a name="interface-isenderkeymessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISenderKeyMessage](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISenderKeyMessage)

Defined in: [WAProto/index.d.ts:10743](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10743)

## Properties[​](#properties "Direct link to Properties")

### ciphertext?[​](#ciphertext "Direct link to ciphertext?")

> `optional` **ciphertext**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10746](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10746)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `number`

Defined in: [WAProto/index.d.ts:10744](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10744)

* * *

### iteration?[​](#iteration "Direct link to iteration?")

> `optional` **iteration**: `null` | `number`

Defined in: [WAProto/index.d.ts:10745](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10745)

---

<a name="interface-isenderkeyrecordstructure"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISenderKeyRecordStructure](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISenderKeyRecordStructure)

Defined in: [WAProto/index.d.ts:10763](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10763)

## Properties[​](#properties "Direct link to Properties")

### senderKeyStates?[​](#senderkeystates "Direct link to senderKeyStates?")

> `optional` **senderKeyStates**: `null` | [`ISenderKeyStateStructure`](/docs/api/namespaces/proto/interfaces/ISenderKeyStateStructure)\[\]

Defined in: [WAProto/index.d.ts:10764](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10764)

---

<a name="interface-isenderkeystatestructure"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISenderKeyStateStructure](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISenderKeyStateStructure)

Defined in: [WAProto/index.d.ts:10779](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10779)

## Properties[​](#properties "Direct link to Properties")

### senderChainKey?[​](#senderchainkey "Direct link to senderChainKey?")

> `optional` **senderChainKey**: `null` | [`ISenderChainKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderChainKey)

Defined in: [WAProto/index.d.ts:10781](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10781)

* * *

### senderKeyId?[​](#senderkeyid "Direct link to senderKeyId?")

> `optional` **senderKeyId**: `null` | `number`

Defined in: [WAProto/index.d.ts:10780](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10780)

* * *

### senderMessageKeys?[​](#sendermessagekeys "Direct link to senderMessageKeys?")

> `optional` **senderMessageKeys**: `null` | [`ISenderMessageKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderMessageKey)\[\]

Defined in: [WAProto/index.d.ts:10783](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10783)

* * *

### senderSigningKey?[​](#sendersigningkey "Direct link to senderSigningKey?")

> `optional` **senderSigningKey**: `null` | [`ISenderSigningKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderSigningKey)

Defined in: [WAProto/index.d.ts:10782](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10782)

---

<a name="interface-iservererrorreceipt"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IServerErrorReceipt](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IServerErrorReceipt)

Defined in: [WAProto/index.d.ts:10858](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10858)

## Properties[​](#properties "Direct link to Properties")

### stanzaId?[​](#stanzaid "Direct link to stanzaId?")

> `optional` **stanzaId**: `null` | `string`

Defined in: [WAProto/index.d.ts:10859](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10859)

---

<a name="interface-isessionstructure"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISessionStructure](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISessionStructure)

Defined in: [WAProto/index.d.ts:10874](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10874)

## Properties[​](#properties "Direct link to Properties")

### aliceBaseKey?[​](#alicebasekey "Direct link to aliceBaseKey?")

> `optional` **aliceBaseKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10887](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10887)

* * *

### localIdentityPublic?[​](#localidentitypublic "Direct link to localIdentityPublic?")

> `optional` **localIdentityPublic**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10876](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10876)

* * *

### localRegistrationId?[​](#localregistrationid "Direct link to localRegistrationId?")

> `optional` **localRegistrationId**: `null` | `number`

Defined in: [WAProto/index.d.ts:10885](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10885)

* * *

### needsRefresh?[​](#needsrefresh "Direct link to needsRefresh?")

> `optional` **needsRefresh**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:10886](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10886)

* * *

### pendingKeyExchange?[​](#pendingkeyexchange "Direct link to pendingKeyExchange?")

> `optional` **pendingKeyExchange**: `null` | [`IPendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange)

Defined in: [WAProto/index.d.ts:10882](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10882)

* * *

### pendingPreKey?[​](#pendingprekey "Direct link to pendingPreKey?")

> `optional` **pendingPreKey**: `null` | [`IPendingPreKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingPreKey)

Defined in: [WAProto/index.d.ts:10883](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10883)

* * *

### previousCounter?[​](#previouscounter "Direct link to previousCounter?")

> `optional` **previousCounter**: `null` | `number`

Defined in: [WAProto/index.d.ts:10879](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10879)

* * *

### receiverChains?[​](#receiverchains "Direct link to receiverChains?")

> `optional` **receiverChains**: `null` | [`IChain`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IChain)\[\]

Defined in: [WAProto/index.d.ts:10881](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10881)

* * *

### remoteIdentityPublic?[​](#remoteidentitypublic "Direct link to remoteIdentityPublic?")

> `optional` **remoteIdentityPublic**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10877](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10877)

* * *

### remoteRegistrationId?[​](#remoteregistrationid "Direct link to remoteRegistrationId?")

> `optional` **remoteRegistrationId**: `null` | `number`

Defined in: [WAProto/index.d.ts:10884](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10884)

* * *

### rootKey?[​](#rootkey "Direct link to rootKey?")

> `optional` **rootKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10878](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10878)

* * *

### senderChain?[​](#senderchain "Direct link to senderChain?")

> `optional` **senderChain**: `null` | [`IChain`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IChain)

Defined in: [WAProto/index.d.ts:10880](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10880)

* * *

### sessionVersion?[​](#sessionversion "Direct link to sessionVersion?")

> `optional` **sessionVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:10875](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10875)

---

<a name="interface-isessiontransparencymetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISessionTransparencyMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISessionTransparencyMetadata)

Defined in: [WAProto/index.d.ts:11030](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11030)

## Properties[​](#properties "Direct link to Properties")

### disclaimerText?[​](#disclaimertext "Direct link to disclaimerText?")

> `optional` **disclaimerText**: `null` | `string`

Defined in: [WAProto/index.d.ts:11031](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11031)

* * *

### hcaId?[​](#hcaid "Direct link to hcaId?")

> `optional` **hcaId**: `null` | `string`

Defined in: [WAProto/index.d.ts:11032](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11032)

* * *

### sessionTransparencyType?[​](#sessiontransparencytype "Direct link to sessionTransparencyType?")

> `optional` **sessionTransparencyType**: `null` | [`SessionTransparencyType`](/docs/api/namespaces/proto/enumerations/SessionTransparencyType)

Defined in: [WAProto/index.d.ts:11033](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11033)

---

<a name="interface-isignalmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISignalMessage](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISignalMessage)

Defined in: [WAProto/index.d.ts:11055](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11055)

## Properties[​](#properties "Direct link to Properties")

### ciphertext?[​](#ciphertext "Direct link to ciphertext?")

> `optional` **ciphertext**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11059](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11059)

* * *

### counter?[​](#counter "Direct link to counter?")

> `optional` **counter**: `null` | `number`

Defined in: [WAProto/index.d.ts:11057](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11057)

* * *

### previousCounter?[​](#previouscounter "Direct link to previousCounter?")

> `optional` **previousCounter**: `null` | `number`

Defined in: [WAProto/index.d.ts:11058](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11058)

* * *

### ratchetKey?[​](#ratchetkey "Direct link to ratchetKey?")

> `optional` **ratchetKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11056](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11056)

---

<a name="interface-isignedprekeyrecordstructure"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISignedPreKeyRecordStructure](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISignedPreKeyRecordStructure)

Defined in: [WAProto/index.d.ts:11077](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11077)

## Properties[​](#properties "Direct link to Properties")

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `number`

Defined in: [WAProto/index.d.ts:11078](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11078)

* * *

### privateKey?[​](#privatekey "Direct link to privateKey?")

> `optional` **privateKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11080](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11080)

* * *

### publicKey?[​](#publickey "Direct link to publicKey?")

> `optional` **publicKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11079](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11079)

* * *

### signature?[​](#signature "Direct link to signature?")

> `optional` **signature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11081](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11081)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:11082](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11082)

---

<a name="interface-istatusattribution"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IStatusAttribution](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IStatusAttribution)

Defined in: [WAProto/index.d.ts:11101](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11101)

## Properties[​](#properties "Direct link to Properties")

### actionUrl?[​](#actionurl "Direct link to actionUrl?")

> `optional` **actionUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:11103](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11103)

* * *

### aiCreatedAttribution?[​](#aicreatedattribution "Direct link to aiCreatedAttribution?")

> `optional` **aiCreatedAttribution**: `null` | [`IAiCreatedAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IAiCreatedAttribution)

Defined in: [WAProto/index.d.ts:11109](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11109)

* * *

### externalShare?[​](#externalshare "Direct link to externalShare?")

> `optional` **externalShare**: `null` | [`IExternalShare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IExternalShare)

Defined in: [WAProto/index.d.ts:11105](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11105)

* * *

### groupStatus?[​](#groupstatus "Direct link to groupStatus?")

> `optional` **groupStatus**: `null` | [`IGroupStatus`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IGroupStatus)

Defined in: [WAProto/index.d.ts:11107](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11107)

* * *

### music?[​](#music "Direct link to music?")

> `optional` **music**: `null` | [`IMusic`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic)

Defined in: [WAProto/index.d.ts:11106](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11106)

* * *

### rlAttribution?[​](#rlattribution "Direct link to rlAttribution?")

> `optional` **rlAttribution**: `null` | [`IRLAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IRLAttribution)

Defined in: [WAProto/index.d.ts:11108](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11108)

* * *

### statusReshare?[​](#statusreshare "Direct link to statusReshare?")

> `optional` **statusReshare**: `null` | [`IStatusReshare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IStatusReshare)

Defined in: [WAProto/index.d.ts:11104](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11104)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`Type`](/docs/api/namespaces/proto/namespaces/StatusAttribution/enumerations/Type)

Defined in: [WAProto/index.d.ts:11102](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11102)

---

<a name="interface-istatusmentionmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IStatusMentionMessage](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IStatusMentionMessage)

Defined in: [WAProto/index.d.ts:11329](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11329)

## Properties[​](#properties "Direct link to Properties")

### quotedStatus?[​](#quotedstatus "Direct link to quotedStatus?")

> `optional` **quotedStatus**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:11330](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11330)

---

<a name="interface-istatuspsa"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IStatusPSA](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IStatusPSA)

Defined in: [WAProto/index.d.ts:11345](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11345)

## Properties[​](#properties "Direct link to Properties")

### campaignExpirationTimestamp?[​](#campaignexpirationtimestamp "Direct link to campaignExpirationTimestamp?")

> `optional` **campaignExpirationTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:11347](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11347)

* * *

### campaignId?[​](#campaignid "Direct link to campaignId?")

> `optional` **campaignId**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:11346](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11346)

---

<a name="interface-istickermetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IStickerMetadata](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IStickerMetadata)

Defined in: [WAProto/index.d.ts:11363](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11363)

## Properties[​](#properties "Direct link to Properties")

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:11371](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11371)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11366](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11366)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:11372](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11372)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11365](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11365)

* * *

### height?[​](#height "Direct link to height?")

> `optional` **height**: `null` | `number`

Defined in: [WAProto/index.d.ts:11369](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11369)

* * *

### imageHash?[​](#imagehash "Direct link to imageHash?")

> `optional` **imageHash**: `null` | `string`

Defined in: [WAProto/index.d.ts:11376](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11376)

* * *

### isAvatarSticker?[​](#isavatarsticker "Direct link to isAvatarSticker?")

> `optional` **isAvatarSticker**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11377](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11377)

* * *

### isLottie?[​](#islottie "Direct link to isLottie?")

> `optional` **isLottie**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11375](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11375)

* * *

### lastStickerSentTs?[​](#laststickersentts "Direct link to lastStickerSentTs?")

> `optional` **lastStickerSentTs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:11374](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11374)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11367](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11367)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:11368](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11368)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:11364](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11364)

* * *

### weight?[​](#weight "Direct link to weight?")

> `optional` **weight**: `null` | `number`

Defined in: [WAProto/index.d.ts:11373](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11373)

* * *

### width?[​](#width "Direct link to width?")

> `optional` **width**: `null` | `number`

Defined in: [WAProto/index.d.ts:11370](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11370)

---

<a name="interface-isyncactiondata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISyncActionData](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISyncActionData)

Defined in: [WAProto/index.d.ts:11405](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11405)

## Properties[​](#properties "Direct link to Properties")

### index?[​](#index "Direct link to index?")

> `optional` **index**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11406](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11406)

* * *

### padding?[​](#padding "Direct link to padding?")

> `optional` **padding**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11408](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11408)

* * *

### value?[​](#value "Direct link to value?")

> `optional` **value**: `null` | [`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue)

Defined in: [WAProto/index.d.ts:11407](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11407)

* * *

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | `number`

Defined in: [WAProto/index.d.ts:11409](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11409)

---

<a name="interface-isyncactionvalue"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISyncActionValue](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISyncActionValue)

Defined in: [WAProto/index.d.ts:11427](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11427)

## Properties[​](#properties "Direct link to Properties")

### agentAction?[​](#agentaction "Direct link to agentAction?")

> `optional` **agentAction**: `null` | [`IAgentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAgentAction)

Defined in: [WAProto/index.d.ts:11448](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11448)

* * *

### aiThreadRenameAction?[​](#aithreadrenameaction "Direct link to aiThreadRenameAction?")

> `optional` **aiThreadRenameAction**: `null` | [`IAiThreadRenameAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAiThreadRenameAction)

Defined in: [WAProto/index.d.ts:11495](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11495)

* * *

### androidUnsupportedActions?[​](#androidunsupportedactions "Direct link to androidUnsupportedActions?")

> `optional` **androidUnsupportedActions**: `null` | [`IAndroidUnsupportedActions`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAndroidUnsupportedActions)

Defined in: [WAProto/index.d.ts:11447](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11447)

* * *

### archiveChatAction?[​](#archivechataction "Direct link to archiveChatAction?")

> `optional` **archiveChatAction**: `null` | [`IArchiveChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IArchiveChatAction)

Defined in: [WAProto/index.d.ts:11439](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11439)

* * *

### avatarUpdatedAction?[​](#avatarupdatedaction "Direct link to avatarUpdatedAction?")

> `optional` **avatarUpdatedAction**: `null` | [`IAvatarUpdatedAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAvatarUpdatedAction)

Defined in: [WAProto/index.d.ts:11492](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11492)

* * *

### botWelcomeRequestAction?[​](#botwelcomerequestaction "Direct link to botWelcomeRequestAction?")

> `optional` **botWelcomeRequestAction**: `null` | [`IBotWelcomeRequestAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBotWelcomeRequestAction)

Defined in: [WAProto/index.d.ts:11466](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11466)

* * *

### businessBroadcastAssociationAction?[​](#businessbroadcastassociationaction "Direct link to businessBroadcastAssociationAction?")

> `optional` **businessBroadcastAssociationAction**: `null` | [`IBusinessBroadcastAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastAssociationAction)

Defined in: [WAProto/index.d.ts:11486](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11486)

* * *

### businessBroadcastListAction?[​](#businessbroadcastlistaction "Direct link to businessBroadcastListAction?")

> `optional` **businessBroadcastListAction**: `null` | [`IBusinessBroadcastListAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastListAction)

Defined in: [WAProto/index.d.ts:11489](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11489)

* * *

### callLogAction?[​](#calllogaction "Direct link to callLogAction?")

> `optional` **callLogAction**: `null` | [`ICallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICallLogAction)

Defined in: [WAProto/index.d.ts:11463](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11463)

* * *

### chatAssignment?[​](#chatassignment "Direct link to chatAssignment?")

> `optional` **chatAssignment**: `null` | [`IChatAssignmentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentAction)

Defined in: [WAProto/index.d.ts:11456](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11456)

* * *

### chatAssignmentOpenedStatus?[​](#chatassignmentopenedstatus "Direct link to chatAssignmentOpenedStatus?")

> `optional` **chatAssignmentOpenedStatus**: `null` | [`IChatAssignmentOpenedStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentOpenedStatusAction)

Defined in: [WAProto/index.d.ts:11457](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11457)

* * *

### chatLockSettings?[​](#chatlocksettings "Direct link to chatLockSettings?")

> `optional` **chatLockSettings**: `null` | [`IChatLockSettings`](/docs/api/namespaces/proto/interfaces/IChatLockSettings)

Defined in: [WAProto/index.d.ts:11472](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11472)

* * *

### clearChatAction?[​](#clearchataction "Direct link to clearChatAction?")

> `optional` **clearChatAction**: `null` | [`IClearChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IClearChatAction)

Defined in: [WAProto/index.d.ts:11443](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11443)

* * *

### contactAction?[​](#contactaction "Direct link to contactAction?")

> `optional` **contactAction**: `null` | [`IContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction)

Defined in: [WAProto/index.d.ts:11430](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11430)

* * *

### ctwaPerCustomerDataSharingAction?[​](#ctwapercustomerdatasharingaction "Direct link to ctwaPerCustomerDataSharingAction?")

> `optional` **ctwaPerCustomerDataSharingAction**: `null` | [`ICtwaPerCustomerDataSharingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICtwaPerCustomerDataSharingAction)

Defined in: [WAProto/index.d.ts:11483](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11483)

* * *

### customPaymentMethodsAction?[​](#custompaymentmethodsaction "Direct link to customPaymentMethodsAction?")

> `optional` **customPaymentMethodsAction**: `null` | [`ICustomPaymentMethodsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodsAction)

Defined in: [WAProto/index.d.ts:11470](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11470)

* * *

### deleteChatAction?[​](#deletechataction "Direct link to deleteChatAction?")

> `optional` **deleteChatAction**: `null` | [`IDeleteChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteChatAction)

Defined in: [WAProto/index.d.ts:11444](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11444)

* * *

### deleteIndividualCallLog?[​](#deleteindividualcalllog "Direct link to deleteIndividualCallLog?")

> `optional` **deleteIndividualCallLog**: `null` | [`IDeleteIndividualCallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteIndividualCallLogAction)

Defined in: [WAProto/index.d.ts:11467](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11467)

* * *

### deleteMessageForMeAction?[​](#deletemessageformeaction "Direct link to deleteMessageForMeAction?")

> `optional` **deleteMessageForMeAction**: `null` | [`IDeleteMessageForMeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteMessageForMeAction)

Defined in: [WAProto/index.d.ts:11440](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11440)

* * *

### detectedOutcomesStatusAction?[​](#detectedoutcomesstatusaction "Direct link to detectedOutcomesStatusAction?")

> `optional` **detectedOutcomesStatusAction**: `null` | [`IDetectedOutcomesStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDetectedOutcomesStatusAction)

Defined in: [WAProto/index.d.ts:11487](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11487)

* * *

### deviceCapabilities?[​](#devicecapabilities "Direct link to deviceCapabilities?")

> `optional` **deviceCapabilities**: `null` | [`IDeviceCapabilities`](/docs/api/namespaces/proto/interfaces/IDeviceCapabilities)

Defined in: [WAProto/index.d.ts:11475](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11475)

* * *

### externalWebBetaAction?[​](#externalwebbetaaction "Direct link to externalWebBetaAction?")

> `optional` **externalWebBetaAction**: `null` | [`IExternalWebBetaAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IExternalWebBetaAction)

Defined in: [WAProto/index.d.ts:11461](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11461)

* * *

### favoritesAction?[​](#favoritesaction "Direct link to favoritesAction?")

> `optional` **favoritesAction**: `null` | [`IFavoritesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IFavoritesAction)

Defined in: [WAProto/index.d.ts:11477](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11477)

* * *

### interactiveMessageAction?[​](#interactivemessageaction "Direct link to interactiveMessageAction?")

> `optional` **interactiveMessageAction**: `null` | [`IInteractiveMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IInteractiveMessageAction)

Defined in: [WAProto/index.d.ts:11496](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11496)

* * *

### keyExpiration?[​](#keyexpiration "Direct link to keyExpiration?")

> `optional` **keyExpiration**: `null` | [`IKeyExpiration`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IKeyExpiration)

Defined in: [WAProto/index.d.ts:11441](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11441)

* * *

### labelAssociationAction?[​](#labelassociationaction "Direct link to labelAssociationAction?")

> `optional` **labelAssociationAction**: `null` | [`ILabelAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelAssociationAction)

Defined in: [WAProto/index.d.ts:11437](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11437)

* * *

### labelEditAction?[​](#labeleditaction "Direct link to labelEditAction?")

> `optional` **labelEditAction**: `null` | [`ILabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction)

Defined in: [WAProto/index.d.ts:11436](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11436)

* * *

### labelReorderingAction?[​](#labelreorderingaction "Direct link to labelReorderingAction?")

> `optional` **labelReorderingAction**: `null` | [`ILabelReorderingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelReorderingAction)

Defined in: [WAProto/index.d.ts:11468](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11468)

* * *

### lidContactAction?[​](#lidcontactaction "Direct link to lidContactAction?")

> `optional` **lidContactAction**: `null` | [`ILidContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILidContactAction)

Defined in: [WAProto/index.d.ts:11482](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11482)

* * *

### localeSetting?[​](#localesetting "Direct link to localeSetting?")

> `optional` **localeSetting**: `null` | [`ILocaleSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILocaleSetting)

Defined in: [WAProto/index.d.ts:11438](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11438)

* * *

### lockChatAction?[​](#lockchataction "Direct link to lockChatAction?")

> `optional` **lockChatAction**: `null` | [`ILockChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILockChatAction)

Defined in: [WAProto/index.d.ts:11471](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11471)

* * *

### maibaAiFeaturesControlAction?[​](#maibaaifeaturescontrolaction "Direct link to maibaAiFeaturesControlAction?")

> `optional` **maibaAiFeaturesControlAction**: `null` | [`IMaibaAIFeaturesControlAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMaibaAIFeaturesControlAction)

Defined in: [WAProto/index.d.ts:11488](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11488)

* * *

### markChatAsReadAction?[​](#markchatasreadaction "Direct link to markChatAsReadAction?")

> `optional` **markChatAsReadAction**: `null` | [`IMarkChatAsReadAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarkChatAsReadAction)

Defined in: [WAProto/index.d.ts:11442](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11442)

* * *

### marketingMessageAction?[​](#marketingmessageaction "Direct link to marketingMessageAction?")

> `optional` **marketingMessageAction**: `null` | [`IMarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction)

Defined in: [WAProto/index.d.ts:11459](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11459)

* * *

### marketingMessageBroadcastAction?[​](#marketingmessagebroadcastaction "Direct link to marketingMessageBroadcastAction?")

> `optional` **marketingMessageBroadcastAction**: `null` | [`IMarketingMessageBroadcastAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageBroadcastAction)

Defined in: [WAProto/index.d.ts:11460](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11460)

* * *

### merchantPaymentPartnerAction?[​](#merchantpaymentpartneraction "Direct link to merchantPaymentPartnerAction?")

> `optional` **merchantPaymentPartnerAction**: `null` | [`IMerchantPaymentPartnerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMerchantPaymentPartnerAction)

Defined in: [WAProto/index.d.ts:11478](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11478)

* * *

### musicUserIdAction?[​](#musicuseridaction "Direct link to musicUserIdAction?")

> `optional` **musicUserIdAction**: `null` | [`IMusicUserIdAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMusicUserIdAction)

Defined in: [WAProto/index.d.ts:11490](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11490)

* * *

### muteAction?[​](#muteaction "Direct link to muteAction?")

> `optional` **muteAction**: `null` | [`IMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMuteAction)

Defined in: [WAProto/index.d.ts:11431](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11431)

* * *

### newsletterSavedInterestsAction?[​](#newslettersavedinterestsaction "Direct link to newsletterSavedInterestsAction?")

> `optional` **newsletterSavedInterestsAction**: `null` | [`INewsletterSavedInterestsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INewsletterSavedInterestsAction)

Defined in: [WAProto/index.d.ts:11494](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11494)

* * *

### noteEditAction?[​](#noteeditaction "Direct link to noteEditAction?")

> `optional` **noteEditAction**: `null` | [`INoteEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INoteEditAction)

Defined in: [WAProto/index.d.ts:11476](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11476)

* * *

### notificationActivitySettingAction?[​](#notificationactivitysettingaction "Direct link to notificationActivitySettingAction?")

> `optional` **notificationActivitySettingAction**: `null` | [`INotificationActivitySettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INotificationActivitySettingAction)

Defined in: [WAProto/index.d.ts:11481](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11481)

* * *

### nuxAction?[​](#nuxaction "Direct link to nuxAction?")

> `optional` **nuxAction**: `null` | [`INuxAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INuxAction)

Defined in: [WAProto/index.d.ts:11452](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11452)

* * *

### paymentInfoAction?[​](#paymentinfoaction "Direct link to paymentInfoAction?")

> `optional` **paymentInfoAction**: `null` | [`IPaymentInfoAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentInfoAction)

Defined in: [WAProto/index.d.ts:11469](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11469)

* * *

### paymentTosAction?[​](#paymenttosaction "Direct link to paymentTosAction?")

> `optional` **paymentTosAction**: `null` | [`IPaymentTosAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentTosAction)

Defined in: [WAProto/index.d.ts:11484](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11484)

* * *

### pinAction?[​](#pinaction "Direct link to pinAction?")

> `optional` **pinAction**: `null` | [`IPinAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPinAction)

Defined in: [WAProto/index.d.ts:11432](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11432)

* * *

### pnForLidChatAction?[​](#pnforlidchataction "Direct link to pnForLidChatAction?")

> `optional` **pnForLidChatAction**: `null` | [`IPnForLidChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPnForLidChatAction)

Defined in: [WAProto/index.d.ts:11458](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11458)

* * *

### primaryFeature?[​](#primaryfeature "Direct link to primaryFeature?")

> `optional` **primaryFeature**: `null` | [`IPrimaryFeature`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryFeature)

Defined in: [WAProto/index.d.ts:11446](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11446)

* * *

### primaryVersionAction?[​](#primaryversionaction "Direct link to primaryVersionAction?")

> `optional` **primaryVersionAction**: `null` | [`IPrimaryVersionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryVersionAction)

Defined in: [WAProto/index.d.ts:11453](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11453)

* * *

### privacySettingChannelsPersonalisedRecommendationAction?[​](#privacysettingchannelspersonalisedrecommendationaction "Direct link to privacySettingChannelsPersonalisedRecommendationAction?")

> `optional` **privacySettingChannelsPersonalisedRecommendationAction**: `null` | [`IPrivacySettingChannelsPersonalisedRecommendationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingChannelsPersonalisedRecommendationAction)

Defined in: [WAProto/index.d.ts:11485](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11485)

* * *

### privacySettingDisableLinkPreviewsAction?[​](#privacysettingdisablelinkpreviewsaction "Direct link to privacySettingDisableLinkPreviewsAction?")

> `optional` **privacySettingDisableLinkPreviewsAction**: `null` | [`IPrivacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingDisableLinkPreviewsAction)

Defined in: [WAProto/index.d.ts:11474](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11474)

* * *

### privacySettingRelayAllCalls?[​](#privacysettingrelayallcalls "Direct link to privacySettingRelayAllCalls?")

> `optional` **privacySettingRelayAllCalls**: `null` | [`IPrivacySettingRelayAllCalls`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingRelayAllCalls)

Defined in: [WAProto/index.d.ts:11462](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11462)

* * *

### privateProcessingSettingAction?[​](#privateprocessingsettingaction "Direct link to privateProcessingSettingAction?")

> `optional` **privateProcessingSettingAction**: `null` | [`IPrivateProcessingSettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivateProcessingSettingAction)

Defined in: [WAProto/index.d.ts:11493](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11493)

* * *

### pushNameSetting?[​](#pushnamesetting "Direct link to pushNameSetting?")

> `optional` **pushNameSetting**: `null` | [`IPushNameSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPushNameSetting)

Defined in: [WAProto/index.d.ts:11433](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11433)

* * *

### quickReplyAction?[​](#quickreplyaction "Direct link to quickReplyAction?")

> `optional` **quickReplyAction**: `null` | [`IQuickReplyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IQuickReplyAction)

Defined in: [WAProto/index.d.ts:11434](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11434)

* * *

### recentEmojiWeightsAction?[​](#recentemojiweightsaction "Direct link to recentEmojiWeightsAction?")

> `optional` **recentEmojiWeightsAction**: `null` | [`IRecentEmojiWeightsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRecentEmojiWeightsAction)

Defined in: [WAProto/index.d.ts:11435](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11435)

* * *

### removeRecentStickerAction?[​](#removerecentstickeraction "Direct link to removeRecentStickerAction?")

> `optional` **removeRecentStickerAction**: `null` | [`IRemoveRecentStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRemoveRecentStickerAction)

Defined in: [WAProto/index.d.ts:11455](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11455)

* * *

### starAction?[​](#staraction "Direct link to starAction?")

> `optional` **starAction**: `null` | [`IStarAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStarAction)

Defined in: [WAProto/index.d.ts:11429](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11429)

* * *

### statusPostOptInNotificationPreferencesAction?[​](#statuspostoptinnotificationpreferencesaction "Direct link to statusPostOptInNotificationPreferencesAction?")

> `optional` **statusPostOptInNotificationPreferencesAction**: `null` | [`IStatusPostOptInNotificationPreferencesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPostOptInNotificationPreferencesAction)

Defined in: [WAProto/index.d.ts:11491](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11491)

* * *

### statusPrivacy?[​](#statusprivacy "Direct link to statusPrivacy?")

> `optional` **statusPrivacy**: `null` | [`IStatusPrivacyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPrivacyAction)

Defined in: [WAProto/index.d.ts:11465](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11465)

* * *

### stickerAction?[​](#stickeraction "Direct link to stickerAction?")

> `optional` **stickerAction**: `null` | [`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction)

Defined in: [WAProto/index.d.ts:11454](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11454)

* * *

### subscriptionAction?[​](#subscriptionaction "Direct link to subscriptionAction?")

> `optional` **subscriptionAction**: `null` | [`ISubscriptionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISubscriptionAction)

Defined in: [WAProto/index.d.ts:11449](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11449)

* * *

### timeFormatAction?[​](#timeformataction "Direct link to timeFormatAction?")

> `optional` **timeFormatAction**: `null` | [`ITimeFormatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ITimeFormatAction)

Defined in: [WAProto/index.d.ts:11451](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11451)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:11428](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11428)

* * *

### ugcBot?[​](#ugcbot "Direct link to ugcBot?")

> `optional` **ugcBot**: `null` | [`IUGCBot`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUGCBot)

Defined in: [WAProto/index.d.ts:11464](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11464)

* * *

### unarchiveChatsSetting?[​](#unarchivechatssetting "Direct link to unarchiveChatsSetting?")

> `optional` **unarchiveChatsSetting**: `null` | [`IUnarchiveChatsSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUnarchiveChatsSetting)

Defined in: [WAProto/index.d.ts:11445](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11445)

* * *

### usernameChatStartMode?[​](#usernamechatstartmode "Direct link to usernameChatStartMode?")

> `optional` **usernameChatStartMode**: `null` | [`IUsernameChatStartModeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUsernameChatStartModeAction)

Defined in: [WAProto/index.d.ts:11480](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11480)

* * *

### userStatusMuteAction?[​](#userstatusmuteaction "Direct link to userStatusMuteAction?")

> `optional` **userStatusMuteAction**: `null` | [`IUserStatusMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUserStatusMuteAction)

Defined in: [WAProto/index.d.ts:11450](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11450)

* * *

### waffleAccountLinkStateAction?[​](#waffleaccountlinkstateaction "Direct link to waffleAccountLinkStateAction?")

> `optional` **waffleAccountLinkStateAction**: `null` | [`IWaffleAccountLinkStateAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWaffleAccountLinkStateAction)

Defined in: [WAProto/index.d.ts:11479](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11479)

* * *

### wamoUserIdentifierAction?[​](#wamouseridentifieraction "Direct link to wamoUserIdentifierAction?")

> `optional` **wamoUserIdentifierAction**: `null` | [`IWamoUserIdentifierAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWamoUserIdentifierAction)

Defined in: [WAProto/index.d.ts:11473](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11473)

---

<a name="interface-isyncdindex"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISyncdIndex](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISyncdIndex)

Defined in: [WAProto/index.d.ts:12990](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12990)

## Properties[​](#properties "Direct link to Properties")

### blob?[​](#blob "Direct link to blob?")

> `optional` **blob**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:12991](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12991)

---

<a name="interface-isyncdmutation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISyncdMutation](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISyncdMutation)

Defined in: [WAProto/index.d.ts:13006](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13006)

## Properties[​](#properties "Direct link to Properties")

### operation?[​](#operation "Direct link to operation?")

> `optional` **operation**: `null` | [`SyncdOperation`](/docs/api/namespaces/proto/namespaces/SyncdMutation/enumerations/SyncdOperation)

Defined in: [WAProto/index.d.ts:13007](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13007)

* * *

### record?[​](#record "Direct link to record?")

> `optional` **record**: `null` | [`ISyncdRecord`](/docs/api/namespaces/proto/interfaces/ISyncdRecord)

Defined in: [WAProto/index.d.ts:13008](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13008)

---

<a name="interface-isyncdmutations"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISyncdMutations](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISyncdMutations)

Defined in: [WAProto/index.d.ts:13032](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13032)

## Properties[​](#properties "Direct link to Properties")

### mutations?[​](#mutations "Direct link to mutations?")

> `optional` **mutations**: `null` | [`ISyncdMutation`](/docs/api/namespaces/proto/interfaces/ISyncdMutation)\[\]

Defined in: [WAProto/index.d.ts:13033](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13033)

---

<a name="interface-isyncdpatch"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISyncdPatch](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISyncdPatch)

Defined in: [WAProto/index.d.ts:13048](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13048)

## Properties[​](#properties "Direct link to Properties")

### clientDebugData?[​](#clientdebugdata "Direct link to clientDebugData?")

> `optional` **clientDebugData**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13057](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13057)

* * *

### deviceIndex?[​](#deviceindex "Direct link to deviceIndex?")

> `optional` **deviceIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:13056](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13056)

* * *

### exitCode?[​](#exitcode "Direct link to exitCode?")

> `optional` **exitCode**: `null` | [`IExitCode`](/docs/api/namespaces/proto/interfaces/IExitCode)

Defined in: [WAProto/index.d.ts:13055](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13055)

* * *

### externalMutations?[​](#externalmutations "Direct link to externalMutations?")

> `optional` **externalMutations**: `null` | [`IExternalBlobReference`](/docs/api/namespaces/proto/interfaces/IExternalBlobReference)

Defined in: [WAProto/index.d.ts:13051](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13051)

* * *

### keyId?[​](#keyid "Direct link to keyId?")

> `optional` **keyId**: `null` | [`IKeyId`](/docs/api/namespaces/proto/interfaces/IKeyId)

Defined in: [WAProto/index.d.ts:13054](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13054)

* * *

### mutations?[​](#mutations "Direct link to mutations?")

> `optional` **mutations**: `null` | [`ISyncdMutation`](/docs/api/namespaces/proto/interfaces/ISyncdMutation)\[\]

Defined in: [WAProto/index.d.ts:13050](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13050)

* * *

### patchMac?[​](#patchmac "Direct link to patchMac?")

> `optional` **patchMac**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13053](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13053)

* * *

### snapshotMac?[​](#snapshotmac "Direct link to snapshotMac?")

> `optional` **snapshotMac**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13052](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13052)

* * *

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | [`ISyncdVersion`](/docs/api/namespaces/proto/interfaces/ISyncdVersion)

Defined in: [WAProto/index.d.ts:13049](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13049)

---

<a name="interface-isyncdrecord"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISyncdRecord](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISyncdRecord)

Defined in: [WAProto/index.d.ts:13080](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13080)

## Properties[​](#properties "Direct link to Properties")

### index?[​](#index "Direct link to index?")

> `optional` **index**: `null` | [`ISyncdIndex`](/docs/api/namespaces/proto/interfaces/ISyncdIndex)

Defined in: [WAProto/index.d.ts:13081](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13081)

* * *

### keyId?[​](#keyid "Direct link to keyId?")

> `optional` **keyId**: `null` | [`IKeyId`](/docs/api/namespaces/proto/interfaces/IKeyId)

Defined in: [WAProto/index.d.ts:13083](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13083)

* * *

### value?[​](#value "Direct link to value?")

> `optional` **value**: `null` | [`ISyncdValue`](/docs/api/namespaces/proto/interfaces/ISyncdValue)

Defined in: [WAProto/index.d.ts:13082](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13082)

---

<a name="interface-isyncdsnapshot"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISyncdSnapshot](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISyncdSnapshot)

Defined in: [WAProto/index.d.ts:13100](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13100)

## Properties[​](#properties "Direct link to Properties")

### keyId?[​](#keyid "Direct link to keyId?")

> `optional` **keyId**: `null` | [`IKeyId`](/docs/api/namespaces/proto/interfaces/IKeyId)

Defined in: [WAProto/index.d.ts:13104](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13104)

* * *

### mac?[​](#mac "Direct link to mac?")

> `optional` **mac**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13103](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13103)

* * *

### records?[​](#records "Direct link to records?")

> `optional` **records**: `null` | [`ISyncdRecord`](/docs/api/namespaces/proto/interfaces/ISyncdRecord)\[\]

Defined in: [WAProto/index.d.ts:13102](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13102)

* * *

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | [`ISyncdVersion`](/docs/api/namespaces/proto/interfaces/ISyncdVersion)

Defined in: [WAProto/index.d.ts:13101](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13101)

---

<a name="interface-isyncdvalue"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISyncdValue](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISyncdValue)

Defined in: [WAProto/index.d.ts:13122](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13122)

## Properties[​](#properties "Direct link to Properties")

### blob?[​](#blob "Direct link to blob?")

> `optional` **blob**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13123](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13123)

---

<a name="interface-isyncdversion"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISyncdVersion](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ISyncdVersion)

Defined in: [WAProto/index.d.ts:13138](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13138)

## Properties[​](#properties "Direct link to Properties")

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13139](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13139)

---

<a name="interface-itaplinkaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ITapLinkAction](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ITapLinkAction)

Defined in: [WAProto/index.d.ts:13154](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13154)

## Properties[​](#properties "Direct link to Properties")

### tapUrl?[​](#tapurl "Direct link to tapUrl?")

> `optional` **tapUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:13156](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13156)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:13155](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13155)

---

<a name="interface-itemplatebutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/ITemplateButton](https://baileys.wiki/docs/api/namespaces/proto/interfaces/ITemplateButton)

Defined in: [WAProto/index.d.ts:13172](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13172)

## Properties[​](#properties "Direct link to Properties")

### callButton?[​](#callbutton "Direct link to callButton?")

> `optional` **callButton**: `null` | [`ICallButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/ICallButton)

Defined in: [WAProto/index.d.ts:13176](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13176)

* * *

### index?[​](#index "Direct link to index?")

> `optional` **index**: `null` | `number`

Defined in: [WAProto/index.d.ts:13173](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13173)

* * *

### quickReplyButton?[​](#quickreplybutton "Direct link to quickReplyButton?")

> `optional` **quickReplyButton**: `null` | [`IQuickReplyButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IQuickReplyButton)

Defined in: [WAProto/index.d.ts:13174](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13174)

* * *

### urlButton?[​](#urlbutton "Direct link to urlButton?")

> `optional` **urlButton**: `null` | [`IURLButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IURLButton)

Defined in: [WAProto/index.d.ts:13175](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13175)

---

<a name="interface-ithreadid"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IThreadID](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IThreadID)

Defined in: [WAProto/index.d.ts:13252](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13252)

## Properties[​](#properties "Direct link to Properties")

### threadKey?[​](#threadkey "Direct link to threadKey?")

> `optional` **threadKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:13254](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13254)

* * *

### threadType?[​](#threadtype "Direct link to threadType?")

> `optional` **threadType**: `null` | [`ThreadType`](/docs/api/namespaces/proto/namespaces/ThreadID/enumerations/ThreadType)

Defined in: [WAProto/index.d.ts:13253](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13253)

---

<a name="interface-iurltrackingmap"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IUrlTrackingMap](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IUrlTrackingMap)

Defined in: [WAProto/index.d.ts:13279](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13279)

## Properties[​](#properties "Direct link to Properties")

### urlTrackingMapElements?[​](#urltrackingmapelements "Direct link to urlTrackingMapElements?")

> `optional` **urlTrackingMapElements**: `null` | [`IUrlTrackingMapElement`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/interfaces/IUrlTrackingMapElement)\[\]

Defined in: [WAProto/index.d.ts:13280](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13280)

---

<a name="interface-iuserpassword"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IUserPassword](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IUserPassword)

Defined in: [WAProto/index.d.ts:13320](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13320)

## Properties[​](#properties "Direct link to Properties")

### encoding?[​](#encoding "Direct link to encoding?")

> `optional` **encoding**: `null` | [`Encoding`](/docs/api/namespaces/proto/namespaces/UserPassword/enumerations/Encoding)

Defined in: [WAProto/index.d.ts:13321](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13321)

* * *

### transformedData?[​](#transformeddata "Direct link to transformedData?")

> `optional` **transformedData**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13324](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13324)

* * *

### transformer?[​](#transformer "Direct link to transformer?")

> `optional` **transformer**: `null` | [`Transformer`](/docs/api/namespaces/proto/namespaces/UserPassword/enumerations/Transformer)

Defined in: [WAProto/index.d.ts:13322](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13322)

* * *

### transformerArg?[​](#transformerarg "Direct link to transformerArg?")

> `optional` **transformerArg**: `null` | [`ITransformerArg`](/docs/api/namespaces/proto/namespaces/UserPassword/interfaces/ITransformerArg)\[\]

Defined in: [WAProto/index.d.ts:13323](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13323)

---

<a name="interface-iuserreceipt"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IUserReceipt](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IUserReceipt)

Defined in: [WAProto/index.d.ts:13396](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13396)

## Properties[​](#properties "Direct link to Properties")

### deliveredDeviceJid?[​](#delivereddevicejid "Direct link to deliveredDeviceJid?")

> `optional` **deliveredDeviceJid**: `null` | `string`\[\]

Defined in: [WAProto/index.d.ts:13402](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13402)

* * *

### pendingDeviceJid?[​](#pendingdevicejid "Direct link to pendingDeviceJid?")

> `optional` **pendingDeviceJid**: `null` | `string`\[\]

Defined in: [WAProto/index.d.ts:13401](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13401)

* * *

### playedTimestamp?[​](#playedtimestamp "Direct link to playedTimestamp?")

> `optional` **playedTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13400](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13400)

* * *

### readTimestamp?[​](#readtimestamp "Direct link to readTimestamp?")

> `optional` **readTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13399](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13399)

* * *

### receiptTimestamp?[​](#receipttimestamp "Direct link to receiptTimestamp?")

> `optional` **receiptTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13398](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13398)

* * *

### userJid?[​](#userjid "Direct link to userJid?")

> `optional` **userJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:13397](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13397)

---

<a name="interface-iverifiednamecertificate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IVerifiedNameCertificate](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IVerifiedNameCertificate)

Defined in: [WAProto/index.d.ts:13422](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13422)

## Properties[​](#properties "Direct link to Properties")

### details?[​](#details "Direct link to details?")

> `optional` **details**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13423](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13423)

* * *

### serverSignature?[​](#serversignature "Direct link to serverSignature?")

> `optional` **serverSignature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13425](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13425)

* * *

### signature?[​](#signature "Direct link to signature?")

> `optional` **signature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13424](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13424)

---

<a name="interface-iwallpapersettings"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IWallpaperSettings](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IWallpaperSettings)

Defined in: [WAProto/index.d.ts:13469](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13469)

## Properties[​](#properties "Direct link to Properties")

### filename?[​](#filename "Direct link to filename?")

> `optional` **filename**: `null` | `string`

Defined in: [WAProto/index.d.ts:13470](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13470)

* * *

### opacity?[​](#opacity "Direct link to opacity?")

> `optional` **opacity**: `null` | `number`

Defined in: [WAProto/index.d.ts:13471](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13471)

---

<a name="interface-iwebfeatures"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IWebFeatures](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IWebFeatures)

Defined in: [WAProto/index.d.ts:13487](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13487)

## Properties[​](#properties "Direct link to Properties")

### archiveV2?[​](#archivev2 "Direct link to archiveV2?")

> `optional` **archiveV2**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13526](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13526)

* * *

### catalog?[​](#catalog "Direct link to catalog?")

> `optional` **catalog**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13512](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13512)

* * *

### changeNumberV2?[​](#changenumberv2 "Direct link to changeNumberV2?")

> `optional` **changeNumberV2**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13492](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13492)

* * *

### disappearingMode?[​](#disappearingmode "Direct link to disappearingMode?")

> `optional` **disappearingMode**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13530](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13530)

* * *

### e2ENotificationSync?[​](#e2enotificationsync "Direct link to e2ENotificationSync?")

> `optional` **e2ENotificationSync**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13518](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13518)

* * *

### ephemeral24HDuration?[​](#ephemeral24hduration "Direct link to ephemeral24HDuration?")

> `optional` **ephemeral24HDuration**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13528](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13528)

* * *

### ephemeralAllowGroupMembers?[​](#ephemeralallowgroupmembers "Direct link to ephemeralAllowGroupMembers?")

> `optional` **ephemeralAllowGroupMembers**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13527](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13527)

* * *

### ephemeralMessages?[​](#ephemeralmessages "Direct link to ephemeralMessages?")

> `optional` **ephemeralMessages**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13517](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13517)

* * *

### externalMdOptInAvailable?[​](#externalmdoptinavailable "Direct link to externalMdOptInAvailable?")

> `optional` **externalMdOptInAvailable**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13531](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13531)

* * *

### frequentlyForwardedSetting?[​](#frequentlyforwardedsetting "Direct link to frequentlyForwardedSetting?")

> `optional` **frequentlyForwardedSetting**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13509](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13509)

* * *

### groupDogfoodingInternalOnly?[​](#groupdogfoodinginternalonly "Direct link to groupDogfoodingInternalOnly?")

> `optional` **groupDogfoodingInternalOnly**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13524](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13524)

* * *

### groupsV3?[​](#groupsv3 "Direct link to groupsV3?")

> `optional` **groupsV3**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13490](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13490)

* * *

### groupsV3Create?[​](#groupsv3create "Direct link to groupsV3Create?")

> `optional` **groupsV3Create**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13491](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13491)

* * *

### groupsV4JoinPermission?[​](#groupsv4joinpermission "Direct link to groupsV4JoinPermission?")

> `optional` **groupsV4JoinPermission**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13510](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13510)

* * *

### groupUiiCleanup?[​](#groupuiicleanup "Direct link to groupUiiCleanup?")

> `optional` **groupUiiCleanup**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13523](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13523)

* * *

### labelsDisplay?[​](#labelsdisplay "Direct link to labelsDisplay?")

> `optional` **labelsDisplay**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13488](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13488)

* * *

### labelsEdit?[​](#labelsedit "Direct link to labelsEdit?")

> `optional` **labelsEdit**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13501](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13501)

* * *

### liveLocations?[​](#livelocations "Direct link to liveLocations?")

> `optional` **liveLocations**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13494](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13494)

* * *

### liveLocationsFinal?[​](#livelocationsfinal "Direct link to liveLocationsFinal?")

> `optional` **liveLocationsFinal**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13500](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13500)

* * *

### mdForceUpgrade?[​](#mdforceupgrade "Direct link to mdForceUpgrade?")

> `optional` **mdForceUpgrade**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13529](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13529)

* * *

### mediaUpload?[​](#mediaupload "Direct link to mediaUpload?")

> `optional` **mediaUpload**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13502](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13502)

* * *

### mediaUploadRichQuickReplies?[​](#mediauploadrichquickreplies "Direct link to mediaUploadRichQuickReplies?")

> `optional` **mediaUploadRichQuickReplies**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13503](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13503)

* * *

### noDeleteMessageTimeLimit?[​](#nodeletemessagetimelimit "Direct link to noDeleteMessageTimeLimit?")

> `optional` **noDeleteMessageTimeLimit**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13532](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13532)

* * *

### payments?[​](#payments "Direct link to payments?")

> `optional` **payments**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13498](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13498)

* * *

### queryStatusV3Thumbnail?[​](#querystatusv3thumbnail "Direct link to queryStatusV3Thumbnail?")

> `optional` **queryStatusV3Thumbnail**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13493](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13493)

* * *

### queryVname?[​](#queryvname "Direct link to queryVname?")

> `optional` **queryVname**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13495](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13495)

* * *

### quickRepliesQuery?[​](#quickrepliesquery "Direct link to quickRepliesQuery?")

> `optional` **quickRepliesQuery**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13497](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13497)

* * *

### recentStickers?[​](#recentstickers "Direct link to recentStickers?")

> `optional` **recentStickers**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13511](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13511)

* * *

### recentStickersV2?[​](#recentstickersv2 "Direct link to recentStickersV2?")

> `optional` **recentStickersV2**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13519](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13519)

* * *

### recentStickersV3?[​](#recentstickersv3 "Direct link to recentStickersV3?")

> `optional` **recentStickersV3**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13520](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13520)

* * *

### settingsSync?[​](#settingssync "Direct link to settingsSync?")

> `optional` **settingsSync**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13525](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13525)

* * *

### starredStickers?[​](#starredstickers "Direct link to starredStickers?")

> `optional` **starredStickers**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13513](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13513)

* * *

### statusRanking?[​](#statusranking "Direct link to statusRanking?")

> `optional` **statusRanking**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13506](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13506)

* * *

### stickerPackQuery?[​](#stickerpackquery "Direct link to stickerPackQuery?")

> `optional` **stickerPackQuery**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13499](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13499)

* * *

### support?[​](#support "Direct link to support?")

> `optional` **support**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13522](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13522)

* * *

### templateMessage?[​](#templatemessage "Direct link to templateMessage?")

> `optional` **templateMessage**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13515](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13515)

* * *

### templateMessageInteractivity?[​](#templatemessageinteractivity "Direct link to templateMessageInteractivity?")

> `optional` **templateMessageInteractivity**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13516](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13516)

* * *

### thirdPartyStickers?[​](#thirdpartystickers "Direct link to thirdPartyStickers?")

> `optional` **thirdPartyStickers**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13508](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13508)

* * *

### userNotice?[​](#usernotice "Direct link to userNotice?")

> `optional` **userNotice**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13521](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13521)

* * *

### videoPlaybackUrl?[​](#videoplaybackurl "Direct link to videoPlaybackUrl?")

> `optional` **videoPlaybackUrl**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13505](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13505)

* * *

### vnameV2?[​](#vnamev2 "Direct link to vnameV2?")

> `optional` **vnameV2**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13504](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13504)

* * *

### voipGroupCall?[​](#voipgroupcall "Direct link to voipGroupCall?")

> `optional` **voipGroupCall**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13514](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13514)

* * *

### voipIndividualIncoming?[​](#voipindividualincoming "Direct link to voipIndividualIncoming?")

> `optional` **voipIndividualIncoming**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13496](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13496)

* * *

### voipIndividualOutgoing?[​](#voipindividualoutgoing "Direct link to voipIndividualOutgoing?")

> `optional` **voipIndividualOutgoing**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13489](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13489)

* * *

### voipIndividualVideo?[​](#voipindividualvideo "Direct link to voipIndividualVideo?")

> `optional` **voipIndividualVideo**: `null` | [`Flag`](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13507](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13507)

---

<a name="interface-iwebmessageinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IWebMessageInfo](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IWebMessageInfo)

Defined in: [WAProto/index.d.ts:13606](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13606)

## Properties[​](#properties "Direct link to Properties")

### agentId?[​](#agentid "Direct link to agentId?")

> `optional` **agentId**: `null` | `string`

Defined in: [WAProto/index.d.ts:13644](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13644)

* * *

### bizPrivacyStatus?[​](#bizprivacystatus "Direct link to bizPrivacyStatus?")

> `optional` **bizPrivacyStatus**: `null` | [`BizPrivacyStatus`](/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/BizPrivacyStatus)

Defined in: [WAProto/index.d.ts:13633](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13633)

* * *

### botMessageInvokerJid?[​](#botmessageinvokerjid "Direct link to botMessageInvokerJid?")

> `optional` **botMessageInvokerJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:13654](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13654)

* * *

### botTargetId?[​](#bottargetid "Direct link to botTargetId?")

> `optional` **botTargetId**: `null` | `string`

Defined in: [WAProto/index.d.ts:13668](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13668)

* * *

### broadcast?[​](#broadcast "Direct link to broadcast?")

> `optional` **broadcast**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13615](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13615)

* * *

### clearMedia?[​](#clearmedia "Direct link to clearMedia?")

> `optional` **clearMedia**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13622](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13622)

* * *

### commentMetadata?[​](#commentmetadata "Direct link to commentMetadata?")

> `optional` **commentMetadata**: `null` | [`ICommentMetadata`](/docs/api/namespaces/proto/interfaces/ICommentMetadata)

Defined in: [WAProto/index.d.ts:13655](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13655)

* * *

### duration?[​](#duration "Direct link to duration?")

> `optional` **duration**: `null` | `number`

Defined in: [WAProto/index.d.ts:13624](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13624)

* * *

### ephemeralDuration?[​](#ephemeralduration "Direct link to ephemeralDuration?")

> `optional` **ephemeralDuration**: `null` | `number`

Defined in: [WAProto/index.d.ts:13630](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13630)

* * *

### ephemeralOffToOn?[​](#ephemeralofftoon "Direct link to ephemeralOffToOn?")

> `optional` **ephemeralOffToOn**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13631](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13631)

* * *

### ephemeralOutOfSync?[​](#ephemeraloutofsync "Direct link to ephemeralOutOfSync?")

> `optional` **ephemeralOutOfSync**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13632](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13632)

* * *

### ephemeralStartTimestamp?[​](#ephemeralstarttimestamp "Direct link to ephemeralStartTimestamp?")

> `optional` **ephemeralStartTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13629](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13629)

* * *

### eventAdditionalMetadata?[​](#eventadditionalmetadata "Direct link to eventAdditionalMetadata?")

> `optional` **eventAdditionalMetadata**: `null` | [`IEventAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IEventAdditionalMetadata)

Defined in: [WAProto/index.d.ts:13659](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13659)

* * *

### eventResponses?[​](#eventresponses "Direct link to eventResponses?")

> `optional` **eventResponses**: `null` | [`IEventResponse`](/docs/api/namespaces/proto/interfaces/IEventResponse)\[\]

Defined in: [WAProto/index.d.ts:13656](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13656)

* * *

### finalLiveLocation?[​](#finallivelocation "Direct link to finalLiveLocation?")

> `optional` **finalLiveLocation**: `null` | [`ILiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage)

Defined in: [WAProto/index.d.ts:13627](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13627)

* * *

### futureproofData?[​](#futureproofdata "Direct link to futureproofData?")

> `optional` **futureproofData**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13640](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13640)

* * *

### groupHistoryBundleInfo?[​](#grouphistorybundleinfo "Direct link to groupHistoryBundleInfo?")

> `optional` **groupHistoryBundleInfo**: `null` | [`IGroupHistoryBundleInfo`](/docs/api/namespaces/proto/interfaces/IGroupHistoryBundleInfo)

Defined in: [WAProto/index.d.ts:13670](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13670)

* * *

### groupHistoryIndividualMessageInfo?[​](#grouphistoryindividualmessageinfo "Direct link to groupHistoryIndividualMessageInfo?")

> `optional` **groupHistoryIndividualMessageInfo**: `null` | [`IGroupHistoryIndividualMessageInfo`](/docs/api/namespaces/proto/interfaces/IGroupHistoryIndividualMessageInfo)

Defined in: [WAProto/index.d.ts:13669](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13669)

* * *

### ignore?[​](#ignore "Direct link to ignore?")

> `optional` **ignore**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13613](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13613)

* * *

### interactiveMessageAdditionalMetadata?[​](#interactivemessageadditionalmetadata "Direct link to interactiveMessageAdditionalMetadata?")

> `optional` **interactiveMessageAdditionalMetadata**: `null` | [`IInteractiveMessageAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IInteractiveMessageAdditionalMetadata)

Defined in: [WAProto/index.d.ts:13671](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13671)

* * *

### is1PBizBotMessage?[​](#is1pbizbotmessage "Direct link to is1PBizBotMessage?")

> `optional` **is1PBizBotMessage**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13652](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13652)

* * *

### isGroupHistoryMessage?[​](#isgrouphistorymessage "Direct link to isGroupHistoryMessage?")

> `optional` **isGroupHistoryMessage**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13653](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13653)

* * *

### isMentionedInStatus?[​](#ismentionedinstatus "Direct link to isMentionedInStatus?")

> `optional` **isMentionedInStatus**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13660](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13660)

* * *

### isSupportAiMessage?[​](#issupportaimessage "Direct link to isSupportAiMessage?")

> `optional` **isSupportAiMessage**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13665](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13665)

* * *

### keepInChat?[​](#keepinchat "Direct link to keepInChat?")

> `optional` **keepInChat**: `null` | [`IKeepInChat`](/docs/api/namespaces/proto/interfaces/IKeepInChat)

Defined in: [WAProto/index.d.ts:13647](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13647)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:13607](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13607)

* * *

### labels?[​](#labels "Direct link to labels?")

> `optional` **labels**: `null` | `string`\[\]

Defined in: [WAProto/index.d.ts:13625](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13625)

* * *

### mediaCiphertextSha256?[​](#mediaciphertextsha256 "Direct link to mediaCiphertextSha256?")

> `optional` **mediaCiphertextSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13617](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13617)

* * *

### mediaData?[​](#mediadata "Direct link to mediaData?")

> `optional` **mediaData**: `null` | [`IMediaData`](/docs/api/namespaces/proto/interfaces/IMediaData)

Defined in: [WAProto/index.d.ts:13635](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13635)

* * *

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:13608](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13608)

* * *

### messageAddOns?[​](#messageaddons "Direct link to messageAddOns?")

> `optional` **messageAddOns**: `null` | [`IMessageAddOn`](/docs/api/namespaces/proto/interfaces/IMessageAddOn)\[\]

Defined in: [WAProto/index.d.ts:13663](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13663)

* * *

### messageC2STimestamp?[​](#messagec2stimestamp "Direct link to messageC2STimestamp?")

> `optional` **messageC2STimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13612](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13612)

* * *

### messageSecret?[​](#messagesecret "Direct link to messageSecret?")

> `optional` **messageSecret**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13646](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13646)

* * *

### messageStubParameters?[​](#messagestubparameters "Direct link to messageStubParameters?")

> `optional` **messageStubParameters**: `null` | `string`\[\]

Defined in: [WAProto/index.d.ts:13623](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13623)

* * *

### messageStubType?[​](#messagestubtype "Direct link to messageStubType?")

> `optional` **messageStubType**: `null` | [`StubType`](/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/StubType)

Defined in: [WAProto/index.d.ts:13621](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13621)

* * *

### messageTimestamp?[​](#messagetimestamp "Direct link to messageTimestamp?")

> `optional` **messageTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13609](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13609)

* * *

### multicast?[​](#multicast "Direct link to multicast?")

> `optional` **multicast**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13618](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13618)

* * *

### newsletterServerId?[​](#newsletterserverid "Direct link to newsletterServerId?")

> `optional` **newsletterServerId**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13658](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13658)

* * *

### originalSelfAuthorUserJidString?[​](#originalselfauthoruserjidstring "Direct link to originalSelfAuthorUserJidString?")

> `optional` **originalSelfAuthorUserJidString**: `null` | `string`

Defined in: [WAProto/index.d.ts:13648](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13648)

* * *

### participant?[​](#participant "Direct link to participant?")

> `optional` **participant**: `null` | `string`

Defined in: [WAProto/index.d.ts:13611](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13611)

* * *

### paymentInfo?[​](#paymentinfo "Direct link to paymentInfo?")

> `optional` **paymentInfo**: `null` | [`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo)

Defined in: [WAProto/index.d.ts:13626](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13626)

* * *

### photoChange?[​](#photochange "Direct link to photoChange?")

> `optional` **photoChange**: `null` | [`IPhotoChange`](/docs/api/namespaces/proto/interfaces/IPhotoChange)

Defined in: [WAProto/index.d.ts:13636](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13636)

* * *

### pinInChat?[​](#pininchat "Direct link to pinInChat?")

> `optional` **pinInChat**: `null` | [`IPinInChat`](/docs/api/namespaces/proto/interfaces/IPinInChat)

Defined in: [WAProto/index.d.ts:13650](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13650)

* * *

### pollAdditionalMetadata?[​](#polladditionalmetadata "Direct link to pollAdditionalMetadata?")

> `optional` **pollAdditionalMetadata**: `null` | [`IPollAdditionalMetadata`](/docs/api/namespaces/proto/interfaces/IPollAdditionalMetadata)

Defined in: [WAProto/index.d.ts:13643](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13643)

* * *

### pollUpdates?[​](#pollupdates "Direct link to pollUpdates?")

> `optional` **pollUpdates**: `null` | [`IPollUpdate`](/docs/api/namespaces/proto/interfaces/IPollUpdate)\[\]

Defined in: [WAProto/index.d.ts:13642](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13642)

* * *

### premiumMessageInfo?[​](#premiummessageinfo "Direct link to premiumMessageInfo?")

> `optional` **premiumMessageInfo**: `null` | [`IPremiumMessageInfo`](/docs/api/namespaces/proto/interfaces/IPremiumMessageInfo)

Defined in: [WAProto/index.d.ts:13651](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13651)

* * *

### pushName?[​](#pushname "Direct link to pushName?")

> `optional` **pushName**: `null` | `string`

Defined in: [WAProto/index.d.ts:13616](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13616)

* * *

### quarantinedMessage?[​](#quarantinedmessage "Direct link to quarantinedMessage?")

> `optional` **quarantinedMessage**: `null` | [`IQuarantinedMessage`](/docs/api/namespaces/proto/interfaces/IQuarantinedMessage)

Defined in: [WAProto/index.d.ts:13672](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13672)

* * *

### quotedPaymentInfo?[​](#quotedpaymentinfo "Direct link to quotedPaymentInfo?")

> `optional` **quotedPaymentInfo**: `null` | [`IPaymentInfo`](/docs/api/namespaces/proto/interfaces/IPaymentInfo)

Defined in: [WAProto/index.d.ts:13628](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13628)

* * *

### quotedStickerData?[​](#quotedstickerdata "Direct link to quotedStickerData?")

> `optional` **quotedStickerData**: `null` | [`IMediaData`](/docs/api/namespaces/proto/interfaces/IMediaData)

Defined in: [WAProto/index.d.ts:13639](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13639)

* * *

### reactions?[​](#reactions "Direct link to reactions?")

> `optional` **reactions**: `null` | [`IReaction`](/docs/api/namespaces/proto/interfaces/IReaction)\[\]

Defined in: [WAProto/index.d.ts:13638](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13638)

* * *

### reportingTokenInfo?[​](#reportingtokeninfo "Direct link to reportingTokenInfo?")

> `optional` **reportingTokenInfo**: `null` | [`IReportingTokenInfo`](/docs/api/namespaces/proto/interfaces/IReportingTokenInfo)

Defined in: [WAProto/index.d.ts:13657](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13657)

* * *

### revokeMessageTimestamp?[​](#revokemessagetimestamp "Direct link to revokeMessageTimestamp?")

> `optional` **revokeMessageTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13649](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13649)

* * *

### starred?[​](#starred "Direct link to starred?")

> `optional` **starred**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13614](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13614)

* * *

### status?[​](#status "Direct link to status?")

> `optional` **status**: `null` | [`Status`](/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/Status)

Defined in: [WAProto/index.d.ts:13610](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13610)

* * *

### statusAlreadyViewed?[​](#statusalreadyviewed "Direct link to statusAlreadyViewed?")

> `optional` **statusAlreadyViewed**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13645](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13645)

* * *

### statusMentionMessageInfo?[​](#statusmentionmessageinfo "Direct link to statusMentionMessageInfo?")

> `optional` **statusMentionMessageInfo**: `null` | [`IStatusMentionMessage`](/docs/api/namespaces/proto/interfaces/IStatusMentionMessage)

Defined in: [WAProto/index.d.ts:13664](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13664)

* * *

### statusMentions?[​](#statusmentions "Direct link to statusMentions?")

> `optional` **statusMentions**: `null` | `string`\[\]

Defined in: [WAProto/index.d.ts:13661](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13661)

* * *

### statusMentionSources?[​](#statusmentionsources "Direct link to statusMentionSources?")

> `optional` **statusMentionSources**: `null` | `string`\[\]

Defined in: [WAProto/index.d.ts:13666](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13666)

* * *

### statusPsa?[​](#statuspsa "Direct link to statusPsa?")

> `optional` **statusPsa**: `null` | [`IStatusPSA`](/docs/api/namespaces/proto/interfaces/IStatusPSA)

Defined in: [WAProto/index.d.ts:13641](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13641)

* * *

### supportAiCitations?[​](#supportaicitations "Direct link to supportAiCitations?")

> `optional` **supportAiCitations**: `null` | [`ICitation`](/docs/api/namespaces/proto/interfaces/ICitation)\[\]

Defined in: [WAProto/index.d.ts:13667](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13667)

* * *

### targetMessageId?[​](#targetmessageid "Direct link to targetMessageId?")

> `optional` **targetMessageId**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:13662](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13662)

* * *

### urlNumber?[​](#urlnumber "Direct link to urlNumber?")

> `optional` **urlNumber**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13620](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13620)

* * *

### urlText?[​](#urltext "Direct link to urlText?")

> `optional` **urlText**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:13619](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13619)

* * *

### userReceipt?[​](#userreceipt "Direct link to userReceipt?")

> `optional` **userReceipt**: `null` | [`IUserReceipt`](/docs/api/namespaces/proto/interfaces/IUserReceipt)\[\]

Defined in: [WAProto/index.d.ts:13637](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13637)

* * *

### verifiedBizName?[​](#verifiedbizname "Direct link to verifiedBizName?")

> `optional` **verifiedBizName**: `null` | `string`

Defined in: [WAProto/index.d.ts:13634](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13634)

---

<a name="interface-iwebnotificationsinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/interfaces/IWebNotificationsInfo](https://baileys.wiki/docs/api/namespaces/proto/interfaces/IWebNotificationsInfo)

Defined in: [WAProto/index.d.ts:13996](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13996)

## Properties[​](#properties "Direct link to Properties")

### notifyMessageCount?[​](#notifymessagecount "Direct link to notifyMessageCount?")

> `optional` **notifyMessageCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:13999](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13999)

* * *

### notifyMessages?[​](#notifymessages "Direct link to notifyMessages?")

> `optional` **notifyMessages**: `null` | [`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo)\[\]

Defined in: [WAProto/index.d.ts:14000](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L14000)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13997](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13997)

* * *

### unreadChats?[​](#unreadchats "Direct link to unreadChats?")

> `optional` **unreadChats**: `null` | `number`

Defined in: [WAProto/index.d.ts:13998](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13998)

---

<a name="aihomestate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIHomeState/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIHomeState/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [AIHomeOption](/docs/api/namespaces/proto/namespaces/AIHomeState/namespaces/AIHomeOption/)

## Classes[​](#classes "Direct link to Classes")

*   [AIHomeOption](/docs/api/namespaces/proto/namespaces/AIHomeState/classes/AIHomeOption)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IAIHomeOption](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption)

---

<a name="class-aihomeoption"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIHomeState/classes/AIHomeOption](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIHomeState/classes/AIHomeOption)

Defined in: [WAProto/index.d.ts:152](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L152)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIHomeOption()[​](#new-aihomeoption "Direct link to new AIHomeOption()")

> **new AIHomeOption**(`p`?): [`AIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/classes/AIHomeOption)

Defined in: [WAProto/index.d.ts:153](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L153)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption)

#### Returns[​](#returns "Direct link to Returns")

[`AIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/classes/AIHomeOption)

## Properties[​](#properties "Direct link to Properties")

### imageBackgroundColor?[​](#imagebackgroundcolor "Direct link to imageBackgroundColor?")

> `optional` **imageBackgroundColor**: `null` | `string`

Defined in: [WAProto/index.d.ts:160](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L160)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption).[`imageBackgroundColor`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption#imagebackgroundcolor)

* * *

### imageTintColor?[​](#imagetintcolor "Direct link to imageTintColor?")

> `optional` **imageTintColor**: `null` | `string`

Defined in: [WAProto/index.d.ts:159](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L159)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption).[`imageTintColor`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption#imagetintcolor)

* * *

### imageWdsIdentifier?[​](#imagewdsidentifier "Direct link to imageWdsIdentifier?")

> `optional` **imageWdsIdentifier**: `null` | `string`

Defined in: [WAProto/index.d.ts:158](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L158)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption).[`imageWdsIdentifier`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption#imagewdsidentifier)

* * *

### promptText?[​](#prompttext "Direct link to promptText?")

> `optional` **promptText**: `null` | `string`

Defined in: [WAProto/index.d.ts:156](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L156)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IAIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption).[`promptText`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption#prompttext)

* * *

### sessionId?[​](#sessionid "Direct link to sessionId?")

> `optional` **sessionId**: `null` | `string`

Defined in: [WAProto/index.d.ts:157](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L157)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IAIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption).[`sessionId`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption#sessionid)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:155](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L155)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IAIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption).[`title`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption#title)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`AIHomeActionType`](/docs/api/namespaces/proto/namespaces/AIHomeState/namespaces/AIHomeOption/enumerations/AIHomeActionType)

Defined in: [WAProto/index.d.ts:154](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L154)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IAIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption).[`type`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption#type)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:166](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L166)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/classes/AIHomeOption)

Defined in: [WAProto/index.d.ts:161](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L161)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/classes/AIHomeOption)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/classes/AIHomeOption)

Defined in: [WAProto/index.d.ts:163](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L163)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/classes/AIHomeOption)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:162](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L162)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/classes/AIHomeOption)

Defined in: [WAProto/index.d.ts:164](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L164)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/classes/AIHomeOption)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:167](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L167)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:165](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L165)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIHomeOption`](/docs/api/namespaces/proto/namespaces/AIHomeState/classes/AIHomeOption)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-iaihomeoption"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIHomeState/interfaces/IAIHomeOption)

Defined in: [WAProto/index.d.ts:142](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L142)

## Properties[​](#properties "Direct link to Properties")

### imageBackgroundColor?[​](#imagebackgroundcolor "Direct link to imageBackgroundColor?")

> `optional` **imageBackgroundColor**: `null` | `string`

Defined in: [WAProto/index.d.ts:149](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L149)

* * *

### imageTintColor?[​](#imagetintcolor "Direct link to imageTintColor?")

> `optional` **imageTintColor**: `null` | `string`

Defined in: [WAProto/index.d.ts:148](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L148)

* * *

### imageWdsIdentifier?[​](#imagewdsidentifier "Direct link to imageWdsIdentifier?")

> `optional` **imageWdsIdentifier**: `null` | `string`

Defined in: [WAProto/index.d.ts:147](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L147)

* * *

### promptText?[​](#prompttext "Direct link to promptText?")

> `optional` **promptText**: `null` | `string`

Defined in: [WAProto/index.d.ts:145](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L145)

* * *

### sessionId?[​](#sessionid "Direct link to sessionId?")

> `optional` **sessionId**: `null` | `string`

Defined in: [WAProto/index.d.ts:146](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L146)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:144](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L144)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`AIHomeActionType`](/docs/api/namespaces/proto/namespaces/AIHomeState/namespaces/AIHomeOption/enumerations/AIHomeActionType)

Defined in: [WAProto/index.d.ts:143](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L143)

---

<a name="aihomeoption"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIHomeState/namespaces/AIHomeOption/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIHomeState/namespaces/AIHomeOption/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [AIHomeActionType](/docs/api/namespaces/proto/namespaces/AIHomeState/namespaces/AIHomeOption/enumerations/AIHomeActionType)

---

<a name="enumeration-aihomeactiontype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIHomeState/namespaces/AIHomeOption/enumerations/AIHomeActionType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIHomeState/namespaces/AIHomeOption/enumerations/AIHomeActionType)

Defined in: [WAProto/index.d.ts:172](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L172)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### ANALYZE\_FILE[​](#analyze_file "Direct link to ANALYZE_FILE")

> **ANALYZE\_FILE**: `3`

Defined in: [WAProto/index.d.ts:176](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L176)

* * *

### ANIMATE\_PHOTO[​](#animate_photo "Direct link to ANIMATE_PHOTO")

> **ANIMATE\_PHOTO**: `2`

Defined in: [WAProto/index.d.ts:175](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L175)

* * *

### CREATE\_IMAGE[​](#create_image "Direct link to CREATE_IMAGE")

> **CREATE\_IMAGE**: `1`

Defined in: [WAProto/index.d.ts:174](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L174)

* * *

### PROMPT[​](#prompt "Direct link to PROMPT")

> **PROMPT**: `0`

Defined in: [WAProto/index.d.ts:173](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L173)

---

<a name="airichresponsecodemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [AIRichResponseCodeHighlightType](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/enumerations/AIRichResponseCodeHighlightType)

## Classes[​](#classes "Direct link to Classes")

*   [AIRichResponseCodeBlock](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/classes/AIRichResponseCodeBlock)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IAIRichResponseCodeBlock](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/interfaces/IAIRichResponseCodeBlock)

---

<a name="class-airichresponsecodeblock"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/classes/AIRichResponseCodeBlock](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/classes/AIRichResponseCodeBlock)

Defined in: [WAProto/index.d.ts:244](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L244)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIRichResponseCodeBlock`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/interfaces/IAIRichResponseCodeBlock)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIRichResponseCodeBlock()[​](#new-airichresponsecodeblock "Direct link to new AIRichResponseCodeBlock()")

> **new AIRichResponseCodeBlock**(`p`?): [`AIRichResponseCodeBlock`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/classes/AIRichResponseCodeBlock)

Defined in: [WAProto/index.d.ts:245](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L245)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIRichResponseCodeBlock`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/interfaces/IAIRichResponseCodeBlock)

#### Returns[​](#returns "Direct link to Returns")

[`AIRichResponseCodeBlock`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/classes/AIRichResponseCodeBlock)

## Properties[​](#properties "Direct link to Properties")

### codeContent?[​](#codecontent "Direct link to codeContent?")

> `optional` **codeContent**: `null` | `string`

Defined in: [WAProto/index.d.ts:247](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L247)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIRichResponseCodeBlock`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/interfaces/IAIRichResponseCodeBlock).[`codeContent`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/interfaces/IAIRichResponseCodeBlock#codecontent)

* * *

### highlightType?[​](#highlighttype "Direct link to highlightType?")

> `optional` **highlightType**: `null` | [`AIRichResponseCodeHighlightType`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/enumerations/AIRichResponseCodeHighlightType)

Defined in: [WAProto/index.d.ts:246](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L246)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIRichResponseCodeBlock`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/interfaces/IAIRichResponseCodeBlock).[`highlightType`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/interfaces/IAIRichResponseCodeBlock#highlighttype)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:253](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L253)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIRichResponseCodeBlock`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/classes/AIRichResponseCodeBlock)

Defined in: [WAProto/index.d.ts:248](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L248)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIRichResponseCodeBlock`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/interfaces/IAIRichResponseCodeBlock)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIRichResponseCodeBlock`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/classes/AIRichResponseCodeBlock)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIRichResponseCodeBlock`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/classes/AIRichResponseCodeBlock)

Defined in: [WAProto/index.d.ts:250](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L250)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIRichResponseCodeBlock`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/classes/AIRichResponseCodeBlock)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:249](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L249)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIRichResponseCodeBlock`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/interfaces/IAIRichResponseCodeBlock)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIRichResponseCodeBlock`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/classes/AIRichResponseCodeBlock)

Defined in: [WAProto/index.d.ts:251](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L251)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIRichResponseCodeBlock`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/classes/AIRichResponseCodeBlock)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:254](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L254)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:252](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L252)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIRichResponseCodeBlock`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/classes/AIRichResponseCodeBlock)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-airichresponsecodehighlighttype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/enumerations/AIRichResponseCodeHighlightType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/enumerations/AIRichResponseCodeHighlightType)

Defined in: [WAProto/index.d.ts:257](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L257)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AI\_RICH\_RESPONSE\_CODE\_HIGHLIGHT\_COMMENT[​](#ai_rich_response_code_highlight_comment "Direct link to AI_RICH_RESPONSE_CODE_HIGHLIGHT_COMMENT")

> **AI\_RICH\_RESPONSE\_CODE\_HIGHLIGHT\_COMMENT**: `5`

Defined in: [WAProto/index.d.ts:263](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L263)

* * *

### AI\_RICH\_RESPONSE\_CODE\_HIGHLIGHT\_DEFAULT[​](#ai_rich_response_code_highlight_default "Direct link to AI_RICH_RESPONSE_CODE_HIGHLIGHT_DEFAULT")

> **AI\_RICH\_RESPONSE\_CODE\_HIGHLIGHT\_DEFAULT**: `0`

Defined in: [WAProto/index.d.ts:258](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L258)

* * *

### AI\_RICH\_RESPONSE\_CODE\_HIGHLIGHT\_KEYWORD[​](#ai_rich_response_code_highlight_keyword "Direct link to AI_RICH_RESPONSE_CODE_HIGHLIGHT_KEYWORD")

> **AI\_RICH\_RESPONSE\_CODE\_HIGHLIGHT\_KEYWORD**: `1`

Defined in: [WAProto/index.d.ts:259](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L259)

* * *

### AI\_RICH\_RESPONSE\_CODE\_HIGHLIGHT\_METHOD[​](#ai_rich_response_code_highlight_method "Direct link to AI_RICH_RESPONSE_CODE_HIGHLIGHT_METHOD")

> **AI\_RICH\_RESPONSE\_CODE\_HIGHLIGHT\_METHOD**: `2`

Defined in: [WAProto/index.d.ts:260](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L260)

* * *

### AI\_RICH\_RESPONSE\_CODE\_HIGHLIGHT\_NUMBER[​](#ai_rich_response_code_highlight_number "Direct link to AI_RICH_RESPONSE_CODE_HIGHLIGHT_NUMBER")

> **AI\_RICH\_RESPONSE\_CODE\_HIGHLIGHT\_NUMBER**: `4`

Defined in: [WAProto/index.d.ts:262](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L262)

* * *

### AI\_RICH\_RESPONSE\_CODE\_HIGHLIGHT\_STRING[​](#ai_rich_response_code_highlight_string "Direct link to AI_RICH_RESPONSE_CODE_HIGHLIGHT_STRING")

> **AI\_RICH\_RESPONSE\_CODE\_HIGHLIGHT\_STRING**: `3`

Defined in: [WAProto/index.d.ts:261](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L261)

---

<a name="interface-iairichresponsecodeblock"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/interfaces/IAIRichResponseCodeBlock](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/interfaces/IAIRichResponseCodeBlock)

Defined in: [WAProto/index.d.ts:239](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L239)

## Properties[​](#properties "Direct link to Properties")

### codeContent?[​](#codecontent "Direct link to codeContent?")

> `optional` **codeContent**: `null` | `string`

Defined in: [WAProto/index.d.ts:241](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L241)

* * *

### highlightType?[​](#highlighttype "Direct link to highlightType?")

> `optional` **highlightType**: `null` | [`AIRichResponseCodeHighlightType`](/docs/api/namespaces/proto/namespaces/AIRichResponseCodeMetadata/enumerations/AIRichResponseCodeHighlightType)

Defined in: [WAProto/index.d.ts:240](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L240)

---

<a name="airichresponsecontentitemsmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [ContentType](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/enumerations/ContentType)

## Classes[​](#classes "Direct link to Classes")

*   [AIRichResponseContentItemMetadata](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseContentItemMetadata)
*   [AIRichResponseReelItem](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseReelItem)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IAIRichResponseContentItemMetadata](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseContentItemMetadata)
*   [IAIRichResponseReelItem](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseReelItem)

---

<a name="class-airichresponsecontentitemmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseContentItemMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseContentItemMetadata)

Defined in: [WAProto/index.d.ts:291](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L291)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIRichResponseContentItemMetadata`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseContentItemMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIRichResponseContentItemMetadata()[​](#new-airichresponsecontentitemmetadata "Direct link to new AIRichResponseContentItemMetadata()")

> **new AIRichResponseContentItemMetadata**(`p`?): [`AIRichResponseContentItemMetadata`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseContentItemMetadata)

Defined in: [WAProto/index.d.ts:292](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L292)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIRichResponseContentItemMetadata`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseContentItemMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`AIRichResponseContentItemMetadata`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseContentItemMetadata)

## Properties[​](#properties "Direct link to Properties")

### aIRichResponseContentItem?[​](#airichresponsecontentitem "Direct link to aIRichResponseContentItem?")

> `optional` **aIRichResponseContentItem**: `"reelItem"`

Defined in: [WAProto/index.d.ts:294](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L294)

* * *

### reelItem?[​](#reelitem "Direct link to reelItem?")

> `optional` **reelItem**: `null` | [`IAIRichResponseReelItem`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseReelItem)

Defined in: [WAProto/index.d.ts:293](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L293)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIRichResponseContentItemMetadata`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseContentItemMetadata).[`reelItem`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseContentItemMetadata#reelitem)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:300](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L300)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIRichResponseContentItemMetadata`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseContentItemMetadata)

Defined in: [WAProto/index.d.ts:295](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L295)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIRichResponseContentItemMetadata`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseContentItemMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIRichResponseContentItemMetadata`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseContentItemMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIRichResponseContentItemMetadata`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseContentItemMetadata)

Defined in: [WAProto/index.d.ts:297](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L297)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIRichResponseContentItemMetadata`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseContentItemMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:296](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L296)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIRichResponseContentItemMetadata`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseContentItemMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIRichResponseContentItemMetadata`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseContentItemMetadata)

Defined in: [WAProto/index.d.ts:298](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L298)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIRichResponseContentItemMetadata`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseContentItemMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:301](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L301)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:299](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L299)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIRichResponseContentItemMetadata`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseContentItemMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-airichresponsereelitem"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseReelItem](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseReelItem)

Defined in: [WAProto/index.d.ts:311](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L311)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIRichResponseReelItem`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseReelItem)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIRichResponseReelItem()[​](#new-airichresponsereelitem "Direct link to new AIRichResponseReelItem()")

> **new AIRichResponseReelItem**(`p`?): [`AIRichResponseReelItem`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseReelItem)

Defined in: [WAProto/index.d.ts:312](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L312)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIRichResponseReelItem`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseReelItem)

#### Returns[​](#returns "Direct link to Returns")

[`AIRichResponseReelItem`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseReelItem)

## Properties[​](#properties "Direct link to Properties")

### profileIconUrl?[​](#profileiconurl "Direct link to profileIconUrl?")

> `optional` **profileIconUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:314](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L314)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIRichResponseReelItem`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseReelItem).[`profileIconUrl`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseReelItem#profileiconurl)

* * *

### thumbnailUrl?[​](#thumbnailurl "Direct link to thumbnailUrl?")

> `optional` **thumbnailUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:315](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L315)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIRichResponseReelItem`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseReelItem).[`thumbnailUrl`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseReelItem#thumbnailurl)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:313](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L313)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAIRichResponseReelItem`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseReelItem).[`title`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseReelItem#title)

* * *

### videoUrl?[​](#videourl "Direct link to videoUrl?")

> `optional` **videoUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:316](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L316)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IAIRichResponseReelItem`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseReelItem).[`videoUrl`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseReelItem#videourl)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:322](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L322)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIRichResponseReelItem`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseReelItem)

Defined in: [WAProto/index.d.ts:317](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L317)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIRichResponseReelItem`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseReelItem)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIRichResponseReelItem`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseReelItem)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIRichResponseReelItem`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseReelItem)

Defined in: [WAProto/index.d.ts:319](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L319)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIRichResponseReelItem`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseReelItem)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:318](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L318)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIRichResponseReelItem`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseReelItem)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIRichResponseReelItem`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseReelItem)

Defined in: [WAProto/index.d.ts:320](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L320)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIRichResponseReelItem`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseReelItem)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:323](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L323)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:321](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L321)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIRichResponseReelItem`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/classes/AIRichResponseReelItem)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-contenttype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/enumerations/ContentType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/enumerations/ContentType)

Defined in: [WAProto/index.d.ts:326](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L326)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### CAROUSEL[​](#carousel "Direct link to CAROUSEL")

> **CAROUSEL**: `1`

Defined in: [WAProto/index.d.ts:328](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L328)

* * *

### DEFAULT[​](#default "Direct link to DEFAULT")

> **DEFAULT**: `0`

Defined in: [WAProto/index.d.ts:327](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L327)

---

<a name="interface-iairichresponsecontentitemmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseContentItemMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseContentItemMetadata)

Defined in: [WAProto/index.d.ts:287](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L287)

## Properties[​](#properties "Direct link to Properties")

### reelItem?[​](#reelitem "Direct link to reelItem?")

> `optional` **reelItem**: `null` | [`IAIRichResponseReelItem`](/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseReelItem)

Defined in: [WAProto/index.d.ts:288](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L288)

---

<a name="interface-iairichresponsereelitem"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseReelItem](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseContentItemsMetadata/interfaces/IAIRichResponseReelItem)

Defined in: [WAProto/index.d.ts:304](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L304)

## Properties[​](#properties "Direct link to Properties")

### profileIconUrl?[​](#profileiconurl "Direct link to profileIconUrl?")

> `optional` **profileIconUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:306](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L306)

* * *

### thumbnailUrl?[​](#thumbnailurl "Direct link to thumbnailUrl?")

> `optional` **thumbnailUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:307](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L307)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:305](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L305)

* * *

### videoUrl?[​](#videourl "Direct link to videoUrl?")

> `optional` **videoUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:308](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L308)

---

<a name="airichresponsedynamicmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseDynamicMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseDynamicMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [AIRichResponseDynamicMetadataType](/docs/api/namespaces/proto/namespaces/AIRichResponseDynamicMetadata/enumerations/AIRichResponseDynamicMetadataType)

---

<a name="enumeration-airichresponsedynamicmetadatatype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseDynamicMetadata/enumerations/AIRichResponseDynamicMetadataType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseDynamicMetadata/enumerations/AIRichResponseDynamicMetadataType)

Defined in: [WAProto/index.d.ts:356](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L356)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AI\_RICH\_RESPONSE\_DYNAMIC\_METADATA\_TYPE\_GIF[​](#ai_rich_response_dynamic_metadata_type_gif "Direct link to AI_RICH_RESPONSE_DYNAMIC_METADATA_TYPE_GIF")

> **AI\_RICH\_RESPONSE\_DYNAMIC\_METADATA\_TYPE\_GIF**: `2`

Defined in: [WAProto/index.d.ts:359](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L359)

* * *

### AI\_RICH\_RESPONSE\_DYNAMIC\_METADATA\_TYPE\_IMAGE[​](#ai_rich_response_dynamic_metadata_type_image "Direct link to AI_RICH_RESPONSE_DYNAMIC_METADATA_TYPE_IMAGE")

> **AI\_RICH\_RESPONSE\_DYNAMIC\_METADATA\_TYPE\_IMAGE**: `1`

Defined in: [WAProto/index.d.ts:358](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L358)

* * *

### AI\_RICH\_RESPONSE\_DYNAMIC\_METADATA\_TYPE\_UNKNOWN[​](#ai_rich_response_dynamic_metadata_type_unknown "Direct link to AI_RICH_RESPONSE_DYNAMIC_METADATA_TYPE_UNKNOWN")

> **AI\_RICH\_RESPONSE\_DYNAMIC\_METADATA\_TYPE\_UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:357](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L357)

---

<a name="airichresponseinlineimagemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseInlineImageMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseInlineImageMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [AIRichResponseImageAlignment](/docs/api/namespaces/proto/namespaces/AIRichResponseInlineImageMetadata/enumerations/AIRichResponseImageAlignment)

---

<a name="enumeration-airichresponseimagealignment"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseInlineImageMetadata/enumerations/AIRichResponseImageAlignment](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseInlineImageMetadata/enumerations/AIRichResponseImageAlignment)

Defined in: [WAProto/index.d.ts:425](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L425)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AI\_RICH\_RESPONSE\_IMAGE\_LAYOUT\_CENTER\_ALIGNED[​](#ai_rich_response_image_layout_center_aligned "Direct link to AI_RICH_RESPONSE_IMAGE_LAYOUT_CENTER_ALIGNED")

> **AI\_RICH\_RESPONSE\_IMAGE\_LAYOUT\_CENTER\_ALIGNED**: `2`

Defined in: [WAProto/index.d.ts:428](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L428)

* * *

### AI\_RICH\_RESPONSE\_IMAGE\_LAYOUT\_LEADING\_ALIGNED[​](#ai_rich_response_image_layout_leading_aligned "Direct link to AI_RICH_RESPONSE_IMAGE_LAYOUT_LEADING_ALIGNED")

> **AI\_RICH\_RESPONSE\_IMAGE\_LAYOUT\_LEADING\_ALIGNED**: `0`

Defined in: [WAProto/index.d.ts:426](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L426)

* * *

### AI\_RICH\_RESPONSE\_IMAGE\_LAYOUT\_TRAILING\_ALIGNED[​](#ai_rich_response_image_layout_trailing_aligned "Direct link to AI_RICH_RESPONSE_IMAGE_LAYOUT_TRAILING_ALIGNED")

> **AI\_RICH\_RESPONSE\_IMAGE\_LAYOUT\_TRAILING\_ALIGNED**: `1`

Defined in: [WAProto/index.d.ts:427](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L427)

---

<a name="airichresponselatexmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/)

## Classes[​](#classes "Direct link to Classes")

*   [AIRichResponseLatexExpression](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/classes/AIRichResponseLatexExpression)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IAIRichResponseLatexExpression](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression)

---

<a name="class-airichresponselatexexpression"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/classes/AIRichResponseLatexExpression](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/classes/AIRichResponseLatexExpression)

Defined in: [WAProto/index.d.ts:464](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L464)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIRichResponseLatexExpression()[​](#new-airichresponselatexexpression "Direct link to new AIRichResponseLatexExpression()")

> **new AIRichResponseLatexExpression**(`p`?): [`AIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/classes/AIRichResponseLatexExpression)

Defined in: [WAProto/index.d.ts:465](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L465)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression)

#### Returns[​](#returns "Direct link to Returns")

[`AIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/classes/AIRichResponseLatexExpression)

## Properties[​](#properties "Direct link to Properties")

### fontHeight?[​](#fontheight "Direct link to fontHeight?")

> `optional` **fontHeight**: `null` | `number`

Defined in: [WAProto/index.d.ts:470](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L470)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression).[`fontHeight`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression#fontheight)

* * *

### height?[​](#height "Direct link to height?")

> `optional` **height**: `null` | `number`

Defined in: [WAProto/index.d.ts:469](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L469)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression).[`height`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression#height)

* * *

### imageBottomPadding?[​](#imagebottompadding "Direct link to imageBottomPadding?")

> `optional` **imageBottomPadding**: `null` | `number`

Defined in: [WAProto/index.d.ts:473](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L473)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression).[`imageBottomPadding`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression#imagebottompadding)

* * *

### imageLeadingPadding?[​](#imageleadingpadding "Direct link to imageLeadingPadding?")

> `optional` **imageLeadingPadding**: `null` | `number`

Defined in: [WAProto/index.d.ts:472](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L472)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IAIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression).[`imageLeadingPadding`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression#imageleadingpadding)

* * *

### imageTopPadding?[​](#imagetoppadding "Direct link to imageTopPadding?")

> `optional` **imageTopPadding**: `null` | `number`

Defined in: [WAProto/index.d.ts:471](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L471)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IAIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression).[`imageTopPadding`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression#imagetoppadding)

* * *

### imageTrailingPadding?[​](#imagetrailingpadding "Direct link to imageTrailingPadding?")

> `optional` **imageTrailingPadding**: `null` | `number`

Defined in: [WAProto/index.d.ts:474](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L474)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IAIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression).[`imageTrailingPadding`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression#imagetrailingpadding)

* * *

### latexExpression?[​](#latexexpression "Direct link to latexExpression?")

> `optional` **latexExpression**: `null` | `string`

Defined in: [WAProto/index.d.ts:466](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L466)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IAIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression).[`latexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression#latexexpression)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:467](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L467)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IAIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression).[`url`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression#url)

* * *

### width?[​](#width "Direct link to width?")

> `optional` **width**: `null` | `number`

Defined in: [WAProto/index.d.ts:468](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L468)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IAIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression).[`width`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression#width)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:480](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L480)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/classes/AIRichResponseLatexExpression)

Defined in: [WAProto/index.d.ts:475](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L475)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/classes/AIRichResponseLatexExpression)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/classes/AIRichResponseLatexExpression)

Defined in: [WAProto/index.d.ts:477](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L477)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/classes/AIRichResponseLatexExpression)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:476](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L476)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/classes/AIRichResponseLatexExpression)

Defined in: [WAProto/index.d.ts:478](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L478)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/classes/AIRichResponseLatexExpression)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:481](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L481)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:479](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L479)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIRichResponseLatexExpression`](/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/classes/AIRichResponseLatexExpression)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-iairichresponselatexexpression"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseLatexMetadata/interfaces/IAIRichResponseLatexExpression)

Defined in: [WAProto/index.d.ts:452](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L452)

## Properties[​](#properties "Direct link to Properties")

### fontHeight?[​](#fontheight "Direct link to fontHeight?")

> `optional` **fontHeight**: `null` | `number`

Defined in: [WAProto/index.d.ts:457](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L457)

* * *

### height?[​](#height "Direct link to height?")

> `optional` **height**: `null` | `number`

Defined in: [WAProto/index.d.ts:456](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L456)

* * *

### imageBottomPadding?[​](#imagebottompadding "Direct link to imageBottomPadding?")

> `optional` **imageBottomPadding**: `null` | `number`

Defined in: [WAProto/index.d.ts:460](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L460)

* * *

### imageLeadingPadding?[​](#imageleadingpadding "Direct link to imageLeadingPadding?")

> `optional` **imageLeadingPadding**: `null` | `number`

Defined in: [WAProto/index.d.ts:459](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L459)

* * *

### imageTopPadding?[​](#imagetoppadding "Direct link to imageTopPadding?")

> `optional` **imageTopPadding**: `null` | `number`

Defined in: [WAProto/index.d.ts:458](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L458)

* * *

### imageTrailingPadding?[​](#imagetrailingpadding "Direct link to imageTrailingPadding?")

> `optional` **imageTrailingPadding**: `null` | `number`

Defined in: [WAProto/index.d.ts:461](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L461)

* * *

### latexExpression?[​](#latexexpression "Direct link to latexExpression?")

> `optional` **latexExpression**: `null` | `string`

Defined in: [WAProto/index.d.ts:453](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L453)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:454](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L454)

* * *

### width?[​](#width "Direct link to width?")

> `optional` **width**: `null` | `number`

Defined in: [WAProto/index.d.ts:455](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L455)

---

<a name="airichresponsemapmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/)

## Classes[​](#classes "Direct link to Classes")

*   [AIRichResponseMapAnnotation](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/classes/AIRichResponseMapAnnotation)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IAIRichResponseMapAnnotation](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/interfaces/IAIRichResponseMapAnnotation)

---

<a name="class-airichresponsemapannotation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/classes/AIRichResponseMapAnnotation](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/classes/AIRichResponseMapAnnotation)

Defined in: [WAProto/index.d.ts:521](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L521)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIRichResponseMapAnnotation`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/interfaces/IAIRichResponseMapAnnotation)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIRichResponseMapAnnotation()[​](#new-airichresponsemapannotation "Direct link to new AIRichResponseMapAnnotation()")

> **new AIRichResponseMapAnnotation**(`p`?): [`AIRichResponseMapAnnotation`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/classes/AIRichResponseMapAnnotation)

Defined in: [WAProto/index.d.ts:522](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L522)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIRichResponseMapAnnotation`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/interfaces/IAIRichResponseMapAnnotation)

#### Returns[​](#returns "Direct link to Returns")

[`AIRichResponseMapAnnotation`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/classes/AIRichResponseMapAnnotation)

## Properties[​](#properties "Direct link to Properties")

### annotationNumber?[​](#annotationnumber "Direct link to annotationNumber?")

> `optional` **annotationNumber**: `null` | `number`

Defined in: [WAProto/index.d.ts:523](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L523)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIRichResponseMapAnnotation`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/interfaces/IAIRichResponseMapAnnotation).[`annotationNumber`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/interfaces/IAIRichResponseMapAnnotation#annotationnumber)

* * *

### body?[​](#body "Direct link to body?")

> `optional` **body**: `null` | `string`

Defined in: [WAProto/index.d.ts:527](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L527)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIRichResponseMapAnnotation`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/interfaces/IAIRichResponseMapAnnotation).[`body`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/interfaces/IAIRichResponseMapAnnotation#body)

* * *

### latitude?[​](#latitude "Direct link to latitude?")

> `optional` **latitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:524](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L524)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAIRichResponseMapAnnotation`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/interfaces/IAIRichResponseMapAnnotation).[`latitude`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/interfaces/IAIRichResponseMapAnnotation#latitude)

* * *

### longitude?[​](#longitude "Direct link to longitude?")

> `optional` **longitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:525](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L525)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IAIRichResponseMapAnnotation`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/interfaces/IAIRichResponseMapAnnotation).[`longitude`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/interfaces/IAIRichResponseMapAnnotation#longitude)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:526](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L526)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IAIRichResponseMapAnnotation`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/interfaces/IAIRichResponseMapAnnotation).[`title`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/interfaces/IAIRichResponseMapAnnotation#title)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:533](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L533)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIRichResponseMapAnnotation`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/classes/AIRichResponseMapAnnotation)

Defined in: [WAProto/index.d.ts:528](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L528)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIRichResponseMapAnnotation`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/interfaces/IAIRichResponseMapAnnotation)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIRichResponseMapAnnotation`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/classes/AIRichResponseMapAnnotation)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIRichResponseMapAnnotation`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/classes/AIRichResponseMapAnnotation)

Defined in: [WAProto/index.d.ts:530](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L530)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIRichResponseMapAnnotation`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/classes/AIRichResponseMapAnnotation)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:529](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L529)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIRichResponseMapAnnotation`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/interfaces/IAIRichResponseMapAnnotation)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIRichResponseMapAnnotation`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/classes/AIRichResponseMapAnnotation)

Defined in: [WAProto/index.d.ts:531](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L531)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIRichResponseMapAnnotation`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/classes/AIRichResponseMapAnnotation)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:534](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L534)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:532](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L532)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIRichResponseMapAnnotation`](/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/classes/AIRichResponseMapAnnotation)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-iairichresponsemapannotation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/interfaces/IAIRichResponseMapAnnotation](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseMapMetadata/interfaces/IAIRichResponseMapAnnotation)

Defined in: [WAProto/index.d.ts:513](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L513)

## Properties[​](#properties "Direct link to Properties")

### annotationNumber?[​](#annotationnumber "Direct link to annotationNumber?")

> `optional` **annotationNumber**: `null` | `number`

Defined in: [WAProto/index.d.ts:514](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L514)

* * *

### body?[​](#body "Direct link to body?")

> `optional` **body**: `null` | `string`

Defined in: [WAProto/index.d.ts:518](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L518)

* * *

### latitude?[​](#latitude "Direct link to latitude?")

> `optional` **latitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:515](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L515)

* * *

### longitude?[​](#longitude "Direct link to longitude?")

> `optional` **longitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:516](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L516)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:517](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L517)

---

<a name="airichresponsetablemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/)

## Classes[​](#classes "Direct link to Classes")

*   [AIRichResponseTableRow](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/classes/AIRichResponseTableRow)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IAIRichResponseTableRow](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/interfaces/IAIRichResponseTableRow)

---

<a name="class-airichresponsetablerow"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/classes/AIRichResponseTableRow](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/classes/AIRichResponseTableRow)

Defined in: [WAProto/index.d.ts:637](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L637)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIRichResponseTableRow`](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/interfaces/IAIRichResponseTableRow)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIRichResponseTableRow()[​](#new-airichresponsetablerow "Direct link to new AIRichResponseTableRow()")

> **new AIRichResponseTableRow**(`p`?): [`AIRichResponseTableRow`](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/classes/AIRichResponseTableRow)

Defined in: [WAProto/index.d.ts:638](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L638)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIRichResponseTableRow`](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/interfaces/IAIRichResponseTableRow)

#### Returns[​](#returns "Direct link to Returns")

[`AIRichResponseTableRow`](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/classes/AIRichResponseTableRow)

## Properties[​](#properties "Direct link to Properties")

### isHeading?[​](#isheading "Direct link to isHeading?")

> `optional` **isHeading**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:640](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L640)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIRichResponseTableRow`](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/interfaces/IAIRichResponseTableRow).[`isHeading`](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/interfaces/IAIRichResponseTableRow#isheading)

* * *

### items[​](#items "Direct link to items")

> **items**: `string`\[\]

Defined in: [WAProto/index.d.ts:639](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L639)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAIRichResponseTableRow`](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/interfaces/IAIRichResponseTableRow).[`items`](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/interfaces/IAIRichResponseTableRow#items)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:646](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L646)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIRichResponseTableRow`](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/classes/AIRichResponseTableRow)

Defined in: [WAProto/index.d.ts:641](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L641)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIRichResponseTableRow`](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/interfaces/IAIRichResponseTableRow)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIRichResponseTableRow`](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/classes/AIRichResponseTableRow)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIRichResponseTableRow`](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/classes/AIRichResponseTableRow)

Defined in: [WAProto/index.d.ts:643](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L643)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIRichResponseTableRow`](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/classes/AIRichResponseTableRow)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:642](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L642)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIRichResponseTableRow`](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/interfaces/IAIRichResponseTableRow)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIRichResponseTableRow`](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/classes/AIRichResponseTableRow)

Defined in: [WAProto/index.d.ts:644](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L644)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIRichResponseTableRow`](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/classes/AIRichResponseTableRow)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:647](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L647)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:645](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L645)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIRichResponseTableRow`](/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/classes/AIRichResponseTableRow)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-iairichresponsetablerow"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/interfaces/IAIRichResponseTableRow](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIRichResponseTableMetadata/interfaces/IAIRichResponseTableRow)

Defined in: [WAProto/index.d.ts:632](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L632)

## Properties[​](#properties "Direct link to Properties")

### isHeading?[​](#isheading "Direct link to isHeading?")

> `optional` **isHeading**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:634](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L634)

* * *

### items?[​](#items "Direct link to items?")

> `optional` **items**: `null` | `string`\[\]

Defined in: [WAProto/index.d.ts:633](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L633)

---

<a name="aithreadinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIThreadInfo/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIThreadInfo/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [AIThreadClientInfo](/docs/api/namespaces/proto/namespaces/AIThreadInfo/namespaces/AIThreadClientInfo/)

## Classes[​](#classes "Direct link to Classes")

*   [AIThreadClientInfo](/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadClientInfo)
*   [AIThreadServerInfo](/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadServerInfo)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IAIThreadClientInfo](/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadClientInfo)
*   [IAIThreadServerInfo](/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadServerInfo)

---

<a name="class-aithreadclientinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadClientInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadClientInfo)

Defined in: [WAProto/index.d.ts:691](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L691)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIThreadClientInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadClientInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIThreadClientInfo()[​](#new-aithreadclientinfo "Direct link to new AIThreadClientInfo()")

> **new AIThreadClientInfo**(`p`?): [`AIThreadClientInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadClientInfo)

Defined in: [WAProto/index.d.ts:692](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L692)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIThreadClientInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadClientInfo)

#### Returns[​](#returns "Direct link to Returns")

[`AIThreadClientInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadClientInfo)

## Properties[​](#properties "Direct link to Properties")

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`AIThreadType`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/namespaces/AIThreadClientInfo/enumerations/AIThreadType)

Defined in: [WAProto/index.d.ts:693](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L693)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIThreadClientInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadClientInfo).[`type`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadClientInfo#type)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:699](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L699)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIThreadClientInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadClientInfo)

Defined in: [WAProto/index.d.ts:694](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L694)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIThreadClientInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadClientInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIThreadClientInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadClientInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIThreadClientInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadClientInfo)

Defined in: [WAProto/index.d.ts:696](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L696)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIThreadClientInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadClientInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:695](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L695)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIThreadClientInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadClientInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIThreadClientInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadClientInfo)

Defined in: [WAProto/index.d.ts:697](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L697)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIThreadClientInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadClientInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:700](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L700)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:698](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L698)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIThreadClientInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadClientInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-aithreadserverinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadServerInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadServerInfo)

Defined in: [WAProto/index.d.ts:716](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L716)

## Implements[​](#implements "Direct link to Implements")

*   [`IAIThreadServerInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadServerInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new AIThreadServerInfo()[​](#new-aithreadserverinfo "Direct link to new AIThreadServerInfo()")

> **new AIThreadServerInfo**(`p`?): [`AIThreadServerInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadServerInfo)

Defined in: [WAProto/index.d.ts:717](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L717)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAIThreadServerInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadServerInfo)

#### Returns[​](#returns "Direct link to Returns")

[`AIThreadServerInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadServerInfo)

## Properties[​](#properties "Direct link to Properties")

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:718](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L718)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAIThreadServerInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadServerInfo).[`title`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadServerInfo#title)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:724](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L724)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AIThreadServerInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadServerInfo)

Defined in: [WAProto/index.d.ts:719](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L719)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAIThreadServerInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadServerInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AIThreadServerInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadServerInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AIThreadServerInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadServerInfo)

Defined in: [WAProto/index.d.ts:721](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L721)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AIThreadServerInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadServerInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:720](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L720)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAIThreadServerInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadServerInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AIThreadServerInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadServerInfo)

Defined in: [WAProto/index.d.ts:722](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L722)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AIThreadServerInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadServerInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:725](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L725)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:723](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L723)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AIThreadServerInfo`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/classes/AIThreadServerInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-iaithreadclientinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadClientInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadClientInfo)

Defined in: [WAProto/index.d.ts:687](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L687)

## Properties[​](#properties "Direct link to Properties")

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`AIThreadType`](/docs/api/namespaces/proto/namespaces/AIThreadInfo/namespaces/AIThreadClientInfo/enumerations/AIThreadType)

Defined in: [WAProto/index.d.ts:688](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L688)

---

<a name="interface-iaithreadserverinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadServerInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIThreadInfo/interfaces/IAIThreadServerInfo)

Defined in: [WAProto/index.d.ts:712](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L712)

## Properties[​](#properties "Direct link to Properties")

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:713](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L713)

---

<a name="aithreadclientinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIThreadInfo/namespaces/AIThreadClientInfo/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIThreadInfo/namespaces/AIThreadClientInfo/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [AIThreadType](/docs/api/namespaces/proto/namespaces/AIThreadInfo/namespaces/AIThreadClientInfo/enumerations/AIThreadType)

---

<a name="enumeration-aithreadtype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIThreadInfo/namespaces/AIThreadClientInfo/enumerations/AIThreadType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/AIThreadInfo/namespaces/AIThreadClientInfo/enumerations/AIThreadType)

Defined in: [WAProto/index.d.ts:705](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L705)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### DEFAULT[​](#default "Direct link to DEFAULT")

> **DEFAULT**: `1`

Defined in: [WAProto/index.d.ts:707](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L707)

* * *

### INCOGNITO[​](#incognito "Direct link to INCOGNITO")

> **INCOGNITO**: `2`

Defined in: [WAProto/index.d.ts:708](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L708)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:706](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L706)

---

<a name="bizaccountlinkinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BizAccountLinkInfo/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BizAccountLinkInfo/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [AccountType](/docs/api/namespaces/proto/namespaces/BizAccountLinkInfo/enumerations/AccountType)
*   [HostStorageType](/docs/api/namespaces/proto/namespaces/BizAccountLinkInfo/enumerations/HostStorageType)

---

<a name="enumeration-accounttype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BizAccountLinkInfo/enumerations/AccountType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BizAccountLinkInfo/enumerations/AccountType)

Defined in: [WAProto/index.d.ts:835](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L835)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### ENTERPRISE[​](#enterprise "Direct link to ENTERPRISE")

> **ENTERPRISE**: `0`

Defined in: [WAProto/index.d.ts:836](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L836)

---

<a name="enumeration-hoststoragetype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BizAccountLinkInfo/enumerations/HostStorageType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BizAccountLinkInfo/enumerations/HostStorageType)

Defined in: [WAProto/index.d.ts:839](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L839)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### FACEBOOK[​](#facebook "Direct link to FACEBOOK")

> **FACEBOOK**: `1`

Defined in: [WAProto/index.d.ts:841](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L841)

* * *

### ON\_PREMISE[​](#on_premise "Direct link to ON_PREMISE")

> **ON\_PREMISE**: `0`

Defined in: [WAProto/index.d.ts:840](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L840)

---

<a name="bizidentityinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BizIdentityInfo/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BizIdentityInfo/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [ActualActorsType](/docs/api/namespaces/proto/namespaces/BizIdentityInfo/enumerations/ActualActorsType)
*   [HostStorageType](/docs/api/namespaces/proto/namespaces/BizIdentityInfo/enumerations/HostStorageType)
*   [VerifiedLevelValue](/docs/api/namespaces/proto/namespaces/BizIdentityInfo/enumerations/VerifiedLevelValue)

---

<a name="enumeration-actualactorstype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BizIdentityInfo/enumerations/ActualActorsType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BizIdentityInfo/enumerations/ActualActorsType)

Defined in: [WAProto/index.d.ts:895](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L895)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### BSP[​](#bsp "Direct link to BSP")

> **BSP**: `1`

Defined in: [WAProto/index.d.ts:897](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L897)

* * *

### SELF[​](#self "Direct link to SELF")

> **SELF**: `0`

Defined in: [WAProto/index.d.ts:896](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L896)

---

<a name="enumeration-hoststoragetype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BizIdentityInfo/enumerations/HostStorageType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BizIdentityInfo/enumerations/HostStorageType)

Defined in: [WAProto/index.d.ts:900](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L900)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### FACEBOOK[​](#facebook "Direct link to FACEBOOK")

> **FACEBOOK**: `1`

Defined in: [WAProto/index.d.ts:902](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L902)

* * *

### ON\_PREMISE[​](#on_premise "Direct link to ON_PREMISE")

> **ON\_PREMISE**: `0`

Defined in: [WAProto/index.d.ts:901](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L901)

---

<a name="enumeration-verifiedlevelvalue"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BizIdentityInfo/enumerations/VerifiedLevelValue](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BizIdentityInfo/enumerations/VerifiedLevelValue)

Defined in: [WAProto/index.d.ts:905](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L905)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### HIGH[​](#high "Direct link to HIGH")

> **HIGH**: `2`

Defined in: [WAProto/index.d.ts:908](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L908)

* * *

### LOW[​](#low "Direct link to LOW")

> **LOW**: `1`

Defined in: [WAProto/index.d.ts:907](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L907)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:906](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L906)

---

<a name="botagecollectionmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotAgeCollectionMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotAgeCollectionMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [AgeCollectionType](/docs/api/namespaces/proto/namespaces/BotAgeCollectionMetadata/enumerations/AgeCollectionType)

---

<a name="enumeration-agecollectiontype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotAgeCollectionMetadata/enumerations/AgeCollectionType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotAgeCollectionMetadata/enumerations/AgeCollectionType)

Defined in: [WAProto/index.d.ts:934](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L934)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### O18\_BINARY[​](#o18_binary "Direct link to O18_BINARY")

> **O18\_BINARY**: `0`

Defined in: [WAProto/index.d.ts:935](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L935)

* * *

### WAFFLE[​](#waffle "Direct link to WAFFLE")

> **WAFFLE**: `1`

Defined in: [WAProto/index.d.ts:936](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L936)

---

<a name="botcapabilitymetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotCapabilityMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotCapabilityMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [BotCapabilityType](/docs/api/namespaces/proto/namespaces/BotCapabilityMetadata/enumerations/BotCapabilityType)

---

<a name="enumeration-botcapabilitytype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotCapabilityMetadata/enumerations/BotCapabilityType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotCapabilityMetadata/enumerations/BotCapabilityType)

Defined in: [WAProto/index.d.ts:982](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L982)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### ACCOUNT\_LINKING[​](#account_linking "Direct link to ACCOUNT_LINKING")

> **ACCOUNT\_LINKING**: `28`

Defined in: [WAProto/index.d.ts:1011](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1011)

* * *

### AGENTIC\_PLANNING[​](#agentic_planning "Direct link to AGENTIC_PLANNING")

> **AGENTIC\_PLANNING**: `27`

Defined in: [WAProto/index.d.ts:1010](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1010)

* * *

### AI\_MEMORY[​](#ai_memory "Direct link to AI_MEMORY")

> **AI\_MEMORY**: `4`

Defined in: [WAProto/index.d.ts:987](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L987)

* * *

### AI\_RESPONSE\_MODEL\_BRANDING[​](#ai_response_model_branding "Direct link to AI_RESPONSE_MODEL_BRANDING")

> **AI\_RESPONSE\_MODEL\_BRANDING**: `47`

Defined in: [WAProto/index.d.ts:1030](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1030)

* * *

### AI\_SHARED\_MEMORY[​](#ai_shared_memory "Direct link to AI_SHARED_MEMORY")

> **AI\_SHARED\_MEMORY**: `40`

Defined in: [WAProto/index.d.ts:1023](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1023)

* * *

### AI\_STUDIO\_UGC\_MEMORY[​](#ai_studio_ugc_memory "Direct link to AI_STUDIO_UGC_MEMORY")

> **AI\_STUDIO\_UGC\_MEMORY**: `23`

Defined in: [WAProto/index.d.ts:1006](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1006)

* * *

### PROACTIVE\_MESSAGE[​](#proactive_message "Direct link to PROACTIVE_MESSAGE")

> **PROACTIVE\_MESSAGE**: `33`

Defined in: [WAProto/index.d.ts:1016](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1016)

* * *

### PROGRESS\_INDICATOR[​](#progress_indicator "Direct link to PROGRESS_INDICATOR")

> **PROGRESS\_INDICATOR**: `1`

Defined in: [WAProto/index.d.ts:984](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L984)

* * *

### PROMOTION\_MESSAGE[​](#promotion_message "Direct link to PROMOTION_MESSAGE")

> **PROMOTION\_MESSAGE**: `35`

Defined in: [WAProto/index.d.ts:1018](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1018)

* * *

### QUERY\_PLAN[​](#query_plan "Direct link to QUERY_PLAN")

> **QUERY\_PLAN**: `32`

Defined in: [WAProto/index.d.ts:1015](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1015)

* * *

### RICH\_RESPONSE\_CODE[​](#rich_response_code "Direct link to RICH_RESPONSE_CODE")

> **RICH\_RESPONSE\_CODE**: `7`

Defined in: [WAProto/index.d.ts:990](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L990)

* * *

### RICH\_RESPONSE\_GRID\_IMAGE[​](#rich_response_grid_image "Direct link to RICH_RESPONSE_GRID_IMAGE")

> **RICH\_RESPONSE\_GRID\_IMAGE**: `22`

Defined in: [WAProto/index.d.ts:1005](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1005)

* * *

### RICH\_RESPONSE\_GRID\_IMAGE\_3P[​](#rich_response_grid_image_3p "Direct link to RICH_RESPONSE_GRID_IMAGE_3P")

> **RICH\_RESPONSE\_GRID\_IMAGE\_3P**: `30`

Defined in: [WAProto/index.d.ts:1013](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1013)

* * *

### RICH\_RESPONSE\_HEADING[​](#rich_response_heading "Direct link to RICH_RESPONSE_HEADING")

> **RICH\_RESPONSE\_HEADING**: `2`

Defined in: [WAProto/index.d.ts:985](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L985)

* * *

### RICH\_RESPONSE\_IN\_APP\_SURVEY[​](#rich_response_in_app_survey "Direct link to RICH_RESPONSE_IN_APP_SURVEY")

> **RICH\_RESPONSE\_IN\_APP\_SURVEY**: `46`

Defined in: [WAProto/index.d.ts:1029](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1029)

* * *

### RICH\_RESPONSE\_INLINE\_IMAGE[​](#rich_response_inline_image "Direct link to RICH_RESPONSE_INLINE_IMAGE")

> **RICH\_RESPONSE\_INLINE\_IMAGE**: `9`

Defined in: [WAProto/index.d.ts:992](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L992)

* * *

### RICH\_RESPONSE\_INLINE\_REELS[​](#rich_response_inline_reels "Direct link to RICH_RESPONSE_INLINE_REELS")

> **RICH\_RESPONSE\_INLINE\_REELS**: `26`

Defined in: [WAProto/index.d.ts:1009](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1009)

* * *

### RICH\_RESPONSE\_LATEX[​](#rich_response_latex "Direct link to RICH_RESPONSE_LATEX")

> **RICH\_RESPONSE\_LATEX**: `24`

Defined in: [WAProto/index.d.ts:1007](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1007)

* * *

### RICH\_RESPONSE\_LATEX\_INLINE[​](#rich_response_latex_inline "Direct link to RICH_RESPONSE_LATEX_INLINE")

> **RICH\_RESPONSE\_LATEX\_INLINE**: `31`

Defined in: [WAProto/index.d.ts:1014](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1014)

* * *

### RICH\_RESPONSE\_MAPS[​](#rich_response_maps "Direct link to RICH_RESPONSE_MAPS")

> **RICH\_RESPONSE\_MAPS**: `25`

Defined in: [WAProto/index.d.ts:1008](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1008)

* * *

### RICH\_RESPONSE\_NESTED\_LIST[​](#rich_response_nested_list "Direct link to RICH_RESPONSE_NESTED_LIST")

> **RICH\_RESPONSE\_NESTED\_LIST**: `3`

Defined in: [WAProto/index.d.ts:986](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L986)

* * *

### RICH\_RESPONSE\_SIDE\_BY\_SIDE\_SURVEY[​](#rich_response_side_by_side_survey "Direct link to RICH_RESPONSE_SIDE_BY_SIDE_SURVEY")

> **RICH\_RESPONSE\_SIDE\_BY\_SIDE\_SURVEY**: `38`

Defined in: [WAProto/index.d.ts:1021](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1021)

* * *

### RICH\_RESPONSE\_SOURCES\_IN\_MESSAGE[​](#rich_response_sources_in_message "Direct link to RICH_RESPONSE_SOURCES_IN_MESSAGE")

> **RICH\_RESPONSE\_SOURCES\_IN\_MESSAGE**: `37`

Defined in: [WAProto/index.d.ts:1020](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1020)

* * *

### RICH\_RESPONSE\_STRUCTURED\_RESPONSE[​](#rich_response_structured_response "Direct link to RICH_RESPONSE_STRUCTURED_RESPONSE")

> **RICH\_RESPONSE\_STRUCTURED\_RESPONSE**: `8`

Defined in: [WAProto/index.d.ts:991](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L991)

* * *

### RICH\_RESPONSE\_SUB\_HEADING[​](#rich_response_sub_heading "Direct link to RICH_RESPONSE_SUB_HEADING")

> **RICH\_RESPONSE\_SUB\_HEADING**: `21`

Defined in: [WAProto/index.d.ts:1004](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1004)

* * *

### RICH\_RESPONSE\_TABLE[​](#rich_response_table "Direct link to RICH_RESPONSE_TABLE")

> **RICH\_RESPONSE\_TABLE**: `6`

Defined in: [WAProto/index.d.ts:989](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L989)

* * *

### RICH\_RESPONSE\_THREAD\_SURFING[​](#rich_response_thread_surfing "Direct link to RICH_RESPONSE_THREAD_SURFING")

> **RICH\_RESPONSE\_THREAD\_SURFING**: `5`

Defined in: [WAProto/index.d.ts:988](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L988)

* * *

### RICH\_RESPONSE\_UNIFIED\_DOMAIN\_CITATIONS[​](#rich_response_unified_domain_citations "Direct link to RICH_RESPONSE_UNIFIED_DOMAIN_CITATIONS")

> **RICH\_RESPONSE\_UNIFIED\_DOMAIN\_CITATIONS**: `42`

Defined in: [WAProto/index.d.ts:1025](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1025)

* * *

### RICH\_RESPONSE\_UNIFIED\_RESPONSE[​](#rich_response_unified_response "Direct link to RICH_RESPONSE_UNIFIED_RESPONSE")

> **RICH\_RESPONSE\_UNIFIED\_RESPONSE**: `34`

Defined in: [WAProto/index.d.ts:1017](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1017)

* * *

### RICH\_RESPONSE\_UNIFIED\_SOURCES[​](#rich_response_unified_sources "Direct link to RICH_RESPONSE_UNIFIED_SOURCES")

> **RICH\_RESPONSE\_UNIFIED\_SOURCES**: `41`

Defined in: [WAProto/index.d.ts:1024](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1024)

* * *

### RICH\_RESPONSE\_UNIFIED\_TEXT\_COMPONENT[​](#rich_response_unified_text_component "Direct link to RICH_RESPONSE_UNIFIED_TEXT_COMPONENT")

> **RICH\_RESPONSE\_UNIFIED\_TEXT\_COMPONENT**: `39`

Defined in: [WAProto/index.d.ts:1022](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1022)

* * *

### RICH\_RESPONSE\_UR\_INLINE\_REELS\_ENABLED[​](#rich_response_ur_inline_reels_enabled "Direct link to RICH_RESPONSE_UR_INLINE_REELS_ENABLED")

> **RICH\_RESPONSE\_UR\_INLINE\_REELS\_ENABLED**: `43`

Defined in: [WAProto/index.d.ts:1026](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1026)

* * *

### RICH\_RESPONSE\_UR\_MEDIA\_GRID\_ENABLED[​](#rich_response_ur_media_grid_enabled "Direct link to RICH_RESPONSE_UR_MEDIA_GRID_ENABLED")

> **RICH\_RESPONSE\_UR\_MEDIA\_GRID\_ENABLED**: `44`

Defined in: [WAProto/index.d.ts:1027](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1027)

* * *

### RICH\_RESPONSE\_UR\_REASONING[​](#rich_response_ur_reasoning "Direct link to RICH_RESPONSE_UR_REASONING")

> **RICH\_RESPONSE\_UR\_REASONING**: `49`

Defined in: [WAProto/index.d.ts:1032](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1032)

* * *

### RICH\_RESPONSE\_UR\_TIMESTAMP\_PLACEHOLDER[​](#rich_response_ur_timestamp_placeholder "Direct link to RICH_RESPONSE_UR_TIMESTAMP_PLACEHOLDER")

> **RICH\_RESPONSE\_UR\_TIMESTAMP\_PLACEHOLDER**: `45`

Defined in: [WAProto/index.d.ts:1028](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1028)

* * *

### SESSION\_TRANSPARENCY\_SYSTEM\_MESSAGE[​](#session_transparency_system_message "Direct link to SESSION_TRANSPARENCY_SYSTEM_MESSAGE")

> **SESSION\_TRANSPARENCY\_SYSTEM\_MESSAGE**: `48`

Defined in: [WAProto/index.d.ts:1031](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1031)

* * *

### SIMPLIFIED\_PROFILE\_PAGE[​](#simplified_profile_page "Direct link to SIMPLIFIED_PROFILE_PAGE")

> **SIMPLIFIED\_PROFILE\_PAGE**: `36`

Defined in: [WAProto/index.d.ts:1019](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1019)

* * *

### STREAMING\_DISAGGREGATION[​](#streaming_disaggregation "Direct link to STREAMING_DISAGGREGATION")

> **STREAMING\_DISAGGREGATION**: `29`

Defined in: [WAProto/index.d.ts:1012](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1012)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:983](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L983)

* * *

### WA\_IG\_1P\_PLUGIN\_RANKING\_CONTROL[​](#wa_ig_1p_plugin_ranking_control "Direct link to WA_IG_1P_PLUGIN_RANKING_CONTROL")

> **WA\_IG\_1P\_PLUGIN\_RANKING\_CONTROL**: `10`

Defined in: [WAProto/index.d.ts:993](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L993)

* * *

### WA\_IG\_1P\_PLUGIN\_RANKING\_UPDATE\_1[​](#wa_ig_1p_plugin_ranking_update_1 "Direct link to WA_IG_1P_PLUGIN_RANKING_UPDATE_1")

> **WA\_IG\_1P\_PLUGIN\_RANKING\_UPDATE\_1**: `11`

Defined in: [WAProto/index.d.ts:994](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L994)

* * *

### WA\_IG\_1P\_PLUGIN\_RANKING\_UPDATE\_10[​](#wa_ig_1p_plugin_ranking_update_10 "Direct link to WA_IG_1P_PLUGIN_RANKING_UPDATE_10")

> **WA\_IG\_1P\_PLUGIN\_RANKING\_UPDATE\_10**: `20`

Defined in: [WAProto/index.d.ts:1003](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1003)

* * *

### WA\_IG\_1P\_PLUGIN\_RANKING\_UPDATE\_2[​](#wa_ig_1p_plugin_ranking_update_2 "Direct link to WA_IG_1P_PLUGIN_RANKING_UPDATE_2")

> **WA\_IG\_1P\_PLUGIN\_RANKING\_UPDATE\_2**: `12`

Defined in: [WAProto/index.d.ts:995](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L995)

* * *

### WA\_IG\_1P\_PLUGIN\_RANKING\_UPDATE\_3[​](#wa_ig_1p_plugin_ranking_update_3 "Direct link to WA_IG_1P_PLUGIN_RANKING_UPDATE_3")

> **WA\_IG\_1P\_PLUGIN\_RANKING\_UPDATE\_3**: `13`

Defined in: [WAProto/index.d.ts:996](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L996)

* * *

### WA\_IG\_1P\_PLUGIN\_RANKING\_UPDATE\_4[​](#wa_ig_1p_plugin_ranking_update_4 "Direct link to WA_IG_1P_PLUGIN_RANKING_UPDATE_4")

> **WA\_IG\_1P\_PLUGIN\_RANKING\_UPDATE\_4**: `14`

Defined in: [WAProto/index.d.ts:997](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L997)

* * *

### WA\_IG\_1P\_PLUGIN\_RANKING\_UPDATE\_5[​](#wa_ig_1p_plugin_ranking_update_5 "Direct link to WA_IG_1P_PLUGIN_RANKING_UPDATE_5")

> **WA\_IG\_1P\_PLUGIN\_RANKING\_UPDATE\_5**: `15`

Defined in: [WAProto/index.d.ts:998](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L998)

* * *

### WA\_IG\_1P\_PLUGIN\_RANKING\_UPDATE\_6[​](#wa_ig_1p_plugin_ranking_update_6 "Direct link to WA_IG_1P_PLUGIN_RANKING_UPDATE_6")

> **WA\_IG\_1P\_PLUGIN\_RANKING\_UPDATE\_6**: `16`

Defined in: [WAProto/index.d.ts:999](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L999)

* * *

### WA\_IG\_1P\_PLUGIN\_RANKING\_UPDATE\_7[​](#wa_ig_1p_plugin_ranking_update_7 "Direct link to WA_IG_1P_PLUGIN_RANKING_UPDATE_7")

> **WA\_IG\_1P\_PLUGIN\_RANKING\_UPDATE\_7**: `17`

Defined in: [WAProto/index.d.ts:1000](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1000)

* * *

### WA\_IG\_1P\_PLUGIN\_RANKING\_UPDATE\_8[​](#wa_ig_1p_plugin_ranking_update_8 "Direct link to WA_IG_1P_PLUGIN_RANKING_UPDATE_8")

> **WA\_IG\_1P\_PLUGIN\_RANKING\_UPDATE\_8**: `18`

Defined in: [WAProto/index.d.ts:1001](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1001)

* * *

### WA\_IG\_1P\_PLUGIN\_RANKING\_UPDATE\_9[​](#wa_ig_1p_plugin_ranking_update_9 "Direct link to WA_IG_1P_PLUGIN_RANKING_UPDATE_9")

> **WA\_IG\_1P\_PLUGIN\_RANKING\_UPDATE\_9**: `19`

Defined in: [WAProto/index.d.ts:1002](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1002)

---

<a name="botfeedbackmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [SideBySideSurveyMetadata](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [BotFeedbackKind](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/enumerations/BotFeedbackKind)
*   [BotFeedbackKindMultipleNegative](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/enumerations/BotFeedbackKindMultipleNegative)
*   [BotFeedbackKindMultiplePositive](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/enumerations/BotFeedbackKindMultiplePositive)
*   [ReportKind](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/enumerations/ReportKind)

## Classes[​](#classes "Direct link to Classes")

*   [SideBySideSurveyMetadata](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/classes/SideBySideSurveyMetadata)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [ISideBySideSurveyMetadata](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata)

---

<a name="class-sidebysidesurveymetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/classes/SideBySideSurveyMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/classes/SideBySideSurveyMetadata)

Defined in: [WAProto/index.d.ts:1117](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1117)

## Implements[​](#implements "Direct link to Implements")

*   [`ISideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new SideBySideSurveyMetadata()[​](#new-sidebysidesurveymetadata "Direct link to new SideBySideSurveyMetadata()")

> **new SideBySideSurveyMetadata**(`p`?): [`SideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/classes/SideBySideSurveyMetadata)

Defined in: [WAProto/index.d.ts:1118](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1118)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`SideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/classes/SideBySideSurveyMetadata)

## Properties[​](#properties "Direct link to Properties")

### analyticsData?[​](#analyticsdata "Direct link to analyticsData?")

> `optional` **analyticsData**: `null` | [`ISideBySideSurveyAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISideBySideSurveyAnalyticsData)

Defined in: [WAProto/index.d.ts:1126](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1126)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata).[`analyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata#analyticsdata)

* * *

### isSelectedResponsePrimary?[​](#isselectedresponseprimary "Direct link to isSelectedResponsePrimary?")

> `optional` **isSelectedResponsePrimary**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:1124](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1124)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata).[`isSelectedResponsePrimary`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata#isselectedresponseprimary)

* * *

### messageIdToEdit?[​](#messageidtoedit "Direct link to messageIdToEdit?")

> `optional` **messageIdToEdit**: `null` | `string`

Defined in: [WAProto/index.d.ts:1125](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1125)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ISideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata).[`messageIdToEdit`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata#messageidtoedit)

* * *

### metaAiAnalyticsData?[​](#metaaianalyticsdata "Direct link to metaAiAnalyticsData?")

> `optional` **metaAiAnalyticsData**: `null` | [`ISidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData)

Defined in: [WAProto/index.d.ts:1127](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1127)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ISideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata).[`metaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata#metaaianalyticsdata)

* * *

### responseOtid?[​](#responseotid "Direct link to responseOtid?")

> `optional` **responseOtid**: `null` | `string`

Defined in: [WAProto/index.d.ts:1122](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1122)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ISideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata).[`responseOtid`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata#responseotid)

* * *

### responseTimestampMsString?[​](#responsetimestampmsstring "Direct link to responseTimestampMsString?")

> `optional` **responseTimestampMsString**: `null` | `string`

Defined in: [WAProto/index.d.ts:1123](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1123)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`ISideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata).[`responseTimestampMsString`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata#responsetimestampmsstring)

* * *

### selectedRequestId?[​](#selectedrequestid "Direct link to selectedRequestId?")

> `optional` **selectedRequestId**: `null` | `string`

Defined in: [WAProto/index.d.ts:1119](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1119)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`ISideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata).[`selectedRequestId`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata#selectedrequestid)

* * *

### simonSessionFbid?[​](#simonsessionfbid "Direct link to simonSessionFbid?")

> `optional` **simonSessionFbid**: `null` | `string`

Defined in: [WAProto/index.d.ts:1121](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1121)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`ISideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata).[`simonSessionFbid`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata#simonsessionfbid)

* * *

### surveyId?[​](#surveyid "Direct link to surveyId?")

> `optional` **surveyId**: `null` | `number`

Defined in: [WAProto/index.d.ts:1120](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1120)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`ISideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata).[`surveyId`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata#surveyid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1133](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1133)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/classes/SideBySideSurveyMetadata)

Defined in: [WAProto/index.d.ts:1128](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1128)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/classes/SideBySideSurveyMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/classes/SideBySideSurveyMetadata)

Defined in: [WAProto/index.d.ts:1130](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1130)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/classes/SideBySideSurveyMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1129](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1129)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/classes/SideBySideSurveyMetadata)

Defined in: [WAProto/index.d.ts:1131](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1131)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/classes/SideBySideSurveyMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1134](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1134)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1132](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1132)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SideBySideSurveyMetadata`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/classes/SideBySideSurveyMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-botfeedbackkind"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/enumerations/BotFeedbackKind](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/enumerations/BotFeedbackKind)

Defined in: [WAProto/index.d.ts:1066](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1066)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### BOT\_FEEDBACK\_NEGATIVE[​](#bot_feedback_negative "Direct link to BOT_FEEDBACK_NEGATIVE")

> **BOT\_FEEDBACK\_NEGATIVE**: `14`

Defined in: [WAProto/index.d.ts:1081](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1081)

* * *

### BOT\_FEEDBACK\_NEGATIVE\_ACCURATE[​](#bot_feedback_negative_accurate "Direct link to BOT_FEEDBACK_NEGATIVE_ACCURATE")

> **BOT\_FEEDBACK\_NEGATIVE\_ACCURATE**: `4`

Defined in: [WAProto/index.d.ts:1071](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1071)

* * *

### BOT\_FEEDBACK\_NEGATIVE\_CLARITY[​](#bot_feedback_negative_clarity "Direct link to BOT_FEEDBACK_NEGATIVE_CLARITY")

> **BOT\_FEEDBACK\_NEGATIVE\_CLARITY**: `11`

Defined in: [WAProto/index.d.ts:1078](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1078)

* * *

### BOT\_FEEDBACK\_NEGATIVE\_DOESNT\_LOOK\_LIKE\_THE\_PERSON[​](#bot_feedback_negative_doesnt_look_like_the_person "Direct link to BOT_FEEDBACK_NEGATIVE_DOESNT_LOOK_LIKE_THE_PERSON")

> **BOT\_FEEDBACK\_NEGATIVE\_DOESNT\_LOOK\_LIKE\_THE\_PERSON**: `12`

Defined in: [WAProto/index.d.ts:1079](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1079)

* * *

### BOT\_FEEDBACK\_NEGATIVE\_GENERIC[​](#bot_feedback_negative_generic "Direct link to BOT_FEEDBACK_NEGATIVE_GENERIC")

> **BOT\_FEEDBACK\_NEGATIVE\_GENERIC**: `1`

Defined in: [WAProto/index.d.ts:1068](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1068)

* * *

### BOT\_FEEDBACK\_NEGATIVE\_HALLUCINATION\_INTERNAL\_ONLY[​](#bot_feedback_negative_hallucination_internal_only "Direct link to BOT_FEEDBACK_NEGATIVE_HALLUCINATION_INTERNAL_ONLY")

> **BOT\_FEEDBACK\_NEGATIVE\_HALLUCINATION\_INTERNAL\_ONLY**: `13`

Defined in: [WAProto/index.d.ts:1080](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1080)

* * *

### BOT\_FEEDBACK\_NEGATIVE\_HELPFUL[​](#bot_feedback_negative_helpful "Direct link to BOT_FEEDBACK_NEGATIVE_HELPFUL")

> **BOT\_FEEDBACK\_NEGATIVE\_HELPFUL**: `2`

Defined in: [WAProto/index.d.ts:1069](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1069)

* * *

### BOT\_FEEDBACK\_NEGATIVE\_INTERESTING[​](#bot_feedback_negative_interesting "Direct link to BOT_FEEDBACK_NEGATIVE_INTERESTING")

> **BOT\_FEEDBACK\_NEGATIVE\_INTERESTING**: `3`

Defined in: [WAProto/index.d.ts:1070](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1070)

* * *

### BOT\_FEEDBACK\_NEGATIVE\_NOT\_RELEVANT\_TO\_TEXT[​](#bot_feedback_negative_not_relevant_to_text "Direct link to BOT_FEEDBACK_NEGATIVE_NOT_RELEVANT_TO_TEXT")

> **BOT\_FEEDBACK\_NEGATIVE\_NOT\_RELEVANT\_TO\_TEXT**: `9`

Defined in: [WAProto/index.d.ts:1076](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1076)

* * *

### BOT\_FEEDBACK\_NEGATIVE\_NOT\_VISUALLY\_APPEALING[​](#bot_feedback_negative_not_visually_appealing "Direct link to BOT_FEEDBACK_NEGATIVE_NOT_VISUALLY_APPEALING")

> **BOT\_FEEDBACK\_NEGATIVE\_NOT\_VISUALLY\_APPEALING**: `8`

Defined in: [WAProto/index.d.ts:1075](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1075)

* * *

### BOT\_FEEDBACK\_NEGATIVE\_OTHER[​](#bot_feedback_negative_other "Direct link to BOT_FEEDBACK_NEGATIVE_OTHER")

> **BOT\_FEEDBACK\_NEGATIVE\_OTHER**: `6`

Defined in: [WAProto/index.d.ts:1073](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1073)

* * *

### BOT\_FEEDBACK\_NEGATIVE\_PERSONALIZED[​](#bot_feedback_negative_personalized "Direct link to BOT_FEEDBACK_NEGATIVE_PERSONALIZED")

> **BOT\_FEEDBACK\_NEGATIVE\_PERSONALIZED**: `10`

Defined in: [WAProto/index.d.ts:1077](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1077)

* * *

### BOT\_FEEDBACK\_NEGATIVE\_REFUSED[​](#bot_feedback_negative_refused "Direct link to BOT_FEEDBACK_NEGATIVE_REFUSED")

> **BOT\_FEEDBACK\_NEGATIVE\_REFUSED**: `7`

Defined in: [WAProto/index.d.ts:1074](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1074)

* * *

### BOT\_FEEDBACK\_NEGATIVE\_SAFE[​](#bot_feedback_negative_safe "Direct link to BOT_FEEDBACK_NEGATIVE_SAFE")

> **BOT\_FEEDBACK\_NEGATIVE\_SAFE**: `5`

Defined in: [WAProto/index.d.ts:1072](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1072)

* * *

### BOT\_FEEDBACK\_POSITIVE[​](#bot_feedback_positive "Direct link to BOT_FEEDBACK_POSITIVE")

> **BOT\_FEEDBACK\_POSITIVE**: `0`

Defined in: [WAProto/index.d.ts:1067](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1067)

---

<a name="enumeration-botfeedbackkindmultiplenegative"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/enumerations/BotFeedbackKindMultipleNegative](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/enumerations/BotFeedbackKindMultipleNegative)

Defined in: [WAProto/index.d.ts:1084](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1084)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### BOT\_FEEDBACK\_MULTIPLE\_NEGATIVE\_ACCURATE[​](#bot_feedback_multiple_negative_accurate "Direct link to BOT_FEEDBACK_MULTIPLE_NEGATIVE_ACCURATE")

> **BOT\_FEEDBACK\_MULTIPLE\_NEGATIVE\_ACCURATE**: `8`

Defined in: [WAProto/index.d.ts:1088](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1088)

* * *

### BOT\_FEEDBACK\_MULTIPLE\_NEGATIVE\_GENERIC[​](#bot_feedback_multiple_negative_generic "Direct link to BOT_FEEDBACK_MULTIPLE_NEGATIVE_GENERIC")

> **BOT\_FEEDBACK\_MULTIPLE\_NEGATIVE\_GENERIC**: `1`

Defined in: [WAProto/index.d.ts:1085](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1085)

* * *

### BOT\_FEEDBACK\_MULTIPLE\_NEGATIVE\_HELPFUL[​](#bot_feedback_multiple_negative_helpful "Direct link to BOT_FEEDBACK_MULTIPLE_NEGATIVE_HELPFUL")

> **BOT\_FEEDBACK\_MULTIPLE\_NEGATIVE\_HELPFUL**: `2`

Defined in: [WAProto/index.d.ts:1086](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1086)

* * *

### BOT\_FEEDBACK\_MULTIPLE\_NEGATIVE\_INTERESTING[​](#bot_feedback_multiple_negative_interesting "Direct link to BOT_FEEDBACK_MULTIPLE_NEGATIVE_INTERESTING")

> **BOT\_FEEDBACK\_MULTIPLE\_NEGATIVE\_INTERESTING**: `4`

Defined in: [WAProto/index.d.ts:1087](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1087)

* * *

### BOT\_FEEDBACK\_MULTIPLE\_NEGATIVE\_NOT\_RELEVANT\_TO\_TEXT[​](#bot_feedback_multiple_negative_not_relevant_to_text "Direct link to BOT_FEEDBACK_MULTIPLE_NEGATIVE_NOT_RELEVANT_TO_TEXT")

> **BOT\_FEEDBACK\_MULTIPLE\_NEGATIVE\_NOT\_RELEVANT\_TO\_TEXT**: `256`

Defined in: [WAProto/index.d.ts:1093](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1093)

* * *

### BOT\_FEEDBACK\_MULTIPLE\_NEGATIVE\_NOT\_VISUALLY\_APPEALING[​](#bot_feedback_multiple_negative_not_visually_appealing "Direct link to BOT_FEEDBACK_MULTIPLE_NEGATIVE_NOT_VISUALLY_APPEALING")

> **BOT\_FEEDBACK\_MULTIPLE\_NEGATIVE\_NOT\_VISUALLY\_APPEALING**: `128`

Defined in: [WAProto/index.d.ts:1092](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1092)

* * *

### BOT\_FEEDBACK\_MULTIPLE\_NEGATIVE\_OTHER[​](#bot_feedback_multiple_negative_other "Direct link to BOT_FEEDBACK_MULTIPLE_NEGATIVE_OTHER")

> **BOT\_FEEDBACK\_MULTIPLE\_NEGATIVE\_OTHER**: `32`

Defined in: [WAProto/index.d.ts:1090](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1090)

* * *

### BOT\_FEEDBACK\_MULTIPLE\_NEGATIVE\_REFUSED[​](#bot_feedback_multiple_negative_refused "Direct link to BOT_FEEDBACK_MULTIPLE_NEGATIVE_REFUSED")

> **BOT\_FEEDBACK\_MULTIPLE\_NEGATIVE\_REFUSED**: `64`

Defined in: [WAProto/index.d.ts:1091](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1091)

* * *

### BOT\_FEEDBACK\_MULTIPLE\_NEGATIVE\_SAFE[​](#bot_feedback_multiple_negative_safe "Direct link to BOT_FEEDBACK_MULTIPLE_NEGATIVE_SAFE")

> **BOT\_FEEDBACK\_MULTIPLE\_NEGATIVE\_SAFE**: `16`

Defined in: [WAProto/index.d.ts:1089](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1089)

---

<a name="enumeration-botfeedbackkindmultiplepositive"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/enumerations/BotFeedbackKindMultiplePositive](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/enumerations/BotFeedbackKindMultiplePositive)

Defined in: [WAProto/index.d.ts:1096](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1096)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### BOT\_FEEDBACK\_MULTIPLE\_POSITIVE\_GENERIC[​](#bot_feedback_multiple_positive_generic "Direct link to BOT_FEEDBACK_MULTIPLE_POSITIVE_GENERIC")

> **BOT\_FEEDBACK\_MULTIPLE\_POSITIVE\_GENERIC**: `1`

Defined in: [WAProto/index.d.ts:1097](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1097)

---

<a name="enumeration-reportkind"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/enumerations/ReportKind](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/enumerations/ReportKind)

Defined in: [WAProto/index.d.ts:1100](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1100)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### GENERIC[​](#generic "Direct link to GENERIC")

> **GENERIC**: `1`

Defined in: [WAProto/index.d.ts:1102](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1102)

* * *

### NONE[​](#none "Direct link to NONE")

> **NONE**: `0`

Defined in: [WAProto/index.d.ts:1101](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1101)

---

<a name="interface-isidebysidesurveymetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/interfaces/ISideBySideSurveyMetadata)

Defined in: [WAProto/index.d.ts:1105](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1105)

## Properties[​](#properties "Direct link to Properties")

### analyticsData?[​](#analyticsdata "Direct link to analyticsData?")

> `optional` **analyticsData**: `null` | [`ISideBySideSurveyAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISideBySideSurveyAnalyticsData)

Defined in: [WAProto/index.d.ts:1113](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1113)

* * *

### isSelectedResponsePrimary?[​](#isselectedresponseprimary "Direct link to isSelectedResponsePrimary?")

> `optional` **isSelectedResponsePrimary**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:1111](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1111)

* * *

### messageIdToEdit?[​](#messageidtoedit "Direct link to messageIdToEdit?")

> `optional` **messageIdToEdit**: `null` | `string`

Defined in: [WAProto/index.d.ts:1112](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1112)

* * *

### metaAiAnalyticsData?[​](#metaaianalyticsdata "Direct link to metaAiAnalyticsData?")

> `optional` **metaAiAnalyticsData**: `null` | [`ISidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData)

Defined in: [WAProto/index.d.ts:1114](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1114)

* * *

### responseOtid?[​](#responseotid "Direct link to responseOtid?")

> `optional` **responseOtid**: `null` | `string`

Defined in: [WAProto/index.d.ts:1109](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1109)

* * *

### responseTimestampMsString?[​](#responsetimestampmsstring "Direct link to responseTimestampMsString?")

> `optional` **responseTimestampMsString**: `null` | `string`

Defined in: [WAProto/index.d.ts:1110](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1110)

* * *

### selectedRequestId?[​](#selectedrequestid "Direct link to selectedRequestId?")

> `optional` **selectedRequestId**: `null` | `string`

Defined in: [WAProto/index.d.ts:1106](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1106)

* * *

### simonSessionFbid?[​](#simonsessionfbid "Direct link to simonSessionFbid?")

> `optional` **simonSessionFbid**: `null` | `string`

Defined in: [WAProto/index.d.ts:1108](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1108)

* * *

### surveyId?[​](#surveyid "Direct link to surveyId?")

> `optional` **surveyId**: `null` | `number`

Defined in: [WAProto/index.d.ts:1107](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1107)

---

<a name="sidebysidesurveymetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [SidebySideSurveyMetaAiAnalyticsData](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/)

## Classes[​](#classes "Direct link to Classes")

*   [SideBySideSurveyAnalyticsData](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SideBySideSurveyAnalyticsData)
*   [SidebySideSurveyMetaAiAnalyticsData](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SidebySideSurveyMetaAiAnalyticsData)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [ISideBySideSurveyAnalyticsData](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISideBySideSurveyAnalyticsData)
*   [ISidebySideSurveyMetaAiAnalyticsData](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData)

---

<a name="class-sidebysidesurveyanalyticsdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SideBySideSurveyAnalyticsData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SideBySideSurveyAnalyticsData)

Defined in: [WAProto/index.d.ts:1145](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1145)

## Implements[​](#implements "Direct link to Implements")

*   [`ISideBySideSurveyAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISideBySideSurveyAnalyticsData)

## Constructors[​](#constructors "Direct link to Constructors")

### new SideBySideSurveyAnalyticsData()[​](#new-sidebysidesurveyanalyticsdata "Direct link to new SideBySideSurveyAnalyticsData()")

> **new SideBySideSurveyAnalyticsData**(`p`?): [`SideBySideSurveyAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SideBySideSurveyAnalyticsData)

Defined in: [WAProto/index.d.ts:1146](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1146)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISideBySideSurveyAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISideBySideSurveyAnalyticsData)

#### Returns[​](#returns "Direct link to Returns")

[`SideBySideSurveyAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SideBySideSurveyAnalyticsData)

## Properties[​](#properties "Direct link to Properties")

### simonSessionFbid?[​](#simonsessionfbid "Direct link to simonSessionFbid?")

> `optional` **simonSessionFbid**: `null` | `string`

Defined in: [WAProto/index.d.ts:1149](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1149)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISideBySideSurveyAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISideBySideSurveyAnalyticsData).[`simonSessionFbid`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISideBySideSurveyAnalyticsData#simonsessionfbid)

* * *

### tessaEvent?[​](#tessaevent "Direct link to tessaEvent?")

> `optional` **tessaEvent**: `null` | `string`

Defined in: [WAProto/index.d.ts:1147](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1147)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISideBySideSurveyAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISideBySideSurveyAnalyticsData).[`tessaEvent`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISideBySideSurveyAnalyticsData#tessaevent)

* * *

### tessaSessionFbid?[​](#tessasessionfbid "Direct link to tessaSessionFbid?")

> `optional` **tessaSessionFbid**: `null` | `string`

Defined in: [WAProto/index.d.ts:1148](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1148)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ISideBySideSurveyAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISideBySideSurveyAnalyticsData).[`tessaSessionFbid`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISideBySideSurveyAnalyticsData#tessasessionfbid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1155](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1155)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SideBySideSurveyAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SideBySideSurveyAnalyticsData)

Defined in: [WAProto/index.d.ts:1150](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1150)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISideBySideSurveyAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISideBySideSurveyAnalyticsData)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SideBySideSurveyAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SideBySideSurveyAnalyticsData)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SideBySideSurveyAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SideBySideSurveyAnalyticsData)

Defined in: [WAProto/index.d.ts:1152](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1152)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SideBySideSurveyAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SideBySideSurveyAnalyticsData)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1151](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1151)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISideBySideSurveyAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISideBySideSurveyAnalyticsData)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SideBySideSurveyAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SideBySideSurveyAnalyticsData)

Defined in: [WAProto/index.d.ts:1153](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1153)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SideBySideSurveyAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SideBySideSurveyAnalyticsData)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1156](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1156)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1154](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1154)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SideBySideSurveyAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SideBySideSurveyAnalyticsData)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-sidebysidesurveymetaaianalyticsdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SidebySideSurveyMetaAiAnalyticsData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SidebySideSurveyMetaAiAnalyticsData)

Defined in: [WAProto/index.d.ts:1171](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1171)

## Implements[​](#implements "Direct link to Implements")

*   [`ISidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData)

## Constructors[​](#constructors "Direct link to Constructors")

### new SidebySideSurveyMetaAiAnalyticsData()[​](#new-sidebysidesurveymetaaianalyticsdata "Direct link to new SidebySideSurveyMetaAiAnalyticsData()")

> **new SidebySideSurveyMetaAiAnalyticsData**(`p`?): [`SidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SidebySideSurveyMetaAiAnalyticsData)

Defined in: [WAProto/index.d.ts:1172](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1172)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData)

#### Returns[​](#returns "Direct link to Returns")

[`SidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SidebySideSurveyMetaAiAnalyticsData)

## Properties[​](#properties "Direct link to Properties")

### abandonEvent?[​](#abandonevent "Direct link to abandonEvent?")

> `optional` **abandonEvent**: `null` | [`ISideBySideSurveyAbandonEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyAbandonEventData)

Defined in: [WAProto/index.d.ts:1181](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1181)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData).[`abandonEvent`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData#abandonevent)

* * *

### cardImpressionEvent?[​](#cardimpressionevent "Direct link to cardImpressionEvent?")

> `optional` **cardImpressionEvent**: `null` | [`ISideBySideSurveyCardImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCardImpressionEventData)

Defined in: [WAProto/index.d.ts:1179](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1179)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData).[`cardImpressionEvent`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData#cardimpressionevent)

* * *

### ctaClickEvent?[​](#ctaclickevent "Direct link to ctaClickEvent?")

> `optional` **ctaClickEvent**: `null` | [`ISideBySideSurveyCTAClickEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAClickEventData)

Defined in: [WAProto/index.d.ts:1178](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1178)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ISidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData).[`ctaClickEvent`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData#ctaclickevent)

* * *

### ctaImpressionEvent?[​](#ctaimpressionevent "Direct link to ctaImpressionEvent?")

> `optional` **ctaImpressionEvent**: `null` | [`ISideBySideSurveyCTAImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAImpressionEventData)

Defined in: [WAProto/index.d.ts:1177](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1177)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ISidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData).[`ctaImpressionEvent`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData#ctaimpressionevent)

* * *

### primaryResponseId?[​](#primaryresponseid "Direct link to primaryResponseId?")

> `optional` **primaryResponseId**: `null` | `string`

Defined in: [WAProto/index.d.ts:1174](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1174)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ISidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData).[`primaryResponseId`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData#primaryresponseid)

* * *

### responseEvent?[​](#responseevent "Direct link to responseEvent?")

> `optional` **responseEvent**: `null` | [`ISideBySideSurveyResponseEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyResponseEventData)

Defined in: [WAProto/index.d.ts:1180](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1180)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`ISidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData).[`responseEvent`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData#responseevent)

* * *

### surveyId?[​](#surveyid "Direct link to surveyId?")

> `optional` **surveyId**: `null` | `number`

Defined in: [WAProto/index.d.ts:1173](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1173)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`ISidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData).[`surveyId`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData#surveyid)

* * *

### testArmName?[​](#testarmname "Direct link to testArmName?")

> `optional` **testArmName**: `null` | `string`

Defined in: [WAProto/index.d.ts:1175](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1175)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`ISidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData).[`testArmName`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData#testarmname)

* * *

### timestampMsString?[​](#timestampmsstring "Direct link to timestampMsString?")

> `optional` **timestampMsString**: `null` | `string`

Defined in: [WAProto/index.d.ts:1176](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1176)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`ISidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData).[`timestampMsString`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData#timestampmsstring)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1187](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1187)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SidebySideSurveyMetaAiAnalyticsData)

Defined in: [WAProto/index.d.ts:1182](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1182)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SidebySideSurveyMetaAiAnalyticsData)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SidebySideSurveyMetaAiAnalyticsData)

Defined in: [WAProto/index.d.ts:1184](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1184)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SidebySideSurveyMetaAiAnalyticsData)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1183](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1183)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SidebySideSurveyMetaAiAnalyticsData)

Defined in: [WAProto/index.d.ts:1185](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1185)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SidebySideSurveyMetaAiAnalyticsData)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1188](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1188)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1186](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1186)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SidebySideSurveyMetaAiAnalyticsData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/classes/SidebySideSurveyMetaAiAnalyticsData)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-isidebysidesurveyanalyticsdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISideBySideSurveyAnalyticsData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISideBySideSurveyAnalyticsData)

Defined in: [WAProto/index.d.ts:1139](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1139)

## Properties[​](#properties "Direct link to Properties")

### simonSessionFbid?[​](#simonsessionfbid "Direct link to simonSessionFbid?")

> `optional` **simonSessionFbid**: `null` | `string`

Defined in: [WAProto/index.d.ts:1142](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1142)

* * *

### tessaEvent?[​](#tessaevent "Direct link to tessaEvent?")

> `optional` **tessaEvent**: `null` | `string`

Defined in: [WAProto/index.d.ts:1140](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1140)

* * *

### tessaSessionFbid?[​](#tessasessionfbid "Direct link to tessaSessionFbid?")

> `optional` **tessaSessionFbid**: `null` | `string`

Defined in: [WAProto/index.d.ts:1141](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1141)

---

<a name="interface-isidebysidesurveymetaaianalyticsdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/interfaces/ISidebySideSurveyMetaAiAnalyticsData)

Defined in: [WAProto/index.d.ts:1159](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1159)

## Properties[​](#properties "Direct link to Properties")

### abandonEvent?[​](#abandonevent "Direct link to abandonEvent?")

> `optional` **abandonEvent**: `null` | [`ISideBySideSurveyAbandonEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyAbandonEventData)

Defined in: [WAProto/index.d.ts:1168](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1168)

* * *

### cardImpressionEvent?[​](#cardimpressionevent "Direct link to cardImpressionEvent?")

> `optional` **cardImpressionEvent**: `null` | [`ISideBySideSurveyCardImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCardImpressionEventData)

Defined in: [WAProto/index.d.ts:1166](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1166)

* * *

### ctaClickEvent?[​](#ctaclickevent "Direct link to ctaClickEvent?")

> `optional` **ctaClickEvent**: `null` | [`ISideBySideSurveyCTAClickEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAClickEventData)

Defined in: [WAProto/index.d.ts:1165](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1165)

* * *

### ctaImpressionEvent?[​](#ctaimpressionevent "Direct link to ctaImpressionEvent?")

> `optional` **ctaImpressionEvent**: `null` | [`ISideBySideSurveyCTAImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAImpressionEventData)

Defined in: [WAProto/index.d.ts:1164](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1164)

* * *

### primaryResponseId?[​](#primaryresponseid "Direct link to primaryResponseId?")

> `optional` **primaryResponseId**: `null` | `string`

Defined in: [WAProto/index.d.ts:1161](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1161)

* * *

### responseEvent?[​](#responseevent "Direct link to responseEvent?")

> `optional` **responseEvent**: `null` | [`ISideBySideSurveyResponseEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyResponseEventData)

Defined in: [WAProto/index.d.ts:1167](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1167)

* * *

### surveyId?[​](#surveyid "Direct link to surveyId?")

> `optional` **surveyId**: `null` | `number`

Defined in: [WAProto/index.d.ts:1160](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1160)

* * *

### testArmName?[​](#testarmname "Direct link to testArmName?")

> `optional` **testArmName**: `null` | `string`

Defined in: [WAProto/index.d.ts:1162](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1162)

* * *

### timestampMsString?[​](#timestampmsstring "Direct link to timestampMsString?")

> `optional` **timestampMsString**: `null` | `string`

Defined in: [WAProto/index.d.ts:1163](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1163)

---

<a name="sidebysidesurveymetaaianalyticsdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/)

## Classes[​](#classes "Direct link to Classes")

*   [SideBySideSurveyAbandonEventData](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyAbandonEventData)
*   [SideBySideSurveyCardImpressionEventData](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCardImpressionEventData)
*   [SideBySideSurveyCTAClickEventData](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAClickEventData)
*   [SideBySideSurveyCTAImpressionEventData](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAImpressionEventData)
*   [SideBySideSurveyResponseEventData](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyResponseEventData)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [ISideBySideSurveyAbandonEventData](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyAbandonEventData)
*   [ISideBySideSurveyCardImpressionEventData](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCardImpressionEventData)
*   [ISideBySideSurveyCTAClickEventData](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAClickEventData)
*   [ISideBySideSurveyCTAImpressionEventData](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAImpressionEventData)
*   [ISideBySideSurveyResponseEventData](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyResponseEventData)

---

<a name="class-sidebysidesurveyabandoneventdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyAbandonEventData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyAbandonEventData)

Defined in: [WAProto/index.d.ts:1197](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1197)

## Implements[​](#implements "Direct link to Implements")

*   [`ISideBySideSurveyAbandonEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyAbandonEventData)

## Constructors[​](#constructors "Direct link to Constructors")

### new SideBySideSurveyAbandonEventData()[​](#new-sidebysidesurveyabandoneventdata "Direct link to new SideBySideSurveyAbandonEventData()")

> **new SideBySideSurveyAbandonEventData**(`p`?): [`SideBySideSurveyAbandonEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyAbandonEventData)

Defined in: [WAProto/index.d.ts:1198](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1198)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISideBySideSurveyAbandonEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyAbandonEventData)

#### Returns[​](#returns "Direct link to Returns")

[`SideBySideSurveyAbandonEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyAbandonEventData)

## Properties[​](#properties "Direct link to Properties")

### abandonDwellTimeMsString?[​](#abandondwelltimemsstring "Direct link to abandonDwellTimeMsString?")

> `optional` **abandonDwellTimeMsString**: `null` | `string`

Defined in: [WAProto/index.d.ts:1199](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1199)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISideBySideSurveyAbandonEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyAbandonEventData).[`abandonDwellTimeMsString`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyAbandonEventData#abandondwelltimemsstring)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1205](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1205)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SideBySideSurveyAbandonEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyAbandonEventData)

Defined in: [WAProto/index.d.ts:1200](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1200)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISideBySideSurveyAbandonEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyAbandonEventData)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SideBySideSurveyAbandonEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyAbandonEventData)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SideBySideSurveyAbandonEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyAbandonEventData)

Defined in: [WAProto/index.d.ts:1202](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1202)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SideBySideSurveyAbandonEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyAbandonEventData)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1201](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1201)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISideBySideSurveyAbandonEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyAbandonEventData)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SideBySideSurveyAbandonEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyAbandonEventData)

Defined in: [WAProto/index.d.ts:1203](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1203)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SideBySideSurveyAbandonEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyAbandonEventData)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1206](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1206)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1204](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1204)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SideBySideSurveyAbandonEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyAbandonEventData)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-sidebysidesurveyctaclickeventdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAClickEventData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAClickEventData)

Defined in: [WAProto/index.d.ts:1214](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1214)

## Implements[​](#implements "Direct link to Implements")

*   [`ISideBySideSurveyCTAClickEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAClickEventData)

## Constructors[​](#constructors "Direct link to Constructors")

### new SideBySideSurveyCTAClickEventData()[​](#new-sidebysidesurveyctaclickeventdata "Direct link to new SideBySideSurveyCTAClickEventData()")

> **new SideBySideSurveyCTAClickEventData**(`p`?): [`SideBySideSurveyCTAClickEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAClickEventData)

Defined in: [WAProto/index.d.ts:1215](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1215)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISideBySideSurveyCTAClickEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAClickEventData)

#### Returns[​](#returns "Direct link to Returns")

[`SideBySideSurveyCTAClickEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAClickEventData)

## Properties[​](#properties "Direct link to Properties")

### clickDwellTimeMsString?[​](#clickdwelltimemsstring "Direct link to clickDwellTimeMsString?")

> `optional` **clickDwellTimeMsString**: `null` | `string`

Defined in: [WAProto/index.d.ts:1217](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1217)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISideBySideSurveyCTAClickEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAClickEventData).[`clickDwellTimeMsString`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAClickEventData#clickdwelltimemsstring)

* * *

### isSurveyExpired?[​](#issurveyexpired "Direct link to isSurveyExpired?")

> `optional` **isSurveyExpired**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:1216](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1216)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISideBySideSurveyCTAClickEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAClickEventData).[`isSurveyExpired`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAClickEventData#issurveyexpired)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1223](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1223)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SideBySideSurveyCTAClickEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAClickEventData)

Defined in: [WAProto/index.d.ts:1218](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1218)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISideBySideSurveyCTAClickEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAClickEventData)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SideBySideSurveyCTAClickEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAClickEventData)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SideBySideSurveyCTAClickEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAClickEventData)

Defined in: [WAProto/index.d.ts:1220](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1220)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SideBySideSurveyCTAClickEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAClickEventData)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1219](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1219)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISideBySideSurveyCTAClickEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAClickEventData)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SideBySideSurveyCTAClickEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAClickEventData)

Defined in: [WAProto/index.d.ts:1221](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1221)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SideBySideSurveyCTAClickEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAClickEventData)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1224](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1224)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1222](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1222)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SideBySideSurveyCTAClickEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAClickEventData)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-sidebysidesurveyctaimpressioneventdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAImpressionEventData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAImpressionEventData)

Defined in: [WAProto/index.d.ts:1231](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1231)

## Implements[​](#implements "Direct link to Implements")

*   [`ISideBySideSurveyCTAImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAImpressionEventData)

## Constructors[​](#constructors "Direct link to Constructors")

### new SideBySideSurveyCTAImpressionEventData()[​](#new-sidebysidesurveyctaimpressioneventdata "Direct link to new SideBySideSurveyCTAImpressionEventData()")

> **new SideBySideSurveyCTAImpressionEventData**(`p`?): [`SideBySideSurveyCTAImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAImpressionEventData)

Defined in: [WAProto/index.d.ts:1232](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1232)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISideBySideSurveyCTAImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAImpressionEventData)

#### Returns[​](#returns "Direct link to Returns")

[`SideBySideSurveyCTAImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAImpressionEventData)

## Properties[​](#properties "Direct link to Properties")

### isSurveyExpired?[​](#issurveyexpired "Direct link to isSurveyExpired?")

> `optional` **isSurveyExpired**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:1233](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1233)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISideBySideSurveyCTAImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAImpressionEventData).[`isSurveyExpired`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAImpressionEventData#issurveyexpired)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1239](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1239)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SideBySideSurveyCTAImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAImpressionEventData)

Defined in: [WAProto/index.d.ts:1234](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1234)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISideBySideSurveyCTAImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAImpressionEventData)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SideBySideSurveyCTAImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAImpressionEventData)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SideBySideSurveyCTAImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAImpressionEventData)

Defined in: [WAProto/index.d.ts:1236](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1236)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SideBySideSurveyCTAImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAImpressionEventData)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1235](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1235)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISideBySideSurveyCTAImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAImpressionEventData)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SideBySideSurveyCTAImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAImpressionEventData)

Defined in: [WAProto/index.d.ts:1237](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1237)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SideBySideSurveyCTAImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAImpressionEventData)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1240](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1240)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1238](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1238)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SideBySideSurveyCTAImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCTAImpressionEventData)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-sidebysidesurveycardimpressioneventdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCardImpressionEventData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCardImpressionEventData)

Defined in: [WAProto/index.d.ts:1246](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1246)

## Implements[​](#implements "Direct link to Implements")

*   [`ISideBySideSurveyCardImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCardImpressionEventData)

## Constructors[​](#constructors "Direct link to Constructors")

### new SideBySideSurveyCardImpressionEventData()[​](#new-sidebysidesurveycardimpressioneventdata "Direct link to new SideBySideSurveyCardImpressionEventData()")

> **new SideBySideSurveyCardImpressionEventData**(`p`?): [`SideBySideSurveyCardImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCardImpressionEventData)

Defined in: [WAProto/index.d.ts:1247](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1247)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISideBySideSurveyCardImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCardImpressionEventData)

#### Returns[​](#returns "Direct link to Returns")

[`SideBySideSurveyCardImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCardImpressionEventData)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1253](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1253)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SideBySideSurveyCardImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCardImpressionEventData)

Defined in: [WAProto/index.d.ts:1248](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1248)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties "Direct link to properties?")

[`ISideBySideSurveyCardImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCardImpressionEventData)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SideBySideSurveyCardImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCardImpressionEventData)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SideBySideSurveyCardImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCardImpressionEventData)

Defined in: [WAProto/index.d.ts:1250](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1250)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SideBySideSurveyCardImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCardImpressionEventData)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1249](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1249)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISideBySideSurveyCardImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCardImpressionEventData)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SideBySideSurveyCardImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCardImpressionEventData)

Defined in: [WAProto/index.d.ts:1251](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1251)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SideBySideSurveyCardImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCardImpressionEventData)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1254](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1254)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1252](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1252)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SideBySideSurveyCardImpressionEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyCardImpressionEventData)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-sidebysidesurveyresponseeventdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyResponseEventData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyResponseEventData)

Defined in: [WAProto/index.d.ts:1262](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1262)

## Implements[​](#implements "Direct link to Implements")

*   [`ISideBySideSurveyResponseEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyResponseEventData)

## Constructors[​](#constructors "Direct link to Constructors")

### new SideBySideSurveyResponseEventData()[​](#new-sidebysidesurveyresponseeventdata "Direct link to new SideBySideSurveyResponseEventData()")

> **new SideBySideSurveyResponseEventData**(`p`?): [`SideBySideSurveyResponseEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyResponseEventData)

Defined in: [WAProto/index.d.ts:1263](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1263)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISideBySideSurveyResponseEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyResponseEventData)

#### Returns[​](#returns "Direct link to Returns")

[`SideBySideSurveyResponseEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyResponseEventData)

## Properties[​](#properties "Direct link to Properties")

### responseDwellTimeMsString?[​](#responsedwelltimemsstring "Direct link to responseDwellTimeMsString?")

> `optional` **responseDwellTimeMsString**: `null` | `string`

Defined in: [WAProto/index.d.ts:1264](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1264)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISideBySideSurveyResponseEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyResponseEventData).[`responseDwellTimeMsString`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyResponseEventData#responsedwelltimemsstring)

* * *

### selectedResponseId?[​](#selectedresponseid "Direct link to selectedResponseId?")

> `optional` **selectedResponseId**: `null` | `string`

Defined in: [WAProto/index.d.ts:1265](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1265)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISideBySideSurveyResponseEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyResponseEventData).[`selectedResponseId`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyResponseEventData#selectedresponseid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1271](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1271)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SideBySideSurveyResponseEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyResponseEventData)

Defined in: [WAProto/index.d.ts:1266](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1266)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISideBySideSurveyResponseEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyResponseEventData)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SideBySideSurveyResponseEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyResponseEventData)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SideBySideSurveyResponseEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyResponseEventData)

Defined in: [WAProto/index.d.ts:1268](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1268)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SideBySideSurveyResponseEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyResponseEventData)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1267](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1267)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISideBySideSurveyResponseEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyResponseEventData)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SideBySideSurveyResponseEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyResponseEventData)

Defined in: [WAProto/index.d.ts:1269](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1269)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SideBySideSurveyResponseEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyResponseEventData)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1272](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1272)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1270](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1270)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SideBySideSurveyResponseEventData`](/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/classes/SideBySideSurveyResponseEventData)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-isidebysidesurveyabandoneventdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyAbandonEventData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyAbandonEventData)

Defined in: [WAProto/index.d.ts:1193](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1193)

## Properties[​](#properties "Direct link to Properties")

### abandonDwellTimeMsString?[​](#abandondwelltimemsstring "Direct link to abandonDwellTimeMsString?")

> `optional` **abandonDwellTimeMsString**: `null` | `string`

Defined in: [WAProto/index.d.ts:1194](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1194)

---

<a name="interface-isidebysidesurveyctaclickeventdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAClickEventData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAClickEventData)

Defined in: [WAProto/index.d.ts:1209](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1209)

## Properties[​](#properties "Direct link to Properties")

### clickDwellTimeMsString?[​](#clickdwelltimemsstring "Direct link to clickDwellTimeMsString?")

> `optional` **clickDwellTimeMsString**: `null` | `string`

Defined in: [WAProto/index.d.ts:1211](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1211)

* * *

### isSurveyExpired?[​](#issurveyexpired "Direct link to isSurveyExpired?")

> `optional` **isSurveyExpired**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:1210](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1210)

---

<a name="interface-isidebysidesurveyctaimpressioneventdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAImpressionEventData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCTAImpressionEventData)

Defined in: [WAProto/index.d.ts:1227](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1227)

## Properties[​](#properties "Direct link to Properties")

### isSurveyExpired?[​](#issurveyexpired "Direct link to isSurveyExpired?")

> `optional` **isSurveyExpired**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:1228](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1228)

---

<a name="interface-isidebysidesurveycardimpressioneventdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCardImpressionEventData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyCardImpressionEventData)

Defined in: [WAProto/index.d.ts:1243](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1243)

---

<a name="interface-isidebysidesurveyresponseeventdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyResponseEventData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotFeedbackMessage/namespaces/SideBySideSurveyMetadata/namespaces/SidebySideSurveyMetaAiAnalyticsData/interfaces/ISideBySideSurveyResponseEventData)

Defined in: [WAProto/index.d.ts:1257](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1257)

## Properties[​](#properties "Direct link to Properties")

### responseDwellTimeMsString?[​](#responsedwelltimemsstring "Direct link to responseDwellTimeMsString?")

> `optional` **responseDwellTimeMsString**: `null` | `string`

Defined in: [WAProto/index.d.ts:1258](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1258)

* * *

### selectedResponseId?[​](#selectedresponseid "Direct link to selectedResponseId?")

> `optional` **selectedResponseId**: `null` | `string`

Defined in: [WAProto/index.d.ts:1259](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1259)

---

<a name="botimaginemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotImagineMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotImagineMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [ImagineType](/docs/api/namespaces/proto/namespaces/BotImagineMetadata/enumerations/ImagineType)

---

<a name="enumeration-imaginetype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotImagineMetadata/enumerations/ImagineType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotImagineMetadata/enumerations/ImagineType)

Defined in: [WAProto/index.d.ts:1296](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1296)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### EDIT[​](#edit "Direct link to EDIT")

> **EDIT**: `4`

Defined in: [WAProto/index.d.ts:1301](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1301)

* * *

### FLASH[​](#flash "Direct link to FLASH")

> **FLASH**: `3`

Defined in: [WAProto/index.d.ts:1300](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1300)

* * *

### IMAGINE[​](#imagine "Direct link to IMAGINE")

> **IMAGINE**: `1`

Defined in: [WAProto/index.d.ts:1298](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1298)

* * *

### MEMU[​](#memu "Direct link to MEMU")

> **MEMU**: `2`

Defined in: [WAProto/index.d.ts:1299](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1299)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:1297](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1297)

---

<a name="botlinkedaccount"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotLinkedAccount/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotLinkedAccount/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [BotLinkedAccountType](/docs/api/namespaces/proto/namespaces/BotLinkedAccount/enumerations/BotLinkedAccountType)

---

<a name="enumeration-botlinkedaccounttype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotLinkedAccount/enumerations/BotLinkedAccountType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotLinkedAccount/enumerations/BotLinkedAccountType)

Defined in: [WAProto/index.d.ts:1323](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1323)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### BOT\_LINKED\_ACCOUNT\_TYPE\_1P[​](#bot_linked_account_type_1p "Direct link to BOT_LINKED_ACCOUNT_TYPE_1P")

> **BOT\_LINKED\_ACCOUNT\_TYPE\_1P**: `0`

Defined in: [WAProto/index.d.ts:1324](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1324)

---

<a name="botmediametadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotMediaMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotMediaMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [OrientationType](/docs/api/namespaces/proto/namespaces/BotMediaMetadata/enumerations/OrientationType)

---

<a name="enumeration-orientationtype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotMediaMetadata/enumerations/OrientationType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotMediaMetadata/enumerations/OrientationType)

Defined in: [WAProto/index.d.ts:1378](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1378)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### CENTER[​](#center "Direct link to CENTER")

> **CENTER**: `1`

Defined in: [WAProto/index.d.ts:1379](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1379)

* * *

### LEFT[​](#left "Direct link to LEFT")

> **LEFT**: `2`

Defined in: [WAProto/index.d.ts:1380](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1380)

* * *

### RIGHT[​](#right "Direct link to RIGHT")

> **RIGHT**: `3`

Defined in: [WAProto/index.d.ts:1381](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1381)

---

<a name="botmessageorigin"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotMessageOrigin/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotMessageOrigin/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [BotMessageOriginType](/docs/api/namespaces/proto/namespaces/BotMessageOrigin/enumerations/BotMessageOriginType)

---

<a name="enumeration-botmessageorigintype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotMessageOrigin/enumerations/BotMessageOriginType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotMessageOrigin/enumerations/BotMessageOriginType)

Defined in: [WAProto/index.d.ts:1457](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1457)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### BOT\_MESSAGE\_ORIGIN\_TYPE\_AI\_INITIATED[​](#bot_message_origin_type_ai_initiated "Direct link to BOT_MESSAGE_ORIGIN_TYPE_AI_INITIATED")

> **BOT\_MESSAGE\_ORIGIN\_TYPE\_AI\_INITIATED**: `0`

Defined in: [WAProto/index.d.ts:1458](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1458)

---

<a name="botmodeselectionmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotModeSelectionMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotModeSelectionMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [BotUserSelectionMode](/docs/api/namespaces/proto/namespaces/BotModeSelectionMetadata/enumerations/BotUserSelectionMode)

---

<a name="enumeration-botuserselectionmode"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotModeSelectionMetadata/enumerations/BotUserSelectionMode](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotModeSelectionMetadata/enumerations/BotUserSelectionMode)

Defined in: [WAProto/index.d.ts:1666](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1666)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### REASONING\_MODE[​](#reasoning_mode "Direct link to REASONING_MODE")

> **REASONING\_MODE**: `1`

Defined in: [WAProto/index.d.ts:1668](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1668)

* * *

### UNKNOWN\_MODE[​](#unknown_mode "Direct link to UNKNOWN_MODE")

> **UNKNOWN\_MODE**: `0`

Defined in: [WAProto/index.d.ts:1667](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1667)

---

<a name="botmodelmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotModelMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotModelMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [ModelType](/docs/api/namespaces/proto/namespaces/BotModelMetadata/enumerations/ModelType)
*   [PremiumModelStatus](/docs/api/namespaces/proto/namespaces/BotModelMetadata/enumerations/PremiumModelStatus)

---

<a name="enumeration-modeltype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotModelMetadata/enumerations/ModelType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotModelMetadata/enumerations/ModelType)

Defined in: [WAProto/index.d.ts:1694](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1694)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### LLAMA\_PROD[​](#llama_prod "Direct link to LLAMA_PROD")

> **LLAMA\_PROD**: `1`

Defined in: [WAProto/index.d.ts:1696](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1696)

* * *

### LLAMA\_PROD\_PREMIUM[​](#llama_prod_premium "Direct link to LLAMA_PROD_PREMIUM")

> **LLAMA\_PROD\_PREMIUM**: `2`

Defined in: [WAProto/index.d.ts:1697](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1697)

* * *

### UNKNOWN\_TYPE[​](#unknown_type "Direct link to UNKNOWN_TYPE")

> **UNKNOWN\_TYPE**: `0`

Defined in: [WAProto/index.d.ts:1695](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1695)

---

<a name="enumeration-premiummodelstatus"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotModelMetadata/enumerations/PremiumModelStatus](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotModelMetadata/enumerations/PremiumModelStatus)

Defined in: [WAProto/index.d.ts:1700](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1700)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AVAILABLE[​](#available "Direct link to AVAILABLE")

> **AVAILABLE**: `1`

Defined in: [WAProto/index.d.ts:1702](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1702)

* * *

### QUOTA\_EXCEED\_LIMIT[​](#quota_exceed_limit "Direct link to QUOTA_EXCEED_LIMIT")

> **QUOTA\_EXCEED\_LIMIT**: `2`

Defined in: [WAProto/index.d.ts:1703](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1703)

* * *

### UNKNOWN\_STATUS[​](#unknown_status "Direct link to UNKNOWN_STATUS")

> **UNKNOWN\_STATUS**: `0`

Defined in: [WAProto/index.d.ts:1701](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1701)

---

<a name="botpluginmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotPluginMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotPluginMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [PluginType](/docs/api/namespaces/proto/namespaces/BotPluginMetadata/enumerations/PluginType)
*   [SearchProvider](/docs/api/namespaces/proto/namespaces/BotPluginMetadata/enumerations/SearchProvider)

---

<a name="enumeration-plugintype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotPluginMetadata/enumerations/PluginType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotPluginMetadata/enumerations/PluginType)

Defined in: [WAProto/index.d.ts:1747](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1747)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### REELS[​](#reels "Direct link to REELS")

> **REELS**: `1`

Defined in: [WAProto/index.d.ts:1749](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1749)

* * *

### SEARCH[​](#search "Direct link to SEARCH")

> **SEARCH**: `2`

Defined in: [WAProto/index.d.ts:1750](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1750)

* * *

### UNKNOWN\_PLUGIN[​](#unknown_plugin "Direct link to UNKNOWN_PLUGIN")

> **UNKNOWN\_PLUGIN**: `0`

Defined in: [WAProto/index.d.ts:1748](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1748)

---

<a name="enumeration-searchprovider"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotPluginMetadata/enumerations/SearchProvider](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotPluginMetadata/enumerations/SearchProvider)

Defined in: [WAProto/index.d.ts:1753](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1753)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### BING[​](#bing "Direct link to BING")

> **BING**: `1`

Defined in: [WAProto/index.d.ts:1755](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1755)

* * *

### GOOGLE[​](#google "Direct link to GOOGLE")

> **GOOGLE**: `2`

Defined in: [WAProto/index.d.ts:1756](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1756)

* * *

### SUPPORT[​](#support "Direct link to SUPPORT")

> **SUPPORT**: `3`

Defined in: [WAProto/index.d.ts:1757](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1757)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:1754](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1754)

---

<a name="botprogressindicatormetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [BotPlanningStepMetadata](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/)

## Classes[​](#classes "Direct link to Classes")

*   [BotPlanningStepMetadata](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/classes/BotPlanningStepMetadata)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IBotPlanningStepMetadata](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata)

---

<a name="class-botplanningstepmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/classes/BotPlanningStepMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/classes/BotPlanningStepMetadata)

Defined in: [WAProto/index.d.ts:1791](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1791)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotPlanningStepMetadata()[​](#new-botplanningstepmetadata "Direct link to new BotPlanningStepMetadata()")

> **new BotPlanningStepMetadata**(`p`?): [`BotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/classes/BotPlanningStepMetadata)

Defined in: [WAProto/index.d.ts:1792](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1792)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/classes/BotPlanningStepMetadata)

## Properties[​](#properties "Direct link to Properties")

### isEnhancedSearch?[​](#isenhancedsearch "Direct link to isEnhancedSearch?")

> `optional` **isEnhancedSearch**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:1798](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1798)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata).[`isEnhancedSearch`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata#isenhancedsearch)

* * *

### isReasoning?[​](#isreasoning "Direct link to isReasoning?")

> `optional` **isReasoning**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:1797](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1797)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata).[`isReasoning`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata#isreasoning)

* * *

### sections[​](#sections "Direct link to sections")

> **sections**: [`IBotPlanningStepSectionMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningStepSectionMetadata)\[\]

Defined in: [WAProto/index.d.ts:1799](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1799)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata).[`sections`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata#sections)

* * *

### sourcesMetadata[​](#sourcesmetadata "Direct link to sourcesMetadata")

> **sourcesMetadata**: [`IBotPlanningSearchSourcesMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourcesMetadata)\[\]

Defined in: [WAProto/index.d.ts:1795](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1795)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IBotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata).[`sourcesMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata#sourcesmetadata)

* * *

### status?[​](#status "Direct link to status?")

> `optional` **status**: `null` | [`PlanningStepStatus`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/enumerations/PlanningStepStatus)

Defined in: [WAProto/index.d.ts:1796](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1796)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IBotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata).[`status`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata#status)

* * *

### statusBody?[​](#statusbody "Direct link to statusBody?")

> `optional` **statusBody**: `null` | `string`

Defined in: [WAProto/index.d.ts:1794](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1794)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IBotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata).[`statusBody`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata#statusbody)

* * *

### statusTitle?[​](#statustitle "Direct link to statusTitle?")

> `optional` **statusTitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:1793](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1793)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IBotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata).[`statusTitle`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata#statustitle)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1805](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1805)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/classes/BotPlanningStepMetadata)

Defined in: [WAProto/index.d.ts:1800](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1800)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/classes/BotPlanningStepMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/classes/BotPlanningStepMetadata)

Defined in: [WAProto/index.d.ts:1802](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1802)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/classes/BotPlanningStepMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1801](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1801)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/classes/BotPlanningStepMetadata)

Defined in: [WAProto/index.d.ts:1803](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1803)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/classes/BotPlanningStepMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1806](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1806)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1804](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1804)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotPlanningStepMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/classes/BotPlanningStepMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ibotplanningstepmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/interfaces/IBotPlanningStepMetadata)

Defined in: [WAProto/index.d.ts:1781](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1781)

## Properties[​](#properties "Direct link to Properties")

### isEnhancedSearch?[​](#isenhancedsearch "Direct link to isEnhancedSearch?")

> `optional` **isEnhancedSearch**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:1787](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1787)

* * *

### isReasoning?[​](#isreasoning "Direct link to isReasoning?")

> `optional` **isReasoning**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:1786](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1786)

* * *

### sections?[​](#sections "Direct link to sections?")

> `optional` **sections**: `null` | [`IBotPlanningStepSectionMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningStepSectionMetadata)\[\]

Defined in: [WAProto/index.d.ts:1788](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1788)

* * *

### sourcesMetadata?[​](#sourcesmetadata "Direct link to sourcesMetadata?")

> `optional` **sourcesMetadata**: `null` | [`IBotPlanningSearchSourcesMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourcesMetadata)\[\]

Defined in: [WAProto/index.d.ts:1784](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1784)

* * *

### status?[​](#status "Direct link to status?")

> `optional` **status**: `null` | [`PlanningStepStatus`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/enumerations/PlanningStepStatus)

Defined in: [WAProto/index.d.ts:1785](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1785)

* * *

### statusBody?[​](#statusbody "Direct link to statusBody?")

> `optional` **statusBody**: `null` | `string`

Defined in: [WAProto/index.d.ts:1783](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1783)

* * *

### statusTitle?[​](#statustitle "Direct link to statusTitle?")

> `optional` **statusTitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:1782](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1782)

---

<a name="botplanningstepmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [BotPlanningSearchSourcesMetadata](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/namespaces/BotPlanningSearchSourcesMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [BotSearchSourceProvider](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/enumerations/BotSearchSourceProvider)
*   [PlanningStepStatus](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/enumerations/PlanningStepStatus)

## Classes[​](#classes "Direct link to Classes")

*   [BotPlanningSearchSourceMetadata](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourceMetadata)
*   [BotPlanningSearchSourcesMetadata](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourcesMetadata)
*   [BotPlanningStepSectionMetadata](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningStepSectionMetadata)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IBotPlanningSearchSourceMetadata](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourceMetadata)
*   [IBotPlanningSearchSourcesMetadata](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourcesMetadata)
*   [IBotPlanningStepSectionMetadata](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningStepSectionMetadata)

---

<a name="class-botplanningsearchsourcemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourceMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourceMetadata)

Defined in: [WAProto/index.d.ts:1818](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1818)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotPlanningSearchSourceMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourceMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotPlanningSearchSourceMetadata()[​](#new-botplanningsearchsourcemetadata "Direct link to new BotPlanningSearchSourceMetadata()")

> **new BotPlanningSearchSourceMetadata**(`p`?): [`BotPlanningSearchSourceMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourceMetadata)

Defined in: [WAProto/index.d.ts:1819](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1819)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotPlanningSearchSourceMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourceMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotPlanningSearchSourceMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourceMetadata)

## Properties[​](#properties "Direct link to Properties")

### favIconUrl?[​](#faviconurl "Direct link to favIconUrl?")

> `optional` **favIconUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:1823](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1823)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotPlanningSearchSourceMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourceMetadata).[`favIconUrl`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourceMetadata#faviconurl)

* * *

### provider?[​](#provider "Direct link to provider?")

> `optional` **provider**: `null` | [`BotSearchSourceProvider`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/enumerations/BotSearchSourceProvider)

Defined in: [WAProto/index.d.ts:1821](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1821)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotPlanningSearchSourceMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourceMetadata).[`provider`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourceMetadata#provider)

* * *

### sourceUrl?[​](#sourceurl "Direct link to sourceUrl?")

> `optional` **sourceUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:1822](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1822)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBotPlanningSearchSourceMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourceMetadata).[`sourceUrl`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourceMetadata#sourceurl)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:1820](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1820)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IBotPlanningSearchSourceMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourceMetadata).[`title`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourceMetadata#title)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1829](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1829)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotPlanningSearchSourceMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourceMetadata)

Defined in: [WAProto/index.d.ts:1824](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1824)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotPlanningSearchSourceMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourceMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotPlanningSearchSourceMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourceMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotPlanningSearchSourceMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourceMetadata)

Defined in: [WAProto/index.d.ts:1826](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1826)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotPlanningSearchSourceMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourceMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1825](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1825)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotPlanningSearchSourceMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourceMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotPlanningSearchSourceMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourceMetadata)

Defined in: [WAProto/index.d.ts:1827](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1827)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotPlanningSearchSourceMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourceMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1830](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1830)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1828](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1828)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotPlanningSearchSourceMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourceMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botplanningsearchsourcesmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourcesMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourcesMetadata)

Defined in: [WAProto/index.d.ts:1839](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1839)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotPlanningSearchSourcesMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourcesMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotPlanningSearchSourcesMetadata()[​](#new-botplanningsearchsourcesmetadata "Direct link to new BotPlanningSearchSourcesMetadata()")

> **new BotPlanningSearchSourcesMetadata**(`p`?): [`BotPlanningSearchSourcesMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourcesMetadata)

Defined in: [WAProto/index.d.ts:1840](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1840)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotPlanningSearchSourcesMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourcesMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotPlanningSearchSourcesMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourcesMetadata)

## Properties[​](#properties "Direct link to Properties")

### provider?[​](#provider "Direct link to provider?")

> `optional` **provider**: `null` | [`BotPlanningSearchSourceProvider`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/namespaces/BotPlanningSearchSourcesMetadata/enumerations/BotPlanningSearchSourceProvider)

Defined in: [WAProto/index.d.ts:1842](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1842)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotPlanningSearchSourcesMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourcesMetadata).[`provider`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourcesMetadata#provider)

* * *

### sourceTitle?[​](#sourcetitle "Direct link to sourceTitle?")

> `optional` **sourceTitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:1841](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1841)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotPlanningSearchSourcesMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourcesMetadata).[`sourceTitle`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourcesMetadata#sourcetitle)

* * *

### sourceUrl?[​](#sourceurl "Direct link to sourceUrl?")

> `optional` **sourceUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:1843](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1843)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBotPlanningSearchSourcesMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourcesMetadata).[`sourceUrl`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourcesMetadata#sourceurl)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1849](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1849)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotPlanningSearchSourcesMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourcesMetadata)

Defined in: [WAProto/index.d.ts:1844](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1844)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotPlanningSearchSourcesMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourcesMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotPlanningSearchSourcesMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourcesMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotPlanningSearchSourcesMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourcesMetadata)

Defined in: [WAProto/index.d.ts:1846](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1846)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotPlanningSearchSourcesMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourcesMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1845](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1845)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotPlanningSearchSourcesMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourcesMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotPlanningSearchSourcesMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourcesMetadata)

Defined in: [WAProto/index.d.ts:1847](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1847)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotPlanningSearchSourcesMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourcesMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1850](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1850)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1848](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1848)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotPlanningSearchSourcesMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningSearchSourcesMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botplanningstepsectionmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningStepSectionMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningStepSectionMetadata)

Defined in: [WAProto/index.d.ts:1869](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1869)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotPlanningStepSectionMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningStepSectionMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotPlanningStepSectionMetadata()[​](#new-botplanningstepsectionmetadata "Direct link to new BotPlanningStepSectionMetadata()")

> **new BotPlanningStepSectionMetadata**(`p`?): [`BotPlanningStepSectionMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningStepSectionMetadata)

Defined in: [WAProto/index.d.ts:1870](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1870)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotPlanningStepSectionMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningStepSectionMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotPlanningStepSectionMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningStepSectionMetadata)

## Properties[​](#properties "Direct link to Properties")

### sectionBody?[​](#sectionbody "Direct link to sectionBody?")

> `optional` **sectionBody**: `null` | `string`

Defined in: [WAProto/index.d.ts:1872](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1872)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotPlanningStepSectionMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningStepSectionMetadata).[`sectionBody`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningStepSectionMetadata#sectionbody)

* * *

### sectionTitle?[​](#sectiontitle "Direct link to sectionTitle?")

> `optional` **sectionTitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:1871](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1871)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotPlanningStepSectionMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningStepSectionMetadata).[`sectionTitle`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningStepSectionMetadata#sectiontitle)

* * *

### sourcesMetadata[​](#sourcesmetadata "Direct link to sourcesMetadata")

> **sourcesMetadata**: [`IBotPlanningSearchSourceMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourceMetadata)\[\]

Defined in: [WAProto/index.d.ts:1873](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1873)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBotPlanningStepSectionMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningStepSectionMetadata).[`sourcesMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningStepSectionMetadata#sourcesmetadata)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1879](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1879)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotPlanningStepSectionMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningStepSectionMetadata)

Defined in: [WAProto/index.d.ts:1874](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1874)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotPlanningStepSectionMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningStepSectionMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotPlanningStepSectionMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningStepSectionMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotPlanningStepSectionMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningStepSectionMetadata)

Defined in: [WAProto/index.d.ts:1876](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1876)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotPlanningStepSectionMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningStepSectionMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1875](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1875)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotPlanningStepSectionMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningStepSectionMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotPlanningStepSectionMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningStepSectionMetadata)

Defined in: [WAProto/index.d.ts:1877](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1877)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotPlanningStepSectionMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningStepSectionMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1880](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1880)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1878](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1878)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotPlanningStepSectionMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/classes/BotPlanningStepSectionMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-botsearchsourceprovider"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/enumerations/BotSearchSourceProvider](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/enumerations/BotSearchSourceProvider)

Defined in: [WAProto/index.d.ts:1883](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1883)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### BING[​](#bing "Direct link to BING")

> **BING**: `3`

Defined in: [WAProto/index.d.ts:1887](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1887)

* * *

### GOOGLE[​](#google "Direct link to GOOGLE")

> **GOOGLE**: `2`

Defined in: [WAProto/index.d.ts:1886](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1886)

* * *

### OTHER[​](#other "Direct link to OTHER")

> **OTHER**: `1`

Defined in: [WAProto/index.d.ts:1885](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1885)

* * *

### UNKNOWN\_PROVIDER[​](#unknown_provider "Direct link to UNKNOWN_PROVIDER")

> **UNKNOWN\_PROVIDER**: `0`

Defined in: [WAProto/index.d.ts:1884](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1884)

---

<a name="enumeration-planningstepstatus"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/enumerations/PlanningStepStatus](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/enumerations/PlanningStepStatus)

Defined in: [WAProto/index.d.ts:1890](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1890)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### EXECUTING[​](#executing "Direct link to EXECUTING")

> **EXECUTING**: `2`

Defined in: [WAProto/index.d.ts:1893](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1893)

* * *

### FINISHED[​](#finished "Direct link to FINISHED")

> **FINISHED**: `3`

Defined in: [WAProto/index.d.ts:1894](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1894)

* * *

### PLANNED[​](#planned "Direct link to PLANNED")

> **PLANNED**: `1`

Defined in: [WAProto/index.d.ts:1892](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1892)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:1891](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1891)

---

<a name="interface-ibotplanningsearchsourcemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourceMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourceMetadata)

Defined in: [WAProto/index.d.ts:1811](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1811)

## Properties[​](#properties "Direct link to Properties")

### favIconUrl?[​](#faviconurl "Direct link to favIconUrl?")

> `optional` **favIconUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:1815](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1815)

* * *

### provider?[​](#provider "Direct link to provider?")

> `optional` **provider**: `null` | [`BotSearchSourceProvider`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/enumerations/BotSearchSourceProvider)

Defined in: [WAProto/index.d.ts:1813](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1813)

* * *

### sourceUrl?[​](#sourceurl "Direct link to sourceUrl?")

> `optional` **sourceUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:1814](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1814)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:1812](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1812)

---

<a name="interface-ibotplanningsearchsourcesmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourcesMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourcesMetadata)

Defined in: [WAProto/index.d.ts:1833](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1833)

## Properties[​](#properties "Direct link to Properties")

### provider?[​](#provider "Direct link to provider?")

> `optional` **provider**: `null` | [`BotPlanningSearchSourceProvider`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/namespaces/BotPlanningSearchSourcesMetadata/enumerations/BotPlanningSearchSourceProvider)

Defined in: [WAProto/index.d.ts:1835](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1835)

* * *

### sourceTitle?[​](#sourcetitle "Direct link to sourceTitle?")

> `optional` **sourceTitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:1834](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1834)

* * *

### sourceUrl?[​](#sourceurl "Direct link to sourceUrl?")

> `optional` **sourceUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:1836](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1836)

---

<a name="interface-ibotplanningstepsectionmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningStepSectionMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningStepSectionMetadata)

Defined in: [WAProto/index.d.ts:1863](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1863)

## Properties[​](#properties "Direct link to Properties")

### sectionBody?[​](#sectionbody "Direct link to sectionBody?")

> `optional` **sectionBody**: `null` | `string`

Defined in: [WAProto/index.d.ts:1865](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1865)

* * *

### sectionTitle?[​](#sectiontitle "Direct link to sectionTitle?")

> `optional` **sectionTitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:1864](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1864)

* * *

### sourcesMetadata?[​](#sourcesmetadata "Direct link to sourcesMetadata?")

> `optional` **sourcesMetadata**: `null` | [`IBotPlanningSearchSourceMetadata`](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/interfaces/IBotPlanningSearchSourceMetadata)\[\]

Defined in: [WAProto/index.d.ts:1866](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1866)

---

<a name="botplanningsearchsourcesmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/namespaces/BotPlanningSearchSourcesMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/namespaces/BotPlanningSearchSourcesMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [BotPlanningSearchSourceProvider](/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/namespaces/BotPlanningSearchSourcesMetadata/enumerations/BotPlanningSearchSourceProvider)

---

<a name="enumeration-botplanningsearchsourceprovider"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/namespaces/BotPlanningSearchSourcesMetadata/enumerations/BotPlanningSearchSourceProvider](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotProgressIndicatorMetadata/namespaces/BotPlanningStepMetadata/namespaces/BotPlanningSearchSourcesMetadata/enumerations/BotPlanningSearchSourceProvider)

Defined in: [WAProto/index.d.ts:1855](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1855)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### BING[​](#bing "Direct link to BING")

> **BING**: `3`

Defined in: [WAProto/index.d.ts:1859](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1859)

* * *

### GOOGLE[​](#google "Direct link to GOOGLE")

> **GOOGLE**: `2`

Defined in: [WAProto/index.d.ts:1858](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1858)

* * *

### OTHER[​](#other "Direct link to OTHER")

> **OTHER**: `1`

Defined in: [WAProto/index.d.ts:1857](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1857)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:1856](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1856)

---

<a name="botpromotionmessagemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotPromotionMessageMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotPromotionMessageMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [BotPromotionType](/docs/api/namespaces/proto/namespaces/BotPromotionMessageMetadata/enumerations/BotPromotionType)

---

<a name="enumeration-botpromotiontype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotPromotionMessageMetadata/enumerations/BotPromotionType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotPromotionMessageMetadata/enumerations/BotPromotionType)

Defined in: [WAProto/index.d.ts:1919](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1919)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### C50[​](#c50 "Direct link to C50")

> **C50**: `1`

Defined in: [WAProto/index.d.ts:1921](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1921)

* * *

### SURVEY\_PLATFORM[​](#survey_platform "Direct link to SURVEY_PLATFORM")

> **SURVEY\_PLATFORM**: `2`

Defined in: [WAProto/index.d.ts:1922](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1922)

* * *

### UNKNOWN\_TYPE[​](#unknown_type "Direct link to UNKNOWN_TYPE")

> **UNKNOWN\_TYPE**: `0`

Defined in: [WAProto/index.d.ts:1920](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1920)

---

<a name="botquotametadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [BotFeatureQuotaMetadata](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/namespaces/BotFeatureQuotaMetadata/)

## Classes[​](#classes "Direct link to Classes")

*   [BotFeatureQuotaMetadata](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/classes/BotFeatureQuotaMetadata)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IBotFeatureQuotaMetadata](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/interfaces/IBotFeatureQuotaMetadata)

---

<a name="class-botfeaturequotametadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/classes/BotFeatureQuotaMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/classes/BotFeatureQuotaMetadata)

Defined in: [WAProto/index.d.ts:1984](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1984)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotFeatureQuotaMetadata`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/interfaces/IBotFeatureQuotaMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotFeatureQuotaMetadata()[​](#new-botfeaturequotametadata "Direct link to new BotFeatureQuotaMetadata()")

> **new BotFeatureQuotaMetadata**(`p`?): [`BotFeatureQuotaMetadata`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/classes/BotFeatureQuotaMetadata)

Defined in: [WAProto/index.d.ts:1985](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1985)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotFeatureQuotaMetadata`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/interfaces/IBotFeatureQuotaMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`BotFeatureQuotaMetadata`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/classes/BotFeatureQuotaMetadata)

## Properties[​](#properties "Direct link to Properties")

### expirationTimestamp?[​](#expirationtimestamp "Direct link to expirationTimestamp?")

> `optional` **expirationTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:1988](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1988)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotFeatureQuotaMetadata`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/interfaces/IBotFeatureQuotaMetadata).[`expirationTimestamp`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/interfaces/IBotFeatureQuotaMetadata#expirationtimestamp)

* * *

### featureType?[​](#featuretype "Direct link to featureType?")

> `optional` **featureType**: `null` | [`BotFeatureType`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/namespaces/BotFeatureQuotaMetadata/enumerations/BotFeatureType)

Defined in: [WAProto/index.d.ts:1986](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1986)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotFeatureQuotaMetadata`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/interfaces/IBotFeatureQuotaMetadata).[`featureType`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/interfaces/IBotFeatureQuotaMetadata#featuretype)

* * *

### remainingQuota?[​](#remainingquota "Direct link to remainingQuota?")

> `optional` **remainingQuota**: `null` | `number`

Defined in: [WAProto/index.d.ts:1987](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1987)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBotFeatureQuotaMetadata`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/interfaces/IBotFeatureQuotaMetadata).[`remainingQuota`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/interfaces/IBotFeatureQuotaMetadata#remainingquota)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:1994](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1994)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotFeatureQuotaMetadata`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/classes/BotFeatureQuotaMetadata)

Defined in: [WAProto/index.d.ts:1989](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1989)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotFeatureQuotaMetadata`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/interfaces/IBotFeatureQuotaMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotFeatureQuotaMetadata`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/classes/BotFeatureQuotaMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotFeatureQuotaMetadata`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/classes/BotFeatureQuotaMetadata)

Defined in: [WAProto/index.d.ts:1991](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1991)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotFeatureQuotaMetadata`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/classes/BotFeatureQuotaMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:1990](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1990)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotFeatureQuotaMetadata`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/interfaces/IBotFeatureQuotaMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotFeatureQuotaMetadata`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/classes/BotFeatureQuotaMetadata)

Defined in: [WAProto/index.d.ts:1992](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1992)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotFeatureQuotaMetadata`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/classes/BotFeatureQuotaMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:1995](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1995)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:1993](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1993)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotFeatureQuotaMetadata`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/classes/BotFeatureQuotaMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ibotfeaturequotametadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/interfaces/IBotFeatureQuotaMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/interfaces/IBotFeatureQuotaMetadata)

Defined in: [WAProto/index.d.ts:1978](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1978)

## Properties[​](#properties "Direct link to Properties")

### expirationTimestamp?[​](#expirationtimestamp "Direct link to expirationTimestamp?")

> `optional` **expirationTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:1981](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1981)

* * *

### featureType?[​](#featuretype "Direct link to featureType?")

> `optional` **featureType**: `null` | [`BotFeatureType`](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/namespaces/BotFeatureQuotaMetadata/enumerations/BotFeatureType)

Defined in: [WAProto/index.d.ts:1979](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1979)

* * *

### remainingQuota?[​](#remainingquota "Direct link to remainingQuota?")

> `optional` **remainingQuota**: `null` | `number`

Defined in: [WAProto/index.d.ts:1980](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L1980)

---

<a name="botfeaturequotametadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/namespaces/BotFeatureQuotaMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/namespaces/BotFeatureQuotaMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [BotFeatureType](/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/namespaces/BotFeatureQuotaMetadata/enumerations/BotFeatureType)

---

<a name="enumeration-botfeaturetype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/namespaces/BotFeatureQuotaMetadata/enumerations/BotFeatureType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotQuotaMetadata/namespaces/BotFeatureQuotaMetadata/enumerations/BotFeatureType)

Defined in: [WAProto/index.d.ts:2000](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2000)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### REASONING\_FEATURE[​](#reasoning_feature "Direct link to REASONING_FEATURE")

> **REASONING\_FEATURE**: `1`

Defined in: [WAProto/index.d.ts:2002](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2002)

* * *

### UNKNOWN\_FEATURE[​](#unknown_feature "Direct link to UNKNOWN_FEATURE")

> **UNKNOWN\_FEATURE**: `0`

Defined in: [WAProto/index.d.ts:2001](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2001)

---

<a name="botremindermetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotReminderMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotReminderMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [ReminderAction](/docs/api/namespaces/proto/namespaces/BotReminderMetadata/enumerations/ReminderAction)
*   [ReminderFrequency](/docs/api/namespaces/proto/namespaces/BotReminderMetadata/enumerations/ReminderFrequency)

---

<a name="enumeration-reminderaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotReminderMetadata/enumerations/ReminderAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotReminderMetadata/enumerations/ReminderAction)

Defined in: [WAProto/index.d.ts:2033](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2033)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### CREATE[​](#create "Direct link to CREATE")

> **CREATE**: `2`

Defined in: [WAProto/index.d.ts:2035](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2035)

* * *

### DELETE[​](#delete "Direct link to DELETE")

> **DELETE**: `3`

Defined in: [WAProto/index.d.ts:2036](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2036)

* * *

### NOTIFY[​](#notify "Direct link to NOTIFY")

> **NOTIFY**: `1`

Defined in: [WAProto/index.d.ts:2034](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2034)

* * *

### UPDATE[​](#update "Direct link to UPDATE")

> **UPDATE**: `4`

Defined in: [WAProto/index.d.ts:2037](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2037)

---

<a name="enumeration-reminderfrequency"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotReminderMetadata/enumerations/ReminderFrequency](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotReminderMetadata/enumerations/ReminderFrequency)

Defined in: [WAProto/index.d.ts:2040](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2040)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### BIWEEKLY[​](#biweekly "Direct link to BIWEEKLY")

> **BIWEEKLY**: `4`

Defined in: [WAProto/index.d.ts:2044](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2044)

* * *

### DAILY[​](#daily "Direct link to DAILY")

> **DAILY**: `2`

Defined in: [WAProto/index.d.ts:2042](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2042)

* * *

### MONTHLY[​](#monthly "Direct link to MONTHLY")

> **MONTHLY**: `5`

Defined in: [WAProto/index.d.ts:2045](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2045)

* * *

### ONCE[​](#once "Direct link to ONCE")

> **ONCE**: `1`

Defined in: [WAProto/index.d.ts:2041](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2041)

* * *

### WEEKLY[​](#weekly "Direct link to WEEKLY")

> **WEEKLY**: `3`

Defined in: [WAProto/index.d.ts:2043](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2043)

---

<a name="botrenderingmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/)

## Classes[​](#classes "Direct link to Classes")

*   [Keyword](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/classes/Keyword)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IKeyword](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/interfaces/IKeyword)

---

<a name="class-keyword"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/classes/Keyword](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/classes/Keyword)

Defined in: [WAProto/index.d.ts:2072](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2072)

## Implements[​](#implements "Direct link to Implements")

*   [`IKeyword`](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/interfaces/IKeyword)

## Constructors[​](#constructors "Direct link to Constructors")

### new Keyword()[​](#new-keyword "Direct link to new Keyword()")

> **new Keyword**(`p`?): [`Keyword`](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/classes/Keyword)

Defined in: [WAProto/index.d.ts:2073](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2073)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IKeyword`](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/interfaces/IKeyword)

#### Returns[​](#returns "Direct link to Returns")

[`Keyword`](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/classes/Keyword)

## Properties[​](#properties "Direct link to Properties")

### associatedPrompts[​](#associatedprompts "Direct link to associatedPrompts")

> **associatedPrompts**: `string`\[\]

Defined in: [WAProto/index.d.ts:2075](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2075)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IKeyword`](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/interfaces/IKeyword).[`associatedPrompts`](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/interfaces/IKeyword#associatedprompts)

* * *

### value?[​](#value "Direct link to value?")

> `optional` **value**: `null` | `string`

Defined in: [WAProto/index.d.ts:2074](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2074)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IKeyword`](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/interfaces/IKeyword).[`value`](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/interfaces/IKeyword#value)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2081](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2081)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Keyword`](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/classes/Keyword)

Defined in: [WAProto/index.d.ts:2076](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2076)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IKeyword`](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/interfaces/IKeyword)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Keyword`](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/classes/Keyword)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Keyword`](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/classes/Keyword)

Defined in: [WAProto/index.d.ts:2078](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2078)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Keyword`](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/classes/Keyword)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2077](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2077)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IKeyword`](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/interfaces/IKeyword)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Keyword`](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/classes/Keyword)

Defined in: [WAProto/index.d.ts:2079](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2079)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Keyword`](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/classes/Keyword)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2082](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2082)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2080](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2080)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Keyword`](/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/classes/Keyword)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ikeyword"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/interfaces/IKeyword](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotRenderingMetadata/interfaces/IKeyword)

Defined in: [WAProto/index.d.ts:2067](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2067)

## Properties[​](#properties "Direct link to Properties")

### associatedPrompts?[​](#associatedprompts "Direct link to associatedPrompts?")

> `optional` **associatedPrompts**: `null` | `string`\[\]

Defined in: [WAProto/index.d.ts:2069](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2069)

* * *

### value?[​](#value "Direct link to value?")

> `optional` **value**: `null` | `string`

Defined in: [WAProto/index.d.ts:2068](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2068)

---

<a name="botsignatureverificationusecaseproof"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotSignatureVerificationUseCaseProof/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotSignatureVerificationUseCaseProof/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [BotSignatureUseCase](/docs/api/namespaces/proto/namespaces/BotSignatureVerificationUseCaseProof/enumerations/BotSignatureUseCase)

---

<a name="enumeration-botsignatureusecase"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotSignatureVerificationUseCaseProof/enumerations/BotSignatureUseCase](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotSignatureVerificationUseCaseProof/enumerations/BotSignatureUseCase)

Defined in: [WAProto/index.d.ts:2154](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2154)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### UNSPECIFIED[​](#unspecified "Direct link to UNSPECIFIED")

> **UNSPECIFIED**: `0`

Defined in: [WAProto/index.d.ts:2155](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2155)

* * *

### WA\_BOT\_MSG[​](#wa_bot_msg "Direct link to WA_BOT_MSG")

> **WA\_BOT\_MSG**: `1`

Defined in: [WAProto/index.d.ts:2156](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2156)

---

<a name="botsourcesmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [BotSourceItem](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/namespaces/BotSourceItem/)

## Classes[​](#classes "Direct link to Classes")

*   [BotSourceItem](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/classes/BotSourceItem)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IBotSourceItem](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem)

---

<a name="class-botsourceitem"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/classes/BotSourceItem](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/classes/BotSourceItem)

Defined in: [WAProto/index.d.ts:2188](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2188)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotSourceItem()[​](#new-botsourceitem "Direct link to new BotSourceItem()")

> **new BotSourceItem**(`p`?): [`BotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/classes/BotSourceItem)

Defined in: [WAProto/index.d.ts:2189](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2189)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem)

#### Returns[​](#returns "Direct link to Returns")

[`BotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/classes/BotSourceItem)

## Properties[​](#properties "Direct link to Properties")

### citationNumber?[​](#citationnumber "Direct link to citationNumber?")

> `optional` **citationNumber**: `null` | `number`

Defined in: [WAProto/index.d.ts:2195](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2195)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem).[`citationNumber`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem#citationnumber)

* * *

### faviconCdnUrl?[​](#faviconcdnurl "Direct link to faviconCdnUrl?")

> `optional` **faviconCdnUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:2194](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2194)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem).[`faviconCdnUrl`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem#faviconcdnurl)

* * *

### provider?[​](#provider "Direct link to provider?")

> `optional` **provider**: `null` | [`SourceProvider`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/namespaces/BotSourceItem/enumerations/SourceProvider)

Defined in: [WAProto/index.d.ts:2190](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2190)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem).[`provider`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem#provider)

* * *

### sourceProviderUrl?[​](#sourceproviderurl "Direct link to sourceProviderUrl?")

> `optional` **sourceProviderUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:2192](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2192)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IBotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem).[`sourceProviderUrl`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem#sourceproviderurl)

* * *

### sourceQuery?[​](#sourcequery "Direct link to sourceQuery?")

> `optional` **sourceQuery**: `null` | `string`

Defined in: [WAProto/index.d.ts:2193](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2193)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IBotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem).[`sourceQuery`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem#sourcequery)

* * *

### sourceTitle?[​](#sourcetitle "Direct link to sourceTitle?")

> `optional` **sourceTitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:2196](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2196)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IBotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem).[`sourceTitle`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem#sourcetitle)

* * *

### thumbnailCdnUrl?[​](#thumbnailcdnurl "Direct link to thumbnailCdnUrl?")

> `optional` **thumbnailCdnUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:2191](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2191)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IBotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem).[`thumbnailCdnUrl`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem#thumbnailcdnurl)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2202](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2202)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/classes/BotSourceItem)

Defined in: [WAProto/index.d.ts:2197](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2197)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/classes/BotSourceItem)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/classes/BotSourceItem)

Defined in: [WAProto/index.d.ts:2199](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2199)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/classes/BotSourceItem)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2198](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2198)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/classes/BotSourceItem)

Defined in: [WAProto/index.d.ts:2200](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2200)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/classes/BotSourceItem)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2203](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2203)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2201](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2201)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotSourceItem`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/classes/BotSourceItem)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ibotsourceitem"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/interfaces/IBotSourceItem)

Defined in: [WAProto/index.d.ts:2178](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2178)

## Properties[​](#properties "Direct link to Properties")

### citationNumber?[​](#citationnumber "Direct link to citationNumber?")

> `optional` **citationNumber**: `null` | `number`

Defined in: [WAProto/index.d.ts:2184](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2184)

* * *

### faviconCdnUrl?[​](#faviconcdnurl "Direct link to faviconCdnUrl?")

> `optional` **faviconCdnUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:2183](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2183)

* * *

### provider?[​](#provider "Direct link to provider?")

> `optional` **provider**: `null` | [`SourceProvider`](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/namespaces/BotSourceItem/enumerations/SourceProvider)

Defined in: [WAProto/index.d.ts:2179](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2179)

* * *

### sourceProviderUrl?[​](#sourceproviderurl "Direct link to sourceProviderUrl?")

> `optional` **sourceProviderUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:2181](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2181)

* * *

### sourceQuery?[​](#sourcequery "Direct link to sourceQuery?")

> `optional` **sourceQuery**: `null` | `string`

Defined in: [WAProto/index.d.ts:2182](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2182)

* * *

### sourceTitle?[​](#sourcetitle "Direct link to sourceTitle?")

> `optional` **sourceTitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:2185](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2185)

* * *

### thumbnailCdnUrl?[​](#thumbnailcdnurl "Direct link to thumbnailCdnUrl?")

> `optional` **thumbnailCdnUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:2180](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2180)

---

<a name="botsourceitem"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/namespaces/BotSourceItem/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/namespaces/BotSourceItem/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [SourceProvider](/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/namespaces/BotSourceItem/enumerations/SourceProvider)

---

<a name="enumeration-sourceprovider"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/namespaces/BotSourceItem/enumerations/SourceProvider](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotSourcesMetadata/namespaces/BotSourceItem/enumerations/SourceProvider)

Defined in: [WAProto/index.d.ts:2208](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2208)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### BING[​](#bing "Direct link to BING")

> **BING**: `1`

Defined in: [WAProto/index.d.ts:2210](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2210)

* * *

### GOOGLE[​](#google "Direct link to GOOGLE")

> **GOOGLE**: `2`

Defined in: [WAProto/index.d.ts:2211](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2211)

* * *

### OTHER[​](#other "Direct link to OTHER")

> **OTHER**: `4`

Defined in: [WAProto/index.d.ts:2213](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2213)

* * *

### SUPPORT[​](#support "Direct link to SUPPORT")

> **SUPPORT**: `3`

Defined in: [WAProto/index.d.ts:2212](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2212)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:2209](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2209)

---

<a name="botunifiedresponsemutation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/)

## Classes[​](#classes "Direct link to Classes")

*   [MediaDetailsMetadata](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/MediaDetailsMetadata)
*   [SideBySideMetadata](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/SideBySideMetadata)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IMediaDetailsMetadata](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/IMediaDetailsMetadata)
*   [ISideBySideMetadata](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/ISideBySideMetadata)

---

<a name="class-mediadetailsmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/MediaDetailsMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/MediaDetailsMetadata)

Defined in: [WAProto/index.d.ts:2266](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2266)

## Implements[​](#implements "Direct link to Implements")

*   [`IMediaDetailsMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/IMediaDetailsMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new MediaDetailsMetadata()[​](#new-mediadetailsmetadata "Direct link to new MediaDetailsMetadata()")

> **new MediaDetailsMetadata**(`p`?): [`MediaDetailsMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/MediaDetailsMetadata)

Defined in: [WAProto/index.d.ts:2267](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2267)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMediaDetailsMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/IMediaDetailsMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`MediaDetailsMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/MediaDetailsMetadata)

## Properties[​](#properties "Direct link to Properties")

### highResMedia?[​](#highresmedia "Direct link to highResMedia?")

> `optional` **highResMedia**: `null` | [`IBotMediaMetadata`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata)

Defined in: [WAProto/index.d.ts:2269](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2269)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMediaDetailsMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/IMediaDetailsMetadata).[`highResMedia`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/IMediaDetailsMetadata#highresmedia)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:2268](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2268)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMediaDetailsMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/IMediaDetailsMetadata).[`id`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/IMediaDetailsMetadata#id)

* * *

### previewMedia?[​](#previewmedia "Direct link to previewMedia?")

> `optional` **previewMedia**: `null` | [`IBotMediaMetadata`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata)

Defined in: [WAProto/index.d.ts:2270](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2270)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMediaDetailsMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/IMediaDetailsMetadata).[`previewMedia`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/IMediaDetailsMetadata#previewmedia)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2276](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2276)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MediaDetailsMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/MediaDetailsMetadata)

Defined in: [WAProto/index.d.ts:2271](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2271)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMediaDetailsMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/IMediaDetailsMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MediaDetailsMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/MediaDetailsMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MediaDetailsMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/MediaDetailsMetadata)

Defined in: [WAProto/index.d.ts:2273](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2273)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MediaDetailsMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/MediaDetailsMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2272](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2272)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMediaDetailsMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/IMediaDetailsMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MediaDetailsMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/MediaDetailsMetadata)

Defined in: [WAProto/index.d.ts:2274](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2274)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MediaDetailsMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/MediaDetailsMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2277](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2277)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2275](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2275)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MediaDetailsMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/MediaDetailsMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-sidebysidemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/SideBySideMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/SideBySideMetadata)

Defined in: [WAProto/index.d.ts:2285](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2285)

## Implements[​](#implements "Direct link to Implements")

*   [`ISideBySideMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/ISideBySideMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new SideBySideMetadata()[​](#new-sidebysidemetadata "Direct link to new SideBySideMetadata()")

> **new SideBySideMetadata**(`p`?): [`SideBySideMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/SideBySideMetadata)

Defined in: [WAProto/index.d.ts:2286](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2286)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISideBySideMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/ISideBySideMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`SideBySideMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/SideBySideMetadata)

## Properties[​](#properties "Direct link to Properties")

### primaryResponseId?[​](#primaryresponseid "Direct link to primaryResponseId?")

> `optional` **primaryResponseId**: `null` | `string`

Defined in: [WAProto/index.d.ts:2287](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2287)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISideBySideMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/ISideBySideMetadata).[`primaryResponseId`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/ISideBySideMetadata#primaryresponseid)

* * *

### surveyCtaHasRendered?[​](#surveyctahasrendered "Direct link to surveyCtaHasRendered?")

> `optional` **surveyCtaHasRendered**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2288](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2288)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISideBySideMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/ISideBySideMetadata).[`surveyCtaHasRendered`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/ISideBySideMetadata#surveyctahasrendered)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2294](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2294)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SideBySideMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/SideBySideMetadata)

Defined in: [WAProto/index.d.ts:2289](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2289)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISideBySideMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/ISideBySideMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SideBySideMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/SideBySideMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SideBySideMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/SideBySideMetadata)

Defined in: [WAProto/index.d.ts:2291](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2291)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SideBySideMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/SideBySideMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2290](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2290)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISideBySideMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/ISideBySideMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SideBySideMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/SideBySideMetadata)

Defined in: [WAProto/index.d.ts:2292](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2292)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SideBySideMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/SideBySideMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2295](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2295)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2293](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2293)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SideBySideMetadata`](/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/classes/SideBySideMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-imediadetailsmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/IMediaDetailsMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/IMediaDetailsMetadata)

Defined in: [WAProto/index.d.ts:2260](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2260)

## Properties[​](#properties "Direct link to Properties")

### highResMedia?[​](#highresmedia "Direct link to highResMedia?")

> `optional` **highResMedia**: `null` | [`IBotMediaMetadata`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata)

Defined in: [WAProto/index.d.ts:2262](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2262)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:2261](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2261)

* * *

### previewMedia?[​](#previewmedia "Direct link to previewMedia?")

> `optional` **previewMedia**: `null` | [`IBotMediaMetadata`](/docs/api/namespaces/proto/interfaces/IBotMediaMetadata)

Defined in: [WAProto/index.d.ts:2263](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2263)

---

<a name="interface-isidebysidemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/ISideBySideMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/BotUnifiedResponseMutation/interfaces/ISideBySideMetadata)

Defined in: [WAProto/index.d.ts:2280](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2280)

## Properties[​](#properties "Direct link to Properties")

### primaryResponseId?[​](#primaryresponseid "Direct link to primaryResponseId?")

> `optional` **primaryResponseId**: `null` | `string`

Defined in: [WAProto/index.d.ts:2281](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2281)

* * *

### surveyCtaHasRendered?[​](#surveyctahasrendered "Direct link to surveyCtaHasRendered?")

> `optional` **surveyCtaHasRendered**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2282](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2282)

---

<a name="calllogrecord"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/CallLogRecord/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/CallLogRecord/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [CallResult](/docs/api/namespaces/proto/namespaces/CallLogRecord/enumerations/CallResult)
*   [CallType](/docs/api/namespaces/proto/namespaces/CallLogRecord/enumerations/CallType)
*   [SilenceReason](/docs/api/namespaces/proto/namespaces/CallLogRecord/enumerations/SilenceReason)

## Classes[​](#classes "Direct link to Classes")

*   [ParticipantInfo](/docs/api/namespaces/proto/namespaces/CallLogRecord/classes/ParticipantInfo)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IParticipantInfo](/docs/api/namespaces/proto/namespaces/CallLogRecord/interfaces/IParticipantInfo)

---

<a name="class-participantinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/CallLogRecord/classes/ParticipantInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/CallLogRecord/classes/ParticipantInfo)

Defined in: [WAProto/index.d.ts:2370](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2370)

## Implements[​](#implements "Direct link to Implements")

*   [`IParticipantInfo`](/docs/api/namespaces/proto/namespaces/CallLogRecord/interfaces/IParticipantInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new ParticipantInfo()[​](#new-participantinfo "Direct link to new ParticipantInfo()")

> **new ParticipantInfo**(`p`?): [`ParticipantInfo`](/docs/api/namespaces/proto/namespaces/CallLogRecord/classes/ParticipantInfo)

Defined in: [WAProto/index.d.ts:2371](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2371)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IParticipantInfo`](/docs/api/namespaces/proto/namespaces/CallLogRecord/interfaces/IParticipantInfo)

#### Returns[​](#returns "Direct link to Returns")

[`ParticipantInfo`](/docs/api/namespaces/proto/namespaces/CallLogRecord/classes/ParticipantInfo)

## Properties[​](#properties "Direct link to Properties")

### callResult?[​](#callresult "Direct link to callResult?")

> `optional` **callResult**: `null` | [`CallResult`](/docs/api/namespaces/proto/namespaces/CallLogRecord/enumerations/CallResult)

Defined in: [WAProto/index.d.ts:2373](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2373)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IParticipantInfo`](/docs/api/namespaces/proto/namespaces/CallLogRecord/interfaces/IParticipantInfo).[`callResult`](/docs/api/namespaces/proto/namespaces/CallLogRecord/interfaces/IParticipantInfo#callresult)

* * *

### userJid?[​](#userjid "Direct link to userJid?")

> `optional` **userJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:2372](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2372)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IParticipantInfo`](/docs/api/namespaces/proto/namespaces/CallLogRecord/interfaces/IParticipantInfo).[`userJid`](/docs/api/namespaces/proto/namespaces/CallLogRecord/interfaces/IParticipantInfo#userjid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2379](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2379)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ParticipantInfo`](/docs/api/namespaces/proto/namespaces/CallLogRecord/classes/ParticipantInfo)

Defined in: [WAProto/index.d.ts:2374](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2374)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IParticipantInfo`](/docs/api/namespaces/proto/namespaces/CallLogRecord/interfaces/IParticipantInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ParticipantInfo`](/docs/api/namespaces/proto/namespaces/CallLogRecord/classes/ParticipantInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ParticipantInfo`](/docs/api/namespaces/proto/namespaces/CallLogRecord/classes/ParticipantInfo)

Defined in: [WAProto/index.d.ts:2376](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2376)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ParticipantInfo`](/docs/api/namespaces/proto/namespaces/CallLogRecord/classes/ParticipantInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2375](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2375)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IParticipantInfo`](/docs/api/namespaces/proto/namespaces/CallLogRecord/interfaces/IParticipantInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ParticipantInfo`](/docs/api/namespaces/proto/namespaces/CallLogRecord/classes/ParticipantInfo)

Defined in: [WAProto/index.d.ts:2377](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2377)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ParticipantInfo`](/docs/api/namespaces/proto/namespaces/CallLogRecord/classes/ParticipantInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2380](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2380)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2378](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2378)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ParticipantInfo`](/docs/api/namespaces/proto/namespaces/CallLogRecord/classes/ParticipantInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-callresult"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/CallLogRecord/enumerations/CallResult](https://baileys.wiki/docs/api/namespaces/proto/namespaces/CallLogRecord/enumerations/CallResult)

Defined in: [WAProto/index.d.ts:2345](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2345)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### ABANDONED[​](#abandoned "Direct link to ABANDONED")

> **ABANDONED**: `9`

Defined in: [WAProto/index.d.ts:2355](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2355)

* * *

### ACCEPTEDELSEWHERE[​](#acceptedelsewhere "Direct link to ACCEPTEDELSEWHERE")

> **ACCEPTEDELSEWHERE**: `3`

Defined in: [WAProto/index.d.ts:2349](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2349)

* * *

### CANCELLED[​](#cancelled "Direct link to CANCELLED")

> **CANCELLED**: `2`

Defined in: [WAProto/index.d.ts:2348](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2348)

* * *

### CONNECTED[​](#connected "Direct link to CONNECTED")

> **CONNECTED**: `0`

Defined in: [WAProto/index.d.ts:2346](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2346)

* * *

### FAILED[​](#failed "Direct link to FAILED")

> **FAILED**: `8`

Defined in: [WAProto/index.d.ts:2354](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2354)

* * *

### INVALID[​](#invalid "Direct link to INVALID")

> **INVALID**: `5`

Defined in: [WAProto/index.d.ts:2351](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2351)

* * *

### MISSED[​](#missed "Direct link to MISSED")

> **MISSED**: `4`

Defined in: [WAProto/index.d.ts:2350](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2350)

* * *

### ONGOING[​](#ongoing "Direct link to ONGOING")

> **ONGOING**: `10`

Defined in: [WAProto/index.d.ts:2356](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2356)

* * *

### REJECTED[​](#rejected "Direct link to REJECTED")

> **REJECTED**: `1`

Defined in: [WAProto/index.d.ts:2347](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2347)

* * *

### UNAVAILABLE[​](#unavailable "Direct link to UNAVAILABLE")

> **UNAVAILABLE**: `6`

Defined in: [WAProto/index.d.ts:2352](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2352)

* * *

### UPCOMING[​](#upcoming "Direct link to UPCOMING")

> **UPCOMING**: `7`

Defined in: [WAProto/index.d.ts:2353](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2353)

---

<a name="enumeration-calltype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/CallLogRecord/enumerations/CallType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/CallLogRecord/enumerations/CallType)

Defined in: [WAProto/index.d.ts:2359](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2359)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### REGULAR[​](#regular "Direct link to REGULAR")

> **REGULAR**: `0`

Defined in: [WAProto/index.d.ts:2360](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2360)

* * *

### SCHEDULED\_CALL[​](#scheduled_call "Direct link to SCHEDULED_CALL")

> **SCHEDULED\_CALL**: `1`

Defined in: [WAProto/index.d.ts:2361](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2361)

* * *

### VOICE\_CHAT[​](#voice_chat "Direct link to VOICE_CHAT")

> **VOICE\_CHAT**: `2`

Defined in: [WAProto/index.d.ts:2362](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2362)

---

<a name="enumeration-silencereason"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/CallLogRecord/enumerations/SilenceReason](https://baileys.wiki/docs/api/namespaces/proto/namespaces/CallLogRecord/enumerations/SilenceReason)

Defined in: [WAProto/index.d.ts:2383](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2383)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### LIGHTWEIGHT[​](#lightweight "Direct link to LIGHTWEIGHT")

> **LIGHTWEIGHT**: `3`

Defined in: [WAProto/index.d.ts:2387](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2387)

* * *

### NONE[​](#none "Direct link to NONE")

> **NONE**: `0`

Defined in: [WAProto/index.d.ts:2384](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2384)

* * *

### PRIVACY[​](#privacy "Direct link to PRIVACY")

> **PRIVACY**: `2`

Defined in: [WAProto/index.d.ts:2386](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2386)

* * *

### SCHEDULED[​](#scheduled "Direct link to SCHEDULED")

> **SCHEDULED**: `1`

Defined in: [WAProto/index.d.ts:2385](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2385)

---

<a name="interface-iparticipantinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/CallLogRecord/interfaces/IParticipantInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/CallLogRecord/interfaces/IParticipantInfo)

Defined in: [WAProto/index.d.ts:2365](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2365)

## Properties[​](#properties "Direct link to Properties")

### callResult?[​](#callresult "Direct link to callResult?")

> `optional` **callResult**: `null` | [`CallResult`](/docs/api/namespaces/proto/namespaces/CallLogRecord/enumerations/CallResult)

Defined in: [WAProto/index.d.ts:2367](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2367)

* * *

### userJid?[​](#userjid "Direct link to userJid?")

> `optional` **userJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:2366](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2366)

---

<a name="certchain"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/CertChain/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/CertChain/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [NoiseCertificate](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/)

## Classes[​](#classes "Direct link to Classes")

*   [NoiseCertificate](/docs/api/namespaces/proto/namespaces/CertChain/classes/NoiseCertificate)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [INoiseCertificate](/docs/api/namespaces/proto/namespaces/CertChain/interfaces/INoiseCertificate)

---

<a name="class-noisecertificate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/CertChain/classes/NoiseCertificate](https://baileys.wiki/docs/api/namespaces/proto/namespaces/CertChain/classes/NoiseCertificate)

Defined in: [WAProto/index.d.ts:2416](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2416)

## Implements[​](#implements "Direct link to Implements")

*   [`INoiseCertificate`](/docs/api/namespaces/proto/namespaces/CertChain/interfaces/INoiseCertificate)

## Constructors[​](#constructors "Direct link to Constructors")

### new NoiseCertificate()[​](#new-noisecertificate "Direct link to new NoiseCertificate()")

> **new NoiseCertificate**(`p`?): [`NoiseCertificate`](/docs/api/namespaces/proto/namespaces/CertChain/classes/NoiseCertificate)

Defined in: [WAProto/index.d.ts:2417](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2417)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`INoiseCertificate`](/docs/api/namespaces/proto/namespaces/CertChain/interfaces/INoiseCertificate)

#### Returns[​](#returns "Direct link to Returns")

[`NoiseCertificate`](/docs/api/namespaces/proto/namespaces/CertChain/classes/NoiseCertificate)

## Properties[​](#properties "Direct link to Properties")

### details?[​](#details "Direct link to details?")

> `optional` **details**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2418](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2418)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`INoiseCertificate`](/docs/api/namespaces/proto/namespaces/CertChain/interfaces/INoiseCertificate).[`details`](/docs/api/namespaces/proto/namespaces/CertChain/interfaces/INoiseCertificate#details)

* * *

### signature?[​](#signature "Direct link to signature?")

> `optional` **signature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2419](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2419)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`INoiseCertificate`](/docs/api/namespaces/proto/namespaces/CertChain/interfaces/INoiseCertificate).[`signature`](/docs/api/namespaces/proto/namespaces/CertChain/interfaces/INoiseCertificate#signature)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2425](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2425)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`NoiseCertificate`](/docs/api/namespaces/proto/namespaces/CertChain/classes/NoiseCertificate)

Defined in: [WAProto/index.d.ts:2420](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2420)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`INoiseCertificate`](/docs/api/namespaces/proto/namespaces/CertChain/interfaces/INoiseCertificate)

#### Returns[​](#returns-2 "Direct link to Returns")

[`NoiseCertificate`](/docs/api/namespaces/proto/namespaces/CertChain/classes/NoiseCertificate)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`NoiseCertificate`](/docs/api/namespaces/proto/namespaces/CertChain/classes/NoiseCertificate)

Defined in: [WAProto/index.d.ts:2422](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2422)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`NoiseCertificate`](/docs/api/namespaces/proto/namespaces/CertChain/classes/NoiseCertificate)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2421](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2421)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`INoiseCertificate`](/docs/api/namespaces/proto/namespaces/CertChain/interfaces/INoiseCertificate)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`NoiseCertificate`](/docs/api/namespaces/proto/namespaces/CertChain/classes/NoiseCertificate)

Defined in: [WAProto/index.d.ts:2423](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2423)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`NoiseCertificate`](/docs/api/namespaces/proto/namespaces/CertChain/classes/NoiseCertificate)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2426](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2426)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2424](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2424)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`NoiseCertificate`](/docs/api/namespaces/proto/namespaces/CertChain/classes/NoiseCertificate)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-inoisecertificate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/CertChain/interfaces/INoiseCertificate](https://baileys.wiki/docs/api/namespaces/proto/namespaces/CertChain/interfaces/INoiseCertificate)

Defined in: [WAProto/index.d.ts:2411](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2411)

## Properties[​](#properties "Direct link to Properties")

### details?[​](#details "Direct link to details?")

> `optional` **details**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2412](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2412)

* * *

### signature?[​](#signature "Direct link to signature?")

> `optional` **signature**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2413](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2413)

---

<a name="noisecertificate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/)

## Classes[​](#classes "Direct link to Classes")

*   [Details](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/classes/Details)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IDetails](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/interfaces/IDetails)

---

<a name="class-details"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/classes/Details](https://baileys.wiki/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/classes/Details)

Defined in: [WAProto/index.d.ts:2439](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2439)

## Implements[​](#implements "Direct link to Implements")

*   [`IDetails`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/interfaces/IDetails)

## Constructors[​](#constructors "Direct link to Constructors")

### new Details()[​](#new-details "Direct link to new Details()")

> **new Details**(`p`?): [`Details`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/classes/Details)

Defined in: [WAProto/index.d.ts:2440](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2440)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IDetails`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/interfaces/IDetails)

#### Returns[​](#returns "Direct link to Returns")

[`Details`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/classes/Details)

## Properties[​](#properties "Direct link to Properties")

### issuerSerial?[​](#issuerserial "Direct link to issuerSerial?")

> `optional` **issuerSerial**: `null` | `number`

Defined in: [WAProto/index.d.ts:2442](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2442)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IDetails`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/interfaces/IDetails).[`issuerSerial`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/interfaces/IDetails#issuerserial)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2443](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2443)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IDetails`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/interfaces/IDetails).[`key`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/interfaces/IDetails#key)

* * *

### notAfter?[​](#notafter "Direct link to notAfter?")

> `optional` **notAfter**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:2445](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2445)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IDetails`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/interfaces/IDetails).[`notAfter`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/interfaces/IDetails#notafter)

* * *

### notBefore?[​](#notbefore "Direct link to notBefore?")

> `optional` **notBefore**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:2444](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2444)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IDetails`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/interfaces/IDetails).[`notBefore`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/interfaces/IDetails#notbefore)

* * *

### serial?[​](#serial "Direct link to serial?")

> `optional` **serial**: `null` | `number`

Defined in: [WAProto/index.d.ts:2441](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2441)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IDetails`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/interfaces/IDetails).[`serial`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/interfaces/IDetails#serial)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2451](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2451)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Details`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/classes/Details)

Defined in: [WAProto/index.d.ts:2446](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2446)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IDetails`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/interfaces/IDetails)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Details`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/classes/Details)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Details`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/classes/Details)

Defined in: [WAProto/index.d.ts:2448](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2448)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Details`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/classes/Details)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2447](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2447)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IDetails`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/interfaces/IDetails)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Details`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/classes/Details)

Defined in: [WAProto/index.d.ts:2449](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2449)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Details`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/classes/Details)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2452](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2452)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2450](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2450)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Details`](/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/classes/Details)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-idetails"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/interfaces/IDetails](https://baileys.wiki/docs/api/namespaces/proto/namespaces/CertChain/namespaces/NoiseCertificate/interfaces/IDetails)

Defined in: [WAProto/index.d.ts:2431](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2431)

## Properties[​](#properties "Direct link to Properties")

### issuerSerial?[​](#issuerserial "Direct link to issuerSerial?")

> `optional` **issuerSerial**: `null` | `number`

Defined in: [WAProto/index.d.ts:2433](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2433)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2434](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2434)

* * *

### notAfter?[​](#notafter "Direct link to notAfter?")

> `optional` **notAfter**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:2436](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2436)

* * *

### notBefore?[​](#notbefore "Direct link to notBefore?")

> `optional` **notBefore**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:2435](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2435)

* * *

### serial?[​](#serial "Direct link to serial?")

> `optional` **serial**: `null` | `number`

Defined in: [WAProto/index.d.ts:2432](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2432)

---

<a name="chatrowopaquedata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [DraftMessage](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/)

## Classes[​](#classes "Direct link to Classes")

*   [DraftMessage](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/classes/DraftMessage)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IDraftMessage](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/interfaces/IDraftMessage)

---

<a name="class-draftmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/classes/DraftMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/classes/DraftMessage)

Defined in: [WAProto/index.d.ts:2501](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2501)

## Implements[​](#implements "Direct link to Implements")

*   [`IDraftMessage`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/interfaces/IDraftMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new DraftMessage()[​](#new-draftmessage "Direct link to new DraftMessage()")

> **new DraftMessage**(`p`?): [`DraftMessage`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/classes/DraftMessage)

Defined in: [WAProto/index.d.ts:2502](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2502)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IDraftMessage`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/interfaces/IDraftMessage)

#### Returns[​](#returns "Direct link to Returns")

[`DraftMessage`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/classes/DraftMessage)

## Properties[​](#properties "Direct link to Properties")

### ctwaContext?[​](#ctwacontext "Direct link to ctwaContext?")

> `optional` **ctwaContext**: `null` | [`ICtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData)

Defined in: [WAProto/index.d.ts:2506](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2506)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IDraftMessage`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/interfaces/IDraftMessage).[`ctwaContext`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/interfaces/IDraftMessage#ctwacontext)

* * *

### ctwaContextLinkData?[​](#ctwacontextlinkdata "Direct link to ctwaContextLinkData?")

> `optional` **ctwaContextLinkData**: `null` | [`ICtwaContextLinkData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextLinkData)

Defined in: [WAProto/index.d.ts:2505](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2505)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IDraftMessage`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/interfaces/IDraftMessage).[`ctwaContextLinkData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/interfaces/IDraftMessage#ctwacontextlinkdata)

* * *

### omittedUrl?[​](#omittedurl "Direct link to omittedUrl?")

> `optional` **omittedUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:2504](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2504)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IDraftMessage`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/interfaces/IDraftMessage).[`omittedUrl`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/interfaces/IDraftMessage#omittedurl)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:2503](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2503)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IDraftMessage`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/interfaces/IDraftMessage).[`text`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/interfaces/IDraftMessage#text)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:2507](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2507)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IDraftMessage`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/interfaces/IDraftMessage).[`timestamp`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/interfaces/IDraftMessage#timestamp)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2513](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2513)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`DraftMessage`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/classes/DraftMessage)

Defined in: [WAProto/index.d.ts:2508](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2508)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IDraftMessage`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/interfaces/IDraftMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`DraftMessage`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/classes/DraftMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`DraftMessage`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/classes/DraftMessage)

Defined in: [WAProto/index.d.ts:2510](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2510)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`DraftMessage`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/classes/DraftMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2509](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2509)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IDraftMessage`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/interfaces/IDraftMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`DraftMessage`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/classes/DraftMessage)

Defined in: [WAProto/index.d.ts:2511](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2511)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`DraftMessage`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/classes/DraftMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2514](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2514)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2512](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2512)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`DraftMessage`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/classes/DraftMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-idraftmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/interfaces/IDraftMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/interfaces/IDraftMessage)

Defined in: [WAProto/index.d.ts:2493](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2493)

## Properties[​](#properties "Direct link to Properties")

### ctwaContext?[​](#ctwacontext "Direct link to ctwaContext?")

> `optional` **ctwaContext**: `null` | [`ICtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData)

Defined in: [WAProto/index.d.ts:2497](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2497)

* * *

### ctwaContextLinkData?[​](#ctwacontextlinkdata "Direct link to ctwaContextLinkData?")

> `optional` **ctwaContextLinkData**: `null` | [`ICtwaContextLinkData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextLinkData)

Defined in: [WAProto/index.d.ts:2496](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2496)

* * *

### omittedUrl?[​](#omittedurl "Direct link to omittedUrl?")

> `optional` **omittedUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:2495](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2495)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:2494](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2494)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:2498](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2498)

---

<a name="draftmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [CtwaContextData](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/namespaces/CtwaContextData/)

## Classes[​](#classes "Direct link to Classes")

*   [CtwaContextData](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextData)
*   [CtwaContextLinkData](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextLinkData)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [ICtwaContextData](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData)
*   [ICtwaContextLinkData](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextLinkData)

---

<a name="class-ctwacontextdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextData)

Defined in: [WAProto/index.d.ts:2534](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2534)

## Implements[​](#implements "Direct link to Implements")

*   [`ICtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData)

## Constructors[​](#constructors "Direct link to Constructors")

### new CtwaContextData()[​](#new-ctwacontextdata "Direct link to new CtwaContextData()")

> **new CtwaContextData**(`p`?): [`CtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextData)

Defined in: [WAProto/index.d.ts:2535](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2535)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData)

#### Returns[​](#returns "Direct link to Returns")

[`CtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextData)

## Properties[​](#properties "Direct link to Properties")

### conversionData?[​](#conversiondata "Direct link to conversionData?")

> `optional` **conversionData**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2537](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2537)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData).[`conversionData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData#conversiondata)

* * *

### conversionSource?[​](#conversionsource "Direct link to conversionSource?")

> `optional` **conversionSource**: `null` | `string`

Defined in: [WAProto/index.d.ts:2536](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2536)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ICtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData).[`conversionSource`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData#conversionsource)

* * *

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:2542](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2542)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ICtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData).[`description`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData#description)

* * *

### isSuspiciousLink?[​](#issuspiciouslink "Direct link to isSuspiciousLink?")

> `optional` **isSuspiciousLink**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2547](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2547)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ICtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData).[`isSuspiciousLink`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData#issuspiciouslink)

* * *

### mediaType?[​](#mediatype "Direct link to mediaType?")

> `optional` **mediaType**: `null` | [`ContextInfoExternalAdReplyInfoMediaType`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/namespaces/CtwaContextData/enumerations/ContextInfoExternalAdReplyInfoMediaType)

Defined in: [WAProto/index.d.ts:2545](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2545)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ICtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData).[`mediaType`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData#mediatype)

* * *

### mediaUrl?[​](#mediaurl "Direct link to mediaUrl?")

> `optional` **mediaUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:2546](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2546)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`ICtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData).[`mediaUrl`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData#mediaurl)

* * *

### sourceId?[​](#sourceid "Direct link to sourceId?")

> `optional` **sourceId**: `null` | `string`

Defined in: [WAProto/index.d.ts:2539](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2539)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`ICtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData).[`sourceId`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData#sourceid)

* * *

### sourceType?[​](#sourcetype "Direct link to sourceType?")

> `optional` **sourceType**: `null` | `string`

Defined in: [WAProto/index.d.ts:2540](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2540)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`ICtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData).[`sourceType`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData#sourcetype)

* * *

### sourceUrl?[​](#sourceurl "Direct link to sourceUrl?")

> `optional` **sourceUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:2538](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2538)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`ICtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData).[`sourceUrl`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData#sourceurl)

* * *

### thumbnail?[​](#thumbnail "Direct link to thumbnail?")

> `optional` **thumbnail**: `null` | `string`

Defined in: [WAProto/index.d.ts:2543](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2543)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`ICtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData).[`thumbnail`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData#thumbnail)

* * *

### thumbnailUrl?[​](#thumbnailurl "Direct link to thumbnailUrl?")

> `optional` **thumbnailUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:2544](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2544)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`ICtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData).[`thumbnailUrl`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData#thumbnailurl)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:2541](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2541)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`ICtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData).[`title`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData#title)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2553](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2553)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextData)

Defined in: [WAProto/index.d.ts:2548](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2548)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextData)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextData)

Defined in: [WAProto/index.d.ts:2550](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2550)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextData)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2549](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2549)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextData)

Defined in: [WAProto/index.d.ts:2551](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2551)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextData)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2554](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2554)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2552](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2552)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CtwaContextData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextData)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-ctwacontextlinkdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextLinkData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextLinkData)

Defined in: [WAProto/index.d.ts:2573](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2573)

## Implements[​](#implements "Direct link to Implements")

*   [`ICtwaContextLinkData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextLinkData)

## Constructors[​](#constructors "Direct link to Constructors")

### new CtwaContextLinkData()[​](#new-ctwacontextlinkdata "Direct link to new CtwaContextLinkData()")

> **new CtwaContextLinkData**(`p`?): [`CtwaContextLinkData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextLinkData)

Defined in: [WAProto/index.d.ts:2574](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2574)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICtwaContextLinkData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextLinkData)

#### Returns[​](#returns "Direct link to Returns")

[`CtwaContextLinkData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextLinkData)

## Properties[​](#properties "Direct link to Properties")

### context?[​](#context "Direct link to context?")

> `optional` **context**: `null` | `string`

Defined in: [WAProto/index.d.ts:2575](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2575)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICtwaContextLinkData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextLinkData).[`context`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextLinkData#context)

* * *

### icebreaker?[​](#icebreaker "Direct link to icebreaker?")

> `optional` **icebreaker**: `null` | `string`

Defined in: [WAProto/index.d.ts:2577](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2577)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ICtwaContextLinkData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextLinkData).[`icebreaker`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextLinkData#icebreaker)

* * *

### phone?[​](#phone "Direct link to phone?")

> `optional` **phone**: `null` | `string`

Defined in: [WAProto/index.d.ts:2578](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2578)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ICtwaContextLinkData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextLinkData).[`phone`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextLinkData#phone)

* * *

### sourceUrl?[​](#sourceurl "Direct link to sourceUrl?")

> `optional` **sourceUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:2576](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2576)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ICtwaContextLinkData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextLinkData).[`sourceUrl`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextLinkData#sourceurl)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2584](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2584)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CtwaContextLinkData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextLinkData)

Defined in: [WAProto/index.d.ts:2579](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2579)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICtwaContextLinkData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextLinkData)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CtwaContextLinkData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextLinkData)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CtwaContextLinkData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextLinkData)

Defined in: [WAProto/index.d.ts:2581](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2581)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CtwaContextLinkData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextLinkData)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2580](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2580)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICtwaContextLinkData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextLinkData)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CtwaContextLinkData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextLinkData)

Defined in: [WAProto/index.d.ts:2582](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2582)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CtwaContextLinkData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextLinkData)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2585](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2585)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2583](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2583)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CtwaContextLinkData`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/classes/CtwaContextLinkData)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ictwacontextdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextData)

Defined in: [WAProto/index.d.ts:2519](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2519)

## Properties[​](#properties "Direct link to Properties")

### conversionData?[​](#conversiondata "Direct link to conversionData?")

> `optional` **conversionData**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2521](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2521)

* * *

### conversionSource?[​](#conversionsource "Direct link to conversionSource?")

> `optional` **conversionSource**: `null` | `string`

Defined in: [WAProto/index.d.ts:2520](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2520)

* * *

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:2526](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2526)

* * *

### isSuspiciousLink?[​](#issuspiciouslink "Direct link to isSuspiciousLink?")

> `optional` **isSuspiciousLink**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2531](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2531)

* * *

### mediaType?[​](#mediatype "Direct link to mediaType?")

> `optional` **mediaType**: `null` | [`ContextInfoExternalAdReplyInfoMediaType`](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/namespaces/CtwaContextData/enumerations/ContextInfoExternalAdReplyInfoMediaType)

Defined in: [WAProto/index.d.ts:2529](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2529)

* * *

### mediaUrl?[​](#mediaurl "Direct link to mediaUrl?")

> `optional` **mediaUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:2530](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2530)

* * *

### sourceId?[​](#sourceid "Direct link to sourceId?")

> `optional` **sourceId**: `null` | `string`

Defined in: [WAProto/index.d.ts:2523](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2523)

* * *

### sourceType?[​](#sourcetype "Direct link to sourceType?")

> `optional` **sourceType**: `null` | `string`

Defined in: [WAProto/index.d.ts:2524](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2524)

* * *

### sourceUrl?[​](#sourceurl "Direct link to sourceUrl?")

> `optional` **sourceUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:2522](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2522)

* * *

### thumbnail?[​](#thumbnail "Direct link to thumbnail?")

> `optional` **thumbnail**: `null` | `string`

Defined in: [WAProto/index.d.ts:2527](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2527)

* * *

### thumbnailUrl?[​](#thumbnailurl "Direct link to thumbnailUrl?")

> `optional` **thumbnailUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:2528](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2528)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:2525](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2525)

---

<a name="interface-ictwacontextlinkdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextLinkData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/interfaces/ICtwaContextLinkData)

Defined in: [WAProto/index.d.ts:2566](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2566)

## Properties[​](#properties "Direct link to Properties")

### context?[​](#context "Direct link to context?")

> `optional` **context**: `null` | `string`

Defined in: [WAProto/index.d.ts:2567](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2567)

* * *

### icebreaker?[​](#icebreaker "Direct link to icebreaker?")

> `optional` **icebreaker**: `null` | `string`

Defined in: [WAProto/index.d.ts:2569](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2569)

* * *

### phone?[​](#phone "Direct link to phone?")

> `optional` **phone**: `null` | `string`

Defined in: [WAProto/index.d.ts:2570](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2570)

* * *

### sourceUrl?[​](#sourceurl "Direct link to sourceUrl?")

> `optional` **sourceUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:2568](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2568)

---

<a name="ctwacontextdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/namespaces/CtwaContextData/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/namespaces/CtwaContextData/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [ContextInfoExternalAdReplyInfoMediaType](/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/namespaces/CtwaContextData/enumerations/ContextInfoExternalAdReplyInfoMediaType)

---

<a name="enumeration-contextinfoexternaladreplyinfomediatype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/namespaces/CtwaContextData/enumerations/ContextInfoExternalAdReplyInfoMediaType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ChatRowOpaqueData/namespaces/DraftMessage/namespaces/CtwaContextData/enumerations/ContextInfoExternalAdReplyInfoMediaType)

Defined in: [WAProto/index.d.ts:2559](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2559)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### IMAGE[​](#image "Direct link to IMAGE")

> **IMAGE**: `1`

Defined in: [WAProto/index.d.ts:2561](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2561)

* * *

### NONE[​](#none "Direct link to NONE")

> **NONE**: `0`

Defined in: [WAProto/index.d.ts:2560](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2560)

* * *

### VIDEO[​](#video "Direct link to VIDEO")

> **VIDEO**: `2`

Defined in: [WAProto/index.d.ts:2562](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2562)

---

<a name="clientpayload"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [DNSSource](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/DNSSource/)
*   [UserAgent](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/)
*   [WebInfo](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [AccountType](/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/AccountType)
*   [ConnectReason](/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/ConnectReason)
*   [ConnectType](/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/ConnectType)
*   [IOSAppExtension](/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/IOSAppExtension)
*   [Product](/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/Product)
*   [TrafficAnonymization](/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/TrafficAnonymization)

## Classes[​](#classes "Direct link to Classes")

*   [DevicePairingRegistrationData](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DevicePairingRegistrationData)
*   [DNSSource](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DNSSource)
*   [InteropData](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/InteropData)
*   [UserAgent](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/UserAgent)
*   [WebInfo](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/WebInfo)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IDevicePairingRegistrationData](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData)
*   [IDNSSource](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDNSSource)
*   [IInteropData](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IInteropData)
*   [IUserAgent](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent)
*   [IWebInfo](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IWebInfo)

---

<a name="class-dnssource"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DNSSource](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DNSSource)

Defined in: [WAProto/index.d.ts:2754](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2754)

## Implements[​](#implements "Direct link to Implements")

*   [`IDNSSource`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDNSSource)

## Constructors[​](#constructors "Direct link to Constructors")

### new DNSSource()[​](#new-dnssource "Direct link to new DNSSource()")

> **new DNSSource**(`p`?): [`DNSSource`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DNSSource)

Defined in: [WAProto/index.d.ts:2755](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2755)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IDNSSource`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDNSSource)

#### Returns[​](#returns "Direct link to Returns")

[`DNSSource`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DNSSource)

## Properties[​](#properties "Direct link to Properties")

### appCached?[​](#appcached "Direct link to appCached?")

> `optional` **appCached**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2757](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2757)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IDNSSource`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDNSSource).[`appCached`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDNSSource#appcached)

* * *

### dnsMethod?[​](#dnsmethod "Direct link to dnsMethod?")

> `optional` **dnsMethod**: `null` | [`DNSResolutionMethod`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/DNSSource/enumerations/DNSResolutionMethod)

Defined in: [WAProto/index.d.ts:2756](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2756)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IDNSSource`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDNSSource).[`dnsMethod`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDNSSource#dnsmethod)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2763](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2763)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`DNSSource`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DNSSource)

Defined in: [WAProto/index.d.ts:2758](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2758)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IDNSSource`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDNSSource)

#### Returns[​](#returns-2 "Direct link to Returns")

[`DNSSource`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DNSSource)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`DNSSource`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DNSSource)

Defined in: [WAProto/index.d.ts:2760](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2760)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`DNSSource`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DNSSource)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2759](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2759)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IDNSSource`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDNSSource)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`DNSSource`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DNSSource)

Defined in: [WAProto/index.d.ts:2761](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2761)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`DNSSource`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DNSSource)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2764](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2764)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2762](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2762)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`DNSSource`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DNSSource)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-devicepairingregistrationdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DevicePairingRegistrationData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DevicePairingRegistrationData)

Defined in: [WAProto/index.d.ts:2790](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2790)

## Implements[​](#implements "Direct link to Implements")

*   [`IDevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData)

## Constructors[​](#constructors "Direct link to Constructors")

### new DevicePairingRegistrationData()[​](#new-devicepairingregistrationdata "Direct link to new DevicePairingRegistrationData()")

> **new DevicePairingRegistrationData**(`p`?): [`DevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DevicePairingRegistrationData)

Defined in: [WAProto/index.d.ts:2791](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2791)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IDevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData)

#### Returns[​](#returns "Direct link to Returns")

[`DevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DevicePairingRegistrationData)

## Properties[​](#properties "Direct link to Properties")

### buildHash?[​](#buildhash "Direct link to buildHash?")

> `optional` **buildHash**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2798](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2798)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IDevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData).[`buildHash`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData#buildhash)

* * *

### deviceProps?[​](#deviceprops "Direct link to deviceProps?")

> `optional` **deviceProps**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2799](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2799)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IDevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData).[`deviceProps`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData#deviceprops)

* * *

### eIdent?[​](#eident "Direct link to eIdent?")

> `optional` **eIdent**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2794](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2794)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IDevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData).[`eIdent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData#eident)

* * *

### eKeytype?[​](#ekeytype "Direct link to eKeytype?")

> `optional` **eKeytype**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2793](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2793)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IDevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData).[`eKeytype`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData#ekeytype)

* * *

### eRegid?[​](#eregid "Direct link to eRegid?")

> `optional` **eRegid**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2792](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2792)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IDevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData).[`eRegid`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData#eregid)

* * *

### eSkeyId?[​](#eskeyid "Direct link to eSkeyId?")

> `optional` **eSkeyId**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2795](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2795)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IDevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData).[`eSkeyId`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData#eskeyid)

* * *

### eSkeySig?[​](#eskeysig "Direct link to eSkeySig?")

> `optional` **eSkeySig**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2797](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2797)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IDevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData).[`eSkeySig`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData#eskeysig)

* * *

### eSkeyVal?[​](#eskeyval "Direct link to eSkeyVal?")

> `optional` **eSkeyVal**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2796](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2796)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IDevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData).[`eSkeyVal`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData#eskeyval)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2805](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2805)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`DevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DevicePairingRegistrationData)

Defined in: [WAProto/index.d.ts:2800](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2800)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IDevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData)

#### Returns[​](#returns-2 "Direct link to Returns")

[`DevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DevicePairingRegistrationData)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`DevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DevicePairingRegistrationData)

Defined in: [WAProto/index.d.ts:2802](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2802)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`DevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DevicePairingRegistrationData)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2801](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2801)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IDevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`DevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DevicePairingRegistrationData)

Defined in: [WAProto/index.d.ts:2803](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2803)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`DevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DevicePairingRegistrationData)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2806](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2806)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2804](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2804)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`DevicePairingRegistrationData`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/DevicePairingRegistrationData)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-interopdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/classes/InteropData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/classes/InteropData)

Defined in: [WAProto/index.d.ts:2821](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2821)

## Implements[​](#implements "Direct link to Implements")

*   [`IInteropData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IInteropData)

## Constructors[​](#constructors "Direct link to Constructors")

### new InteropData()[​](#new-interopdata "Direct link to new InteropData()")

> **new InteropData**(`p`?): [`InteropData`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/InteropData)

Defined in: [WAProto/index.d.ts:2822](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2822)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IInteropData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IInteropData)

#### Returns[​](#returns "Direct link to Returns")

[`InteropData`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/InteropData)

## Properties[​](#properties "Direct link to Properties")

### accountId?[​](#accountid "Direct link to accountId?")

> `optional` **accountId**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:2823](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2823)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IInteropData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IInteropData).[`accountId`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IInteropData#accountid)

* * *

### enableReadReceipts?[​](#enablereadreceipts "Direct link to enableReadReceipts?")

> `optional` **enableReadReceipts**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2825](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2825)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IInteropData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IInteropData).[`enableReadReceipts`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IInteropData#enablereadreceipts)

* * *

### token?[​](#token "Direct link to token?")

> `optional` **token**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2824](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2824)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IInteropData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IInteropData).[`token`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IInteropData#token)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2831](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2831)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`InteropData`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/InteropData)

Defined in: [WAProto/index.d.ts:2826](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2826)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IInteropData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IInteropData)

#### Returns[​](#returns-2 "Direct link to Returns")

[`InteropData`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/InteropData)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`InteropData`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/InteropData)

Defined in: [WAProto/index.d.ts:2828](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2828)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`InteropData`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/InteropData)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2827](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2827)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IInteropData`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IInteropData)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`InteropData`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/InteropData)

Defined in: [WAProto/index.d.ts:2829](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2829)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`InteropData`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/InteropData)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2832](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2832)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2830](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2830)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`InteropData`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/InteropData)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-useragent"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/classes/UserAgent](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/classes/UserAgent)

Defined in: [WAProto/index.d.ts:2867](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2867)

## Implements[​](#implements "Direct link to Implements")

*   [`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent)

## Constructors[​](#constructors "Direct link to Constructors")

### new UserAgent()[​](#new-useragent "Direct link to new UserAgent()")

> **new UserAgent**(`p`?): [`UserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/UserAgent)

Defined in: [WAProto/index.d.ts:2868](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2868)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent)

#### Returns[​](#returns "Direct link to Returns")

[`UserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/UserAgent)

## Properties[​](#properties "Direct link to Properties")

### appVersion?[​](#appversion "Direct link to appVersion?")

> `optional` **appVersion**: `null` | [`IAppVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/interfaces/IAppVersion)

Defined in: [WAProto/index.d.ts:2870](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2870)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent).[`appVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent#appversion)

* * *

### device?[​](#device "Direct link to device?")

> `optional` **device**: `null` | `string`

Defined in: [WAProto/index.d.ts:2875](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2875)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent).[`device`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent#device)

* * *

### deviceBoard?[​](#deviceboard "Direct link to deviceBoard?")

> `optional` **deviceBoard**: `null` | `string`

Defined in: [WAProto/index.d.ts:2881](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2881)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent).[`deviceBoard`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent#deviceboard)

* * *

### deviceExpId?[​](#deviceexpid "Direct link to deviceExpId?")

> `optional` **deviceExpId**: `null` | `string`

Defined in: [WAProto/index.d.ts:2882](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2882)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent).[`deviceExpId`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent#deviceexpid)

* * *

### deviceModelType?[​](#devicemodeltype "Direct link to deviceModelType?")

> `optional` **deviceModelType**: `null` | `string`

Defined in: [WAProto/index.d.ts:2884](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2884)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent).[`deviceModelType`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent#devicemodeltype)

* * *

### deviceType?[​](#devicetype "Direct link to deviceType?")

> `optional` **deviceType**: `null` | [`DeviceType`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/enumerations/DeviceType)

Defined in: [WAProto/index.d.ts:2883](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2883)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent).[`deviceType`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent#devicetype)

* * *

### localeCountryIso31661Alpha2?[​](#localecountryiso31661alpha2 "Direct link to localeCountryIso31661Alpha2?")

> `optional` **localeCountryIso31661Alpha2**: `null` | `string`

Defined in: [WAProto/index.d.ts:2880](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2880)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent).[`localeCountryIso31661Alpha2`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent#localecountryiso31661alpha2)

* * *

### localeLanguageIso6391?[​](#localelanguageiso6391 "Direct link to localeLanguageIso6391?")

> `optional` **localeLanguageIso6391**: `null` | `string`

Defined in: [WAProto/index.d.ts:2879](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2879)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent).[`localeLanguageIso6391`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent#localelanguageiso6391)

* * *

### manufacturer?[​](#manufacturer "Direct link to manufacturer?")

> `optional` **manufacturer**: `null` | `string`

Defined in: [WAProto/index.d.ts:2874](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2874)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent).[`manufacturer`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent#manufacturer)

* * *

### mcc?[​](#mcc "Direct link to mcc?")

> `optional` **mcc**: `null` | `string`

Defined in: [WAProto/index.d.ts:2871](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2871)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent).[`mcc`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent#mcc)

* * *

### mnc?[​](#mnc "Direct link to mnc?")

> `optional` **mnc**: `null` | `string`

Defined in: [WAProto/index.d.ts:2872](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2872)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent).[`mnc`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent#mnc)

* * *

### osBuildNumber?[​](#osbuildnumber "Direct link to osBuildNumber?")

> `optional` **osBuildNumber**: `null` | `string`

Defined in: [WAProto/index.d.ts:2876](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2876)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent).[`osBuildNumber`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent#osbuildnumber)

* * *

### osVersion?[​](#osversion "Direct link to osVersion?")

> `optional` **osVersion**: `null` | `string`

Defined in: [WAProto/index.d.ts:2873](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2873)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent).[`osVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent#osversion)

* * *

### phoneId?[​](#phoneid "Direct link to phoneId?")

> `optional` **phoneId**: `null` | `string`

Defined in: [WAProto/index.d.ts:2877](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2877)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent).[`phoneId`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent#phoneid)

* * *

### platform?[​](#platform "Direct link to platform?")

> `optional` **platform**: `null` | [`Platform`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/enumerations/Platform)

Defined in: [WAProto/index.d.ts:2869](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2869)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent).[`platform`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent#platform)

* * *

### releaseChannel?[​](#releasechannel "Direct link to releaseChannel?")

> `optional` **releaseChannel**: `null` | [`ReleaseChannel`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/enumerations/ReleaseChannel)

Defined in: [WAProto/index.d.ts:2878](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2878)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent).[`releaseChannel`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent#releasechannel)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2890](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2890)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`UserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/UserAgent)

Defined in: [WAProto/index.d.ts:2885](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2885)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent)

#### Returns[​](#returns-2 "Direct link to Returns")

[`UserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/UserAgent)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`UserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/UserAgent)

Defined in: [WAProto/index.d.ts:2887](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2887)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`UserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/UserAgent)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2886](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2886)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IUserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`UserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/UserAgent)

Defined in: [WAProto/index.d.ts:2888](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2888)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`UserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/UserAgent)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2891](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2891)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2889](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2889)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`UserAgent`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/UserAgent)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-webinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/classes/WebInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/classes/WebInfo)

Defined in: [WAProto/index.d.ts:2984](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2984)

## Implements[​](#implements "Direct link to Implements")

*   [`IWebInfo`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IWebInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new WebInfo()[​](#new-webinfo "Direct link to new WebInfo()")

> **new WebInfo**(`p`?): [`WebInfo`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/WebInfo)

Defined in: [WAProto/index.d.ts:2985](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2985)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IWebInfo`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IWebInfo)

#### Returns[​](#returns "Direct link to Returns")

[`WebInfo`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/WebInfo)

## Properties[​](#properties "Direct link to Properties")

### refToken?[​](#reftoken "Direct link to refToken?")

> `optional` **refToken**: `null` | `string`

Defined in: [WAProto/index.d.ts:2986](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2986)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IWebInfo`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IWebInfo).[`refToken`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IWebInfo#reftoken)

* * *

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | `string`

Defined in: [WAProto/index.d.ts:2987](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2987)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IWebInfo`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IWebInfo).[`version`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IWebInfo#version)

* * *

### webdPayload?[​](#webdpayload "Direct link to webdPayload?")

> `optional` **webdPayload**: `null` | [`IWebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload)

Defined in: [WAProto/index.d.ts:2988](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2988)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IWebInfo`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IWebInfo).[`webdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IWebInfo#webdpayload)

* * *

### webSubPlatform?[​](#websubplatform "Direct link to webSubPlatform?")

> `optional` **webSubPlatform**: `null` | [`WebSubPlatform`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/enumerations/WebSubPlatform)

Defined in: [WAProto/index.d.ts:2989](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2989)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IWebInfo`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IWebInfo).[`webSubPlatform`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IWebInfo#websubplatform)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2995](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2995)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`WebInfo`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/WebInfo)

Defined in: [WAProto/index.d.ts:2990](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2990)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IWebInfo`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IWebInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`WebInfo`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/WebInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`WebInfo`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/WebInfo)

Defined in: [WAProto/index.d.ts:2992](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2992)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`WebInfo`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/WebInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2991](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2991)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IWebInfo`](/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IWebInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`WebInfo`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/WebInfo)

Defined in: [WAProto/index.d.ts:2993](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2993)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`WebInfo`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/WebInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2996](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2996)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2994](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2994)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`WebInfo`](/docs/api/namespaces/proto/namespaces/ClientPayload/classes/WebInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-accounttype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/AccountType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/AccountType)

Defined in: [WAProto/index.d.ts:2716](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2716)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### DEFAULT[​](#default "Direct link to DEFAULT")

> **DEFAULT**: `0`

Defined in: [WAProto/index.d.ts:2717](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2717)

* * *

### GUEST[​](#guest "Direct link to GUEST")

> **GUEST**: `1`

Defined in: [WAProto/index.d.ts:2718](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2718)

---

<a name="enumeration-connectreason"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/ConnectReason](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/ConnectReason)

Defined in: [WAProto/index.d.ts:2721](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2721)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### ERROR\_RECONNECT[​](#error_reconnect "Direct link to ERROR_RECONNECT")

> **ERROR\_RECONNECT**: `3`

Defined in: [WAProto/index.d.ts:2725](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2725)

* * *

### NETWORK\_SWITCH[​](#network_switch "Direct link to NETWORK_SWITCH")

> **NETWORK\_SWITCH**: `4`

Defined in: [WAProto/index.d.ts:2726](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2726)

* * *

### PING\_RECONNECT[​](#ping_reconnect "Direct link to PING_RECONNECT")

> **PING\_RECONNECT**: `5`

Defined in: [WAProto/index.d.ts:2727](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2727)

* * *

### PUSH[​](#push "Direct link to PUSH")

> **PUSH**: `0`

Defined in: [WAProto/index.d.ts:2722](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2722)

* * *

### SCHEDULED[​](#scheduled "Direct link to SCHEDULED")

> **SCHEDULED**: `2`

Defined in: [WAProto/index.d.ts:2724](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2724)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `6`

Defined in: [WAProto/index.d.ts:2728](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2728)

* * *

### USER\_ACTIVATED[​](#user_activated "Direct link to USER_ACTIVATED")

> **USER\_ACTIVATED**: `1`

Defined in: [WAProto/index.d.ts:2723](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2723)

---

<a name="enumeration-connecttype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/ConnectType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/ConnectType)

Defined in: [WAProto/index.d.ts:2731](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2731)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### CELLULAR\_1XRTT[​](#cellular_1xrtt "Direct link to CELLULAR_1XRTT")

> **CELLULAR\_1XRTT**: `109`

Defined in: [WAProto/index.d.ts:2743](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2743)

* * *

### CELLULAR\_CDMA[​](#cellular_cdma "Direct link to CELLULAR_CDMA")

> **CELLULAR\_CDMA**: `108`

Defined in: [WAProto/index.d.ts:2742](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2742)

* * *

### CELLULAR\_EDGE[​](#cellular_edge "Direct link to CELLULAR_EDGE")

> **CELLULAR\_EDGE**: `100`

Defined in: [WAProto/index.d.ts:2734](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2734)

* * *

### CELLULAR\_EHRPD[​](#cellular_ehrpd "Direct link to CELLULAR_EHRPD")

> **CELLULAR\_EHRPD**: `110`

Defined in: [WAProto/index.d.ts:2744](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2744)

* * *

### CELLULAR\_EVDO[​](#cellular_evdo "Direct link to CELLULAR_EVDO")

> **CELLULAR\_EVDO**: `103`

Defined in: [WAProto/index.d.ts:2737](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2737)

* * *

### CELLULAR\_GPRS[​](#cellular_gprs "Direct link to CELLULAR_GPRS")

> **CELLULAR\_GPRS**: `104`

Defined in: [WAProto/index.d.ts:2738](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2738)

* * *

### CELLULAR\_HSDPA[​](#cellular_hsdpa "Direct link to CELLULAR_HSDPA")

> **CELLULAR\_HSDPA**: `105`

Defined in: [WAProto/index.d.ts:2739](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2739)

* * *

### CELLULAR\_HSPA[​](#cellular_hspa "Direct link to CELLULAR_HSPA")

> **CELLULAR\_HSPA**: `107`

Defined in: [WAProto/index.d.ts:2741](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2741)

* * *

### CELLULAR\_HSPAP[​](#cellular_hspap "Direct link to CELLULAR_HSPAP")

> **CELLULAR\_HSPAP**: `112`

Defined in: [WAProto/index.d.ts:2746](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2746)

* * *

### CELLULAR\_HSUPA[​](#cellular_hsupa "Direct link to CELLULAR_HSUPA")

> **CELLULAR\_HSUPA**: `106`

Defined in: [WAProto/index.d.ts:2740](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2740)

* * *

### CELLULAR\_IDEN[​](#cellular_iden "Direct link to CELLULAR_IDEN")

> **CELLULAR\_IDEN**: `101`

Defined in: [WAProto/index.d.ts:2735](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2735)

* * *

### CELLULAR\_LTE[​](#cellular_lte "Direct link to CELLULAR_LTE")

> **CELLULAR\_LTE**: `111`

Defined in: [WAProto/index.d.ts:2745](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2745)

* * *

### CELLULAR\_UMTS[​](#cellular_umts "Direct link to CELLULAR_UMTS")

> **CELLULAR\_UMTS**: `102`

Defined in: [WAProto/index.d.ts:2736](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2736)

* * *

### CELLULAR\_UNKNOWN[​](#cellular_unknown "Direct link to CELLULAR_UNKNOWN")

> **CELLULAR\_UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:2732](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2732)

* * *

### WIFI\_UNKNOWN[​](#wifi_unknown "Direct link to WIFI_UNKNOWN")

> **WIFI\_UNKNOWN**: `1`

Defined in: [WAProto/index.d.ts:2733](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2733)

---

<a name="enumeration-iosappextension"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/IOSAppExtension](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/IOSAppExtension)

Defined in: [WAProto/index.d.ts:2809](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2809)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### INTENTS\_EXTENSION[​](#intents_extension "Direct link to INTENTS_EXTENSION")

> **INTENTS\_EXTENSION**: `2`

Defined in: [WAProto/index.d.ts:2812](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2812)

* * *

### SERVICE\_EXTENSION[​](#service_extension "Direct link to SERVICE_EXTENSION")

> **SERVICE\_EXTENSION**: `1`

Defined in: [WAProto/index.d.ts:2811](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2811)

* * *

### SHARE\_EXTENSION[​](#share_extension "Direct link to SHARE_EXTENSION")

> **SHARE\_EXTENSION**: `0`

Defined in: [WAProto/index.d.ts:2810](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2810)

---

<a name="enumeration-product"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/Product](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/Product)

Defined in: [WAProto/index.d.ts:2835](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2835)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### INTEROP[​](#interop "Direct link to INTEROP")

> **INTEROP**: `2`

Defined in: [WAProto/index.d.ts:2838](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2838)

* * *

### INTEROP\_MSGR[​](#interop_msgr "Direct link to INTEROP_MSGR")

> **INTEROP\_MSGR**: `3`

Defined in: [WAProto/index.d.ts:2839](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2839)

* * *

### MESSENGER[​](#messenger "Direct link to MESSENGER")

> **MESSENGER**: `1`

Defined in: [WAProto/index.d.ts:2837](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2837)

* * *

### WHATSAPP[​](#whatsapp "Direct link to WHATSAPP")

> **WHATSAPP**: `0`

Defined in: [WAProto/index.d.ts:2836](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2836)

* * *

### WHATSAPP\_LID[​](#whatsapp_lid "Direct link to WHATSAPP_LID")

> **WHATSAPP\_LID**: `4`

Defined in: [WAProto/index.d.ts:2840](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2840)

---

<a name="enumeration-trafficanonymization"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/TrafficAnonymization](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/enumerations/TrafficAnonymization)

Defined in: [WAProto/index.d.ts:2843](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2843)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### OFF[​](#off "Direct link to OFF")

> **OFF**: `0`

Defined in: [WAProto/index.d.ts:2844](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2844)

* * *

### STANDARD[​](#standard "Direct link to STANDARD")

> **STANDARD**: `1`

Defined in: [WAProto/index.d.ts:2845](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2845)

---

<a name="interface-idnssource"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDNSSource](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDNSSource)

Defined in: [WAProto/index.d.ts:2749](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2749)

## Properties[​](#properties "Direct link to Properties")

### appCached?[​](#appcached "Direct link to appCached?")

> `optional` **appCached**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2751](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2751)

* * *

### dnsMethod?[​](#dnsmethod "Direct link to dnsMethod?")

> `optional` **dnsMethod**: `null` | [`DNSResolutionMethod`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/DNSSource/enumerations/DNSResolutionMethod)

Defined in: [WAProto/index.d.ts:2750](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2750)

---

<a name="interface-idevicepairingregistrationdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IDevicePairingRegistrationData)

Defined in: [WAProto/index.d.ts:2779](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2779)

## Properties[​](#properties "Direct link to Properties")

### buildHash?[​](#buildhash "Direct link to buildHash?")

> `optional` **buildHash**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2786](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2786)

* * *

### deviceProps?[​](#deviceprops "Direct link to deviceProps?")

> `optional` **deviceProps**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2787](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2787)

* * *

### eIdent?[​](#eident "Direct link to eIdent?")

> `optional` **eIdent**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2782](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2782)

* * *

### eKeytype?[​](#ekeytype "Direct link to eKeytype?")

> `optional` **eKeytype**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2781](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2781)

* * *

### eRegid?[​](#eregid "Direct link to eRegid?")

> `optional` **eRegid**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2780](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2780)

* * *

### eSkeyId?[​](#eskeyid "Direct link to eSkeyId?")

> `optional` **eSkeyId**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2783](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2783)

* * *

### eSkeySig?[​](#eskeysig "Direct link to eSkeySig?")

> `optional` **eSkeySig**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2785](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2785)

* * *

### eSkeyVal?[​](#eskeyval "Direct link to eSkeyVal?")

> `optional` **eSkeyVal**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2784](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2784)

---

<a name="interface-iinteropdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IInteropData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IInteropData)

Defined in: [WAProto/index.d.ts:2815](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2815)

## Properties[​](#properties "Direct link to Properties")

### accountId?[​](#accountid "Direct link to accountId?")

> `optional` **accountId**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:2816](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2816)

* * *

### enableReadReceipts?[​](#enablereadreceipts "Direct link to enableReadReceipts?")

> `optional` **enableReadReceipts**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:2818](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2818)

* * *

### token?[​](#token "Direct link to token?")

> `optional` **token**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:2817](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2817)

---

<a name="interface-iuseragent"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IUserAgent)

Defined in: [WAProto/index.d.ts:2848](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2848)

## Properties[​](#properties "Direct link to Properties")

### appVersion?[​](#appversion "Direct link to appVersion?")

> `optional` **appVersion**: `null` | [`IAppVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/interfaces/IAppVersion)

Defined in: [WAProto/index.d.ts:2850](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2850)

* * *

### device?[​](#device "Direct link to device?")

> `optional` **device**: `null` | `string`

Defined in: [WAProto/index.d.ts:2855](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2855)

* * *

### deviceBoard?[​](#deviceboard "Direct link to deviceBoard?")

> `optional` **deviceBoard**: `null` | `string`

Defined in: [WAProto/index.d.ts:2861](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2861)

* * *

### deviceExpId?[​](#deviceexpid "Direct link to deviceExpId?")

> `optional` **deviceExpId**: `null` | `string`

Defined in: [WAProto/index.d.ts:2862](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2862)

* * *

### deviceModelType?[​](#devicemodeltype "Direct link to deviceModelType?")

> `optional` **deviceModelType**: `null` | `string`

Defined in: [WAProto/index.d.ts:2864](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2864)

* * *

### deviceType?[​](#devicetype "Direct link to deviceType?")

> `optional` **deviceType**: `null` | [`DeviceType`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/enumerations/DeviceType)

Defined in: [WAProto/index.d.ts:2863](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2863)

* * *

### localeCountryIso31661Alpha2?[​](#localecountryiso31661alpha2 "Direct link to localeCountryIso31661Alpha2?")

> `optional` **localeCountryIso31661Alpha2**: `null` | `string`

Defined in: [WAProto/index.d.ts:2860](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2860)

* * *

### localeLanguageIso6391?[​](#localelanguageiso6391 "Direct link to localeLanguageIso6391?")

> `optional` **localeLanguageIso6391**: `null` | `string`

Defined in: [WAProto/index.d.ts:2859](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2859)

* * *

### manufacturer?[​](#manufacturer "Direct link to manufacturer?")

> `optional` **manufacturer**: `null` | `string`

Defined in: [WAProto/index.d.ts:2854](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2854)

* * *

### mcc?[​](#mcc "Direct link to mcc?")

> `optional` **mcc**: `null` | `string`

Defined in: [WAProto/index.d.ts:2851](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2851)

* * *

### mnc?[​](#mnc "Direct link to mnc?")

> `optional` **mnc**: `null` | `string`

Defined in: [WAProto/index.d.ts:2852](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2852)

* * *

### osBuildNumber?[​](#osbuildnumber "Direct link to osBuildNumber?")

> `optional` **osBuildNumber**: `null` | `string`

Defined in: [WAProto/index.d.ts:2856](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2856)

* * *

### osVersion?[​](#osversion "Direct link to osVersion?")

> `optional` **osVersion**: `null` | `string`

Defined in: [WAProto/index.d.ts:2853](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2853)

* * *

### phoneId?[​](#phoneid "Direct link to phoneId?")

> `optional` **phoneId**: `null` | `string`

Defined in: [WAProto/index.d.ts:2857](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2857)

* * *

### platform?[​](#platform "Direct link to platform?")

> `optional` **platform**: `null` | [`Platform`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/enumerations/Platform)

Defined in: [WAProto/index.d.ts:2849](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2849)

* * *

### releaseChannel?[​](#releasechannel "Direct link to releaseChannel?")

> `optional` **releaseChannel**: `null` | [`ReleaseChannel`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/enumerations/ReleaseChannel)

Defined in: [WAProto/index.d.ts:2858](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2858)

---

<a name="interface-iwebinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IWebInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/interfaces/IWebInfo)

Defined in: [WAProto/index.d.ts:2977](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2977)

## Properties[​](#properties "Direct link to Properties")

### refToken?[​](#reftoken "Direct link to refToken?")

> `optional` **refToken**: `null` | `string`

Defined in: [WAProto/index.d.ts:2978](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2978)

* * *

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | `string`

Defined in: [WAProto/index.d.ts:2979](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2979)

* * *

### webdPayload?[​](#webdpayload "Direct link to webdPayload?")

> `optional` **webdPayload**: `null` | [`IWebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload)

Defined in: [WAProto/index.d.ts:2980](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2980)

* * *

### webSubPlatform?[​](#websubplatform "Direct link to webSubPlatform?")

> `optional` **webSubPlatform**: `null` | [`WebSubPlatform`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/enumerations/WebSubPlatform)

Defined in: [WAProto/index.d.ts:2981](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2981)

---

<a name="dnssource"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/DNSSource/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/DNSSource/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [DNSResolutionMethod](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/DNSSource/enumerations/DNSResolutionMethod)

---

<a name="enumeration-dnsresolutionmethod"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/DNSSource/enumerations/DNSResolutionMethod](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/DNSSource/enumerations/DNSResolutionMethod)

Defined in: [WAProto/index.d.ts:2769](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2769)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### FALLBACK[​](#fallback "Direct link to FALLBACK")

> **FALLBACK**: `4`

Defined in: [WAProto/index.d.ts:2774](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2774)

* * *

### GOOGLE[​](#google "Direct link to GOOGLE")

> **GOOGLE**: `1`

Defined in: [WAProto/index.d.ts:2771](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2771)

* * *

### HARDCODED[​](#hardcoded "Direct link to HARDCODED")

> **HARDCODED**: `2`

Defined in: [WAProto/index.d.ts:2772](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2772)

* * *

### MNS[​](#mns "Direct link to MNS")

> **MNS**: `5`

Defined in: [WAProto/index.d.ts:2775](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2775)

* * *

### OVERRIDE[​](#override "Direct link to OVERRIDE")

> **OVERRIDE**: `3`

Defined in: [WAProto/index.d.ts:2773](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2773)

* * *

### SYSTEM[​](#system "Direct link to SYSTEM")

> **SYSTEM**: `0`

Defined in: [WAProto/index.d.ts:2770](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2770)

---

<a name="useragent"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [DeviceType](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/enumerations/DeviceType)
*   [Platform](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/enumerations/Platform)
*   [ReleaseChannel](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/enumerations/ReleaseChannel)

## Classes[​](#classes "Direct link to Classes")

*   [AppVersion](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/classes/AppVersion)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IAppVersion](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/interfaces/IAppVersion)

---

<a name="class-appversion"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/classes/AppVersion](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/classes/AppVersion)

Defined in: [WAProto/index.d.ts:2904](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2904)

## Implements[​](#implements "Direct link to Implements")

*   [`IAppVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/interfaces/IAppVersion)

## Constructors[​](#constructors "Direct link to Constructors")

### new AppVersion()[​](#new-appversion "Direct link to new AppVersion()")

> **new AppVersion**(`p`?): [`AppVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/classes/AppVersion)

Defined in: [WAProto/index.d.ts:2905](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2905)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAppVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/interfaces/IAppVersion)

#### Returns[​](#returns "Direct link to Returns")

[`AppVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/classes/AppVersion)

## Properties[​](#properties "Direct link to Properties")

### primary?[​](#primary "Direct link to primary?")

> `optional` **primary**: `null` | `number`

Defined in: [WAProto/index.d.ts:2906](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2906)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAppVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/interfaces/IAppVersion).[`primary`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/interfaces/IAppVersion#primary)

* * *

### quaternary?[​](#quaternary "Direct link to quaternary?")

> `optional` **quaternary**: `null` | `number`

Defined in: [WAProto/index.d.ts:2909](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2909)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAppVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/interfaces/IAppVersion).[`quaternary`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/interfaces/IAppVersion#quaternary)

* * *

### quinary?[​](#quinary "Direct link to quinary?")

> `optional` **quinary**: `null` | `number`

Defined in: [WAProto/index.d.ts:2910](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2910)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAppVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/interfaces/IAppVersion).[`quinary`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/interfaces/IAppVersion#quinary)

* * *

### secondary?[​](#secondary "Direct link to secondary?")

> `optional` **secondary**: `null` | `number`

Defined in: [WAProto/index.d.ts:2907](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2907)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IAppVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/interfaces/IAppVersion).[`secondary`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/interfaces/IAppVersion#secondary)

* * *

### tertiary?[​](#tertiary "Direct link to tertiary?")

> `optional` **tertiary**: `null` | `number`

Defined in: [WAProto/index.d.ts:2908](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2908)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IAppVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/interfaces/IAppVersion).[`tertiary`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/interfaces/IAppVersion#tertiary)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:2916](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2916)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AppVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/classes/AppVersion)

Defined in: [WAProto/index.d.ts:2911](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2911)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAppVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/interfaces/IAppVersion)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AppVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/classes/AppVersion)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AppVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/classes/AppVersion)

Defined in: [WAProto/index.d.ts:2913](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2913)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AppVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/classes/AppVersion)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:2912](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2912)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAppVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/interfaces/IAppVersion)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AppVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/classes/AppVersion)

Defined in: [WAProto/index.d.ts:2914](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2914)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AppVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/classes/AppVersion)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:2917](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2917)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:2915](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2915)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AppVersion`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/classes/AppVersion)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-devicetype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/enumerations/DeviceType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/enumerations/DeviceType)

Defined in: [WAProto/index.d.ts:2920](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2920)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### DESKTOP[​](#desktop "Direct link to DESKTOP")

> **DESKTOP**: `2`

Defined in: [WAProto/index.d.ts:2923](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2923)

* * *

### PHONE[​](#phone "Direct link to PHONE")

> **PHONE**: `0`

Defined in: [WAProto/index.d.ts:2921](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2921)

* * *

### TABLET[​](#tablet "Direct link to TABLET")

> **TABLET**: `1`

Defined in: [WAProto/index.d.ts:2922](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2922)

* * *

### VR[​](#vr "Direct link to VR")

> **VR**: `4`

Defined in: [WAProto/index.d.ts:2925](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2925)

* * *

### WEARABLE[​](#wearable "Direct link to WEARABLE")

> **WEARABLE**: `3`

Defined in: [WAProto/index.d.ts:2924](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2924)

---

<a name="enumeration-platform"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/enumerations/Platform](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/enumerations/Platform)

Defined in: [WAProto/index.d.ts:2928](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2928)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### ANDROID[​](#android "Direct link to ANDROID")

> **ANDROID**: `0`

Defined in: [WAProto/index.d.ts:2929](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2929)

* * *

### AR\_WRIST[​](#ar_wrist "Direct link to AR_WRIST")

> **AR\_WRIST**: `37`

Defined in: [WAProto/index.d.ts:2966](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2966)

* * *

### ARDEVICE[​](#ardevice "Direct link to ARDEVICE")

> **ARDEVICE**: `30`

Defined in: [WAProto/index.d.ts:2959](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2959)

* * *

### BLACKBERRY[​](#blackberry "Direct link to BLACKBERRY")

> **BLACKBERRY**: `3`

Defined in: [WAProto/index.d.ts:2932](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2932)

* * *

### BLACKBERRYX[​](#blackberryx "Direct link to BLACKBERRYX")

> **BLACKBERRYX**: `4`

Defined in: [WAProto/index.d.ts:2933](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2933)

* * *

### BLUE\_ANDROID[​](#blue_android "Direct link to BLUE_ANDROID")

> **BLUE\_ANDROID**: `18`

Defined in: [WAProto/index.d.ts:2947](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2947)

* * *

### BLUE\_IPHONE[​](#blue_iphone "Direct link to BLUE_IPHONE")

> **BLUE\_IPHONE**: `19`

Defined in: [WAProto/index.d.ts:2948](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2948)

* * *

### BLUE\_VR[​](#blue_vr "Direct link to BLUE_VR")

> **BLUE\_VR**: `36`

Defined in: [WAProto/index.d.ts:2965](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2965)

* * *

### BLUE\_WEB[​](#blue_web "Direct link to BLUE_WEB")

> **BLUE\_WEB**: `32`

Defined in: [WAProto/index.d.ts:2961](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2961)

* * *

### CAPI[​](#capi "Direct link to CAPI")

> **CAPI**: `28`

Defined in: [WAProto/index.d.ts:2957](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2957)

* * *

### ENTERPRISE[​](#enterprise "Direct link to ENTERPRISE")

> **ENTERPRISE**: `9`

Defined in: [WAProto/index.d.ts:2938](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2938)

* * *

### FBLITE\_ANDROID[​](#fblite_android "Direct link to FBLITE_ANDROID")

> **FBLITE\_ANDROID**: `20`

Defined in: [WAProto/index.d.ts:2949](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2949)

* * *

### GREEN\_ANDROID[​](#green_android "Direct link to GREEN_ANDROID")

> **GREEN\_ANDROID**: `16`

Defined in: [WAProto/index.d.ts:2945](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2945)

* * *

### GREEN\_IPHONE[​](#green_iphone "Direct link to GREEN_IPHONE")

> **GREEN\_IPHONE**: `17`

Defined in: [WAProto/index.d.ts:2946](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2946)

* * *

### IGLITE\_ANDROID[​](#iglite_android "Direct link to IGLITE_ANDROID")

> **IGLITE\_ANDROID**: `22`

Defined in: [WAProto/index.d.ts:2951](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2951)

* * *

### IOS[​](#ios "Direct link to IOS")

> **IOS**: `1`

Defined in: [WAProto/index.d.ts:2930](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2930)

* * *

### IPAD[​](#ipad "Direct link to IPAD")

> **IPAD**: `33`

Defined in: [WAProto/index.d.ts:2962](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2962)

* * *

### KAIOS[​](#kaios "Direct link to KAIOS")

> **KAIOS**: `11`

Defined in: [WAProto/index.d.ts:2940](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2940)

* * *

### MACOS[​](#macos "Direct link to MACOS")

> **MACOS**: `24`

Defined in: [WAProto/index.d.ts:2953](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2953)

* * *

### MILAN[​](#milan "Direct link to MILAN")

> **MILAN**: `27`

Defined in: [WAProto/index.d.ts:2956](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2956)

* * *

### MLITE\_ANDROID[​](#mlite_android "Direct link to MLITE_ANDROID")

> **MLITE\_ANDROID**: `21`

Defined in: [WAProto/index.d.ts:2950](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2950)

* * *

### OCULUS\_CALL[​](#oculus_call "Direct link to OCULUS_CALL")

> **OCULUS\_CALL**: `26`

Defined in: [WAProto/index.d.ts:2955](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2955)

* * *

### OCULUS\_MSG[​](#oculus_msg "Direct link to OCULUS_MSG")

> **OCULUS\_MSG**: `25`

Defined in: [WAProto/index.d.ts:2954](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2954)

* * *

### PAGE[​](#page "Direct link to PAGE")

> **PAGE**: `23`

Defined in: [WAProto/index.d.ts:2952](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2952)

* * *

### PORTAL[​](#portal "Direct link to PORTAL")

> **PORTAL**: `15`

Defined in: [WAProto/index.d.ts:2944](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2944)

* * *

### PYTHON\_CLIENT[​](#python_client "Direct link to PYTHON_CLIENT")

> **PYTHON\_CLIENT**: `7`

Defined in: [WAProto/index.d.ts:2936](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2936)

* * *

### S40[​](#s40 "Direct link to S40")

> **S40**: `5`

Defined in: [WAProto/index.d.ts:2934](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2934)

* * *

### S60[​](#s60 "Direct link to S60")

> **S60**: `6`

Defined in: [WAProto/index.d.ts:2935](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2935)

* * *

### SMART\_GLASSES[​](#smart_glasses "Direct link to SMART_GLASSES")

> **SMART\_GLASSES**: `35`

Defined in: [WAProto/index.d.ts:2964](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2964)

* * *

### SMB\_ANDROID[​](#smb_android "Direct link to SMB_ANDROID")

> **SMB\_ANDROID**: `10`

Defined in: [WAProto/index.d.ts:2939](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2939)

* * *

### SMB\_IOS[​](#smb_ios "Direct link to SMB_IOS")

> **SMB\_IOS**: `12`

Defined in: [WAProto/index.d.ts:2941](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2941)

* * *

### TEST[​](#test "Direct link to TEST")

> **TEST**: `34`

Defined in: [WAProto/index.d.ts:2963](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2963)

* * *

### TIZEN[​](#tizen "Direct link to TIZEN")

> **TIZEN**: `8`

Defined in: [WAProto/index.d.ts:2937](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2937)

* * *

### VRDEVICE[​](#vrdevice "Direct link to VRDEVICE")

> **VRDEVICE**: `31`

Defined in: [WAProto/index.d.ts:2960](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2960)

* * *

### WEAROS[​](#wearos "Direct link to WEAROS")

> **WEAROS**: `29`

Defined in: [WAProto/index.d.ts:2958](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2958)

* * *

### WEB[​](#web "Direct link to WEB")

> **WEB**: `14`

Defined in: [WAProto/index.d.ts:2943](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2943)

* * *

### WINDOWS[​](#windows "Direct link to WINDOWS")

> **WINDOWS**: `13`

Defined in: [WAProto/index.d.ts:2942](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2942)

* * *

### WINDOWS\_PHONE[​](#windows_phone "Direct link to WINDOWS_PHONE")

> **WINDOWS\_PHONE**: `2`

Defined in: [WAProto/index.d.ts:2931](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2931)

---

<a name="enumeration-releasechannel"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/enumerations/ReleaseChannel](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/enumerations/ReleaseChannel)

Defined in: [WAProto/index.d.ts:2969](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2969)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### ALPHA[​](#alpha "Direct link to ALPHA")

> **ALPHA**: `2`

Defined in: [WAProto/index.d.ts:2972](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2972)

* * *

### BETA[​](#beta "Direct link to BETA")

> **BETA**: `1`

Defined in: [WAProto/index.d.ts:2971](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2971)

* * *

### DEBUG[​](#debug "Direct link to DEBUG")

> **DEBUG**: `3`

Defined in: [WAProto/index.d.ts:2973](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2973)

* * *

### RELEASE[​](#release "Direct link to RELEASE")

> **RELEASE**: `0`

Defined in: [WAProto/index.d.ts:2970](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2970)

---

<a name="interface-iappversion"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/interfaces/IAppVersion](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/UserAgent/interfaces/IAppVersion)

Defined in: [WAProto/index.d.ts:2896](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2896)

## Properties[​](#properties "Direct link to Properties")

### primary?[​](#primary "Direct link to primary?")

> `optional` **primary**: `null` | `number`

Defined in: [WAProto/index.d.ts:2897](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2897)

* * *

### quaternary?[​](#quaternary "Direct link to quaternary?")

> `optional` **quaternary**: `null` | `number`

Defined in: [WAProto/index.d.ts:2900](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2900)

* * *

### quinary?[​](#quinary "Direct link to quinary?")

> `optional` **quinary**: `null` | `number`

Defined in: [WAProto/index.d.ts:2901](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2901)

* * *

### secondary?[​](#secondary "Direct link to secondary?")

> `optional` **secondary**: `null` | `number`

Defined in: [WAProto/index.d.ts:2898](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2898)

* * *

### tertiary?[​](#tertiary "Direct link to tertiary?")

> `optional` **tertiary**: `null` | `number`

Defined in: [WAProto/index.d.ts:2899](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L2899)

---

<a name="webinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [WebSubPlatform](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/enumerations/WebSubPlatform)

## Classes[​](#classes "Direct link to Classes")

*   [WebdPayload](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/classes/WebdPayload)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IWebdPayload](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload)

---

<a name="class-webdpayload"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/classes/WebdPayload](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/classes/WebdPayload)

Defined in: [WAProto/index.d.ts:3024](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3024)

## Implements[​](#implements "Direct link to Implements")

*   [`IWebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload)

## Constructors[​](#constructors "Direct link to Constructors")

### new WebdPayload()[​](#new-webdpayload "Direct link to new WebdPayload()")

> **new WebdPayload**(`p`?): [`WebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/classes/WebdPayload)

Defined in: [WAProto/index.d.ts:3025](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3025)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IWebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload)

#### Returns[​](#returns "Direct link to Returns")

[`WebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/classes/WebdPayload)

## Properties[​](#properties "Direct link to Properties")

### documentTypes?[​](#documenttypes "Direct link to documentTypes?")

> `optional` **documentTypes**: `null` | `string`

Defined in: [WAProto/index.d.ts:3035](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3035)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IWebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload).[`documentTypes`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload#documenttypes)

* * *

### features?[​](#features "Direct link to features?")

> `optional` **features**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3036](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3036)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IWebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload).[`features`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload#features)

* * *

### supportsDocumentMessages?[​](#supportsdocumentmessages "Direct link to supportsDocumentMessages?")

> `optional` **supportsDocumentMessages**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3028](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3028)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IWebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload).[`supportsDocumentMessages`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload#supportsdocumentmessages)

* * *

### supportsE2EAudio?[​](#supportse2eaudio "Direct link to supportsE2EAudio?")

> `optional` **supportsE2EAudio**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3033](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3033)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IWebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload).[`supportsE2EAudio`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload#supportse2eaudio)

* * *

### supportsE2EDocument?[​](#supportse2edocument "Direct link to supportsE2EDocument?")

> `optional` **supportsE2EDocument**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3034](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3034)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IWebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload).[`supportsE2EDocument`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload#supportse2edocument)

* * *

### supportsE2EImage?[​](#supportse2eimage "Direct link to supportsE2EImage?")

> `optional` **supportsE2EImage**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3031](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3031)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IWebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload).[`supportsE2EImage`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload#supportse2eimage)

* * *

### supportsE2EVideo?[​](#supportse2evideo "Direct link to supportsE2EVideo?")

> `optional` **supportsE2EVideo**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3032](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3032)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IWebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload).[`supportsE2EVideo`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload#supportse2evideo)

* * *

### supportsMediaRetry?[​](#supportsmediaretry "Direct link to supportsMediaRetry?")

> `optional` **supportsMediaRetry**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3030](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3030)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IWebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload).[`supportsMediaRetry`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload#supportsmediaretry)

* * *

### supportsStarredMessages?[​](#supportsstarredmessages "Direct link to supportsStarredMessages?")

> `optional` **supportsStarredMessages**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3027](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3027)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IWebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload).[`supportsStarredMessages`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload#supportsstarredmessages)

* * *

### supportsUrlMessages?[​](#supportsurlmessages "Direct link to supportsUrlMessages?")

> `optional` **supportsUrlMessages**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3029](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3029)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IWebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload).[`supportsUrlMessages`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload#supportsurlmessages)

* * *

### usesParticipantInKey?[​](#usesparticipantinkey "Direct link to usesParticipantInKey?")

> `optional` **usesParticipantInKey**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3026](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3026)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IWebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload).[`usesParticipantInKey`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload#usesparticipantinkey)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3042](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3042)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`WebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/classes/WebdPayload)

Defined in: [WAProto/index.d.ts:3037](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3037)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IWebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload)

#### Returns[​](#returns-2 "Direct link to Returns")

[`WebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/classes/WebdPayload)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`WebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/classes/WebdPayload)

Defined in: [WAProto/index.d.ts:3039](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3039)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`WebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/classes/WebdPayload)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3038](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3038)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IWebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`WebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/classes/WebdPayload)

Defined in: [WAProto/index.d.ts:3040](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3040)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`WebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/classes/WebdPayload)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3043](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3043)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3041](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3041)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`WebdPayload`](/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/classes/WebdPayload)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-websubplatform"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/enumerations/WebSubPlatform](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/enumerations/WebSubPlatform)

Defined in: [WAProto/index.d.ts:3001](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3001)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### APP\_STORE[​](#app_store "Direct link to APP_STORE")

> **APP\_STORE**: `1`

Defined in: [WAProto/index.d.ts:3003](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3003)

* * *

### DARWIN[​](#darwin "Direct link to DARWIN")

> **DARWIN**: `3`

Defined in: [WAProto/index.d.ts:3005](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3005)

* * *

### WEB\_BROWSER[​](#web_browser "Direct link to WEB_BROWSER")

> **WEB\_BROWSER**: `0`

Defined in: [WAProto/index.d.ts:3002](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3002)

* * *

### WIN\_HYBRID[​](#win_hybrid "Direct link to WIN_HYBRID")

> **WIN\_HYBRID**: `5`

Defined in: [WAProto/index.d.ts:3007](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3007)

* * *

### WIN\_STORE[​](#win_store "Direct link to WIN_STORE")

> **WIN\_STORE**: `2`

Defined in: [WAProto/index.d.ts:3004](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3004)

* * *

### WIN32[​](#win32 "Direct link to WIN32")

> **WIN32**: `4`

Defined in: [WAProto/index.d.ts:3006](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3006)

---

<a name="interface-iwebdpayload"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ClientPayload/namespaces/WebInfo/interfaces/IWebdPayload)

Defined in: [WAProto/index.d.ts:3010](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3010)

## Properties[​](#properties "Direct link to Properties")

### documentTypes?[​](#documenttypes "Direct link to documentTypes?")

> `optional` **documentTypes**: `null` | `string`

Defined in: [WAProto/index.d.ts:3020](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3020)

* * *

### features?[​](#features "Direct link to features?")

> `optional` **features**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3021](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3021)

* * *

### supportsDocumentMessages?[​](#supportsdocumentmessages "Direct link to supportsDocumentMessages?")

> `optional` **supportsDocumentMessages**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3013](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3013)

* * *

### supportsE2EAudio?[​](#supportse2eaudio "Direct link to supportsE2EAudio?")

> `optional` **supportsE2EAudio**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3018](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3018)

* * *

### supportsE2EDocument?[​](#supportse2edocument "Direct link to supportsE2EDocument?")

> `optional` **supportsE2EDocument**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3019](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3019)

* * *

### supportsE2EImage?[​](#supportse2eimage "Direct link to supportsE2EImage?")

> `optional` **supportsE2EImage**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3016](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3016)

* * *

### supportsE2EVideo?[​](#supportse2evideo "Direct link to supportsE2EVideo?")

> `optional` **supportsE2EVideo**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3017](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3017)

* * *

### supportsMediaRetry?[​](#supportsmediaretry "Direct link to supportsMediaRetry?")

> `optional` **supportsMediaRetry**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3015](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3015)

* * *

### supportsStarredMessages?[​](#supportsstarredmessages "Direct link to supportsStarredMessages?")

> `optional` **supportsStarredMessages**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3012](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3012)

* * *

### supportsUrlMessages?[​](#supportsurlmessages "Direct link to supportsUrlMessages?")

> `optional` **supportsUrlMessages**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3014](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3014)

* * *

### usesParticipantInKey?[​](#usesparticipantinkey "Direct link to usesParticipantInKey?")

> `optional` **usesParticipantInKey**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3011](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3011)

---

<a name="contextinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [AdReplyInfo](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/AdReplyInfo/)
*   [DataSharingContext](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/)
*   [ExternalAdReplyInfo](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ExternalAdReplyInfo/)
*   [ForwardedNewsletterMessageInfo](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ForwardedNewsletterMessageInfo/)
*   [StatusAudienceMetadata](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/StatusAudienceMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [ForwardOrigin](/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/ForwardOrigin)
*   [PairedMediaType](/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/PairedMediaType)
*   [QuotedType](/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/QuotedType)
*   [StatusAttributionType](/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/StatusAttributionType)
*   [StatusSourceType](/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/StatusSourceType)

## Classes[​](#classes "Direct link to Classes")

*   [AdReplyInfo](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/AdReplyInfo)
*   [BusinessMessageForwardInfo](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/BusinessMessageForwardInfo)
*   [DataSharingContext](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/DataSharingContext)
*   [ExternalAdReplyInfo](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ExternalAdReplyInfo)
*   [FeatureEligibilities](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/FeatureEligibilities)
*   [ForwardedNewsletterMessageInfo](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ForwardedNewsletterMessageInfo)
*   [QuestionReplyQuotedMessage](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/QuestionReplyQuotedMessage)
*   [StatusAudienceMetadata](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/StatusAudienceMetadata)
*   [UTMInfo](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/UTMInfo)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IAdReplyInfo](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IAdReplyInfo)
*   [IBusinessMessageForwardInfo](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IBusinessMessageForwardInfo)
*   [IDataSharingContext](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IDataSharingContext)
*   [IExternalAdReplyInfo](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo)
*   [IFeatureEligibilities](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IFeatureEligibilities)
*   [IForwardedNewsletterMessageInfo](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo)
*   [IQuestionReplyQuotedMessage](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IQuestionReplyQuotedMessage)
*   [IStatusAudienceMetadata](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IStatusAudienceMetadata)
*   [IUTMInfo](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IUTMInfo)

---

<a name="class-adreplyinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/classes/AdReplyInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/classes/AdReplyInfo)

Defined in: [WAProto/index.d.ts:3262](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3262)

## Implements[​](#implements "Direct link to Implements")

*   [`IAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IAdReplyInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new AdReplyInfo()[​](#new-adreplyinfo "Direct link to new AdReplyInfo()")

> **new AdReplyInfo**(`p`?): [`AdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/AdReplyInfo)

Defined in: [WAProto/index.d.ts:3263](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3263)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IAdReplyInfo)

#### Returns[​](#returns "Direct link to Returns")

[`AdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/AdReplyInfo)

## Properties[​](#properties "Direct link to Properties")

### advertiserName?[​](#advertisername "Direct link to advertiserName?")

> `optional` **advertiserName**: `null` | `string`

Defined in: [WAProto/index.d.ts:3264](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3264)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IAdReplyInfo).[`advertiserName`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IAdReplyInfo#advertisername)

* * *

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:3267](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3267)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IAdReplyInfo).[`caption`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IAdReplyInfo#caption)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3266](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3266)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IAdReplyInfo).[`jpegThumbnail`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IAdReplyInfo#jpegthumbnail)

* * *

### mediaType?[​](#mediatype "Direct link to mediaType?")

> `optional` **mediaType**: `null` | [`MediaType`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/AdReplyInfo/enumerations/MediaType)

Defined in: [WAProto/index.d.ts:3265](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3265)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IAdReplyInfo).[`mediaType`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IAdReplyInfo#mediatype)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3273](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3273)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/AdReplyInfo)

Defined in: [WAProto/index.d.ts:3268](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3268)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IAdReplyInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/AdReplyInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/AdReplyInfo)

Defined in: [WAProto/index.d.ts:3270](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3270)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/AdReplyInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3269](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3269)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IAdReplyInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/AdReplyInfo)

Defined in: [WAProto/index.d.ts:3271](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3271)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/AdReplyInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3274](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3274)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3272](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3272)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/AdReplyInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-businessmessageforwardinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/classes/BusinessMessageForwardInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/classes/BusinessMessageForwardInfo)

Defined in: [WAProto/index.d.ts:3290](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3290)

## Implements[​](#implements "Direct link to Implements")

*   [`IBusinessMessageForwardInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IBusinessMessageForwardInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new BusinessMessageForwardInfo()[​](#new-businessmessageforwardinfo "Direct link to new BusinessMessageForwardInfo()")

> **new BusinessMessageForwardInfo**(`p`?): [`BusinessMessageForwardInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/BusinessMessageForwardInfo)

Defined in: [WAProto/index.d.ts:3291](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3291)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBusinessMessageForwardInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IBusinessMessageForwardInfo)

#### Returns[​](#returns "Direct link to Returns")

[`BusinessMessageForwardInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/BusinessMessageForwardInfo)

## Properties[​](#properties "Direct link to Properties")

### businessOwnerJid?[​](#businessownerjid "Direct link to businessOwnerJid?")

> `optional` **businessOwnerJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:3292](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3292)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBusinessMessageForwardInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IBusinessMessageForwardInfo).[`businessOwnerJid`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IBusinessMessageForwardInfo#businessownerjid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3298](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3298)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BusinessMessageForwardInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/BusinessMessageForwardInfo)

Defined in: [WAProto/index.d.ts:3293](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3293)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBusinessMessageForwardInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IBusinessMessageForwardInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BusinessMessageForwardInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/BusinessMessageForwardInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BusinessMessageForwardInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/BusinessMessageForwardInfo)

Defined in: [WAProto/index.d.ts:3295](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3295)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BusinessMessageForwardInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/BusinessMessageForwardInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3294](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3294)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBusinessMessageForwardInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IBusinessMessageForwardInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BusinessMessageForwardInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/BusinessMessageForwardInfo)

Defined in: [WAProto/index.d.ts:3296](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3296)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BusinessMessageForwardInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/BusinessMessageForwardInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3299](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3299)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3297](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3297)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BusinessMessageForwardInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/BusinessMessageForwardInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-datasharingcontext"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/classes/DataSharingContext](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/classes/DataSharingContext)

Defined in: [WAProto/index.d.ts:3309](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3309)

## Implements[​](#implements "Direct link to Implements")

*   [`IDataSharingContext`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IDataSharingContext)

## Constructors[​](#constructors "Direct link to Constructors")

### new DataSharingContext()[​](#new-datasharingcontext "Direct link to new DataSharingContext()")

> **new DataSharingContext**(`p`?): [`DataSharingContext`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/DataSharingContext)

Defined in: [WAProto/index.d.ts:3310](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3310)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IDataSharingContext`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IDataSharingContext)

#### Returns[​](#returns "Direct link to Returns")

[`DataSharingContext`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/DataSharingContext)

## Properties[​](#properties "Direct link to Properties")

### dataSharingFlags?[​](#datasharingflags "Direct link to dataSharingFlags?")

> `optional` **dataSharingFlags**: `null` | `number`

Defined in: [WAProto/index.d.ts:3314](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3314)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IDataSharingContext`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IDataSharingContext).[`dataSharingFlags`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IDataSharingContext#datasharingflags)

* * *

### encryptedSignalTokenConsented?[​](#encryptedsignaltokenconsented "Direct link to encryptedSignalTokenConsented?")

> `optional` **encryptedSignalTokenConsented**: `null` | `string`

Defined in: [WAProto/index.d.ts:3312](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3312)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IDataSharingContext`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IDataSharingContext).[`encryptedSignalTokenConsented`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IDataSharingContext#encryptedsignaltokenconsented)

* * *

### parameters[​](#parameters-1 "Direct link to parameters")

> **parameters**: [`IParameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters)\[\]

Defined in: [WAProto/index.d.ts:3313](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3313)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IDataSharingContext`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IDataSharingContext).[`parameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IDataSharingContext#parameters)

* * *

### showMmDisclosure?[​](#showmmdisclosure "Direct link to showMmDisclosure?")

> `optional` **showMmDisclosure**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3311](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3311)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IDataSharingContext`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IDataSharingContext).[`showMmDisclosure`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IDataSharingContext#showmmdisclosure)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3320](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3320)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`DataSharingContext`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/DataSharingContext)

Defined in: [WAProto/index.d.ts:3315](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3315)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IDataSharingContext`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IDataSharingContext)

#### Returns[​](#returns-2 "Direct link to Returns")

[`DataSharingContext`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/DataSharingContext)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`DataSharingContext`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/DataSharingContext)

Defined in: [WAProto/index.d.ts:3317](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3317)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`DataSharingContext`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/DataSharingContext)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3316](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3316)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IDataSharingContext`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IDataSharingContext)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`DataSharingContext`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/DataSharingContext)

Defined in: [WAProto/index.d.ts:3318](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3318)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`DataSharingContext`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/DataSharingContext)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3321](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3321)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3319](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3319)

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`DataSharingContext`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/DataSharingContext)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-externaladreplyinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ExternalAdReplyInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ExternalAdReplyInfo)

Defined in: [WAProto/index.d.ts:3386](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3386)

## Implements[​](#implements "Direct link to Implements")

*   [`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new ExternalAdReplyInfo()[​](#new-externaladreplyinfo "Direct link to new ExternalAdReplyInfo()")

> **new ExternalAdReplyInfo**(`p`?): [`ExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ExternalAdReplyInfo)

Defined in: [WAProto/index.d.ts:3387](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3387)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo)

#### Returns[​](#returns "Direct link to Returns")

[`ExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ExternalAdReplyInfo)

## Properties[​](#properties "Direct link to Properties")

### adContextPreviewDismissed?[​](#adcontextpreviewdismissed "Direct link to adContextPreviewDismissed?")

> `optional` **adContextPreviewDismissed**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3403](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3403)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`adContextPreviewDismissed`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#adcontextpreviewdismissed)

* * *

### adPreviewUrl?[​](#adpreviewurl "Direct link to adPreviewUrl?")

> `optional` **adPreviewUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:3414](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3414)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`adPreviewUrl`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#adpreviewurl)

* * *

### adType?[​](#adtype "Direct link to adType?")

> `optional` **adType**: `null` | [`AdType`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ExternalAdReplyInfo/enumerations/AdType)

Defined in: [WAProto/index.d.ts:3412](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3412)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`adType`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#adtype)

* * *

### automatedGreetingMessageCtaType?[​](#automatedgreetingmessagectatype "Direct link to automatedGreetingMessageCtaType?")

> `optional` **automatedGreetingMessageCtaType**: `null` | `string`

Defined in: [WAProto/index.d.ts:3410](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3410)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`automatedGreetingMessageCtaType`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#automatedgreetingmessagectatype)

* * *

### automatedGreetingMessageShown?[​](#automatedgreetingmessageshown "Direct link to automatedGreetingMessageShown?")

> `optional` **automatedGreetingMessageShown**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3405](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3405)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`automatedGreetingMessageShown`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#automatedgreetingmessageshown)

* * *

### body?[​](#body "Direct link to body?")

> `optional` **body**: `null` | `string`

Defined in: [WAProto/index.d.ts:3389](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3389)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`body`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#body)

* * *

### clickToWhatsappCall?[​](#clicktowhatsappcall "Direct link to clickToWhatsappCall?")

> `optional` **clickToWhatsappCall**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3402](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3402)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`clickToWhatsappCall`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#clicktowhatsappcall)

* * *

### containsAutoReply?[​](#containsautoreply "Direct link to containsAutoReply?")

> `optional` **containsAutoReply**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3397](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3397)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`containsAutoReply`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#containsautoreply)

* * *

### ctaPayload?[​](#ctapayload "Direct link to ctaPayload?")

> `optional` **ctaPayload**: `null` | `string`

Defined in: [WAProto/index.d.ts:3407](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3407)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`ctaPayload`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#ctapayload)

* * *

### ctwaClid?[​](#ctwaclid "Direct link to ctwaClid?")

> `optional` **ctwaClid**: `null` | `string`

Defined in: [WAProto/index.d.ts:3400](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3400)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`ctwaClid`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#ctwaclid)

* * *

### disableNudge?[​](#disablenudge "Direct link to disableNudge?")

> `optional` **disableNudge**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3408](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3408)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`disableNudge`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#disablenudge)

* * *

### greetingMessageBody?[​](#greetingmessagebody "Direct link to greetingMessageBody?")

> `optional` **greetingMessageBody**: `null` | `string`

Defined in: [WAProto/index.d.ts:3406](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3406)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`greetingMessageBody`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#greetingmessagebody)

* * *

### mediaType?[​](#mediatype "Direct link to mediaType?")

> `optional` **mediaType**: `null` | [`MediaType`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ExternalAdReplyInfo/enumerations/MediaType)

Defined in: [WAProto/index.d.ts:3390](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3390)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`mediaType`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#mediatype)

* * *

### mediaUrl?[​](#mediaurl "Direct link to mediaUrl?")

> `optional` **mediaUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:3392](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3392)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`mediaUrl`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#mediaurl)

* * *

### originalImageUrl?[​](#originalimageurl "Direct link to originalImageUrl?")

> `optional` **originalImageUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:3409](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3409)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`originalImageUrl`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#originalimageurl)

* * *

### ref?[​](#ref "Direct link to ref?")

> `optional` **ref**: `null` | `string`

Defined in: [WAProto/index.d.ts:3401](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3401)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`ref`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#ref)

* * *

### renderLargerThumbnail?[​](#renderlargerthumbnail "Direct link to renderLargerThumbnail?")

> `optional` **renderLargerThumbnail**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3398](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3398)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`renderLargerThumbnail`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#renderlargerthumbnail)

* * *

### showAdAttribution?[​](#showadattribution "Direct link to showAdAttribution?")

> `optional` **showAdAttribution**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3399](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3399)

#### Implementation of[​](#implementation-of-17 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`showAdAttribution`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#showadattribution)

* * *

### sourceApp?[​](#sourceapp "Direct link to sourceApp?")

> `optional` **sourceApp**: `null` | `string`

Defined in: [WAProto/index.d.ts:3404](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3404)

#### Implementation of[​](#implementation-of-18 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`sourceApp`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#sourceapp)

* * *

### sourceId?[​](#sourceid "Direct link to sourceId?")

> `optional` **sourceId**: `null` | `string`

Defined in: [WAProto/index.d.ts:3395](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3395)

#### Implementation of[​](#implementation-of-19 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`sourceId`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#sourceid)

* * *

### sourceType?[​](#sourcetype "Direct link to sourceType?")

> `optional` **sourceType**: `null` | `string`

Defined in: [WAProto/index.d.ts:3394](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3394)

#### Implementation of[​](#implementation-of-20 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`sourceType`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#sourcetype)

* * *

### sourceUrl?[​](#sourceurl "Direct link to sourceUrl?")

> `optional` **sourceUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:3396](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3396)

#### Implementation of[​](#implementation-of-21 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`sourceUrl`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#sourceurl)

* * *

### thumbnail?[​](#thumbnail "Direct link to thumbnail?")

> `optional` **thumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3393](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3393)

#### Implementation of[​](#implementation-of-22 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`thumbnail`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#thumbnail)

* * *

### thumbnailUrl?[​](#thumbnailurl "Direct link to thumbnailUrl?")

> `optional` **thumbnailUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:3391](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3391)

#### Implementation of[​](#implementation-of-23 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`thumbnailUrl`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#thumbnailurl)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:3388](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3388)

#### Implementation of[​](#implementation-of-24 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`title`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#title)

* * *

### wtwaAdFormat?[​](#wtwaadformat "Direct link to wtwaAdFormat?")

> `optional` **wtwaAdFormat**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3411](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3411)

#### Implementation of[​](#implementation-of-25 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`wtwaAdFormat`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#wtwaadformat)

* * *

### wtwaWebsiteUrl?[​](#wtwawebsiteurl "Direct link to wtwaWebsiteUrl?")

> `optional` **wtwaWebsiteUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:3413](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3413)

#### Implementation of[​](#implementation-of-26 "Direct link to Implementation of")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo).[`wtwaWebsiteUrl`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo#wtwawebsiteurl)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3420](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3420)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ExternalAdReplyInfo)

Defined in: [WAProto/index.d.ts:3415](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3415)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ExternalAdReplyInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ExternalAdReplyInfo)

Defined in: [WAProto/index.d.ts:3417](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3417)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ExternalAdReplyInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3416](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3416)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ExternalAdReplyInfo)

Defined in: [WAProto/index.d.ts:3418](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3418)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ExternalAdReplyInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3421](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3421)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3419](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3419)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ExternalAdReplyInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ExternalAdReplyInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-featureeligibilities"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/classes/FeatureEligibilities](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/classes/FeatureEligibilities)

Defined in: [WAProto/index.d.ts:3446](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3446)

## Implements[​](#implements "Direct link to Implements")

*   [`IFeatureEligibilities`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IFeatureEligibilities)

## Constructors[​](#constructors "Direct link to Constructors")

### new FeatureEligibilities()[​](#new-featureeligibilities "Direct link to new FeatureEligibilities()")

> **new FeatureEligibilities**(`p`?): [`FeatureEligibilities`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/FeatureEligibilities)

Defined in: [WAProto/index.d.ts:3447](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3447)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IFeatureEligibilities`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IFeatureEligibilities)

#### Returns[​](#returns "Direct link to Returns")

[`FeatureEligibilities`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/FeatureEligibilities)

## Properties[​](#properties "Direct link to Properties")

### canBeReshared?[​](#canbereshared "Direct link to canBeReshared?")

> `optional` **canBeReshared**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3451](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3451)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IFeatureEligibilities`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IFeatureEligibilities).[`canBeReshared`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IFeatureEligibilities#canbereshared)

* * *

### cannotBeRanked?[​](#cannotberanked "Direct link to cannotBeRanked?")

> `optional` **cannotBeRanked**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3449](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3449)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IFeatureEligibilities`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IFeatureEligibilities).[`cannotBeRanked`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IFeatureEligibilities#cannotberanked)

* * *

### cannotBeReactedTo?[​](#cannotbereactedto "Direct link to cannotBeReactedTo?")

> `optional` **cannotBeReactedTo**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3448](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3448)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IFeatureEligibilities`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IFeatureEligibilities).[`cannotBeReactedTo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IFeatureEligibilities#cannotbereactedto)

* * *

### canReceiveMultiReact?[​](#canreceivemultireact "Direct link to canReceiveMultiReact?")

> `optional` **canReceiveMultiReact**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3452](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3452)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IFeatureEligibilities`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IFeatureEligibilities).[`canReceiveMultiReact`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IFeatureEligibilities#canreceivemultireact)

* * *

### canRequestFeedback?[​](#canrequestfeedback "Direct link to canRequestFeedback?")

> `optional` **canRequestFeedback**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3450](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3450)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IFeatureEligibilities`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IFeatureEligibilities).[`canRequestFeedback`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IFeatureEligibilities#canrequestfeedback)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3458](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3458)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`FeatureEligibilities`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/FeatureEligibilities)

Defined in: [WAProto/index.d.ts:3453](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3453)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IFeatureEligibilities`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IFeatureEligibilities)

#### Returns[​](#returns-2 "Direct link to Returns")

[`FeatureEligibilities`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/FeatureEligibilities)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`FeatureEligibilities`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/FeatureEligibilities)

Defined in: [WAProto/index.d.ts:3455](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3455)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`FeatureEligibilities`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/FeatureEligibilities)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3454](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3454)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IFeatureEligibilities`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IFeatureEligibilities)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`FeatureEligibilities`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/FeatureEligibilities)

Defined in: [WAProto/index.d.ts:3456](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3456)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`FeatureEligibilities`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/FeatureEligibilities)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3459](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3459)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3457](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3457)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`FeatureEligibilities`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/FeatureEligibilities)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-forwardednewslettermessageinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ForwardedNewsletterMessageInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ForwardedNewsletterMessageInfo)

Defined in: [WAProto/index.d.ts:3479](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3479)

## Implements[​](#implements "Direct link to Implements")

*   [`IForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new ForwardedNewsletterMessageInfo()[​](#new-forwardednewslettermessageinfo "Direct link to new ForwardedNewsletterMessageInfo()")

> **new ForwardedNewsletterMessageInfo**(`p`?): [`ForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ForwardedNewsletterMessageInfo)

Defined in: [WAProto/index.d.ts:3480](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3480)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo)

#### Returns[​](#returns "Direct link to Returns")

[`ForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ForwardedNewsletterMessageInfo)

## Properties[​](#properties "Direct link to Properties")

### accessibilityText?[​](#accessibilitytext "Direct link to accessibilityText?")

> `optional` **accessibilityText**: `null` | `string`

Defined in: [WAProto/index.d.ts:3485](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3485)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo).[`accessibilityText`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo#accessibilitytext)

* * *

### contentType?[​](#contenttype "Direct link to contentType?")

> `optional` **contentType**: `null` | [`ContentType`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ForwardedNewsletterMessageInfo/enumerations/ContentType)

Defined in: [WAProto/index.d.ts:3484](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3484)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo).[`contentType`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo#contenttype)

* * *

### newsletterJid?[​](#newsletterjid "Direct link to newsletterJid?")

> `optional` **newsletterJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:3481](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3481)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo).[`newsletterJid`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo#newsletterjid)

* * *

### newsletterName?[​](#newslettername "Direct link to newsletterName?")

> `optional` **newsletterName**: `null` | `string`

Defined in: [WAProto/index.d.ts:3483](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3483)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo).[`newsletterName`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo#newslettername)

* * *

### serverMessageId?[​](#servermessageid "Direct link to serverMessageId?")

> `optional` **serverMessageId**: `null` | `number`

Defined in: [WAProto/index.d.ts:3482](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3482)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo).[`serverMessageId`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo#servermessageid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3491](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3491)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ForwardedNewsletterMessageInfo)

Defined in: [WAProto/index.d.ts:3486](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3486)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ForwardedNewsletterMessageInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ForwardedNewsletterMessageInfo)

Defined in: [WAProto/index.d.ts:3488](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3488)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ForwardedNewsletterMessageInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3487](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3487)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ForwardedNewsletterMessageInfo)

Defined in: [WAProto/index.d.ts:3489](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3489)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ForwardedNewsletterMessageInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3492](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3492)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3490](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3490)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ForwardedNewsletterMessageInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/ForwardedNewsletterMessageInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-questionreplyquotedmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/classes/QuestionReplyQuotedMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/classes/QuestionReplyQuotedMessage)

Defined in: [WAProto/index.d.ts:3522](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3522)

## Implements[​](#implements "Direct link to Implements")

*   [`IQuestionReplyQuotedMessage`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IQuestionReplyQuotedMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new QuestionReplyQuotedMessage()[​](#new-questionreplyquotedmessage "Direct link to new QuestionReplyQuotedMessage()")

> **new QuestionReplyQuotedMessage**(`p`?): [`QuestionReplyQuotedMessage`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/QuestionReplyQuotedMessage)

Defined in: [WAProto/index.d.ts:3523](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3523)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IQuestionReplyQuotedMessage`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IQuestionReplyQuotedMessage)

#### Returns[​](#returns "Direct link to Returns")

[`QuestionReplyQuotedMessage`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/QuestionReplyQuotedMessage)

## Properties[​](#properties "Direct link to Properties")

### quotedQuestion?[​](#quotedquestion "Direct link to quotedQuestion?")

> `optional` **quotedQuestion**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:3525](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3525)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IQuestionReplyQuotedMessage`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IQuestionReplyQuotedMessage).[`quotedQuestion`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IQuestionReplyQuotedMessage#quotedquestion)

* * *

### quotedResponse?[​](#quotedresponse "Direct link to quotedResponse?")

> `optional` **quotedResponse**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:3526](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3526)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IQuestionReplyQuotedMessage`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IQuestionReplyQuotedMessage).[`quotedResponse`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IQuestionReplyQuotedMessage#quotedresponse)

* * *

### serverQuestionId?[​](#serverquestionid "Direct link to serverQuestionId?")

> `optional` **serverQuestionId**: `null` | `number`

Defined in: [WAProto/index.d.ts:3524](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3524)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IQuestionReplyQuotedMessage`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IQuestionReplyQuotedMessage).[`serverQuestionId`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IQuestionReplyQuotedMessage#serverquestionid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3532](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3532)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`QuestionReplyQuotedMessage`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/QuestionReplyQuotedMessage)

Defined in: [WAProto/index.d.ts:3527](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3527)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IQuestionReplyQuotedMessage`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IQuestionReplyQuotedMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`QuestionReplyQuotedMessage`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/QuestionReplyQuotedMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`QuestionReplyQuotedMessage`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/QuestionReplyQuotedMessage)

Defined in: [WAProto/index.d.ts:3529](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3529)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`QuestionReplyQuotedMessage`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/QuestionReplyQuotedMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3528](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3528)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IQuestionReplyQuotedMessage`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IQuestionReplyQuotedMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`QuestionReplyQuotedMessage`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/QuestionReplyQuotedMessage)

Defined in: [WAProto/index.d.ts:3530](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3530)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`QuestionReplyQuotedMessage`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/QuestionReplyQuotedMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3533](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3533)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3531](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3531)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`QuestionReplyQuotedMessage`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/QuestionReplyQuotedMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-statusaudiencemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/classes/StatusAudienceMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/classes/StatusAudienceMetadata)

Defined in: [WAProto/index.d.ts:3553](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3553)

## Implements[​](#implements "Direct link to Implements")

*   [`IStatusAudienceMetadata`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IStatusAudienceMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new StatusAudienceMetadata()[​](#new-statusaudiencemetadata "Direct link to new StatusAudienceMetadata()")

> **new StatusAudienceMetadata**(`p`?): [`StatusAudienceMetadata`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/StatusAudienceMetadata)

Defined in: [WAProto/index.d.ts:3554](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3554)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IStatusAudienceMetadata`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IStatusAudienceMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`StatusAudienceMetadata`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/StatusAudienceMetadata)

## Properties[​](#properties "Direct link to Properties")

### audienceType?[​](#audiencetype "Direct link to audienceType?")

> `optional` **audienceType**: `null` | [`AudienceType`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/StatusAudienceMetadata/enumerations/AudienceType)

Defined in: [WAProto/index.d.ts:3555](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3555)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IStatusAudienceMetadata`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IStatusAudienceMetadata).[`audienceType`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IStatusAudienceMetadata#audiencetype)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3561](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3561)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`StatusAudienceMetadata`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/StatusAudienceMetadata)

Defined in: [WAProto/index.d.ts:3556](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3556)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IStatusAudienceMetadata`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IStatusAudienceMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`StatusAudienceMetadata`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/StatusAudienceMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`StatusAudienceMetadata`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/StatusAudienceMetadata)

Defined in: [WAProto/index.d.ts:3558](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3558)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`StatusAudienceMetadata`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/StatusAudienceMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3557](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3557)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IStatusAudienceMetadata`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IStatusAudienceMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`StatusAudienceMetadata`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/StatusAudienceMetadata)

Defined in: [WAProto/index.d.ts:3559](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3559)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`StatusAudienceMetadata`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/StatusAudienceMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3562](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3562)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3560](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3560)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`StatusAudienceMetadata`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/StatusAudienceMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-utminfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/classes/UTMInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/classes/UTMInfo)

Defined in: [WAProto/index.d.ts:3587](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3587)

## Implements[​](#implements "Direct link to Implements")

*   [`IUTMInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IUTMInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new UTMInfo()[​](#new-utminfo "Direct link to new UTMInfo()")

> **new UTMInfo**(`p`?): [`UTMInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/UTMInfo)

Defined in: [WAProto/index.d.ts:3588](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3588)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IUTMInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IUTMInfo)

#### Returns[​](#returns "Direct link to Returns")

[`UTMInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/UTMInfo)

## Properties[​](#properties "Direct link to Properties")

### utmCampaign?[​](#utmcampaign "Direct link to utmCampaign?")

> `optional` **utmCampaign**: `null` | `string`

Defined in: [WAProto/index.d.ts:3590](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3590)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IUTMInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IUTMInfo).[`utmCampaign`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IUTMInfo#utmcampaign)

* * *

### utmSource?[​](#utmsource "Direct link to utmSource?")

> `optional` **utmSource**: `null` | `string`

Defined in: [WAProto/index.d.ts:3589](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3589)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IUTMInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IUTMInfo).[`utmSource`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IUTMInfo#utmsource)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3596](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3596)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`UTMInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/UTMInfo)

Defined in: [WAProto/index.d.ts:3591](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3591)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IUTMInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IUTMInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`UTMInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/UTMInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`UTMInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/UTMInfo)

Defined in: [WAProto/index.d.ts:3593](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3593)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`UTMInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/UTMInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3592](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3592)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IUTMInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IUTMInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`UTMInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/UTMInfo)

Defined in: [WAProto/index.d.ts:3594](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3594)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`UTMInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/UTMInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3597](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3597)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3595](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3595)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`UTMInfo`](/docs/api/namespaces/proto/namespaces/ContextInfo/classes/UTMInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-forwardorigin"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/ForwardOrigin](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/ForwardOrigin)

Defined in: [WAProto/index.d.ts:3462](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3462)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### CHANNELS[​](#channels "Direct link to CHANNELS")

> **CHANNELS**: `3`

Defined in: [WAProto/index.d.ts:3466](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3466)

* * *

### CHAT[​](#chat "Direct link to CHAT")

> **CHAT**: `1`

Defined in: [WAProto/index.d.ts:3464](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3464)

* * *

### META\_AI[​](#meta_ai "Direct link to META_AI")

> **META\_AI**: `4`

Defined in: [WAProto/index.d.ts:3467](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3467)

* * *

### STATUS[​](#status "Direct link to STATUS")

> **STATUS**: `2`

Defined in: [WAProto/index.d.ts:3465](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3465)

* * *

### UGC[​](#ugc "Direct link to UGC")

> **UGC**: `5`

Defined in: [WAProto/index.d.ts:3468](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3468)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:3463](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3463)

---

<a name="enumeration-pairedmediatype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/PairedMediaType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/PairedMediaType)

Defined in: [WAProto/index.d.ts:3504](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3504)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### HD\_IMAGE\_CHILD[​](#hd_image_child "Direct link to HD_IMAGE_CHILD")

> **HD\_IMAGE\_CHILD**: `4`

Defined in: [WAProto/index.d.ts:3509](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3509)

* * *

### HD\_VIDEO\_CHILD[​](#hd_video_child "Direct link to HD_VIDEO_CHILD")

> **HD\_VIDEO\_CHILD**: `2`

Defined in: [WAProto/index.d.ts:3507](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3507)

* * *

### HEVC\_VIDEO\_CHILD[​](#hevc_video_child "Direct link to HEVC_VIDEO_CHILD")

> **HEVC\_VIDEO\_CHILD**: `8`

Defined in: [WAProto/index.d.ts:3513](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3513)

* * *

### HEVC\_VIDEO\_PARENT[​](#hevc_video_parent "Direct link to HEVC_VIDEO_PARENT")

> **HEVC\_VIDEO\_PARENT**: `7`

Defined in: [WAProto/index.d.ts:3512](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3512)

* * *

### MOTION\_PHOTO\_CHILD[​](#motion_photo_child "Direct link to MOTION_PHOTO_CHILD")

> **MOTION\_PHOTO\_CHILD**: `6`

Defined in: [WAProto/index.d.ts:3511](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3511)

* * *

### MOTION\_PHOTO\_PARENT[​](#motion_photo_parent "Direct link to MOTION_PHOTO_PARENT")

> **MOTION\_PHOTO\_PARENT**: `5`

Defined in: [WAProto/index.d.ts:3510](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3510)

* * *

### NOT\_PAIRED\_MEDIA[​](#not_paired_media "Direct link to NOT_PAIRED_MEDIA")

> **NOT\_PAIRED\_MEDIA**: `0`

Defined in: [WAProto/index.d.ts:3505](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3505)

* * *

### SD\_IMAGE\_PARENT[​](#sd_image_parent "Direct link to SD_IMAGE_PARENT")

> **SD\_IMAGE\_PARENT**: `3`

Defined in: [WAProto/index.d.ts:3508](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3508)

* * *

### SD\_VIDEO\_PARENT[​](#sd_video_parent "Direct link to SD_VIDEO_PARENT")

> **SD\_VIDEO\_PARENT**: `1`

Defined in: [WAProto/index.d.ts:3506](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3506)

---

<a name="enumeration-quotedtype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/QuotedType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/QuotedType)

Defined in: [WAProto/index.d.ts:3536](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3536)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AUTO[​](#auto "Direct link to AUTO")

> **AUTO**: `1`

Defined in: [WAProto/index.d.ts:3538](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3538)

* * *

### EXPLICIT[​](#explicit "Direct link to EXPLICIT")

> **EXPLICIT**: `0`

Defined in: [WAProto/index.d.ts:3537](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3537)

---

<a name="enumeration-statusattributiontype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/StatusAttributionType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/StatusAttributionType)

Defined in: [WAProto/index.d.ts:3541](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3541)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### FORWARDED\_FROM\_STATUS[​](#forwarded_from_status "Direct link to FORWARDED_FROM_STATUS")

> **FORWARDED\_FROM\_STATUS**: `4`

Defined in: [WAProto/index.d.ts:3546](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3546)

* * *

### NONE[​](#none "Direct link to NONE")

> **NONE**: `0`

Defined in: [WAProto/index.d.ts:3542](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3542)

* * *

### RESHARED\_FROM\_MENTION[​](#reshared_from_mention "Direct link to RESHARED_FROM_MENTION")

> **RESHARED\_FROM\_MENTION**: `1`

Defined in: [WAProto/index.d.ts:3543](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3543)

* * *

### RESHARED\_FROM\_POST[​](#reshared_from_post "Direct link to RESHARED_FROM_POST")

> **RESHARED\_FROM\_POST**: `2`

Defined in: [WAProto/index.d.ts:3544](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3544)

* * *

### RESHARED\_FROM\_POST\_MANY\_TIMES[​](#reshared_from_post_many_times "Direct link to RESHARED_FROM_POST_MANY_TIMES")

> **RESHARED\_FROM\_POST\_MANY\_TIMES**: `3`

Defined in: [WAProto/index.d.ts:3545](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3545)

---

<a name="enumeration-statussourcetype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/StatusSourceType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/enumerations/StatusSourceType)

Defined in: [WAProto/index.d.ts:3573](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3573)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AUDIO[​](#audio "Direct link to AUDIO")

> **AUDIO**: `3`

Defined in: [WAProto/index.d.ts:3577](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3577)

* * *

### GIF[​](#gif "Direct link to GIF")

> **GIF**: `2`

Defined in: [WAProto/index.d.ts:3576](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3576)

* * *

### IMAGE[​](#image "Direct link to IMAGE")

> **IMAGE**: `0`

Defined in: [WAProto/index.d.ts:3574](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3574)

* * *

### MUSIC\_STANDALONE[​](#music_standalone "Direct link to MUSIC_STANDALONE")

> **MUSIC\_STANDALONE**: `5`

Defined in: [WAProto/index.d.ts:3579](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3579)

* * *

### TEXT[​](#text "Direct link to TEXT")

> **TEXT**: `4`

Defined in: [WAProto/index.d.ts:3578](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3578)

* * *

### VIDEO[​](#video "Direct link to VIDEO")

> **VIDEO**: `1`

Defined in: [WAProto/index.d.ts:3575](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3575)

---

<a name="interface-iadreplyinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IAdReplyInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IAdReplyInfo)

Defined in: [WAProto/index.d.ts:3255](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3255)

## Properties[​](#properties "Direct link to Properties")

### advertiserName?[​](#advertisername "Direct link to advertiserName?")

> `optional` **advertiserName**: `null` | `string`

Defined in: [WAProto/index.d.ts:3256](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3256)

* * *

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:3259](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3259)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3258](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3258)

* * *

### mediaType?[​](#mediatype "Direct link to mediaType?")

> `optional` **mediaType**: `null` | [`MediaType`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/AdReplyInfo/enumerations/MediaType)

Defined in: [WAProto/index.d.ts:3257](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3257)

---

<a name="interface-ibusinessmessageforwardinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IBusinessMessageForwardInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IBusinessMessageForwardInfo)

Defined in: [WAProto/index.d.ts:3286](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3286)

## Properties[​](#properties "Direct link to Properties")

### businessOwnerJid?[​](#businessownerjid "Direct link to businessOwnerJid?")

> `optional` **businessOwnerJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:3287](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3287)

---

<a name="interface-idatasharingcontext"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IDataSharingContext](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IDataSharingContext)

Defined in: [WAProto/index.d.ts:3302](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3302)

## Properties[​](#properties "Direct link to Properties")

### dataSharingFlags?[​](#datasharingflags "Direct link to dataSharingFlags?")

> `optional` **dataSharingFlags**: `null` | `number`

Defined in: [WAProto/index.d.ts:3306](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3306)

* * *

### encryptedSignalTokenConsented?[​](#encryptedsignaltokenconsented "Direct link to encryptedSignalTokenConsented?")

> `optional` **encryptedSignalTokenConsented**: `null` | `string`

Defined in: [WAProto/index.d.ts:3304](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3304)

* * *

### parameters?[​](#parameters "Direct link to parameters?")

> `optional` **parameters**: `null` | [`IParameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters)\[\]

Defined in: [WAProto/index.d.ts:3305](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3305)

* * *

### showMmDisclosure?[​](#showmmdisclosure "Direct link to showMmDisclosure?")

> `optional` **showMmDisclosure**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3303](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3303)

---

<a name="interface-iexternaladreplyinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IExternalAdReplyInfo)

Defined in: [WAProto/index.d.ts:3356](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3356)

## Properties[​](#properties "Direct link to Properties")

### adContextPreviewDismissed?[​](#adcontextpreviewdismissed "Direct link to adContextPreviewDismissed?")

> `optional` **adContextPreviewDismissed**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3372](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3372)

* * *

### adPreviewUrl?[​](#adpreviewurl "Direct link to adPreviewUrl?")

> `optional` **adPreviewUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:3383](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3383)

* * *

### adType?[​](#adtype "Direct link to adType?")

> `optional` **adType**: `null` | [`AdType`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ExternalAdReplyInfo/enumerations/AdType)

Defined in: [WAProto/index.d.ts:3381](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3381)

* * *

### automatedGreetingMessageCtaType?[​](#automatedgreetingmessagectatype "Direct link to automatedGreetingMessageCtaType?")

> `optional` **automatedGreetingMessageCtaType**: `null` | `string`

Defined in: [WAProto/index.d.ts:3379](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3379)

* * *

### automatedGreetingMessageShown?[​](#automatedgreetingmessageshown "Direct link to automatedGreetingMessageShown?")

> `optional` **automatedGreetingMessageShown**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3374](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3374)

* * *

### body?[​](#body "Direct link to body?")

> `optional` **body**: `null` | `string`

Defined in: [WAProto/index.d.ts:3358](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3358)

* * *

### clickToWhatsappCall?[​](#clicktowhatsappcall "Direct link to clickToWhatsappCall?")

> `optional` **clickToWhatsappCall**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3371](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3371)

* * *

### containsAutoReply?[​](#containsautoreply "Direct link to containsAutoReply?")

> `optional` **containsAutoReply**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3366](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3366)

* * *

### ctaPayload?[​](#ctapayload "Direct link to ctaPayload?")

> `optional` **ctaPayload**: `null` | `string`

Defined in: [WAProto/index.d.ts:3376](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3376)

* * *

### ctwaClid?[​](#ctwaclid "Direct link to ctwaClid?")

> `optional` **ctwaClid**: `null` | `string`

Defined in: [WAProto/index.d.ts:3369](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3369)

* * *

### disableNudge?[​](#disablenudge "Direct link to disableNudge?")

> `optional` **disableNudge**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3377](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3377)

* * *

### greetingMessageBody?[​](#greetingmessagebody "Direct link to greetingMessageBody?")

> `optional` **greetingMessageBody**: `null` | `string`

Defined in: [WAProto/index.d.ts:3375](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3375)

* * *

### mediaType?[​](#mediatype "Direct link to mediaType?")

> `optional` **mediaType**: `null` | [`MediaType`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ExternalAdReplyInfo/enumerations/MediaType)

Defined in: [WAProto/index.d.ts:3359](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3359)

* * *

### mediaUrl?[​](#mediaurl "Direct link to mediaUrl?")

> `optional` **mediaUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:3361](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3361)

* * *

### originalImageUrl?[​](#originalimageurl "Direct link to originalImageUrl?")

> `optional` **originalImageUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:3378](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3378)

* * *

### ref?[​](#ref "Direct link to ref?")

> `optional` **ref**: `null` | `string`

Defined in: [WAProto/index.d.ts:3370](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3370)

* * *

### renderLargerThumbnail?[​](#renderlargerthumbnail "Direct link to renderLargerThumbnail?")

> `optional` **renderLargerThumbnail**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3367](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3367)

* * *

### showAdAttribution?[​](#showadattribution "Direct link to showAdAttribution?")

> `optional` **showAdAttribution**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3368](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3368)

* * *

### sourceApp?[​](#sourceapp "Direct link to sourceApp?")

> `optional` **sourceApp**: `null` | `string`

Defined in: [WAProto/index.d.ts:3373](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3373)

* * *

### sourceId?[​](#sourceid "Direct link to sourceId?")

> `optional` **sourceId**: `null` | `string`

Defined in: [WAProto/index.d.ts:3364](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3364)

* * *

### sourceType?[​](#sourcetype "Direct link to sourceType?")

> `optional` **sourceType**: `null` | `string`

Defined in: [WAProto/index.d.ts:3363](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3363)

* * *

### sourceUrl?[​](#sourceurl "Direct link to sourceUrl?")

> `optional` **sourceUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:3365](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3365)

* * *

### thumbnail?[​](#thumbnail "Direct link to thumbnail?")

> `optional` **thumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:3362](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3362)

* * *

### thumbnailUrl?[​](#thumbnailurl "Direct link to thumbnailUrl?")

> `optional` **thumbnailUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:3360](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3360)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:3357](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3357)

* * *

### wtwaAdFormat?[​](#wtwaadformat "Direct link to wtwaAdFormat?")

> `optional` **wtwaAdFormat**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3380](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3380)

* * *

### wtwaWebsiteUrl?[​](#wtwawebsiteurl "Direct link to wtwaWebsiteUrl?")

> `optional` **wtwaWebsiteUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:3382](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3382)

---

<a name="interface-ifeatureeligibilities"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IFeatureEligibilities](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IFeatureEligibilities)

Defined in: [WAProto/index.d.ts:3438](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3438)

## Properties[​](#properties "Direct link to Properties")

### canBeReshared?[​](#canbereshared "Direct link to canBeReshared?")

> `optional` **canBeReshared**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3442](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3442)

* * *

### cannotBeRanked?[​](#cannotberanked "Direct link to cannotBeRanked?")

> `optional` **cannotBeRanked**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3440](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3440)

* * *

### cannotBeReactedTo?[​](#cannotbereactedto "Direct link to cannotBeReactedTo?")

> `optional` **cannotBeReactedTo**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3439](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3439)

* * *

### canReceiveMultiReact?[​](#canreceivemultireact "Direct link to canReceiveMultiReact?")

> `optional` **canReceiveMultiReact**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3443](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3443)

* * *

### canRequestFeedback?[​](#canrequestfeedback "Direct link to canRequestFeedback?")

> `optional` **canRequestFeedback**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3441](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3441)

---

<a name="interface-iforwardednewslettermessageinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IForwardedNewsletterMessageInfo)

Defined in: [WAProto/index.d.ts:3471](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3471)

## Properties[​](#properties "Direct link to Properties")

### accessibilityText?[​](#accessibilitytext "Direct link to accessibilityText?")

> `optional` **accessibilityText**: `null` | `string`

Defined in: [WAProto/index.d.ts:3476](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3476)

* * *

### contentType?[​](#contenttype "Direct link to contentType?")

> `optional` **contentType**: `null` | [`ContentType`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ForwardedNewsletterMessageInfo/enumerations/ContentType)

Defined in: [WAProto/index.d.ts:3475](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3475)

* * *

### newsletterJid?[​](#newsletterjid "Direct link to newsletterJid?")

> `optional` **newsletterJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:3472](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3472)

* * *

### newsletterName?[​](#newslettername "Direct link to newsletterName?")

> `optional` **newsletterName**: `null` | `string`

Defined in: [WAProto/index.d.ts:3474](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3474)

* * *

### serverMessageId?[​](#servermessageid "Direct link to serverMessageId?")

> `optional` **serverMessageId**: `null` | `number`

Defined in: [WAProto/index.d.ts:3473](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3473)

---

<a name="interface-iquestionreplyquotedmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IQuestionReplyQuotedMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IQuestionReplyQuotedMessage)

Defined in: [WAProto/index.d.ts:3516](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3516)

## Properties[​](#properties "Direct link to Properties")

### quotedQuestion?[​](#quotedquestion "Direct link to quotedQuestion?")

> `optional` **quotedQuestion**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:3518](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3518)

* * *

### quotedResponse?[​](#quotedresponse "Direct link to quotedResponse?")

> `optional` **quotedResponse**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:3519](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3519)

* * *

### serverQuestionId?[​](#serverquestionid "Direct link to serverQuestionId?")

> `optional` **serverQuestionId**: `null` | `number`

Defined in: [WAProto/index.d.ts:3517](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3517)

---

<a name="interface-istatusaudiencemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IStatusAudienceMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IStatusAudienceMetadata)

Defined in: [WAProto/index.d.ts:3549](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3549)

## Properties[​](#properties "Direct link to Properties")

### audienceType?[​](#audiencetype "Direct link to audienceType?")

> `optional` **audienceType**: `null` | [`AudienceType`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/StatusAudienceMetadata/enumerations/AudienceType)

Defined in: [WAProto/index.d.ts:3550](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3550)

---

<a name="interface-iutminfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IUTMInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/interfaces/IUTMInfo)

Defined in: [WAProto/index.d.ts:3582](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3582)

## Properties[​](#properties "Direct link to Properties")

### utmCampaign?[​](#utmcampaign "Direct link to utmCampaign?")

> `optional` **utmCampaign**: `null` | `string`

Defined in: [WAProto/index.d.ts:3584](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3584)

* * *

### utmSource?[​](#utmsource "Direct link to utmSource?")

> `optional` **utmSource**: `null` | `string`

Defined in: [WAProto/index.d.ts:3583](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3583)

---

<a name="adreplyinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/AdReplyInfo/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/AdReplyInfo/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [MediaType](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/AdReplyInfo/enumerations/MediaType)

---

<a name="enumeration-mediatype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/AdReplyInfo/enumerations/MediaType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/AdReplyInfo/enumerations/MediaType)

Defined in: [WAProto/index.d.ts:3279](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3279)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### IMAGE[​](#image "Direct link to IMAGE")

> **IMAGE**: `1`

Defined in: [WAProto/index.d.ts:3281](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3281)

* * *

### NONE[​](#none "Direct link to NONE")

> **NONE**: `0`

Defined in: [WAProto/index.d.ts:3280](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3280)

* * *

### VIDEO[​](#video "Direct link to VIDEO")

> **VIDEO**: `2`

Defined in: [WAProto/index.d.ts:3282](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3282)

---

<a name="datasharingcontext"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [DataSharingFlags](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/enumerations/DataSharingFlags)

## Classes[​](#classes "Direct link to Classes")

*   [Parameters](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/classes/Parameters)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IParameters](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters)

---

<a name="class-parameters"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/classes/Parameters](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/classes/Parameters)

Defined in: [WAProto/index.d.ts:3339](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3339)

## Implements[​](#implements "Direct link to Implements")

*   [`IParameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters)

## Constructors[​](#constructors "Direct link to Constructors")

### new Parameters()[​](#new-parameters "Direct link to new Parameters()")

> **new Parameters**(`p`?): [`Parameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/classes/Parameters)

Defined in: [WAProto/index.d.ts:3340](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3340)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IParameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters)

#### Returns[​](#returns "Direct link to Returns")

[`Parameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/classes/Parameters)

## Properties[​](#properties "Direct link to Properties")

### contents?[​](#contents "Direct link to contents?")

> `optional` **contents**: `null` | [`IParameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters)

Defined in: [WAProto/index.d.ts:3345](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3345)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IParameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters).[`contents`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters#contents)

* * *

### floatData?[​](#floatdata "Direct link to floatData?")

> `optional` **floatData**: `null` | `number`

Defined in: [WAProto/index.d.ts:3344](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3344)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IParameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters).[`floatData`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters#floatdata)

* * *

### intData?[​](#intdata "Direct link to intData?")

> `optional` **intData**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3343](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3343)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IParameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters).[`intData`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters#intdata)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `string`

Defined in: [WAProto/index.d.ts:3341](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3341)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IParameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters).[`key`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters#key)

* * *

### stringData?[​](#stringdata "Direct link to stringData?")

> `optional` **stringData**: `null` | `string`

Defined in: [WAProto/index.d.ts:3342](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3342)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IParameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters).[`stringData`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters#stringdata)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3351](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3351)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Parameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/classes/Parameters)

Defined in: [WAProto/index.d.ts:3346](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3346)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IParameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Parameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/classes/Parameters)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Parameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/classes/Parameters)

Defined in: [WAProto/index.d.ts:3348](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3348)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Parameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/classes/Parameters)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3347](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3347)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IParameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Parameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/classes/Parameters)

Defined in: [WAProto/index.d.ts:3349](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3349)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Parameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/classes/Parameters)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3352](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3352)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3350](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3350)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Parameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/classes/Parameters)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-datasharingflags"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/enumerations/DataSharingFlags](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/enumerations/DataSharingFlags)

Defined in: [WAProto/index.d.ts:3326](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3326)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### SHOW\_MM\_DISCLOSURE\_ON\_CLICK[​](#show_mm_disclosure_on_click "Direct link to SHOW_MM_DISCLOSURE_ON_CLICK")

> **SHOW\_MM\_DISCLOSURE\_ON\_CLICK**: `1`

Defined in: [WAProto/index.d.ts:3327](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3327)

* * *

### SHOW\_MM\_DISCLOSURE\_ON\_READ[​](#show_mm_disclosure_on_read "Direct link to SHOW_MM_DISCLOSURE_ON_READ")

> **SHOW\_MM\_DISCLOSURE\_ON\_READ**: `2`

Defined in: [WAProto/index.d.ts:3328](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3328)

---

<a name="interface-iparameters"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters)

Defined in: [WAProto/index.d.ts:3331](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3331)

## Properties[​](#properties "Direct link to Properties")

### contents?[​](#contents "Direct link to contents?")

> `optional` **contents**: `null` | [`IParameters`](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/DataSharingContext/interfaces/IParameters)

Defined in: [WAProto/index.d.ts:3336](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3336)

* * *

### floatData?[​](#floatdata "Direct link to floatData?")

> `optional` **floatData**: `null` | `number`

Defined in: [WAProto/index.d.ts:3335](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3335)

* * *

### intData?[​](#intdata "Direct link to intData?")

> `optional` **intData**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3334](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3334)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `string`

Defined in: [WAProto/index.d.ts:3332](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3332)

* * *

### stringData?[​](#stringdata "Direct link to stringData?")

> `optional` **stringData**: `null` | `string`

Defined in: [WAProto/index.d.ts:3333](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3333)

---

<a name="externaladreplyinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ExternalAdReplyInfo/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ExternalAdReplyInfo/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [AdType](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ExternalAdReplyInfo/enumerations/AdType)
*   [MediaType](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ExternalAdReplyInfo/enumerations/MediaType)

---

<a name="enumeration-adtype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ExternalAdReplyInfo/enumerations/AdType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ExternalAdReplyInfo/enumerations/AdType)

Defined in: [WAProto/index.d.ts:3426](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3426)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### CAWC[​](#cawc "Direct link to CAWC")

> **CAWC**: `1`

Defined in: [WAProto/index.d.ts:3428](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3428)

* * *

### CTWA[​](#ctwa "Direct link to CTWA")

> **CTWA**: `0`

Defined in: [WAProto/index.d.ts:3427](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3427)

---

<a name="enumeration-mediatype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ExternalAdReplyInfo/enumerations/MediaType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ExternalAdReplyInfo/enumerations/MediaType)

Defined in: [WAProto/index.d.ts:3431](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3431)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### IMAGE[​](#image "Direct link to IMAGE")

> **IMAGE**: `1`

Defined in: [WAProto/index.d.ts:3433](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3433)

* * *

### NONE[​](#none "Direct link to NONE")

> **NONE**: `0`

Defined in: [WAProto/index.d.ts:3432](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3432)

* * *

### VIDEO[​](#video "Direct link to VIDEO")

> **VIDEO**: `2`

Defined in: [WAProto/index.d.ts:3434](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3434)

---

<a name="forwardednewslettermessageinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ForwardedNewsletterMessageInfo/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ForwardedNewsletterMessageInfo/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [ContentType](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ForwardedNewsletterMessageInfo/enumerations/ContentType)

---

<a name="enumeration-contenttype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ForwardedNewsletterMessageInfo/enumerations/ContentType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/ForwardedNewsletterMessageInfo/enumerations/ContentType)

Defined in: [WAProto/index.d.ts:3497](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3497)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### LINK\_CARD[​](#link_card "Direct link to LINK_CARD")

> **LINK\_CARD**: `3`

Defined in: [WAProto/index.d.ts:3500](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3500)

* * *

### UPDATE[​](#update "Direct link to UPDATE")

> **UPDATE**: `1`

Defined in: [WAProto/index.d.ts:3498](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3498)

* * *

### UPDATE\_CARD[​](#update_card "Direct link to UPDATE_CARD")

> **UPDATE\_CARD**: `2`

Defined in: [WAProto/index.d.ts:3499](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3499)

---

<a name="statusaudiencemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/StatusAudienceMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/StatusAudienceMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [AudienceType](/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/StatusAudienceMetadata/enumerations/AudienceType)

---

<a name="enumeration-audiencetype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/StatusAudienceMetadata/enumerations/AudienceType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ContextInfo/namespaces/StatusAudienceMetadata/enumerations/AudienceType)

Defined in: [WAProto/index.d.ts:3567](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3567)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### CLOSE\_FRIENDS[​](#close_friends "Direct link to CLOSE_FRIENDS")

> **CLOSE\_FRIENDS**: `1`

Defined in: [WAProto/index.d.ts:3569](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3569)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:3568](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3568)

---

<a name="conversation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Conversation/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Conversation/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [EndOfHistoryTransferType](/docs/api/namespaces/proto/namespaces/Conversation/enumerations/EndOfHistoryTransferType)

---

<a name="enumeration-endofhistorytransfertype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Conversation/enumerations/EndOfHistoryTransferType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Conversation/enumerations/EndOfHistoryTransferType)

Defined in: [WAProto/index.d.ts:3725](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3725)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### COMPLETE\_AND\_NO\_MORE\_MESSAGE\_REMAIN\_ON\_PRIMARY[​](#complete_and_no_more_message_remain_on_primary "Direct link to COMPLETE_AND_NO_MORE_MESSAGE_REMAIN_ON_PRIMARY")

> **COMPLETE\_AND\_NO\_MORE\_MESSAGE\_REMAIN\_ON\_PRIMARY**: `1`

Defined in: [WAProto/index.d.ts:3727](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3727)

* * *

### COMPLETE\_BUT\_MORE\_MESSAGES\_REMAIN\_ON\_PRIMARY[​](#complete_but_more_messages_remain_on_primary "Direct link to COMPLETE_BUT_MORE_MESSAGES_REMAIN_ON_PRIMARY")

> **COMPLETE\_BUT\_MORE\_MESSAGES\_REMAIN\_ON\_PRIMARY**: `0`

Defined in: [WAProto/index.d.ts:3726](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3726)

* * *

### COMPLETE\_ON\_DEMAND\_SYNC\_BUT\_MORE\_MSG\_REMAIN\_ON\_PRIMARY[​](#complete_on_demand_sync_but_more_msg_remain_on_primary "Direct link to COMPLETE_ON_DEMAND_SYNC_BUT_MORE_MSG_REMAIN_ON_PRIMARY")

> **COMPLETE\_ON\_DEMAND\_SYNC\_BUT\_MORE\_MSG\_REMAIN\_ON\_PRIMARY**: `2`

Defined in: [WAProto/index.d.ts:3728](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3728)

---

<a name="devicecapabilities"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceCapabilities/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceCapabilities/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [ChatLockSupportLevel](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/enumerations/ChatLockSupportLevel)
*   [MemberNameTagPrimarySupport](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/enumerations/MemberNameTagPrimarySupport)

## Classes[​](#classes "Direct link to Classes")

*   [BusinessBroadcast](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/BusinessBroadcast)
*   [LIDMigration](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/LIDMigration)
*   [UserHasAvatar](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/UserHasAvatar)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IBusinessBroadcast](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IBusinessBroadcast)
*   [ILIDMigration](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/ILIDMigration)
*   [IUserHasAvatar](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IUserHasAvatar)

---

<a name="class-businessbroadcast"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/BusinessBroadcast](https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/BusinessBroadcast)

Defined in: [WAProto/index.d.ts:3762](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3762)

## Implements[​](#implements "Direct link to Implements")

*   [`IBusinessBroadcast`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IBusinessBroadcast)

## Constructors[​](#constructors "Direct link to Constructors")

### new BusinessBroadcast()[​](#new-businessbroadcast "Direct link to new BusinessBroadcast()")

> **new BusinessBroadcast**(`p`?): [`BusinessBroadcast`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/BusinessBroadcast)

Defined in: [WAProto/index.d.ts:3763](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3763)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBusinessBroadcast`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IBusinessBroadcast)

#### Returns[​](#returns "Direct link to Returns")

[`BusinessBroadcast`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/BusinessBroadcast)

## Properties[​](#properties "Direct link to Properties")

### importListEnabled?[​](#importlistenabled "Direct link to importListEnabled?")

> `optional` **importListEnabled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3764](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3764)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBusinessBroadcast`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IBusinessBroadcast).[`importListEnabled`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IBusinessBroadcast#importlistenabled)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3770](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3770)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BusinessBroadcast`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/BusinessBroadcast)

Defined in: [WAProto/index.d.ts:3765](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3765)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBusinessBroadcast`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IBusinessBroadcast)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BusinessBroadcast`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/BusinessBroadcast)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BusinessBroadcast`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/BusinessBroadcast)

Defined in: [WAProto/index.d.ts:3767](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3767)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BusinessBroadcast`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/BusinessBroadcast)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3766](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3766)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBusinessBroadcast`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IBusinessBroadcast)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BusinessBroadcast`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/BusinessBroadcast)

Defined in: [WAProto/index.d.ts:3768](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3768)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BusinessBroadcast`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/BusinessBroadcast)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3771](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3771)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3769](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3769)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BusinessBroadcast`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/BusinessBroadcast)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-lidmigration"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/LIDMigration](https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/LIDMigration)

Defined in: [WAProto/index.d.ts:3784](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3784)

## Implements[​](#implements "Direct link to Implements")

*   [`ILIDMigration`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/ILIDMigration)

## Constructors[​](#constructors "Direct link to Constructors")

### new LIDMigration()[​](#new-lidmigration "Direct link to new LIDMigration()")

> **new LIDMigration**(`p`?): [`LIDMigration`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/LIDMigration)

Defined in: [WAProto/index.d.ts:3785](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3785)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ILIDMigration`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/ILIDMigration)

#### Returns[​](#returns "Direct link to Returns")

[`LIDMigration`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/LIDMigration)

## Properties[​](#properties "Direct link to Properties")

### chatDbMigrationTimestamp?[​](#chatdbmigrationtimestamp "Direct link to chatDbMigrationTimestamp?")

> `optional` **chatDbMigrationTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3786](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3786)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILIDMigration`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/ILIDMigration).[`chatDbMigrationTimestamp`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/ILIDMigration#chatdbmigrationtimestamp)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3792](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3792)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`LIDMigration`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/LIDMigration)

Defined in: [WAProto/index.d.ts:3787](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3787)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ILIDMigration`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/ILIDMigration)

#### Returns[​](#returns-2 "Direct link to Returns")

[`LIDMigration`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/LIDMigration)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`LIDMigration`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/LIDMigration)

Defined in: [WAProto/index.d.ts:3789](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3789)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`LIDMigration`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/LIDMigration)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3788](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3788)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ILIDMigration`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/ILIDMigration)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`LIDMigration`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/LIDMigration)

Defined in: [WAProto/index.d.ts:3790](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3790)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`LIDMigration`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/LIDMigration)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3793](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3793)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3791](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3791)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`LIDMigration`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/LIDMigration)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-userhasavatar"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/UserHasAvatar](https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/UserHasAvatar)

Defined in: [WAProto/index.d.ts:3806](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3806)

## Implements[​](#implements "Direct link to Implements")

*   [`IUserHasAvatar`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IUserHasAvatar)

## Constructors[​](#constructors "Direct link to Constructors")

### new UserHasAvatar()[​](#new-userhasavatar "Direct link to new UserHasAvatar()")

> **new UserHasAvatar**(`p`?): [`UserHasAvatar`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/UserHasAvatar)

Defined in: [WAProto/index.d.ts:3807](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3807)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IUserHasAvatar`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IUserHasAvatar)

#### Returns[​](#returns "Direct link to Returns")

[`UserHasAvatar`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/UserHasAvatar)

## Properties[​](#properties "Direct link to Properties")

### userHasAvatar?[​](#userhasavatar "Direct link to userHasAvatar?")

> `optional` **userHasAvatar**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3808](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3808)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IUserHasAvatar`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IUserHasAvatar).[`userHasAvatar`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IUserHasAvatar#userhasavatar)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3814](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3814)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`UserHasAvatar`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/UserHasAvatar)

Defined in: [WAProto/index.d.ts:3809](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3809)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IUserHasAvatar`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IUserHasAvatar)

#### Returns[​](#returns-2 "Direct link to Returns")

[`UserHasAvatar`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/UserHasAvatar)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`UserHasAvatar`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/UserHasAvatar)

Defined in: [WAProto/index.d.ts:3811](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3811)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`UserHasAvatar`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/UserHasAvatar)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3810](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3810)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IUserHasAvatar`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IUserHasAvatar)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`UserHasAvatar`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/UserHasAvatar)

Defined in: [WAProto/index.d.ts:3812](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3812)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`UserHasAvatar`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/UserHasAvatar)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3815](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3815)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3813](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3813)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`UserHasAvatar`](/docs/api/namespaces/proto/namespaces/DeviceCapabilities/classes/UserHasAvatar)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-chatlocksupportlevel"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceCapabilities/enumerations/ChatLockSupportLevel](https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceCapabilities/enumerations/ChatLockSupportLevel)

Defined in: [WAProto/index.d.ts:3774](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3774)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### FULL[​](#full "Direct link to FULL")

> **FULL**: `2`

Defined in: [WAProto/index.d.ts:3777](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3777)

* * *

### MINIMAL[​](#minimal "Direct link to MINIMAL")

> **MINIMAL**: `1`

Defined in: [WAProto/index.d.ts:3776](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3776)

* * *

### NONE[​](#none "Direct link to NONE")

> **NONE**: `0`

Defined in: [WAProto/index.d.ts:3775](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3775)

---

<a name="enumeration-membernametagprimarysupport"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceCapabilities/enumerations/MemberNameTagPrimarySupport](https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceCapabilities/enumerations/MemberNameTagPrimarySupport)

Defined in: [WAProto/index.d.ts:3796](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3796)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### DISABLED[​](#disabled "Direct link to DISABLED")

> **DISABLED**: `0`

Defined in: [WAProto/index.d.ts:3797](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3797)

* * *

### RECEIVER\_ENABLED[​](#receiver_enabled "Direct link to RECEIVER_ENABLED")

> **RECEIVER\_ENABLED**: `1`

Defined in: [WAProto/index.d.ts:3798](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3798)

* * *

### SENDER\_ENABLED[​](#sender_enabled "Direct link to SENDER_ENABLED")

> **SENDER\_ENABLED**: `2`

Defined in: [WAProto/index.d.ts:3799](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3799)

---

<a name="interface-ibusinessbroadcast"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IBusinessBroadcast](https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IBusinessBroadcast)

Defined in: [WAProto/index.d.ts:3758](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3758)

## Properties[​](#properties "Direct link to Properties")

### importListEnabled?[​](#importlistenabled "Direct link to importListEnabled?")

> `optional` **importListEnabled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3759](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3759)

---

<a name="interface-ilidmigration"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/ILIDMigration](https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/ILIDMigration)

Defined in: [WAProto/index.d.ts:3780](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3780)

## Properties[​](#properties "Direct link to Properties")

### chatDbMigrationTimestamp?[​](#chatdbmigrationtimestamp "Direct link to chatDbMigrationTimestamp?")

> `optional` **chatDbMigrationTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:3781](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3781)

---

<a name="interface-iuserhasavatar"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IUserHasAvatar](https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceCapabilities/interfaces/IUserHasAvatar)

Defined in: [WAProto/index.d.ts:3802](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3802)

## Properties[​](#properties "Direct link to Properties")

### userHasAvatar?[​](#userhasavatar "Direct link to userHasAvatar?")

> `optional` **userHasAvatar**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3803](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3803)

---

<a name="deviceprops"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceProps/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceProps/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [PlatformType](/docs/api/namespaces/proto/namespaces/DeviceProps/enumerations/PlatformType)

## Classes[​](#classes "Direct link to Classes")

*   [AppVersion](/docs/api/namespaces/proto/namespaces/DeviceProps/classes/AppVersion)
*   [HistorySyncConfig](/docs/api/namespaces/proto/namespaces/DeviceProps/classes/HistorySyncConfig)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IAppVersion](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IAppVersion)
*   [IHistorySyncConfig](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig)

---

<a name="class-appversion"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceProps/classes/AppVersion](https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceProps/classes/AppVersion)

Defined in: [WAProto/index.d.ts:3901](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3901)

## Implements[​](#implements "Direct link to Implements")

*   [`IAppVersion`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IAppVersion)

## Constructors[​](#constructors "Direct link to Constructors")

### new AppVersion()[​](#new-appversion "Direct link to new AppVersion()")

> **new AppVersion**(`p`?): [`AppVersion`](/docs/api/namespaces/proto/namespaces/DeviceProps/classes/AppVersion)

Defined in: [WAProto/index.d.ts:3902](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3902)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAppVersion`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IAppVersion)

#### Returns[​](#returns "Direct link to Returns")

[`AppVersion`](/docs/api/namespaces/proto/namespaces/DeviceProps/classes/AppVersion)

## Properties[​](#properties "Direct link to Properties")

### primary?[​](#primary "Direct link to primary?")

> `optional` **primary**: `null` | `number`

Defined in: [WAProto/index.d.ts:3903](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3903)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAppVersion`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IAppVersion).[`primary`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IAppVersion#primary)

* * *

### quaternary?[​](#quaternary "Direct link to quaternary?")

> `optional` **quaternary**: `null` | `number`

Defined in: [WAProto/index.d.ts:3906](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3906)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAppVersion`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IAppVersion).[`quaternary`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IAppVersion#quaternary)

* * *

### quinary?[​](#quinary "Direct link to quinary?")

> `optional` **quinary**: `null` | `number`

Defined in: [WAProto/index.d.ts:3907](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3907)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAppVersion`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IAppVersion).[`quinary`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IAppVersion#quinary)

* * *

### secondary?[​](#secondary "Direct link to secondary?")

> `optional` **secondary**: `null` | `number`

Defined in: [WAProto/index.d.ts:3904](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3904)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IAppVersion`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IAppVersion).[`secondary`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IAppVersion#secondary)

* * *

### tertiary?[​](#tertiary "Direct link to tertiary?")

> `optional` **tertiary**: `null` | `number`

Defined in: [WAProto/index.d.ts:3905](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3905)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IAppVersion`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IAppVersion).[`tertiary`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IAppVersion#tertiary)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3913](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3913)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AppVersion`](/docs/api/namespaces/proto/namespaces/DeviceProps/classes/AppVersion)

Defined in: [WAProto/index.d.ts:3908](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3908)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAppVersion`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IAppVersion)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AppVersion`](/docs/api/namespaces/proto/namespaces/DeviceProps/classes/AppVersion)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AppVersion`](/docs/api/namespaces/proto/namespaces/DeviceProps/classes/AppVersion)

Defined in: [WAProto/index.d.ts:3910](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3910)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AppVersion`](/docs/api/namespaces/proto/namespaces/DeviceProps/classes/AppVersion)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3909](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3909)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAppVersion`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IAppVersion)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AppVersion`](/docs/api/namespaces/proto/namespaces/DeviceProps/classes/AppVersion)

Defined in: [WAProto/index.d.ts:3911](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3911)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AppVersion`](/docs/api/namespaces/proto/namespaces/DeviceProps/classes/AppVersion)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3914](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3914)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3912](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3912)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AppVersion`](/docs/api/namespaces/proto/namespaces/DeviceProps/classes/AppVersion)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-historysyncconfig"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceProps/classes/HistorySyncConfig](https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceProps/classes/HistorySyncConfig)

Defined in: [WAProto/index.d.ts:3939](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3939)

## Implements[​](#implements "Direct link to Implements")

*   [`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig)

## Constructors[​](#constructors "Direct link to Constructors")

### new HistorySyncConfig()[​](#new-historysyncconfig "Direct link to new HistorySyncConfig()")

> **new HistorySyncConfig**(`p`?): [`HistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/classes/HistorySyncConfig)

Defined in: [WAProto/index.d.ts:3940](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3940)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig)

#### Returns[​](#returns "Direct link to Returns")

[`HistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/classes/HistorySyncConfig)

## Properties[​](#properties "Direct link to Properties")

### completeOnDemandReady?[​](#completeondemandready "Direct link to completeOnDemandReady?")

> `optional` **completeOnDemandReady**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3958](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3958)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig).[`completeOnDemandReady`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig#completeondemandready)

* * *

### fullSyncDaysLimit?[​](#fullsyncdayslimit "Direct link to fullSyncDaysLimit?")

> `optional` **fullSyncDaysLimit**: `null` | `number`

Defined in: [WAProto/index.d.ts:3941](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3941)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig).[`fullSyncDaysLimit`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig#fullsyncdayslimit)

* * *

### fullSyncSizeMbLimit?[​](#fullsyncsizemblimit "Direct link to fullSyncSizeMbLimit?")

> `optional` **fullSyncSizeMbLimit**: `null` | `number`

Defined in: [WAProto/index.d.ts:3942](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3942)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig).[`fullSyncSizeMbLimit`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig#fullsyncsizemblimit)

* * *

### inlineInitialPayloadInE2EeMsg?[​](#inlineinitialpayloadine2eemsg "Direct link to inlineInitialPayloadInE2EeMsg?")

> `optional` **inlineInitialPayloadInE2EeMsg**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3944](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3944)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig).[`inlineInitialPayloadInE2EeMsg`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig#inlineinitialpayloadine2eemsg)

* * *

### onDemandReady?[​](#ondemandready "Direct link to onDemandReady?")

> `optional` **onDemandReady**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3956](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3956)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig).[`onDemandReady`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig#ondemandready)

* * *

### recentSyncDaysLimit?[​](#recentsyncdayslimit "Direct link to recentSyncDaysLimit?")

> `optional` **recentSyncDaysLimit**: `null` | `number`

Defined in: [WAProto/index.d.ts:3945](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3945)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig).[`recentSyncDaysLimit`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig#recentsyncdayslimit)

* * *

### storageQuotaMb?[​](#storagequotamb "Direct link to storageQuotaMb?")

> `optional` **storageQuotaMb**: `null` | `number`

Defined in: [WAProto/index.d.ts:3943](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3943)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig).[`storageQuotaMb`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig#storagequotamb)

* * *

### supportAddOnHistorySyncMigration?[​](#supportaddonhistorysyncmigration "Direct link to supportAddOnHistorySyncMigration?")

> `optional` **supportAddOnHistorySyncMigration**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3953](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3953)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig).[`supportAddOnHistorySyncMigration`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig#supportaddonhistorysyncmigration)

* * *

### supportBizHostedMsg?[​](#supportbizhostedmsg "Direct link to supportBizHostedMsg?")

> `optional` **supportBizHostedMsg**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3949](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3949)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig).[`supportBizHostedMsg`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig#supportbizhostedmsg)

* * *

### supportBotUserAgentChatHistory?[​](#supportbotuseragentchathistory "Direct link to supportBotUserAgentChatHistory?")

> `optional` **supportBotUserAgentChatHistory**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3947](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3947)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig).[`supportBotUserAgentChatHistory`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig#supportbotuseragentchathistory)

* * *

### supportCagReactionsAndPolls?[​](#supportcagreactionsandpolls "Direct link to supportCagReactionsAndPolls?")

> `optional` **supportCagReactionsAndPolls**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3948](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3948)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig).[`supportCagReactionsAndPolls`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig#supportcagreactionsandpolls)

* * *

### supportCallLogHistory?[​](#supportcallloghistory "Direct link to supportCallLogHistory?")

> `optional` **supportCallLogHistory**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3946](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3946)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig).[`supportCallLogHistory`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig#supportcallloghistory)

* * *

### supportFbidBotChatHistory?[​](#supportfbidbotchathistory "Direct link to supportFbidBotChatHistory?")

> `optional` **supportFbidBotChatHistory**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3952](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3952)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig).[`supportFbidBotChatHistory`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig#supportfbidbotchathistory)

* * *

### supportGroupHistory?[​](#supportgrouphistory "Direct link to supportGroupHistory?")

> `optional` **supportGroupHistory**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3955](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3955)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig).[`supportGroupHistory`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig#supportgrouphistory)

* * *

### supportGuestChat?[​](#supportguestchat "Direct link to supportGuestChat?")

> `optional` **supportGuestChat**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3957](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3957)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig).[`supportGuestChat`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig#supportguestchat)

* * *

### supportHostedGroupMsg?[​](#supporthostedgroupmsg "Direct link to supportHostedGroupMsg?")

> `optional` **supportHostedGroupMsg**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3951](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3951)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig).[`supportHostedGroupMsg`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig#supporthostedgroupmsg)

* * *

### supportMessageAssociation?[​](#supportmessageassociation "Direct link to supportMessageAssociation?")

> `optional` **supportMessageAssociation**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3954](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3954)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig).[`supportMessageAssociation`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig#supportmessageassociation)

* * *

### supportRecentSyncChunkMessageCountTuning?[​](#supportrecentsyncchunkmessagecounttuning "Direct link to supportRecentSyncChunkMessageCountTuning?")

> `optional` **supportRecentSyncChunkMessageCountTuning**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3950](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3950)

#### Implementation of[​](#implementation-of-17 "Direct link to Implementation of")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig).[`supportRecentSyncChunkMessageCountTuning`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig#supportrecentsyncchunkmessagecounttuning)

* * *

### thumbnailSyncDaysLimit?[​](#thumbnailsyncdayslimit "Direct link to thumbnailSyncDaysLimit?")

> `optional` **thumbnailSyncDaysLimit**: `null` | `number`

Defined in: [WAProto/index.d.ts:3959](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3959)

#### Implementation of[​](#implementation-of-18 "Direct link to Implementation of")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig).[`thumbnailSyncDaysLimit`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig#thumbnailsyncdayslimit)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:3965](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3965)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`HistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/classes/HistorySyncConfig)

Defined in: [WAProto/index.d.ts:3960](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3960)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig)

#### Returns[​](#returns-2 "Direct link to Returns")

[`HistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/classes/HistorySyncConfig)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`HistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/classes/HistorySyncConfig)

Defined in: [WAProto/index.d.ts:3962](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3962)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`HistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/classes/HistorySyncConfig)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:3961](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3961)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`HistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/classes/HistorySyncConfig)

Defined in: [WAProto/index.d.ts:3963](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3963)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`HistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/classes/HistorySyncConfig)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:3966](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3966)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:3964](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3964)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`HistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/classes/HistorySyncConfig)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-platformtype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceProps/enumerations/PlatformType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceProps/enumerations/PlatformType)

Defined in: [WAProto/index.d.ts:3969](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3969)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### ALOHA[​](#aloha "Direct link to ALOHA")

> **ALOHA**: `11`

Defined in: [WAProto/index.d.ts:3981](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3981)

* * *

### ANDROID\_AMBIGUOUS[​](#android_ambiguous "Direct link to ANDROID_AMBIGUOUS")

> **ANDROID\_AMBIGUOUS**: `17`

Defined in: [WAProto/index.d.ts:3987](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3987)

* * *

### ANDROID\_PHONE[​](#android_phone "Direct link to ANDROID_PHONE")

> **ANDROID\_PHONE**: `16`

Defined in: [WAProto/index.d.ts:3986](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3986)

* * *

### ANDROID\_TABLET[​](#android_tablet "Direct link to ANDROID_TABLET")

> **ANDROID\_TABLET**: `9`

Defined in: [WAProto/index.d.ts:3979](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3979)

* * *

### AR\_DEVICE[​](#ar_device "Direct link to AR_DEVICE")

> **AR\_DEVICE**: `20`

Defined in: [WAProto/index.d.ts:3990](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3990)

* * *

### AR\_WRIST[​](#ar_wrist "Direct link to AR_WRIST")

> **AR\_WRIST**: `19`

Defined in: [WAProto/index.d.ts:3989](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3989)

* * *

### CATALINA[​](#catalina "Direct link to CATALINA")

> **CATALINA**: `12`

Defined in: [WAProto/index.d.ts:3982](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3982)

* * *

### CHROME[​](#chrome "Direct link to CHROME")

> **CHROME**: `1`

Defined in: [WAProto/index.d.ts:3971](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3971)

* * *

### CLOUD\_API[​](#cloud_api "Direct link to CLOUD_API")

> **CLOUD\_API**: `23`

Defined in: [WAProto/index.d.ts:3993](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3993)

* * *

### DESKTOP[​](#desktop "Direct link to DESKTOP")

> **DESKTOP**: `7`

Defined in: [WAProto/index.d.ts:3977](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3977)

* * *

### EDGE[​](#edge "Direct link to EDGE")

> **EDGE**: `6`

Defined in: [WAProto/index.d.ts:3976](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3976)

* * *

### FIREFOX[​](#firefox "Direct link to FIREFOX")

> **FIREFOX**: `2`

Defined in: [WAProto/index.d.ts:3972](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3972)

* * *

### IE[​](#ie "Direct link to IE")

> **IE**: `3`

Defined in: [WAProto/index.d.ts:3973](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3973)

* * *

### IOS\_CATALYST[​](#ios_catalyst "Direct link to IOS_CATALYST")

> **IOS\_CATALYST**: `15`

Defined in: [WAProto/index.d.ts:3985](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3985)

* * *

### IOS\_PHONE[​](#ios_phone "Direct link to IOS_PHONE")

> **IOS\_PHONE**: `14`

Defined in: [WAProto/index.d.ts:3984](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3984)

* * *

### IPAD[​](#ipad "Direct link to IPAD")

> **IPAD**: `8`

Defined in: [WAProto/index.d.ts:3978](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3978)

* * *

### OHANA[​](#ohana "Direct link to OHANA")

> **OHANA**: `10`

Defined in: [WAProto/index.d.ts:3980](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3980)

* * *

### OPERA[​](#opera "Direct link to OPERA")

> **OPERA**: `4`

Defined in: [WAProto/index.d.ts:3974](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3974)

* * *

### SAFARI[​](#safari "Direct link to SAFARI")

> **SAFARI**: `5`

Defined in: [WAProto/index.d.ts:3975](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3975)

* * *

### SMARTGLASSES[​](#smartglasses "Direct link to SMARTGLASSES")

> **SMARTGLASSES**: `24`

Defined in: [WAProto/index.d.ts:3994](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3994)

* * *

### TCL\_TV[​](#tcl_tv "Direct link to TCL_TV")

> **TCL\_TV**: `13`

Defined in: [WAProto/index.d.ts:3983](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3983)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:3970](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3970)

* * *

### UWP[​](#uwp "Direct link to UWP")

> **UWP**: `21`

Defined in: [WAProto/index.d.ts:3991](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3991)

* * *

### VR[​](#vr "Direct link to VR")

> **VR**: `22`

Defined in: [WAProto/index.d.ts:3992](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3992)

* * *

### WEAR\_OS[​](#wear_os "Direct link to WEAR_OS")

> **WEAR\_OS**: `18`

Defined in: [WAProto/index.d.ts:3988](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3988)

---

<a name="interface-iappversion"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IAppVersion](https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IAppVersion)

Defined in: [WAProto/index.d.ts:3893](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3893)

## Properties[​](#properties "Direct link to Properties")

### primary?[​](#primary "Direct link to primary?")

> `optional` **primary**: `null` | `number`

Defined in: [WAProto/index.d.ts:3894](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3894)

* * *

### quaternary?[​](#quaternary "Direct link to quaternary?")

> `optional` **quaternary**: `null` | `number`

Defined in: [WAProto/index.d.ts:3897](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3897)

* * *

### quinary?[​](#quinary "Direct link to quinary?")

> `optional` **quinary**: `null` | `number`

Defined in: [WAProto/index.d.ts:3898](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3898)

* * *

### secondary?[​](#secondary "Direct link to secondary?")

> `optional` **secondary**: `null` | `number`

Defined in: [WAProto/index.d.ts:3895](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3895)

* * *

### tertiary?[​](#tertiary "Direct link to tertiary?")

> `optional` **tertiary**: `null` | `number`

Defined in: [WAProto/index.d.ts:3896](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3896)

---

<a name="interface-ihistorysyncconfig"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig](https://baileys.wiki/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig)

Defined in: [WAProto/index.d.ts:3917](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3917)

## Properties[​](#properties "Direct link to Properties")

### completeOnDemandReady?[​](#completeondemandready "Direct link to completeOnDemandReady?")

> `optional` **completeOnDemandReady**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3935](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3935)

* * *

### fullSyncDaysLimit?[​](#fullsyncdayslimit "Direct link to fullSyncDaysLimit?")

> `optional` **fullSyncDaysLimit**: `null` | `number`

Defined in: [WAProto/index.d.ts:3918](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3918)

* * *

### fullSyncSizeMbLimit?[​](#fullsyncsizemblimit "Direct link to fullSyncSizeMbLimit?")

> `optional` **fullSyncSizeMbLimit**: `null` | `number`

Defined in: [WAProto/index.d.ts:3919](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3919)

* * *

### inlineInitialPayloadInE2EeMsg?[​](#inlineinitialpayloadine2eemsg "Direct link to inlineInitialPayloadInE2EeMsg?")

> `optional` **inlineInitialPayloadInE2EeMsg**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3921](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3921)

* * *

### onDemandReady?[​](#ondemandready "Direct link to onDemandReady?")

> `optional` **onDemandReady**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3933](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3933)

* * *

### recentSyncDaysLimit?[​](#recentsyncdayslimit "Direct link to recentSyncDaysLimit?")

> `optional` **recentSyncDaysLimit**: `null` | `number`

Defined in: [WAProto/index.d.ts:3922](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3922)

* * *

### storageQuotaMb?[​](#storagequotamb "Direct link to storageQuotaMb?")

> `optional` **storageQuotaMb**: `null` | `number`

Defined in: [WAProto/index.d.ts:3920](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3920)

* * *

### supportAddOnHistorySyncMigration?[​](#supportaddonhistorysyncmigration "Direct link to supportAddOnHistorySyncMigration?")

> `optional` **supportAddOnHistorySyncMigration**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3930](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3930)

* * *

### supportBizHostedMsg?[​](#supportbizhostedmsg "Direct link to supportBizHostedMsg?")

> `optional` **supportBizHostedMsg**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3926](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3926)

* * *

### supportBotUserAgentChatHistory?[​](#supportbotuseragentchathistory "Direct link to supportBotUserAgentChatHistory?")

> `optional` **supportBotUserAgentChatHistory**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3924](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3924)

* * *

### supportCagReactionsAndPolls?[​](#supportcagreactionsandpolls "Direct link to supportCagReactionsAndPolls?")

> `optional` **supportCagReactionsAndPolls**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3925](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3925)

* * *

### supportCallLogHistory?[​](#supportcallloghistory "Direct link to supportCallLogHistory?")

> `optional` **supportCallLogHistory**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3923](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3923)

* * *

### supportFbidBotChatHistory?[​](#supportfbidbotchathistory "Direct link to supportFbidBotChatHistory?")

> `optional` **supportFbidBotChatHistory**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3929](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3929)

* * *

### supportGroupHistory?[​](#supportgrouphistory "Direct link to supportGroupHistory?")

> `optional` **supportGroupHistory**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3932](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3932)

* * *

### supportGuestChat?[​](#supportguestchat "Direct link to supportGuestChat?")

> `optional` **supportGuestChat**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3934](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3934)

* * *

### supportHostedGroupMsg?[​](#supporthostedgroupmsg "Direct link to supportHostedGroupMsg?")

> `optional` **supportHostedGroupMsg**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3928](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3928)

* * *

### supportMessageAssociation?[​](#supportmessageassociation "Direct link to supportMessageAssociation?")

> `optional` **supportMessageAssociation**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3931](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3931)

* * *

### supportRecentSyncChunkMessageCountTuning?[​](#supportrecentsyncchunkmessagecounttuning "Direct link to supportRecentSyncChunkMessageCountTuning?")

> `optional` **supportRecentSyncChunkMessageCountTuning**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:3927](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3927)

* * *

### thumbnailSyncDaysLimit?[​](#thumbnailsyncdayslimit "Direct link to thumbnailSyncDaysLimit?")

> `optional` **thumbnailSyncDaysLimit**: `null` | `number`

Defined in: [WAProto/index.d.ts:3936](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L3936)

---

<a name="disappearingmode"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/DisappearingMode/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/DisappearingMode/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Initiator](/docs/api/namespaces/proto/namespaces/DisappearingMode/enumerations/Initiator)
*   [Trigger](/docs/api/namespaces/proto/namespaces/DisappearingMode/enumerations/Trigger)

---

<a name="enumeration-initiator"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/DisappearingMode/enumerations/Initiator](https://baileys.wiki/docs/api/namespaces/proto/namespaces/DisappearingMode/enumerations/Initiator)

Defined in: [WAProto/index.d.ts:4022](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4022)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### BIZ\_UPGRADE\_FB\_HOSTING[​](#biz_upgrade_fb_hosting "Direct link to BIZ_UPGRADE_FB_HOSTING")

> **BIZ\_UPGRADE\_FB\_HOSTING**: `3`

Defined in: [WAProto/index.d.ts:4026](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4026)

* * *

### CHANGED\_IN\_CHAT[​](#changed_in_chat "Direct link to CHANGED_IN_CHAT")

> **CHANGED\_IN\_CHAT**: `0`

Defined in: [WAProto/index.d.ts:4023](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4023)

* * *

### INITIATED\_BY\_ME[​](#initiated_by_me "Direct link to INITIATED_BY_ME")

> **INITIATED\_BY\_ME**: `1`

Defined in: [WAProto/index.d.ts:4024](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4024)

* * *

### INITIATED\_BY\_OTHER[​](#initiated_by_other "Direct link to INITIATED_BY_OTHER")

> **INITIATED\_BY\_OTHER**: `2`

Defined in: [WAProto/index.d.ts:4025](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4025)

---

<a name="enumeration-trigger"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/DisappearingMode/enumerations/Trigger](https://baileys.wiki/docs/api/namespaces/proto/namespaces/DisappearingMode/enumerations/Trigger)

Defined in: [WAProto/index.d.ts:4029](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4029)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### ACCOUNT\_SETTING[​](#account_setting "Direct link to ACCOUNT_SETTING")

> **ACCOUNT\_SETTING**: `2`

Defined in: [WAProto/index.d.ts:4032](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4032)

* * *

### BIZ\_SUPPORTS\_FB\_HOSTING[​](#biz_supports_fb_hosting "Direct link to BIZ_SUPPORTS_FB_HOSTING")

> **BIZ\_SUPPORTS\_FB\_HOSTING**: `4`

Defined in: [WAProto/index.d.ts:4034](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4034)

* * *

### BULK\_CHANGE[​](#bulk_change "Direct link to BULK_CHANGE")

> **BULK\_CHANGE**: `3`

Defined in: [WAProto/index.d.ts:4033](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4033)

* * *

### CHAT\_SETTING[​](#chat_setting "Direct link to CHAT_SETTING")

> **CHAT\_SETTING**: `1`

Defined in: [WAProto/index.d.ts:4031](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4031)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:4030](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4030)

* * *

### UNKNOWN\_GROUPS[​](#unknown_groups "Direct link to UNKNOWN_GROUPS")

> **UNKNOWN\_GROUPS**: `5`

Defined in: [WAProto/index.d.ts:4035](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4035)

---

<a name="grouphistorybundleinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/GroupHistoryBundleInfo/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/GroupHistoryBundleInfo/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [ProcessState](/docs/api/namespaces/proto/namespaces/GroupHistoryBundleInfo/enumerations/ProcessState)

---

<a name="enumeration-processstate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/GroupHistoryBundleInfo/enumerations/ProcessState](https://baileys.wiki/docs/api/namespaces/proto/namespaces/GroupHistoryBundleInfo/enumerations/ProcessState)

Defined in: [WAProto/index.d.ts:4354](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4354)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### INJECTED[​](#injected "Direct link to INJECTED")

> **INJECTED**: `1`

Defined in: [WAProto/index.d.ts:4356](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4356)

* * *

### INJECTED\_PARTIAL[​](#injected_partial "Direct link to INJECTED_PARTIAL")

> **INJECTED\_PARTIAL**: `2`

Defined in: [WAProto/index.d.ts:4357](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4357)

* * *

### INJECTION\_FAILED[​](#injection_failed "Direct link to INJECTION_FAILED")

> **INJECTION\_FAILED**: `3`

Defined in: [WAProto/index.d.ts:4358](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4358)

* * *

### INJECTION\_FAILED\_NO\_RETRY[​](#injection_failed_no_retry "Direct link to INJECTION_FAILED_NO_RETRY")

> **INJECTION\_FAILED\_NO\_RETRY**: `4`

Defined in: [WAProto/index.d.ts:4359](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4359)

* * *

### NOT\_INJECTED[​](#not_injected "Direct link to NOT_INJECTED")

> **NOT\_INJECTED**: `0`

Defined in: [WAProto/index.d.ts:4355](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4355)

---

<a name="groupparticipant"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/GroupParticipant/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/GroupParticipant/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Rank](/docs/api/namespaces/proto/namespaces/GroupParticipant/enumerations/Rank)

---

<a name="enumeration-rank"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/GroupParticipant/enumerations/Rank](https://baileys.wiki/docs/api/namespaces/proto/namespaces/GroupParticipant/enumerations/Rank)

Defined in: [WAProto/index.d.ts:4421](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4421)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### ADMIN[​](#admin "Direct link to ADMIN")

> **ADMIN**: `1`

Defined in: [WAProto/index.d.ts:4423](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4423)

* * *

### REGULAR[​](#regular "Direct link to REGULAR")

> **REGULAR**: `0`

Defined in: [WAProto/index.d.ts:4422](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4422)

* * *

### SUPERADMIN[​](#superadmin "Direct link to SUPERADMIN")

> **SUPERADMIN**: `2`

Defined in: [WAProto/index.d.ts:4424](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4424)

---

<a name="handshakemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/HandshakeMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/HandshakeMessage/)

## Classes[​](#classes "Direct link to Classes")

*   [ClientFinish](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientFinish)
*   [ClientHello](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientHello)
*   [ServerHello](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ServerHello)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IClientFinish](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientFinish)
*   [IClientHello](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientHello)
*   [IServerHello](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IServerHello)

---

<a name="class-clientfinish"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientFinish](https://baileys.wiki/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientFinish)

Defined in: [WAProto/index.d.ts:4456](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4456)

## Implements[​](#implements "Direct link to Implements")

*   [`IClientFinish`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientFinish)

## Constructors[​](#constructors "Direct link to Constructors")

### new ClientFinish()[​](#new-clientfinish "Direct link to new ClientFinish()")

> **new ClientFinish**(`p`?): [`ClientFinish`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientFinish)

Defined in: [WAProto/index.d.ts:4457](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4457)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IClientFinish`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientFinish)

#### Returns[​](#returns "Direct link to Returns")

[`ClientFinish`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientFinish)

## Properties[​](#properties "Direct link to Properties")

### extendedCiphertext?[​](#extendedciphertext "Direct link to extendedCiphertext?")

> `optional` **extendedCiphertext**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4460](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4460)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IClientFinish`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientFinish).[`extendedCiphertext`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientFinish#extendedciphertext)

* * *

### payload?[​](#payload "Direct link to payload?")

> `optional` **payload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4459](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4459)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IClientFinish`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientFinish).[`payload`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientFinish#payload)

* * *

### static?[​](#static "Direct link to static?")

> `optional` **static**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4458](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4458)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IClientFinish`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientFinish).[`static`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientFinish#static)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4466](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4466)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ClientFinish`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientFinish)

Defined in: [WAProto/index.d.ts:4461](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4461)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IClientFinish`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientFinish)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ClientFinish`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientFinish)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ClientFinish`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientFinish)

Defined in: [WAProto/index.d.ts:4463](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4463)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ClientFinish`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientFinish)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4462](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4462)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IClientFinish`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientFinish)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ClientFinish`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientFinish)

Defined in: [WAProto/index.d.ts:4464](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4464)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ClientFinish`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientFinish)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4467](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4467)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4465](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4465)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ClientFinish`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientFinish)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-clienthello"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientHello](https://baileys.wiki/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientHello)

Defined in: [WAProto/index.d.ts:4478](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4478)

## Implements[​](#implements "Direct link to Implements")

*   [`IClientHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientHello)

## Constructors[​](#constructors "Direct link to Constructors")

### new ClientHello()[​](#new-clienthello "Direct link to new ClientHello()")

> **new ClientHello**(`p`?): [`ClientHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientHello)

Defined in: [WAProto/index.d.ts:4479](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4479)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IClientHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientHello)

#### Returns[​](#returns "Direct link to Returns")

[`ClientHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientHello)

## Properties[​](#properties "Direct link to Properties")

### ephemeral?[​](#ephemeral "Direct link to ephemeral?")

> `optional` **ephemeral**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4480](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4480)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IClientHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientHello).[`ephemeral`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientHello#ephemeral)

* * *

### extendedCiphertext?[​](#extendedciphertext "Direct link to extendedCiphertext?")

> `optional` **extendedCiphertext**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4484](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4484)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IClientHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientHello).[`extendedCiphertext`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientHello#extendedciphertext)

* * *

### payload?[​](#payload "Direct link to payload?")

> `optional` **payload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4482](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4482)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IClientHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientHello).[`payload`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientHello#payload)

* * *

### static?[​](#static "Direct link to static?")

> `optional` **static**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4481](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4481)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IClientHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientHello).[`static`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientHello#static)

* * *

### useExtended?[​](#useextended "Direct link to useExtended?")

> `optional` **useExtended**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4483](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4483)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IClientHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientHello).[`useExtended`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientHello#useextended)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4490](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4490)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ClientHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientHello)

Defined in: [WAProto/index.d.ts:4485](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4485)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IClientHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientHello)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ClientHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientHello)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ClientHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientHello)

Defined in: [WAProto/index.d.ts:4487](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4487)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ClientHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientHello)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4486](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4486)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IClientHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientHello)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ClientHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientHello)

Defined in: [WAProto/index.d.ts:4488](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4488)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ClientHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientHello)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4491](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4491)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4489](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4489)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ClientHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ClientHello)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-serverhello"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ServerHello](https://baileys.wiki/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ServerHello)

Defined in: [WAProto/index.d.ts:4501](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4501)

## Implements[​](#implements "Direct link to Implements")

*   [`IServerHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IServerHello)

## Constructors[​](#constructors "Direct link to Constructors")

### new ServerHello()[​](#new-serverhello "Direct link to new ServerHello()")

> **new ServerHello**(`p`?): [`ServerHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ServerHello)

Defined in: [WAProto/index.d.ts:4502](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4502)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IServerHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IServerHello)

#### Returns[​](#returns "Direct link to Returns")

[`ServerHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ServerHello)

## Properties[​](#properties "Direct link to Properties")

### ephemeral?[​](#ephemeral "Direct link to ephemeral?")

> `optional` **ephemeral**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4503](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4503)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IServerHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IServerHello).[`ephemeral`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IServerHello#ephemeral)

* * *

### extendedStatic?[​](#extendedstatic "Direct link to extendedStatic?")

> `optional` **extendedStatic**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4506](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4506)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IServerHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IServerHello).[`extendedStatic`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IServerHello#extendedstatic)

* * *

### payload?[​](#payload "Direct link to payload?")

> `optional` **payload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4505](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4505)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IServerHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IServerHello).[`payload`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IServerHello#payload)

* * *

### static?[​](#static "Direct link to static?")

> `optional` **static**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4504](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4504)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IServerHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IServerHello).[`static`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IServerHello#static)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4512](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4512)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ServerHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ServerHello)

Defined in: [WAProto/index.d.ts:4507](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4507)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IServerHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IServerHello)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ServerHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ServerHello)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ServerHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ServerHello)

Defined in: [WAProto/index.d.ts:4509](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4509)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ServerHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ServerHello)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4508](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4508)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IServerHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IServerHello)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ServerHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ServerHello)

Defined in: [WAProto/index.d.ts:4510](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4510)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ServerHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ServerHello)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4513](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4513)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4511](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4511)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ServerHello`](/docs/api/namespaces/proto/namespaces/HandshakeMessage/classes/ServerHello)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-iclientfinish"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientFinish](https://baileys.wiki/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientFinish)

Defined in: [WAProto/index.d.ts:4450](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4450)

## Properties[​](#properties "Direct link to Properties")

### extendedCiphertext?[​](#extendedciphertext "Direct link to extendedCiphertext?")

> `optional` **extendedCiphertext**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4453](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4453)

* * *

### payload?[​](#payload "Direct link to payload?")

> `optional` **payload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4452](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4452)

* * *

### static?[​](#static "Direct link to static?")

> `optional` **static**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4451](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4451)

---

<a name="interface-iclienthello"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientHello](https://baileys.wiki/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IClientHello)

Defined in: [WAProto/index.d.ts:4470](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4470)

## Properties[​](#properties "Direct link to Properties")

### ephemeral?[​](#ephemeral "Direct link to ephemeral?")

> `optional` **ephemeral**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4471](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4471)

* * *

### extendedCiphertext?[​](#extendedciphertext "Direct link to extendedCiphertext?")

> `optional` **extendedCiphertext**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4475](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4475)

* * *

### payload?[​](#payload "Direct link to payload?")

> `optional` **payload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4473](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4473)

* * *

### static?[​](#static "Direct link to static?")

> `optional` **static**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4472](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4472)

* * *

### useExtended?[​](#useextended "Direct link to useExtended?")

> `optional` **useExtended**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:4474](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4474)

---

<a name="interface-iserverhello"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IServerHello](https://baileys.wiki/docs/api/namespaces/proto/namespaces/HandshakeMessage/interfaces/IServerHello)

Defined in: [WAProto/index.d.ts:4494](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4494)

## Properties[​](#properties "Direct link to Properties")

### ephemeral?[​](#ephemeral "Direct link to ephemeral?")

> `optional` **ephemeral**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4495](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4495)

* * *

### extendedStatic?[​](#extendedstatic "Direct link to extendedStatic?")

> `optional` **extendedStatic**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4498](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4498)

* * *

### payload?[​](#payload "Direct link to payload?")

> `optional` **payload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4497](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4497)

* * *

### static?[​](#static "Direct link to static?")

> `optional` **static**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:4496](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4496)

---

<a name="historysync"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/HistorySync/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/HistorySync/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [BotAIWaitListState](/docs/api/namespaces/proto/namespaces/HistorySync/enumerations/BotAIWaitListState)
*   [HistorySyncType](/docs/api/namespaces/proto/namespaces/HistorySync/enumerations/HistorySyncType)

---

<a name="enumeration-botaiwaitliststate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/HistorySync/enumerations/BotAIWaitListState](https://baileys.wiki/docs/api/namespaces/proto/namespaces/HistorySync/enumerations/BotAIWaitListState)

Defined in: [WAProto/index.d.ts:4567](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4567)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AI\_AVAILABLE[​](#ai_available "Direct link to AI_AVAILABLE")

> **AI\_AVAILABLE**: `1`

Defined in: [WAProto/index.d.ts:4569](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4569)

* * *

### IN\_WAITLIST[​](#in_waitlist "Direct link to IN_WAITLIST")

> **IN\_WAITLIST**: `0`

Defined in: [WAProto/index.d.ts:4568](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4568)

---

<a name="enumeration-historysynctype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/HistorySync/enumerations/HistorySyncType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/HistorySync/enumerations/HistorySyncType)

Defined in: [WAProto/index.d.ts:4572](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4572)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### FULL[​](#full "Direct link to FULL")

> **FULL**: `2`

Defined in: [WAProto/index.d.ts:4575](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4575)

* * *

### INITIAL\_BOOTSTRAP[​](#initial_bootstrap "Direct link to INITIAL_BOOTSTRAP")

> **INITIAL\_BOOTSTRAP**: `0`

Defined in: [WAProto/index.d.ts:4573](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4573)

* * *

### INITIAL\_STATUS\_V3[​](#initial_status_v3 "Direct link to INITIAL_STATUS_V3")

> **INITIAL\_STATUS\_V3**: `1`

Defined in: [WAProto/index.d.ts:4574](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4574)

* * *

### NON\_BLOCKING\_DATA[​](#non_blocking_data "Direct link to NON_BLOCKING_DATA")

> **NON\_BLOCKING\_DATA**: `5`

Defined in: [WAProto/index.d.ts:4578](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4578)

* * *

### ON\_DEMAND[​](#on_demand "Direct link to ON_DEMAND")

> **ON\_DEMAND**: `6`

Defined in: [WAProto/index.d.ts:4579](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4579)

* * *

### PUSH\_NAME[​](#push_name "Direct link to PUSH_NAME")

> **PUSH\_NAME**: `4`

Defined in: [WAProto/index.d.ts:4577](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4577)

* * *

### RECENT[​](#recent "Direct link to RECENT")

> **RECENT**: `3`

Defined in: [WAProto/index.d.ts:4576](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4576)

---

<a name="hydratedtemplatebutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [HydratedURLButton](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/namespaces/HydratedURLButton/)

## Classes[​](#classes "Direct link to Classes")

*   [HydratedCallButton](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedCallButton)
*   [HydratedQuickReplyButton](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedQuickReplyButton)
*   [HydratedURLButton](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedURLButton)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IHydratedCallButton](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedCallButton)
*   [IHydratedQuickReplyButton](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedQuickReplyButton)
*   [IHydratedURLButton](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedURLButton)

---

<a name="class-hydratedcallbutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedCallButton](https://baileys.wiki/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedCallButton)

Defined in: [WAProto/index.d.ts:4631](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4631)

## Implements[​](#implements "Direct link to Implements")

*   [`IHydratedCallButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedCallButton)

## Constructors[​](#constructors "Direct link to Constructors")

### new HydratedCallButton()[​](#new-hydratedcallbutton "Direct link to new HydratedCallButton()")

> **new HydratedCallButton**(`p`?): [`HydratedCallButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedCallButton)

Defined in: [WAProto/index.d.ts:4632](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4632)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHydratedCallButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedCallButton)

#### Returns[​](#returns "Direct link to Returns")

[`HydratedCallButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedCallButton)

## Properties[​](#properties "Direct link to Properties")

### displayText?[​](#displaytext "Direct link to displayText?")

> `optional` **displayText**: `null` | `string`

Defined in: [WAProto/index.d.ts:4633](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4633)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHydratedCallButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedCallButton).[`displayText`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedCallButton#displaytext)

* * *

### phoneNumber?[​](#phonenumber "Direct link to phoneNumber?")

> `optional` **phoneNumber**: `null` | `string`

Defined in: [WAProto/index.d.ts:4634](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4634)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IHydratedCallButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedCallButton).[`phoneNumber`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedCallButton#phonenumber)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4640](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4640)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`HydratedCallButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedCallButton)

Defined in: [WAProto/index.d.ts:4635](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4635)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHydratedCallButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedCallButton)

#### Returns[​](#returns-2 "Direct link to Returns")

[`HydratedCallButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedCallButton)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`HydratedCallButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedCallButton)

Defined in: [WAProto/index.d.ts:4637](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4637)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`HydratedCallButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedCallButton)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4636](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4636)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHydratedCallButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedCallButton)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`HydratedCallButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedCallButton)

Defined in: [WAProto/index.d.ts:4638](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4638)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`HydratedCallButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedCallButton)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4641](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4641)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4639](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4639)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`HydratedCallButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedCallButton)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-hydratedquickreplybutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedQuickReplyButton](https://baileys.wiki/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedQuickReplyButton)

Defined in: [WAProto/index.d.ts:4649](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4649)

## Implements[​](#implements "Direct link to Implements")

*   [`IHydratedQuickReplyButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedQuickReplyButton)

## Constructors[​](#constructors "Direct link to Constructors")

### new HydratedQuickReplyButton()[​](#new-hydratedquickreplybutton "Direct link to new HydratedQuickReplyButton()")

> **new HydratedQuickReplyButton**(`p`?): [`HydratedQuickReplyButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedQuickReplyButton)

Defined in: [WAProto/index.d.ts:4650](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4650)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHydratedQuickReplyButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedQuickReplyButton)

#### Returns[​](#returns "Direct link to Returns")

[`HydratedQuickReplyButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedQuickReplyButton)

## Properties[​](#properties "Direct link to Properties")

### displayText?[​](#displaytext "Direct link to displayText?")

> `optional` **displayText**: `null` | `string`

Defined in: [WAProto/index.d.ts:4651](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4651)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHydratedQuickReplyButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedQuickReplyButton).[`displayText`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedQuickReplyButton#displaytext)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:4652](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4652)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IHydratedQuickReplyButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedQuickReplyButton).[`id`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedQuickReplyButton#id)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4658](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4658)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`HydratedQuickReplyButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedQuickReplyButton)

Defined in: [WAProto/index.d.ts:4653](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4653)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHydratedQuickReplyButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedQuickReplyButton)

#### Returns[​](#returns-2 "Direct link to Returns")

[`HydratedQuickReplyButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedQuickReplyButton)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`HydratedQuickReplyButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedQuickReplyButton)

Defined in: [WAProto/index.d.ts:4655](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4655)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`HydratedQuickReplyButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedQuickReplyButton)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4654](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4654)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHydratedQuickReplyButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedQuickReplyButton)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`HydratedQuickReplyButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedQuickReplyButton)

Defined in: [WAProto/index.d.ts:4656](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4656)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`HydratedQuickReplyButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedQuickReplyButton)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4659](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4659)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4657](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4657)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`HydratedQuickReplyButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedQuickReplyButton)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-hydratedurlbutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedURLButton](https://baileys.wiki/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedURLButton)

Defined in: [WAProto/index.d.ts:4669](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4669)

## Implements[​](#implements "Direct link to Implements")

*   [`IHydratedURLButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedURLButton)

## Constructors[​](#constructors "Direct link to Constructors")

### new HydratedURLButton()[​](#new-hydratedurlbutton "Direct link to new HydratedURLButton()")

> **new HydratedURLButton**(`p`?): [`HydratedURLButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedURLButton)

Defined in: [WAProto/index.d.ts:4670](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4670)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHydratedURLButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedURLButton)

#### Returns[​](#returns "Direct link to Returns")

[`HydratedURLButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedURLButton)

## Properties[​](#properties "Direct link to Properties")

### consentedUsersUrl?[​](#consentedusersurl "Direct link to consentedUsersUrl?")

> `optional` **consentedUsersUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:4673](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4673)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHydratedURLButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedURLButton).[`consentedUsersUrl`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedURLButton#consentedusersurl)

* * *

### displayText?[​](#displaytext "Direct link to displayText?")

> `optional` **displayText**: `null` | `string`

Defined in: [WAProto/index.d.ts:4671](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4671)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IHydratedURLButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedURLButton).[`displayText`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedURLButton#displaytext)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:4672](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4672)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IHydratedURLButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedURLButton).[`url`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedURLButton#url)

* * *

### webviewPresentation?[​](#webviewpresentation "Direct link to webviewPresentation?")

> `optional` **webviewPresentation**: `null` | [`WebviewPresentationType`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/namespaces/HydratedURLButton/enumerations/WebviewPresentationType)

Defined in: [WAProto/index.d.ts:4674](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4674)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IHydratedURLButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedURLButton).[`webviewPresentation`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedURLButton#webviewpresentation)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4680](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4680)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`HydratedURLButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedURLButton)

Defined in: [WAProto/index.d.ts:4675](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4675)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHydratedURLButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedURLButton)

#### Returns[​](#returns-2 "Direct link to Returns")

[`HydratedURLButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedURLButton)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`HydratedURLButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedURLButton)

Defined in: [WAProto/index.d.ts:4677](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4677)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`HydratedURLButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedURLButton)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4676](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4676)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHydratedURLButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedURLButton)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`HydratedURLButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedURLButton)

Defined in: [WAProto/index.d.ts:4678](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4678)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`HydratedURLButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedURLButton)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4681](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4681)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4679](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4679)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`HydratedURLButton`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/classes/HydratedURLButton)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ihydratedcallbutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedCallButton](https://baileys.wiki/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedCallButton)

Defined in: [WAProto/index.d.ts:4626](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4626)

## Properties[​](#properties "Direct link to Properties")

### displayText?[​](#displaytext "Direct link to displayText?")

> `optional` **displayText**: `null` | `string`

Defined in: [WAProto/index.d.ts:4627](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4627)

* * *

### phoneNumber?[​](#phonenumber "Direct link to phoneNumber?")

> `optional` **phoneNumber**: `null` | `string`

Defined in: [WAProto/index.d.ts:4628](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4628)

---

<a name="interface-ihydratedquickreplybutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedQuickReplyButton](https://baileys.wiki/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedQuickReplyButton)

Defined in: [WAProto/index.d.ts:4644](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4644)

## Properties[​](#properties "Direct link to Properties")

### displayText?[​](#displaytext "Direct link to displayText?")

> `optional` **displayText**: `null` | `string`

Defined in: [WAProto/index.d.ts:4645](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4645)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:4646](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4646)

---

<a name="interface-ihydratedurlbutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedURLButton](https://baileys.wiki/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/interfaces/IHydratedURLButton)

Defined in: [WAProto/index.d.ts:4662](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4662)

## Properties[​](#properties "Direct link to Properties")

### consentedUsersUrl?[​](#consentedusersurl "Direct link to consentedUsersUrl?")

> `optional` **consentedUsersUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:4665](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4665)

* * *

### displayText?[​](#displaytext "Direct link to displayText?")

> `optional` **displayText**: `null` | `string`

Defined in: [WAProto/index.d.ts:4663](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4663)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:4664](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4664)

* * *

### webviewPresentation?[​](#webviewpresentation "Direct link to webviewPresentation?")

> `optional` **webviewPresentation**: `null` | [`WebviewPresentationType`](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/namespaces/HydratedURLButton/enumerations/WebviewPresentationType)

Defined in: [WAProto/index.d.ts:4666](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4666)

---

<a name="hydratedurlbutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/namespaces/HydratedURLButton/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/namespaces/HydratedURLButton/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [WebviewPresentationType](/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/namespaces/HydratedURLButton/enumerations/WebviewPresentationType)

---

<a name="enumeration-webviewpresentationtype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/namespaces/HydratedURLButton/enumerations/WebviewPresentationType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/HydratedTemplateButton/namespaces/HydratedURLButton/enumerations/WebviewPresentationType)

Defined in: [WAProto/index.d.ts:4686](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4686)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### COMPACT[​](#compact "Direct link to COMPACT")

> **COMPACT**: `3`

Defined in: [WAProto/index.d.ts:4689](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4689)

* * *

### FULL[​](#full "Direct link to FULL")

> **FULL**: `1`

Defined in: [WAProto/index.d.ts:4687](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4687)

* * *

### TALL[​](#tall "Direct link to TALL")

> **TALL**: `2`

Defined in: [WAProto/index.d.ts:4688](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4688)

---

<a name="inthreadsurveymetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/)

## Classes[​](#classes "Direct link to Classes")

*   [InThreadSurveyOption](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyOption)
*   [InThreadSurveyPrivacyStatementPart](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyPrivacyStatementPart)
*   [InThreadSurveyQuestion](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyQuestion)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IInThreadSurveyOption](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyOption)
*   [IInThreadSurveyPrivacyStatementPart](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyPrivacyStatementPart)
*   [IInThreadSurveyQuestion](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyQuestion)

---

<a name="class-inthreadsurveyoption"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyOption](https://baileys.wiki/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyOption)

Defined in: [WAProto/index.d.ts:4768](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4768)

## Implements[​](#implements "Direct link to Implements")

*   [`IInThreadSurveyOption`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyOption)

## Constructors[​](#constructors "Direct link to Constructors")

### new InThreadSurveyOption()[​](#new-inthreadsurveyoption "Direct link to new InThreadSurveyOption()")

> **new InThreadSurveyOption**(`p`?): [`InThreadSurveyOption`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyOption)

Defined in: [WAProto/index.d.ts:4769](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4769)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IInThreadSurveyOption`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyOption)

#### Returns[​](#returns "Direct link to Returns")

[`InThreadSurveyOption`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyOption)

## Properties[​](#properties "Direct link to Properties")

### numericValue?[​](#numericvalue "Direct link to numericValue?")

> `optional` **numericValue**: `null` | `number`

Defined in: [WAProto/index.d.ts:4771](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4771)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IInThreadSurveyOption`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyOption).[`numericValue`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyOption#numericvalue)

* * *

### stringValue?[​](#stringvalue "Direct link to stringValue?")

> `optional` **stringValue**: `null` | `string`

Defined in: [WAProto/index.d.ts:4770](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4770)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IInThreadSurveyOption`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyOption).[`stringValue`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyOption#stringvalue)

* * *

### textTranslated?[​](#texttranslated "Direct link to textTranslated?")

> `optional` **textTranslated**: `null` | `string`

Defined in: [WAProto/index.d.ts:4772](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4772)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IInThreadSurveyOption`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyOption).[`textTranslated`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyOption#texttranslated)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4778](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4778)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`InThreadSurveyOption`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyOption)

Defined in: [WAProto/index.d.ts:4773](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4773)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IInThreadSurveyOption`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyOption)

#### Returns[​](#returns-2 "Direct link to Returns")

[`InThreadSurveyOption`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyOption)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`InThreadSurveyOption`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyOption)

Defined in: [WAProto/index.d.ts:4775](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4775)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`InThreadSurveyOption`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyOption)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4774](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4774)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IInThreadSurveyOption`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyOption)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`InThreadSurveyOption`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyOption)

Defined in: [WAProto/index.d.ts:4776](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4776)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`InThreadSurveyOption`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyOption)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4779](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4779)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4777](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4777)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`InThreadSurveyOption`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyOption)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-inthreadsurveyprivacystatementpart"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyPrivacyStatementPart](https://baileys.wiki/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyPrivacyStatementPart)

Defined in: [WAProto/index.d.ts:4787](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4787)

## Implements[​](#implements "Direct link to Implements")

*   [`IInThreadSurveyPrivacyStatementPart`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyPrivacyStatementPart)

## Constructors[​](#constructors "Direct link to Constructors")

### new InThreadSurveyPrivacyStatementPart()[​](#new-inthreadsurveyprivacystatementpart "Direct link to new InThreadSurveyPrivacyStatementPart()")

> **new InThreadSurveyPrivacyStatementPart**(`p`?): [`InThreadSurveyPrivacyStatementPart`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyPrivacyStatementPart)

Defined in: [WAProto/index.d.ts:4788](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4788)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IInThreadSurveyPrivacyStatementPart`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyPrivacyStatementPart)

#### Returns[​](#returns "Direct link to Returns")

[`InThreadSurveyPrivacyStatementPart`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyPrivacyStatementPart)

## Properties[​](#properties "Direct link to Properties")

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:4789](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4789)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IInThreadSurveyPrivacyStatementPart`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyPrivacyStatementPart).[`text`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyPrivacyStatementPart#text)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:4790](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4790)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IInThreadSurveyPrivacyStatementPart`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyPrivacyStatementPart).[`url`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyPrivacyStatementPart#url)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4796](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4796)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`InThreadSurveyPrivacyStatementPart`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyPrivacyStatementPart)

Defined in: [WAProto/index.d.ts:4791](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4791)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IInThreadSurveyPrivacyStatementPart`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyPrivacyStatementPart)

#### Returns[​](#returns-2 "Direct link to Returns")

[`InThreadSurveyPrivacyStatementPart`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyPrivacyStatementPart)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`InThreadSurveyPrivacyStatementPart`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyPrivacyStatementPart)

Defined in: [WAProto/index.d.ts:4793](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4793)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`InThreadSurveyPrivacyStatementPart`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyPrivacyStatementPart)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4792](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4792)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IInThreadSurveyPrivacyStatementPart`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyPrivacyStatementPart)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`InThreadSurveyPrivacyStatementPart`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyPrivacyStatementPart)

Defined in: [WAProto/index.d.ts:4794](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4794)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`InThreadSurveyPrivacyStatementPart`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyPrivacyStatementPart)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4797](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4797)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4795](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4795)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`InThreadSurveyPrivacyStatementPart`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyPrivacyStatementPart)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-inthreadsurveyquestion"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyQuestion](https://baileys.wiki/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyQuestion)

Defined in: [WAProto/index.d.ts:4806](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4806)

## Implements[​](#implements "Direct link to Implements")

*   [`IInThreadSurveyQuestion`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyQuestion)

## Constructors[​](#constructors "Direct link to Constructors")

### new InThreadSurveyQuestion()[​](#new-inthreadsurveyquestion "Direct link to new InThreadSurveyQuestion()")

> **new InThreadSurveyQuestion**(`p`?): [`InThreadSurveyQuestion`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyQuestion)

Defined in: [WAProto/index.d.ts:4807](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4807)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IInThreadSurveyQuestion`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyQuestion)

#### Returns[​](#returns "Direct link to Returns")

[`InThreadSurveyQuestion`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyQuestion)

## Properties[​](#properties "Direct link to Properties")

### questionId?[​](#questionid "Direct link to questionId?")

> `optional` **questionId**: `null` | `string`

Defined in: [WAProto/index.d.ts:4809](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4809)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IInThreadSurveyQuestion`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyQuestion).[`questionId`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyQuestion#questionid)

* * *

### questionOptions[​](#questionoptions "Direct link to questionOptions")

> **questionOptions**: [`IInThreadSurveyOption`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyOption)\[\]

Defined in: [WAProto/index.d.ts:4810](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4810)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IInThreadSurveyQuestion`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyQuestion).[`questionOptions`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyQuestion#questionoptions)

* * *

### questionText?[​](#questiontext "Direct link to questionText?")

> `optional` **questionText**: `null` | `string`

Defined in: [WAProto/index.d.ts:4808](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4808)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IInThreadSurveyQuestion`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyQuestion).[`questionText`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyQuestion#questiontext)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:4816](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4816)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`InThreadSurveyQuestion`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyQuestion)

Defined in: [WAProto/index.d.ts:4811](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4811)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IInThreadSurveyQuestion`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyQuestion)

#### Returns[​](#returns-2 "Direct link to Returns")

[`InThreadSurveyQuestion`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyQuestion)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`InThreadSurveyQuestion`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyQuestion)

Defined in: [WAProto/index.d.ts:4813](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4813)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`InThreadSurveyQuestion`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyQuestion)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:4812](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4812)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IInThreadSurveyQuestion`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyQuestion)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`InThreadSurveyQuestion`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyQuestion)

Defined in: [WAProto/index.d.ts:4814](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4814)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`InThreadSurveyQuestion`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyQuestion)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:4817](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4817)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:4815](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4815)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`InThreadSurveyQuestion`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/classes/InThreadSurveyQuestion)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-iinthreadsurveyoption"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyOption](https://baileys.wiki/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyOption)

Defined in: [WAProto/index.d.ts:4762](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4762)

## Properties[​](#properties "Direct link to Properties")

### numericValue?[​](#numericvalue "Direct link to numericValue?")

> `optional` **numericValue**: `null` | `number`

Defined in: [WAProto/index.d.ts:4764](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4764)

* * *

### stringValue?[​](#stringvalue "Direct link to stringValue?")

> `optional` **stringValue**: `null` | `string`

Defined in: [WAProto/index.d.ts:4763](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4763)

* * *

### textTranslated?[​](#texttranslated "Direct link to textTranslated?")

> `optional` **textTranslated**: `null` | `string`

Defined in: [WAProto/index.d.ts:4765](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4765)

---

<a name="interface-iinthreadsurveyprivacystatementpart"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyPrivacyStatementPart](https://baileys.wiki/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyPrivacyStatementPart)

Defined in: [WAProto/index.d.ts:4782](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4782)

## Properties[​](#properties "Direct link to Properties")

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:4783](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4783)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:4784](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4784)

---

<a name="interface-iinthreadsurveyquestion"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyQuestion](https://baileys.wiki/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyQuestion)

Defined in: [WAProto/index.d.ts:4800](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4800)

## Properties[​](#properties "Direct link to Properties")

### questionId?[​](#questionid "Direct link to questionId?")

> `optional` **questionId**: `null` | `string`

Defined in: [WAProto/index.d.ts:4802](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4802)

* * *

### questionOptions?[​](#questionoptions "Direct link to questionOptions?")

> `optional` **questionOptions**: `null` | [`IInThreadSurveyOption`](/docs/api/namespaces/proto/namespaces/InThreadSurveyMetadata/interfaces/IInThreadSurveyOption)\[\]

Defined in: [WAProto/index.d.ts:4803](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4803)

* * *

### questionText?[​](#questiontext "Direct link to questionText?")

> `optional` **questionText**: `null` | `string`

Defined in: [WAProto/index.d.ts:4801](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4801)

---

<a name="interactiveannotation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/InteractiveAnnotation/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/InteractiveAnnotation/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [StatusLinkType](/docs/api/namespaces/proto/namespaces/InteractiveAnnotation/enumerations/StatusLinkType)

---

<a name="enumeration-statuslinktype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/InteractiveAnnotation/enumerations/StatusLinkType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/InteractiveAnnotation/enumerations/StatusLinkType)

Defined in: [WAProto/index.d.ts:4854](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4854)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### RASTERIZED\_LINK\_FULL\_URL[​](#rasterized_link_full_url "Direct link to RASTERIZED_LINK_FULL_URL")

> **RASTERIZED\_LINK\_FULL\_URL**: `3`

Defined in: [WAProto/index.d.ts:4857](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4857)

* * *

### RASTERIZED\_LINK\_PREVIEW[​](#rasterized_link_preview "Direct link to RASTERIZED_LINK_PREVIEW")

> **RASTERIZED\_LINK\_PREVIEW**: `1`

Defined in: [WAProto/index.d.ts:4855](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4855)

* * *

### RASTERIZED\_LINK\_TRUNCATED[​](#rasterized_link_truncated "Direct link to RASTERIZED_LINK_TRUNCATED")

> **RASTERIZED\_LINK\_TRUNCATED**: `2`

Defined in: [WAProto/index.d.ts:4856](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L4856)

---

<a name="limitsharing"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/LimitSharing/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/LimitSharing/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [TriggerType](/docs/api/namespaces/proto/namespaces/LimitSharing/enumerations/TriggerType)

---

<a name="enumeration-triggertype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/LimitSharing/enumerations/TriggerType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/LimitSharing/enumerations/TriggerType)

Defined in: [WAProto/index.d.ts:5045](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5045)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### BIZ\_SUPPORTS\_FB\_HOSTING[​](#biz_supports_fb_hosting "Direct link to BIZ_SUPPORTS_FB_HOSTING")

> **BIZ\_SUPPORTS\_FB\_HOSTING**: `2`

Defined in: [WAProto/index.d.ts:5048](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5048)

* * *

### CHAT\_SETTING[​](#chat_setting "Direct link to CHAT_SETTING")

> **CHAT\_SETTING**: `1`

Defined in: [WAProto/index.d.ts:5047](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5047)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:5046](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5046)

* * *

### UNKNOWN\_GROUP[​](#unknown_group "Direct link to UNKNOWN_GROUP")

> **UNKNOWN\_GROUP**: `3`

Defined in: [WAProto/index.d.ts:5049](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5049)

---

<a name="mediaretrynotification"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/MediaRetryNotification/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/MediaRetryNotification/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [ResultType](/docs/api/namespaces/proto/namespaces/MediaRetryNotification/enumerations/ResultType)

---

<a name="enumeration-resulttype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/MediaRetryNotification/enumerations/ResultType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/MediaRetryNotification/enumerations/ResultType)

Defined in: [WAProto/index.d.ts:5153](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5153)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### DECRYPTION\_ERROR[​](#decryption_error "Direct link to DECRYPTION_ERROR")

> **DECRYPTION\_ERROR**: `3`

Defined in: [WAProto/index.d.ts:5157](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5157)

* * *

### GENERAL\_ERROR[​](#general_error "Direct link to GENERAL_ERROR")

> **GENERAL\_ERROR**: `0`

Defined in: [WAProto/index.d.ts:5154](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5154)

* * *

### NOT\_FOUND[​](#not_found "Direct link to NOT_FOUND")

> **NOT\_FOUND**: `2`

Defined in: [WAProto/index.d.ts:5156](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5156)

* * *

### SUCCESS[​](#success "Direct link to SUCCESS")

> **SUCCESS**: `1`

Defined in: [WAProto/index.d.ts:5155](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5155)

---

<a name="message"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [BCallMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/BCallMessage/)
*   [ButtonsMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/)
*   [ButtonsResponseMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsResponseMessage/)
*   [CallLogMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/)
*   [CloudAPIThreadControlNotification](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/)
*   [EventResponseMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/EventResponseMessage/)
*   [ExtendedTextMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/ExtendedTextMessage/)
*   [GroupInviteMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/GroupInviteMessage/)
*   [HighlyStructuredMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/)
*   [ImageMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/ImageMessage/)
*   [InteractiveMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/)
*   [InteractiveResponseMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/)
*   [InvoiceMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/InvoiceMessage/)
*   [LinkPreviewMetadata](/docs/api/namespaces/proto/namespaces/Message/namespaces/LinkPreviewMetadata/)
*   [ListMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/)
*   [ListResponseMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/)
*   [OrderMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/OrderMessage/)
*   [PaymentInviteMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentInviteMessage/)
*   [PaymentLinkMetadata](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/)
*   [PeerDataOperationRequestMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/)
*   [PeerDataOperationRequestResponseMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/)
*   [PinInChatMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/PinInChatMessage/)
*   [PlaceholderMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/PlaceholderMessage/)
*   [PollCreationMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/)
*   [PollResultSnapshotMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/)
*   [ProductMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/)
*   [ProtocolMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProtocolMessage/)
*   [RequestWelcomeMessageMetadata](/docs/api/namespaces/proto/namespaces/Message/namespaces/RequestWelcomeMessageMetadata/)
*   [ScheduledCallCreationMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/ScheduledCallCreationMessage/)
*   [ScheduledCallEditMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/ScheduledCallEditMessage/)
*   [SecretEncryptedMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/SecretEncryptedMessage/)
*   [StatusNotificationMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusNotificationMessage/)
*   [StatusQuotedMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusQuotedMessage/)
*   [StatusStickerInteractionMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusStickerInteractionMessage/)
*   [StickerPackMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/StickerPackMessage/)
*   [TemplateMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/)
*   [VideoMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/VideoMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [HistorySyncType](/docs/api/namespaces/proto/namespaces/Message/enumerations/HistorySyncType)
*   [MediaKeyDomain](/docs/api/namespaces/proto/namespaces/Message/enumerations/MediaKeyDomain)
*   [PeerDataOperationRequestType](/docs/api/namespaces/proto/namespaces/Message/enumerations/PeerDataOperationRequestType)
*   [PollContentType](/docs/api/namespaces/proto/namespaces/Message/enumerations/PollContentType)
*   [PollType](/docs/api/namespaces/proto/namespaces/Message/enumerations/PollType)

## Classes[​](#classes "Direct link to Classes")

*   [AlbumMessage](/docs/api/namespaces/proto/namespaces/Message/classes/AlbumMessage)
*   [AppStateFatalExceptionNotification](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateFatalExceptionNotification)
*   [AppStateSyncKey](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKey)
*   [AppStateSyncKeyData](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyData)
*   [AppStateSyncKeyFingerprint](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyFingerprint)
*   [AppStateSyncKeyId](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyId)
*   [AppStateSyncKeyRequest](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyRequest)
*   [AppStateSyncKeyShare](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyShare)
*   [AudioMessage](/docs/api/namespaces/proto/namespaces/Message/classes/AudioMessage)
*   [BCallMessage](/docs/api/namespaces/proto/namespaces/Message/classes/BCallMessage)
*   [ButtonsMessage](/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsMessage)
*   [ButtonsResponseMessage](/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsResponseMessage)
*   [Call](/docs/api/namespaces/proto/namespaces/Message/classes/Call)
*   [CallLogMessage](/docs/api/namespaces/proto/namespaces/Message/classes/CallLogMessage)
*   [CancelPaymentRequestMessage](/docs/api/namespaces/proto/namespaces/Message/classes/CancelPaymentRequestMessage)
*   [Chat](/docs/api/namespaces/proto/namespaces/Message/classes/Chat)
*   [CloudAPIThreadControlNotification](/docs/api/namespaces/proto/namespaces/Message/classes/CloudAPIThreadControlNotification)
*   [CommentMessage](/docs/api/namespaces/proto/namespaces/Message/classes/CommentMessage)
*   [ContactMessage](/docs/api/namespaces/proto/namespaces/Message/classes/ContactMessage)
*   [ContactsArrayMessage](/docs/api/namespaces/proto/namespaces/Message/classes/ContactsArrayMessage)
*   [DeclinePaymentRequestMessage](/docs/api/namespaces/proto/namespaces/Message/classes/DeclinePaymentRequestMessage)
*   [DeviceSentMessage](/docs/api/namespaces/proto/namespaces/Message/classes/DeviceSentMessage)
*   [DocumentMessage](/docs/api/namespaces/proto/namespaces/Message/classes/DocumentMessage)
*   [EncCommentMessage](/docs/api/namespaces/proto/namespaces/Message/classes/EncCommentMessage)
*   [EncEventResponseMessage](/docs/api/namespaces/proto/namespaces/Message/classes/EncEventResponseMessage)
*   [EncReactionMessage](/docs/api/namespaces/proto/namespaces/Message/classes/EncReactionMessage)
*   [EventMessage](/docs/api/namespaces/proto/namespaces/Message/classes/EventMessage)
*   [EventResponseMessage](/docs/api/namespaces/proto/namespaces/Message/classes/EventResponseMessage)
*   [ExtendedTextMessage](/docs/api/namespaces/proto/namespaces/Message/classes/ExtendedTextMessage)
*   [FullHistorySyncOnDemandRequestMetadata](/docs/api/namespaces/proto/namespaces/Message/classes/FullHistorySyncOnDemandRequestMetadata)
*   [FutureProofMessage](/docs/api/namespaces/proto/namespaces/Message/classes/FutureProofMessage)
*   [GroupInviteMessage](/docs/api/namespaces/proto/namespaces/Message/classes/GroupInviteMessage)
*   [HighlyStructuredMessage](/docs/api/namespaces/proto/namespaces/Message/classes/HighlyStructuredMessage)
*   [HistorySyncMessageAccessStatus](/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncMessageAccessStatus)
*   [HistorySyncNotification](/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncNotification)
*   [ImageMessage](/docs/api/namespaces/proto/namespaces/Message/classes/ImageMessage)
*   [InitialSecurityNotificationSettingSync](/docs/api/namespaces/proto/namespaces/Message/classes/InitialSecurityNotificationSettingSync)
*   [InteractiveMessage](/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveMessage)
*   [InteractiveResponseMessage](/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveResponseMessage)
*   [InvoiceMessage](/docs/api/namespaces/proto/namespaces/Message/classes/InvoiceMessage)
*   [KeepInChatMessage](/docs/api/namespaces/proto/namespaces/Message/classes/KeepInChatMessage)
*   [LinkPreviewMetadata](/docs/api/namespaces/proto/namespaces/Message/classes/LinkPreviewMetadata)
*   [ListMessage](/docs/api/namespaces/proto/namespaces/Message/classes/ListMessage)
*   [ListResponseMessage](/docs/api/namespaces/proto/namespaces/Message/classes/ListResponseMessage)
*   [LiveLocationMessage](/docs/api/namespaces/proto/namespaces/Message/classes/LiveLocationMessage)
*   [LocationMessage](/docs/api/namespaces/proto/namespaces/Message/classes/LocationMessage)
*   [MessageHistoryBundle](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryBundle)
*   [MessageHistoryMetadata](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryMetadata)
*   [MessageHistoryNotice](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryNotice)
*   [MMSThumbnailMetadata](/docs/api/namespaces/proto/namespaces/Message/classes/MMSThumbnailMetadata)
*   [NewsletterAdminInviteMessage](/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterAdminInviteMessage)
*   [NewsletterFollowerInviteMessage](/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterFollowerInviteMessage)
*   [OrderMessage](/docs/api/namespaces/proto/namespaces/Message/classes/OrderMessage)
*   [PaymentExtendedMetadata](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentExtendedMetadata)
*   [PaymentInviteMessage](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentInviteMessage)
*   [PaymentLinkMetadata](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentLinkMetadata)
*   [PeerDataOperationRequestMessage](/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestMessage)
*   [PeerDataOperationRequestResponseMessage](/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestResponseMessage)
*   [PinInChatMessage](/docs/api/namespaces/proto/namespaces/Message/classes/PinInChatMessage)
*   [PlaceholderMessage](/docs/api/namespaces/proto/namespaces/Message/classes/PlaceholderMessage)
*   [PollCreationMessage](/docs/api/namespaces/proto/namespaces/Message/classes/PollCreationMessage)
*   [PollEncValue](/docs/api/namespaces/proto/namespaces/Message/classes/PollEncValue)
*   [PollResultSnapshotMessage](/docs/api/namespaces/proto/namespaces/Message/classes/PollResultSnapshotMessage)
*   [PollUpdateMessage](/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessage)
*   [PollUpdateMessageMetadata](/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessageMetadata)
*   [PollVoteMessage](/docs/api/namespaces/proto/namespaces/Message/classes/PollVoteMessage)
*   [ProductMessage](/docs/api/namespaces/proto/namespaces/Message/classes/ProductMessage)
*   [ProtocolMessage](/docs/api/namespaces/proto/namespaces/Message/classes/ProtocolMessage)
*   [QuestionResponseMessage](/docs/api/namespaces/proto/namespaces/Message/classes/QuestionResponseMessage)
*   [ReactionMessage](/docs/api/namespaces/proto/namespaces/Message/classes/ReactionMessage)
*   [RequestPaymentMessage](/docs/api/namespaces/proto/namespaces/Message/classes/RequestPaymentMessage)
*   [RequestPhoneNumberMessage](/docs/api/namespaces/proto/namespaces/Message/classes/RequestPhoneNumberMessage)
*   [RequestWelcomeMessageMetadata](/docs/api/namespaces/proto/namespaces/Message/classes/RequestWelcomeMessageMetadata)
*   [ScheduledCallCreationMessage](/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallCreationMessage)
*   [ScheduledCallEditMessage](/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallEditMessage)
*   [SecretEncryptedMessage](/docs/api/namespaces/proto/namespaces/Message/classes/SecretEncryptedMessage)
*   [SenderKeyDistributionMessage](/docs/api/namespaces/proto/namespaces/Message/classes/SenderKeyDistributionMessage)
*   [SendPaymentMessage](/docs/api/namespaces/proto/namespaces/Message/classes/SendPaymentMessage)
*   [StatusNotificationMessage](/docs/api/namespaces/proto/namespaces/Message/classes/StatusNotificationMessage)
*   [StatusQuestionAnswerMessage](/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuestionAnswerMessage)
*   [StatusQuotedMessage](/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuotedMessage)
*   [StatusStickerInteractionMessage](/docs/api/namespaces/proto/namespaces/Message/classes/StatusStickerInteractionMessage)
*   [StickerMessage](/docs/api/namespaces/proto/namespaces/Message/classes/StickerMessage)
*   [StickerPackMessage](/docs/api/namespaces/proto/namespaces/Message/classes/StickerPackMessage)
*   [StickerSyncRMRMessage](/docs/api/namespaces/proto/namespaces/Message/classes/StickerSyncRMRMessage)
*   [TemplateButtonReplyMessage](/docs/api/namespaces/proto/namespaces/Message/classes/TemplateButtonReplyMessage)
*   [TemplateMessage](/docs/api/namespaces/proto/namespaces/Message/classes/TemplateMessage)
*   [URLMetadata](/docs/api/namespaces/proto/namespaces/Message/classes/URLMetadata)
*   [VideoEndCard](/docs/api/namespaces/proto/namespaces/Message/classes/VideoEndCard)
*   [VideoMessage](/docs/api/namespaces/proto/namespaces/Message/classes/VideoMessage)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IAlbumMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAlbumMessage)
*   [IAppStateFatalExceptionNotification](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateFatalExceptionNotification)
*   [IAppStateSyncKey](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKey)
*   [IAppStateSyncKeyData](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyData)
*   [IAppStateSyncKeyFingerprint](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyFingerprint)
*   [IAppStateSyncKeyId](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyId)
*   [IAppStateSyncKeyRequest](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyRequest)
*   [IAppStateSyncKeyShare](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyShare)
*   [IAudioMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage)
*   [IBCallMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IBCallMessage)
*   [IButtonsMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage)
*   [IButtonsResponseMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsResponseMessage)
*   [ICall](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall)
*   [ICallLogMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICallLogMessage)
*   [ICancelPaymentRequestMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICancelPaymentRequestMessage)
*   [IChat](/docs/api/namespaces/proto/namespaces/Message/interfaces/IChat)
*   [ICloudAPIThreadControlNotification](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification)
*   [ICommentMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICommentMessage)
*   [IContactMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactMessage)
*   [IContactsArrayMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactsArrayMessage)
*   [IDeclinePaymentRequestMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeclinePaymentRequestMessage)
*   [IDeviceSentMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeviceSentMessage)
*   [IDocumentMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage)
*   [IEncCommentMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncCommentMessage)
*   [IEncEventResponseMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncEventResponseMessage)
*   [IEncReactionMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncReactionMessage)
*   [IEventMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage)
*   [IEventResponseMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventResponseMessage)
*   [IExtendedTextMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage)
*   [IFullHistorySyncOnDemandRequestMetadata](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFullHistorySyncOnDemandRequestMetadata)
*   [IFutureProofMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)
*   [IGroupInviteMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage)
*   [IHighlyStructuredMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)
*   [IHistorySyncMessageAccessStatus](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncMessageAccessStatus)
*   [IHistorySyncNotification](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification)
*   [IImageMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage)
*   [IInitialSecurityNotificationSettingSync](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInitialSecurityNotificationSettingSync)
*   [IInteractiveMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage)
*   [IInteractiveResponseMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveResponseMessage)
*   [IInvoiceMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage)
*   [IKeepInChatMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IKeepInChatMessage)
*   [ILinkPreviewMetadata](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata)
*   [IListMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage)
*   [IListResponseMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListResponseMessage)
*   [ILiveLocationMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage)
*   [ILocationMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage)
*   [IMessageHistoryBundle](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle)
*   [IMessageHistoryMetadata](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryMetadata)
*   [IMessageHistoryNotice](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryNotice)
*   [IMMSThumbnailMetadata](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata)
*   [INewsletterAdminInviteMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage)
*   [INewsletterFollowerInviteMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterFollowerInviteMessage)
*   [IOrderMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage)
*   [IPaymentExtendedMetadata](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentExtendedMetadata)
*   [IPaymentInviteMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentInviteMessage)
*   [IPaymentLinkMetadata](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentLinkMetadata)
*   [IPeerDataOperationRequestMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage)
*   [IPeerDataOperationRequestResponseMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestResponseMessage)
*   [IPinInChatMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPinInChatMessage)
*   [IPlaceholderMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPlaceholderMessage)
*   [IPollCreationMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage)
*   [IPollEncValue](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollEncValue)
*   [IPollResultSnapshotMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollResultSnapshotMessage)
*   [IPollUpdateMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessage)
*   [IPollUpdateMessageMetadata](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessageMetadata)
*   [IPollVoteMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollVoteMessage)
*   [IProductMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage)
*   [IProtocolMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage)
*   [IQuestionResponseMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IQuestionResponseMessage)
*   [IReactionMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IReactionMessage)
*   [IRequestPaymentMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage)
*   [IRequestPhoneNumberMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPhoneNumberMessage)
*   [IRequestWelcomeMessageMetadata](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestWelcomeMessageMetadata)
*   [IScheduledCallCreationMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallCreationMessage)
*   [IScheduledCallEditMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallEditMessage)
*   [ISecretEncryptedMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISecretEncryptedMessage)
*   [ISenderKeyDistributionMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISenderKeyDistributionMessage)
*   [ISendPaymentMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISendPaymentMessage)
*   [IStatusNotificationMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusNotificationMessage)
*   [IStatusQuestionAnswerMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuestionAnswerMessage)
*   [IStatusQuotedMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuotedMessage)
*   [IStatusStickerInteractionMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusStickerInteractionMessage)
*   [IStickerMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage)
*   [IStickerPackMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage)
*   [IStickerSyncRMRMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerSyncRMRMessage)
*   [ITemplateButtonReplyMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateButtonReplyMessage)
*   [ITemplateMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage)
*   [IURLMetadata](/docs/api/namespaces/proto/namespaces/Message/interfaces/IURLMetadata)
*   [IVideoEndCard](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoEndCard)
*   [IVideoMessage](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage)

---

<a name="class-albummessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/AlbumMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/AlbumMessage)

Defined in: [WAProto/index.d.ts:5397](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5397)

## Implements[​](#implements "Direct link to Implements")

*   [`IAlbumMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAlbumMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new AlbumMessage()[​](#new-albummessage "Direct link to new AlbumMessage()")

> **new AlbumMessage**(`p`?): [`AlbumMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/AlbumMessage)

Defined in: [WAProto/index.d.ts:5398](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5398)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAlbumMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAlbumMessage)

#### Returns[​](#returns "Direct link to Returns")

[`AlbumMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/AlbumMessage)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:5401](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5401)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAlbumMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAlbumMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAlbumMessage#contextinfo)

* * *

### expectedImageCount?[​](#expectedimagecount "Direct link to expectedImageCount?")

> `optional` **expectedImageCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:5399](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5399)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAlbumMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAlbumMessage).[`expectedImageCount`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAlbumMessage#expectedimagecount)

* * *

### expectedVideoCount?[​](#expectedvideocount "Direct link to expectedVideoCount?")

> `optional` **expectedVideoCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:5400](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5400)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAlbumMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAlbumMessage).[`expectedVideoCount`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAlbumMessage#expectedvideocount)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5407](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5407)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AlbumMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/AlbumMessage)

Defined in: [WAProto/index.d.ts:5402](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5402)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAlbumMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAlbumMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AlbumMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/AlbumMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AlbumMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/AlbumMessage)

Defined in: [WAProto/index.d.ts:5404](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5404)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AlbumMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/AlbumMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5403](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5403)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAlbumMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAlbumMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AlbumMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/AlbumMessage)

Defined in: [WAProto/index.d.ts:5405](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5405)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AlbumMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/AlbumMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5408](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5408)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5406](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5406)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AlbumMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/AlbumMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-appstatefatalexceptionnotification"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/AppStateFatalExceptionNotification](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/AppStateFatalExceptionNotification)

Defined in: [WAProto/index.d.ts:5416](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5416)

## Implements[​](#implements "Direct link to Implements")

*   [`IAppStateFatalExceptionNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateFatalExceptionNotification)

## Constructors[​](#constructors "Direct link to Constructors")

### new AppStateFatalExceptionNotification()[​](#new-appstatefatalexceptionnotification "Direct link to new AppStateFatalExceptionNotification()")

> **new AppStateFatalExceptionNotification**(`p`?): [`AppStateFatalExceptionNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateFatalExceptionNotification)

Defined in: [WAProto/index.d.ts:5417](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5417)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAppStateFatalExceptionNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateFatalExceptionNotification)

#### Returns[​](#returns "Direct link to Returns")

[`AppStateFatalExceptionNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateFatalExceptionNotification)

## Properties[​](#properties "Direct link to Properties")

### collectionNames[​](#collectionnames "Direct link to collectionNames")

> **collectionNames**: `string`\[\]

Defined in: [WAProto/index.d.ts:5418](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5418)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAppStateFatalExceptionNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateFatalExceptionNotification).[`collectionNames`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateFatalExceptionNotification#collectionnames)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:5419](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5419)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAppStateFatalExceptionNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateFatalExceptionNotification).[`timestamp`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateFatalExceptionNotification#timestamp)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5425](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5425)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AppStateFatalExceptionNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateFatalExceptionNotification)

Defined in: [WAProto/index.d.ts:5420](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5420)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAppStateFatalExceptionNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateFatalExceptionNotification)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AppStateFatalExceptionNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateFatalExceptionNotification)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AppStateFatalExceptionNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateFatalExceptionNotification)

Defined in: [WAProto/index.d.ts:5422](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5422)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AppStateFatalExceptionNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateFatalExceptionNotification)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5421](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5421)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAppStateFatalExceptionNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateFatalExceptionNotification)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AppStateFatalExceptionNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateFatalExceptionNotification)

Defined in: [WAProto/index.d.ts:5423](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5423)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AppStateFatalExceptionNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateFatalExceptionNotification)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5426](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5426)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5424](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5424)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AppStateFatalExceptionNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateFatalExceptionNotification)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-appstatesynckey"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKey](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKey)

Defined in: [WAProto/index.d.ts:5434](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5434)

## Implements[​](#implements "Direct link to Implements")

*   [`IAppStateSyncKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKey)

## Constructors[​](#constructors "Direct link to Constructors")

### new AppStateSyncKey()[​](#new-appstatesynckey "Direct link to new AppStateSyncKey()")

> **new AppStateSyncKey**(`p`?): [`AppStateSyncKey`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKey)

Defined in: [WAProto/index.d.ts:5435](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5435)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAppStateSyncKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKey)

#### Returns[​](#returns "Direct link to Returns")

[`AppStateSyncKey`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKey)

## Properties[​](#properties "Direct link to Properties")

### keyData?[​](#keydata "Direct link to keyData?")

> `optional` **keyData**: `null` | [`IAppStateSyncKeyData`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyData)

Defined in: [WAProto/index.d.ts:5437](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5437)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAppStateSyncKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKey).[`keyData`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKey#keydata)

* * *

### keyId?[​](#keyid "Direct link to keyId?")

> `optional` **keyId**: `null` | [`IAppStateSyncKeyId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyId)

Defined in: [WAProto/index.d.ts:5436](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5436)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAppStateSyncKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKey).[`keyId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKey#keyid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5443](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5443)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AppStateSyncKey`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKey)

Defined in: [WAProto/index.d.ts:5438](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5438)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAppStateSyncKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKey)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AppStateSyncKey`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKey)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AppStateSyncKey`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKey)

Defined in: [WAProto/index.d.ts:5440](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5440)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AppStateSyncKey`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKey)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5439](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5439)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAppStateSyncKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKey)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AppStateSyncKey`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKey)

Defined in: [WAProto/index.d.ts:5441](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5441)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AppStateSyncKey`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKey)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5444](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5444)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5442](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5442)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AppStateSyncKey`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKey)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-appstatesynckeydata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyData)

Defined in: [WAProto/index.d.ts:5453](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5453)

## Implements[​](#implements "Direct link to Implements")

*   [`IAppStateSyncKeyData`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyData)

## Constructors[​](#constructors "Direct link to Constructors")

### new AppStateSyncKeyData()[​](#new-appstatesynckeydata "Direct link to new AppStateSyncKeyData()")

> **new AppStateSyncKeyData**(`p`?): [`AppStateSyncKeyData`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyData)

Defined in: [WAProto/index.d.ts:5454](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5454)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAppStateSyncKeyData`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyData)

#### Returns[​](#returns "Direct link to Returns")

[`AppStateSyncKeyData`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyData)

## Properties[​](#properties "Direct link to Properties")

### fingerprint?[​](#fingerprint "Direct link to fingerprint?")

> `optional` **fingerprint**: `null` | [`IAppStateSyncKeyFingerprint`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyFingerprint)

Defined in: [WAProto/index.d.ts:5456](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5456)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAppStateSyncKeyData`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyData).[`fingerprint`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyData#fingerprint)

* * *

### keyData?[​](#keydata "Direct link to keyData?")

> `optional` **keyData**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5455](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5455)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAppStateSyncKeyData`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyData).[`keyData`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyData#keydata)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:5457](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5457)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAppStateSyncKeyData`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyData).[`timestamp`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyData#timestamp)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5463](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5463)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AppStateSyncKeyData`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyData)

Defined in: [WAProto/index.d.ts:5458](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5458)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAppStateSyncKeyData`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyData)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AppStateSyncKeyData`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyData)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AppStateSyncKeyData`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyData)

Defined in: [WAProto/index.d.ts:5460](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5460)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AppStateSyncKeyData`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyData)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5459](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5459)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAppStateSyncKeyData`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyData)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AppStateSyncKeyData`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyData)

Defined in: [WAProto/index.d.ts:5461](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5461)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AppStateSyncKeyData`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyData)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5464](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5464)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5462](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5462)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AppStateSyncKeyData`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyData)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-appstatesynckeyfingerprint"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyFingerprint](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyFingerprint)

Defined in: [WAProto/index.d.ts:5473](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5473)

## Implements[​](#implements "Direct link to Implements")

*   [`IAppStateSyncKeyFingerprint`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyFingerprint)

## Constructors[​](#constructors "Direct link to Constructors")

### new AppStateSyncKeyFingerprint()[​](#new-appstatesynckeyfingerprint "Direct link to new AppStateSyncKeyFingerprint()")

> **new AppStateSyncKeyFingerprint**(`p`?): [`AppStateSyncKeyFingerprint`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyFingerprint)

Defined in: [WAProto/index.d.ts:5474](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5474)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAppStateSyncKeyFingerprint`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyFingerprint)

#### Returns[​](#returns "Direct link to Returns")

[`AppStateSyncKeyFingerprint`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyFingerprint)

## Properties[​](#properties "Direct link to Properties")

### currentIndex?[​](#currentindex "Direct link to currentIndex?")

> `optional` **currentIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:5476](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5476)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAppStateSyncKeyFingerprint`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyFingerprint).[`currentIndex`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyFingerprint#currentindex)

* * *

### deviceIndexes[​](#deviceindexes "Direct link to deviceIndexes")

> **deviceIndexes**: `number`\[\]

Defined in: [WAProto/index.d.ts:5477](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5477)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAppStateSyncKeyFingerprint`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyFingerprint).[`deviceIndexes`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyFingerprint#deviceindexes)

* * *

### rawId?[​](#rawid "Direct link to rawId?")

> `optional` **rawId**: `null` | `number`

Defined in: [WAProto/index.d.ts:5475](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5475)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAppStateSyncKeyFingerprint`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyFingerprint).[`rawId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyFingerprint#rawid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5483](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5483)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AppStateSyncKeyFingerprint`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyFingerprint)

Defined in: [WAProto/index.d.ts:5478](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5478)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAppStateSyncKeyFingerprint`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyFingerprint)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AppStateSyncKeyFingerprint`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyFingerprint)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AppStateSyncKeyFingerprint`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyFingerprint)

Defined in: [WAProto/index.d.ts:5480](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5480)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AppStateSyncKeyFingerprint`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyFingerprint)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5479](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5479)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAppStateSyncKeyFingerprint`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyFingerprint)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AppStateSyncKeyFingerprint`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyFingerprint)

Defined in: [WAProto/index.d.ts:5481](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5481)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AppStateSyncKeyFingerprint`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyFingerprint)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5484](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5484)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5482](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5482)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AppStateSyncKeyFingerprint`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyFingerprint)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-appstatesynckeyid"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyId](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyId)

Defined in: [WAProto/index.d.ts:5491](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5491)

## Implements[​](#implements "Direct link to Implements")

*   [`IAppStateSyncKeyId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyId)

## Constructors[​](#constructors "Direct link to Constructors")

### new AppStateSyncKeyId()[​](#new-appstatesynckeyid "Direct link to new AppStateSyncKeyId()")

> **new AppStateSyncKeyId**(`p`?): [`AppStateSyncKeyId`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyId)

Defined in: [WAProto/index.d.ts:5492](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5492)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAppStateSyncKeyId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyId)

#### Returns[​](#returns "Direct link to Returns")

[`AppStateSyncKeyId`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyId)

## Properties[​](#properties "Direct link to Properties")

### keyId?[​](#keyid "Direct link to keyId?")

> `optional` **keyId**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5493](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5493)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAppStateSyncKeyId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyId).[`keyId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyId#keyid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5499](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5499)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AppStateSyncKeyId`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyId)

Defined in: [WAProto/index.d.ts:5494](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5494)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAppStateSyncKeyId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyId)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AppStateSyncKeyId`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyId)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AppStateSyncKeyId`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyId)

Defined in: [WAProto/index.d.ts:5496](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5496)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AppStateSyncKeyId`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyId)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5495](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5495)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAppStateSyncKeyId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyId)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AppStateSyncKeyId`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyId)

Defined in: [WAProto/index.d.ts:5497](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5497)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AppStateSyncKeyId`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyId)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5500](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5500)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5498](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5498)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AppStateSyncKeyId`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyId)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-appstatesynckeyrequest"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyRequest](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyRequest)

Defined in: [WAProto/index.d.ts:5507](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5507)

## Implements[​](#implements "Direct link to Implements")

*   [`IAppStateSyncKeyRequest`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyRequest)

## Constructors[​](#constructors "Direct link to Constructors")

### new AppStateSyncKeyRequest()[​](#new-appstatesynckeyrequest "Direct link to new AppStateSyncKeyRequest()")

> **new AppStateSyncKeyRequest**(`p`?): [`AppStateSyncKeyRequest`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyRequest)

Defined in: [WAProto/index.d.ts:5508](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5508)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAppStateSyncKeyRequest`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyRequest)

#### Returns[​](#returns "Direct link to Returns")

[`AppStateSyncKeyRequest`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyRequest)

## Properties[​](#properties "Direct link to Properties")

### keyIds[​](#keyids "Direct link to keyIds")

> **keyIds**: [`IAppStateSyncKeyId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyId)\[\]

Defined in: [WAProto/index.d.ts:5509](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5509)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAppStateSyncKeyRequest`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyRequest).[`keyIds`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyRequest#keyids)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5515](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5515)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AppStateSyncKeyRequest`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyRequest)

Defined in: [WAProto/index.d.ts:5510](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5510)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAppStateSyncKeyRequest`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyRequest)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AppStateSyncKeyRequest`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyRequest)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AppStateSyncKeyRequest`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyRequest)

Defined in: [WAProto/index.d.ts:5512](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5512)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AppStateSyncKeyRequest`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyRequest)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5511](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5511)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAppStateSyncKeyRequest`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyRequest)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AppStateSyncKeyRequest`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyRequest)

Defined in: [WAProto/index.d.ts:5513](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5513)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AppStateSyncKeyRequest`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyRequest)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5516](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5516)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5514](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5514)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AppStateSyncKeyRequest`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyRequest)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-appstatesynckeyshare"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyShare](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyShare)

Defined in: [WAProto/index.d.ts:5523](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5523)

## Implements[​](#implements "Direct link to Implements")

*   [`IAppStateSyncKeyShare`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyShare)

## Constructors[​](#constructors "Direct link to Constructors")

### new AppStateSyncKeyShare()[​](#new-appstatesynckeyshare "Direct link to new AppStateSyncKeyShare()")

> **new AppStateSyncKeyShare**(`p`?): [`AppStateSyncKeyShare`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyShare)

Defined in: [WAProto/index.d.ts:5524](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5524)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAppStateSyncKeyShare`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyShare)

#### Returns[​](#returns "Direct link to Returns")

[`AppStateSyncKeyShare`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyShare)

## Properties[​](#properties "Direct link to Properties")

### keys[​](#keys "Direct link to keys")

> **keys**: [`IAppStateSyncKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKey)\[\]

Defined in: [WAProto/index.d.ts:5525](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5525)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAppStateSyncKeyShare`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyShare).[`keys`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyShare#keys)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5531](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5531)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AppStateSyncKeyShare`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyShare)

Defined in: [WAProto/index.d.ts:5526](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5526)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAppStateSyncKeyShare`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyShare)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AppStateSyncKeyShare`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyShare)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AppStateSyncKeyShare`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyShare)

Defined in: [WAProto/index.d.ts:5528](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5528)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AppStateSyncKeyShare`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyShare)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5527](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5527)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAppStateSyncKeyShare`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyShare)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AppStateSyncKeyShare`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyShare)

Defined in: [WAProto/index.d.ts:5529](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5529)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AppStateSyncKeyShare`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyShare)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5532](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5532)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5530](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5530)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AppStateSyncKeyShare`](/docs/api/namespaces/proto/namespaces/Message/classes/AppStateSyncKeyShare)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-audiomessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/AudioMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/AudioMessage)

Defined in: [WAProto/index.d.ts:5555](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5555)

## Implements[​](#implements "Direct link to Implements")

*   [`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new AudioMessage()[​](#new-audiomessage "Direct link to new AudioMessage()")

> **new AudioMessage**(`p`?): [`AudioMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/AudioMessage)

Defined in: [WAProto/index.d.ts:5556](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5556)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage)

#### Returns[​](#returns "Direct link to Returns")

[`AudioMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/AudioMessage)

## Properties[​](#properties "Direct link to Properties")

### accessibilityLabel?[​](#accessibilitylabel "Direct link to accessibilityLabel?")

> `optional` **accessibilityLabel**: `null` | `string`

Defined in: [WAProto/index.d.ts:5572](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5572)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage).[`accessibilityLabel`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage#accessibilitylabel)

* * *

### backgroundArgb?[​](#backgroundargb "Direct link to backgroundArgb?")

> `optional` **backgroundArgb**: `null` | `number`

Defined in: [WAProto/index.d.ts:5570](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5570)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage).[`backgroundArgb`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage#backgroundargb)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:5567](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5567)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage#contextinfo)

* * *

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:5565](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5565)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage).[`directPath`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage#directpath)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5564](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5564)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage).[`fileEncSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage#fileencsha256)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:5560](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5560)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage).[`fileLength`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage#filelength)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5559](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5559)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage).[`fileSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage#filesha256)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5563](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5563)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage).[`mediaKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage#mediakey)

* * *

### mediaKeyDomain?[​](#mediakeydomain "Direct link to mediaKeyDomain?")

> `optional` **mediaKeyDomain**: `null` | [`MediaKeyDomain`](/docs/api/namespaces/proto/namespaces/Message/enumerations/MediaKeyDomain)

Defined in: [WAProto/index.d.ts:5573](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5573)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage).[`mediaKeyDomain`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage#mediakeydomain)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:5566](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5566)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage).[`mediaKeyTimestamp`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage#mediakeytimestamp)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:5558](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5558)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage).[`mimetype`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage#mimetype)

* * *

### ptt?[​](#ptt "Direct link to ptt?")

> `optional` **ptt**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:5562](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5562)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage).[`ptt`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage#ptt)

* * *

### seconds?[​](#seconds "Direct link to seconds?")

> `optional` **seconds**: `null` | `number`

Defined in: [WAProto/index.d.ts:5561](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5561)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage).[`seconds`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage#seconds)

* * *

### streamingSidecar?[​](#streamingsidecar "Direct link to streamingSidecar?")

> `optional` **streamingSidecar**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5568](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5568)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage).[`streamingSidecar`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage#streamingsidecar)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:5557](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5557)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage).[`url`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage#url)

* * *

### viewOnce?[​](#viewonce "Direct link to viewOnce?")

> `optional` **viewOnce**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:5571](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5571)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage).[`viewOnce`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage#viewonce)

* * *

### waveform?[​](#waveform "Direct link to waveform?")

> `optional` **waveform**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5569](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5569)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage).[`waveform`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage#waveform)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5579](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5579)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AudioMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/AudioMessage)

Defined in: [WAProto/index.d.ts:5574](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5574)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AudioMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/AudioMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AudioMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/AudioMessage)

Defined in: [WAProto/index.d.ts:5576](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5576)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AudioMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/AudioMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5575](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5575)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AudioMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/AudioMessage)

Defined in: [WAProto/index.d.ts:5577](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5577)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AudioMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/AudioMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5580](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5580)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5578](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5578)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AudioMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/AudioMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-bcallmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/BCallMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/BCallMessage)

Defined in: [WAProto/index.d.ts:5590](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5590)

## Implements[​](#implements "Direct link to Implements")

*   [`IBCallMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IBCallMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new BCallMessage()[​](#new-bcallmessage "Direct link to new BCallMessage()")

> **new BCallMessage**(`p`?): [`BCallMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/BCallMessage)

Defined in: [WAProto/index.d.ts:5591](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5591)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBCallMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IBCallMessage)

#### Returns[​](#returns "Direct link to Returns")

[`BCallMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/BCallMessage)

## Properties[​](#properties "Direct link to Properties")

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:5595](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5595)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBCallMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IBCallMessage).[`caption`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IBCallMessage#caption)

* * *

### masterKey?[​](#masterkey "Direct link to masterKey?")

> `optional` **masterKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5594](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5594)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBCallMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IBCallMessage).[`masterKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IBCallMessage#masterkey)

* * *

### mediaType?[​](#mediatype "Direct link to mediaType?")

> `optional` **mediaType**: `null` | [`MediaType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/BCallMessage/enumerations/MediaType)

Defined in: [WAProto/index.d.ts:5593](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5593)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBCallMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IBCallMessage).[`mediaType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IBCallMessage#mediatype)

* * *

### sessionId?[​](#sessionid "Direct link to sessionId?")

> `optional` **sessionId**: `null` | `string`

Defined in: [WAProto/index.d.ts:5592](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5592)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IBCallMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IBCallMessage).[`sessionId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IBCallMessage#sessionid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5601](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5601)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BCallMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/BCallMessage)

Defined in: [WAProto/index.d.ts:5596](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5596)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBCallMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IBCallMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BCallMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/BCallMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BCallMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/BCallMessage)

Defined in: [WAProto/index.d.ts:5598](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5598)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BCallMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/BCallMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5597](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5597)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBCallMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IBCallMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BCallMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/BCallMessage)

Defined in: [WAProto/index.d.ts:5599](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5599)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BCallMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/BCallMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5602](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5602)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5600](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5600)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BCallMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/BCallMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-buttonsmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsMessage)

Defined in: [WAProto/index.d.ts:5627](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5627)

## Implements[​](#implements "Direct link to Implements")

*   [`IButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new ButtonsMessage()[​](#new-buttonsmessage "Direct link to new ButtonsMessage()")

> **new ButtonsMessage**(`p`?): [`ButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsMessage)

Defined in: [WAProto/index.d.ts:5628](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5628)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage)

#### Returns[​](#returns "Direct link to Returns")

[`ButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsMessage)

## Properties[​](#properties "Direct link to Properties")

### buttons[​](#buttons "Direct link to buttons")

> **buttons**: [`IButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/interfaces/IButton)\[\]

Defined in: [WAProto/index.d.ts:5632](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5632)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage).[`buttons`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage#buttons)

* * *

### contentText?[​](#contenttext "Direct link to contentText?")

> `optional` **contentText**: `null` | `string`

Defined in: [WAProto/index.d.ts:5629](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5629)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage).[`contentText`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage#contenttext)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:5631](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5631)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage#contextinfo)

* * *

### documentMessage?[​](#documentmessage "Direct link to documentMessage?")

> `optional` **documentMessage**: `null` | [`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage)

Defined in: [WAProto/index.d.ts:5635](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5635)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage).[`documentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage#documentmessage)

* * *

### footerText?[​](#footertext "Direct link to footerText?")

> `optional` **footerText**: `null` | `string`

Defined in: [WAProto/index.d.ts:5630](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5630)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage).[`footerText`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage#footertext)

* * *

### header?[​](#header "Direct link to header?")

> `optional` **header**: `"text"` | `"imageMessage"` | `"locationMessage"` | `"documentMessage"` | `"videoMessage"`

Defined in: [WAProto/index.d.ts:5639](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5639)

* * *

### headerType?[​](#headertype "Direct link to headerType?")

> `optional` **headerType**: `null` | [`HeaderType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/enumerations/HeaderType)

Defined in: [WAProto/index.d.ts:5633](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5633)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage).[`headerType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage#headertype)

* * *

### imageMessage?[​](#imagemessage "Direct link to imageMessage?")

> `optional` **imageMessage**: `null` | [`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage)

Defined in: [WAProto/index.d.ts:5636](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5636)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage).[`imageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage#imagemessage)

* * *

### locationMessage?[​](#locationmessage "Direct link to locationMessage?")

> `optional` **locationMessage**: `null` | [`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage)

Defined in: [WAProto/index.d.ts:5638](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5638)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage).[`locationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage#locationmessage)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:5634](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5634)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage).[`text`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage#text)

* * *

### videoMessage?[​](#videomessage "Direct link to videoMessage?")

> `optional` **videoMessage**: `null` | [`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage)

Defined in: [WAProto/index.d.ts:5637](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5637)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage).[`videoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage#videomessage)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5645](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5645)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsMessage)

Defined in: [WAProto/index.d.ts:5640](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5640)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsMessage)

Defined in: [WAProto/index.d.ts:5642](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5642)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5641](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5641)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsMessage)

Defined in: [WAProto/index.d.ts:5643](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5643)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5646](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5646)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5644](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5644)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ButtonsMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-buttonsresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsResponseMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsResponseMessage)

Defined in: [WAProto/index.d.ts:5734](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5734)

## Implements[​](#implements "Direct link to Implements")

*   [`IButtonsResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsResponseMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new ButtonsResponseMessage()[​](#new-buttonsresponsemessage "Direct link to new ButtonsResponseMessage()")

> **new ButtonsResponseMessage**(`p`?): [`ButtonsResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsResponseMessage)

Defined in: [WAProto/index.d.ts:5735](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5735)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IButtonsResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsResponseMessage)

#### Returns[​](#returns "Direct link to Returns")

[`ButtonsResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsResponseMessage)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:5737](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5737)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IButtonsResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsResponseMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsResponseMessage#contextinfo)

* * *

### response?[​](#response "Direct link to response?")

> `optional` **response**: `"selectedDisplayText"`

Defined in: [WAProto/index.d.ts:5740](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5740)

* * *

### selectedButtonId?[​](#selectedbuttonid "Direct link to selectedButtonId?")

> `optional` **selectedButtonId**: `null` | `string`

Defined in: [WAProto/index.d.ts:5736](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5736)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IButtonsResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsResponseMessage).[`selectedButtonId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsResponseMessage#selectedbuttonid)

* * *

### selectedDisplayText?[​](#selecteddisplaytext "Direct link to selectedDisplayText?")

> `optional` **selectedDisplayText**: `null` | `string`

Defined in: [WAProto/index.d.ts:5739](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5739)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IButtonsResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsResponseMessage).[`selectedDisplayText`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsResponseMessage#selecteddisplaytext)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`Type`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsResponseMessage/enumerations/Type)

Defined in: [WAProto/index.d.ts:5738](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5738)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IButtonsResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsResponseMessage).[`type`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsResponseMessage#type)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5746](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5746)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ButtonsResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsResponseMessage)

Defined in: [WAProto/index.d.ts:5741](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5741)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IButtonsResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsResponseMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ButtonsResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsResponseMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ButtonsResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsResponseMessage)

Defined in: [WAProto/index.d.ts:5743](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5743)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ButtonsResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsResponseMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5742](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5742)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IButtonsResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsResponseMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ButtonsResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsResponseMessage)

Defined in: [WAProto/index.d.ts:5744](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5744)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ButtonsResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsResponseMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5747](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5747)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5745](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5745)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ButtonsResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ButtonsResponseMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-call"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/Call](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/Call)

Defined in: [WAProto/index.d.ts:5770](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5770)

## Implements[​](#implements "Direct link to Implements")

*   [`ICall`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall)

## Constructors[​](#constructors "Direct link to Constructors")

### new Call()[​](#new-call "Direct link to new Call()")

> **new Call**(`p`?): [`Call`](/docs/api/namespaces/proto/namespaces/Message/classes/Call)

Defined in: [WAProto/index.d.ts:5771](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5771)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICall`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall)

#### Returns[​](#returns "Direct link to Returns")

[`Call`](/docs/api/namespaces/proto/namespaces/Message/classes/Call)

## Properties[​](#properties "Direct link to Properties")

### callKey?[​](#callkey "Direct link to callKey?")

> `optional` **callKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5772](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5772)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICall`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall).[`callKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall#callkey)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:5778](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5778)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ICall`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall#contextinfo)

* * *

### conversionData?[​](#conversiondata "Direct link to conversionData?")

> `optional` **conversionData**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5774](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5774)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ICall`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall).[`conversionData`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall#conversiondata)

* * *

### conversionDelaySeconds?[​](#conversiondelayseconds "Direct link to conversionDelaySeconds?")

> `optional` **conversionDelaySeconds**: `null` | `number`

Defined in: [WAProto/index.d.ts:5775](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5775)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ICall`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall).[`conversionDelaySeconds`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall#conversiondelayseconds)

* * *

### conversionSource?[​](#conversionsource "Direct link to conversionSource?")

> `optional` **conversionSource**: `null` | `string`

Defined in: [WAProto/index.d.ts:5773](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5773)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ICall`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall).[`conversionSource`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall#conversionsource)

* * *

### ctwaPayload?[​](#ctwapayload "Direct link to ctwaPayload?")

> `optional` **ctwaPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5777](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5777)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`ICall`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall).[`ctwaPayload`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall#ctwapayload)

* * *

### ctwaSignals?[​](#ctwasignals "Direct link to ctwaSignals?")

> `optional` **ctwaSignals**: `null` | `string`

Defined in: [WAProto/index.d.ts:5776](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5776)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`ICall`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall).[`ctwaSignals`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall#ctwasignals)

* * *

### deeplinkPayload?[​](#deeplinkpayload "Direct link to deeplinkPayload?")

> `optional` **deeplinkPayload**: `null` | `string`

Defined in: [WAProto/index.d.ts:5780](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5780)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`ICall`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall).[`deeplinkPayload`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall#deeplinkpayload)

* * *

### nativeFlowCallButtonPayload?[​](#nativeflowcallbuttonpayload "Direct link to nativeFlowCallButtonPayload?")

> `optional` **nativeFlowCallButtonPayload**: `null` | `string`

Defined in: [WAProto/index.d.ts:5779](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5779)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`ICall`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall).[`nativeFlowCallButtonPayload`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall#nativeflowcallbuttonpayload)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5786](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5786)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Call`](/docs/api/namespaces/proto/namespaces/Message/classes/Call)

Defined in: [WAProto/index.d.ts:5781](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5781)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICall`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Call`](/docs/api/namespaces/proto/namespaces/Message/classes/Call)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Call`](/docs/api/namespaces/proto/namespaces/Message/classes/Call)

Defined in: [WAProto/index.d.ts:5783](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5783)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Call`](/docs/api/namespaces/proto/namespaces/Message/classes/Call)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5782](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5782)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICall`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Call`](/docs/api/namespaces/proto/namespaces/Message/classes/Call)

Defined in: [WAProto/index.d.ts:5784](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5784)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Call`](/docs/api/namespaces/proto/namespaces/Message/classes/Call)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5787](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5787)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5785](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5785)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Call`](/docs/api/namespaces/proto/namespaces/Message/classes/Call)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-calllogmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/CallLogMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/CallLogMessage)

Defined in: [WAProto/index.d.ts:5798](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5798)

## Implements[​](#implements "Direct link to Implements")

*   [`ICallLogMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICallLogMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new CallLogMessage()[​](#new-calllogmessage "Direct link to new CallLogMessage()")

> **new CallLogMessage**(`p`?): [`CallLogMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CallLogMessage)

Defined in: [WAProto/index.d.ts:5799](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5799)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICallLogMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICallLogMessage)

#### Returns[​](#returns "Direct link to Returns")

[`CallLogMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CallLogMessage)

## Properties[​](#properties "Direct link to Properties")

### callOutcome?[​](#calloutcome "Direct link to callOutcome?")

> `optional` **callOutcome**: `null` | [`CallOutcome`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/enumerations/CallOutcome)

Defined in: [WAProto/index.d.ts:5801](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5801)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICallLogMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICallLogMessage).[`callOutcome`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICallLogMessage#calloutcome)

* * *

### callType?[​](#calltype "Direct link to callType?")

> `optional` **callType**: `null` | [`CallType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/enumerations/CallType)

Defined in: [WAProto/index.d.ts:5803](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5803)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ICallLogMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICallLogMessage).[`callType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICallLogMessage#calltype)

* * *

### durationSecs?[​](#durationsecs "Direct link to durationSecs?")

> `optional` **durationSecs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:5802](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5802)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ICallLogMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICallLogMessage).[`durationSecs`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICallLogMessage#durationsecs)

* * *

### isVideo?[​](#isvideo "Direct link to isVideo?")

> `optional` **isVideo**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:5800](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5800)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ICallLogMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICallLogMessage).[`isVideo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICallLogMessage#isvideo)

* * *

### participants[​](#participants "Direct link to participants")

> **participants**: [`ICallParticipant`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/interfaces/ICallParticipant)\[\]

Defined in: [WAProto/index.d.ts:5804](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5804)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ICallLogMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICallLogMessage).[`participants`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICallLogMessage#participants)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5810](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5810)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CallLogMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CallLogMessage)

Defined in: [WAProto/index.d.ts:5805](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5805)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICallLogMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICallLogMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CallLogMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CallLogMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CallLogMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CallLogMessage)

Defined in: [WAProto/index.d.ts:5807](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5807)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CallLogMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CallLogMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5806](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5806)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICallLogMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICallLogMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CallLogMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CallLogMessage)

Defined in: [WAProto/index.d.ts:5808](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5808)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CallLogMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CallLogMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5811](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5811)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5809](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5809)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CallLogMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CallLogMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-cancelpaymentrequestmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/CancelPaymentRequestMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/CancelPaymentRequestMessage)

Defined in: [WAProto/index.d.ts:5856](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5856)

## Implements[​](#implements "Direct link to Implements")

*   [`ICancelPaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICancelPaymentRequestMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new CancelPaymentRequestMessage()[​](#new-cancelpaymentrequestmessage "Direct link to new CancelPaymentRequestMessage()")

> **new CancelPaymentRequestMessage**(`p`?): [`CancelPaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CancelPaymentRequestMessage)

Defined in: [WAProto/index.d.ts:5857](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5857)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICancelPaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICancelPaymentRequestMessage)

#### Returns[​](#returns "Direct link to Returns")

[`CancelPaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CancelPaymentRequestMessage)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:5858](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5858)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICancelPaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICancelPaymentRequestMessage).[`key`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICancelPaymentRequestMessage#key)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5864](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5864)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CancelPaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CancelPaymentRequestMessage)

Defined in: [WAProto/index.d.ts:5859](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5859)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICancelPaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICancelPaymentRequestMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CancelPaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CancelPaymentRequestMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CancelPaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CancelPaymentRequestMessage)

Defined in: [WAProto/index.d.ts:5861](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5861)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CancelPaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CancelPaymentRequestMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5860](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5860)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICancelPaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICancelPaymentRequestMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CancelPaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CancelPaymentRequestMessage)

Defined in: [WAProto/index.d.ts:5862](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5862)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CancelPaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CancelPaymentRequestMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5865](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5865)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5863](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5863)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CancelPaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CancelPaymentRequestMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-chat"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/Chat](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/Chat)

Defined in: [WAProto/index.d.ts:5873](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5873)

## Implements[​](#implements "Direct link to Implements")

*   [`IChat`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IChat)

## Constructors[​](#constructors "Direct link to Constructors")

### new Chat()[​](#new-chat "Direct link to new Chat()")

> **new Chat**(`p`?): [`Chat`](/docs/api/namespaces/proto/namespaces/Message/classes/Chat)

Defined in: [WAProto/index.d.ts:5874](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5874)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IChat`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IChat)

#### Returns[​](#returns "Direct link to Returns")

[`Chat`](/docs/api/namespaces/proto/namespaces/Message/classes/Chat)

## Properties[​](#properties "Direct link to Properties")

### displayName?[​](#displayname "Direct link to displayName?")

> `optional` **displayName**: `null` | `string`

Defined in: [WAProto/index.d.ts:5875](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5875)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IChat`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IChat).[`displayName`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IChat#displayname)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:5876](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5876)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IChat`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IChat).[`id`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IChat#id)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5882](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5882)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Chat`](/docs/api/namespaces/proto/namespaces/Message/classes/Chat)

Defined in: [WAProto/index.d.ts:5877](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5877)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IChat`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IChat)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Chat`](/docs/api/namespaces/proto/namespaces/Message/classes/Chat)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Chat`](/docs/api/namespaces/proto/namespaces/Message/classes/Chat)

Defined in: [WAProto/index.d.ts:5879](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5879)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Chat`](/docs/api/namespaces/proto/namespaces/Message/classes/Chat)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5878](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5878)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IChat`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IChat)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Chat`](/docs/api/namespaces/proto/namespaces/Message/classes/Chat)

Defined in: [WAProto/index.d.ts:5880](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5880)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Chat`](/docs/api/namespaces/proto/namespaces/Message/classes/Chat)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5883](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5883)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5881](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5881)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Chat`](/docs/api/namespaces/proto/namespaces/Message/classes/Chat)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-cloudapithreadcontrolnotification"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/CloudAPIThreadControlNotification](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/CloudAPIThreadControlNotification)

Defined in: [WAProto/index.d.ts:5895](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5895)

## Implements[​](#implements "Direct link to Implements")

*   [`ICloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification)

## Constructors[​](#constructors "Direct link to Constructors")

### new CloudAPIThreadControlNotification()[​](#new-cloudapithreadcontrolnotification "Direct link to new CloudAPIThreadControlNotification()")

> **new CloudAPIThreadControlNotification**(`p`?): [`CloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/CloudAPIThreadControlNotification)

Defined in: [WAProto/index.d.ts:5896](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5896)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification)

#### Returns[​](#returns "Direct link to Returns")

[`CloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/CloudAPIThreadControlNotification)

## Properties[​](#properties "Direct link to Properties")

### consumerLid?[​](#consumerlid "Direct link to consumerLid?")

> `optional` **consumerLid**: `null` | `string`

Defined in: [WAProto/index.d.ts:5899](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5899)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification).[`consumerLid`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification#consumerlid)

* * *

### consumerPhoneNumber?[​](#consumerphonenumber "Direct link to consumerPhoneNumber?")

> `optional` **consumerPhoneNumber**: `null` | `string`

Defined in: [WAProto/index.d.ts:5900](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5900)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ICloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification).[`consumerPhoneNumber`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification#consumerphonenumber)

* * *

### notificationContent?[​](#notificationcontent "Direct link to notificationContent?")

> `optional` **notificationContent**: `null` | [`ICloudAPIThreadControlNotificationContent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/interfaces/ICloudAPIThreadControlNotificationContent)

Defined in: [WAProto/index.d.ts:5901](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5901)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ICloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification).[`notificationContent`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification#notificationcontent)

* * *

### senderNotificationTimestampMs?[​](#sendernotificationtimestampms "Direct link to senderNotificationTimestampMs?")

> `optional` **senderNotificationTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:5898](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5898)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ICloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification).[`senderNotificationTimestampMs`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification#sendernotificationtimestampms)

* * *

### shouldSuppressNotification?[​](#shouldsuppressnotification "Direct link to shouldSuppressNotification?")

> `optional` **shouldSuppressNotification**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:5902](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5902)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ICloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification).[`shouldSuppressNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification#shouldsuppressnotification)

* * *

### status?[​](#status "Direct link to status?")

> `optional` **status**: `null` | [`CloudAPIThreadControl`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/enumerations/CloudAPIThreadControl)

Defined in: [WAProto/index.d.ts:5897](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5897)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`ICloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification).[`status`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification#status)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5908](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5908)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/CloudAPIThreadControlNotification)

Defined in: [WAProto/index.d.ts:5903](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5903)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/CloudAPIThreadControlNotification)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/CloudAPIThreadControlNotification)

Defined in: [WAProto/index.d.ts:5905](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5905)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/CloudAPIThreadControlNotification)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5904](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5904)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/CloudAPIThreadControlNotification)

Defined in: [WAProto/index.d.ts:5906](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5906)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/CloudAPIThreadControlNotification)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5909](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5909)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5907](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5907)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/CloudAPIThreadControlNotification)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-commentmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/CommentMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/CommentMessage)

Defined in: [WAProto/index.d.ts:5944](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5944)

## Implements[​](#implements "Direct link to Implements")

*   [`ICommentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICommentMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new CommentMessage()[​](#new-commentmessage "Direct link to new CommentMessage()")

> **new CommentMessage**(`p`?): [`CommentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CommentMessage)

Defined in: [WAProto/index.d.ts:5945](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5945)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICommentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICommentMessage)

#### Returns[​](#returns "Direct link to Returns")

[`CommentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CommentMessage)

## Properties[​](#properties "Direct link to Properties")

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:5946](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5946)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICommentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICommentMessage).[`message`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICommentMessage#message)

* * *

### targetMessageKey?[​](#targetmessagekey "Direct link to targetMessageKey?")

> `optional` **targetMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:5947](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5947)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ICommentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICommentMessage).[`targetMessageKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICommentMessage#targetmessagekey)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5953](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5953)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CommentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CommentMessage)

Defined in: [WAProto/index.d.ts:5948](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5948)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICommentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICommentMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CommentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CommentMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CommentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CommentMessage)

Defined in: [WAProto/index.d.ts:5950](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5950)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CommentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CommentMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5949](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5949)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICommentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICommentMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CommentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CommentMessage)

Defined in: [WAProto/index.d.ts:5951](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5951)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CommentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CommentMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5954](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5954)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5952](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5952)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CommentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/CommentMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-contactmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ContactMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ContactMessage)

Defined in: [WAProto/index.d.ts:5963](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5963)

## Implements[​](#implements "Direct link to Implements")

*   [`IContactMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new ContactMessage()[​](#new-contactmessage "Direct link to new ContactMessage()")

> **new ContactMessage**(`p`?): [`ContactMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ContactMessage)

Defined in: [WAProto/index.d.ts:5964](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5964)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IContactMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactMessage)

#### Returns[​](#returns "Direct link to Returns")

[`ContactMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ContactMessage)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:5967](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5967)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IContactMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactMessage#contextinfo)

* * *

### displayName?[​](#displayname "Direct link to displayName?")

> `optional` **displayName**: `null` | `string`

Defined in: [WAProto/index.d.ts:5965](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5965)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IContactMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactMessage).[`displayName`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactMessage#displayname)

* * *

### vcard?[​](#vcard "Direct link to vcard?")

> `optional` **vcard**: `null` | `string`

Defined in: [WAProto/index.d.ts:5966](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5966)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IContactMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactMessage).[`vcard`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactMessage#vcard)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5973](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5973)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ContactMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ContactMessage)

Defined in: [WAProto/index.d.ts:5968](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5968)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IContactMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ContactMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ContactMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ContactMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ContactMessage)

Defined in: [WAProto/index.d.ts:5970](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5970)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ContactMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ContactMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5969](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5969)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IContactMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ContactMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ContactMessage)

Defined in: [WAProto/index.d.ts:5971](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5971)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ContactMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ContactMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5974](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5974)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5972](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5972)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ContactMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ContactMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-contactsarraymessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ContactsArrayMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ContactsArrayMessage)

Defined in: [WAProto/index.d.ts:5983](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5983)

## Implements[​](#implements "Direct link to Implements")

*   [`IContactsArrayMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactsArrayMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new ContactsArrayMessage()[​](#new-contactsarraymessage "Direct link to new ContactsArrayMessage()")

> **new ContactsArrayMessage**(`p`?): [`ContactsArrayMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ContactsArrayMessage)

Defined in: [WAProto/index.d.ts:5984](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5984)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IContactsArrayMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactsArrayMessage)

#### Returns[​](#returns "Direct link to Returns")

[`ContactsArrayMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ContactsArrayMessage)

## Properties[​](#properties "Direct link to Properties")

### contacts[​](#contacts "Direct link to contacts")

> **contacts**: [`IContactMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactMessage)\[\]

Defined in: [WAProto/index.d.ts:5986](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5986)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IContactsArrayMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactsArrayMessage).[`contacts`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactsArrayMessage#contacts)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:5987](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5987)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IContactsArrayMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactsArrayMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactsArrayMessage#contextinfo)

* * *

### displayName?[​](#displayname "Direct link to displayName?")

> `optional` **displayName**: `null` | `string`

Defined in: [WAProto/index.d.ts:5985](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5985)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IContactsArrayMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactsArrayMessage).[`displayName`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactsArrayMessage#displayname)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5993](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5993)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ContactsArrayMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ContactsArrayMessage)

Defined in: [WAProto/index.d.ts:5988](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5988)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IContactsArrayMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactsArrayMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ContactsArrayMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ContactsArrayMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ContactsArrayMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ContactsArrayMessage)

Defined in: [WAProto/index.d.ts:5990](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5990)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ContactsArrayMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ContactsArrayMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5989](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5989)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IContactsArrayMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactsArrayMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ContactsArrayMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ContactsArrayMessage)

Defined in: [WAProto/index.d.ts:5991](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5991)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ContactsArrayMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ContactsArrayMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5994](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5994)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5992](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5992)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ContactsArrayMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ContactsArrayMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-declinepaymentrequestmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/DeclinePaymentRequestMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/DeclinePaymentRequestMessage)

Defined in: [WAProto/index.d.ts:6001](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6001)

## Implements[​](#implements "Direct link to Implements")

*   [`IDeclinePaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeclinePaymentRequestMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new DeclinePaymentRequestMessage()[​](#new-declinepaymentrequestmessage "Direct link to new DeclinePaymentRequestMessage()")

> **new DeclinePaymentRequestMessage**(`p`?): [`DeclinePaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DeclinePaymentRequestMessage)

Defined in: [WAProto/index.d.ts:6002](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6002)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IDeclinePaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeclinePaymentRequestMessage)

#### Returns[​](#returns "Direct link to Returns")

[`DeclinePaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DeclinePaymentRequestMessage)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:6003](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6003)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IDeclinePaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeclinePaymentRequestMessage).[`key`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeclinePaymentRequestMessage#key)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6009](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6009)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`DeclinePaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DeclinePaymentRequestMessage)

Defined in: [WAProto/index.d.ts:6004](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6004)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IDeclinePaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeclinePaymentRequestMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`DeclinePaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DeclinePaymentRequestMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`DeclinePaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DeclinePaymentRequestMessage)

Defined in: [WAProto/index.d.ts:6006](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6006)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`DeclinePaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DeclinePaymentRequestMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6005](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6005)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IDeclinePaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeclinePaymentRequestMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`DeclinePaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DeclinePaymentRequestMessage)

Defined in: [WAProto/index.d.ts:6007](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6007)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`DeclinePaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DeclinePaymentRequestMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6010](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6010)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6008](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6008)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`DeclinePaymentRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DeclinePaymentRequestMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-devicesentmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/DeviceSentMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/DeviceSentMessage)

Defined in: [WAProto/index.d.ts:6019](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6019)

## Implements[​](#implements "Direct link to Implements")

*   [`IDeviceSentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeviceSentMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new DeviceSentMessage()[​](#new-devicesentmessage "Direct link to new DeviceSentMessage()")

> **new DeviceSentMessage**(`p`?): [`DeviceSentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DeviceSentMessage)

Defined in: [WAProto/index.d.ts:6020](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6020)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IDeviceSentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeviceSentMessage)

#### Returns[​](#returns "Direct link to Returns")

[`DeviceSentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DeviceSentMessage)

## Properties[​](#properties "Direct link to Properties")

### destinationJid?[​](#destinationjid "Direct link to destinationJid?")

> `optional` **destinationJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:6021](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6021)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IDeviceSentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeviceSentMessage).[`destinationJid`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeviceSentMessage#destinationjid)

* * *

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:6022](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6022)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IDeviceSentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeviceSentMessage).[`message`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeviceSentMessage#message)

* * *

### phash?[​](#phash "Direct link to phash?")

> `optional` **phash**: `null` | `string`

Defined in: [WAProto/index.d.ts:6023](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6023)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IDeviceSentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeviceSentMessage).[`phash`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeviceSentMessage#phash)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6029](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6029)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`DeviceSentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DeviceSentMessage)

Defined in: [WAProto/index.d.ts:6024](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6024)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IDeviceSentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeviceSentMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`DeviceSentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DeviceSentMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`DeviceSentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DeviceSentMessage)

Defined in: [WAProto/index.d.ts:6026](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6026)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`DeviceSentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DeviceSentMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6025](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6025)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IDeviceSentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeviceSentMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`DeviceSentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DeviceSentMessage)

Defined in: [WAProto/index.d.ts:6027](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6027)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`DeviceSentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DeviceSentMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6030](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6030)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6028](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6028)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`DeviceSentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DeviceSentMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-documentmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/DocumentMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/DocumentMessage)

Defined in: [WAProto/index.d.ts:6058](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6058)

## Implements[​](#implements "Direct link to Implements")

*   [`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new DocumentMessage()[​](#new-documentmessage "Direct link to new DocumentMessage()")

> **new DocumentMessage**(`p`?): [`DocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DocumentMessage)

Defined in: [WAProto/index.d.ts:6059](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6059)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage)

#### Returns[​](#returns "Direct link to Returns")

[`DocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DocumentMessage)

## Properties[​](#properties "Direct link to Properties")

### accessibilityLabel?[​](#accessibilitylabel "Direct link to accessibilityLabel?")

> `optional` **accessibilityLabel**: `null` | `string`

Defined in: [WAProto/index.d.ts:6080](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6080)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`accessibilityLabel`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#accessibilitylabel)

* * *

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:6079](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6079)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`caption`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#caption)

* * *

### contactVcard?[​](#contactvcard "Direct link to contactVcard?")

> `optional` **contactVcard**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6071](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6071)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`contactVcard`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#contactvcard)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:6076](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6076)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#contextinfo)

* * *

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:6069](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6069)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`directPath`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#directpath)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6068](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6068)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`fileEncSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#fileencsha256)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6064](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6064)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`fileLength`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#filelength)

* * *

### fileName?[​](#filename "Direct link to fileName?")

> `optional` **fileName**: `null` | `string`

Defined in: [WAProto/index.d.ts:6067](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6067)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`fileName`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#filename)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6063](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6063)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`fileSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#filesha256)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6075](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6075)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`jpegThumbnail`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#jpegthumbnail)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6066](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6066)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`mediaKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#mediakey)

* * *

### mediaKeyDomain?[​](#mediakeydomain "Direct link to mediaKeyDomain?")

> `optional` **mediaKeyDomain**: `null` | [`MediaKeyDomain`](/docs/api/namespaces/proto/namespaces/Message/enumerations/MediaKeyDomain)

Defined in: [WAProto/index.d.ts:6081](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6081)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`mediaKeyDomain`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#mediakeydomain)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6070](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6070)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`mediaKeyTimestamp`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#mediakeytimestamp)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:6061](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6061)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`mimetype`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#mimetype)

* * *

### pageCount?[​](#pagecount "Direct link to pageCount?")

> `optional` **pageCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:6065](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6065)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`pageCount`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#pagecount)

* * *

### thumbnailDirectPath?[​](#thumbnaildirectpath "Direct link to thumbnailDirectPath?")

> `optional` **thumbnailDirectPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:6072](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6072)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`thumbnailDirectPath`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#thumbnaildirectpath)

* * *

### thumbnailEncSha256?[​](#thumbnailencsha256 "Direct link to thumbnailEncSha256?")

> `optional` **thumbnailEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6074](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6074)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`thumbnailEncSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#thumbnailencsha256)

* * *

### thumbnailHeight?[​](#thumbnailheight "Direct link to thumbnailHeight?")

> `optional` **thumbnailHeight**: `null` | `number`

Defined in: [WAProto/index.d.ts:6077](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6077)

#### Implementation of[​](#implementation-of-17 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`thumbnailHeight`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#thumbnailheight)

* * *

### thumbnailSha256?[​](#thumbnailsha256 "Direct link to thumbnailSha256?")

> `optional` **thumbnailSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6073](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6073)

#### Implementation of[​](#implementation-of-18 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`thumbnailSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#thumbnailsha256)

* * *

### thumbnailWidth?[​](#thumbnailwidth "Direct link to thumbnailWidth?")

> `optional` **thumbnailWidth**: `null` | `number`

Defined in: [WAProto/index.d.ts:6078](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6078)

#### Implementation of[​](#implementation-of-19 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`thumbnailWidth`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#thumbnailwidth)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:6062](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6062)

#### Implementation of[​](#implementation-of-20 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`title`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#title)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:6060](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6060)

#### Implementation of[​](#implementation-of-21 "Direct link to Implementation of")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage).[`url`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage#url)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6087](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6087)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`DocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DocumentMessage)

Defined in: [WAProto/index.d.ts:6082](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6082)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`DocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DocumentMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`DocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DocumentMessage)

Defined in: [WAProto/index.d.ts:6084](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6084)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`DocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DocumentMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6083](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6083)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`DocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DocumentMessage)

Defined in: [WAProto/index.d.ts:6085](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6085)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`DocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DocumentMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6088](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6088)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6086](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6086)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`DocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/DocumentMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-enccommentmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/EncCommentMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/EncCommentMessage)

Defined in: [WAProto/index.d.ts:6097](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6097)

## Implements[​](#implements "Direct link to Implements")

*   [`IEncCommentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncCommentMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new EncCommentMessage()[​](#new-enccommentmessage "Direct link to new EncCommentMessage()")

> **new EncCommentMessage**(`p`?): [`EncCommentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncCommentMessage)

Defined in: [WAProto/index.d.ts:6098](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6098)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IEncCommentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncCommentMessage)

#### Returns[​](#returns "Direct link to Returns")

[`EncCommentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncCommentMessage)

## Properties[​](#properties "Direct link to Properties")

### encIv?[​](#enciv "Direct link to encIv?")

> `optional` **encIv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6101](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6101)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IEncCommentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncCommentMessage).[`encIv`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncCommentMessage#enciv)

* * *

### encPayload?[​](#encpayload "Direct link to encPayload?")

> `optional` **encPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6100](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6100)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IEncCommentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncCommentMessage).[`encPayload`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncCommentMessage#encpayload)

* * *

### targetMessageKey?[​](#targetmessagekey "Direct link to targetMessageKey?")

> `optional` **targetMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:6099](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6099)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IEncCommentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncCommentMessage).[`targetMessageKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncCommentMessage#targetmessagekey)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6107](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6107)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`EncCommentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncCommentMessage)

Defined in: [WAProto/index.d.ts:6102](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6102)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IEncCommentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncCommentMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`EncCommentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncCommentMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`EncCommentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncCommentMessage)

Defined in: [WAProto/index.d.ts:6104](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6104)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`EncCommentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncCommentMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6103](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6103)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IEncCommentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncCommentMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`EncCommentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncCommentMessage)

Defined in: [WAProto/index.d.ts:6105](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6105)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`EncCommentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncCommentMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6108](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6108)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6106](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6106)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`EncCommentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncCommentMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-enceventresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/EncEventResponseMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/EncEventResponseMessage)

Defined in: [WAProto/index.d.ts:6117](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6117)

## Implements[​](#implements "Direct link to Implements")

*   [`IEncEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncEventResponseMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new EncEventResponseMessage()[​](#new-enceventresponsemessage "Direct link to new EncEventResponseMessage()")

> **new EncEventResponseMessage**(`p`?): [`EncEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncEventResponseMessage)

Defined in: [WAProto/index.d.ts:6118](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6118)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IEncEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncEventResponseMessage)

#### Returns[​](#returns "Direct link to Returns")

[`EncEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncEventResponseMessage)

## Properties[​](#properties "Direct link to Properties")

### encIv?[​](#enciv "Direct link to encIv?")

> `optional` **encIv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6121](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6121)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IEncEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncEventResponseMessage).[`encIv`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncEventResponseMessage#enciv)

* * *

### encPayload?[​](#encpayload "Direct link to encPayload?")

> `optional` **encPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6120](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6120)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IEncEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncEventResponseMessage).[`encPayload`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncEventResponseMessage#encpayload)

* * *

### eventCreationMessageKey?[​](#eventcreationmessagekey "Direct link to eventCreationMessageKey?")

> `optional` **eventCreationMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:6119](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6119)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IEncEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncEventResponseMessage).[`eventCreationMessageKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncEventResponseMessage#eventcreationmessagekey)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6127](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6127)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`EncEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncEventResponseMessage)

Defined in: [WAProto/index.d.ts:6122](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6122)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IEncEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncEventResponseMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`EncEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncEventResponseMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`EncEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncEventResponseMessage)

Defined in: [WAProto/index.d.ts:6124](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6124)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`EncEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncEventResponseMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6123](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6123)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IEncEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncEventResponseMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`EncEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncEventResponseMessage)

Defined in: [WAProto/index.d.ts:6125](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6125)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`EncEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncEventResponseMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6128](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6128)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6126](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6126)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`EncEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncEventResponseMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-encreactionmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/EncReactionMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/EncReactionMessage)

Defined in: [WAProto/index.d.ts:6137](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6137)

## Implements[​](#implements "Direct link to Implements")

*   [`IEncReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncReactionMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new EncReactionMessage()[​](#new-encreactionmessage "Direct link to new EncReactionMessage()")

> **new EncReactionMessage**(`p`?): [`EncReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncReactionMessage)

Defined in: [WAProto/index.d.ts:6138](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6138)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IEncReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncReactionMessage)

#### Returns[​](#returns "Direct link to Returns")

[`EncReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncReactionMessage)

## Properties[​](#properties "Direct link to Properties")

### encIv?[​](#enciv "Direct link to encIv?")

> `optional` **encIv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6141](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6141)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IEncReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncReactionMessage).[`encIv`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncReactionMessage#enciv)

* * *

### encPayload?[​](#encpayload "Direct link to encPayload?")

> `optional` **encPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6140](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6140)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IEncReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncReactionMessage).[`encPayload`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncReactionMessage#encpayload)

* * *

### targetMessageKey?[​](#targetmessagekey "Direct link to targetMessageKey?")

> `optional` **targetMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:6139](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6139)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IEncReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncReactionMessage).[`targetMessageKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncReactionMessage#targetmessagekey)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6147](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6147)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`EncReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncReactionMessage)

Defined in: [WAProto/index.d.ts:6142](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6142)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IEncReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncReactionMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`EncReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncReactionMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`EncReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncReactionMessage)

Defined in: [WAProto/index.d.ts:6144](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6144)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`EncReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncReactionMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6143](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6143)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IEncReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncReactionMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`EncReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncReactionMessage)

Defined in: [WAProto/index.d.ts:6145](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6145)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`EncReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncReactionMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6148](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6148)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6146](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6146)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`EncReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EncReactionMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-eventmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/EventMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/EventMessage)

Defined in: [WAProto/index.d.ts:6166](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6166)

## Implements[​](#implements "Direct link to Implements")

*   [`IEventMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new EventMessage()[​](#new-eventmessage "Direct link to new EventMessage()")

> **new EventMessage**(`p`?): [`EventMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EventMessage)

Defined in: [WAProto/index.d.ts:6167](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6167)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IEventMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage)

#### Returns[​](#returns "Direct link to Returns")

[`EventMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EventMessage)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:6168](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6168)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IEventMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage#contextinfo)

* * *

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:6171](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6171)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IEventMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage).[`description`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage#description)

* * *

### endTime?[​](#endtime "Direct link to endTime?")

> `optional` **endTime**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6175](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6175)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IEventMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage).[`endTime`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage#endtime)

* * *

### extraGuestsAllowed?[​](#extraguestsallowed "Direct link to extraGuestsAllowed?")

> `optional` **extraGuestsAllowed**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6176](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6176)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IEventMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage).[`extraGuestsAllowed`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage#extraguestsallowed)

* * *

### hasReminder?[​](#hasreminder "Direct link to hasReminder?")

> `optional` **hasReminder**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6178](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6178)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IEventMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage).[`hasReminder`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage#hasreminder)

* * *

### isCanceled?[​](#iscanceled "Direct link to isCanceled?")

> `optional` **isCanceled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6169](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6169)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IEventMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage).[`isCanceled`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage#iscanceled)

* * *

### isScheduleCall?[​](#isschedulecall "Direct link to isScheduleCall?")

> `optional` **isScheduleCall**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6177](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6177)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IEventMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage).[`isScheduleCall`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage#isschedulecall)

* * *

### joinLink?[​](#joinlink "Direct link to joinLink?")

> `optional` **joinLink**: `null` | `string`

Defined in: [WAProto/index.d.ts:6173](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6173)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IEventMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage).[`joinLink`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage#joinlink)

* * *

### location?[​](#location "Direct link to location?")

> `optional` **location**: `null` | [`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage)

Defined in: [WAProto/index.d.ts:6172](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6172)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IEventMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage).[`location`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage#location)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:6170](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6170)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IEventMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage).[`name`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage#name)

* * *

### reminderOffsetSec?[​](#reminderoffsetsec "Direct link to reminderOffsetSec?")

> `optional` **reminderOffsetSec**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6179](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6179)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IEventMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage).[`reminderOffsetSec`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage#reminderoffsetsec)

* * *

### startTime?[​](#starttime "Direct link to startTime?")

> `optional` **startTime**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6174](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6174)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IEventMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage).[`startTime`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage#starttime)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6185](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6185)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`EventMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EventMessage)

Defined in: [WAProto/index.d.ts:6180](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6180)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IEventMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`EventMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EventMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`EventMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EventMessage)

Defined in: [WAProto/index.d.ts:6182](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6182)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`EventMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EventMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6181](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6181)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IEventMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`EventMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EventMessage)

Defined in: [WAProto/index.d.ts:6183](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6183)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`EventMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EventMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6186](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6186)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6184](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6184)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`EventMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EventMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-eventresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/EventResponseMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/EventResponseMessage)

Defined in: [WAProto/index.d.ts:6195](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6195)

## Implements[​](#implements "Direct link to Implements")

*   [`IEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventResponseMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new EventResponseMessage()[​](#new-eventresponsemessage "Direct link to new EventResponseMessage()")

> **new EventResponseMessage**(`p`?): [`EventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EventResponseMessage)

Defined in: [WAProto/index.d.ts:6196](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6196)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventResponseMessage)

#### Returns[​](#returns "Direct link to Returns")

[`EventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EventResponseMessage)

## Properties[​](#properties "Direct link to Properties")

### extraGuestCount?[​](#extraguestcount "Direct link to extraGuestCount?")

> `optional` **extraGuestCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:6199](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6199)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventResponseMessage).[`extraGuestCount`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventResponseMessage#extraguestcount)

* * *

### response?[​](#response "Direct link to response?")

> `optional` **response**: `null` | [`EventResponseType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/EventResponseMessage/enumerations/EventResponseType)

Defined in: [WAProto/index.d.ts:6197](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6197)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventResponseMessage).[`response`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventResponseMessage#response)

* * *

### timestampMs?[​](#timestampms "Direct link to timestampMs?")

> `optional` **timestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6198](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6198)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventResponseMessage).[`timestampMs`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventResponseMessage#timestampms)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6205](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6205)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`EventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EventResponseMessage)

Defined in: [WAProto/index.d.ts:6200](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6200)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventResponseMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`EventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EventResponseMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`EventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EventResponseMessage)

Defined in: [WAProto/index.d.ts:6202](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6202)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`EventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EventResponseMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6201](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6201)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IEventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventResponseMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`EventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EventResponseMessage)

Defined in: [WAProto/index.d.ts:6203](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6203)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`EventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EventResponseMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6206](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6206)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6204](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6204)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`EventResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/EventResponseMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-extendedtextmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ExtendedTextMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ExtendedTextMessage)

Defined in: [WAProto/index.d.ts:6254](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6254)

## Implements[​](#implements "Direct link to Implements")

*   [`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new ExtendedTextMessage()[​](#new-extendedtextmessage "Direct link to new ExtendedTextMessage()")

> **new ExtendedTextMessage**(`p`?): [`ExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ExtendedTextMessage)

Defined in: [WAProto/index.d.ts:6255](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6255)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage)

#### Returns[​](#returns "Direct link to Returns")

[`ExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ExtendedTextMessage)

## Properties[​](#properties "Direct link to Properties")

### backgroundArgb?[​](#backgroundargb "Direct link to backgroundArgb?")

> `optional` **backgroundArgb**: `null` | `number`

Defined in: [WAProto/index.d.ts:6261](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6261)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`backgroundArgb`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#backgroundargb)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:6265](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6265)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#contextinfo)

* * *

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:6258](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6258)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`description`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#description)

* * *

### doNotPlayInline?[​](#donotplayinline "Direct link to doNotPlayInline?")

> `optional` **doNotPlayInline**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6266](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6266)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`doNotPlayInline`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#donotplayinline)

* * *

### endCardTiles[​](#endcardtiles "Direct link to endCardTiles")

> **endCardTiles**: [`IVideoEndCard`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoEndCard)\[\]

Defined in: [WAProto/index.d.ts:6284](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6284)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`endCardTiles`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#endcardtiles)

* * *

### faviconMMSMetadata?[​](#faviconmmsmetadata "Direct link to faviconMMSMetadata?")

> `optional` **faviconMMSMetadata**: `null` | [`IMMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata)

Defined in: [WAProto/index.d.ts:6281](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6281)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`faviconMMSMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#faviconmmsmetadata)

* * *

### font?[​](#font "Direct link to font?")

> `optional` **font**: `null` | [`FontType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ExtendedTextMessage/enumerations/FontType)

Defined in: [WAProto/index.d.ts:6262](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6262)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`font`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#font)

* * *

### inviteLinkGroupType?[​](#invitelinkgrouptype "Direct link to inviteLinkGroupType?")

> `optional` **inviteLinkGroupType**: `null` | [`InviteLinkGroupType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ExtendedTextMessage/enumerations/InviteLinkGroupType)

Defined in: [WAProto/index.d.ts:6274](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6274)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`inviteLinkGroupType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#invitelinkgrouptype)

* * *

### inviteLinkGroupTypeV2?[​](#invitelinkgrouptypev2 "Direct link to inviteLinkGroupTypeV2?")

> `optional` **inviteLinkGroupTypeV2**: `null` | [`InviteLinkGroupType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ExtendedTextMessage/enumerations/InviteLinkGroupType)

Defined in: [WAProto/index.d.ts:6277](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6277)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`inviteLinkGroupTypeV2`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#invitelinkgrouptypev2)

* * *

### inviteLinkParentGroupSubjectV2?[​](#invitelinkparentgroupsubjectv2 "Direct link to inviteLinkParentGroupSubjectV2?")

> `optional` **inviteLinkParentGroupSubjectV2**: `null` | `string`

Defined in: [WAProto/index.d.ts:6275](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6275)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`inviteLinkParentGroupSubjectV2`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#invitelinkparentgroupsubjectv2)

* * *

### inviteLinkParentGroupThumbnailV2?[​](#invitelinkparentgroupthumbnailv2 "Direct link to inviteLinkParentGroupThumbnailV2?")

> `optional` **inviteLinkParentGroupThumbnailV2**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6276](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6276)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`inviteLinkParentGroupThumbnailV2`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#invitelinkparentgroupthumbnailv2)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6264](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6264)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`jpegThumbnail`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#jpegthumbnail)

* * *

### linkPreviewMetadata?[​](#linkpreviewmetadata "Direct link to linkPreviewMetadata?")

> `optional` **linkPreviewMetadata**: `null` | [`ILinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata)

Defined in: [WAProto/index.d.ts:6282](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6282)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`linkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#linkpreviewmetadata)

* * *

### matchedText?[​](#matchedtext "Direct link to matchedText?")

> `optional` **matchedText**: `null` | `string`

Defined in: [WAProto/index.d.ts:6257](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6257)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`matchedText`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#matchedtext)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6270](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6270)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`mediaKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#mediakey)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6271](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6271)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`mediaKeyTimestamp`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#mediakeytimestamp)

* * *

### musicMetadata?[​](#musicmetadata "Direct link to musicMetadata?")

> `optional` **musicMetadata**: `null` | [`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic)

Defined in: [WAProto/index.d.ts:6286](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6286)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`musicMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#musicmetadata)

* * *

### paymentExtendedMetadata?[​](#paymentextendedmetadata "Direct link to paymentExtendedMetadata?")

> `optional` **paymentExtendedMetadata**: `null` | [`IPaymentExtendedMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentExtendedMetadata)

Defined in: [WAProto/index.d.ts:6287](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6287)

#### Implementation of[​](#implementation-of-17 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`paymentExtendedMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#paymentextendedmetadata)

* * *

### paymentLinkMetadata?[​](#paymentlinkmetadata "Direct link to paymentLinkMetadata?")

> `optional` **paymentLinkMetadata**: `null` | [`IPaymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentLinkMetadata)

Defined in: [WAProto/index.d.ts:6283](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6283)

#### Implementation of[​](#implementation-of-18 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`paymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#paymentlinkmetadata)

* * *

### previewType?[​](#previewtype "Direct link to previewType?")

> `optional` **previewType**: `null` | [`PreviewType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ExtendedTextMessage/enumerations/PreviewType)

Defined in: [WAProto/index.d.ts:6263](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6263)

#### Implementation of[​](#implementation-of-19 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`previewType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#previewtype)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:6256](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6256)

#### Implementation of[​](#implementation-of-20 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`text`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#text)

* * *

### textArgb?[​](#textargb "Direct link to textArgb?")

> `optional` **textArgb**: `null` | `number`

Defined in: [WAProto/index.d.ts:6260](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6260)

#### Implementation of[​](#implementation-of-21 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`textArgb`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#textargb)

* * *

### thumbnailDirectPath?[​](#thumbnaildirectpath "Direct link to thumbnailDirectPath?")

> `optional` **thumbnailDirectPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:6267](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6267)

#### Implementation of[​](#implementation-of-22 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`thumbnailDirectPath`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#thumbnaildirectpath)

* * *

### thumbnailEncSha256?[​](#thumbnailencsha256 "Direct link to thumbnailEncSha256?")

> `optional` **thumbnailEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6269](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6269)

#### Implementation of[​](#implementation-of-23 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`thumbnailEncSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#thumbnailencsha256)

* * *

### thumbnailHeight?[​](#thumbnailheight "Direct link to thumbnailHeight?")

> `optional` **thumbnailHeight**: `null` | `number`

Defined in: [WAProto/index.d.ts:6272](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6272)

#### Implementation of[​](#implementation-of-24 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`thumbnailHeight`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#thumbnailheight)

* * *

### thumbnailSha256?[​](#thumbnailsha256 "Direct link to thumbnailSha256?")

> `optional` **thumbnailSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6268](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6268)

#### Implementation of[​](#implementation-of-25 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`thumbnailSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#thumbnailsha256)

* * *

### thumbnailWidth?[​](#thumbnailwidth "Direct link to thumbnailWidth?")

> `optional` **thumbnailWidth**: `null` | `number`

Defined in: [WAProto/index.d.ts:6273](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6273)

#### Implementation of[​](#implementation-of-26 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`thumbnailWidth`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#thumbnailwidth)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:6259](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6259)

#### Implementation of[​](#implementation-of-27 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`title`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#title)

* * *

### videoContentUrl?[​](#videocontenturl "Direct link to videoContentUrl?")

> `optional` **videoContentUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:6285](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6285)

#### Implementation of[​](#implementation-of-28 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`videoContentUrl`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#videocontenturl)

* * *

### videoHeight?[​](#videoheight "Direct link to videoHeight?")

> `optional` **videoHeight**: `null` | `number`

Defined in: [WAProto/index.d.ts:6279](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6279)

#### Implementation of[​](#implementation-of-29 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`videoHeight`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#videoheight)

* * *

### videoWidth?[​](#videowidth "Direct link to videoWidth?")

> `optional` **videoWidth**: `null` | `number`

Defined in: [WAProto/index.d.ts:6280](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6280)

#### Implementation of[​](#implementation-of-30 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`videoWidth`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#videowidth)

* * *

### viewOnce?[​](#viewonce "Direct link to viewOnce?")

> `optional` **viewOnce**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6278](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6278)

#### Implementation of[​](#implementation-of-31 "Direct link to Implementation of")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage).[`viewOnce`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage#viewonce)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6293](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6293)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ExtendedTextMessage)

Defined in: [WAProto/index.d.ts:6288](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6288)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ExtendedTextMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ExtendedTextMessage)

Defined in: [WAProto/index.d.ts:6290](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6290)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ExtendedTextMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6289](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6289)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ExtendedTextMessage)

Defined in: [WAProto/index.d.ts:6291](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6291)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ExtendedTextMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6294](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6294)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6292](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6292)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ExtendedTextMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-fullhistorysyncondemandrequestmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/FullHistorySyncOnDemandRequestMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/FullHistorySyncOnDemandRequestMetadata)

Defined in: [WAProto/index.d.ts:6331](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6331)

## Implements[​](#implements "Direct link to Implements")

*   [`IFullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFullHistorySyncOnDemandRequestMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new FullHistorySyncOnDemandRequestMetadata()[​](#new-fullhistorysyncondemandrequestmetadata "Direct link to new FullHistorySyncOnDemandRequestMetadata()")

> **new FullHistorySyncOnDemandRequestMetadata**(`p`?): [`FullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/FullHistorySyncOnDemandRequestMetadata)

Defined in: [WAProto/index.d.ts:6332](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6332)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IFullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFullHistorySyncOnDemandRequestMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`FullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/FullHistorySyncOnDemandRequestMetadata)

## Properties[​](#properties "Direct link to Properties")

### requestId?[​](#requestid "Direct link to requestId?")

> `optional` **requestId**: `null` | `string`

Defined in: [WAProto/index.d.ts:6333](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6333)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IFullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFullHistorySyncOnDemandRequestMetadata).[`requestId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFullHistorySyncOnDemandRequestMetadata#requestid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6339](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6339)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`FullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/FullHistorySyncOnDemandRequestMetadata)

Defined in: [WAProto/index.d.ts:6334](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6334)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IFullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFullHistorySyncOnDemandRequestMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`FullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/FullHistorySyncOnDemandRequestMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`FullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/FullHistorySyncOnDemandRequestMetadata)

Defined in: [WAProto/index.d.ts:6336](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6336)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`FullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/FullHistorySyncOnDemandRequestMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6335](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6335)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IFullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFullHistorySyncOnDemandRequestMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`FullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/FullHistorySyncOnDemandRequestMetadata)

Defined in: [WAProto/index.d.ts:6337](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6337)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`FullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/FullHistorySyncOnDemandRequestMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6340](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6340)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6338](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6338)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`FullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/FullHistorySyncOnDemandRequestMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-futureproofmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/FutureProofMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/FutureProofMessage)

Defined in: [WAProto/index.d.ts:6347](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6347)

## Implements[​](#implements "Direct link to Implements")

*   [`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new FutureProofMessage()[​](#new-futureproofmessage "Direct link to new FutureProofMessage()")

> **new FutureProofMessage**(`p`?): [`FutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/FutureProofMessage)

Defined in: [WAProto/index.d.ts:6348](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6348)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

#### Returns[​](#returns "Direct link to Returns")

[`FutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/FutureProofMessage)

## Properties[​](#properties "Direct link to Properties")

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:6349](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6349)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage).[`message`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage#message)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6355](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6355)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`FutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/FutureProofMessage)

Defined in: [WAProto/index.d.ts:6350](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6350)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`FutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/FutureProofMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`FutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/FutureProofMessage)

Defined in: [WAProto/index.d.ts:6352](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6352)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`FutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/FutureProofMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6351](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6351)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IFutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`FutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/FutureProofMessage)

Defined in: [WAProto/index.d.ts:6353](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6353)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`FutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/FutureProofMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6356](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6356)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6354](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6354)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`FutureProofMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/FutureProofMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-groupinvitemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/GroupInviteMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/GroupInviteMessage)

Defined in: [WAProto/index.d.ts:6370](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6370)

## Implements[​](#implements "Direct link to Implements")

*   [`IGroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new GroupInviteMessage()[​](#new-groupinvitemessage "Direct link to new GroupInviteMessage()")

> **new GroupInviteMessage**(`p`?): [`GroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/GroupInviteMessage)

Defined in: [WAProto/index.d.ts:6371](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6371)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IGroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage)

#### Returns[​](#returns "Direct link to Returns")

[`GroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/GroupInviteMessage)

## Properties[​](#properties "Direct link to Properties")

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:6377](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6377)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IGroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage).[`caption`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage#caption)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:6378](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6378)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IGroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage#contextinfo)

* * *

### groupJid?[​](#groupjid "Direct link to groupJid?")

> `optional` **groupJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:6372](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6372)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IGroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage).[`groupJid`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage#groupjid)

* * *

### groupName?[​](#groupname "Direct link to groupName?")

> `optional` **groupName**: `null` | `string`

Defined in: [WAProto/index.d.ts:6375](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6375)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IGroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage).[`groupName`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage#groupname)

* * *

### groupType?[​](#grouptype "Direct link to groupType?")

> `optional` **groupType**: `null` | [`GroupType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/GroupInviteMessage/enumerations/GroupType)

Defined in: [WAProto/index.d.ts:6379](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6379)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IGroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage).[`groupType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage#grouptype)

* * *

### inviteCode?[​](#invitecode "Direct link to inviteCode?")

> `optional` **inviteCode**: `null` | `string`

Defined in: [WAProto/index.d.ts:6373](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6373)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IGroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage).[`inviteCode`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage#invitecode)

* * *

### inviteExpiration?[​](#inviteexpiration "Direct link to inviteExpiration?")

> `optional` **inviteExpiration**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6374](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6374)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IGroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage).[`inviteExpiration`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage#inviteexpiration)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6376](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6376)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IGroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage).[`jpegThumbnail`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage#jpegthumbnail)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6385](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6385)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`GroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/GroupInviteMessage)

Defined in: [WAProto/index.d.ts:6380](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6380)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IGroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`GroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/GroupInviteMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`GroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/GroupInviteMessage)

Defined in: [WAProto/index.d.ts:6382](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6382)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`GroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/GroupInviteMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6381](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6381)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IGroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`GroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/GroupInviteMessage)

Defined in: [WAProto/index.d.ts:6383](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6383)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`GroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/GroupInviteMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6386](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6386)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6384](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6384)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`GroupInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/GroupInviteMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-highlystructuredmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/HighlyStructuredMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/HighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:6409](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6409)

## Implements[​](#implements "Direct link to Implements")

*   [`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new HighlyStructuredMessage()[​](#new-highlystructuredmessage "Direct link to new HighlyStructuredMessage()")

> **new HighlyStructuredMessage**(`p`?): [`HighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/HighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:6410](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6410)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

#### Returns[​](#returns "Direct link to Returns")

[`HighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/HighlyStructuredMessage)

## Properties[​](#properties "Direct link to Properties")

### deterministicLc?[​](#deterministiclc "Direct link to deterministicLc?")

> `optional` **deterministicLc**: `null` | `string`

Defined in: [WAProto/index.d.ts:6418](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6418)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage).[`deterministicLc`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage#deterministiclc)

* * *

### deterministicLg?[​](#deterministiclg "Direct link to deterministicLg?")

> `optional` **deterministicLg**: `null` | `string`

Defined in: [WAProto/index.d.ts:6417](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6417)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage).[`deterministicLg`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage#deterministiclg)

* * *

### elementName?[​](#elementname "Direct link to elementName?")

> `optional` **elementName**: `null` | `string`

Defined in: [WAProto/index.d.ts:6412](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6412)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage).[`elementName`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage#elementname)

* * *

### fallbackLc?[​](#fallbacklc "Direct link to fallbackLc?")

> `optional` **fallbackLc**: `null` | `string`

Defined in: [WAProto/index.d.ts:6415](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6415)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage).[`fallbackLc`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage#fallbacklc)

* * *

### fallbackLg?[​](#fallbacklg "Direct link to fallbackLg?")

> `optional` **fallbackLg**: `null` | `string`

Defined in: [WAProto/index.d.ts:6414](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6414)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage).[`fallbackLg`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage#fallbacklg)

* * *

### hydratedHsm?[​](#hydratedhsm "Direct link to hydratedHsm?")

> `optional` **hydratedHsm**: `null` | [`ITemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage)

Defined in: [WAProto/index.d.ts:6419](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6419)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage).[`hydratedHsm`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage#hydratedhsm)

* * *

### localizableParams[​](#localizableparams "Direct link to localizableParams")

> **localizableParams**: [`IHSMLocalizableParameter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/interfaces/IHSMLocalizableParameter)\[\]

Defined in: [WAProto/index.d.ts:6416](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6416)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage).[`localizableParams`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage#localizableparams)

* * *

### namespace?[​](#namespace "Direct link to namespace?")

> `optional` **namespace**: `null` | `string`

Defined in: [WAProto/index.d.ts:6411](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6411)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage).[`namespace`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage#namespace)

* * *

### params[​](#params "Direct link to params")

> **params**: `string`\[\]

Defined in: [WAProto/index.d.ts:6413](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6413)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage).[`params`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage#params)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6425](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6425)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`HighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/HighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:6420](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6420)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`HighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/HighlyStructuredMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`HighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/HighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:6422](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6422)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`HighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/HighlyStructuredMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6421](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6421)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`HighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/HighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:6423](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6423)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`HighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/HighlyStructuredMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6426](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6426)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6424](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6424)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`HighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/HighlyStructuredMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-historysyncmessageaccessstatus"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncMessageAccessStatus](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncMessageAccessStatus)

Defined in: [WAProto/index.d.ts:6562](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6562)

## Implements[​](#implements "Direct link to Implements")

*   [`IHistorySyncMessageAccessStatus`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncMessageAccessStatus)

## Constructors[​](#constructors "Direct link to Constructors")

### new HistorySyncMessageAccessStatus()[​](#new-historysyncmessageaccessstatus "Direct link to new HistorySyncMessageAccessStatus()")

> **new HistorySyncMessageAccessStatus**(`p`?): [`HistorySyncMessageAccessStatus`](/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncMessageAccessStatus)

Defined in: [WAProto/index.d.ts:6563](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6563)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHistorySyncMessageAccessStatus`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncMessageAccessStatus)

#### Returns[​](#returns "Direct link to Returns")

[`HistorySyncMessageAccessStatus`](/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncMessageAccessStatus)

## Properties[​](#properties "Direct link to Properties")

### completeAccessGranted?[​](#completeaccessgranted "Direct link to completeAccessGranted?")

> `optional` **completeAccessGranted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6564](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6564)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHistorySyncMessageAccessStatus`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncMessageAccessStatus).[`completeAccessGranted`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncMessageAccessStatus#completeaccessgranted)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6570](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6570)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`HistorySyncMessageAccessStatus`](/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncMessageAccessStatus)

Defined in: [WAProto/index.d.ts:6565](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6565)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHistorySyncMessageAccessStatus`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncMessageAccessStatus)

#### Returns[​](#returns-2 "Direct link to Returns")

[`HistorySyncMessageAccessStatus`](/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncMessageAccessStatus)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`HistorySyncMessageAccessStatus`](/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncMessageAccessStatus)

Defined in: [WAProto/index.d.ts:6567](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6567)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`HistorySyncMessageAccessStatus`](/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncMessageAccessStatus)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6566](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6566)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHistorySyncMessageAccessStatus`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncMessageAccessStatus)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`HistorySyncMessageAccessStatus`](/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncMessageAccessStatus)

Defined in: [WAProto/index.d.ts:6568](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6568)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`HistorySyncMessageAccessStatus`](/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncMessageAccessStatus)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6571](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6571)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6569](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6569)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`HistorySyncMessageAccessStatus`](/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncMessageAccessStatus)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-historysyncnotification"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncNotification](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncNotification)

Defined in: [WAProto/index.d.ts:6592](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6592)

## Implements[​](#implements "Direct link to Implements")

*   [`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification)

## Constructors[​](#constructors "Direct link to Constructors")

### new HistorySyncNotification()[​](#new-historysyncnotification "Direct link to new HistorySyncNotification()")

> **new HistorySyncNotification**(`p`?): [`HistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncNotification)

Defined in: [WAProto/index.d.ts:6593](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6593)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification)

#### Returns[​](#returns "Direct link to Returns")

[`HistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncNotification)

## Properties[​](#properties "Direct link to Properties")

### chunkOrder?[​](#chunkorder "Direct link to chunkOrder?")

> `optional` **chunkOrder**: `null` | `number`

Defined in: [WAProto/index.d.ts:6600](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6600)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification).[`chunkOrder`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification#chunkorder)

* * *

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:6598](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6598)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification).[`directPath`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification#directpath)

* * *

### encHandle?[​](#enchandle "Direct link to encHandle?")

> `optional` **encHandle**: `null` | `string`

Defined in: [WAProto/index.d.ts:6607](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6607)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification).[`encHandle`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification#enchandle)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6597](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6597)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification).[`fileEncSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification#fileencsha256)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6595](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6595)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification).[`fileLength`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification#filelength)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6594](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6594)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification).[`fileSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification#filesha256)

* * *

### fullHistorySyncOnDemandRequestMetadata?[​](#fullhistorysyncondemandrequestmetadata "Direct link to fullHistorySyncOnDemandRequestMetadata?")

> `optional` **fullHistorySyncOnDemandRequestMetadata**: `null` | [`IFullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFullHistorySyncOnDemandRequestMetadata)

Defined in: [WAProto/index.d.ts:6606](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6606)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification).[`fullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification#fullhistorysyncondemandrequestmetadata)

* * *

### initialHistBootstrapInlinePayload?[​](#initialhistbootstrapinlinepayload "Direct link to initialHistBootstrapInlinePayload?")

> `optional` **initialHistBootstrapInlinePayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6604](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6604)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification).[`initialHistBootstrapInlinePayload`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification#initialhistbootstrapinlinepayload)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6596](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6596)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification).[`mediaKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification#mediakey)

* * *

### messageAccessStatus?[​](#messageaccessstatus "Direct link to messageAccessStatus?")

> `optional` **messageAccessStatus**: `null` | [`IHistorySyncMessageAccessStatus`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncMessageAccessStatus)

Defined in: [WAProto/index.d.ts:6608](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6608)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification).[`messageAccessStatus`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification#messageaccessstatus)

* * *

### oldestMsgInChunkTimestampSec?[​](#oldestmsginchunktimestampsec "Direct link to oldestMsgInChunkTimestampSec?")

> `optional` **oldestMsgInChunkTimestampSec**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6603](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6603)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification).[`oldestMsgInChunkTimestampSec`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification#oldestmsginchunktimestampsec)

* * *

### originalMessageId?[​](#originalmessageid "Direct link to originalMessageId?")

> `optional` **originalMessageId**: `null` | `string`

Defined in: [WAProto/index.d.ts:6601](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6601)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification).[`originalMessageId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification#originalmessageid)

* * *

### peerDataRequestSessionId?[​](#peerdatarequestsessionid "Direct link to peerDataRequestSessionId?")

> `optional` **peerDataRequestSessionId**: `null` | `string`

Defined in: [WAProto/index.d.ts:6605](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6605)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification).[`peerDataRequestSessionId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification#peerdatarequestsessionid)

* * *

### progress?[​](#progress "Direct link to progress?")

> `optional` **progress**: `null` | `number`

Defined in: [WAProto/index.d.ts:6602](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6602)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification).[`progress`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification#progress)

* * *

### syncType?[​](#synctype "Direct link to syncType?")

> `optional` **syncType**: `null` | [`HistorySyncType`](/docs/api/namespaces/proto/namespaces/Message/enumerations/HistorySyncType)

Defined in: [WAProto/index.d.ts:6599](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6599)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification).[`syncType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification#synctype)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6614](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6614)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`HistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncNotification)

Defined in: [WAProto/index.d.ts:6609](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6609)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification)

#### Returns[​](#returns-2 "Direct link to Returns")

[`HistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncNotification)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`HistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncNotification)

Defined in: [WAProto/index.d.ts:6611](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6611)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`HistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncNotification)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6610](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6610)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`HistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncNotification)

Defined in: [WAProto/index.d.ts:6612](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6612)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`HistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncNotification)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6615](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6615)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6613](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6613)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`HistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/classes/HistorySyncNotification)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-imagemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ImageMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ImageMessage)

Defined in: [WAProto/index.d.ts:6664](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6664)

## Implements[​](#implements "Direct link to Implements")

*   [`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new ImageMessage()[​](#new-imagemessage "Direct link to new ImageMessage()")

> **new ImageMessage**(`p`?): [`ImageMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ImageMessage)

Defined in: [WAProto/index.d.ts:6665](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6665)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage)

#### Returns[​](#returns "Direct link to Returns")

[`ImageMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ImageMessage)

## Properties[​](#properties "Direct link to Properties")

### accessibilityLabel?[​](#accessibilitylabel "Direct link to accessibilityLabel?")

> `optional` **accessibilityLabel**: `null` | `string`

Defined in: [WAProto/index.d.ts:6694](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6694)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`accessibilityLabel`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#accessibilitylabel)

* * *

### annotations[​](#annotations "Direct link to annotations")

> **annotations**: [`IInteractiveAnnotation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation)\[\]

Defined in: [WAProto/index.d.ts:6692](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6692)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`annotations`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#annotations)

* * *

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:6668](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6668)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`caption`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#caption)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:6679](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6679)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#contextinfo)

* * *

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:6676](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6676)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`directPath`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#directpath)

* * *

### experimentGroupId?[​](#experimentgroupid "Direct link to experimentGroupId?")

> `optional` **experimentGroupId**: `null` | `number`

Defined in: [WAProto/index.d.ts:6682](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6682)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`experimentGroupId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#experimentgroupid)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6674](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6674)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`fileEncSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#fileencsha256)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6670](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6670)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`fileLength`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#filelength)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6669](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6669)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`fileSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#filesha256)

* * *

### firstScanLength?[​](#firstscanlength "Direct link to firstScanLength?")

> `optional` **firstScanLength**: `null` | `number`

Defined in: [WAProto/index.d.ts:6681](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6681)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`firstScanLength`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#firstscanlength)

* * *

### firstScanSidecar?[​](#firstscansidecar "Direct link to firstScanSidecar?")

> `optional` **firstScanSidecar**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6680](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6680)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`firstScanSidecar`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#firstscansidecar)

* * *

### height?[​](#height "Direct link to height?")

> `optional` **height**: `null` | `number`

Defined in: [WAProto/index.d.ts:6671](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6671)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`height`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#height)

* * *

### imageSourceType?[​](#imagesourcetype "Direct link to imageSourceType?")

> `optional` **imageSourceType**: `null` | [`ImageSourceType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ImageMessage/enumerations/ImageSourceType)

Defined in: [WAProto/index.d.ts:6693](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6693)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`imageSourceType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#imagesourcetype)

* * *

### interactiveAnnotations[​](#interactiveannotations "Direct link to interactiveAnnotations")

> **interactiveAnnotations**: [`IInteractiveAnnotation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation)\[\]

Defined in: [WAProto/index.d.ts:6675](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6675)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`interactiveAnnotations`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#interactiveannotations)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6678](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6678)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`jpegThumbnail`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#jpegthumbnail)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6673](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6673)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`mediaKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#mediakey)

* * *

### mediaKeyDomain?[​](#mediakeydomain "Direct link to mediaKeyDomain?")

> `optional` **mediaKeyDomain**: `null` | [`MediaKeyDomain`](/docs/api/namespaces/proto/namespaces/Message/enumerations/MediaKeyDomain)

Defined in: [WAProto/index.d.ts:6695](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6695)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`mediaKeyDomain`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#mediakeydomain)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6677](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6677)

#### Implementation of[​](#implementation-of-17 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`mediaKeyTimestamp`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#mediakeytimestamp)

* * *

### midQualityFileEncSha256?[​](#midqualityfileencsha256 "Direct link to midQualityFileEncSha256?")

> `optional` **midQualityFileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6686](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6686)

#### Implementation of[​](#implementation-of-18 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`midQualityFileEncSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#midqualityfileencsha256)

* * *

### midQualityFileSha256?[​](#midqualityfilesha256 "Direct link to midQualityFileSha256?")

> `optional` **midQualityFileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6685](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6685)

#### Implementation of[​](#implementation-of-19 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`midQualityFileSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#midqualityfilesha256)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:6667](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6667)

#### Implementation of[​](#implementation-of-20 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`mimetype`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#mimetype)

* * *

### qrUrl?[​](#qrurl "Direct link to qrUrl?")

> `optional` **qrUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:6696](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6696)

#### Implementation of[​](#implementation-of-21 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`qrUrl`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#qrurl)

* * *

### scanLengths[​](#scanlengths "Direct link to scanLengths")

> **scanLengths**: `number`\[\]

Defined in: [WAProto/index.d.ts:6684](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6684)

#### Implementation of[​](#implementation-of-22 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`scanLengths`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#scanlengths)

* * *

### scansSidecar?[​](#scanssidecar "Direct link to scansSidecar?")

> `optional` **scansSidecar**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6683](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6683)

#### Implementation of[​](#implementation-of-23 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`scansSidecar`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#scanssidecar)

* * *

### staticUrl?[​](#staticurl "Direct link to staticUrl?")

> `optional` **staticUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:6691](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6691)

#### Implementation of[​](#implementation-of-24 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`staticUrl`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#staticurl)

* * *

### thumbnailDirectPath?[​](#thumbnaildirectpath "Direct link to thumbnailDirectPath?")

> `optional` **thumbnailDirectPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:6688](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6688)

#### Implementation of[​](#implementation-of-25 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`thumbnailDirectPath`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#thumbnaildirectpath)

* * *

### thumbnailEncSha256?[​](#thumbnailencsha256 "Direct link to thumbnailEncSha256?")

> `optional` **thumbnailEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6690](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6690)

#### Implementation of[​](#implementation-of-26 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`thumbnailEncSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#thumbnailencsha256)

* * *

### thumbnailSha256?[​](#thumbnailsha256 "Direct link to thumbnailSha256?")

> `optional` **thumbnailSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6689](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6689)

#### Implementation of[​](#implementation-of-27 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`thumbnailSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#thumbnailsha256)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:6666](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6666)

#### Implementation of[​](#implementation-of-28 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`url`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#url)

* * *

### viewOnce?[​](#viewonce "Direct link to viewOnce?")

> `optional` **viewOnce**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6687](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6687)

#### Implementation of[​](#implementation-of-29 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`viewOnce`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#viewonce)

* * *

### width?[​](#width "Direct link to width?")

> `optional` **width**: `null` | `number`

Defined in: [WAProto/index.d.ts:6672](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6672)

#### Implementation of[​](#implementation-of-30 "Direct link to Implementation of")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage).[`width`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage#width)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6702](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6702)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ImageMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ImageMessage)

Defined in: [WAProto/index.d.ts:6697](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6697)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ImageMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ImageMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ImageMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ImageMessage)

Defined in: [WAProto/index.d.ts:6699](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6699)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ImageMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ImageMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6698](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6698)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ImageMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ImageMessage)

Defined in: [WAProto/index.d.ts:6700](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6700)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ImageMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ImageMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6703](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6703)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6701](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6701)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ImageMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ImageMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-initialsecuritynotificationsettingsync"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/InitialSecurityNotificationSettingSync](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/InitialSecurityNotificationSettingSync)

Defined in: [WAProto/index.d.ts:6720](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6720)

## Implements[​](#implements "Direct link to Implements")

*   [`IInitialSecurityNotificationSettingSync`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInitialSecurityNotificationSettingSync)

## Constructors[​](#constructors "Direct link to Constructors")

### new InitialSecurityNotificationSettingSync()[​](#new-initialsecuritynotificationsettingsync "Direct link to new InitialSecurityNotificationSettingSync()")

> **new InitialSecurityNotificationSettingSync**(`p`?): [`InitialSecurityNotificationSettingSync`](/docs/api/namespaces/proto/namespaces/Message/classes/InitialSecurityNotificationSettingSync)

Defined in: [WAProto/index.d.ts:6721](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6721)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IInitialSecurityNotificationSettingSync`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInitialSecurityNotificationSettingSync)

#### Returns[​](#returns "Direct link to Returns")

[`InitialSecurityNotificationSettingSync`](/docs/api/namespaces/proto/namespaces/Message/classes/InitialSecurityNotificationSettingSync)

## Properties[​](#properties "Direct link to Properties")

### securityNotificationEnabled?[​](#securitynotificationenabled "Direct link to securityNotificationEnabled?")

> `optional` **securityNotificationEnabled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6722](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6722)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IInitialSecurityNotificationSettingSync`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInitialSecurityNotificationSettingSync).[`securityNotificationEnabled`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInitialSecurityNotificationSettingSync#securitynotificationenabled)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6728](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6728)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`InitialSecurityNotificationSettingSync`](/docs/api/namespaces/proto/namespaces/Message/classes/InitialSecurityNotificationSettingSync)

Defined in: [WAProto/index.d.ts:6723](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6723)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IInitialSecurityNotificationSettingSync`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInitialSecurityNotificationSettingSync)

#### Returns[​](#returns-2 "Direct link to Returns")

[`InitialSecurityNotificationSettingSync`](/docs/api/namespaces/proto/namespaces/Message/classes/InitialSecurityNotificationSettingSync)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`InitialSecurityNotificationSettingSync`](/docs/api/namespaces/proto/namespaces/Message/classes/InitialSecurityNotificationSettingSync)

Defined in: [WAProto/index.d.ts:6725](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6725)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`InitialSecurityNotificationSettingSync`](/docs/api/namespaces/proto/namespaces/Message/classes/InitialSecurityNotificationSettingSync)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6724](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6724)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IInitialSecurityNotificationSettingSync`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInitialSecurityNotificationSettingSync)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`InitialSecurityNotificationSettingSync`](/docs/api/namespaces/proto/namespaces/Message/classes/InitialSecurityNotificationSettingSync)

Defined in: [WAProto/index.d.ts:6726](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6726)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`InitialSecurityNotificationSettingSync`](/docs/api/namespaces/proto/namespaces/Message/classes/InitialSecurityNotificationSettingSync)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6729](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6729)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6727](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6727)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`InitialSecurityNotificationSettingSync`](/docs/api/namespaces/proto/namespaces/Message/classes/InitialSecurityNotificationSettingSync)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-interactivemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveMessage)

Defined in: [WAProto/index.d.ts:6744](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6744)

## Implements[​](#implements "Direct link to Implements")

*   [`IInteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new InteractiveMessage()[​](#new-interactivemessage "Direct link to new InteractiveMessage()")

> **new InteractiveMessage**(`p`?): [`InteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveMessage)

Defined in: [WAProto/index.d.ts:6745](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6745)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IInteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage)

#### Returns[​](#returns "Direct link to Returns")

[`InteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveMessage)

## Properties[​](#properties "Direct link to Properties")

### body?[​](#body "Direct link to body?")

> `optional` **body**: `null` | [`IBody`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IBody)

Defined in: [WAProto/index.d.ts:6747](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6747)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IInteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage).[`body`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage#body)

* * *

### carouselMessage?[​](#carouselmessage "Direct link to carouselMessage?")

> `optional` **carouselMessage**: `null` | [`ICarouselMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICarouselMessage)

Defined in: [WAProto/index.d.ts:6754](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6754)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IInteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage).[`carouselMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage#carouselmessage)

* * *

### collectionMessage?[​](#collectionmessage "Direct link to collectionMessage?")

> `optional` **collectionMessage**: `null` | [`ICollectionMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICollectionMessage)

Defined in: [WAProto/index.d.ts:6752](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6752)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IInteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage).[`collectionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage#collectionmessage)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:6749](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6749)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IInteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage#contextinfo)

* * *

### footer?[​](#footer "Direct link to footer?")

> `optional` **footer**: `null` | [`IFooter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IFooter)

Defined in: [WAProto/index.d.ts:6748](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6748)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IInteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage).[`footer`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage#footer)

* * *

### header?[​](#header "Direct link to header?")

> `optional` **header**: `null` | [`IHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader)

Defined in: [WAProto/index.d.ts:6746](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6746)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IInteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage).[`header`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage#header)

* * *

### interactiveMessage?[​](#interactivemessage "Direct link to interactiveMessage?")

> `optional` **interactiveMessage**: `"shopStorefrontMessage"` | `"collectionMessage"` | `"nativeFlowMessage"` | `"carouselMessage"`

Defined in: [WAProto/index.d.ts:6755](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6755)

* * *

### nativeFlowMessage?[​](#nativeflowmessage "Direct link to nativeFlowMessage?")

> `optional` **nativeFlowMessage**: `null` | [`INativeFlowMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/INativeFlowMessage)

Defined in: [WAProto/index.d.ts:6753](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6753)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IInteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage).[`nativeFlowMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage#nativeflowmessage)

* * *

### shopStorefrontMessage?[​](#shopstorefrontmessage "Direct link to shopStorefrontMessage?")

> `optional` **shopStorefrontMessage**: `null` | [`IShopMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IShopMessage)

Defined in: [WAProto/index.d.ts:6751](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6751)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IInteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage).[`shopStorefrontMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage#shopstorefrontmessage)

* * *

### urlTrackingMap?[​](#urltrackingmap "Direct link to urlTrackingMap?")

> `optional` **urlTrackingMap**: `null` | [`IUrlTrackingMap`](/docs/api/namespaces/proto/interfaces/IUrlTrackingMap)

Defined in: [WAProto/index.d.ts:6750](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6750)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IInteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage).[`urlTrackingMap`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage#urltrackingmap)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6761](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6761)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`InteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveMessage)

Defined in: [WAProto/index.d.ts:6756](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6756)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IInteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`InteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`InteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveMessage)

Defined in: [WAProto/index.d.ts:6758](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6758)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`InteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6757](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6757)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IInteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`InteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveMessage)

Defined in: [WAProto/index.d.ts:6759](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6759)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`InteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6762](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6762)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6760](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6760)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`InteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-interactiveresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveResponseMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveResponseMessage)

Defined in: [WAProto/index.d.ts:6964](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6964)

## Implements[​](#implements "Direct link to Implements")

*   [`IInteractiveResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveResponseMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new InteractiveResponseMessage()[​](#new-interactiveresponsemessage "Direct link to new InteractiveResponseMessage()")

> **new InteractiveResponseMessage**(`p`?): [`InteractiveResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveResponseMessage)

Defined in: [WAProto/index.d.ts:6965](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6965)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IInteractiveResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveResponseMessage)

#### Returns[​](#returns "Direct link to Returns")

[`InteractiveResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveResponseMessage)

## Properties[​](#properties "Direct link to Properties")

### body?[​](#body "Direct link to body?")

> `optional` **body**: `null` | [`IBody`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/IBody)

Defined in: [WAProto/index.d.ts:6966](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6966)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IInteractiveResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveResponseMessage).[`body`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveResponseMessage#body)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:6967](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6967)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IInteractiveResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveResponseMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveResponseMessage#contextinfo)

* * *

### interactiveResponseMessage?[​](#interactiveresponsemessage "Direct link to interactiveResponseMessage?")

> `optional` **interactiveResponseMessage**: `"nativeFlowResponseMessage"`

Defined in: [WAProto/index.d.ts:6969](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6969)

* * *

### nativeFlowResponseMessage?[​](#nativeflowresponsemessage "Direct link to nativeFlowResponseMessage?")

> `optional` **nativeFlowResponseMessage**: `null` | [`INativeFlowResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/INativeFlowResponseMessage)

Defined in: [WAProto/index.d.ts:6968](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6968)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IInteractiveResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveResponseMessage).[`nativeFlowResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveResponseMessage#nativeflowresponsemessage)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6975](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6975)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`InteractiveResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveResponseMessage)

Defined in: [WAProto/index.d.ts:6970](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6970)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IInteractiveResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveResponseMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`InteractiveResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveResponseMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`InteractiveResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveResponseMessage)

Defined in: [WAProto/index.d.ts:6972](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6972)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`InteractiveResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveResponseMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6971](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6971)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IInteractiveResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveResponseMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`InteractiveResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveResponseMessage)

Defined in: [WAProto/index.d.ts:6973](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6973)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`InteractiveResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveResponseMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6976](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6976)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6974](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6974)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`InteractiveResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InteractiveResponseMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-invoicemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/InvoiceMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/InvoiceMessage)

Defined in: [WAProto/index.d.ts:7041](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7041)

## Implements[​](#implements "Direct link to Implements")

*   [`IInvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new InvoiceMessage()[​](#new-invoicemessage "Direct link to new InvoiceMessage()")

> **new InvoiceMessage**(`p`?): [`InvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InvoiceMessage)

Defined in: [WAProto/index.d.ts:7042](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7042)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IInvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage)

#### Returns[​](#returns "Direct link to Returns")

[`InvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InvoiceMessage)

## Properties[​](#properties "Direct link to Properties")

### attachmentDirectPath?[​](#attachmentdirectpath "Direct link to attachmentDirectPath?")

> `optional` **attachmentDirectPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:7051](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7051)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IInvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage).[`attachmentDirectPath`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage#attachmentdirectpath)

* * *

### attachmentFileEncSha256?[​](#attachmentfileencsha256 "Direct link to attachmentFileEncSha256?")

> `optional` **attachmentFileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7050](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7050)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IInvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage).[`attachmentFileEncSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage#attachmentfileencsha256)

* * *

### attachmentFileSha256?[​](#attachmentfilesha256 "Direct link to attachmentFileSha256?")

> `optional` **attachmentFileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7049](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7049)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IInvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage).[`attachmentFileSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage#attachmentfilesha256)

* * *

### attachmentJpegThumbnail?[​](#attachmentjpegthumbnail "Direct link to attachmentJpegThumbnail?")

> `optional` **attachmentJpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7052](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7052)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IInvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage).[`attachmentJpegThumbnail`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage#attachmentjpegthumbnail)

* * *

### attachmentMediaKey?[​](#attachmentmediakey "Direct link to attachmentMediaKey?")

> `optional` **attachmentMediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7047](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7047)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IInvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage).[`attachmentMediaKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage#attachmentmediakey)

* * *

### attachmentMediaKeyTimestamp?[​](#attachmentmediakeytimestamp "Direct link to attachmentMediaKeyTimestamp?")

> `optional` **attachmentMediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7048](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7048)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IInvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage).[`attachmentMediaKeyTimestamp`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage#attachmentmediakeytimestamp)

* * *

### attachmentMimetype?[​](#attachmentmimetype "Direct link to attachmentMimetype?")

> `optional` **attachmentMimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:7046](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7046)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IInvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage).[`attachmentMimetype`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage#attachmentmimetype)

* * *

### attachmentType?[​](#attachmenttype "Direct link to attachmentType?")

> `optional` **attachmentType**: `null` | [`AttachmentType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InvoiceMessage/enumerations/AttachmentType)

Defined in: [WAProto/index.d.ts:7045](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7045)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IInvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage).[`attachmentType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage#attachmenttype)

* * *

### note?[​](#note "Direct link to note?")

> `optional` **note**: `null` | `string`

Defined in: [WAProto/index.d.ts:7043](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7043)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IInvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage).[`note`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage#note)

* * *

### token?[​](#token "Direct link to token?")

> `optional` **token**: `null` | `string`

Defined in: [WAProto/index.d.ts:7044](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7044)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IInvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage).[`token`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage#token)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7058](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7058)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`InvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InvoiceMessage)

Defined in: [WAProto/index.d.ts:7053](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7053)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IInvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`InvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InvoiceMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`InvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InvoiceMessage)

Defined in: [WAProto/index.d.ts:7055](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7055)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`InvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InvoiceMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7054](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7054)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IInvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`InvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InvoiceMessage)

Defined in: [WAProto/index.d.ts:7056](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7056)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`InvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InvoiceMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7059](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7059)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7057](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7057)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`InvoiceMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/InvoiceMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-keepinchatmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/KeepInChatMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/KeepInChatMessage)

Defined in: [WAProto/index.d.ts:7076](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7076)

## Implements[​](#implements "Direct link to Implements")

*   [`IKeepInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IKeepInChatMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new KeepInChatMessage()[​](#new-keepinchatmessage "Direct link to new KeepInChatMessage()")

> **new KeepInChatMessage**(`p`?): [`KeepInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/KeepInChatMessage)

Defined in: [WAProto/index.d.ts:7077](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7077)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IKeepInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IKeepInChatMessage)

#### Returns[​](#returns "Direct link to Returns")

[`KeepInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/KeepInChatMessage)

## Properties[​](#properties "Direct link to Properties")

### keepType?[​](#keeptype "Direct link to keepType?")

> `optional` **keepType**: `null` | [`KeepType`](/docs/api/namespaces/proto/enumerations/KeepType)

Defined in: [WAProto/index.d.ts:7079](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7079)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IKeepInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IKeepInChatMessage).[`keepType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IKeepInChatMessage#keeptype)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:7078](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7078)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IKeepInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IKeepInChatMessage).[`key`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IKeepInChatMessage#key)

* * *

### timestampMs?[​](#timestampms "Direct link to timestampMs?")

> `optional` **timestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7080](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7080)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IKeepInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IKeepInChatMessage).[`timestampMs`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IKeepInChatMessage#timestampms)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7086](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7086)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`KeepInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/KeepInChatMessage)

Defined in: [WAProto/index.d.ts:7081](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7081)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IKeepInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IKeepInChatMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`KeepInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/KeepInChatMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`KeepInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/KeepInChatMessage)

Defined in: [WAProto/index.d.ts:7083](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7083)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`KeepInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/KeepInChatMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7082](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7082)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IKeepInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IKeepInChatMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`KeepInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/KeepInChatMessage)

Defined in: [WAProto/index.d.ts:7084](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7084)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`KeepInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/KeepInChatMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7087](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7087)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7085](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7085)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`KeepInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/KeepInChatMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-linkpreviewmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/LinkPreviewMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/LinkPreviewMetadata)

Defined in: [WAProto/index.d.ts:7102](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7102)

## Implements[​](#implements "Direct link to Implements")

*   [`ILinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new LinkPreviewMetadata()[​](#new-linkpreviewmetadata "Direct link to new LinkPreviewMetadata()")

> **new LinkPreviewMetadata**(`p`?): [`LinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/LinkPreviewMetadata)

Defined in: [WAProto/index.d.ts:7103](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7103)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ILinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`LinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/LinkPreviewMetadata)

## Properties[​](#properties "Direct link to Properties")

### fbExperimentId?[​](#fbexperimentid "Direct link to fbExperimentId?")

> `optional` **fbExperimentId**: `null` | `number`

Defined in: [WAProto/index.d.ts:7106](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7106)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata).[`fbExperimentId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata#fbexperimentid)

* * *

### linkInlineVideoMuted?[​](#linkinlinevideomuted "Direct link to linkInlineVideoMuted?")

> `optional` **linkInlineVideoMuted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:7109](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7109)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ILinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata).[`linkInlineVideoMuted`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata#linkinlinevideomuted)

* * *

### linkMediaDuration?[​](#linkmediaduration "Direct link to linkMediaDuration?")

> `optional` **linkMediaDuration**: `null` | `number`

Defined in: [WAProto/index.d.ts:7107](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7107)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ILinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata).[`linkMediaDuration`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata#linkmediaduration)

* * *

### musicMetadata?[​](#musicmetadata "Direct link to musicMetadata?")

> `optional` **musicMetadata**: `null` | [`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic)

Defined in: [WAProto/index.d.ts:7111](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7111)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ILinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata).[`musicMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata#musicmetadata)

* * *

### paymentLinkMetadata?[​](#paymentlinkmetadata "Direct link to paymentLinkMetadata?")

> `optional` **paymentLinkMetadata**: `null` | [`IPaymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentLinkMetadata)

Defined in: [WAProto/index.d.ts:7104](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7104)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ILinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata).[`paymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata#paymentlinkmetadata)

* * *

### socialMediaPostType?[​](#socialmediaposttype "Direct link to socialMediaPostType?")

> `optional` **socialMediaPostType**: `null` | [`SocialMediaPostType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/LinkPreviewMetadata/enumerations/SocialMediaPostType)

Defined in: [WAProto/index.d.ts:7108](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7108)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`ILinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata).[`socialMediaPostType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata#socialmediaposttype)

* * *

### urlMetadata?[​](#urlmetadata "Direct link to urlMetadata?")

> `optional` **urlMetadata**: `null` | [`IURLMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IURLMetadata)

Defined in: [WAProto/index.d.ts:7105](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7105)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`ILinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata).[`urlMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata#urlmetadata)

* * *

### videoContentCaption?[​](#videocontentcaption "Direct link to videoContentCaption?")

> `optional` **videoContentCaption**: `null` | `string`

Defined in: [WAProto/index.d.ts:7112](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7112)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`ILinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata).[`videoContentCaption`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata#videocontentcaption)

* * *

### videoContentUrl?[​](#videocontenturl "Direct link to videoContentUrl?")

> `optional` **videoContentUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:7110](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7110)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`ILinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata).[`videoContentUrl`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata#videocontenturl)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7118](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7118)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`LinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/LinkPreviewMetadata)

Defined in: [WAProto/index.d.ts:7113](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7113)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ILinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`LinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/LinkPreviewMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`LinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/LinkPreviewMetadata)

Defined in: [WAProto/index.d.ts:7115](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7115)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`LinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/LinkPreviewMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7114](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7114)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ILinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`LinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/LinkPreviewMetadata)

Defined in: [WAProto/index.d.ts:7116](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7116)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`LinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/LinkPreviewMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7119](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7119)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7117](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7117)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`LinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/LinkPreviewMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-listmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ListMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ListMessage)

Defined in: [WAProto/index.d.ts:7145](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7145)

## Implements[​](#implements "Direct link to Implements")

*   [`IListMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new ListMessage()[​](#new-listmessage "Direct link to new ListMessage()")

> **new ListMessage**(`p`?): [`ListMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ListMessage)

Defined in: [WAProto/index.d.ts:7146](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7146)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IListMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage)

#### Returns[​](#returns "Direct link to Returns")

[`ListMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ListMessage)

## Properties[​](#properties "Direct link to Properties")

### buttonText?[​](#buttontext "Direct link to buttonText?")

> `optional` **buttonText**: `null` | `string`

Defined in: [WAProto/index.d.ts:7149](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7149)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IListMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage).[`buttonText`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage#buttontext)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:7154](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7154)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IListMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage#contextinfo)

* * *

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:7148](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7148)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IListMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage).[`description`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage#description)

* * *

### footerText?[​](#footertext "Direct link to footerText?")

> `optional` **footerText**: `null` | `string`

Defined in: [WAProto/index.d.ts:7153](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7153)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IListMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage).[`footerText`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage#footertext)

* * *

### listType?[​](#listtype "Direct link to listType?")

> `optional` **listType**: `null` | [`ListType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/enumerations/ListType)

Defined in: [WAProto/index.d.ts:7150](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7150)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IListMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage).[`listType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage#listtype)

* * *

### productListInfo?[​](#productlistinfo "Direct link to productListInfo?")

> `optional` **productListInfo**: `null` | [`IProductListInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListInfo)

Defined in: [WAProto/index.d.ts:7152](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7152)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IListMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage).[`productListInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage#productlistinfo)

* * *

### sections[​](#sections "Direct link to sections")

> **sections**: [`ISection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/ISection)\[\]

Defined in: [WAProto/index.d.ts:7151](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7151)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IListMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage).[`sections`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage#sections)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:7147](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7147)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IListMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage).[`title`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage#title)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7160](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7160)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ListMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ListMessage)

Defined in: [WAProto/index.d.ts:7155](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7155)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IListMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ListMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ListMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ListMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ListMessage)

Defined in: [WAProto/index.d.ts:7157](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7157)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ListMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ListMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7156](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7156)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IListMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ListMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ListMessage)

Defined in: [WAProto/index.d.ts:7158](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7158)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ListMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ListMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7161](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7161)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7159](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7159)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ListMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ListMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-listresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ListResponseMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ListResponseMessage)

Defined in: [WAProto/index.d.ts:7291](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7291)

## Implements[​](#implements "Direct link to Implements")

*   [`IListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListResponseMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new ListResponseMessage()[​](#new-listresponsemessage "Direct link to new ListResponseMessage()")

> **new ListResponseMessage**(`p`?): [`ListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ListResponseMessage)

Defined in: [WAProto/index.d.ts:7292](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7292)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListResponseMessage)

#### Returns[​](#returns "Direct link to Returns")

[`ListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ListResponseMessage)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:7296](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7296)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListResponseMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListResponseMessage#contextinfo)

* * *

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:7297](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7297)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListResponseMessage).[`description`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListResponseMessage#description)

* * *

### listType?[​](#listtype "Direct link to listType?")

> `optional` **listType**: `null` | [`ListType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/enumerations/ListType)

Defined in: [WAProto/index.d.ts:7294](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7294)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListResponseMessage).[`listType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListResponseMessage#listtype)

* * *

### singleSelectReply?[​](#singleselectreply "Direct link to singleSelectReply?")

> `optional` **singleSelectReply**: `null` | [`ISingleSelectReply`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/interfaces/ISingleSelectReply)

Defined in: [WAProto/index.d.ts:7295](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7295)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListResponseMessage).[`singleSelectReply`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListResponseMessage#singleselectreply)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:7293](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7293)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListResponseMessage).[`title`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListResponseMessage#title)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7303](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7303)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ListResponseMessage)

Defined in: [WAProto/index.d.ts:7298](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7298)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListResponseMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ListResponseMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ListResponseMessage)

Defined in: [WAProto/index.d.ts:7300](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7300)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ListResponseMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7299](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7299)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListResponseMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ListResponseMessage)

Defined in: [WAProto/index.d.ts:7301](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7301)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ListResponseMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7304](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7304)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7302](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7302)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ListResponseMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-livelocationmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/LiveLocationMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/LiveLocationMessage)

Defined in: [WAProto/index.d.ts:7344](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7344)

## Implements[​](#implements "Direct link to Implements")

*   [`ILiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new LiveLocationMessage()[​](#new-livelocationmessage "Direct link to new LiveLocationMessage()")

> **new LiveLocationMessage**(`p`?): [`LiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/LiveLocationMessage)

Defined in: [WAProto/index.d.ts:7345](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7345)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ILiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage)

#### Returns[​](#returns "Direct link to Returns")

[`LiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/LiveLocationMessage)

## Properties[​](#properties "Direct link to Properties")

### accuracyInMeters?[​](#accuracyinmeters "Direct link to accuracyInMeters?")

> `optional` **accuracyInMeters**: `null` | `number`

Defined in: [WAProto/index.d.ts:7348](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7348)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage).[`accuracyInMeters`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage#accuracyinmeters)

* * *

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:7351](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7351)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ILiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage).[`caption`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage#caption)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:7355](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7355)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ILiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage#contextinfo)

* * *

### degreesClockwiseFromMagneticNorth?[​](#degreesclockwisefrommagneticnorth "Direct link to degreesClockwiseFromMagneticNorth?")

> `optional` **degreesClockwiseFromMagneticNorth**: `null` | `number`

Defined in: [WAProto/index.d.ts:7350](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7350)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ILiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage).[`degreesClockwiseFromMagneticNorth`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage#degreesclockwisefrommagneticnorth)

* * *

### degreesLatitude?[​](#degreeslatitude "Direct link to degreesLatitude?")

> `optional` **degreesLatitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:7346](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7346)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ILiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage).[`degreesLatitude`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage#degreeslatitude)

* * *

### degreesLongitude?[​](#degreeslongitude "Direct link to degreesLongitude?")

> `optional` **degreesLongitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:7347](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7347)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`ILiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage).[`degreesLongitude`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage#degreeslongitude)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7354](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7354)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`ILiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage).[`jpegThumbnail`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage#jpegthumbnail)

* * *

### sequenceNumber?[​](#sequencenumber "Direct link to sequenceNumber?")

> `optional` **sequenceNumber**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7352](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7352)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`ILiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage).[`sequenceNumber`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage#sequencenumber)

* * *

### speedInMps?[​](#speedinmps "Direct link to speedInMps?")

> `optional` **speedInMps**: `null` | `number`

Defined in: [WAProto/index.d.ts:7349](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7349)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`ILiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage).[`speedInMps`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage#speedinmps)

* * *

### timeOffset?[​](#timeoffset "Direct link to timeOffset?")

> `optional` **timeOffset**: `null` | `number`

Defined in: [WAProto/index.d.ts:7353](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7353)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`ILiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage).[`timeOffset`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage#timeoffset)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7361](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7361)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`LiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/LiveLocationMessage)

Defined in: [WAProto/index.d.ts:7356](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7356)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ILiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`LiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/LiveLocationMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`LiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/LiveLocationMessage)

Defined in: [WAProto/index.d.ts:7358](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7358)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`LiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/LiveLocationMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7357](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7357)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ILiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`LiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/LiveLocationMessage)

Defined in: [WAProto/index.d.ts:7359](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7359)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`LiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/LiveLocationMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7362](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7362)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7360](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7360)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`LiveLocationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/LiveLocationMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-locationmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/LocationMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/LocationMessage)

Defined in: [WAProto/index.d.ts:7380](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7380)

## Implements[​](#implements "Direct link to Implements")

*   [`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new LocationMessage()[​](#new-locationmessage "Direct link to new LocationMessage()")

> **new LocationMessage**(`p`?): [`LocationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/LocationMessage)

Defined in: [WAProto/index.d.ts:7381](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7381)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage)

#### Returns[​](#returns "Direct link to Returns")

[`LocationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/LocationMessage)

## Properties[​](#properties "Direct link to Properties")

### accuracyInMeters?[​](#accuracyinmeters "Direct link to accuracyInMeters?")

> `optional` **accuracyInMeters**: `null` | `number`

Defined in: [WAProto/index.d.ts:7388](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7388)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage).[`accuracyInMeters`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage#accuracyinmeters)

* * *

### address?[​](#address "Direct link to address?")

> `optional` **address**: `null` | `string`

Defined in: [WAProto/index.d.ts:7385](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7385)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage).[`address`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage#address)

* * *

### comment?[​](#comment "Direct link to comment?")

> `optional` **comment**: `null` | `string`

Defined in: [WAProto/index.d.ts:7391](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7391)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage).[`comment`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage#comment)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:7393](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7393)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage#contextinfo)

* * *

### degreesClockwiseFromMagneticNorth?[​](#degreesclockwisefrommagneticnorth "Direct link to degreesClockwiseFromMagneticNorth?")

> `optional` **degreesClockwiseFromMagneticNorth**: `null` | `number`

Defined in: [WAProto/index.d.ts:7390](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7390)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage).[`degreesClockwiseFromMagneticNorth`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage#degreesclockwisefrommagneticnorth)

* * *

### degreesLatitude?[​](#degreeslatitude "Direct link to degreesLatitude?")

> `optional` **degreesLatitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:7382](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7382)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage).[`degreesLatitude`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage#degreeslatitude)

* * *

### degreesLongitude?[​](#degreeslongitude "Direct link to degreesLongitude?")

> `optional` **degreesLongitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:7383](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7383)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage).[`degreesLongitude`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage#degreeslongitude)

* * *

### isLive?[​](#islive "Direct link to isLive?")

> `optional` **isLive**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:7387](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7387)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage).[`isLive`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage#islive)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7392](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7392)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage).[`jpegThumbnail`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage#jpegthumbnail)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:7384](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7384)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage).[`name`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage#name)

* * *

### speedInMps?[​](#speedinmps "Direct link to speedInMps?")

> `optional` **speedInMps**: `null` | `number`

Defined in: [WAProto/index.d.ts:7389](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7389)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage).[`speedInMps`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage#speedinmps)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:7386](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7386)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage).[`url`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage#url)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7399](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7399)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`LocationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/LocationMessage)

Defined in: [WAProto/index.d.ts:7394](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7394)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`LocationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/LocationMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`LocationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/LocationMessage)

Defined in: [WAProto/index.d.ts:7396](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7396)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`LocationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/LocationMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7395](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7395)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`LocationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/LocationMessage)

Defined in: [WAProto/index.d.ts:7397](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7397)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`LocationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/LocationMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7400](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7400)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7398](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7398)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`LocationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/LocationMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-mmsthumbnailmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/MMSThumbnailMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/MMSThumbnailMetadata)

Defined in: [WAProto/index.d.ts:7414](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7414)

## Implements[​](#implements "Direct link to Implements")

*   [`IMMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new MMSThumbnailMetadata()[​](#new-mmsthumbnailmetadata "Direct link to new MMSThumbnailMetadata()")

> **new MMSThumbnailMetadata**(`p`?): [`MMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/MMSThumbnailMetadata)

Defined in: [WAProto/index.d.ts:7415](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7415)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`MMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/MMSThumbnailMetadata)

## Properties[​](#properties "Direct link to Properties")

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7419](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7419)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata).[`mediaKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata#mediakey)

* * *

### mediaKeyDomain?[​](#mediakeydomain "Direct link to mediaKeyDomain?")

> `optional` **mediaKeyDomain**: `null` | [`MediaKeyDomain`](/docs/api/namespaces/proto/namespaces/Message/enumerations/MediaKeyDomain)

Defined in: [WAProto/index.d.ts:7423](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7423)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata).[`mediaKeyDomain`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata#mediakeydomain)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7420](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7420)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata).[`mediaKeyTimestamp`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata#mediakeytimestamp)

* * *

### thumbnailDirectPath?[​](#thumbnaildirectpath "Direct link to thumbnailDirectPath?")

> `optional` **thumbnailDirectPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:7416](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7416)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IMMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata).[`thumbnailDirectPath`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata#thumbnaildirectpath)

* * *

### thumbnailEncSha256?[​](#thumbnailencsha256 "Direct link to thumbnailEncSha256?")

> `optional` **thumbnailEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7418](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7418)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IMMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata).[`thumbnailEncSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata#thumbnailencsha256)

* * *

### thumbnailHeight?[​](#thumbnailheight "Direct link to thumbnailHeight?")

> `optional` **thumbnailHeight**: `null` | `number`

Defined in: [WAProto/index.d.ts:7421](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7421)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IMMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata).[`thumbnailHeight`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata#thumbnailheight)

* * *

### thumbnailSha256?[​](#thumbnailsha256 "Direct link to thumbnailSha256?")

> `optional` **thumbnailSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7417](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7417)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IMMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata).[`thumbnailSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata#thumbnailsha256)

* * *

### thumbnailWidth?[​](#thumbnailwidth "Direct link to thumbnailWidth?")

> `optional` **thumbnailWidth**: `null` | `number`

Defined in: [WAProto/index.d.ts:7422](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7422)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IMMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata).[`thumbnailWidth`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata#thumbnailwidth)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7429](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7429)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/MMSThumbnailMetadata)

Defined in: [WAProto/index.d.ts:7424](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7424)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/MMSThumbnailMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/MMSThumbnailMetadata)

Defined in: [WAProto/index.d.ts:7426](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7426)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/MMSThumbnailMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7425](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7425)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/MMSThumbnailMetadata)

Defined in: [WAProto/index.d.ts:7427](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7427)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/MMSThumbnailMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7430](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7430)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7428](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7428)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/MMSThumbnailMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-messagehistorybundle"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryBundle](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryBundle)

Defined in: [WAProto/index.d.ts:7452](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7452)

## Implements[​](#implements "Direct link to Implements")

*   [`IMessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle)

## Constructors[​](#constructors "Direct link to Constructors")

### new MessageHistoryBundle()[​](#new-messagehistorybundle "Direct link to new MessageHistoryBundle()")

> **new MessageHistoryBundle**(`p`?): [`MessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryBundle)

Defined in: [WAProto/index.d.ts:7453](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7453)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle)

#### Returns[​](#returns "Direct link to Returns")

[`MessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryBundle)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:7460](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7460)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle#contextinfo)

* * *

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:7458](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7458)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle).[`directPath`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle#directpath)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7457](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7457)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle).[`fileEncSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle#fileencsha256)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7455](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7455)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IMessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle).[`fileSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle#filesha256)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7456](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7456)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IMessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle).[`mediaKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle#mediakey)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7459](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7459)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IMessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle).[`mediaKeyTimestamp`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle#mediakeytimestamp)

* * *

### messageHistoryMetadata?[​](#messagehistorymetadata "Direct link to messageHistoryMetadata?")

> `optional` **messageHistoryMetadata**: `null` | [`IMessageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryMetadata)

Defined in: [WAProto/index.d.ts:7461](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7461)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IMessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle).[`messageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle#messagehistorymetadata)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:7454](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7454)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IMessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle).[`mimetype`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle#mimetype)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7467](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7467)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryBundle)

Defined in: [WAProto/index.d.ts:7462](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7462)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryBundle)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryBundle)

Defined in: [WAProto/index.d.ts:7464](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7464)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryBundle)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7463](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7463)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryBundle)

Defined in: [WAProto/index.d.ts:7465](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7465)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryBundle)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7468](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7468)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7466](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7466)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MessageHistoryBundle`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryBundle)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-messagehistorymetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryMetadata)

Defined in: [WAProto/index.d.ts:7477](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7477)

## Implements[​](#implements "Direct link to Implements")

*   [`IMessageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new MessageHistoryMetadata()[​](#new-messagehistorymetadata "Direct link to new MessageHistoryMetadata()")

> **new MessageHistoryMetadata**(`p`?): [`MessageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryMetadata)

Defined in: [WAProto/index.d.ts:7478](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7478)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMessageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`MessageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryMetadata)

## Properties[​](#properties "Direct link to Properties")

### historyReceivers[​](#historyreceivers "Direct link to historyReceivers")

> **historyReceivers**: `string`\[\]

Defined in: [WAProto/index.d.ts:7479](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7479)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMessageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryMetadata).[`historyReceivers`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryMetadata#historyreceivers)

* * *

### messageCount?[​](#messagecount "Direct link to messageCount?")

> `optional` **messageCount**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7481](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7481)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMessageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryMetadata).[`messageCount`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryMetadata#messagecount)

* * *

### oldestMessageTimestamp?[​](#oldestmessagetimestamp "Direct link to oldestMessageTimestamp?")

> `optional` **oldestMessageTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7480](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7480)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMessageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryMetadata).[`oldestMessageTimestamp`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryMetadata#oldestmessagetimestamp)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7487](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7487)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MessageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryMetadata)

Defined in: [WAProto/index.d.ts:7482](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7482)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMessageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MessageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MessageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryMetadata)

Defined in: [WAProto/index.d.ts:7484](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7484)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MessageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7483](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7483)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMessageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MessageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryMetadata)

Defined in: [WAProto/index.d.ts:7485](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7485)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MessageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7488](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7488)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7486](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7486)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MessageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-messagehistorynotice"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryNotice](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryNotice)

Defined in: [WAProto/index.d.ts:7496](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7496)

## Implements[​](#implements "Direct link to Implements")

*   [`IMessageHistoryNotice`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryNotice)

## Constructors[​](#constructors "Direct link to Constructors")

### new MessageHistoryNotice()[​](#new-messagehistorynotice "Direct link to new MessageHistoryNotice()")

> **new MessageHistoryNotice**(`p`?): [`MessageHistoryNotice`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryNotice)

Defined in: [WAProto/index.d.ts:7497](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7497)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMessageHistoryNotice`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryNotice)

#### Returns[​](#returns "Direct link to Returns")

[`MessageHistoryNotice`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryNotice)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:7498](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7498)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMessageHistoryNotice`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryNotice).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryNotice#contextinfo)

* * *

### messageHistoryMetadata?[​](#messagehistorymetadata "Direct link to messageHistoryMetadata?")

> `optional` **messageHistoryMetadata**: `null` | [`IMessageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryMetadata)

Defined in: [WAProto/index.d.ts:7499](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7499)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMessageHistoryNotice`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryNotice).[`messageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryNotice#messagehistorymetadata)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7505](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7505)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MessageHistoryNotice`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryNotice)

Defined in: [WAProto/index.d.ts:7500](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7500)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMessageHistoryNotice`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryNotice)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MessageHistoryNotice`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryNotice)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MessageHistoryNotice`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryNotice)

Defined in: [WAProto/index.d.ts:7502](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7502)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MessageHistoryNotice`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryNotice)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7501](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7501)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMessageHistoryNotice`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryNotice)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MessageHistoryNotice`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryNotice)

Defined in: [WAProto/index.d.ts:7503](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7503)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MessageHistoryNotice`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryNotice)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7506](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7506)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7504](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7504)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MessageHistoryNotice`](/docs/api/namespaces/proto/namespaces/Message/classes/MessageHistoryNotice)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-newsletteradmininvitemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterAdminInviteMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterAdminInviteMessage)

Defined in: [WAProto/index.d.ts:7518](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7518)

## Implements[​](#implements "Direct link to Implements")

*   [`INewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new NewsletterAdminInviteMessage()[​](#new-newsletteradmininvitemessage "Direct link to new NewsletterAdminInviteMessage()")

> **new NewsletterAdminInviteMessage**(`p`?): [`NewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterAdminInviteMessage)

Defined in: [WAProto/index.d.ts:7519](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7519)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`INewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage)

#### Returns[​](#returns "Direct link to Returns")

[`NewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterAdminInviteMessage)

## Properties[​](#properties "Direct link to Properties")

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:7523](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7523)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`INewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage).[`caption`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage#caption)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:7525](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7525)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`INewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage#contextinfo)

* * *

### inviteExpiration?[​](#inviteexpiration "Direct link to inviteExpiration?")

> `optional` **inviteExpiration**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7524](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7524)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`INewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage).[`inviteExpiration`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage#inviteexpiration)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7522](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7522)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`INewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage).[`jpegThumbnail`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage#jpegthumbnail)

* * *

### newsletterJid?[​](#newsletterjid "Direct link to newsletterJid?")

> `optional` **newsletterJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:7520](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7520)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`INewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage).[`newsletterJid`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage#newsletterjid)

* * *

### newsletterName?[​](#newslettername "Direct link to newsletterName?")

> `optional` **newsletterName**: `null` | `string`

Defined in: [WAProto/index.d.ts:7521](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7521)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`INewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage).[`newsletterName`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage#newslettername)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7531](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7531)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`NewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterAdminInviteMessage)

Defined in: [WAProto/index.d.ts:7526](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7526)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`INewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`NewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterAdminInviteMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`NewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterAdminInviteMessage)

Defined in: [WAProto/index.d.ts:7528](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7528)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`NewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterAdminInviteMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7527](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7527)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`INewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`NewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterAdminInviteMessage)

Defined in: [WAProto/index.d.ts:7529](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7529)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`NewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterAdminInviteMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7532](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7532)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7530](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7530)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`NewsletterAdminInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterAdminInviteMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-newsletterfollowerinvitemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterFollowerInviteMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterFollowerInviteMessage)

Defined in: [WAProto/index.d.ts:7543](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7543)

## Implements[​](#implements "Direct link to Implements")

*   [`INewsletterFollowerInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterFollowerInviteMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new NewsletterFollowerInviteMessage()[​](#new-newsletterfollowerinvitemessage "Direct link to new NewsletterFollowerInviteMessage()")

> **new NewsletterFollowerInviteMessage**(`p`?): [`NewsletterFollowerInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterFollowerInviteMessage)

Defined in: [WAProto/index.d.ts:7544](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7544)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`INewsletterFollowerInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterFollowerInviteMessage)

#### Returns[​](#returns "Direct link to Returns")

[`NewsletterFollowerInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterFollowerInviteMessage)

## Properties[​](#properties "Direct link to Properties")

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:7548](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7548)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`INewsletterFollowerInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterFollowerInviteMessage).[`caption`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterFollowerInviteMessage#caption)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:7549](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7549)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`INewsletterFollowerInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterFollowerInviteMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterFollowerInviteMessage#contextinfo)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7547](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7547)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`INewsletterFollowerInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterFollowerInviteMessage).[`jpegThumbnail`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterFollowerInviteMessage#jpegthumbnail)

* * *

### newsletterJid?[​](#newsletterjid "Direct link to newsletterJid?")

> `optional` **newsletterJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:7545](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7545)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`INewsletterFollowerInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterFollowerInviteMessage).[`newsletterJid`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterFollowerInviteMessage#newsletterjid)

* * *

### newsletterName?[​](#newslettername "Direct link to newsletterName?")

> `optional` **newsletterName**: `null` | `string`

Defined in: [WAProto/index.d.ts:7546](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7546)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`INewsletterFollowerInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterFollowerInviteMessage).[`newsletterName`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterFollowerInviteMessage#newslettername)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7555](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7555)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`NewsletterFollowerInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterFollowerInviteMessage)

Defined in: [WAProto/index.d.ts:7550](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7550)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`INewsletterFollowerInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterFollowerInviteMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`NewsletterFollowerInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterFollowerInviteMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`NewsletterFollowerInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterFollowerInviteMessage)

Defined in: [WAProto/index.d.ts:7552](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7552)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`NewsletterFollowerInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterFollowerInviteMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7551](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7551)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`INewsletterFollowerInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterFollowerInviteMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`NewsletterFollowerInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterFollowerInviteMessage)

Defined in: [WAProto/index.d.ts:7553](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7553)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`NewsletterFollowerInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterFollowerInviteMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7556](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7556)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7554](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7554)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`NewsletterFollowerInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/NewsletterFollowerInviteMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-ordermessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/OrderMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/OrderMessage)

Defined in: [WAProto/index.d.ts:7577](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7577)

## Implements[​](#implements "Direct link to Implements")

*   [`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new OrderMessage()[​](#new-ordermessage "Direct link to new OrderMessage()")

> **new OrderMessage**(`p`?): [`OrderMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/OrderMessage)

Defined in: [WAProto/index.d.ts:7578](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7578)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage)

#### Returns[​](#returns "Direct link to Returns")

[`OrderMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/OrderMessage)

## Properties[​](#properties "Direct link to Properties")

### catalogType?[​](#catalogtype "Direct link to catalogType?")

> `optional` **catalogType**: `null` | `string`

Defined in: [WAProto/index.d.ts:7593](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7593)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage).[`catalogType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage#catalogtype)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:7590](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7590)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage#contextinfo)

* * *

### itemCount?[​](#itemcount "Direct link to itemCount?")

> `optional` **itemCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:7581](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7581)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage).[`itemCount`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage#itemcount)

* * *

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | `string`

Defined in: [WAProto/index.d.ts:7584](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7584)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage).[`message`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage#message)

* * *

### messageVersion?[​](#messageversion "Direct link to messageVersion?")

> `optional` **messageVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:7591](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7591)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage).[`messageVersion`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage#messageversion)

* * *

### orderId?[​](#orderid "Direct link to orderId?")

> `optional` **orderId**: `null` | `string`

Defined in: [WAProto/index.d.ts:7579](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7579)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage).[`orderId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage#orderid)

* * *

### orderRequestMessageId?[​](#orderrequestmessageid "Direct link to orderRequestMessageId?")

> `optional` **orderRequestMessageId**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:7592](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7592)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage).[`orderRequestMessageId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage#orderrequestmessageid)

* * *

### orderTitle?[​](#ordertitle "Direct link to orderTitle?")

> `optional` **orderTitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:7585](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7585)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage).[`orderTitle`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage#ordertitle)

* * *

### sellerJid?[​](#sellerjid "Direct link to sellerJid?")

> `optional` **sellerJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:7586](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7586)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage).[`sellerJid`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage#sellerjid)

* * *

### status?[​](#status "Direct link to status?")

> `optional` **status**: `null` | [`OrderStatus`](/docs/api/namespaces/proto/namespaces/Message/namespaces/OrderMessage/enumerations/OrderStatus)

Defined in: [WAProto/index.d.ts:7582](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7582)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage).[`status`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage#status)

* * *

### surface?[​](#surface "Direct link to surface?")

> `optional` **surface**: `null` | [`CATALOG`](/docs/api/namespaces/proto/namespaces/Message/namespaces/OrderMessage/enumerations/OrderSurface#catalog)

Defined in: [WAProto/index.d.ts:7583](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7583)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage).[`surface`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage#surface)

* * *

### thumbnail?[​](#thumbnail "Direct link to thumbnail?")

> `optional` **thumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7580](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7580)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage).[`thumbnail`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage#thumbnail)

* * *

### token?[​](#token "Direct link to token?")

> `optional` **token**: `null` | `string`

Defined in: [WAProto/index.d.ts:7587](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7587)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage).[`token`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage#token)

* * *

### totalAmount1000?[​](#totalamount1000 "Direct link to totalAmount1000?")

> `optional` **totalAmount1000**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7588](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7588)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage).[`totalAmount1000`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage#totalamount1000)

* * *

### totalCurrencyCode?[​](#totalcurrencycode "Direct link to totalCurrencyCode?")

> `optional` **totalCurrencyCode**: `null` | `string`

Defined in: [WAProto/index.d.ts:7589](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7589)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage).[`totalCurrencyCode`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage#totalcurrencycode)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7599](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7599)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`OrderMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/OrderMessage)

Defined in: [WAProto/index.d.ts:7594](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7594)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`OrderMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/OrderMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`OrderMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/OrderMessage)

Defined in: [WAProto/index.d.ts:7596](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7596)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`OrderMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/OrderMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7595](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7595)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IOrderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`OrderMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/OrderMessage)

Defined in: [WAProto/index.d.ts:7597](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7597)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`OrderMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/OrderMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7600](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7600)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7598](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7598)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`OrderMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/OrderMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-paymentextendedmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PaymentExtendedMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PaymentExtendedMetadata)

Defined in: [WAProto/index.d.ts:7622](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7622)

## Implements[​](#implements "Direct link to Implements")

*   [`IPaymentExtendedMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentExtendedMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new PaymentExtendedMetadata()[​](#new-paymentextendedmetadata "Direct link to new PaymentExtendedMetadata()")

> **new PaymentExtendedMetadata**(`p`?): [`PaymentExtendedMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentExtendedMetadata)

Defined in: [WAProto/index.d.ts:7623](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7623)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPaymentExtendedMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentExtendedMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`PaymentExtendedMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentExtendedMetadata)

## Properties[​](#properties "Direct link to Properties")

### messageParamsJson?[​](#messageparamsjson "Direct link to messageParamsJson?")

> `optional` **messageParamsJson**: `null` | `string`

Defined in: [WAProto/index.d.ts:7626](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7626)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPaymentExtendedMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentExtendedMetadata).[`messageParamsJson`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentExtendedMetadata#messageparamsjson)

* * *

### platform?[​](#platform "Direct link to platform?")

> `optional` **platform**: `null` | `string`

Defined in: [WAProto/index.d.ts:7625](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7625)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPaymentExtendedMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentExtendedMetadata).[`platform`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentExtendedMetadata#platform)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | `number`

Defined in: [WAProto/index.d.ts:7624](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7624)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPaymentExtendedMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentExtendedMetadata).[`type`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentExtendedMetadata#type)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7632](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7632)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PaymentExtendedMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentExtendedMetadata)

Defined in: [WAProto/index.d.ts:7627](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7627)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPaymentExtendedMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentExtendedMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PaymentExtendedMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentExtendedMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PaymentExtendedMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentExtendedMetadata)

Defined in: [WAProto/index.d.ts:7629](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7629)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PaymentExtendedMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentExtendedMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7628](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7628)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPaymentExtendedMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentExtendedMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PaymentExtendedMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentExtendedMetadata)

Defined in: [WAProto/index.d.ts:7630](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7630)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PaymentExtendedMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentExtendedMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7633](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7633)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7631](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7631)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PaymentExtendedMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentExtendedMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-paymentinvitemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PaymentInviteMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PaymentInviteMessage)

Defined in: [WAProto/index.d.ts:7641](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7641)

## Implements[​](#implements "Direct link to Implements")

*   [`IPaymentInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentInviteMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new PaymentInviteMessage()[​](#new-paymentinvitemessage "Direct link to new PaymentInviteMessage()")

> **new PaymentInviteMessage**(`p`?): [`PaymentInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentInviteMessage)

Defined in: [WAProto/index.d.ts:7642](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7642)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPaymentInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentInviteMessage)

#### Returns[​](#returns "Direct link to Returns")

[`PaymentInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentInviteMessage)

## Properties[​](#properties "Direct link to Properties")

### expiryTimestamp?[​](#expirytimestamp "Direct link to expiryTimestamp?")

> `optional` **expiryTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7644](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7644)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPaymentInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentInviteMessage).[`expiryTimestamp`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentInviteMessage#expirytimestamp)

* * *

### serviceType?[​](#servicetype "Direct link to serviceType?")

> `optional` **serviceType**: `null` | [`ServiceType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentInviteMessage/enumerations/ServiceType)

Defined in: [WAProto/index.d.ts:7643](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7643)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPaymentInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentInviteMessage).[`serviceType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentInviteMessage#servicetype)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7650](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7650)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PaymentInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentInviteMessage)

Defined in: [WAProto/index.d.ts:7645](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7645)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPaymentInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentInviteMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PaymentInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentInviteMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PaymentInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentInviteMessage)

Defined in: [WAProto/index.d.ts:7647](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7647)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PaymentInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentInviteMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7646](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7646)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPaymentInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentInviteMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PaymentInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentInviteMessage)

Defined in: [WAProto/index.d.ts:7648](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7648)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PaymentInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentInviteMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7651](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7651)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7649](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7649)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PaymentInviteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentInviteMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-paymentlinkmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PaymentLinkMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PaymentLinkMetadata)

Defined in: [WAProto/index.d.ts:7670](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7670)

## Implements[​](#implements "Direct link to Implements")

*   [`IPaymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentLinkMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new PaymentLinkMetadata()[​](#new-paymentlinkmetadata "Direct link to new PaymentLinkMetadata()")

> **new PaymentLinkMetadata**(`p`?): [`PaymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentLinkMetadata)

Defined in: [WAProto/index.d.ts:7671](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7671)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPaymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentLinkMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`PaymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentLinkMetadata)

## Properties[​](#properties "Direct link to Properties")

### button?[​](#button "Direct link to button?")

> `optional` **button**: `null` | [`IPaymentLinkButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkButton)

Defined in: [WAProto/index.d.ts:7672](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7672)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPaymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentLinkMetadata).[`button`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentLinkMetadata#button)

* * *

### header?[​](#header "Direct link to header?")

> `optional` **header**: `null` | [`IPaymentLinkHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkHeader)

Defined in: [WAProto/index.d.ts:7673](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7673)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPaymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentLinkMetadata).[`header`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentLinkMetadata#header)

* * *

### provider?[​](#provider "Direct link to provider?")

> `optional` **provider**: `null` | [`IPaymentLinkProvider`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkProvider)

Defined in: [WAProto/index.d.ts:7674](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7674)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPaymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentLinkMetadata).[`provider`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentLinkMetadata#provider)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7680](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7680)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PaymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentLinkMetadata)

Defined in: [WAProto/index.d.ts:7675](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7675)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPaymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentLinkMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PaymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentLinkMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PaymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentLinkMetadata)

Defined in: [WAProto/index.d.ts:7677](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7677)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PaymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentLinkMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7676](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7676)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPaymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentLinkMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PaymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentLinkMetadata)

Defined in: [WAProto/index.d.ts:7678](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7678)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PaymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentLinkMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7681](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7681)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7679](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7679)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PaymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PaymentLinkMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-peerdataoperationrequestmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestMessage)

Defined in: [WAProto/index.d.ts:7755](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7755)

## Implements[​](#implements "Direct link to Implements")

*   [`IPeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new PeerDataOperationRequestMessage()[​](#new-peerdataoperationrequestmessage "Direct link to new PeerDataOperationRequestMessage()")

> **new PeerDataOperationRequestMessage**(`p`?): [`PeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestMessage)

Defined in: [WAProto/index.d.ts:7756](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7756)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage)

#### Returns[​](#returns "Direct link to Returns")

[`PeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestMessage)

## Properties[​](#properties "Direct link to Properties")

### fullHistorySyncOnDemandRequest?[​](#fullhistorysyncondemandrequest "Direct link to fullHistorySyncOnDemandRequest?")

> `optional` **fullHistorySyncOnDemandRequest**: `null` | [`IFullHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IFullHistorySyncOnDemandRequest)

Defined in: [WAProto/index.d.ts:7762](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7762)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage).[`fullHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage#fullhistorysyncondemandrequest)

* * *

### galaxyFlowAction?[​](#galaxyflowaction "Direct link to galaxyFlowAction?")

> `optional` **galaxyFlowAction**: `null` | [`IGalaxyFlowAction`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IGalaxyFlowAction)

Defined in: [WAProto/index.d.ts:7765](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7765)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage).[`galaxyFlowAction`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage#galaxyflowaction)

* * *

### historySyncChunkRetryRequest?[​](#historysyncchunkretryrequest "Direct link to historySyncChunkRetryRequest?")

> `optional` **historySyncChunkRetryRequest**: `null` | [`IHistorySyncChunkRetryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncChunkRetryRequest)

Defined in: [WAProto/index.d.ts:7764](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7764)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage).[`historySyncChunkRetryRequest`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage#historysyncchunkretryrequest)

* * *

### historySyncOnDemandRequest?[​](#historysyncondemandrequest "Direct link to historySyncOnDemandRequest?")

> `optional` **historySyncOnDemandRequest**: `null` | [`IHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest)

Defined in: [WAProto/index.d.ts:7760](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7760)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IPeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage).[`historySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage#historysyncondemandrequest)

* * *

### peerDataOperationRequestType?[​](#peerdataoperationrequesttype "Direct link to peerDataOperationRequestType?")

> `optional` **peerDataOperationRequestType**: `null` | [`PeerDataOperationRequestType`](/docs/api/namespaces/proto/namespaces/Message/enumerations/PeerDataOperationRequestType)

Defined in: [WAProto/index.d.ts:7757](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7757)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IPeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage).[`peerDataOperationRequestType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage#peerdataoperationrequesttype)

* * *

### placeholderMessageResendRequest[​](#placeholdermessageresendrequest "Direct link to placeholderMessageResendRequest")

> **placeholderMessageResendRequest**: [`IPlaceholderMessageResendRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IPlaceholderMessageResendRequest)\[\]

Defined in: [WAProto/index.d.ts:7761](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7761)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IPeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage).[`placeholderMessageResendRequest`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage#placeholdermessageresendrequest)

* * *

### requestStickerReupload[​](#requeststickerreupload "Direct link to requestStickerReupload")

> **requestStickerReupload**: [`IRequestStickerReupload`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestStickerReupload)\[\]

Defined in: [WAProto/index.d.ts:7758](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7758)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IPeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage).[`requestStickerReupload`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage#requeststickerreupload)

* * *

### requestUrlPreview[​](#requesturlpreview "Direct link to requestUrlPreview")

> **requestUrlPreview**: [`IRequestUrlPreview`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestUrlPreview)\[\]

Defined in: [WAProto/index.d.ts:7759](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7759)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IPeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage).[`requestUrlPreview`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage#requesturlpreview)

* * *

### syncdCollectionFatalRecoveryRequest?[​](#syncdcollectionfatalrecoveryrequest "Direct link to syncdCollectionFatalRecoveryRequest?")

> `optional` **syncdCollectionFatalRecoveryRequest**: `null` | [`ISyncDCollectionFatalRecoveryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/ISyncDCollectionFatalRecoveryRequest)

Defined in: [WAProto/index.d.ts:7763](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7763)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IPeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage).[`syncdCollectionFatalRecoveryRequest`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage#syncdcollectionfatalrecoveryrequest)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7771](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7771)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestMessage)

Defined in: [WAProto/index.d.ts:7766](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7766)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestMessage)

Defined in: [WAProto/index.d.ts:7768](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7768)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7767](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7767)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestMessage)

Defined in: [WAProto/index.d.ts:7769](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7769)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7772](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7772)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7770](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7770)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-peerdataoperationrequestresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestResponseMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestResponseMessage)

Defined in: [WAProto/index.d.ts:7945](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7945)

## Implements[​](#implements "Direct link to Implements")

*   [`IPeerDataOperationRequestResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestResponseMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new PeerDataOperationRequestResponseMessage()[​](#new-peerdataoperationrequestresponsemessage "Direct link to new PeerDataOperationRequestResponseMessage()")

> **new PeerDataOperationRequestResponseMessage**(`p`?): [`PeerDataOperationRequestResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestResponseMessage)

Defined in: [WAProto/index.d.ts:7946](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7946)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPeerDataOperationRequestResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestResponseMessage)

#### Returns[​](#returns "Direct link to Returns")

[`PeerDataOperationRequestResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestResponseMessage)

## Properties[​](#properties "Direct link to Properties")

### peerDataOperationRequestType?[​](#peerdataoperationrequesttype "Direct link to peerDataOperationRequestType?")

> `optional` **peerDataOperationRequestType**: `null` | [`PeerDataOperationRequestType`](/docs/api/namespaces/proto/namespaces/Message/enumerations/PeerDataOperationRequestType)

Defined in: [WAProto/index.d.ts:7947](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7947)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPeerDataOperationRequestResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestResponseMessage).[`peerDataOperationRequestType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestResponseMessage#peerdataoperationrequesttype)

* * *

### peerDataOperationResult[​](#peerdataoperationresult "Direct link to peerDataOperationResult")

> **peerDataOperationResult**: [`IPeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult)\[\]

Defined in: [WAProto/index.d.ts:7949](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7949)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPeerDataOperationRequestResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestResponseMessage).[`peerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestResponseMessage#peerdataoperationresult)

* * *

### stanzaId?[​](#stanzaid "Direct link to stanzaId?")

> `optional` **stanzaId**: `null` | `string`

Defined in: [WAProto/index.d.ts:7948](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7948)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPeerDataOperationRequestResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestResponseMessage).[`stanzaId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestResponseMessage#stanzaid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7955](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7955)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PeerDataOperationRequestResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestResponseMessage)

Defined in: [WAProto/index.d.ts:7950](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7950)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPeerDataOperationRequestResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestResponseMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PeerDataOperationRequestResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestResponseMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PeerDataOperationRequestResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestResponseMessage)

Defined in: [WAProto/index.d.ts:7952](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7952)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PeerDataOperationRequestResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestResponseMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7951](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7951)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPeerDataOperationRequestResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestResponseMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PeerDataOperationRequestResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestResponseMessage)

Defined in: [WAProto/index.d.ts:7953](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7953)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PeerDataOperationRequestResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestResponseMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7956](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7956)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7954](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7954)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PeerDataOperationRequestResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PeerDataOperationRequestResponseMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pininchatmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PinInChatMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PinInChatMessage)

Defined in: [WAProto/index.d.ts:8248](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8248)

## Implements[​](#implements "Direct link to Implements")

*   [`IPinInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPinInChatMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new PinInChatMessage()[​](#new-pininchatmessage "Direct link to new PinInChatMessage()")

> **new PinInChatMessage**(`p`?): [`PinInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PinInChatMessage)

Defined in: [WAProto/index.d.ts:8249](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8249)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPinInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPinInChatMessage)

#### Returns[​](#returns "Direct link to Returns")

[`PinInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PinInChatMessage)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8250](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8250)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPinInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPinInChatMessage).[`key`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPinInChatMessage#key)

* * *

### senderTimestampMs?[​](#sendertimestampms "Direct link to senderTimestampMs?")

> `optional` **senderTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8252](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8252)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPinInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPinInChatMessage).[`senderTimestampMs`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPinInChatMessage#sendertimestampms)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`Type`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PinInChatMessage/enumerations/Type)

Defined in: [WAProto/index.d.ts:8251](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8251)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPinInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPinInChatMessage).[`type`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPinInChatMessage#type)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8258](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8258)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PinInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PinInChatMessage)

Defined in: [WAProto/index.d.ts:8253](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8253)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPinInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPinInChatMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PinInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PinInChatMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PinInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PinInChatMessage)

Defined in: [WAProto/index.d.ts:8255](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8255)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PinInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PinInChatMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8254](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8254)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPinInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPinInChatMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PinInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PinInChatMessage)

Defined in: [WAProto/index.d.ts:8256](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8256)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PinInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PinInChatMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8259](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8259)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8257](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8257)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PinInChatMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PinInChatMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-placeholdermessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PlaceholderMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PlaceholderMessage)

Defined in: [WAProto/index.d.ts:8275](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8275)

## Implements[​](#implements "Direct link to Implements")

*   [`IPlaceholderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPlaceholderMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new PlaceholderMessage()[​](#new-placeholdermessage "Direct link to new PlaceholderMessage()")

> **new PlaceholderMessage**(`p`?): [`PlaceholderMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PlaceholderMessage)

Defined in: [WAProto/index.d.ts:8276](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8276)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPlaceholderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPlaceholderMessage)

#### Returns[​](#returns "Direct link to Returns")

[`PlaceholderMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PlaceholderMessage)

## Properties[​](#properties "Direct link to Properties")

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`MASK_LINKED_DEVICES`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PlaceholderMessage/enumerations/PlaceholderType#mask_linked_devices)

Defined in: [WAProto/index.d.ts:8277](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8277)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPlaceholderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPlaceholderMessage).[`type`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPlaceholderMessage#type)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8283](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8283)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PlaceholderMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PlaceholderMessage)

Defined in: [WAProto/index.d.ts:8278](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8278)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPlaceholderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPlaceholderMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PlaceholderMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PlaceholderMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PlaceholderMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PlaceholderMessage)

Defined in: [WAProto/index.d.ts:8280](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8280)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PlaceholderMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PlaceholderMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8279](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8279)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPlaceholderMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPlaceholderMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PlaceholderMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PlaceholderMessage)

Defined in: [WAProto/index.d.ts:8281](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8281)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PlaceholderMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PlaceholderMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8284](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8284)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8282](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8282)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PlaceholderMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PlaceholderMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pollcreationmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PollCreationMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PollCreationMessage)

Defined in: [WAProto/index.d.ts:8311](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8311)

## Implements[​](#implements "Direct link to Implements")

*   [`IPollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new PollCreationMessage()[​](#new-pollcreationmessage "Direct link to new PollCreationMessage()")

> **new PollCreationMessage**(`p`?): [`PollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollCreationMessage)

Defined in: [WAProto/index.d.ts:8312](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8312)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage)

#### Returns[​](#returns "Direct link to Returns")

[`PollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollCreationMessage)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:8317](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8317)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage#contextinfo)

* * *

### correctAnswer?[​](#correctanswer "Direct link to correctAnswer?")

> `optional` **correctAnswer**: `null` | [`IOption`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/interfaces/IOption)

Defined in: [WAProto/index.d.ts:8320](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8320)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage).[`correctAnswer`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage#correctanswer)

* * *

### encKey?[​](#enckey "Direct link to encKey?")

> `optional` **encKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8313](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8313)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage).[`encKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage#enckey)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:8314](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8314)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IPollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage).[`name`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage#name)

* * *

### options[​](#options "Direct link to options")

> **options**: [`IOption`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/interfaces/IOption)\[\]

Defined in: [WAProto/index.d.ts:8315](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8315)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IPollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage).[`options`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage#options)

* * *

### pollContentType?[​](#pollcontenttype "Direct link to pollContentType?")

> `optional` **pollContentType**: `null` | [`PollContentType`](/docs/api/namespaces/proto/namespaces/Message/enumerations/PollContentType)

Defined in: [WAProto/index.d.ts:8318](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8318)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IPollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage).[`pollContentType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage#pollcontenttype)

* * *

### pollType?[​](#polltype "Direct link to pollType?")

> `optional` **pollType**: `null` | [`PollType`](/docs/api/namespaces/proto/namespaces/Message/enumerations/PollType)

Defined in: [WAProto/index.d.ts:8319](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8319)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IPollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage).[`pollType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage#polltype)

* * *

### selectableOptionsCount?[​](#selectableoptionscount "Direct link to selectableOptionsCount?")

> `optional` **selectableOptionsCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:8316](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8316)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IPollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage).[`selectableOptionsCount`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage#selectableoptionscount)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8326](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8326)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollCreationMessage)

Defined in: [WAProto/index.d.ts:8321](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8321)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollCreationMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollCreationMessage)

Defined in: [WAProto/index.d.ts:8323](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8323)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollCreationMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8322](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8322)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollCreationMessage)

Defined in: [WAProto/index.d.ts:8324](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8324)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollCreationMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8327](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8327)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8325](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8325)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PollCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollCreationMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pollencvalue"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PollEncValue](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PollEncValue)

Defined in: [WAProto/index.d.ts:8356](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8356)

## Implements[​](#implements "Direct link to Implements")

*   [`IPollEncValue`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollEncValue)

## Constructors[​](#constructors "Direct link to Constructors")

### new PollEncValue()[​](#new-pollencvalue "Direct link to new PollEncValue()")

> **new PollEncValue**(`p`?): [`PollEncValue`](/docs/api/namespaces/proto/namespaces/Message/classes/PollEncValue)

Defined in: [WAProto/index.d.ts:8357](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8357)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPollEncValue`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollEncValue)

#### Returns[​](#returns "Direct link to Returns")

[`PollEncValue`](/docs/api/namespaces/proto/namespaces/Message/classes/PollEncValue)

## Properties[​](#properties "Direct link to Properties")

### encIv?[​](#enciv "Direct link to encIv?")

> `optional` **encIv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8359](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8359)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPollEncValue`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollEncValue).[`encIv`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollEncValue#enciv)

* * *

### encPayload?[​](#encpayload "Direct link to encPayload?")

> `optional` **encPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8358](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8358)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPollEncValue`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollEncValue).[`encPayload`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollEncValue#encpayload)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8365](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8365)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PollEncValue`](/docs/api/namespaces/proto/namespaces/Message/classes/PollEncValue)

Defined in: [WAProto/index.d.ts:8360](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8360)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPollEncValue`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollEncValue)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PollEncValue`](/docs/api/namespaces/proto/namespaces/Message/classes/PollEncValue)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PollEncValue`](/docs/api/namespaces/proto/namespaces/Message/classes/PollEncValue)

Defined in: [WAProto/index.d.ts:8362](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8362)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PollEncValue`](/docs/api/namespaces/proto/namespaces/Message/classes/PollEncValue)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8361](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8361)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPollEncValue`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollEncValue)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PollEncValue`](/docs/api/namespaces/proto/namespaces/Message/classes/PollEncValue)

Defined in: [WAProto/index.d.ts:8363](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8363)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PollEncValue`](/docs/api/namespaces/proto/namespaces/Message/classes/PollEncValue)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8366](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8366)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8364](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8364)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PollEncValue`](/docs/api/namespaces/proto/namespaces/Message/classes/PollEncValue)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pollresultsnapshotmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PollResultSnapshotMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PollResultSnapshotMessage)

Defined in: [WAProto/index.d.ts:8376](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8376)

## Implements[​](#implements "Direct link to Implements")

*   [`IPollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollResultSnapshotMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new PollResultSnapshotMessage()[​](#new-pollresultsnapshotmessage "Direct link to new PollResultSnapshotMessage()")

> **new PollResultSnapshotMessage**(`p`?): [`PollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollResultSnapshotMessage)

Defined in: [WAProto/index.d.ts:8377](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8377)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollResultSnapshotMessage)

#### Returns[​](#returns "Direct link to Returns")

[`PollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollResultSnapshotMessage)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:8380](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8380)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollResultSnapshotMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollResultSnapshotMessage#contextinfo)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:8378](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8378)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollResultSnapshotMessage).[`name`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollResultSnapshotMessage#name)

* * *

### pollType?[​](#polltype "Direct link to pollType?")

> `optional` **pollType**: `null` | [`PollType`](/docs/api/namespaces/proto/namespaces/Message/enumerations/PollType)

Defined in: [WAProto/index.d.ts:8381](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8381)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollResultSnapshotMessage).[`pollType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollResultSnapshotMessage#polltype)

* * *

### pollVotes[​](#pollvotes "Direct link to pollVotes")

> **pollVotes**: [`IPollVote`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/interfaces/IPollVote)\[\]

Defined in: [WAProto/index.d.ts:8379](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8379)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IPollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollResultSnapshotMessage).[`pollVotes`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollResultSnapshotMessage#pollvotes)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8387](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8387)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollResultSnapshotMessage)

Defined in: [WAProto/index.d.ts:8382](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8382)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollResultSnapshotMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollResultSnapshotMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollResultSnapshotMessage)

Defined in: [WAProto/index.d.ts:8384](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8384)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollResultSnapshotMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8383](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8383)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollResultSnapshotMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollResultSnapshotMessage)

Defined in: [WAProto/index.d.ts:8385](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8385)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollResultSnapshotMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8388](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8388)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8386](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8386)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PollResultSnapshotMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollResultSnapshotMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pollupdatemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessage)

Defined in: [WAProto/index.d.ts:8424](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8424)

## Implements[​](#implements "Direct link to Implements")

*   [`IPollUpdateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new PollUpdateMessage()[​](#new-pollupdatemessage "Direct link to new PollUpdateMessage()")

> **new PollUpdateMessage**(`p`?): [`PollUpdateMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessage)

Defined in: [WAProto/index.d.ts:8425](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8425)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPollUpdateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessage)

#### Returns[​](#returns "Direct link to Returns")

[`PollUpdateMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessage)

## Properties[​](#properties "Direct link to Properties")

### metadata?[​](#metadata "Direct link to metadata?")

> `optional` **metadata**: `null` | [`IPollUpdateMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessageMetadata)

Defined in: [WAProto/index.d.ts:8428](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8428)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPollUpdateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessage).[`metadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessage#metadata)

* * *

### pollCreationMessageKey?[​](#pollcreationmessagekey "Direct link to pollCreationMessageKey?")

> `optional` **pollCreationMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8426](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8426)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPollUpdateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessage).[`pollCreationMessageKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessage#pollcreationmessagekey)

* * *

### senderTimestampMs?[​](#sendertimestampms "Direct link to senderTimestampMs?")

> `optional` **senderTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8429](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8429)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPollUpdateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessage).[`senderTimestampMs`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessage#sendertimestampms)

* * *

### vote?[​](#vote "Direct link to vote?")

> `optional` **vote**: `null` | [`IPollEncValue`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollEncValue)

Defined in: [WAProto/index.d.ts:8427](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8427)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IPollUpdateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessage).[`vote`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessage#vote)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8435](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8435)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PollUpdateMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessage)

Defined in: [WAProto/index.d.ts:8430](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8430)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPollUpdateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PollUpdateMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PollUpdateMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessage)

Defined in: [WAProto/index.d.ts:8432](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8432)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PollUpdateMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8431](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8431)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPollUpdateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PollUpdateMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessage)

Defined in: [WAProto/index.d.ts:8433](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8433)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PollUpdateMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8436](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8436)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8434](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8434)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PollUpdateMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pollupdatemessagemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessageMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessageMetadata)

Defined in: [WAProto/index.d.ts:8442](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8442)

## Implements[​](#implements "Direct link to Implements")

*   [`IPollUpdateMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessageMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new PollUpdateMessageMetadata()[​](#new-pollupdatemessagemetadata "Direct link to new PollUpdateMessageMetadata()")

> **new PollUpdateMessageMetadata**(`p`?): [`PollUpdateMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessageMetadata)

Defined in: [WAProto/index.d.ts:8443](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8443)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPollUpdateMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessageMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`PollUpdateMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessageMetadata)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8449](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8449)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PollUpdateMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessageMetadata)

Defined in: [WAProto/index.d.ts:8444](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8444)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties "Direct link to properties?")

[`IPollUpdateMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessageMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PollUpdateMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessageMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PollUpdateMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessageMetadata)

Defined in: [WAProto/index.d.ts:8446](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8446)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PollUpdateMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessageMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8445](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8445)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPollUpdateMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessageMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PollUpdateMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessageMetadata)

Defined in: [WAProto/index.d.ts:8447](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8447)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PollUpdateMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessageMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8450](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8450)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8448](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8448)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PollUpdateMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/PollUpdateMessageMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pollvotemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PollVoteMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/PollVoteMessage)

Defined in: [WAProto/index.d.ts:8457](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8457)

## Implements[​](#implements "Direct link to Implements")

*   [`IPollVoteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollVoteMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new PollVoteMessage()[​](#new-pollvotemessage "Direct link to new PollVoteMessage()")

> **new PollVoteMessage**(`p`?): [`PollVoteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollVoteMessage)

Defined in: [WAProto/index.d.ts:8458](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8458)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPollVoteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollVoteMessage)

#### Returns[​](#returns "Direct link to Returns")

[`PollVoteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollVoteMessage)

## Properties[​](#properties "Direct link to Properties")

### selectedOptions[​](#selectedoptions "Direct link to selectedOptions")

> **selectedOptions**: `Uint8Array`<`ArrayBufferLike`\>\[\]

Defined in: [WAProto/index.d.ts:8459](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8459)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPollVoteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollVoteMessage).[`selectedOptions`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollVoteMessage#selectedoptions)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8465](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8465)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PollVoteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollVoteMessage)

Defined in: [WAProto/index.d.ts:8460](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8460)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPollVoteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollVoteMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PollVoteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollVoteMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PollVoteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollVoteMessage)

Defined in: [WAProto/index.d.ts:8462](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8462)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PollVoteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollVoteMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8461](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8461)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPollVoteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollVoteMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PollVoteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollVoteMessage)

Defined in: [WAProto/index.d.ts:8463](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8463)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PollVoteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollVoteMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8466](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8466)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8464](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8464)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PollVoteMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/PollVoteMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-productmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ProductMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ProductMessage)

Defined in: [WAProto/index.d.ts:8478](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8478)

## Implements[​](#implements "Direct link to Implements")

*   [`IProductMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new ProductMessage()[​](#new-productmessage "Direct link to new ProductMessage()")

> **new ProductMessage**(`p`?): [`ProductMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ProductMessage)

Defined in: [WAProto/index.d.ts:8479](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8479)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IProductMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage)

#### Returns[​](#returns "Direct link to Returns")

[`ProductMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ProductMessage)

## Properties[​](#properties "Direct link to Properties")

### body?[​](#body "Direct link to body?")

> `optional` **body**: `null` | `string`

Defined in: [WAProto/index.d.ts:8483](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8483)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IProductMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage).[`body`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage#body)

* * *

### businessOwnerJid?[​](#businessownerjid "Direct link to businessOwnerJid?")

> `optional` **businessOwnerJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:8481](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8481)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IProductMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage).[`businessOwnerJid`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage#businessownerjid)

* * *

### catalog?[​](#catalog "Direct link to catalog?")

> `optional` **catalog**: `null` | [`ICatalogSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/ICatalogSnapshot)

Defined in: [WAProto/index.d.ts:8482](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8482)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IProductMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage).[`catalog`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage#catalog)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:8485](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8485)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IProductMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage#contextinfo)

* * *

### footer?[​](#footer "Direct link to footer?")

> `optional` **footer**: `null` | `string`

Defined in: [WAProto/index.d.ts:8484](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8484)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IProductMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage).[`footer`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage#footer)

* * *

### product?[​](#product "Direct link to product?")

> `optional` **product**: `null` | [`IProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot)

Defined in: [WAProto/index.d.ts:8480](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8480)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IProductMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage).[`product`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage#product)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8491](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8491)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ProductMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ProductMessage)

Defined in: [WAProto/index.d.ts:8486](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8486)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IProductMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ProductMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ProductMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ProductMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ProductMessage)

Defined in: [WAProto/index.d.ts:8488](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8488)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ProductMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ProductMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8487](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8487)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IProductMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ProductMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ProductMessage)

Defined in: [WAProto/index.d.ts:8489](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8489)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ProductMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ProductMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8492](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8492)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8490](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8490)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ProductMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ProductMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-protocolmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ProtocolMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ProtocolMessage)

Defined in: [WAProto/index.d.ts:8583](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8583)

## Implements[​](#implements "Direct link to Implements")

*   [`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new ProtocolMessage()[​](#new-protocolmessage "Direct link to new ProtocolMessage()")

> **new ProtocolMessage**(`p`?): [`ProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ProtocolMessage)

Defined in: [WAProto/index.d.ts:8584](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8584)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage)

#### Returns[​](#returns "Direct link to Returns")

[`ProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ProtocolMessage)

## Properties[​](#properties "Direct link to Properties")

### aiPsiMetadata?[​](#aipsimetadata "Direct link to aiPsiMetadata?")

> `optional` **aiPsiMetadata**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8606](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8606)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`aiPsiMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#aipsimetadata)

* * *

### aiQueryFanout?[​](#aiqueryfanout "Direct link to aiQueryFanout?")

> `optional` **aiQueryFanout**: `null` | [`IAIQueryFanout`](/docs/api/namespaces/proto/interfaces/IAIQueryFanout)

Defined in: [WAProto/index.d.ts:8607](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8607)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`aiQueryFanout`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#aiqueryfanout)

* * *

### appStateFatalExceptionNotification?[​](#appstatefatalexceptionnotification "Direct link to appStateFatalExceptionNotification?")

> `optional` **appStateFatalExceptionNotification**: `null` | [`IAppStateFatalExceptionNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateFatalExceptionNotification)

Defined in: [WAProto/index.d.ts:8593](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8593)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`appStateFatalExceptionNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#appstatefatalexceptionnotification)

* * *

### appStateSyncKeyRequest?[​](#appstatesynckeyrequest "Direct link to appStateSyncKeyRequest?")

> `optional` **appStateSyncKeyRequest**: `null` | [`IAppStateSyncKeyRequest`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyRequest)

Defined in: [WAProto/index.d.ts:8591](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8591)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`appStateSyncKeyRequest`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#appstatesynckeyrequest)

* * *

### appStateSyncKeyShare?[​](#appstatesynckeyshare "Direct link to appStateSyncKeyShare?")

> `optional` **appStateSyncKeyShare**: `null` | [`IAppStateSyncKeyShare`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyShare)

Defined in: [WAProto/index.d.ts:8590](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8590)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`appStateSyncKeyShare`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#appstatesynckeyshare)

* * *

### botFeedbackMessage?[​](#botfeedbackmessage "Direct link to botFeedbackMessage?")

> `optional` **botFeedbackMessage**: `null` | [`IBotFeedbackMessage`](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage)

Defined in: [WAProto/index.d.ts:8599](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8599)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`botFeedbackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#botfeedbackmessage)

* * *

### cloudApiThreadControlNotification?[​](#cloudapithreadcontrolnotification "Direct link to cloudApiThreadControlNotification?")

> `optional` **cloudApiThreadControlNotification**: `null` | [`ICloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification)

Defined in: [WAProto/index.d.ts:8603](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8603)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`cloudApiThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#cloudapithreadcontrolnotification)

* * *

### disappearingMode?[​](#disappearingmode "Direct link to disappearingMode?")

> `optional` **disappearingMode**: `null` | [`IDisappearingMode`](/docs/api/namespaces/proto/interfaces/IDisappearingMode)

Defined in: [WAProto/index.d.ts:8594](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8594)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`disappearingMode`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#disappearingmode)

* * *

### editedMessage?[​](#editedmessage "Direct link to editedMessage?")

> `optional` **editedMessage**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:8595](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8595)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`editedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#editedmessage)

* * *

### ephemeralExpiration?[​](#ephemeralexpiration "Direct link to ephemeralExpiration?")

> `optional` **ephemeralExpiration**: `null` | `number`

Defined in: [WAProto/index.d.ts:8587](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8587)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`ephemeralExpiration`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#ephemeralexpiration)

* * *

### ephemeralSettingTimestamp?[​](#ephemeralsettingtimestamp "Direct link to ephemeralSettingTimestamp?")

> `optional` **ephemeralSettingTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8588](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8588)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`ephemeralSettingTimestamp`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#ephemeralsettingtimestamp)

* * *

### historySyncNotification?[​](#historysyncnotification "Direct link to historySyncNotification?")

> `optional` **historySyncNotification**: `null` | [`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification)

Defined in: [WAProto/index.d.ts:8589](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8589)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`historySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#historysyncnotification)

* * *

### initialSecurityNotificationSettingSync?[​](#initialsecuritynotificationsettingsync "Direct link to initialSecurityNotificationSettingSync?")

> `optional` **initialSecurityNotificationSettingSync**: `null` | [`IInitialSecurityNotificationSettingSync`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInitialSecurityNotificationSettingSync)

Defined in: [WAProto/index.d.ts:8592](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8592)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`initialSecurityNotificationSettingSync`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#initialsecuritynotificationsettingsync)

* * *

### invokerJid?[​](#invokerjid "Direct link to invokerJid?")

> `optional` **invokerJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:8600](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8600)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`invokerJid`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#invokerjid)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8585](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8585)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`key`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#key)

* * *

### lidMigrationMappingSyncMessage?[​](#lidmigrationmappingsyncmessage "Direct link to lidMigrationMappingSyncMessage?")

> `optional` **lidMigrationMappingSyncMessage**: `null` | [`ILIDMigrationMappingSyncMessage`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncMessage)

Defined in: [WAProto/index.d.ts:8604](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8604)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`lidMigrationMappingSyncMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#lidmigrationmappingsyncmessage)

* * *

### limitSharing?[​](#limitsharing "Direct link to limitSharing?")

> `optional` **limitSharing**: `null` | [`ILimitSharing`](/docs/api/namespaces/proto/interfaces/ILimitSharing)

Defined in: [WAProto/index.d.ts:8605](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8605)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`limitSharing`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#limitsharing)

* * *

### mediaNotifyMessage?[​](#medianotifymessage "Direct link to mediaNotifyMessage?")

> `optional` **mediaNotifyMessage**: `null` | [`IMediaNotifyMessage`](/docs/api/namespaces/proto/interfaces/IMediaNotifyMessage)

Defined in: [WAProto/index.d.ts:8602](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8602)

#### Implementation of[​](#implementation-of-17 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`mediaNotifyMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#medianotifymessage)

* * *

### memberLabel?[​](#memberlabel "Direct link to memberLabel?")

> `optional` **memberLabel**: `null` | [`IMemberLabel`](/docs/api/namespaces/proto/interfaces/IMemberLabel)

Defined in: [WAProto/index.d.ts:8608](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8608)

#### Implementation of[​](#implementation-of-18 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`memberLabel`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#memberlabel)

* * *

### peerDataOperationRequestMessage?[​](#peerdataoperationrequestmessage "Direct link to peerDataOperationRequestMessage?")

> `optional` **peerDataOperationRequestMessage**: `null` | [`IPeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage)

Defined in: [WAProto/index.d.ts:8597](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8597)

#### Implementation of[​](#implementation-of-19 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`peerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#peerdataoperationrequestmessage)

* * *

### peerDataOperationRequestResponseMessage?[​](#peerdataoperationrequestresponsemessage "Direct link to peerDataOperationRequestResponseMessage?")

> `optional` **peerDataOperationRequestResponseMessage**: `null` | [`IPeerDataOperationRequestResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestResponseMessage)

Defined in: [WAProto/index.d.ts:8598](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8598)

#### Implementation of[​](#implementation-of-20 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`peerDataOperationRequestResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#peerdataoperationrequestresponsemessage)

* * *

### requestWelcomeMessageMetadata?[​](#requestwelcomemessagemetadata "Direct link to requestWelcomeMessageMetadata?")

> `optional` **requestWelcomeMessageMetadata**: `null` | [`IRequestWelcomeMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestWelcomeMessageMetadata)

Defined in: [WAProto/index.d.ts:8601](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8601)

#### Implementation of[​](#implementation-of-21 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`requestWelcomeMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#requestwelcomemessagemetadata)

* * *

### timestampMs?[​](#timestampms "Direct link to timestampMs?")

> `optional` **timestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8596](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8596)

#### Implementation of[​](#implementation-of-22 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`timestampMs`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#timestampms)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`Type`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProtocolMessage/enumerations/Type)

Defined in: [WAProto/index.d.ts:8586](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8586)

#### Implementation of[​](#implementation-of-23 "Direct link to Implementation of")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage).[`type`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage#type)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8614](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8614)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ProtocolMessage)

Defined in: [WAProto/index.d.ts:8609](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8609)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ProtocolMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ProtocolMessage)

Defined in: [WAProto/index.d.ts:8611](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8611)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ProtocolMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8610](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8610)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ProtocolMessage)

Defined in: [WAProto/index.d.ts:8612](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8612)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ProtocolMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8615](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8615)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8613](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8613)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ProtocolMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ProtocolMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-questionresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/QuestionResponseMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/QuestionResponseMessage)

Defined in: [WAProto/index.d.ts:8655](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8655)

## Implements[​](#implements "Direct link to Implements")

*   [`IQuestionResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IQuestionResponseMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new QuestionResponseMessage()[​](#new-questionresponsemessage "Direct link to new QuestionResponseMessage()")

> **new QuestionResponseMessage**(`p`?): [`QuestionResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/QuestionResponseMessage)

Defined in: [WAProto/index.d.ts:8656](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8656)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IQuestionResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IQuestionResponseMessage)

#### Returns[​](#returns "Direct link to Returns")

[`QuestionResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/QuestionResponseMessage)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8657](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8657)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IQuestionResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IQuestionResponseMessage).[`key`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IQuestionResponseMessage#key)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:8658](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8658)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IQuestionResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IQuestionResponseMessage).[`text`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IQuestionResponseMessage#text)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8664](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8664)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`QuestionResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/QuestionResponseMessage)

Defined in: [WAProto/index.d.ts:8659](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8659)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IQuestionResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IQuestionResponseMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`QuestionResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/QuestionResponseMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`QuestionResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/QuestionResponseMessage)

Defined in: [WAProto/index.d.ts:8661](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8661)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`QuestionResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/QuestionResponseMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8660](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8660)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IQuestionResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IQuestionResponseMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`QuestionResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/QuestionResponseMessage)

Defined in: [WAProto/index.d.ts:8662](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8662)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`QuestionResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/QuestionResponseMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8665](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8665)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8663](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8663)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`QuestionResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/QuestionResponseMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-reactionmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ReactionMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ReactionMessage)

Defined in: [WAProto/index.d.ts:8675](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8675)

## Implements[​](#implements "Direct link to Implements")

*   [`IReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IReactionMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new ReactionMessage()[​](#new-reactionmessage "Direct link to new ReactionMessage()")

> **new ReactionMessage**(`p`?): [`ReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ReactionMessage)

Defined in: [WAProto/index.d.ts:8676](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8676)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IReactionMessage)

#### Returns[​](#returns "Direct link to Returns")

[`ReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ReactionMessage)

## Properties[​](#properties "Direct link to Properties")

### groupingKey?[​](#groupingkey "Direct link to groupingKey?")

> `optional` **groupingKey**: `null` | `string`

Defined in: [WAProto/index.d.ts:8679](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8679)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IReactionMessage).[`groupingKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IReactionMessage#groupingkey)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8677](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8677)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IReactionMessage).[`key`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IReactionMessage#key)

* * *

### senderTimestampMs?[​](#sendertimestampms "Direct link to senderTimestampMs?")

> `optional` **senderTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8680](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8680)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IReactionMessage).[`senderTimestampMs`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IReactionMessage#sendertimestampms)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:8678](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8678)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IReactionMessage).[`text`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IReactionMessage#text)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8686](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8686)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ReactionMessage)

Defined in: [WAProto/index.d.ts:8681](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8681)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IReactionMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ReactionMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ReactionMessage)

Defined in: [WAProto/index.d.ts:8683](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8683)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ReactionMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8682](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8682)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IReactionMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ReactionMessage)

Defined in: [WAProto/index.d.ts:8684](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8684)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ReactionMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8687](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8687)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8685](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8685)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ReactionMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-requestpaymentmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/RequestPaymentMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/RequestPaymentMessage)

Defined in: [WAProto/index.d.ts:8700](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8700)

## Implements[​](#implements "Direct link to Implements")

*   [`IRequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new RequestPaymentMessage()[​](#new-requestpaymentmessage "Direct link to new RequestPaymentMessage()")

> **new RequestPaymentMessage**(`p`?): [`RequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestPaymentMessage)

Defined in: [WAProto/index.d.ts:8701](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8701)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IRequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage)

#### Returns[​](#returns "Direct link to Returns")

[`RequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestPaymentMessage)

## Properties[​](#properties "Direct link to Properties")

### amount?[​](#amount "Direct link to amount?")

> `optional` **amount**: `null` | [`IMoney`](/docs/api/namespaces/proto/interfaces/IMoney)

Defined in: [WAProto/index.d.ts:8707](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8707)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IRequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage).[`amount`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage#amount)

* * *

### amount1000?[​](#amount1000 "Direct link to amount1000?")

> `optional` **amount1000**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8704](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8704)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IRequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage).[`amount1000`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage#amount1000)

* * *

### background?[​](#background "Direct link to background?")

> `optional` **background**: `null` | [`IPaymentBackground`](/docs/api/namespaces/proto/interfaces/IPaymentBackground)

Defined in: [WAProto/index.d.ts:8708](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8708)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IRequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage).[`background`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage#background)

* * *

### currencyCodeIso4217?[​](#currencycodeiso4217 "Direct link to currencyCodeIso4217?")

> `optional` **currencyCodeIso4217**: `null` | `string`

Defined in: [WAProto/index.d.ts:8703](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8703)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IRequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage).[`currencyCodeIso4217`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage#currencycodeiso4217)

* * *

### expiryTimestamp?[​](#expirytimestamp "Direct link to expiryTimestamp?")

> `optional` **expiryTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8706](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8706)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IRequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage).[`expiryTimestamp`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage#expirytimestamp)

* * *

### noteMessage?[​](#notemessage "Direct link to noteMessage?")

> `optional` **noteMessage**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:8702](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8702)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IRequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage).[`noteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage#notemessage)

* * *

### requestFrom?[​](#requestfrom "Direct link to requestFrom?")

> `optional` **requestFrom**: `null` | `string`

Defined in: [WAProto/index.d.ts:8705](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8705)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IRequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage).[`requestFrom`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage#requestfrom)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8714](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8714)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`RequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestPaymentMessage)

Defined in: [WAProto/index.d.ts:8709](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8709)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IRequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`RequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestPaymentMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`RequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestPaymentMessage)

Defined in: [WAProto/index.d.ts:8711](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8711)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`RequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestPaymentMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8710](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8710)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IRequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`RequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestPaymentMessage)

Defined in: [WAProto/index.d.ts:8712](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8712)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`RequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestPaymentMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8715](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8715)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8713](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8713)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`RequestPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestPaymentMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-requestphonenumbermessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/RequestPhoneNumberMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/RequestPhoneNumberMessage)

Defined in: [WAProto/index.d.ts:8722](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8722)

## Implements[​](#implements "Direct link to Implements")

*   [`IRequestPhoneNumberMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPhoneNumberMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new RequestPhoneNumberMessage()[​](#new-requestphonenumbermessage "Direct link to new RequestPhoneNumberMessage()")

> **new RequestPhoneNumberMessage**(`p`?): [`RequestPhoneNumberMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestPhoneNumberMessage)

Defined in: [WAProto/index.d.ts:8723](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8723)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IRequestPhoneNumberMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPhoneNumberMessage)

#### Returns[​](#returns "Direct link to Returns")

[`RequestPhoneNumberMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestPhoneNumberMessage)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:8724](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8724)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IRequestPhoneNumberMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPhoneNumberMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPhoneNumberMessage#contextinfo)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8730](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8730)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`RequestPhoneNumberMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestPhoneNumberMessage)

Defined in: [WAProto/index.d.ts:8725](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8725)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IRequestPhoneNumberMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPhoneNumberMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`RequestPhoneNumberMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestPhoneNumberMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`RequestPhoneNumberMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestPhoneNumberMessage)

Defined in: [WAProto/index.d.ts:8727](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8727)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`RequestPhoneNumberMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestPhoneNumberMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8726](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8726)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IRequestPhoneNumberMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPhoneNumberMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`RequestPhoneNumberMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestPhoneNumberMessage)

Defined in: [WAProto/index.d.ts:8728](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8728)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`RequestPhoneNumberMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestPhoneNumberMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8731](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8731)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8729](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8729)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`RequestPhoneNumberMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestPhoneNumberMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-requestwelcomemessagemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/RequestWelcomeMessageMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/RequestWelcomeMessageMetadata)

Defined in: [WAProto/index.d.ts:8738](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8738)

## Implements[​](#implements "Direct link to Implements")

*   [`IRequestWelcomeMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestWelcomeMessageMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new RequestWelcomeMessageMetadata()[​](#new-requestwelcomemessagemetadata "Direct link to new RequestWelcomeMessageMetadata()")

> **new RequestWelcomeMessageMetadata**(`p`?): [`RequestWelcomeMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestWelcomeMessageMetadata)

Defined in: [WAProto/index.d.ts:8739](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8739)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IRequestWelcomeMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestWelcomeMessageMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`RequestWelcomeMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestWelcomeMessageMetadata)

## Properties[​](#properties "Direct link to Properties")

### localChatState?[​](#localchatstate "Direct link to localChatState?")

> `optional` **localChatState**: `null` | [`LocalChatState`](/docs/api/namespaces/proto/namespaces/Message/namespaces/RequestWelcomeMessageMetadata/enumerations/LocalChatState)

Defined in: [WAProto/index.d.ts:8740](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8740)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IRequestWelcomeMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestWelcomeMessageMetadata).[`localChatState`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestWelcomeMessageMetadata#localchatstate)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8746](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8746)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`RequestWelcomeMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestWelcomeMessageMetadata)

Defined in: [WAProto/index.d.ts:8741](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8741)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IRequestWelcomeMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestWelcomeMessageMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`RequestWelcomeMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestWelcomeMessageMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`RequestWelcomeMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestWelcomeMessageMetadata)

Defined in: [WAProto/index.d.ts:8743](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8743)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`RequestWelcomeMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestWelcomeMessageMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8742](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8742)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IRequestWelcomeMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestWelcomeMessageMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`RequestWelcomeMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestWelcomeMessageMetadata)

Defined in: [WAProto/index.d.ts:8744](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8744)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`RequestWelcomeMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestWelcomeMessageMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8747](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8747)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8745](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8745)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`RequestWelcomeMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/RequestWelcomeMessageMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-scheduledcallcreationmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallCreationMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallCreationMessage)

Defined in: [WAProto/index.d.ts:8764](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8764)

## Implements[​](#implements "Direct link to Implements")

*   [`IScheduledCallCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallCreationMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new ScheduledCallCreationMessage()[​](#new-scheduledcallcreationmessage "Direct link to new ScheduledCallCreationMessage()")

> **new ScheduledCallCreationMessage**(`p`?): [`ScheduledCallCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallCreationMessage)

Defined in: [WAProto/index.d.ts:8765](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8765)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IScheduledCallCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallCreationMessage)

#### Returns[​](#returns "Direct link to Returns")

[`ScheduledCallCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallCreationMessage)

## Properties[​](#properties "Direct link to Properties")

### callType?[​](#calltype "Direct link to callType?")

> `optional` **callType**: `null` | [`CallType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ScheduledCallCreationMessage/enumerations/CallType)

Defined in: [WAProto/index.d.ts:8767](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8767)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IScheduledCallCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallCreationMessage).[`callType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallCreationMessage#calltype)

* * *

### scheduledTimestampMs?[​](#scheduledtimestampms "Direct link to scheduledTimestampMs?")

> `optional` **scheduledTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8766](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8766)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IScheduledCallCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallCreationMessage).[`scheduledTimestampMs`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallCreationMessage#scheduledtimestampms)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:8768](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8768)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IScheduledCallCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallCreationMessage).[`title`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallCreationMessage#title)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8774](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8774)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ScheduledCallCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallCreationMessage)

Defined in: [WAProto/index.d.ts:8769](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8769)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IScheduledCallCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallCreationMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ScheduledCallCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallCreationMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ScheduledCallCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallCreationMessage)

Defined in: [WAProto/index.d.ts:8771](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8771)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ScheduledCallCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallCreationMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8770](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8770)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IScheduledCallCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallCreationMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ScheduledCallCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallCreationMessage)

Defined in: [WAProto/index.d.ts:8772](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8772)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ScheduledCallCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallCreationMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8775](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8775)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8773](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8773)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ScheduledCallCreationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallCreationMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-scheduledcalleditmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallEditMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallEditMessage)

Defined in: [WAProto/index.d.ts:8792](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8792)

## Implements[​](#implements "Direct link to Implements")

*   [`IScheduledCallEditMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallEditMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new ScheduledCallEditMessage()[​](#new-scheduledcalleditmessage "Direct link to new ScheduledCallEditMessage()")

> **new ScheduledCallEditMessage**(`p`?): [`ScheduledCallEditMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallEditMessage)

Defined in: [WAProto/index.d.ts:8793](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8793)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IScheduledCallEditMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallEditMessage)

#### Returns[​](#returns "Direct link to Returns")

[`ScheduledCallEditMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallEditMessage)

## Properties[​](#properties "Direct link to Properties")

### editType?[​](#edittype "Direct link to editType?")

> `optional` **editType**: `null` | [`EditType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ScheduledCallEditMessage/enumerations/EditType)

Defined in: [WAProto/index.d.ts:8795](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8795)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IScheduledCallEditMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallEditMessage).[`editType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallEditMessage#edittype)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8794](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8794)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IScheduledCallEditMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallEditMessage).[`key`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallEditMessage#key)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8801](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8801)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ScheduledCallEditMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallEditMessage)

Defined in: [WAProto/index.d.ts:8796](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8796)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IScheduledCallEditMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallEditMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ScheduledCallEditMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallEditMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ScheduledCallEditMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallEditMessage)

Defined in: [WAProto/index.d.ts:8798](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8798)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ScheduledCallEditMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallEditMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8797](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8797)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IScheduledCallEditMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallEditMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ScheduledCallEditMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallEditMessage)

Defined in: [WAProto/index.d.ts:8799](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8799)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ScheduledCallEditMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallEditMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8802](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8802)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8800](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8800)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ScheduledCallEditMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/ScheduledCallEditMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-secretencryptedmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/SecretEncryptedMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/SecretEncryptedMessage)

Defined in: [WAProto/index.d.ts:8820](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8820)

## Implements[​](#implements "Direct link to Implements")

*   [`ISecretEncryptedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISecretEncryptedMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new SecretEncryptedMessage()[​](#new-secretencryptedmessage "Direct link to new SecretEncryptedMessage()")

> **new SecretEncryptedMessage**(`p`?): [`SecretEncryptedMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SecretEncryptedMessage)

Defined in: [WAProto/index.d.ts:8821](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8821)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISecretEncryptedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISecretEncryptedMessage)

#### Returns[​](#returns "Direct link to Returns")

[`SecretEncryptedMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SecretEncryptedMessage)

## Properties[​](#properties "Direct link to Properties")

### encIv?[​](#enciv "Direct link to encIv?")

> `optional` **encIv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8824](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8824)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISecretEncryptedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISecretEncryptedMessage).[`encIv`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISecretEncryptedMessage#enciv)

* * *

### encPayload?[​](#encpayload "Direct link to encPayload?")

> `optional` **encPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8823](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8823)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISecretEncryptedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISecretEncryptedMessage).[`encPayload`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISecretEncryptedMessage#encpayload)

* * *

### secretEncType?[​](#secretenctype "Direct link to secretEncType?")

> `optional` **secretEncType**: `null` | [`SecretEncType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/SecretEncryptedMessage/enumerations/SecretEncType)

Defined in: [WAProto/index.d.ts:8825](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8825)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ISecretEncryptedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISecretEncryptedMessage).[`secretEncType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISecretEncryptedMessage#secretenctype)

* * *

### targetMessageKey?[​](#targetmessagekey "Direct link to targetMessageKey?")

> `optional` **targetMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8822](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8822)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ISecretEncryptedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISecretEncryptedMessage).[`targetMessageKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISecretEncryptedMessage#targetmessagekey)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8831](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8831)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SecretEncryptedMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SecretEncryptedMessage)

Defined in: [WAProto/index.d.ts:8826](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8826)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISecretEncryptedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISecretEncryptedMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SecretEncryptedMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SecretEncryptedMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SecretEncryptedMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SecretEncryptedMessage)

Defined in: [WAProto/index.d.ts:8828](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8828)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SecretEncryptedMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SecretEncryptedMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8827](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8827)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISecretEncryptedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISecretEncryptedMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SecretEncryptedMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SecretEncryptedMessage)

Defined in: [WAProto/index.d.ts:8829](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8829)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SecretEncryptedMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SecretEncryptedMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8832](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8832)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8830](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8830)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SecretEncryptedMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SecretEncryptedMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-sendpaymentmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/SendPaymentMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/SendPaymentMessage)

Defined in: [WAProto/index.d.ts:8851](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8851)

## Implements[​](#implements "Direct link to Implements")

*   [`ISendPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISendPaymentMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new SendPaymentMessage()[​](#new-sendpaymentmessage "Direct link to new SendPaymentMessage()")

> **new SendPaymentMessage**(`p`?): [`SendPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SendPaymentMessage)

Defined in: [WAProto/index.d.ts:8852](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8852)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISendPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISendPaymentMessage)

#### Returns[​](#returns "Direct link to Returns")

[`SendPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SendPaymentMessage)

## Properties[​](#properties "Direct link to Properties")

### background?[​](#background "Direct link to background?")

> `optional` **background**: `null` | [`IPaymentBackground`](/docs/api/namespaces/proto/interfaces/IPaymentBackground)

Defined in: [WAProto/index.d.ts:8855](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8855)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISendPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISendPaymentMessage).[`background`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISendPaymentMessage#background)

* * *

### noteMessage?[​](#notemessage "Direct link to noteMessage?")

> `optional` **noteMessage**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:8853](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8853)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISendPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISendPaymentMessage).[`noteMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISendPaymentMessage#notemessage)

* * *

### requestMessageKey?[​](#requestmessagekey "Direct link to requestMessageKey?")

> `optional` **requestMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8854](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8854)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ISendPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISendPaymentMessage).[`requestMessageKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISendPaymentMessage#requestmessagekey)

* * *

### transactionData?[​](#transactiondata "Direct link to transactionData?")

> `optional` **transactionData**: `null` | `string`

Defined in: [WAProto/index.d.ts:8856](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8856)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ISendPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISendPaymentMessage).[`transactionData`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISendPaymentMessage#transactiondata)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8862](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8862)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SendPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SendPaymentMessage)

Defined in: [WAProto/index.d.ts:8857](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8857)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISendPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISendPaymentMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SendPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SendPaymentMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SendPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SendPaymentMessage)

Defined in: [WAProto/index.d.ts:8859](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8859)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SendPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SendPaymentMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8858](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8858)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISendPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISendPaymentMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SendPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SendPaymentMessage)

Defined in: [WAProto/index.d.ts:8860](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8860)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SendPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SendPaymentMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8863](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8863)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8861](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8861)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SendPaymentMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SendPaymentMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-senderkeydistributionmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/SenderKeyDistributionMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/SenderKeyDistributionMessage)

Defined in: [WAProto/index.d.ts:8871](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8871)

## Implements[​](#implements "Direct link to Implements")

*   [`ISenderKeyDistributionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISenderKeyDistributionMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new SenderKeyDistributionMessage()[​](#new-senderkeydistributionmessage "Direct link to new SenderKeyDistributionMessage()")

> **new SenderKeyDistributionMessage**(`p`?): [`SenderKeyDistributionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SenderKeyDistributionMessage)

Defined in: [WAProto/index.d.ts:8872](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8872)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISenderKeyDistributionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISenderKeyDistributionMessage)

#### Returns[​](#returns "Direct link to Returns")

[`SenderKeyDistributionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SenderKeyDistributionMessage)

## Properties[​](#properties "Direct link to Properties")

### axolotlSenderKeyDistributionMessage?[​](#axolotlsenderkeydistributionmessage "Direct link to axolotlSenderKeyDistributionMessage?")

> `optional` **axolotlSenderKeyDistributionMessage**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8874](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8874)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISenderKeyDistributionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISenderKeyDistributionMessage).[`axolotlSenderKeyDistributionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISenderKeyDistributionMessage#axolotlsenderkeydistributionmessage)

* * *

### groupId?[​](#groupid "Direct link to groupId?")

> `optional` **groupId**: `null` | `string`

Defined in: [WAProto/index.d.ts:8873](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8873)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISenderKeyDistributionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISenderKeyDistributionMessage).[`groupId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISenderKeyDistributionMessage#groupid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8880](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8880)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SenderKeyDistributionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SenderKeyDistributionMessage)

Defined in: [WAProto/index.d.ts:8875](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8875)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISenderKeyDistributionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISenderKeyDistributionMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SenderKeyDistributionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SenderKeyDistributionMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SenderKeyDistributionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SenderKeyDistributionMessage)

Defined in: [WAProto/index.d.ts:8877](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8877)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SenderKeyDistributionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SenderKeyDistributionMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8876](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8876)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISenderKeyDistributionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ISenderKeyDistributionMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SenderKeyDistributionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SenderKeyDistributionMessage)

Defined in: [WAProto/index.d.ts:8878](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8878)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SenderKeyDistributionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SenderKeyDistributionMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8881](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8881)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8879](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8879)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SenderKeyDistributionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/SenderKeyDistributionMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-statusnotificationmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/StatusNotificationMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/StatusNotificationMessage)

Defined in: [WAProto/index.d.ts:8890](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8890)

## Implements[​](#implements "Direct link to Implements")

*   [`IStatusNotificationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusNotificationMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new StatusNotificationMessage()[​](#new-statusnotificationmessage "Direct link to new StatusNotificationMessage()")

> **new StatusNotificationMessage**(`p`?): [`StatusNotificationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusNotificationMessage)

Defined in: [WAProto/index.d.ts:8891](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8891)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IStatusNotificationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusNotificationMessage)

#### Returns[​](#returns "Direct link to Returns")

[`StatusNotificationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusNotificationMessage)

## Properties[​](#properties "Direct link to Properties")

### originalMessageKey?[​](#originalmessagekey "Direct link to originalMessageKey?")

> `optional` **originalMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8893](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8893)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IStatusNotificationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusNotificationMessage).[`originalMessageKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusNotificationMessage#originalmessagekey)

* * *

### responseMessageKey?[​](#responsemessagekey "Direct link to responseMessageKey?")

> `optional` **responseMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8892](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8892)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IStatusNotificationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusNotificationMessage).[`responseMessageKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusNotificationMessage#responsemessagekey)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`StatusNotificationType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusNotificationMessage/enumerations/StatusNotificationType)

Defined in: [WAProto/index.d.ts:8894](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8894)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IStatusNotificationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusNotificationMessage).[`type`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusNotificationMessage#type)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8900](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8900)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`StatusNotificationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusNotificationMessage)

Defined in: [WAProto/index.d.ts:8895](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8895)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IStatusNotificationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusNotificationMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`StatusNotificationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusNotificationMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`StatusNotificationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusNotificationMessage)

Defined in: [WAProto/index.d.ts:8897](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8897)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`StatusNotificationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusNotificationMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8896](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8896)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IStatusNotificationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusNotificationMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`StatusNotificationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusNotificationMessage)

Defined in: [WAProto/index.d.ts:8898](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8898)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`StatusNotificationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusNotificationMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8901](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8901)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8899](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8899)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`StatusNotificationMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusNotificationMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-statusquestionanswermessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuestionAnswerMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuestionAnswerMessage)

Defined in: [WAProto/index.d.ts:8919](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8919)

## Implements[​](#implements "Direct link to Implements")

*   [`IStatusQuestionAnswerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuestionAnswerMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new StatusQuestionAnswerMessage()[​](#new-statusquestionanswermessage "Direct link to new StatusQuestionAnswerMessage()")

> **new StatusQuestionAnswerMessage**(`p`?): [`StatusQuestionAnswerMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuestionAnswerMessage)

Defined in: [WAProto/index.d.ts:8920](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8920)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IStatusQuestionAnswerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuestionAnswerMessage)

#### Returns[​](#returns "Direct link to Returns")

[`StatusQuestionAnswerMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuestionAnswerMessage)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8921](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8921)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IStatusQuestionAnswerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuestionAnswerMessage).[`key`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuestionAnswerMessage#key)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:8922](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8922)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IStatusQuestionAnswerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuestionAnswerMessage).[`text`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuestionAnswerMessage#text)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8928](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8928)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`StatusQuestionAnswerMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuestionAnswerMessage)

Defined in: [WAProto/index.d.ts:8923](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8923)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IStatusQuestionAnswerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuestionAnswerMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`StatusQuestionAnswerMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuestionAnswerMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`StatusQuestionAnswerMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuestionAnswerMessage)

Defined in: [WAProto/index.d.ts:8925](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8925)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`StatusQuestionAnswerMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuestionAnswerMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8924](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8924)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IStatusQuestionAnswerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuestionAnswerMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`StatusQuestionAnswerMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuestionAnswerMessage)

Defined in: [WAProto/index.d.ts:8926](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8926)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`StatusQuestionAnswerMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuestionAnswerMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8929](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8929)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8927](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8927)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`StatusQuestionAnswerMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuestionAnswerMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-statusquotedmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuotedMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuotedMessage)

Defined in: [WAProto/index.d.ts:8939](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8939)

## Implements[​](#implements "Direct link to Implements")

*   [`IStatusQuotedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuotedMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new StatusQuotedMessage()[​](#new-statusquotedmessage "Direct link to new StatusQuotedMessage()")

> **new StatusQuotedMessage**(`p`?): [`StatusQuotedMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuotedMessage)

Defined in: [WAProto/index.d.ts:8940](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8940)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IStatusQuotedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuotedMessage)

#### Returns[​](#returns "Direct link to Returns")

[`StatusQuotedMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuotedMessage)

## Properties[​](#properties "Direct link to Properties")

### originalStatusId?[​](#originalstatusid "Direct link to originalStatusId?")

> `optional` **originalStatusId**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8944](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8944)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IStatusQuotedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuotedMessage).[`originalStatusId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuotedMessage#originalstatusid)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:8942](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8942)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IStatusQuotedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuotedMessage).[`text`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuotedMessage#text)

* * *

### thumbnail?[​](#thumbnail "Direct link to thumbnail?")

> `optional` **thumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8943](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8943)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IStatusQuotedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuotedMessage).[`thumbnail`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuotedMessage#thumbnail)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`QUESTION_ANSWER`](/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusQuotedMessage/enumerations/StatusQuotedMessageType#question_answer)

Defined in: [WAProto/index.d.ts:8941](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8941)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IStatusQuotedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuotedMessage).[`type`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuotedMessage#type)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8950](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8950)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`StatusQuotedMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuotedMessage)

Defined in: [WAProto/index.d.ts:8945](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8945)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IStatusQuotedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuotedMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`StatusQuotedMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuotedMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`StatusQuotedMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuotedMessage)

Defined in: [WAProto/index.d.ts:8947](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8947)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`StatusQuotedMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuotedMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8946](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8946)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IStatusQuotedMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuotedMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`StatusQuotedMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuotedMessage)

Defined in: [WAProto/index.d.ts:8948](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8948)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`StatusQuotedMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuotedMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8951](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8951)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8949](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8949)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`StatusQuotedMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusQuotedMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-statusstickerinteractionmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/StatusStickerInteractionMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/StatusStickerInteractionMessage)

Defined in: [WAProto/index.d.ts:8967](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8967)

## Implements[​](#implements "Direct link to Implements")

*   [`IStatusStickerInteractionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusStickerInteractionMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new StatusStickerInteractionMessage()[​](#new-statusstickerinteractionmessage "Direct link to new StatusStickerInteractionMessage()")

> **new StatusStickerInteractionMessage**(`p`?): [`StatusStickerInteractionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusStickerInteractionMessage)

Defined in: [WAProto/index.d.ts:8968](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8968)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IStatusStickerInteractionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusStickerInteractionMessage)

#### Returns[​](#returns "Direct link to Returns")

[`StatusStickerInteractionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusStickerInteractionMessage)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8969](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8969)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IStatusStickerInteractionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusStickerInteractionMessage).[`key`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusStickerInteractionMessage#key)

* * *

### stickerKey?[​](#stickerkey "Direct link to stickerKey?")

> `optional` **stickerKey**: `null` | `string`

Defined in: [WAProto/index.d.ts:8970](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8970)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IStatusStickerInteractionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusStickerInteractionMessage).[`stickerKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusStickerInteractionMessage#stickerkey)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`StatusStickerType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusStickerInteractionMessage/enumerations/StatusStickerType)

Defined in: [WAProto/index.d.ts:8971](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8971)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IStatusStickerInteractionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusStickerInteractionMessage).[`type`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusStickerInteractionMessage#type)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8977](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8977)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`StatusStickerInteractionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusStickerInteractionMessage)

Defined in: [WAProto/index.d.ts:8972](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8972)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IStatusStickerInteractionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusStickerInteractionMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`StatusStickerInteractionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusStickerInteractionMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`StatusStickerInteractionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusStickerInteractionMessage)

Defined in: [WAProto/index.d.ts:8974](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8974)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`StatusStickerInteractionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusStickerInteractionMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8973](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8973)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IStatusStickerInteractionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusStickerInteractionMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`StatusStickerInteractionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusStickerInteractionMessage)

Defined in: [WAProto/index.d.ts:8975](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8975)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`StatusStickerInteractionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusStickerInteractionMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8978](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8978)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8976](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8976)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`StatusStickerInteractionMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StatusStickerInteractionMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-stickermessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/StickerMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/StickerMessage)

Defined in: [WAProto/index.d.ts:9013](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9013)

## Implements[​](#implements "Direct link to Implements")

*   [`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new StickerMessage()[​](#new-stickermessage "Direct link to new StickerMessage()")

> **new StickerMessage**(`p`?): [`StickerMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerMessage)

Defined in: [WAProto/index.d.ts:9014](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9014)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage)

#### Returns[​](#returns "Direct link to Returns")

[`StickerMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerMessage)

## Properties[​](#properties "Direct link to Properties")

### accessibilityLabel?[​](#accessibilitylabel "Direct link to accessibilityLabel?")

> `optional` **accessibilityLabel**: `null` | `string`

Defined in: [WAProto/index.d.ts:9034](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9034)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`accessibilityLabel`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#accessibilitylabel)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:9029](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9029)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#contextinfo)

* * *

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:9022](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9022)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`directPath`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#directpath)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9017](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9017)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`fileEncSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#fileencsha256)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9023](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9023)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`fileLength`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#filelength)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9016](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9016)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`fileSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#filesha256)

* * *

### firstFrameLength?[​](#firstframelength "Direct link to firstFrameLength?")

> `optional` **firstFrameLength**: `null` | `number`

Defined in: [WAProto/index.d.ts:9025](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9025)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`firstFrameLength`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#firstframelength)

* * *

### firstFrameSidecar?[​](#firstframesidecar "Direct link to firstFrameSidecar?")

> `optional` **firstFrameSidecar**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9026](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9026)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`firstFrameSidecar`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#firstframesidecar)

* * *

### height?[​](#height "Direct link to height?")

> `optional` **height**: `null` | `number`

Defined in: [WAProto/index.d.ts:9020](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9020)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`height`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#height)

* * *

### isAiSticker?[​](#isaisticker "Direct link to isAiSticker?")

> `optional` **isAiSticker**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9032](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9032)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`isAiSticker`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#isaisticker)

* * *

### isAnimated?[​](#isanimated "Direct link to isAnimated?")

> `optional` **isAnimated**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9027](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9027)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`isAnimated`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#isanimated)

* * *

### isAvatar?[​](#isavatar "Direct link to isAvatar?")

> `optional` **isAvatar**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9031](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9031)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`isAvatar`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#isavatar)

* * *

### isLottie?[​](#islottie "Direct link to isLottie?")

> `optional` **isLottie**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9033](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9033)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`isLottie`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#islottie)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9018](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9018)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`mediaKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#mediakey)

* * *

### mediaKeyDomain?[​](#mediakeydomain "Direct link to mediaKeyDomain?")

> `optional` **mediaKeyDomain**: `null` | [`MediaKeyDomain`](/docs/api/namespaces/proto/namespaces/Message/enumerations/MediaKeyDomain)

Defined in: [WAProto/index.d.ts:9035](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9035)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`mediaKeyDomain`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#mediakeydomain)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9024](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9024)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`mediaKeyTimestamp`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#mediakeytimestamp)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:9019](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9019)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`mimetype`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#mimetype)

* * *

### pngThumbnail?[​](#pngthumbnail "Direct link to pngThumbnail?")

> `optional` **pngThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9028](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9028)

#### Implementation of[​](#implementation-of-17 "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`pngThumbnail`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#pngthumbnail)

* * *

### stickerSentTs?[​](#stickersentts "Direct link to stickerSentTs?")

> `optional` **stickerSentTs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9030](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9030)

#### Implementation of[​](#implementation-of-18 "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`stickerSentTs`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#stickersentts)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:9015](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9015)

#### Implementation of[​](#implementation-of-19 "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`url`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#url)

* * *

### width?[​](#width "Direct link to width?")

> `optional` **width**: `null` | `number`

Defined in: [WAProto/index.d.ts:9021](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9021)

#### Implementation of[​](#implementation-of-20 "Direct link to Implementation of")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage).[`width`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage#width)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9041](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9041)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`StickerMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerMessage)

Defined in: [WAProto/index.d.ts:9036](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9036)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`StickerMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`StickerMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerMessage)

Defined in: [WAProto/index.d.ts:9038](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9038)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`StickerMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9037](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9037)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`StickerMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerMessage)

Defined in: [WAProto/index.d.ts:9039](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9039)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`StickerMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9042](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9042)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9040](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9040)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`StickerMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-stickerpackmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/StickerPackMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/StickerPackMessage)

Defined in: [WAProto/index.d.ts:9070](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9070)

## Implements[​](#implements "Direct link to Implements")

*   [`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new StickerPackMessage()[​](#new-stickerpackmessage "Direct link to new StickerPackMessage()")

> **new StickerPackMessage**(`p`?): [`StickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerPackMessage)

Defined in: [WAProto/index.d.ts:9071](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9071)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage)

#### Returns[​](#returns "Direct link to Returns")

[`StickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerPackMessage)

## Properties[​](#properties "Direct link to Properties")

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:9081](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9081)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`caption`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#caption)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:9082](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9082)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#contextinfo)

* * *

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:9080](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9080)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`directPath`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#directpath)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9078](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9078)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`fileEncSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#fileencsha256)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9076](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9076)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`fileLength`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#filelength)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9077](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9077)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`fileSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#filesha256)

* * *

### imageDataHash?[​](#imagedatahash "Direct link to imageDataHash?")

> `optional` **imageDataHash**: `null` | `string`

Defined in: [WAProto/index.d.ts:9091](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9091)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`imageDataHash`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#imagedatahash)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9079](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9079)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`mediaKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#mediakey)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9084](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9084)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`mediaKeyTimestamp`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#mediakeytimestamp)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:9073](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9073)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`name`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#name)

* * *

### packDescription?[​](#packdescription "Direct link to packDescription?")

> `optional` **packDescription**: `null` | `string`

Defined in: [WAProto/index.d.ts:9083](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9083)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`packDescription`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#packdescription)

* * *

### publisher?[​](#publisher "Direct link to publisher?")

> `optional` **publisher**: `null` | `string`

Defined in: [WAProto/index.d.ts:9074](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9074)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`publisher`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#publisher)

* * *

### stickerPackId?[​](#stickerpackid "Direct link to stickerPackId?")

> `optional` **stickerPackId**: `null` | `string`

Defined in: [WAProto/index.d.ts:9072](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9072)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`stickerPackId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#stickerpackid)

* * *

### stickerPackOrigin?[​](#stickerpackorigin "Direct link to stickerPackOrigin?")

> `optional` **stickerPackOrigin**: `null` | [`StickerPackOrigin`](/docs/api/namespaces/proto/namespaces/Message/namespaces/StickerPackMessage/enumerations/StickerPackOrigin)

Defined in: [WAProto/index.d.ts:9093](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9093)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`stickerPackOrigin`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#stickerpackorigin)

* * *

### stickerPackSize?[​](#stickerpacksize "Direct link to stickerPackSize?")

> `optional` **stickerPackSize**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9092](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9092)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`stickerPackSize`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#stickerpacksize)

* * *

### stickers[​](#stickers "Direct link to stickers")

> **stickers**: [`ISticker`](/docs/api/namespaces/proto/namespaces/Message/namespaces/StickerPackMessage/interfaces/ISticker)\[\]

Defined in: [WAProto/index.d.ts:9075](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9075)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`stickers`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#stickers)

* * *

### thumbnailDirectPath?[​](#thumbnaildirectpath "Direct link to thumbnailDirectPath?")

> `optional` **thumbnailDirectPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:9086](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9086)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`thumbnailDirectPath`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#thumbnaildirectpath)

* * *

### thumbnailEncSha256?[​](#thumbnailencsha256 "Direct link to thumbnailEncSha256?")

> `optional` **thumbnailEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9088](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9088)

#### Implementation of[​](#implementation-of-17 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`thumbnailEncSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#thumbnailencsha256)

* * *

### thumbnailHeight?[​](#thumbnailheight "Direct link to thumbnailHeight?")

> `optional` **thumbnailHeight**: `null` | `number`

Defined in: [WAProto/index.d.ts:9089](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9089)

#### Implementation of[​](#implementation-of-18 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`thumbnailHeight`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#thumbnailheight)

* * *

### thumbnailSha256?[​](#thumbnailsha256 "Direct link to thumbnailSha256?")

> `optional` **thumbnailSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9087](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9087)

#### Implementation of[​](#implementation-of-19 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`thumbnailSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#thumbnailsha256)

* * *

### thumbnailWidth?[​](#thumbnailwidth "Direct link to thumbnailWidth?")

> `optional` **thumbnailWidth**: `null` | `number`

Defined in: [WAProto/index.d.ts:9090](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9090)

#### Implementation of[​](#implementation-of-20 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`thumbnailWidth`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#thumbnailwidth)

* * *

### trayIconFileName?[​](#trayiconfilename "Direct link to trayIconFileName?")

> `optional` **trayIconFileName**: `null` | `string`

Defined in: [WAProto/index.d.ts:9085](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9085)

#### Implementation of[​](#implementation-of-21 "Direct link to Implementation of")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage).[`trayIconFileName`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage#trayiconfilename)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9099](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9099)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`StickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerPackMessage)

Defined in: [WAProto/index.d.ts:9094](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9094)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`StickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerPackMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`StickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerPackMessage)

Defined in: [WAProto/index.d.ts:9096](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9096)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`StickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerPackMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9095](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9095)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IStickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`StickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerPackMessage)

Defined in: [WAProto/index.d.ts:9097](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9097)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`StickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerPackMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9100](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9100)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9098](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9098)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`StickerPackMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerPackMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-stickersyncrmrmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/StickerSyncRMRMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/StickerSyncRMRMessage)

Defined in: [WAProto/index.d.ts:9144](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9144)

## Implements[​](#implements "Direct link to Implements")

*   [`IStickerSyncRMRMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerSyncRMRMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new StickerSyncRMRMessage()[​](#new-stickersyncrmrmessage "Direct link to new StickerSyncRMRMessage()")

> **new StickerSyncRMRMessage**(`p`?): [`StickerSyncRMRMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerSyncRMRMessage)

Defined in: [WAProto/index.d.ts:9145](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9145)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IStickerSyncRMRMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerSyncRMRMessage)

#### Returns[​](#returns "Direct link to Returns")

[`StickerSyncRMRMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerSyncRMRMessage)

## Properties[​](#properties "Direct link to Properties")

### filehash[​](#filehash "Direct link to filehash")

> **filehash**: `string`\[\]

Defined in: [WAProto/index.d.ts:9146](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9146)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IStickerSyncRMRMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerSyncRMRMessage).[`filehash`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerSyncRMRMessage#filehash)

* * *

### requestTimestamp?[​](#requesttimestamp "Direct link to requestTimestamp?")

> `optional` **requestTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9148](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9148)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IStickerSyncRMRMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerSyncRMRMessage).[`requestTimestamp`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerSyncRMRMessage#requesttimestamp)

* * *

### rmrSource?[​](#rmrsource "Direct link to rmrSource?")

> `optional` **rmrSource**: `null` | `string`

Defined in: [WAProto/index.d.ts:9147](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9147)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IStickerSyncRMRMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerSyncRMRMessage).[`rmrSource`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerSyncRMRMessage#rmrsource)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9154](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9154)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`StickerSyncRMRMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerSyncRMRMessage)

Defined in: [WAProto/index.d.ts:9149](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9149)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IStickerSyncRMRMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerSyncRMRMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`StickerSyncRMRMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerSyncRMRMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`StickerSyncRMRMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerSyncRMRMessage)

Defined in: [WAProto/index.d.ts:9151](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9151)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`StickerSyncRMRMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerSyncRMRMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9150](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9150)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IStickerSyncRMRMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerSyncRMRMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`StickerSyncRMRMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerSyncRMRMessage)

Defined in: [WAProto/index.d.ts:9152](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9152)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`StickerSyncRMRMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerSyncRMRMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9155](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9155)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9153](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9153)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`StickerSyncRMRMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/StickerSyncRMRMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-templatebuttonreplymessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/TemplateButtonReplyMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/TemplateButtonReplyMessage)

Defined in: [WAProto/index.d.ts:9166](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9166)

## Implements[​](#implements "Direct link to Implements")

*   [`ITemplateButtonReplyMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateButtonReplyMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new TemplateButtonReplyMessage()[​](#new-templatebuttonreplymessage "Direct link to new TemplateButtonReplyMessage()")

> **new TemplateButtonReplyMessage**(`p`?): [`TemplateButtonReplyMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/TemplateButtonReplyMessage)

Defined in: [WAProto/index.d.ts:9167](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9167)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ITemplateButtonReplyMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateButtonReplyMessage)

#### Returns[​](#returns "Direct link to Returns")

[`TemplateButtonReplyMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/TemplateButtonReplyMessage)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:9170](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9170)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ITemplateButtonReplyMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateButtonReplyMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateButtonReplyMessage#contextinfo)

* * *

### selectedCarouselCardIndex?[​](#selectedcarouselcardindex "Direct link to selectedCarouselCardIndex?")

> `optional` **selectedCarouselCardIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:9172](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9172)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ITemplateButtonReplyMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateButtonReplyMessage).[`selectedCarouselCardIndex`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateButtonReplyMessage#selectedcarouselcardindex)

* * *

### selectedDisplayText?[​](#selecteddisplaytext "Direct link to selectedDisplayText?")

> `optional` **selectedDisplayText**: `null` | `string`

Defined in: [WAProto/index.d.ts:9169](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9169)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ITemplateButtonReplyMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateButtonReplyMessage).[`selectedDisplayText`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateButtonReplyMessage#selecteddisplaytext)

* * *

### selectedId?[​](#selectedid "Direct link to selectedId?")

> `optional` **selectedId**: `null` | `string`

Defined in: [WAProto/index.d.ts:9168](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9168)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ITemplateButtonReplyMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateButtonReplyMessage).[`selectedId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateButtonReplyMessage#selectedid)

* * *

### selectedIndex?[​](#selectedindex "Direct link to selectedIndex?")

> `optional` **selectedIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:9171](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9171)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ITemplateButtonReplyMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateButtonReplyMessage).[`selectedIndex`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateButtonReplyMessage#selectedindex)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9178](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9178)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`TemplateButtonReplyMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/TemplateButtonReplyMessage)

Defined in: [WAProto/index.d.ts:9173](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9173)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ITemplateButtonReplyMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateButtonReplyMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`TemplateButtonReplyMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/TemplateButtonReplyMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`TemplateButtonReplyMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/TemplateButtonReplyMessage)

Defined in: [WAProto/index.d.ts:9175](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9175)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`TemplateButtonReplyMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/TemplateButtonReplyMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9174](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9174)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ITemplateButtonReplyMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateButtonReplyMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`TemplateButtonReplyMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/TemplateButtonReplyMessage)

Defined in: [WAProto/index.d.ts:9176](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9176)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`TemplateButtonReplyMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/TemplateButtonReplyMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9179](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9179)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9177](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9177)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`TemplateButtonReplyMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/TemplateButtonReplyMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-templatemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/TemplateMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/TemplateMessage)

Defined in: [WAProto/index.d.ts:9191](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9191)

## Implements[​](#implements "Direct link to Implements")

*   [`ITemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new TemplateMessage()[​](#new-templatemessage "Direct link to new TemplateMessage()")

> **new TemplateMessage**(`p`?): [`TemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/TemplateMessage)

Defined in: [WAProto/index.d.ts:9192](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9192)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ITemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage)

#### Returns[​](#returns "Direct link to Returns")

[`TemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/TemplateMessage)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:9193](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9193)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ITemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage#contextinfo)

* * *

### format?[​](#format "Direct link to format?")

> `optional` **format**: `"hydratedFourRowTemplate"` | `"fourRowTemplate"` | `"interactiveMessageTemplate"`

Defined in: [WAProto/index.d.ts:9199](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9199)

* * *

### fourRowTemplate?[​](#fourrowtemplate "Direct link to fourRowTemplate?")

> `optional` **fourRowTemplate**: `null` | [`IFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate)

Defined in: [WAProto/index.d.ts:9196](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9196)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ITemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage).[`fourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage#fourrowtemplate)

* * *

### hydratedFourRowTemplate?[​](#hydratedfourrowtemplate "Direct link to hydratedFourRowTemplate?")

> `optional` **hydratedFourRowTemplate**: `null` | [`IHydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate)

Defined in: [WAProto/index.d.ts:9197](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9197)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ITemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage).[`hydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage#hydratedfourrowtemplate)

* * *

### hydratedTemplate?[​](#hydratedtemplate "Direct link to hydratedTemplate?")

> `optional` **hydratedTemplate**: `null` | [`IHydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate)

Defined in: [WAProto/index.d.ts:9194](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9194)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ITemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage).[`hydratedTemplate`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage#hydratedtemplate)

* * *

### interactiveMessageTemplate?[​](#interactivemessagetemplate "Direct link to interactiveMessageTemplate?")

> `optional` **interactiveMessageTemplate**: `null` | [`IInteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage)

Defined in: [WAProto/index.d.ts:9198](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9198)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ITemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage).[`interactiveMessageTemplate`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage#interactivemessagetemplate)

* * *

### templateId?[​](#templateid "Direct link to templateId?")

> `optional` **templateId**: `null` | `string`

Defined in: [WAProto/index.d.ts:9195](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9195)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`ITemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage).[`templateId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage#templateid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9205](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9205)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`TemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/TemplateMessage)

Defined in: [WAProto/index.d.ts:9200](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9200)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ITemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`TemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/TemplateMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`TemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/TemplateMessage)

Defined in: [WAProto/index.d.ts:9202](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9202)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`TemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/TemplateMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9201](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9201)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ITemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`TemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/TemplateMessage)

Defined in: [WAProto/index.d.ts:9203](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9203)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`TemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/TemplateMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9206](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9206)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9204](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9204)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`TemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/TemplateMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-urlmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/URLMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/URLMetadata)

Defined in: [WAProto/index.d.ts:9282](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9282)

## Implements[​](#implements "Direct link to Implements")

*   [`IURLMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IURLMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new URLMetadata()[​](#new-urlmetadata "Direct link to new URLMetadata()")

> **new URLMetadata**(`p`?): [`URLMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/URLMetadata)

Defined in: [WAProto/index.d.ts:9283](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9283)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IURLMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IURLMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`URLMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/URLMetadata)

## Properties[​](#properties "Direct link to Properties")

### fbExperimentId?[​](#fbexperimentid "Direct link to fbExperimentId?")

> `optional` **fbExperimentId**: `null` | `number`

Defined in: [WAProto/index.d.ts:9284](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9284)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IURLMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IURLMetadata).[`fbExperimentId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IURLMetadata#fbexperimentid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9290](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9290)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`URLMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/URLMetadata)

Defined in: [WAProto/index.d.ts:9285](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9285)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IURLMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IURLMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`URLMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/URLMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`URLMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/URLMetadata)

Defined in: [WAProto/index.d.ts:9287](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9287)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`URLMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/URLMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9286](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9286)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IURLMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IURLMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`URLMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/URLMetadata)

Defined in: [WAProto/index.d.ts:9288](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9288)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`URLMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/URLMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9291](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9291)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9289](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9289)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`URLMetadata`](/docs/api/namespaces/proto/namespaces/Message/classes/URLMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-videoendcard"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/VideoEndCard](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/VideoEndCard)

Defined in: [WAProto/index.d.ts:9301](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9301)

## Implements[​](#implements "Direct link to Implements")

*   [`IVideoEndCard`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoEndCard)

## Constructors[​](#constructors "Direct link to Constructors")

### new VideoEndCard()[​](#new-videoendcard "Direct link to new VideoEndCard()")

> **new VideoEndCard**(`p`?): [`VideoEndCard`](/docs/api/namespaces/proto/namespaces/Message/classes/VideoEndCard)

Defined in: [WAProto/index.d.ts:9302](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9302)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IVideoEndCard`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoEndCard)

#### Returns[​](#returns "Direct link to Returns")

[`VideoEndCard`](/docs/api/namespaces/proto/namespaces/Message/classes/VideoEndCard)

## Properties[​](#properties "Direct link to Properties")

### caption[​](#caption "Direct link to caption")

> **caption**: `string`

Defined in: [WAProto/index.d.ts:9304](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9304)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IVideoEndCard`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoEndCard).[`caption`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoEndCard#caption)

* * *

### profilePictureUrl[​](#profilepictureurl "Direct link to profilePictureUrl")

> **profilePictureUrl**: `string`

Defined in: [WAProto/index.d.ts:9306](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9306)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IVideoEndCard`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoEndCard).[`profilePictureUrl`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoEndCard#profilepictureurl)

* * *

### thumbnailImageUrl[​](#thumbnailimageurl "Direct link to thumbnailImageUrl")

> **thumbnailImageUrl**: `string`

Defined in: [WAProto/index.d.ts:9305](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9305)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IVideoEndCard`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoEndCard).[`thumbnailImageUrl`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoEndCard#thumbnailimageurl)

* * *

### username[​](#username "Direct link to username")

> **username**: `string`

Defined in: [WAProto/index.d.ts:9303](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9303)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IVideoEndCard`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoEndCard).[`username`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoEndCard#username)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9312](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9312)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`VideoEndCard`](/docs/api/namespaces/proto/namespaces/Message/classes/VideoEndCard)

Defined in: [WAProto/index.d.ts:9307](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9307)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IVideoEndCard`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoEndCard)

#### Returns[​](#returns-2 "Direct link to Returns")

[`VideoEndCard`](/docs/api/namespaces/proto/namespaces/Message/classes/VideoEndCard)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`VideoEndCard`](/docs/api/namespaces/proto/namespaces/Message/classes/VideoEndCard)

Defined in: [WAProto/index.d.ts:9309](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9309)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`VideoEndCard`](/docs/api/namespaces/proto/namespaces/Message/classes/VideoEndCard)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9308](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9308)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IVideoEndCard`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoEndCard)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`VideoEndCard`](/docs/api/namespaces/proto/namespaces/Message/classes/VideoEndCard)

Defined in: [WAProto/index.d.ts:9310](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9310)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`VideoEndCard`](/docs/api/namespaces/proto/namespaces/Message/classes/VideoEndCard)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9313](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9313)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9311](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9311)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`VideoEndCard`](/docs/api/namespaces/proto/namespaces/Message/classes/VideoEndCard)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-videomessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/VideoMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/classes/VideoMessage)

Defined in: [WAProto/index.d.ts:9350](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9350)

## Implements[​](#implements "Direct link to Implements")

*   [`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new VideoMessage()[​](#new-videomessage "Direct link to new VideoMessage()")

> **new VideoMessage**(`p`?): [`VideoMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/VideoMessage)

Defined in: [WAProto/index.d.ts:9351](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9351)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage)

#### Returns[​](#returns "Direct link to Returns")

[`VideoMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/VideoMessage)

## Properties[​](#properties "Direct link to Properties")

### accessibilityLabel?[​](#accessibilitylabel "Direct link to accessibilityLabel?")

> `optional` **accessibilityLabel**: `null` | `string`

Defined in: [WAProto/index.d.ts:9376](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9376)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`accessibilityLabel`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#accessibilitylabel)

* * *

### annotations[​](#annotations "Direct link to annotations")

> **annotations**: [`IInteractiveAnnotation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation)\[\]

Defined in: [WAProto/index.d.ts:9375](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9375)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`annotations`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#annotations)

* * *

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:9358](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9358)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`caption`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#caption)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:9367](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9367)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`contextInfo`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#contextinfo)

* * *

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:9364](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9364)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`directPath`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#directpath)

* * *

### externalShareFullVideoDurationInSeconds?[​](#externalsharefullvideodurationinseconds "Direct link to externalShareFullVideoDurationInSeconds?")

> `optional` **externalShareFullVideoDurationInSeconds**: `null` | `number`

Defined in: [WAProto/index.d.ts:9378](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9378)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`externalShareFullVideoDurationInSeconds`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#externalsharefullvideodurationinseconds)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9362](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9362)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`fileEncSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#fileencsha256)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9355](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9355)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`fileLength`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#filelength)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9354](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9354)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`fileSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#filesha256)

* * *

### gifAttribution?[​](#gifattribution "Direct link to gifAttribution?")

> `optional` **gifAttribution**: `null` | [`Attribution`](/docs/api/namespaces/proto/namespaces/Message/namespaces/VideoMessage/enumerations/Attribution)

Defined in: [WAProto/index.d.ts:9369](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9369)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`gifAttribution`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#gifattribution)

* * *

### gifPlayback?[​](#gifplayback "Direct link to gifPlayback?")

> `optional` **gifPlayback**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9359](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9359)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`gifPlayback`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#gifplayback)

* * *

### height?[​](#height "Direct link to height?")

> `optional` **height**: `null` | `number`

Defined in: [WAProto/index.d.ts:9360](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9360)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`height`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#height)

* * *

### interactiveAnnotations[​](#interactiveannotations "Direct link to interactiveAnnotations")

> **interactiveAnnotations**: [`IInteractiveAnnotation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation)\[\]

Defined in: [WAProto/index.d.ts:9363](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9363)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`interactiveAnnotations`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#interactiveannotations)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9366](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9366)

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`jpegThumbnail`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#jpegthumbnail)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9357](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9357)

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`mediaKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#mediakey)

* * *

### mediaKeyDomain?[​](#mediakeydomain "Direct link to mediaKeyDomain?")

> `optional` **mediaKeyDomain**: `null` | [`MediaKeyDomain`](/docs/api/namespaces/proto/namespaces/Message/enumerations/MediaKeyDomain)

Defined in: [WAProto/index.d.ts:9382](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9382)

#### Implementation of[​](#implementation-of-15 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`mediaKeyDomain`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#mediakeydomain)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9365](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9365)

#### Implementation of[​](#implementation-of-16 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`mediaKeyTimestamp`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#mediakeytimestamp)

* * *

### metadataUrl?[​](#metadataurl "Direct link to metadataUrl?")

> `optional` **metadataUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:9380](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9380)

#### Implementation of[​](#implementation-of-17 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`metadataUrl`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#metadataurl)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:9353](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9353)

#### Implementation of[​](#implementation-of-18 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`mimetype`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#mimetype)

* * *

### motionPhotoPresentationOffsetMs?[​](#motionphotopresentationoffsetms "Direct link to motionPhotoPresentationOffsetMs?")

> `optional` **motionPhotoPresentationOffsetMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9379](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9379)

#### Implementation of[​](#implementation-of-19 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`motionPhotoPresentationOffsetMs`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#motionphotopresentationoffsetms)

* * *

### processedVideos[​](#processedvideos "Direct link to processedVideos")

> **processedVideos**: [`IProcessedVideo`](/docs/api/namespaces/proto/interfaces/IProcessedVideo)\[\]

Defined in: [WAProto/index.d.ts:9377](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9377)

#### Implementation of[​](#implementation-of-20 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`processedVideos`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#processedvideos)

* * *

### seconds?[​](#seconds "Direct link to seconds?")

> `optional` **seconds**: `null` | `number`

Defined in: [WAProto/index.d.ts:9356](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9356)

#### Implementation of[​](#implementation-of-21 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`seconds`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#seconds)

* * *

### staticUrl?[​](#staticurl "Direct link to staticUrl?")

> `optional` **staticUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:9374](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9374)

#### Implementation of[​](#implementation-of-22 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`staticUrl`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#staticurl)

* * *

### streamingSidecar?[​](#streamingsidecar "Direct link to streamingSidecar?")

> `optional` **streamingSidecar**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9368](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9368)

#### Implementation of[​](#implementation-of-23 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`streamingSidecar`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#streamingsidecar)

* * *

### thumbnailDirectPath?[​](#thumbnaildirectpath "Direct link to thumbnailDirectPath?")

> `optional` **thumbnailDirectPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:9371](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9371)

#### Implementation of[​](#implementation-of-24 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`thumbnailDirectPath`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#thumbnaildirectpath)

* * *

### thumbnailEncSha256?[​](#thumbnailencsha256 "Direct link to thumbnailEncSha256?")

> `optional` **thumbnailEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9373](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9373)

#### Implementation of[​](#implementation-of-25 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`thumbnailEncSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#thumbnailencsha256)

* * *

### thumbnailSha256?[​](#thumbnailsha256 "Direct link to thumbnailSha256?")

> `optional` **thumbnailSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9372](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9372)

#### Implementation of[​](#implementation-of-26 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`thumbnailSha256`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#thumbnailsha256)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:9352](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9352)

#### Implementation of[​](#implementation-of-27 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`url`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#url)

* * *

### videoSourceType?[​](#videosourcetype "Direct link to videoSourceType?")

> `optional` **videoSourceType**: `null` | [`VideoSourceType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/VideoMessage/enumerations/VideoSourceType)

Defined in: [WAProto/index.d.ts:9381](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9381)

#### Implementation of[​](#implementation-of-28 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`videoSourceType`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#videosourcetype)

* * *

### viewOnce?[​](#viewonce "Direct link to viewOnce?")

> `optional` **viewOnce**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9370](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9370)

#### Implementation of[​](#implementation-of-29 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`viewOnce`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#viewonce)

* * *

### width?[​](#width "Direct link to width?")

> `optional` **width**: `null` | `number`

Defined in: [WAProto/index.d.ts:9361](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9361)

#### Implementation of[​](#implementation-of-30 "Direct link to Implementation of")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage).[`width`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage#width)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9388](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9388)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`VideoMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/VideoMessage)

Defined in: [WAProto/index.d.ts:9383](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9383)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`VideoMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/VideoMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`VideoMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/VideoMessage)

Defined in: [WAProto/index.d.ts:9385](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9385)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`VideoMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/VideoMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9384](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9384)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`VideoMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/VideoMessage)

Defined in: [WAProto/index.d.ts:9386](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9386)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`VideoMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/VideoMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9389](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9389)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9387](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9387)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`VideoMessage`](/docs/api/namespaces/proto/namespaces/Message/classes/VideoMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-historysynctype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/enumerations/HistorySyncType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/enumerations/HistorySyncType)

Defined in: [WAProto/index.d.ts:6618](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6618)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### FULL[​](#full "Direct link to FULL")

> **FULL**: `2`

Defined in: [WAProto/index.d.ts:6621](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6621)

* * *

### INITIAL\_BOOTSTRAP[​](#initial_bootstrap "Direct link to INITIAL_BOOTSTRAP")

> **INITIAL\_BOOTSTRAP**: `0`

Defined in: [WAProto/index.d.ts:6619](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6619)

* * *

### INITIAL\_STATUS\_V3[​](#initial_status_v3 "Direct link to INITIAL_STATUS_V3")

> **INITIAL\_STATUS\_V3**: `1`

Defined in: [WAProto/index.d.ts:6620](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6620)

* * *

### MESSAGE\_ACCESS\_STATUS[​](#message_access_status "Direct link to MESSAGE_ACCESS_STATUS")

> **MESSAGE\_ACCESS\_STATUS**: `8`

Defined in: [WAProto/index.d.ts:6627](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6627)

* * *

### NO\_HISTORY[​](#no_history "Direct link to NO_HISTORY")

> **NO\_HISTORY**: `7`

Defined in: [WAProto/index.d.ts:6626](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6626)

* * *

### NON\_BLOCKING\_DATA[​](#non_blocking_data "Direct link to NON_BLOCKING_DATA")

> **NON\_BLOCKING\_DATA**: `5`

Defined in: [WAProto/index.d.ts:6624](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6624)

* * *

### ON\_DEMAND[​](#on_demand "Direct link to ON_DEMAND")

> **ON\_DEMAND**: `6`

Defined in: [WAProto/index.d.ts:6625](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6625)

* * *

### PUSH\_NAME[​](#push_name "Direct link to PUSH_NAME")

> **PUSH\_NAME**: `4`

Defined in: [WAProto/index.d.ts:6623](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6623)

* * *

### RECENT[​](#recent "Direct link to RECENT")

> **RECENT**: `3`

Defined in: [WAProto/index.d.ts:6622](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6622)

---

<a name="enumeration-mediakeydomain"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/enumerations/MediaKeyDomain](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/enumerations/MediaKeyDomain)

Defined in: [WAProto/index.d.ts:7433](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7433)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### BOT[​](#bot "Direct link to BOT")

> **BOT**: `4`

Defined in: [WAProto/index.d.ts:7438](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7438)

* * *

### CAPI[​](#capi "Direct link to CAPI")

> **CAPI**: `3`

Defined in: [WAProto/index.d.ts:7437](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7437)

* * *

### E2EE\_CHAT[​](#e2ee_chat "Direct link to E2EE_CHAT")

> **E2EE\_CHAT**: `1`

Defined in: [WAProto/index.d.ts:7435](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7435)

* * *

### STATUS[​](#status "Direct link to STATUS")

> **STATUS**: `2`

Defined in: [WAProto/index.d.ts:7436](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7436)

* * *

### UNSET[​](#unset "Direct link to UNSET")

> **UNSET**: `0`

Defined in: [WAProto/index.d.ts:7434](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7434)

---

<a name="enumeration-peerdataoperationrequesttype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/enumerations/PeerDataOperationRequestType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/enumerations/PeerDataOperationRequestType)

Defined in: [WAProto/index.d.ts:8227](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8227)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### COMPANION\_CANONICAL\_USER\_NONCE\_FETCH[​](#companion_canonical_user_nonce_fetch "Direct link to COMPANION_CANONICAL_USER_NONCE_FETCH")

> **COMPANION\_CANONICAL\_USER\_NONCE\_FETCH**: `9`

Defined in: [WAProto/index.d.ts:8237](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8237)

* * *

### COMPANION\_META\_NONCE\_FETCH[​](#companion_meta_nonce_fetch "Direct link to COMPANION_META_NONCE_FETCH")

> **COMPANION\_META\_NONCE\_FETCH**: `7`

Defined in: [WAProto/index.d.ts:8235](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8235)

* * *

### COMPANION\_SYNCD\_SNAPSHOT\_FATAL\_RECOVERY[​](#companion_syncd_snapshot_fatal_recovery "Direct link to COMPANION_SYNCD_SNAPSHOT_FATAL_RECOVERY")

> **COMPANION\_SYNCD\_SNAPSHOT\_FATAL\_RECOVERY**: `8`

Defined in: [WAProto/index.d.ts:8236](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8236)

* * *

### FULL\_HISTORY\_SYNC\_ON\_DEMAND[​](#full_history_sync_on_demand "Direct link to FULL_HISTORY_SYNC_ON_DEMAND")

> **FULL\_HISTORY\_SYNC\_ON\_DEMAND**: `6`

Defined in: [WAProto/index.d.ts:8234](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8234)

* * *

### GALAXY\_FLOW\_ACTION[​](#galaxy_flow_action "Direct link to GALAXY_FLOW_ACTION")

> **GALAXY\_FLOW\_ACTION**: `11`

Defined in: [WAProto/index.d.ts:8239](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8239)

* * *

### GENERATE\_LINK\_PREVIEW[​](#generate_link_preview "Direct link to GENERATE_LINK_PREVIEW")

> **GENERATE\_LINK\_PREVIEW**: `2`

Defined in: [WAProto/index.d.ts:8230](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8230)

* * *

### HISTORY\_SYNC\_CHUNK\_RETRY[​](#history_sync_chunk_retry "Direct link to HISTORY_SYNC_CHUNK_RETRY")

> **HISTORY\_SYNC\_CHUNK\_RETRY**: `10`

Defined in: [WAProto/index.d.ts:8238](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8238)

* * *

### HISTORY\_SYNC\_ON\_DEMAND[​](#history_sync_on_demand "Direct link to HISTORY_SYNC_ON_DEMAND")

> **HISTORY\_SYNC\_ON\_DEMAND**: `3`

Defined in: [WAProto/index.d.ts:8231](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8231)

* * *

### PLACEHOLDER\_MESSAGE\_RESEND[​](#placeholder_message_resend "Direct link to PLACEHOLDER_MESSAGE_RESEND")

> **PLACEHOLDER\_MESSAGE\_RESEND**: `4`

Defined in: [WAProto/index.d.ts:8232](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8232)

* * *

### SEND\_RECENT\_STICKER\_BOOTSTRAP[​](#send_recent_sticker_bootstrap "Direct link to SEND_RECENT_STICKER_BOOTSTRAP")

> **SEND\_RECENT\_STICKER\_BOOTSTRAP**: `1`

Defined in: [WAProto/index.d.ts:8229](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8229)

* * *

### UPLOAD\_STICKER[​](#upload_sticker "Direct link to UPLOAD_STICKER")

> **UPLOAD\_STICKER**: `0`

Defined in: [WAProto/index.d.ts:8228](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8228)

* * *

### WAFFLE\_LINKING\_NONCE\_FETCH[​](#waffle_linking_nonce_fetch "Direct link to WAFFLE_LINKING_NONCE_FETCH")

> **WAFFLE\_LINKING\_NONCE\_FETCH**: `5`

Defined in: [WAProto/index.d.ts:8233](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8233)

---

<a name="enumeration-pollcontenttype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/enumerations/PollContentType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/enumerations/PollContentType)

Defined in: [WAProto/index.d.ts:8294](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8294)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### IMAGE[​](#image "Direct link to IMAGE")

> **IMAGE**: `2`

Defined in: [WAProto/index.d.ts:8297](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8297)

* * *

### TEXT[​](#text "Direct link to TEXT")

> **TEXT**: `1`

Defined in: [WAProto/index.d.ts:8296](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8296)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:8295](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8295)

---

<a name="enumeration-polltype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/enumerations/PollType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/enumerations/PollType)

Defined in: [WAProto/index.d.ts:8412](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8412)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### POLL[​](#poll "Direct link to POLL")

> **POLL**: `0`

Defined in: [WAProto/index.d.ts:8413](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8413)

* * *

### QUIZ[​](#quiz "Direct link to QUIZ")

> **QUIZ**: `1`

Defined in: [WAProto/index.d.ts:8414](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8414)

---

<a name="interface-ialbummessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IAlbumMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IAlbumMessage)

Defined in: [WAProto/index.d.ts:5391](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5391)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:5394](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5394)

* * *

### expectedImageCount?[​](#expectedimagecount "Direct link to expectedImageCount?")

> `optional` **expectedImageCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:5392](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5392)

* * *

### expectedVideoCount?[​](#expectedvideocount "Direct link to expectedVideoCount?")

> `optional` **expectedVideoCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:5393](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5393)

---

<a name="interface-iappstatefatalexceptionnotification"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateFatalExceptionNotification](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateFatalExceptionNotification)

Defined in: [WAProto/index.d.ts:5411](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5411)

## Properties[​](#properties "Direct link to Properties")

### collectionNames?[​](#collectionnames "Direct link to collectionNames?")

> `optional` **collectionNames**: `null` | `string`\[\]

Defined in: [WAProto/index.d.ts:5412](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5412)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:5413](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5413)

---

<a name="interface-iappstatesynckey"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKey](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKey)

Defined in: [WAProto/index.d.ts:5429](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5429)

## Properties[​](#properties "Direct link to Properties")

### keyData?[​](#keydata "Direct link to keyData?")

> `optional` **keyData**: `null` | [`IAppStateSyncKeyData`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyData)

Defined in: [WAProto/index.d.ts:5431](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5431)

* * *

### keyId?[​](#keyid "Direct link to keyId?")

> `optional` **keyId**: `null` | [`IAppStateSyncKeyId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyId)

Defined in: [WAProto/index.d.ts:5430](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5430)

---

<a name="interface-iappstatesynckeydata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyData)

Defined in: [WAProto/index.d.ts:5447](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5447)

## Properties[​](#properties "Direct link to Properties")

### fingerprint?[​](#fingerprint "Direct link to fingerprint?")

> `optional` **fingerprint**: `null` | [`IAppStateSyncKeyFingerprint`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyFingerprint)

Defined in: [WAProto/index.d.ts:5449](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5449)

* * *

### keyData?[​](#keydata "Direct link to keyData?")

> `optional` **keyData**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5448](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5448)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:5450](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5450)

---

<a name="interface-iappstatesynckeyfingerprint"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyFingerprint](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyFingerprint)

Defined in: [WAProto/index.d.ts:5467](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5467)

## Properties[​](#properties "Direct link to Properties")

### currentIndex?[​](#currentindex "Direct link to currentIndex?")

> `optional` **currentIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:5469](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5469)

* * *

### deviceIndexes?[​](#deviceindexes "Direct link to deviceIndexes?")

> `optional` **deviceIndexes**: `null` | `number`\[\]

Defined in: [WAProto/index.d.ts:5470](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5470)

* * *

### rawId?[​](#rawid "Direct link to rawId?")

> `optional` **rawId**: `null` | `number`

Defined in: [WAProto/index.d.ts:5468](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5468)

---

<a name="interface-iappstatesynckeyid"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyId](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyId)

Defined in: [WAProto/index.d.ts:5487](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5487)

## Properties[​](#properties "Direct link to Properties")

### keyId?[​](#keyid "Direct link to keyId?")

> `optional` **keyId**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5488](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5488)

---

<a name="interface-iappstatesynckeyrequest"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyRequest](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyRequest)

Defined in: [WAProto/index.d.ts:5503](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5503)

## Properties[​](#properties "Direct link to Properties")

### keyIds?[​](#keyids "Direct link to keyIds?")

> `optional` **keyIds**: `null` | [`IAppStateSyncKeyId`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyId)\[\]

Defined in: [WAProto/index.d.ts:5504](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5504)

---

<a name="interface-iappstatesynckeyshare"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyShare](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyShare)

Defined in: [WAProto/index.d.ts:5519](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5519)

## Properties[​](#properties "Direct link to Properties")

### keys?[​](#keys "Direct link to keys?")

> `optional` **keys**: `null` | [`IAppStateSyncKey`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKey)\[\]

Defined in: [WAProto/index.d.ts:5520](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5520)

---

<a name="interface-iaudiomessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage)

Defined in: [WAProto/index.d.ts:5535](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5535)

## Properties[​](#properties "Direct link to Properties")

### accessibilityLabel?[​](#accessibilitylabel "Direct link to accessibilityLabel?")

> `optional` **accessibilityLabel**: `null` | `string`

Defined in: [WAProto/index.d.ts:5551](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5551)

* * *

### backgroundArgb?[​](#backgroundargb "Direct link to backgroundArgb?")

> `optional` **backgroundArgb**: `null` | `number`

Defined in: [WAProto/index.d.ts:5549](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5549)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:5546](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5546)

* * *

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:5544](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5544)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5543](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5543)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:5539](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5539)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5538](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5538)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5542](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5542)

* * *

### mediaKeyDomain?[​](#mediakeydomain "Direct link to mediaKeyDomain?")

> `optional` **mediaKeyDomain**: `null` | [`MediaKeyDomain`](/docs/api/namespaces/proto/namespaces/Message/enumerations/MediaKeyDomain)

Defined in: [WAProto/index.d.ts:5552](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5552)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:5545](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5545)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:5537](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5537)

* * *

### ptt?[​](#ptt "Direct link to ptt?")

> `optional` **ptt**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:5541](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5541)

* * *

### seconds?[​](#seconds "Direct link to seconds?")

> `optional` **seconds**: `null` | `number`

Defined in: [WAProto/index.d.ts:5540](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5540)

* * *

### streamingSidecar?[​](#streamingsidecar "Direct link to streamingSidecar?")

> `optional` **streamingSidecar**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5547](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5547)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:5536](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5536)

* * *

### viewOnce?[​](#viewonce "Direct link to viewOnce?")

> `optional` **viewOnce**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:5550](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5550)

* * *

### waveform?[​](#waveform "Direct link to waveform?")

> `optional` **waveform**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5548](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5548)

---

<a name="interface-ibcallmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IBCallMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IBCallMessage)

Defined in: [WAProto/index.d.ts:5583](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5583)

## Properties[​](#properties "Direct link to Properties")

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:5587](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5587)

* * *

### masterKey?[​](#masterkey "Direct link to masterKey?")

> `optional` **masterKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5586](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5586)

* * *

### mediaType?[​](#mediatype "Direct link to mediaType?")

> `optional` **mediaType**: `null` | [`MediaType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/BCallMessage/enumerations/MediaType)

Defined in: [WAProto/index.d.ts:5585](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5585)

* * *

### sessionId?[​](#sessionid "Direct link to sessionId?")

> `optional` **sessionId**: `null` | `string`

Defined in: [WAProto/index.d.ts:5584](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5584)

---

<a name="interface-ibuttonsmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsMessage)

Defined in: [WAProto/index.d.ts:5614](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5614)

## Properties[​](#properties "Direct link to Properties")

### buttons?[​](#buttons "Direct link to buttons?")

> `optional` **buttons**: `null` | [`IButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/interfaces/IButton)\[\]

Defined in: [WAProto/index.d.ts:5618](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5618)

* * *

### contentText?[​](#contenttext "Direct link to contentText?")

> `optional` **contentText**: `null` | `string`

Defined in: [WAProto/index.d.ts:5615](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5615)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:5617](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5617)

* * *

### documentMessage?[​](#documentmessage "Direct link to documentMessage?")

> `optional` **documentMessage**: `null` | [`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage)

Defined in: [WAProto/index.d.ts:5621](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5621)

* * *

### footerText?[​](#footertext "Direct link to footerText?")

> `optional` **footerText**: `null` | `string`

Defined in: [WAProto/index.d.ts:5616](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5616)

* * *

### headerType?[​](#headertype "Direct link to headerType?")

> `optional` **headerType**: `null` | [`HeaderType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/enumerations/HeaderType)

Defined in: [WAProto/index.d.ts:5619](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5619)

* * *

### imageMessage?[​](#imagemessage "Direct link to imageMessage?")

> `optional` **imageMessage**: `null` | [`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage)

Defined in: [WAProto/index.d.ts:5622](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5622)

* * *

### locationMessage?[​](#locationmessage "Direct link to locationMessage?")

> `optional` **locationMessage**: `null` | [`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage)

Defined in: [WAProto/index.d.ts:5624](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5624)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:5620](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5620)

* * *

### videoMessage?[​](#videomessage "Direct link to videoMessage?")

> `optional` **videoMessage**: `null` | [`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage)

Defined in: [WAProto/index.d.ts:5623](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5623)

---

<a name="interface-ibuttonsresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsResponseMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IButtonsResponseMessage)

Defined in: [WAProto/index.d.ts:5727](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5727)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:5729](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5729)

* * *

### selectedButtonId?[​](#selectedbuttonid "Direct link to selectedButtonId?")

> `optional` **selectedButtonId**: `null` | `string`

Defined in: [WAProto/index.d.ts:5728](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5728)

* * *

### selectedDisplayText?[​](#selecteddisplaytext "Direct link to selectedDisplayText?")

> `optional` **selectedDisplayText**: `null` | `string`

Defined in: [WAProto/index.d.ts:5731](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5731)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`Type`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsResponseMessage/enumerations/Type)

Defined in: [WAProto/index.d.ts:5730](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5730)

---

<a name="interface-icall"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ICall)

Defined in: [WAProto/index.d.ts:5758](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5758)

## Properties[​](#properties "Direct link to Properties")

### callKey?[​](#callkey "Direct link to callKey?")

> `optional` **callKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5759](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5759)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:5765](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5765)

* * *

### conversionData?[​](#conversiondata "Direct link to conversionData?")

> `optional` **conversionData**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5761](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5761)

* * *

### conversionDelaySeconds?[​](#conversiondelayseconds "Direct link to conversionDelaySeconds?")

> `optional` **conversionDelaySeconds**: `null` | `number`

Defined in: [WAProto/index.d.ts:5762](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5762)

* * *

### conversionSource?[​](#conversionsource "Direct link to conversionSource?")

> `optional` **conversionSource**: `null` | `string`

Defined in: [WAProto/index.d.ts:5760](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5760)

* * *

### ctwaPayload?[​](#ctwapayload "Direct link to ctwaPayload?")

> `optional` **ctwaPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:5764](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5764)

* * *

### ctwaSignals?[​](#ctwasignals "Direct link to ctwaSignals?")

> `optional` **ctwaSignals**: `null` | `string`

Defined in: [WAProto/index.d.ts:5763](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5763)

* * *

### deeplinkPayload?[​](#deeplinkpayload "Direct link to deeplinkPayload?")

> `optional` **deeplinkPayload**: `null` | `string`

Defined in: [WAProto/index.d.ts:5767](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5767)

* * *

### nativeFlowCallButtonPayload?[​](#nativeflowcallbuttonpayload "Direct link to nativeFlowCallButtonPayload?")

> `optional` **nativeFlowCallButtonPayload**: `null` | `string`

Defined in: [WAProto/index.d.ts:5766](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5766)

---

<a name="interface-icalllogmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ICallLogMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ICallLogMessage)

Defined in: [WAProto/index.d.ts:5790](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5790)

## Properties[​](#properties "Direct link to Properties")

### callOutcome?[​](#calloutcome "Direct link to callOutcome?")

> `optional` **callOutcome**: `null` | [`CallOutcome`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/enumerations/CallOutcome)

Defined in: [WAProto/index.d.ts:5792](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5792)

* * *

### callType?[​](#calltype "Direct link to callType?")

> `optional` **callType**: `null` | [`CallType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/enumerations/CallType)

Defined in: [WAProto/index.d.ts:5794](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5794)

* * *

### durationSecs?[​](#durationsecs "Direct link to durationSecs?")

> `optional` **durationSecs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:5793](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5793)

* * *

### isVideo?[​](#isvideo "Direct link to isVideo?")

> `optional` **isVideo**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:5791](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5791)

* * *

### participants?[​](#participants "Direct link to participants?")

> `optional` **participants**: `null` | [`ICallParticipant`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/interfaces/ICallParticipant)\[\]

Defined in: [WAProto/index.d.ts:5795](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5795)

---

<a name="interface-icancelpaymentrequestmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ICancelPaymentRequestMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ICancelPaymentRequestMessage)

Defined in: [WAProto/index.d.ts:5852](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5852)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:5853](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5853)

---

<a name="interface-ichat"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IChat](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IChat)

Defined in: [WAProto/index.d.ts:5868](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5868)

## Properties[​](#properties "Direct link to Properties")

### displayName?[​](#displayname "Direct link to displayName?")

> `optional` **displayName**: `null` | `string`

Defined in: [WAProto/index.d.ts:5869](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5869)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:5870](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5870)

---

<a name="interface-icloudapithreadcontrolnotification"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification)

Defined in: [WAProto/index.d.ts:5886](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5886)

## Properties[​](#properties "Direct link to Properties")

### consumerLid?[​](#consumerlid "Direct link to consumerLid?")

> `optional` **consumerLid**: `null` | `string`

Defined in: [WAProto/index.d.ts:5889](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5889)

* * *

### consumerPhoneNumber?[​](#consumerphonenumber "Direct link to consumerPhoneNumber?")

> `optional` **consumerPhoneNumber**: `null` | `string`

Defined in: [WAProto/index.d.ts:5890](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5890)

* * *

### notificationContent?[​](#notificationcontent "Direct link to notificationContent?")

> `optional` **notificationContent**: `null` | [`ICloudAPIThreadControlNotificationContent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/interfaces/ICloudAPIThreadControlNotificationContent)

Defined in: [WAProto/index.d.ts:5891](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5891)

* * *

### senderNotificationTimestampMs?[​](#sendernotificationtimestampms "Direct link to senderNotificationTimestampMs?")

> `optional` **senderNotificationTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:5888](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5888)

* * *

### shouldSuppressNotification?[​](#shouldsuppressnotification "Direct link to shouldSuppressNotification?")

> `optional` **shouldSuppressNotification**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:5892](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5892)

* * *

### status?[​](#status "Direct link to status?")

> `optional` **status**: `null` | [`CloudAPIThreadControl`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/enumerations/CloudAPIThreadControl)

Defined in: [WAProto/index.d.ts:5887](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5887)

---

<a name="interface-icommentmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ICommentMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ICommentMessage)

Defined in: [WAProto/index.d.ts:5939](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5939)

## Properties[​](#properties "Direct link to Properties")

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:5940](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5940)

* * *

### targetMessageKey?[​](#targetmessagekey "Direct link to targetMessageKey?")

> `optional` **targetMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:5941](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5941)

---

<a name="interface-icontactmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactMessage)

Defined in: [WAProto/index.d.ts:5957](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5957)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:5960](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5960)

* * *

### displayName?[​](#displayname "Direct link to displayName?")

> `optional` **displayName**: `null` | `string`

Defined in: [WAProto/index.d.ts:5958](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5958)

* * *

### vcard?[​](#vcard "Direct link to vcard?")

> `optional` **vcard**: `null` | `string`

Defined in: [WAProto/index.d.ts:5959](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5959)

---

<a name="interface-icontactsarraymessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactsArrayMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactsArrayMessage)

Defined in: [WAProto/index.d.ts:5977](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5977)

## Properties[​](#properties "Direct link to Properties")

### contacts?[​](#contacts "Direct link to contacts?")

> `optional` **contacts**: `null` | [`IContactMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactMessage)\[\]

Defined in: [WAProto/index.d.ts:5979](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5979)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:5980](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5980)

* * *

### displayName?[​](#displayname "Direct link to displayName?")

> `optional` **displayName**: `null` | `string`

Defined in: [WAProto/index.d.ts:5978](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5978)

---

<a name="interface-ideclinepaymentrequestmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeclinePaymentRequestMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeclinePaymentRequestMessage)

Defined in: [WAProto/index.d.ts:5997](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5997)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:5998](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5998)

---

<a name="interface-idevicesentmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeviceSentMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IDeviceSentMessage)

Defined in: [WAProto/index.d.ts:6013](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6013)

## Properties[​](#properties "Direct link to Properties")

### destinationJid?[​](#destinationjid "Direct link to destinationJid?")

> `optional` **destinationJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:6014](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6014)

* * *

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:6015](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6015)

* * *

### phash?[​](#phash "Direct link to phash?")

> `optional` **phash**: `null` | `string`

Defined in: [WAProto/index.d.ts:6016](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6016)

---

<a name="interface-idocumentmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage)

Defined in: [WAProto/index.d.ts:6033](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6033)

## Properties[​](#properties "Direct link to Properties")

### accessibilityLabel?[​](#accessibilitylabel "Direct link to accessibilityLabel?")

> `optional` **accessibilityLabel**: `null` | `string`

Defined in: [WAProto/index.d.ts:6054](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6054)

* * *

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:6053](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6053)

* * *

### contactVcard?[​](#contactvcard "Direct link to contactVcard?")

> `optional` **contactVcard**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6045](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6045)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:6050](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6050)

* * *

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:6043](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6043)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6042](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6042)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6038](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6038)

* * *

### fileName?[​](#filename "Direct link to fileName?")

> `optional` **fileName**: `null` | `string`

Defined in: [WAProto/index.d.ts:6041](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6041)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6037](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6037)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6049](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6049)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6040](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6040)

* * *

### mediaKeyDomain?[​](#mediakeydomain "Direct link to mediaKeyDomain?")

> `optional` **mediaKeyDomain**: `null` | [`MediaKeyDomain`](/docs/api/namespaces/proto/namespaces/Message/enumerations/MediaKeyDomain)

Defined in: [WAProto/index.d.ts:6055](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6055)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6044](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6044)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:6035](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6035)

* * *

### pageCount?[​](#pagecount "Direct link to pageCount?")

> `optional` **pageCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:6039](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6039)

* * *

### thumbnailDirectPath?[​](#thumbnaildirectpath "Direct link to thumbnailDirectPath?")

> `optional` **thumbnailDirectPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:6046](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6046)

* * *

### thumbnailEncSha256?[​](#thumbnailencsha256 "Direct link to thumbnailEncSha256?")

> `optional` **thumbnailEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6048](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6048)

* * *

### thumbnailHeight?[​](#thumbnailheight "Direct link to thumbnailHeight?")

> `optional` **thumbnailHeight**: `null` | `number`

Defined in: [WAProto/index.d.ts:6051](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6051)

* * *

### thumbnailSha256?[​](#thumbnailsha256 "Direct link to thumbnailSha256?")

> `optional` **thumbnailSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6047](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6047)

* * *

### thumbnailWidth?[​](#thumbnailwidth "Direct link to thumbnailWidth?")

> `optional` **thumbnailWidth**: `null` | `number`

Defined in: [WAProto/index.d.ts:6052](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6052)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:6036](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6036)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:6034](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6034)

---

<a name="interface-ienccommentmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncCommentMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncCommentMessage)

Defined in: [WAProto/index.d.ts:6091](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6091)

## Properties[​](#properties "Direct link to Properties")

### encIv?[​](#enciv "Direct link to encIv?")

> `optional` **encIv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6094](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6094)

* * *

### encPayload?[​](#encpayload "Direct link to encPayload?")

> `optional` **encPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6093](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6093)

* * *

### targetMessageKey?[​](#targetmessagekey "Direct link to targetMessageKey?")

> `optional` **targetMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:6092](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6092)

---

<a name="interface-ienceventresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncEventResponseMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncEventResponseMessage)

Defined in: [WAProto/index.d.ts:6111](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6111)

## Properties[​](#properties "Direct link to Properties")

### encIv?[​](#enciv "Direct link to encIv?")

> `optional` **encIv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6114](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6114)

* * *

### encPayload?[​](#encpayload "Direct link to encPayload?")

> `optional` **encPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6113](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6113)

* * *

### eventCreationMessageKey?[​](#eventcreationmessagekey "Direct link to eventCreationMessageKey?")

> `optional` **eventCreationMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:6112](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6112)

---

<a name="interface-iencreactionmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncReactionMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IEncReactionMessage)

Defined in: [WAProto/index.d.ts:6131](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6131)

## Properties[​](#properties "Direct link to Properties")

### encIv?[​](#enciv "Direct link to encIv?")

> `optional` **encIv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6134](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6134)

* * *

### encPayload?[​](#encpayload "Direct link to encPayload?")

> `optional` **encPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6133](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6133)

* * *

### targetMessageKey?[​](#targetmessagekey "Direct link to targetMessageKey?")

> `optional` **targetMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:6132](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6132)

---

<a name="interface-ieventmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventMessage)

Defined in: [WAProto/index.d.ts:6151](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6151)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:6152](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6152)

* * *

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:6155](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6155)

* * *

### endTime?[​](#endtime "Direct link to endTime?")

> `optional` **endTime**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6159](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6159)

* * *

### extraGuestsAllowed?[​](#extraguestsallowed "Direct link to extraGuestsAllowed?")

> `optional` **extraGuestsAllowed**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6160](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6160)

* * *

### hasReminder?[​](#hasreminder "Direct link to hasReminder?")

> `optional` **hasReminder**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6162](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6162)

* * *

### isCanceled?[​](#iscanceled "Direct link to isCanceled?")

> `optional` **isCanceled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6153](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6153)

* * *

### isScheduleCall?[​](#isschedulecall "Direct link to isScheduleCall?")

> `optional` **isScheduleCall**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6161](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6161)

* * *

### joinLink?[​](#joinlink "Direct link to joinLink?")

> `optional` **joinLink**: `null` | `string`

Defined in: [WAProto/index.d.ts:6157](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6157)

* * *

### location?[​](#location "Direct link to location?")

> `optional` **location**: `null` | [`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage)

Defined in: [WAProto/index.d.ts:6156](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6156)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:6154](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6154)

* * *

### reminderOffsetSec?[​](#reminderoffsetsec "Direct link to reminderOffsetSec?")

> `optional` **reminderOffsetSec**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6163](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6163)

* * *

### startTime?[​](#starttime "Direct link to startTime?")

> `optional` **startTime**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6158](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6158)

---

<a name="interface-ieventresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventResponseMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IEventResponseMessage)

Defined in: [WAProto/index.d.ts:6189](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6189)

## Properties[​](#properties "Direct link to Properties")

### extraGuestCount?[​](#extraguestcount "Direct link to extraGuestCount?")

> `optional` **extraGuestCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:6192](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6192)

* * *

### response?[​](#response "Direct link to response?")

> `optional` **response**: `null` | [`EventResponseType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/EventResponseMessage/enumerations/EventResponseType)

Defined in: [WAProto/index.d.ts:6190](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6190)

* * *

### timestampMs?[​](#timestampms "Direct link to timestampMs?")

> `optional` **timestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6191](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6191)

---

<a name="interface-iextendedtextmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage)

Defined in: [WAProto/index.d.ts:6219](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6219)

## Properties[​](#properties "Direct link to Properties")

### backgroundArgb?[​](#backgroundargb "Direct link to backgroundArgb?")

> `optional` **backgroundArgb**: `null` | `number`

Defined in: [WAProto/index.d.ts:6225](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6225)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:6229](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6229)

* * *

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:6222](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6222)

* * *

### doNotPlayInline?[​](#donotplayinline "Direct link to doNotPlayInline?")

> `optional` **doNotPlayInline**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6230](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6230)

* * *

### endCardTiles?[​](#endcardtiles "Direct link to endCardTiles?")

> `optional` **endCardTiles**: `null` | [`IVideoEndCard`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoEndCard)\[\]

Defined in: [WAProto/index.d.ts:6248](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6248)

* * *

### faviconMMSMetadata?[​](#faviconmmsmetadata "Direct link to faviconMMSMetadata?")

> `optional` **faviconMMSMetadata**: `null` | [`IMMSThumbnailMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata)

Defined in: [WAProto/index.d.ts:6245](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6245)

* * *

### font?[​](#font "Direct link to font?")

> `optional` **font**: `null` | [`FontType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ExtendedTextMessage/enumerations/FontType)

Defined in: [WAProto/index.d.ts:6226](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6226)

* * *

### inviteLinkGroupType?[​](#invitelinkgrouptype "Direct link to inviteLinkGroupType?")

> `optional` **inviteLinkGroupType**: `null` | [`InviteLinkGroupType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ExtendedTextMessage/enumerations/InviteLinkGroupType)

Defined in: [WAProto/index.d.ts:6238](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6238)

* * *

### inviteLinkGroupTypeV2?[​](#invitelinkgrouptypev2 "Direct link to inviteLinkGroupTypeV2?")

> `optional` **inviteLinkGroupTypeV2**: `null` | [`InviteLinkGroupType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ExtendedTextMessage/enumerations/InviteLinkGroupType)

Defined in: [WAProto/index.d.ts:6241](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6241)

* * *

### inviteLinkParentGroupSubjectV2?[​](#invitelinkparentgroupsubjectv2 "Direct link to inviteLinkParentGroupSubjectV2?")

> `optional` **inviteLinkParentGroupSubjectV2**: `null` | `string`

Defined in: [WAProto/index.d.ts:6239](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6239)

* * *

### inviteLinkParentGroupThumbnailV2?[​](#invitelinkparentgroupthumbnailv2 "Direct link to inviteLinkParentGroupThumbnailV2?")

> `optional` **inviteLinkParentGroupThumbnailV2**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6240](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6240)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6228](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6228)

* * *

### linkPreviewMetadata?[​](#linkpreviewmetadata "Direct link to linkPreviewMetadata?")

> `optional` **linkPreviewMetadata**: `null` | [`ILinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata)

Defined in: [WAProto/index.d.ts:6246](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6246)

* * *

### matchedText?[​](#matchedtext "Direct link to matchedText?")

> `optional` **matchedText**: `null` | `string`

Defined in: [WAProto/index.d.ts:6221](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6221)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6234](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6234)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6235](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6235)

* * *

### musicMetadata?[​](#musicmetadata "Direct link to musicMetadata?")

> `optional` **musicMetadata**: `null` | [`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic)

Defined in: [WAProto/index.d.ts:6250](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6250)

* * *

### paymentExtendedMetadata?[​](#paymentextendedmetadata "Direct link to paymentExtendedMetadata?")

> `optional` **paymentExtendedMetadata**: `null` | [`IPaymentExtendedMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentExtendedMetadata)

Defined in: [WAProto/index.d.ts:6251](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6251)

* * *

### paymentLinkMetadata?[​](#paymentlinkmetadata "Direct link to paymentLinkMetadata?")

> `optional` **paymentLinkMetadata**: `null` | [`IPaymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentLinkMetadata)

Defined in: [WAProto/index.d.ts:6247](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6247)

* * *

### previewType?[​](#previewtype "Direct link to previewType?")

> `optional` **previewType**: `null` | [`PreviewType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ExtendedTextMessage/enumerations/PreviewType)

Defined in: [WAProto/index.d.ts:6227](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6227)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:6220](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6220)

* * *

### textArgb?[​](#textargb "Direct link to textArgb?")

> `optional` **textArgb**: `null` | `number`

Defined in: [WAProto/index.d.ts:6224](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6224)

* * *

### thumbnailDirectPath?[​](#thumbnaildirectpath "Direct link to thumbnailDirectPath?")

> `optional` **thumbnailDirectPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:6231](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6231)

* * *

### thumbnailEncSha256?[​](#thumbnailencsha256 "Direct link to thumbnailEncSha256?")

> `optional` **thumbnailEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6233](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6233)

* * *

### thumbnailHeight?[​](#thumbnailheight "Direct link to thumbnailHeight?")

> `optional` **thumbnailHeight**: `null` | `number`

Defined in: [WAProto/index.d.ts:6236](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6236)

* * *

### thumbnailSha256?[​](#thumbnailsha256 "Direct link to thumbnailSha256?")

> `optional` **thumbnailSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6232](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6232)

* * *

### thumbnailWidth?[​](#thumbnailwidth "Direct link to thumbnailWidth?")

> `optional` **thumbnailWidth**: `null` | `number`

Defined in: [WAProto/index.d.ts:6237](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6237)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:6223](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6223)

* * *

### videoContentUrl?[​](#videocontenturl "Direct link to videoContentUrl?")

> `optional` **videoContentUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:6249](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6249)

* * *

### videoHeight?[​](#videoheight "Direct link to videoHeight?")

> `optional` **videoHeight**: `null` | `number`

Defined in: [WAProto/index.d.ts:6243](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6243)

* * *

### videoWidth?[​](#videowidth "Direct link to videoWidth?")

> `optional` **videoWidth**: `null` | `number`

Defined in: [WAProto/index.d.ts:6244](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6244)

* * *

### viewOnce?[​](#viewonce "Direct link to viewOnce?")

> `optional` **viewOnce**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6242](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6242)

---

<a name="interface-ifullhistorysyncondemandrequestmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IFullHistorySyncOnDemandRequestMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IFullHistorySyncOnDemandRequestMetadata)

Defined in: [WAProto/index.d.ts:6327](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6327)

## Properties[​](#properties "Direct link to Properties")

### requestId?[​](#requestid "Direct link to requestId?")

> `optional` **requestId**: `null` | `string`

Defined in: [WAProto/index.d.ts:6328](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6328)

---

<a name="interface-ifutureproofmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IFutureProofMessage)

Defined in: [WAProto/index.d.ts:6343](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6343)

## Properties[​](#properties "Direct link to Properties")

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:6344](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6344)

---

<a name="interface-igroupinvitemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IGroupInviteMessage)

Defined in: [WAProto/index.d.ts:6359](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6359)

## Properties[​](#properties "Direct link to Properties")

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:6365](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6365)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:6366](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6366)

* * *

### groupJid?[​](#groupjid "Direct link to groupJid?")

> `optional` **groupJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:6360](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6360)

* * *

### groupName?[​](#groupname "Direct link to groupName?")

> `optional` **groupName**: `null` | `string`

Defined in: [WAProto/index.d.ts:6363](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6363)

* * *

### groupType?[​](#grouptype "Direct link to groupType?")

> `optional` **groupType**: `null` | [`GroupType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/GroupInviteMessage/enumerations/GroupType)

Defined in: [WAProto/index.d.ts:6367](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6367)

* * *

### inviteCode?[​](#invitecode "Direct link to inviteCode?")

> `optional` **inviteCode**: `null` | `string`

Defined in: [WAProto/index.d.ts:6361](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6361)

* * *

### inviteExpiration?[​](#inviteexpiration "Direct link to inviteExpiration?")

> `optional` **inviteExpiration**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6362](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6362)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6364](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6364)

---

<a name="interface-ihighlystructuredmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:6397](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6397)

## Properties[​](#properties "Direct link to Properties")

### deterministicLc?[​](#deterministiclc "Direct link to deterministicLc?")

> `optional` **deterministicLc**: `null` | `string`

Defined in: [WAProto/index.d.ts:6405](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6405)

* * *

### deterministicLg?[​](#deterministiclg "Direct link to deterministicLg?")

> `optional` **deterministicLg**: `null` | `string`

Defined in: [WAProto/index.d.ts:6404](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6404)

* * *

### elementName?[​](#elementname "Direct link to elementName?")

> `optional` **elementName**: `null` | `string`

Defined in: [WAProto/index.d.ts:6399](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6399)

* * *

### fallbackLc?[​](#fallbacklc "Direct link to fallbackLc?")

> `optional` **fallbackLc**: `null` | `string`

Defined in: [WAProto/index.d.ts:6402](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6402)

* * *

### fallbackLg?[​](#fallbacklg "Direct link to fallbackLg?")

> `optional` **fallbackLg**: `null` | `string`

Defined in: [WAProto/index.d.ts:6401](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6401)

* * *

### hydratedHsm?[​](#hydratedhsm "Direct link to hydratedHsm?")

> `optional` **hydratedHsm**: `null` | [`ITemplateMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage)

Defined in: [WAProto/index.d.ts:6406](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6406)

* * *

### localizableParams?[​](#localizableparams "Direct link to localizableParams?")

> `optional` **localizableParams**: `null` | [`IHSMLocalizableParameter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/interfaces/IHSMLocalizableParameter)\[\]

Defined in: [WAProto/index.d.ts:6403](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6403)

* * *

### namespace?[​](#namespace "Direct link to namespace?")

> `optional` **namespace**: `null` | `string`

Defined in: [WAProto/index.d.ts:6398](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6398)

* * *

### params?[​](#params "Direct link to params?")

> `optional` **params**: `null` | `string`\[\]

Defined in: [WAProto/index.d.ts:6400](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6400)

---

<a name="interface-ihistorysyncmessageaccessstatus"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncMessageAccessStatus](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncMessageAccessStatus)

Defined in: [WAProto/index.d.ts:6558](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6558)

## Properties[​](#properties "Direct link to Properties")

### completeAccessGranted?[​](#completeaccessgranted "Direct link to completeAccessGranted?")

> `optional` **completeAccessGranted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6559](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6559)

---

<a name="interface-ihistorysyncnotification"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification)

Defined in: [WAProto/index.d.ts:6574](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6574)

## Properties[​](#properties "Direct link to Properties")

### chunkOrder?[​](#chunkorder "Direct link to chunkOrder?")

> `optional` **chunkOrder**: `null` | `number`

Defined in: [WAProto/index.d.ts:6581](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6581)

* * *

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:6579](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6579)

* * *

### encHandle?[​](#enchandle "Direct link to encHandle?")

> `optional` **encHandle**: `null` | `string`

Defined in: [WAProto/index.d.ts:6588](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6588)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6578](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6578)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6576](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6576)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6575](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6575)

* * *

### fullHistorySyncOnDemandRequestMetadata?[​](#fullhistorysyncondemandrequestmetadata "Direct link to fullHistorySyncOnDemandRequestMetadata?")

> `optional` **fullHistorySyncOnDemandRequestMetadata**: `null` | [`IFullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFullHistorySyncOnDemandRequestMetadata)

Defined in: [WAProto/index.d.ts:6587](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6587)

* * *

### initialHistBootstrapInlinePayload?[​](#initialhistbootstrapinlinepayload "Direct link to initialHistBootstrapInlinePayload?")

> `optional` **initialHistBootstrapInlinePayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6585](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6585)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6577](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6577)

* * *

### messageAccessStatus?[​](#messageaccessstatus "Direct link to messageAccessStatus?")

> `optional` **messageAccessStatus**: `null` | [`IHistorySyncMessageAccessStatus`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncMessageAccessStatus)

Defined in: [WAProto/index.d.ts:6589](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6589)

* * *

### oldestMsgInChunkTimestampSec?[​](#oldestmsginchunktimestampsec "Direct link to oldestMsgInChunkTimestampSec?")

> `optional` **oldestMsgInChunkTimestampSec**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6584](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6584)

* * *

### originalMessageId?[​](#originalmessageid "Direct link to originalMessageId?")

> `optional` **originalMessageId**: `null` | `string`

Defined in: [WAProto/index.d.ts:6582](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6582)

* * *

### peerDataRequestSessionId?[​](#peerdatarequestsessionid "Direct link to peerDataRequestSessionId?")

> `optional` **peerDataRequestSessionId**: `null` | `string`

Defined in: [WAProto/index.d.ts:6586](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6586)

* * *

### progress?[​](#progress "Direct link to progress?")

> `optional` **progress**: `null` | `number`

Defined in: [WAProto/index.d.ts:6583](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6583)

* * *

### syncType?[​](#synctype "Direct link to syncType?")

> `optional` **syncType**: `null` | [`HistorySyncType`](/docs/api/namespaces/proto/namespaces/Message/enumerations/HistorySyncType)

Defined in: [WAProto/index.d.ts:6580](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6580)

---

<a name="interface-iimagemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage)

Defined in: [WAProto/index.d.ts:6630](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6630)

## Properties[​](#properties "Direct link to Properties")

### accessibilityLabel?[​](#accessibilitylabel "Direct link to accessibilityLabel?")

> `optional` **accessibilityLabel**: `null` | `string`

Defined in: [WAProto/index.d.ts:6659](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6659)

* * *

### annotations?[​](#annotations "Direct link to annotations?")

> `optional` **annotations**: `null` | [`IInteractiveAnnotation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation)\[\]

Defined in: [WAProto/index.d.ts:6657](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6657)

* * *

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:6633](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6633)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:6644](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6644)

* * *

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:6641](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6641)

* * *

### experimentGroupId?[​](#experimentgroupid "Direct link to experimentGroupId?")

> `optional` **experimentGroupId**: `null` | `number`

Defined in: [WAProto/index.d.ts:6647](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6647)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6639](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6639)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6635](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6635)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6634](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6634)

* * *

### firstScanLength?[​](#firstscanlength "Direct link to firstScanLength?")

> `optional` **firstScanLength**: `null` | `number`

Defined in: [WAProto/index.d.ts:6646](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6646)

* * *

### firstScanSidecar?[​](#firstscansidecar "Direct link to firstScanSidecar?")

> `optional` **firstScanSidecar**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6645](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6645)

* * *

### height?[​](#height "Direct link to height?")

> `optional` **height**: `null` | `number`

Defined in: [WAProto/index.d.ts:6636](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6636)

* * *

### imageSourceType?[​](#imagesourcetype "Direct link to imageSourceType?")

> `optional` **imageSourceType**: `null` | [`ImageSourceType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ImageMessage/enumerations/ImageSourceType)

Defined in: [WAProto/index.d.ts:6658](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6658)

* * *

### interactiveAnnotations?[​](#interactiveannotations "Direct link to interactiveAnnotations?")

> `optional` **interactiveAnnotations**: `null` | [`IInteractiveAnnotation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation)\[\]

Defined in: [WAProto/index.d.ts:6640](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6640)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6643](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6643)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6638](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6638)

* * *

### mediaKeyDomain?[​](#mediakeydomain "Direct link to mediaKeyDomain?")

> `optional` **mediaKeyDomain**: `null` | [`MediaKeyDomain`](/docs/api/namespaces/proto/namespaces/Message/enumerations/MediaKeyDomain)

Defined in: [WAProto/index.d.ts:6660](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6660)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6642](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6642)

* * *

### midQualityFileEncSha256?[​](#midqualityfileencsha256 "Direct link to midQualityFileEncSha256?")

> `optional` **midQualityFileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6651](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6651)

* * *

### midQualityFileSha256?[​](#midqualityfilesha256 "Direct link to midQualityFileSha256?")

> `optional` **midQualityFileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6650](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6650)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:6632](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6632)

* * *

### qrUrl?[​](#qrurl "Direct link to qrUrl?")

> `optional` **qrUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:6661](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6661)

* * *

### scanLengths?[​](#scanlengths "Direct link to scanLengths?")

> `optional` **scanLengths**: `null` | `number`\[\]

Defined in: [WAProto/index.d.ts:6649](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6649)

* * *

### scansSidecar?[​](#scanssidecar "Direct link to scansSidecar?")

> `optional` **scansSidecar**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6648](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6648)

* * *

### staticUrl?[​](#staticurl "Direct link to staticUrl?")

> `optional` **staticUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:6656](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6656)

* * *

### thumbnailDirectPath?[​](#thumbnaildirectpath "Direct link to thumbnailDirectPath?")

> `optional` **thumbnailDirectPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:6653](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6653)

* * *

### thumbnailEncSha256?[​](#thumbnailencsha256 "Direct link to thumbnailEncSha256?")

> `optional` **thumbnailEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6655](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6655)

* * *

### thumbnailSha256?[​](#thumbnailsha256 "Direct link to thumbnailSha256?")

> `optional` **thumbnailSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6654](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6654)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:6631](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6631)

* * *

### viewOnce?[​](#viewonce "Direct link to viewOnce?")

> `optional` **viewOnce**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6652](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6652)

* * *

### width?[​](#width "Direct link to width?")

> `optional` **width**: `null` | `number`

Defined in: [WAProto/index.d.ts:6637](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6637)

---

<a name="interface-iinitialsecuritynotificationsettingsync"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IInitialSecurityNotificationSettingSync](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IInitialSecurityNotificationSettingSync)

Defined in: [WAProto/index.d.ts:6716](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6716)

## Properties[​](#properties "Direct link to Properties")

### securityNotificationEnabled?[​](#securitynotificationenabled "Direct link to securityNotificationEnabled?")

> `optional` **securityNotificationEnabled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6717](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6717)

---

<a name="interface-iinteractivemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage)

Defined in: [WAProto/index.d.ts:6732](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6732)

## Properties[​](#properties "Direct link to Properties")

### body?[​](#body "Direct link to body?")

> `optional` **body**: `null` | [`IBody`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IBody)

Defined in: [WAProto/index.d.ts:6734](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6734)

* * *

### carouselMessage?[​](#carouselmessage "Direct link to carouselMessage?")

> `optional` **carouselMessage**: `null` | [`ICarouselMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICarouselMessage)

Defined in: [WAProto/index.d.ts:6741](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6741)

* * *

### collectionMessage?[​](#collectionmessage "Direct link to collectionMessage?")

> `optional` **collectionMessage**: `null` | [`ICollectionMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICollectionMessage)

Defined in: [WAProto/index.d.ts:6739](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6739)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:6736](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6736)

* * *

### footer?[​](#footer "Direct link to footer?")

> `optional` **footer**: `null` | [`IFooter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IFooter)

Defined in: [WAProto/index.d.ts:6735](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6735)

* * *

### header?[​](#header "Direct link to header?")

> `optional` **header**: `null` | [`IHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader)

Defined in: [WAProto/index.d.ts:6733](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6733)

* * *

### nativeFlowMessage?[​](#nativeflowmessage "Direct link to nativeFlowMessage?")

> `optional` **nativeFlowMessage**: `null` | [`INativeFlowMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/INativeFlowMessage)

Defined in: [WAProto/index.d.ts:6740](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6740)

* * *

### shopStorefrontMessage?[​](#shopstorefrontmessage "Direct link to shopStorefrontMessage?")

> `optional` **shopStorefrontMessage**: `null` | [`IShopMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IShopMessage)

Defined in: [WAProto/index.d.ts:6738](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6738)

* * *

### urlTrackingMap?[​](#urltrackingmap "Direct link to urlTrackingMap?")

> `optional` **urlTrackingMap**: `null` | [`IUrlTrackingMap`](/docs/api/namespaces/proto/interfaces/IUrlTrackingMap)

Defined in: [WAProto/index.d.ts:6737](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6737)

---

<a name="interface-iinteractiveresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveResponseMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveResponseMessage)

Defined in: [WAProto/index.d.ts:6958](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6958)

## Properties[​](#properties "Direct link to Properties")

### body?[​](#body "Direct link to body?")

> `optional` **body**: `null` | [`IBody`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/IBody)

Defined in: [WAProto/index.d.ts:6959](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6959)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:6960](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6960)

* * *

### nativeFlowResponseMessage?[​](#nativeflowresponsemessage "Direct link to nativeFlowResponseMessage?")

> `optional` **nativeFlowResponseMessage**: `null` | [`INativeFlowResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/INativeFlowResponseMessage)

Defined in: [WAProto/index.d.ts:6961](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6961)

---

<a name="interface-iinvoicemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IInvoiceMessage)

Defined in: [WAProto/index.d.ts:7028](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7028)

## Properties[​](#properties "Direct link to Properties")

### attachmentDirectPath?[​](#attachmentdirectpath "Direct link to attachmentDirectPath?")

> `optional` **attachmentDirectPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:7037](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7037)

* * *

### attachmentFileEncSha256?[​](#attachmentfileencsha256 "Direct link to attachmentFileEncSha256?")

> `optional` **attachmentFileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7036](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7036)

* * *

### attachmentFileSha256?[​](#attachmentfilesha256 "Direct link to attachmentFileSha256?")

> `optional` **attachmentFileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7035](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7035)

* * *

### attachmentJpegThumbnail?[​](#attachmentjpegthumbnail "Direct link to attachmentJpegThumbnail?")

> `optional` **attachmentJpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7038](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7038)

* * *

### attachmentMediaKey?[​](#attachmentmediakey "Direct link to attachmentMediaKey?")

> `optional` **attachmentMediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7033](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7033)

* * *

### attachmentMediaKeyTimestamp?[​](#attachmentmediakeytimestamp "Direct link to attachmentMediaKeyTimestamp?")

> `optional` **attachmentMediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7034](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7034)

* * *

### attachmentMimetype?[​](#attachmentmimetype "Direct link to attachmentMimetype?")

> `optional` **attachmentMimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:7032](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7032)

* * *

### attachmentType?[​](#attachmenttype "Direct link to attachmentType?")

> `optional` **attachmentType**: `null` | [`AttachmentType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InvoiceMessage/enumerations/AttachmentType)

Defined in: [WAProto/index.d.ts:7031](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7031)

* * *

### note?[​](#note "Direct link to note?")

> `optional` **note**: `null` | `string`

Defined in: [WAProto/index.d.ts:7029](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7029)

* * *

### token?[​](#token "Direct link to token?")

> `optional` **token**: `null` | `string`

Defined in: [WAProto/index.d.ts:7030](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7030)

---

<a name="interface-ikeepinchatmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IKeepInChatMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IKeepInChatMessage)

Defined in: [WAProto/index.d.ts:7070](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7070)

## Properties[​](#properties "Direct link to Properties")

### keepType?[​](#keeptype "Direct link to keepType?")

> `optional` **keepType**: `null` | [`KeepType`](/docs/api/namespaces/proto/enumerations/KeepType)

Defined in: [WAProto/index.d.ts:7072](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7072)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:7071](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7071)

* * *

### timestampMs?[​](#timestampms "Direct link to timestampMs?")

> `optional` **timestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7073](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7073)

---

<a name="interface-ilinkpreviewmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ILinkPreviewMetadata)

Defined in: [WAProto/index.d.ts:7090](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7090)

## Properties[​](#properties "Direct link to Properties")

### fbExperimentId?[​](#fbexperimentid "Direct link to fbExperimentId?")

> `optional` **fbExperimentId**: `null` | `number`

Defined in: [WAProto/index.d.ts:7093](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7093)

* * *

### linkInlineVideoMuted?[​](#linkinlinevideomuted "Direct link to linkInlineVideoMuted?")

> `optional` **linkInlineVideoMuted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:7096](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7096)

* * *

### linkMediaDuration?[​](#linkmediaduration "Direct link to linkMediaDuration?")

> `optional` **linkMediaDuration**: `null` | `number`

Defined in: [WAProto/index.d.ts:7094](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7094)

* * *

### musicMetadata?[​](#musicmetadata "Direct link to musicMetadata?")

> `optional` **musicMetadata**: `null` | [`IEmbeddedMusic`](/docs/api/namespaces/proto/interfaces/IEmbeddedMusic)

Defined in: [WAProto/index.d.ts:7098](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7098)

* * *

### paymentLinkMetadata?[​](#paymentlinkmetadata "Direct link to paymentLinkMetadata?")

> `optional` **paymentLinkMetadata**: `null` | [`IPaymentLinkMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentLinkMetadata)

Defined in: [WAProto/index.d.ts:7091](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7091)

* * *

### socialMediaPostType?[​](#socialmediaposttype "Direct link to socialMediaPostType?")

> `optional` **socialMediaPostType**: `null` | [`SocialMediaPostType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/LinkPreviewMetadata/enumerations/SocialMediaPostType)

Defined in: [WAProto/index.d.ts:7095](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7095)

* * *

### urlMetadata?[​](#urlmetadata "Direct link to urlMetadata?")

> `optional` **urlMetadata**: `null` | [`IURLMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IURLMetadata)

Defined in: [WAProto/index.d.ts:7092](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7092)

* * *

### videoContentCaption?[​](#videocontentcaption "Direct link to videoContentCaption?")

> `optional` **videoContentCaption**: `null` | `string`

Defined in: [WAProto/index.d.ts:7099](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7099)

* * *

### videoContentUrl?[​](#videocontenturl "Direct link to videoContentUrl?")

> `optional` **videoContentUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:7097](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7097)

---

<a name="interface-ilistmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IListMessage)

Defined in: [WAProto/index.d.ts:7134](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7134)

## Properties[​](#properties "Direct link to Properties")

### buttonText?[​](#buttontext "Direct link to buttonText?")

> `optional` **buttonText**: `null` | `string`

Defined in: [WAProto/index.d.ts:7137](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7137)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:7142](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7142)

* * *

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:7136](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7136)

* * *

### footerText?[​](#footertext "Direct link to footerText?")

> `optional` **footerText**: `null` | `string`

Defined in: [WAProto/index.d.ts:7141](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7141)

* * *

### listType?[​](#listtype "Direct link to listType?")

> `optional` **listType**: `null` | [`ListType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/enumerations/ListType)

Defined in: [WAProto/index.d.ts:7138](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7138)

* * *

### productListInfo?[​](#productlistinfo "Direct link to productListInfo?")

> `optional` **productListInfo**: `null` | [`IProductListInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListInfo)

Defined in: [WAProto/index.d.ts:7140](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7140)

* * *

### sections?[​](#sections "Direct link to sections?")

> `optional` **sections**: `null` | [`ISection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/ISection)\[\]

Defined in: [WAProto/index.d.ts:7139](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7139)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:7135](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7135)

---

<a name="interface-ilistresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IListResponseMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IListResponseMessage)

Defined in: [WAProto/index.d.ts:7283](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7283)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:7287](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7287)

* * *

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:7288](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7288)

* * *

### listType?[​](#listtype "Direct link to listType?")

> `optional` **listType**: `null` | [`ListType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/enumerations/ListType)

Defined in: [WAProto/index.d.ts:7285](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7285)

* * *

### singleSelectReply?[​](#singleselectreply "Direct link to singleSelectReply?")

> `optional` **singleSelectReply**: `null` | [`ISingleSelectReply`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/interfaces/ISingleSelectReply)

Defined in: [WAProto/index.d.ts:7286](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7286)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:7284](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7284)

---

<a name="interface-ilivelocationmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ILiveLocationMessage)

Defined in: [WAProto/index.d.ts:7331](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7331)

## Properties[​](#properties "Direct link to Properties")

### accuracyInMeters?[​](#accuracyinmeters "Direct link to accuracyInMeters?")

> `optional` **accuracyInMeters**: `null` | `number`

Defined in: [WAProto/index.d.ts:7334](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7334)

* * *

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:7337](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7337)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:7341](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7341)

* * *

### degreesClockwiseFromMagneticNorth?[​](#degreesclockwisefrommagneticnorth "Direct link to degreesClockwiseFromMagneticNorth?")

> `optional` **degreesClockwiseFromMagneticNorth**: `null` | `number`

Defined in: [WAProto/index.d.ts:7336](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7336)

* * *

### degreesLatitude?[​](#degreeslatitude "Direct link to degreesLatitude?")

> `optional` **degreesLatitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:7332](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7332)

* * *

### degreesLongitude?[​](#degreeslongitude "Direct link to degreesLongitude?")

> `optional` **degreesLongitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:7333](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7333)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7340](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7340)

* * *

### sequenceNumber?[​](#sequencenumber "Direct link to sequenceNumber?")

> `optional` **sequenceNumber**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7338](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7338)

* * *

### speedInMps?[​](#speedinmps "Direct link to speedInMps?")

> `optional` **speedInMps**: `null` | `number`

Defined in: [WAProto/index.d.ts:7335](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7335)

* * *

### timeOffset?[​](#timeoffset "Direct link to timeOffset?")

> `optional` **timeOffset**: `null` | `number`

Defined in: [WAProto/index.d.ts:7339](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7339)

---

<a name="interface-ilocationmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage)

Defined in: [WAProto/index.d.ts:7365](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7365)

## Properties[​](#properties "Direct link to Properties")

### accuracyInMeters?[​](#accuracyinmeters "Direct link to accuracyInMeters?")

> `optional` **accuracyInMeters**: `null` | `number`

Defined in: [WAProto/index.d.ts:7372](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7372)

* * *

### address?[​](#address "Direct link to address?")

> `optional` **address**: `null` | `string`

Defined in: [WAProto/index.d.ts:7369](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7369)

* * *

### comment?[​](#comment "Direct link to comment?")

> `optional` **comment**: `null` | `string`

Defined in: [WAProto/index.d.ts:7375](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7375)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:7377](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7377)

* * *

### degreesClockwiseFromMagneticNorth?[​](#degreesclockwisefrommagneticnorth "Direct link to degreesClockwiseFromMagneticNorth?")

> `optional` **degreesClockwiseFromMagneticNorth**: `null` | `number`

Defined in: [WAProto/index.d.ts:7374](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7374)

* * *

### degreesLatitude?[​](#degreeslatitude "Direct link to degreesLatitude?")

> `optional` **degreesLatitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:7366](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7366)

* * *

### degreesLongitude?[​](#degreeslongitude "Direct link to degreesLongitude?")

> `optional` **degreesLongitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:7367](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7367)

* * *

### isLive?[​](#islive "Direct link to isLive?")

> `optional` **isLive**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:7371](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7371)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7376](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7376)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:7368](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7368)

* * *

### speedInMps?[​](#speedinmps "Direct link to speedInMps?")

> `optional` **speedInMps**: `null` | `number`

Defined in: [WAProto/index.d.ts:7373](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7373)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:7370](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7370)

---

<a name="interface-immsthumbnailmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IMMSThumbnailMetadata)

Defined in: [WAProto/index.d.ts:7403](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7403)

## Properties[​](#properties "Direct link to Properties")

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7407](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7407)

* * *

### mediaKeyDomain?[​](#mediakeydomain "Direct link to mediaKeyDomain?")

> `optional` **mediaKeyDomain**: `null` | [`MediaKeyDomain`](/docs/api/namespaces/proto/namespaces/Message/enumerations/MediaKeyDomain)

Defined in: [WAProto/index.d.ts:7411](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7411)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7408](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7408)

* * *

### thumbnailDirectPath?[​](#thumbnaildirectpath "Direct link to thumbnailDirectPath?")

> `optional` **thumbnailDirectPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:7404](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7404)

* * *

### thumbnailEncSha256?[​](#thumbnailencsha256 "Direct link to thumbnailEncSha256?")

> `optional` **thumbnailEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7406](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7406)

* * *

### thumbnailHeight?[​](#thumbnailheight "Direct link to thumbnailHeight?")

> `optional` **thumbnailHeight**: `null` | `number`

Defined in: [WAProto/index.d.ts:7409](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7409)

* * *

### thumbnailSha256?[​](#thumbnailsha256 "Direct link to thumbnailSha256?")

> `optional` **thumbnailSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7405](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7405)

* * *

### thumbnailWidth?[​](#thumbnailwidth "Direct link to thumbnailWidth?")

> `optional` **thumbnailWidth**: `null` | `number`

Defined in: [WAProto/index.d.ts:7410](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7410)

---

<a name="interface-imessagehistorybundle"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryBundle)

Defined in: [WAProto/index.d.ts:7441](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7441)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:7448](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7448)

* * *

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:7446](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7446)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7445](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7445)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7443](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7443)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7444](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7444)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7447](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7447)

* * *

### messageHistoryMetadata?[​](#messagehistorymetadata "Direct link to messageHistoryMetadata?")

> `optional` **messageHistoryMetadata**: `null` | [`IMessageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryMetadata)

Defined in: [WAProto/index.d.ts:7449](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7449)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:7442](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7442)

---

<a name="interface-imessagehistorymetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryMetadata)

Defined in: [WAProto/index.d.ts:7471](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7471)

## Properties[​](#properties "Direct link to Properties")

### historyReceivers?[​](#historyreceivers "Direct link to historyReceivers?")

> `optional` **historyReceivers**: `null` | `string`\[\]

Defined in: [WAProto/index.d.ts:7472](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7472)

* * *

### messageCount?[​](#messagecount "Direct link to messageCount?")

> `optional` **messageCount**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7474](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7474)

* * *

### oldestMessageTimestamp?[​](#oldestmessagetimestamp "Direct link to oldestMessageTimestamp?")

> `optional` **oldestMessageTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7473](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7473)

---

<a name="interface-imessagehistorynotice"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryNotice](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryNotice)

Defined in: [WAProto/index.d.ts:7491](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7491)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:7492](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7492)

* * *

### messageHistoryMetadata?[​](#messagehistorymetadata "Direct link to messageHistoryMetadata?")

> `optional` **messageHistoryMetadata**: `null` | [`IMessageHistoryMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IMessageHistoryMetadata)

Defined in: [WAProto/index.d.ts:7493](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7493)

---

<a name="interface-inewsletteradmininvitemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterAdminInviteMessage)

Defined in: [WAProto/index.d.ts:7509](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7509)

## Properties[​](#properties "Direct link to Properties")

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:7513](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7513)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:7515](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7515)

* * *

### inviteExpiration?[​](#inviteexpiration "Direct link to inviteExpiration?")

> `optional` **inviteExpiration**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7514](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7514)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7512](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7512)

* * *

### newsletterJid?[​](#newsletterjid "Direct link to newsletterJid?")

> `optional` **newsletterJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:7510](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7510)

* * *

### newsletterName?[​](#newslettername "Direct link to newsletterName?")

> `optional` **newsletterName**: `null` | `string`

Defined in: [WAProto/index.d.ts:7511](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7511)

---

<a name="interface-inewsletterfollowerinvitemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterFollowerInviteMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/INewsletterFollowerInviteMessage)

Defined in: [WAProto/index.d.ts:7535](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7535)

## Properties[​](#properties "Direct link to Properties")

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:7539](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7539)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:7540](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7540)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7538](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7538)

* * *

### newsletterJid?[​](#newsletterjid "Direct link to newsletterJid?")

> `optional` **newsletterJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:7536](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7536)

* * *

### newsletterName?[​](#newslettername "Direct link to newsletterName?")

> `optional` **newsletterName**: `null` | `string`

Defined in: [WAProto/index.d.ts:7537](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7537)

---

<a name="interface-iordermessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IOrderMessage)

Defined in: [WAProto/index.d.ts:7559](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7559)

## Properties[​](#properties "Direct link to Properties")

### catalogType?[​](#catalogtype "Direct link to catalogType?")

> `optional` **catalogType**: `null` | `string`

Defined in: [WAProto/index.d.ts:7574](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7574)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:7571](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7571)

* * *

### itemCount?[​](#itemcount "Direct link to itemCount?")

> `optional` **itemCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:7562](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7562)

* * *

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | `string`

Defined in: [WAProto/index.d.ts:7565](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7565)

* * *

### messageVersion?[​](#messageversion "Direct link to messageVersion?")

> `optional` **messageVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:7572](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7572)

* * *

### orderId?[​](#orderid "Direct link to orderId?")

> `optional` **orderId**: `null` | `string`

Defined in: [WAProto/index.d.ts:7560](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7560)

* * *

### orderRequestMessageId?[​](#orderrequestmessageid "Direct link to orderRequestMessageId?")

> `optional` **orderRequestMessageId**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:7573](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7573)

* * *

### orderTitle?[​](#ordertitle "Direct link to orderTitle?")

> `optional` **orderTitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:7566](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7566)

* * *

### sellerJid?[​](#sellerjid "Direct link to sellerJid?")

> `optional` **sellerJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:7567](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7567)

* * *

### status?[​](#status "Direct link to status?")

> `optional` **status**: `null` | [`OrderStatus`](/docs/api/namespaces/proto/namespaces/Message/namespaces/OrderMessage/enumerations/OrderStatus)

Defined in: [WAProto/index.d.ts:7563](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7563)

* * *

### surface?[​](#surface "Direct link to surface?")

> `optional` **surface**: `null` | [`CATALOG`](/docs/api/namespaces/proto/namespaces/Message/namespaces/OrderMessage/enumerations/OrderSurface#catalog)

Defined in: [WAProto/index.d.ts:7564](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7564)

* * *

### thumbnail?[​](#thumbnail "Direct link to thumbnail?")

> `optional` **thumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7561](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7561)

* * *

### token?[​](#token "Direct link to token?")

> `optional` **token**: `null` | `string`

Defined in: [WAProto/index.d.ts:7568](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7568)

* * *

### totalAmount1000?[​](#totalamount1000 "Direct link to totalAmount1000?")

> `optional` **totalAmount1000**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7569](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7569)

* * *

### totalCurrencyCode?[​](#totalcurrencycode "Direct link to totalCurrencyCode?")

> `optional` **totalCurrencyCode**: `null` | `string`

Defined in: [WAProto/index.d.ts:7570](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7570)

---

<a name="interface-ipaymentextendedmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentExtendedMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentExtendedMetadata)

Defined in: [WAProto/index.d.ts:7616](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7616)

## Properties[​](#properties "Direct link to Properties")

### messageParamsJson?[​](#messageparamsjson "Direct link to messageParamsJson?")

> `optional` **messageParamsJson**: `null` | `string`

Defined in: [WAProto/index.d.ts:7619](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7619)

* * *

### platform?[​](#platform "Direct link to platform?")

> `optional` **platform**: `null` | `string`

Defined in: [WAProto/index.d.ts:7618](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7618)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | `number`

Defined in: [WAProto/index.d.ts:7617](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7617)

---

<a name="interface-ipaymentinvitemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentInviteMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentInviteMessage)

Defined in: [WAProto/index.d.ts:7636](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7636)

## Properties[​](#properties "Direct link to Properties")

### expiryTimestamp?[​](#expirytimestamp "Direct link to expiryTimestamp?")

> `optional` **expiryTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7638](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7638)

* * *

### serviceType?[​](#servicetype "Direct link to serviceType?")

> `optional` **serviceType**: `null` | [`ServiceType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentInviteMessage/enumerations/ServiceType)

Defined in: [WAProto/index.d.ts:7637](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7637)

---

<a name="interface-ipaymentlinkmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentLinkMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPaymentLinkMetadata)

Defined in: [WAProto/index.d.ts:7664](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7664)

## Properties[​](#properties "Direct link to Properties")

### button?[​](#button "Direct link to button?")

> `optional` **button**: `null` | [`IPaymentLinkButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkButton)

Defined in: [WAProto/index.d.ts:7665](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7665)

* * *

### header?[​](#header "Direct link to header?")

> `optional` **header**: `null` | [`IPaymentLinkHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkHeader)

Defined in: [WAProto/index.d.ts:7666](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7666)

* * *

### provider?[​](#provider "Direct link to provider?")

> `optional` **provider**: `null` | [`IPaymentLinkProvider`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkProvider)

Defined in: [WAProto/index.d.ts:7667](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7667)

---

<a name="interface-ipeerdataoperationrequestmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage)

Defined in: [WAProto/index.d.ts:7743](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7743)

## Properties[​](#properties "Direct link to Properties")

### fullHistorySyncOnDemandRequest?[​](#fullhistorysyncondemandrequest "Direct link to fullHistorySyncOnDemandRequest?")

> `optional` **fullHistorySyncOnDemandRequest**: `null` | [`IFullHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IFullHistorySyncOnDemandRequest)

Defined in: [WAProto/index.d.ts:7749](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7749)

* * *

### galaxyFlowAction?[​](#galaxyflowaction "Direct link to galaxyFlowAction?")

> `optional` **galaxyFlowAction**: `null` | [`IGalaxyFlowAction`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IGalaxyFlowAction)

Defined in: [WAProto/index.d.ts:7752](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7752)

* * *

### historySyncChunkRetryRequest?[​](#historysyncchunkretryrequest "Direct link to historySyncChunkRetryRequest?")

> `optional` **historySyncChunkRetryRequest**: `null` | [`IHistorySyncChunkRetryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncChunkRetryRequest)

Defined in: [WAProto/index.d.ts:7751](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7751)

* * *

### historySyncOnDemandRequest?[​](#historysyncondemandrequest "Direct link to historySyncOnDemandRequest?")

> `optional` **historySyncOnDemandRequest**: `null` | [`IHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest)

Defined in: [WAProto/index.d.ts:7747](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7747)

* * *

### peerDataOperationRequestType?[​](#peerdataoperationrequesttype "Direct link to peerDataOperationRequestType?")

> `optional` **peerDataOperationRequestType**: `null` | [`PeerDataOperationRequestType`](/docs/api/namespaces/proto/namespaces/Message/enumerations/PeerDataOperationRequestType)

Defined in: [WAProto/index.d.ts:7744](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7744)

* * *

### placeholderMessageResendRequest?[​](#placeholdermessageresendrequest "Direct link to placeholderMessageResendRequest?")

> `optional` **placeholderMessageResendRequest**: `null` | [`IPlaceholderMessageResendRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IPlaceholderMessageResendRequest)\[\]

Defined in: [WAProto/index.d.ts:7748](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7748)

* * *

### requestStickerReupload?[​](#requeststickerreupload "Direct link to requestStickerReupload?")

> `optional` **requestStickerReupload**: `null` | [`IRequestStickerReupload`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestStickerReupload)\[\]

Defined in: [WAProto/index.d.ts:7745](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7745)

* * *

### requestUrlPreview?[​](#requesturlpreview "Direct link to requestUrlPreview?")

> `optional` **requestUrlPreview**: `null` | [`IRequestUrlPreview`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestUrlPreview)\[\]

Defined in: [WAProto/index.d.ts:7746](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7746)

* * *

### syncdCollectionFatalRecoveryRequest?[​](#syncdcollectionfatalrecoveryrequest "Direct link to syncdCollectionFatalRecoveryRequest?")

> `optional` **syncdCollectionFatalRecoveryRequest**: `null` | [`ISyncDCollectionFatalRecoveryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/ISyncDCollectionFatalRecoveryRequest)

Defined in: [WAProto/index.d.ts:7750](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7750)

---

<a name="interface-ipeerdataoperationrequestresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestResponseMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestResponseMessage)

Defined in: [WAProto/index.d.ts:7939](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7939)

## Properties[​](#properties "Direct link to Properties")

### peerDataOperationRequestType?[​](#peerdataoperationrequesttype "Direct link to peerDataOperationRequestType?")

> `optional` **peerDataOperationRequestType**: `null` | [`PeerDataOperationRequestType`](/docs/api/namespaces/proto/namespaces/Message/enumerations/PeerDataOperationRequestType)

Defined in: [WAProto/index.d.ts:7940](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7940)

* * *

### peerDataOperationResult?[​](#peerdataoperationresult "Direct link to peerDataOperationResult?")

> `optional` **peerDataOperationResult**: `null` | [`IPeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult)\[\]

Defined in: [WAProto/index.d.ts:7942](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7942)

* * *

### stanzaId?[​](#stanzaid "Direct link to stanzaId?")

> `optional` **stanzaId**: `null` | `string`

Defined in: [WAProto/index.d.ts:7941](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7941)

---

<a name="interface-ipininchatmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPinInChatMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPinInChatMessage)

Defined in: [WAProto/index.d.ts:8242](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8242)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8243](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8243)

* * *

### senderTimestampMs?[​](#sendertimestampms "Direct link to senderTimestampMs?")

> `optional` **senderTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8245](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8245)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`Type`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PinInChatMessage/enumerations/Type)

Defined in: [WAProto/index.d.ts:8244](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8244)

---

<a name="interface-iplaceholdermessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPlaceholderMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPlaceholderMessage)

Defined in: [WAProto/index.d.ts:8271](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8271)

## Properties[​](#properties "Direct link to Properties")

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`MASK_LINKED_DEVICES`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PlaceholderMessage/enumerations/PlaceholderType#mask_linked_devices)

Defined in: [WAProto/index.d.ts:8272](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8272)

---

<a name="interface-ipollcreationmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollCreationMessage)

Defined in: [WAProto/index.d.ts:8300](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8300)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:8305](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8305)

* * *

### correctAnswer?[​](#correctanswer "Direct link to correctAnswer?")

> `optional` **correctAnswer**: `null` | [`IOption`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/interfaces/IOption)

Defined in: [WAProto/index.d.ts:8308](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8308)

* * *

### encKey?[​](#enckey "Direct link to encKey?")

> `optional` **encKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8301](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8301)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:8302](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8302)

* * *

### options?[​](#options "Direct link to options?")

> `optional` **options**: `null` | [`IOption`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/interfaces/IOption)\[\]

Defined in: [WAProto/index.d.ts:8303](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8303)

* * *

### pollContentType?[​](#pollcontenttype "Direct link to pollContentType?")

> `optional` **pollContentType**: `null` | [`PollContentType`](/docs/api/namespaces/proto/namespaces/Message/enumerations/PollContentType)

Defined in: [WAProto/index.d.ts:8306](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8306)

* * *

### pollType?[​](#polltype "Direct link to pollType?")

> `optional` **pollType**: `null` | [`PollType`](/docs/api/namespaces/proto/namespaces/Message/enumerations/PollType)

Defined in: [WAProto/index.d.ts:8307](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8307)

* * *

### selectableOptionsCount?[​](#selectableoptionscount "Direct link to selectableOptionsCount?")

> `optional` **selectableOptionsCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:8304](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8304)

---

<a name="interface-ipollencvalue"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollEncValue](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollEncValue)

Defined in: [WAProto/index.d.ts:8351](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8351)

## Properties[​](#properties "Direct link to Properties")

### encIv?[​](#enciv "Direct link to encIv?")

> `optional` **encIv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8353](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8353)

* * *

### encPayload?[​](#encpayload "Direct link to encPayload?")

> `optional` **encPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8352](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8352)

---

<a name="interface-ipollresultsnapshotmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollResultSnapshotMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollResultSnapshotMessage)

Defined in: [WAProto/index.d.ts:8369](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8369)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:8372](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8372)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:8370](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8370)

* * *

### pollType?[​](#polltype "Direct link to pollType?")

> `optional` **pollType**: `null` | [`PollType`](/docs/api/namespaces/proto/namespaces/Message/enumerations/PollType)

Defined in: [WAProto/index.d.ts:8373](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8373)

* * *

### pollVotes?[​](#pollvotes "Direct link to pollVotes?")

> `optional` **pollVotes**: `null` | [`IPollVote`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/interfaces/IPollVote)\[\]

Defined in: [WAProto/index.d.ts:8371](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8371)

---

<a name="interface-ipollupdatemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessage)

Defined in: [WAProto/index.d.ts:8417](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8417)

## Properties[​](#properties "Direct link to Properties")

### metadata?[​](#metadata "Direct link to metadata?")

> `optional` **metadata**: `null` | [`IPollUpdateMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessageMetadata)

Defined in: [WAProto/index.d.ts:8420](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8420)

* * *

### pollCreationMessageKey?[​](#pollcreationmessagekey "Direct link to pollCreationMessageKey?")

> `optional` **pollCreationMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8418](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8418)

* * *

### senderTimestampMs?[​](#sendertimestampms "Direct link to senderTimestampMs?")

> `optional` **senderTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8421](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8421)

* * *

### vote?[​](#vote "Direct link to vote?")

> `optional` **vote**: `null` | [`IPollEncValue`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollEncValue)

Defined in: [WAProto/index.d.ts:8419](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8419)

---

<a name="interface-ipollupdatemessagemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessageMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollUpdateMessageMetadata)

Defined in: [WAProto/index.d.ts:8439](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8439)

---

<a name="interface-ipollvotemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollVoteMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IPollVoteMessage)

Defined in: [WAProto/index.d.ts:8453](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8453)

## Properties[​](#properties "Direct link to Properties")

### selectedOptions?[​](#selectedoptions "Direct link to selectedOptions?")

> `optional` **selectedOptions**: `null` | `Uint8Array`<`ArrayBufferLike`\>\[\]

Defined in: [WAProto/index.d.ts:8454](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8454)

---

<a name="interface-iproductmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage)

Defined in: [WAProto/index.d.ts:8469](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8469)

## Properties[​](#properties "Direct link to Properties")

### body?[​](#body "Direct link to body?")

> `optional` **body**: `null` | `string`

Defined in: [WAProto/index.d.ts:8473](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8473)

* * *

### businessOwnerJid?[​](#businessownerjid "Direct link to businessOwnerJid?")

> `optional` **businessOwnerJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:8471](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8471)

* * *

### catalog?[​](#catalog "Direct link to catalog?")

> `optional` **catalog**: `null` | [`ICatalogSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/ICatalogSnapshot)

Defined in: [WAProto/index.d.ts:8472](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8472)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:8475](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8475)

* * *

### footer?[​](#footer "Direct link to footer?")

> `optional` **footer**: `null` | `string`

Defined in: [WAProto/index.d.ts:8474](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8474)

* * *

### product?[​](#product "Direct link to product?")

> `optional` **product**: `null` | [`IProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot)

Defined in: [WAProto/index.d.ts:8470](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8470)

---

<a name="interface-iprotocolmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IProtocolMessage)

Defined in: [WAProto/index.d.ts:8556](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8556)

## Properties[​](#properties "Direct link to Properties")

### aiPsiMetadata?[​](#aipsimetadata "Direct link to aiPsiMetadata?")

> `optional` **aiPsiMetadata**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8578](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8578)

* * *

### aiQueryFanout?[​](#aiqueryfanout "Direct link to aiQueryFanout?")

> `optional` **aiQueryFanout**: `null` | [`IAIQueryFanout`](/docs/api/namespaces/proto/interfaces/IAIQueryFanout)

Defined in: [WAProto/index.d.ts:8579](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8579)

* * *

### appStateFatalExceptionNotification?[​](#appstatefatalexceptionnotification "Direct link to appStateFatalExceptionNotification?")

> `optional` **appStateFatalExceptionNotification**: `null` | [`IAppStateFatalExceptionNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateFatalExceptionNotification)

Defined in: [WAProto/index.d.ts:8565](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8565)

* * *

### appStateSyncKeyRequest?[​](#appstatesynckeyrequest "Direct link to appStateSyncKeyRequest?")

> `optional` **appStateSyncKeyRequest**: `null` | [`IAppStateSyncKeyRequest`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyRequest)

Defined in: [WAProto/index.d.ts:8563](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8563)

* * *

### appStateSyncKeyShare?[​](#appstatesynckeyshare "Direct link to appStateSyncKeyShare?")

> `optional` **appStateSyncKeyShare**: `null` | [`IAppStateSyncKeyShare`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyShare)

Defined in: [WAProto/index.d.ts:8562](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8562)

* * *

### botFeedbackMessage?[​](#botfeedbackmessage "Direct link to botFeedbackMessage?")

> `optional` **botFeedbackMessage**: `null` | [`IBotFeedbackMessage`](/docs/api/namespaces/proto/interfaces/IBotFeedbackMessage)

Defined in: [WAProto/index.d.ts:8571](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8571)

* * *

### cloudApiThreadControlNotification?[​](#cloudapithreadcontrolnotification "Direct link to cloudApiThreadControlNotification?")

> `optional` **cloudApiThreadControlNotification**: `null` | [`ICloudAPIThreadControlNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ICloudAPIThreadControlNotification)

Defined in: [WAProto/index.d.ts:8575](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8575)

* * *

### disappearingMode?[​](#disappearingmode "Direct link to disappearingMode?")

> `optional` **disappearingMode**: `null` | [`IDisappearingMode`](/docs/api/namespaces/proto/interfaces/IDisappearingMode)

Defined in: [WAProto/index.d.ts:8566](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8566)

* * *

### editedMessage?[​](#editedmessage "Direct link to editedMessage?")

> `optional` **editedMessage**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:8567](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8567)

* * *

### ephemeralExpiration?[​](#ephemeralexpiration "Direct link to ephemeralExpiration?")

> `optional` **ephemeralExpiration**: `null` | `number`

Defined in: [WAProto/index.d.ts:8559](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8559)

* * *

### ephemeralSettingTimestamp?[​](#ephemeralsettingtimestamp "Direct link to ephemeralSettingTimestamp?")

> `optional` **ephemeralSettingTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8560](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8560)

* * *

### historySyncNotification?[​](#historysyncnotification "Direct link to historySyncNotification?")

> `optional` **historySyncNotification**: `null` | [`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification)

Defined in: [WAProto/index.d.ts:8561](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8561)

* * *

### initialSecurityNotificationSettingSync?[​](#initialsecuritynotificationsettingsync "Direct link to initialSecurityNotificationSettingSync?")

> `optional` **initialSecurityNotificationSettingSync**: `null` | [`IInitialSecurityNotificationSettingSync`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInitialSecurityNotificationSettingSync)

Defined in: [WAProto/index.d.ts:8564](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8564)

* * *

### invokerJid?[​](#invokerjid "Direct link to invokerJid?")

> `optional` **invokerJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:8572](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8572)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8557](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8557)

* * *

### lidMigrationMappingSyncMessage?[​](#lidmigrationmappingsyncmessage "Direct link to lidMigrationMappingSyncMessage?")

> `optional` **lidMigrationMappingSyncMessage**: `null` | [`ILIDMigrationMappingSyncMessage`](/docs/api/namespaces/proto/interfaces/ILIDMigrationMappingSyncMessage)

Defined in: [WAProto/index.d.ts:8576](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8576)

* * *

### limitSharing?[​](#limitsharing "Direct link to limitSharing?")

> `optional` **limitSharing**: `null` | [`ILimitSharing`](/docs/api/namespaces/proto/interfaces/ILimitSharing)

Defined in: [WAProto/index.d.ts:8577](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8577)

* * *

### mediaNotifyMessage?[​](#medianotifymessage "Direct link to mediaNotifyMessage?")

> `optional` **mediaNotifyMessage**: `null` | [`IMediaNotifyMessage`](/docs/api/namespaces/proto/interfaces/IMediaNotifyMessage)

Defined in: [WAProto/index.d.ts:8574](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8574)

* * *

### memberLabel?[​](#memberlabel "Direct link to memberLabel?")

> `optional` **memberLabel**: `null` | [`IMemberLabel`](/docs/api/namespaces/proto/interfaces/IMemberLabel)

Defined in: [WAProto/index.d.ts:8580](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8580)

* * *

### peerDataOperationRequestMessage?[​](#peerdataoperationrequestmessage "Direct link to peerDataOperationRequestMessage?")

> `optional` **peerDataOperationRequestMessage**: `null` | [`IPeerDataOperationRequestMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestMessage)

Defined in: [WAProto/index.d.ts:8569](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8569)

* * *

### peerDataOperationRequestResponseMessage?[​](#peerdataoperationrequestresponsemessage "Direct link to peerDataOperationRequestResponseMessage?")

> `optional` **peerDataOperationRequestResponseMessage**: `null` | [`IPeerDataOperationRequestResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IPeerDataOperationRequestResponseMessage)

Defined in: [WAProto/index.d.ts:8570](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8570)

* * *

### requestWelcomeMessageMetadata?[​](#requestwelcomemessagemetadata "Direct link to requestWelcomeMessageMetadata?")

> `optional` **requestWelcomeMessageMetadata**: `null` | [`IRequestWelcomeMessageMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestWelcomeMessageMetadata)

Defined in: [WAProto/index.d.ts:8573](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8573)

* * *

### timestampMs?[​](#timestampms "Direct link to timestampMs?")

> `optional` **timestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8568](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8568)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`Type`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProtocolMessage/enumerations/Type)

Defined in: [WAProto/index.d.ts:8558](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8558)

---

<a name="interface-iquestionresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IQuestionResponseMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IQuestionResponseMessage)

Defined in: [WAProto/index.d.ts:8650](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8650)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8651](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8651)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:8652](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8652)

---

<a name="interface-ireactionmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IReactionMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IReactionMessage)

Defined in: [WAProto/index.d.ts:8668](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8668)

## Properties[​](#properties "Direct link to Properties")

### groupingKey?[​](#groupingkey "Direct link to groupingKey?")

> `optional` **groupingKey**: `null` | `string`

Defined in: [WAProto/index.d.ts:8671](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8671)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8669](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8669)

* * *

### senderTimestampMs?[​](#sendertimestampms "Direct link to senderTimestampMs?")

> `optional` **senderTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8672](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8672)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:8670](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8670)

---

<a name="interface-irequestpaymentmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPaymentMessage)

Defined in: [WAProto/index.d.ts:8690](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8690)

## Properties[​](#properties "Direct link to Properties")

### amount?[​](#amount "Direct link to amount?")

> `optional` **amount**: `null` | [`IMoney`](/docs/api/namespaces/proto/interfaces/IMoney)

Defined in: [WAProto/index.d.ts:8696](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8696)

* * *

### amount1000?[​](#amount1000 "Direct link to amount1000?")

> `optional` **amount1000**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8693](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8693)

* * *

### background?[​](#background "Direct link to background?")

> `optional` **background**: `null` | [`IPaymentBackground`](/docs/api/namespaces/proto/interfaces/IPaymentBackground)

Defined in: [WAProto/index.d.ts:8697](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8697)

* * *

### currencyCodeIso4217?[​](#currencycodeiso4217 "Direct link to currencyCodeIso4217?")

> `optional` **currencyCodeIso4217**: `null` | `string`

Defined in: [WAProto/index.d.ts:8692](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8692)

* * *

### expiryTimestamp?[​](#expirytimestamp "Direct link to expiryTimestamp?")

> `optional` **expiryTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8695](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8695)

* * *

### noteMessage?[​](#notemessage "Direct link to noteMessage?")

> `optional` **noteMessage**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:8691](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8691)

* * *

### requestFrom?[​](#requestfrom "Direct link to requestFrom?")

> `optional` **requestFrom**: `null` | `string`

Defined in: [WAProto/index.d.ts:8694](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8694)

---

<a name="interface-irequestphonenumbermessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPhoneNumberMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestPhoneNumberMessage)

Defined in: [WAProto/index.d.ts:8718](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8718)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:8719](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8719)

---

<a name="interface-irequestwelcomemessagemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestWelcomeMessageMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IRequestWelcomeMessageMetadata)

Defined in: [WAProto/index.d.ts:8734](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8734)

## Properties[​](#properties "Direct link to Properties")

### localChatState?[​](#localchatstate "Direct link to localChatState?")

> `optional` **localChatState**: `null` | [`LocalChatState`](/docs/api/namespaces/proto/namespaces/Message/namespaces/RequestWelcomeMessageMetadata/enumerations/LocalChatState)

Defined in: [WAProto/index.d.ts:8735](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8735)

---

<a name="interface-ischeduledcallcreationmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallCreationMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallCreationMessage)

Defined in: [WAProto/index.d.ts:8758](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8758)

## Properties[​](#properties "Direct link to Properties")

### callType?[​](#calltype "Direct link to callType?")

> `optional` **callType**: `null` | [`CallType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ScheduledCallCreationMessage/enumerations/CallType)

Defined in: [WAProto/index.d.ts:8760](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8760)

* * *

### scheduledTimestampMs?[​](#scheduledtimestampms "Direct link to scheduledTimestampMs?")

> `optional` **scheduledTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8759](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8759)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:8761](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8761)

---

<a name="interface-ischeduledcalleditmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallEditMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IScheduledCallEditMessage)

Defined in: [WAProto/index.d.ts:8787](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8787)

## Properties[​](#properties "Direct link to Properties")

### editType?[​](#edittype "Direct link to editType?")

> `optional` **editType**: `null` | [`EditType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ScheduledCallEditMessage/enumerations/EditType)

Defined in: [WAProto/index.d.ts:8789](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8789)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8788](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8788)

---

<a name="interface-isecretencryptedmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ISecretEncryptedMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ISecretEncryptedMessage)

Defined in: [WAProto/index.d.ts:8813](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8813)

## Properties[​](#properties "Direct link to Properties")

### encIv?[​](#enciv "Direct link to encIv?")

> `optional` **encIv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8816](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8816)

* * *

### encPayload?[​](#encpayload "Direct link to encPayload?")

> `optional` **encPayload**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8815](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8815)

* * *

### secretEncType?[​](#secretenctype "Direct link to secretEncType?")

> `optional` **secretEncType**: `null` | [`SecretEncType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/SecretEncryptedMessage/enumerations/SecretEncType)

Defined in: [WAProto/index.d.ts:8817](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8817)

* * *

### targetMessageKey?[​](#targetmessagekey "Direct link to targetMessageKey?")

> `optional` **targetMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8814](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8814)

---

<a name="interface-isendpaymentmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ISendPaymentMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ISendPaymentMessage)

Defined in: [WAProto/index.d.ts:8844](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8844)

## Properties[​](#properties "Direct link to Properties")

### background?[​](#background "Direct link to background?")

> `optional` **background**: `null` | [`IPaymentBackground`](/docs/api/namespaces/proto/interfaces/IPaymentBackground)

Defined in: [WAProto/index.d.ts:8847](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8847)

* * *

### noteMessage?[​](#notemessage "Direct link to noteMessage?")

> `optional` **noteMessage**: `null` | [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [WAProto/index.d.ts:8845](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8845)

* * *

### requestMessageKey?[​](#requestmessagekey "Direct link to requestMessageKey?")

> `optional` **requestMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8846](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8846)

* * *

### transactionData?[​](#transactiondata "Direct link to transactionData?")

> `optional` **transactionData**: `null` | `string`

Defined in: [WAProto/index.d.ts:8848](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8848)

---

<a name="interface-isenderkeydistributionmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ISenderKeyDistributionMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ISenderKeyDistributionMessage)

Defined in: [WAProto/index.d.ts:8866](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8866)

## Properties[​](#properties "Direct link to Properties")

### axolotlSenderKeyDistributionMessage?[​](#axolotlsenderkeydistributionmessage "Direct link to axolotlSenderKeyDistributionMessage?")

> `optional` **axolotlSenderKeyDistributionMessage**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8868](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8868)

* * *

### groupId?[​](#groupid "Direct link to groupId?")

> `optional` **groupId**: `null` | `string`

Defined in: [WAProto/index.d.ts:8867](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8867)

---

<a name="interface-istatusnotificationmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusNotificationMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusNotificationMessage)

Defined in: [WAProto/index.d.ts:8884](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8884)

## Properties[​](#properties "Direct link to Properties")

### originalMessageKey?[​](#originalmessagekey "Direct link to originalMessageKey?")

> `optional` **originalMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8886](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8886)

* * *

### responseMessageKey?[​](#responsemessagekey "Direct link to responseMessageKey?")

> `optional` **responseMessageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8885](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8885)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`StatusNotificationType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusNotificationMessage/enumerations/StatusNotificationType)

Defined in: [WAProto/index.d.ts:8887](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8887)

---

<a name="interface-istatusquestionanswermessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuestionAnswerMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuestionAnswerMessage)

Defined in: [WAProto/index.d.ts:8914](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8914)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8915](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8915)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:8916](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8916)

---

<a name="interface-istatusquotedmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuotedMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusQuotedMessage)

Defined in: [WAProto/index.d.ts:8932](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8932)

## Properties[​](#properties "Direct link to Properties")

### originalStatusId?[​](#originalstatusid "Direct link to originalStatusId?")

> `optional` **originalStatusId**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8936](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8936)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:8934](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8934)

* * *

### thumbnail?[​](#thumbnail "Direct link to thumbnail?")

> `optional` **thumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8935](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8935)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`QUESTION_ANSWER`](/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusQuotedMessage/enumerations/StatusQuotedMessageType#question_answer)

Defined in: [WAProto/index.d.ts:8933](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8933)

---

<a name="interface-istatusstickerinteractionmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusStickerInteractionMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IStatusStickerInteractionMessage)

Defined in: [WAProto/index.d.ts:8961](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8961)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:8962](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8962)

* * *

### stickerKey?[​](#stickerkey "Direct link to stickerKey?")

> `optional` **stickerKey**: `null` | `string`

Defined in: [WAProto/index.d.ts:8963](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8963)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`StatusStickerType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusStickerInteractionMessage/enumerations/StatusStickerType)

Defined in: [WAProto/index.d.ts:8964](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8964)

---

<a name="interface-istickermessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage)

Defined in: [WAProto/index.d.ts:8989](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8989)

## Properties[​](#properties "Direct link to Properties")

### accessibilityLabel?[​](#accessibilitylabel "Direct link to accessibilityLabel?")

> `optional` **accessibilityLabel**: `null` | `string`

Defined in: [WAProto/index.d.ts:9009](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9009)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:9004](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9004)

* * *

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:8997](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8997)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8992](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8992)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8998](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8998)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8991](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8991)

* * *

### firstFrameLength?[​](#firstframelength "Direct link to firstFrameLength?")

> `optional` **firstFrameLength**: `null` | `number`

Defined in: [WAProto/index.d.ts:9000](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9000)

* * *

### firstFrameSidecar?[​](#firstframesidecar "Direct link to firstFrameSidecar?")

> `optional` **firstFrameSidecar**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9001](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9001)

* * *

### height?[​](#height "Direct link to height?")

> `optional` **height**: `null` | `number`

Defined in: [WAProto/index.d.ts:8995](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8995)

* * *

### isAiSticker?[​](#isaisticker "Direct link to isAiSticker?")

> `optional` **isAiSticker**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9007](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9007)

* * *

### isAnimated?[​](#isanimated "Direct link to isAnimated?")

> `optional` **isAnimated**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9002](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9002)

* * *

### isAvatar?[​](#isavatar "Direct link to isAvatar?")

> `optional` **isAvatar**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9006](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9006)

* * *

### isLottie?[​](#islottie "Direct link to isLottie?")

> `optional` **isLottie**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9008](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9008)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8993](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8993)

* * *

### mediaKeyDomain?[​](#mediakeydomain "Direct link to mediaKeyDomain?")

> `optional` **mediaKeyDomain**: `null` | [`MediaKeyDomain`](/docs/api/namespaces/proto/namespaces/Message/enumerations/MediaKeyDomain)

Defined in: [WAProto/index.d.ts:9010](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9010)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8999](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8999)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:8994](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8994)

* * *

### pngThumbnail?[​](#pngthumbnail "Direct link to pngThumbnail?")

> `optional` **pngThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9003](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9003)

* * *

### stickerSentTs?[​](#stickersentts "Direct link to stickerSentTs?")

> `optional` **stickerSentTs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9005](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9005)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:8990](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8990)

* * *

### width?[​](#width "Direct link to width?")

> `optional` **width**: `null` | `number`

Defined in: [WAProto/index.d.ts:8996](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8996)

---

<a name="interface-istickerpackmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerPackMessage)

Defined in: [WAProto/index.d.ts:9045](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9045)

## Properties[​](#properties "Direct link to Properties")

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:9055](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9055)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:9056](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9056)

* * *

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:9054](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9054)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9052](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9052)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9050](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9050)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9051](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9051)

* * *

### imageDataHash?[​](#imagedatahash "Direct link to imageDataHash?")

> `optional` **imageDataHash**: `null` | `string`

Defined in: [WAProto/index.d.ts:9065](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9065)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9053](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9053)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9058](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9058)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:9047](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9047)

* * *

### packDescription?[​](#packdescription "Direct link to packDescription?")

> `optional` **packDescription**: `null` | `string`

Defined in: [WAProto/index.d.ts:9057](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9057)

* * *

### publisher?[​](#publisher "Direct link to publisher?")

> `optional` **publisher**: `null` | `string`

Defined in: [WAProto/index.d.ts:9048](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9048)

* * *

### stickerPackId?[​](#stickerpackid "Direct link to stickerPackId?")

> `optional` **stickerPackId**: `null` | `string`

Defined in: [WAProto/index.d.ts:9046](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9046)

* * *

### stickerPackOrigin?[​](#stickerpackorigin "Direct link to stickerPackOrigin?")

> `optional` **stickerPackOrigin**: `null` | [`StickerPackOrigin`](/docs/api/namespaces/proto/namespaces/Message/namespaces/StickerPackMessage/enumerations/StickerPackOrigin)

Defined in: [WAProto/index.d.ts:9067](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9067)

* * *

### stickerPackSize?[​](#stickerpacksize "Direct link to stickerPackSize?")

> `optional` **stickerPackSize**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9066](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9066)

* * *

### stickers?[​](#stickers "Direct link to stickers?")

> `optional` **stickers**: `null` | [`ISticker`](/docs/api/namespaces/proto/namespaces/Message/namespaces/StickerPackMessage/interfaces/ISticker)\[\]

Defined in: [WAProto/index.d.ts:9049](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9049)

* * *

### thumbnailDirectPath?[​](#thumbnaildirectpath "Direct link to thumbnailDirectPath?")

> `optional` **thumbnailDirectPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:9060](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9060)

* * *

### thumbnailEncSha256?[​](#thumbnailencsha256 "Direct link to thumbnailEncSha256?")

> `optional` **thumbnailEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9062](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9062)

* * *

### thumbnailHeight?[​](#thumbnailheight "Direct link to thumbnailHeight?")

> `optional` **thumbnailHeight**: `null` | `number`

Defined in: [WAProto/index.d.ts:9063](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9063)

* * *

### thumbnailSha256?[​](#thumbnailsha256 "Direct link to thumbnailSha256?")

> `optional` **thumbnailSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9061](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9061)

* * *

### thumbnailWidth?[​](#thumbnailwidth "Direct link to thumbnailWidth?")

> `optional` **thumbnailWidth**: `null` | `number`

Defined in: [WAProto/index.d.ts:9064](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9064)

* * *

### trayIconFileName?[​](#trayiconfilename "Direct link to trayIconFileName?")

> `optional` **trayIconFileName**: `null` | `string`

Defined in: [WAProto/index.d.ts:9059](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9059)

---

<a name="interface-istickersyncrmrmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerSyncRMRMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerSyncRMRMessage)

Defined in: [WAProto/index.d.ts:9138](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9138)

## Properties[​](#properties "Direct link to Properties")

### filehash?[​](#filehash "Direct link to filehash?")

> `optional` **filehash**: `null` | `string`\[\]

Defined in: [WAProto/index.d.ts:9139](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9139)

* * *

### requestTimestamp?[​](#requesttimestamp "Direct link to requestTimestamp?")

> `optional` **requestTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9141](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9141)

* * *

### rmrSource?[​](#rmrsource "Direct link to rmrSource?")

> `optional` **rmrSource**: `null` | `string`

Defined in: [WAProto/index.d.ts:9140](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9140)

---

<a name="interface-itemplatebuttonreplymessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateButtonReplyMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateButtonReplyMessage)

Defined in: [WAProto/index.d.ts:9158](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9158)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:9161](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9161)

* * *

### selectedCarouselCardIndex?[​](#selectedcarouselcardindex "Direct link to selectedCarouselCardIndex?")

> `optional` **selectedCarouselCardIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:9163](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9163)

* * *

### selectedDisplayText?[​](#selecteddisplaytext "Direct link to selectedDisplayText?")

> `optional` **selectedDisplayText**: `null` | `string`

Defined in: [WAProto/index.d.ts:9160](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9160)

* * *

### selectedId?[​](#selectedid "Direct link to selectedId?")

> `optional` **selectedId**: `null` | `string`

Defined in: [WAProto/index.d.ts:9159](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9159)

* * *

### selectedIndex?[​](#selectedindex "Direct link to selectedIndex?")

> `optional` **selectedIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:9162](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9162)

---

<a name="interface-itemplatemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/ITemplateMessage)

Defined in: [WAProto/index.d.ts:9182](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9182)

## Properties[​](#properties "Direct link to Properties")

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:9183](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9183)

* * *

### fourRowTemplate?[​](#fourrowtemplate "Direct link to fourRowTemplate?")

> `optional` **fourRowTemplate**: `null` | [`IFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate)

Defined in: [WAProto/index.d.ts:9186](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9186)

* * *

### hydratedFourRowTemplate?[​](#hydratedfourrowtemplate "Direct link to hydratedFourRowTemplate?")

> `optional` **hydratedFourRowTemplate**: `null` | [`IHydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate)

Defined in: [WAProto/index.d.ts:9187](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9187)

* * *

### hydratedTemplate?[​](#hydratedtemplate "Direct link to hydratedTemplate?")

> `optional` **hydratedTemplate**: `null` | [`IHydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate)

Defined in: [WAProto/index.d.ts:9184](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9184)

* * *

### interactiveMessageTemplate?[​](#interactivemessagetemplate "Direct link to interactiveMessageTemplate?")

> `optional` **interactiveMessageTemplate**: `null` | [`IInteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage)

Defined in: [WAProto/index.d.ts:9188](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9188)

* * *

### templateId?[​](#templateid "Direct link to templateId?")

> `optional` **templateId**: `null` | `string`

Defined in: [WAProto/index.d.ts:9185](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9185)

---

<a name="interface-iurlmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IURLMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IURLMetadata)

Defined in: [WAProto/index.d.ts:9278](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9278)

## Properties[​](#properties "Direct link to Properties")

### fbExperimentId?[​](#fbexperimentid "Direct link to fbExperimentId?")

> `optional` **fbExperimentId**: `null` | `number`

Defined in: [WAProto/index.d.ts:9279](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9279)

---

<a name="interface-ivideoendcard"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoEndCard](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoEndCard)

Defined in: [WAProto/index.d.ts:9294](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9294)

## Properties[​](#properties "Direct link to Properties")

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:9296](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9296)

* * *

### profilePictureUrl?[​](#profilepictureurl "Direct link to profilePictureUrl?")

> `optional` **profilePictureUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:9298](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9298)

* * *

### thumbnailImageUrl?[​](#thumbnailimageurl "Direct link to thumbnailImageUrl?")

> `optional` **thumbnailImageUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:9297](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9297)

* * *

### username?[​](#username "Direct link to username?")

> `optional` **username**: `null` | `string`

Defined in: [WAProto/index.d.ts:9295](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9295)

---

<a name="interface-ivideomessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage)

Defined in: [WAProto/index.d.ts:9316](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9316)

## Properties[​](#properties "Direct link to Properties")

### accessibilityLabel?[​](#accessibilitylabel "Direct link to accessibilityLabel?")

> `optional` **accessibilityLabel**: `null` | `string`

Defined in: [WAProto/index.d.ts:9341](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9341)

* * *

### annotations?[​](#annotations "Direct link to annotations?")

> `optional` **annotations**: `null` | [`IInteractiveAnnotation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation)\[\]

Defined in: [WAProto/index.d.ts:9340](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9340)

* * *

### caption?[​](#caption "Direct link to caption?")

> `optional` **caption**: `null` | `string`

Defined in: [WAProto/index.d.ts:9323](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9323)

* * *

### contextInfo?[​](#contextinfo "Direct link to contextInfo?")

> `optional` **contextInfo**: `null` | [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [WAProto/index.d.ts:9332](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9332)

* * *

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:9329](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9329)

* * *

### externalShareFullVideoDurationInSeconds?[​](#externalsharefullvideodurationinseconds "Direct link to externalShareFullVideoDurationInSeconds?")

> `optional` **externalShareFullVideoDurationInSeconds**: `null` | `number`

Defined in: [WAProto/index.d.ts:9343](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9343)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9327](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9327)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9320](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9320)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9319](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9319)

* * *

### gifAttribution?[​](#gifattribution "Direct link to gifAttribution?")

> `optional` **gifAttribution**: `null` | [`Attribution`](/docs/api/namespaces/proto/namespaces/Message/namespaces/VideoMessage/enumerations/Attribution)

Defined in: [WAProto/index.d.ts:9334](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9334)

* * *

### gifPlayback?[​](#gifplayback "Direct link to gifPlayback?")

> `optional` **gifPlayback**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9324](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9324)

* * *

### height?[​](#height "Direct link to height?")

> `optional` **height**: `null` | `number`

Defined in: [WAProto/index.d.ts:9325](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9325)

* * *

### interactiveAnnotations?[​](#interactiveannotations "Direct link to interactiveAnnotations?")

> `optional` **interactiveAnnotations**: `null` | [`IInteractiveAnnotation`](/docs/api/namespaces/proto/interfaces/IInteractiveAnnotation)\[\]

Defined in: [WAProto/index.d.ts:9328](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9328)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9331](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9331)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9322](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9322)

* * *

### mediaKeyDomain?[​](#mediakeydomain "Direct link to mediaKeyDomain?")

> `optional` **mediaKeyDomain**: `null` | [`MediaKeyDomain`](/docs/api/namespaces/proto/namespaces/Message/enumerations/MediaKeyDomain)

Defined in: [WAProto/index.d.ts:9347](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9347)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9330](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9330)

* * *

### metadataUrl?[​](#metadataurl "Direct link to metadataUrl?")

> `optional` **metadataUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:9345](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9345)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:9318](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9318)

* * *

### motionPhotoPresentationOffsetMs?[​](#motionphotopresentationoffsetms "Direct link to motionPhotoPresentationOffsetMs?")

> `optional` **motionPhotoPresentationOffsetMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9344](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9344)

* * *

### processedVideos?[​](#processedvideos "Direct link to processedVideos?")

> `optional` **processedVideos**: `null` | [`IProcessedVideo`](/docs/api/namespaces/proto/interfaces/IProcessedVideo)\[\]

Defined in: [WAProto/index.d.ts:9342](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9342)

* * *

### seconds?[​](#seconds "Direct link to seconds?")

> `optional` **seconds**: `null` | `number`

Defined in: [WAProto/index.d.ts:9321](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9321)

* * *

### staticUrl?[​](#staticurl "Direct link to staticUrl?")

> `optional` **staticUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:9339](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9339)

* * *

### streamingSidecar?[​](#streamingsidecar "Direct link to streamingSidecar?")

> `optional` **streamingSidecar**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9333](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9333)

* * *

### thumbnailDirectPath?[​](#thumbnaildirectpath "Direct link to thumbnailDirectPath?")

> `optional` **thumbnailDirectPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:9336](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9336)

* * *

### thumbnailEncSha256?[​](#thumbnailencsha256 "Direct link to thumbnailEncSha256?")

> `optional` **thumbnailEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9338](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9338)

* * *

### thumbnailSha256?[​](#thumbnailsha256 "Direct link to thumbnailSha256?")

> `optional` **thumbnailSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9337](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9337)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:9317](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9317)

* * *

### videoSourceType?[​](#videosourcetype "Direct link to videoSourceType?")

> `optional` **videoSourceType**: `null` | [`VideoSourceType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/VideoMessage/enumerations/VideoSourceType)

Defined in: [WAProto/index.d.ts:9346](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9346)

* * *

### viewOnce?[​](#viewonce "Direct link to viewOnce?")

> `optional` **viewOnce**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9335](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9335)

* * *

### width?[​](#width "Direct link to width?")

> `optional` **width**: `null` | `number`

Defined in: [WAProto/index.d.ts:9326](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9326)

---

<a name="bcallmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/BCallMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/BCallMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [MediaType](/docs/api/namespaces/proto/namespaces/Message/namespaces/BCallMessage/enumerations/MediaType)

---

<a name="enumeration-mediatype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/BCallMessage/enumerations/MediaType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/BCallMessage/enumerations/MediaType)

Defined in: [WAProto/index.d.ts:5607](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5607)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AUDIO[​](#audio "Direct link to AUDIO")

> **AUDIO**: `1`

Defined in: [WAProto/index.d.ts:5609](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5609)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:5608](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5608)

* * *

### VIDEO[​](#video "Direct link to VIDEO")

> **VIDEO**: `2`

Defined in: [WAProto/index.d.ts:5610](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5610)

---

<a name="buttonsmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [Button](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [HeaderType](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/enumerations/HeaderType)

## Classes[​](#classes "Direct link to Classes")

*   [Button](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/classes/Button)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IButton](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/interfaces/IButton)

---

<a name="class-button"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/classes/Button](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/classes/Button)

Defined in: [WAProto/index.d.ts:5658](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5658)

## Implements[​](#implements "Direct link to Implements")

*   [`IButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/interfaces/IButton)

## Constructors[​](#constructors "Direct link to Constructors")

### new Button()[​](#new-button "Direct link to new Button()")

> **new Button**(`p`?): [`Button`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/classes/Button)

Defined in: [WAProto/index.d.ts:5659](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5659)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/interfaces/IButton)

#### Returns[​](#returns "Direct link to Returns")

[`Button`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/classes/Button)

## Properties[​](#properties "Direct link to Properties")

### buttonId?[​](#buttonid "Direct link to buttonId?")

> `optional` **buttonId**: `null` | `string`

Defined in: [WAProto/index.d.ts:5660](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5660)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/interfaces/IButton).[`buttonId`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/interfaces/IButton#buttonid)

* * *

### buttonText?[​](#buttontext "Direct link to buttonText?")

> `optional` **buttonText**: `null` | [`IButtonText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/IButtonText)

Defined in: [WAProto/index.d.ts:5661](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5661)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/interfaces/IButton).[`buttonText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/interfaces/IButton#buttontext)

* * *

### nativeFlowInfo?[​](#nativeflowinfo "Direct link to nativeFlowInfo?")

> `optional` **nativeFlowInfo**: `null` | [`INativeFlowInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/INativeFlowInfo)

Defined in: [WAProto/index.d.ts:5663](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5663)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/interfaces/IButton).[`nativeFlowInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/interfaces/IButton#nativeflowinfo)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`Type`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/enumerations/Type)

Defined in: [WAProto/index.d.ts:5662](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5662)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/interfaces/IButton).[`type`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/interfaces/IButton#type)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5669](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5669)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Button`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/classes/Button)

Defined in: [WAProto/index.d.ts:5664](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5664)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/interfaces/IButton)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Button`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/classes/Button)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Button`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/classes/Button)

Defined in: [WAProto/index.d.ts:5666](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5666)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Button`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/classes/Button)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5665](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5665)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/interfaces/IButton)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Button`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/classes/Button)

Defined in: [WAProto/index.d.ts:5667](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5667)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Button`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/classes/Button)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5670](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5670)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5668](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5668)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Button`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/classes/Button)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-headertype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/enumerations/HeaderType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/enumerations/HeaderType)

Defined in: [WAProto/index.d.ts:5716](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5716)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### DOCUMENT[​](#document "Direct link to DOCUMENT")

> **DOCUMENT**: `3`

Defined in: [WAProto/index.d.ts:5720](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5720)

* * *

### EMPTY[​](#empty "Direct link to EMPTY")

> **EMPTY**: `1`

Defined in: [WAProto/index.d.ts:5718](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5718)

* * *

### IMAGE[​](#image "Direct link to IMAGE")

> **IMAGE**: `4`

Defined in: [WAProto/index.d.ts:5721](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5721)

* * *

### LOCATION[​](#location "Direct link to LOCATION")

> **LOCATION**: `6`

Defined in: [WAProto/index.d.ts:5723](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5723)

* * *

### TEXT[​](#text "Direct link to TEXT")

> **TEXT**: `2`

Defined in: [WAProto/index.d.ts:5719](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5719)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:5717](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5717)

* * *

### VIDEO[​](#video "Direct link to VIDEO")

> **VIDEO**: `5`

Defined in: [WAProto/index.d.ts:5722](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5722)

---

<a name="interface-ibutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/interfaces/IButton](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/interfaces/IButton)

Defined in: [WAProto/index.d.ts:5651](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5651)

## Properties[​](#properties "Direct link to Properties")

### buttonId?[​](#buttonid "Direct link to buttonId?")

> `optional` **buttonId**: `null` | `string`

Defined in: [WAProto/index.d.ts:5652](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5652)

* * *

### buttonText?[​](#buttontext "Direct link to buttonText?")

> `optional` **buttonText**: `null` | [`IButtonText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/IButtonText)

Defined in: [WAProto/index.d.ts:5653](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5653)

* * *

### nativeFlowInfo?[​](#nativeflowinfo "Direct link to nativeFlowInfo?")

> `optional` **nativeFlowInfo**: `null` | [`INativeFlowInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/INativeFlowInfo)

Defined in: [WAProto/index.d.ts:5655](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5655)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`Type`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/enumerations/Type)

Defined in: [WAProto/index.d.ts:5654](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5654)

---

<a name="button"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Type](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/enumerations/Type)

## Classes[​](#classes "Direct link to Classes")

*   [ButtonText](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/ButtonText)
*   [NativeFlowInfo](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/NativeFlowInfo)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IButtonText](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/IButtonText)
*   [INativeFlowInfo](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/INativeFlowInfo)

---

<a name="class-buttontext"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/ButtonText](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/ButtonText)

Defined in: [WAProto/index.d.ts:5679](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5679)

## Implements[​](#implements "Direct link to Implements")

*   [`IButtonText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/IButtonText)

## Constructors[​](#constructors "Direct link to Constructors")

### new ButtonText()[​](#new-buttontext "Direct link to new ButtonText()")

> **new ButtonText**(`p`?): [`ButtonText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/ButtonText)

Defined in: [WAProto/index.d.ts:5680](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5680)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IButtonText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/IButtonText)

#### Returns[​](#returns "Direct link to Returns")

[`ButtonText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/ButtonText)

## Properties[​](#properties "Direct link to Properties")

### displayText?[​](#displaytext "Direct link to displayText?")

> `optional` **displayText**: `null` | `string`

Defined in: [WAProto/index.d.ts:5681](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5681)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IButtonText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/IButtonText).[`displayText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/IButtonText#displaytext)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5687](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5687)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ButtonText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/ButtonText)

Defined in: [WAProto/index.d.ts:5682](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5682)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IButtonText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/IButtonText)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ButtonText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/ButtonText)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ButtonText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/ButtonText)

Defined in: [WAProto/index.d.ts:5684](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5684)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ButtonText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/ButtonText)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5683](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5683)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IButtonText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/IButtonText)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ButtonText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/ButtonText)

Defined in: [WAProto/index.d.ts:5685](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5685)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ButtonText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/ButtonText)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5688](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5688)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5686](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5686)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ButtonText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/ButtonText)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-nativeflowinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/NativeFlowInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/NativeFlowInfo)

Defined in: [WAProto/index.d.ts:5696](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5696)

## Implements[​](#implements "Direct link to Implements")

*   [`INativeFlowInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/INativeFlowInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new NativeFlowInfo()[​](#new-nativeflowinfo "Direct link to new NativeFlowInfo()")

> **new NativeFlowInfo**(`p`?): [`NativeFlowInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/NativeFlowInfo)

Defined in: [WAProto/index.d.ts:5697](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5697)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`INativeFlowInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/INativeFlowInfo)

#### Returns[​](#returns "Direct link to Returns")

[`NativeFlowInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/NativeFlowInfo)

## Properties[​](#properties "Direct link to Properties")

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:5698](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5698)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`INativeFlowInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/INativeFlowInfo).[`name`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/INativeFlowInfo#name)

* * *

### paramsJson?[​](#paramsjson "Direct link to paramsJson?")

> `optional` **paramsJson**: `null` | `string`

Defined in: [WAProto/index.d.ts:5699](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5699)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`INativeFlowInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/INativeFlowInfo).[`paramsJson`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/INativeFlowInfo#paramsjson)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5705](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5705)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`NativeFlowInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/NativeFlowInfo)

Defined in: [WAProto/index.d.ts:5700](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5700)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`INativeFlowInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/INativeFlowInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`NativeFlowInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/NativeFlowInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`NativeFlowInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/NativeFlowInfo)

Defined in: [WAProto/index.d.ts:5702](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5702)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`NativeFlowInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/NativeFlowInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5701](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5701)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`INativeFlowInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/INativeFlowInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`NativeFlowInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/NativeFlowInfo)

Defined in: [WAProto/index.d.ts:5703](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5703)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`NativeFlowInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/NativeFlowInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5706](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5706)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5704](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5704)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`NativeFlowInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/classes/NativeFlowInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-type"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/enumerations/Type](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/enumerations/Type)

Defined in: [WAProto/index.d.ts:5709](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5709)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### NATIVE\_FLOW[​](#native_flow "Direct link to NATIVE_FLOW")

> **NATIVE\_FLOW**: `2`

Defined in: [WAProto/index.d.ts:5712](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5712)

* * *

### RESPONSE[​](#response "Direct link to RESPONSE")

> **RESPONSE**: `1`

Defined in: [WAProto/index.d.ts:5711](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5711)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:5710](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5710)

---

<a name="interface-ibuttontext"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/IButtonText](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/IButtonText)

Defined in: [WAProto/index.d.ts:5675](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5675)

## Properties[​](#properties "Direct link to Properties")

### displayText?[​](#displaytext "Direct link to displayText?")

> `optional` **displayText**: `null` | `string`

Defined in: [WAProto/index.d.ts:5676](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5676)

---

<a name="interface-inativeflowinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/INativeFlowInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsMessage/namespaces/Button/interfaces/INativeFlowInfo)

Defined in: [WAProto/index.d.ts:5691](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5691)

## Properties[​](#properties "Direct link to Properties")

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:5692](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5692)

* * *

### paramsJson?[​](#paramsjson "Direct link to paramsJson?")

> `optional` **paramsJson**: `null` | `string`

Defined in: [WAProto/index.d.ts:5693](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5693)

---

<a name="buttonsresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsResponseMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsResponseMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Type](/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsResponseMessage/enumerations/Type)

---

<a name="enumeration-type"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsResponseMessage/enumerations/Type](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ButtonsResponseMessage/enumerations/Type)

Defined in: [WAProto/index.d.ts:5752](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5752)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### DISPLAY\_TEXT[​](#display_text "Direct link to DISPLAY_TEXT")

> **DISPLAY\_TEXT**: `1`

Defined in: [WAProto/index.d.ts:5754](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5754)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:5753](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5753)

---

<a name="calllogmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [CallOutcome](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/enumerations/CallOutcome)
*   [CallType](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/enumerations/CallType)

## Classes[​](#classes "Direct link to Classes")

*   [CallParticipant](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/classes/CallParticipant)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [ICallParticipant](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/interfaces/ICallParticipant)

---

<a name="class-callparticipant"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/classes/CallParticipant](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/classes/CallParticipant)

Defined in: [WAProto/index.d.ts:5832](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5832)

## Implements[​](#implements "Direct link to Implements")

*   [`ICallParticipant`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/interfaces/ICallParticipant)

## Constructors[​](#constructors "Direct link to Constructors")

### new CallParticipant()[​](#new-callparticipant "Direct link to new CallParticipant()")

> **new CallParticipant**(`p`?): [`CallParticipant`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/classes/CallParticipant)

Defined in: [WAProto/index.d.ts:5833](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5833)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICallParticipant`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/interfaces/ICallParticipant)

#### Returns[​](#returns "Direct link to Returns")

[`CallParticipant`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/classes/CallParticipant)

## Properties[​](#properties "Direct link to Properties")

### callOutcome?[​](#calloutcome "Direct link to callOutcome?")

> `optional` **callOutcome**: `null` | [`CallOutcome`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/enumerations/CallOutcome)

Defined in: [WAProto/index.d.ts:5835](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5835)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICallParticipant`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/interfaces/ICallParticipant).[`callOutcome`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/interfaces/ICallParticipant#calloutcome)

* * *

### jid?[​](#jid "Direct link to jid?")

> `optional` **jid**: `null` | `string`

Defined in: [WAProto/index.d.ts:5834](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5834)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ICallParticipant`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/interfaces/ICallParticipant).[`jid`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/interfaces/ICallParticipant#jid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5841](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5841)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CallParticipant`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/classes/CallParticipant)

Defined in: [WAProto/index.d.ts:5836](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5836)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICallParticipant`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/interfaces/ICallParticipant)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CallParticipant`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/classes/CallParticipant)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CallParticipant`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/classes/CallParticipant)

Defined in: [WAProto/index.d.ts:5838](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5838)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CallParticipant`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/classes/CallParticipant)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5837](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5837)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICallParticipant`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/interfaces/ICallParticipant)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CallParticipant`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/classes/CallParticipant)

Defined in: [WAProto/index.d.ts:5839](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5839)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CallParticipant`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/classes/CallParticipant)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5842](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5842)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5840](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5840)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CallParticipant`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/classes/CallParticipant)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-calloutcome"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/enumerations/CallOutcome](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/enumerations/CallOutcome)

Defined in: [WAProto/index.d.ts:5816](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5816)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### ACCEPTED\_ELSEWHERE[​](#accepted_elsewhere "Direct link to ACCEPTED_ELSEWHERE")

> **ACCEPTED\_ELSEWHERE**: `4`

Defined in: [WAProto/index.d.ts:5821](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5821)

* * *

### CONNECTED[​](#connected "Direct link to CONNECTED")

> **CONNECTED**: `0`

Defined in: [WAProto/index.d.ts:5817](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5817)

* * *

### FAILED[​](#failed "Direct link to FAILED")

> **FAILED**: `2`

Defined in: [WAProto/index.d.ts:5819](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5819)

* * *

### MISSED[​](#missed "Direct link to MISSED")

> **MISSED**: `1`

Defined in: [WAProto/index.d.ts:5818](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5818)

* * *

### ONGOING[​](#ongoing "Direct link to ONGOING")

> **ONGOING**: `5`

Defined in: [WAProto/index.d.ts:5822](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5822)

* * *

### REJECTED[​](#rejected "Direct link to REJECTED")

> **REJECTED**: `3`

Defined in: [WAProto/index.d.ts:5820](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5820)

* * *

### SILENCED\_BY\_DND[​](#silenced_by_dnd "Direct link to SILENCED_BY_DND")

> **SILENCED\_BY\_DND**: `6`

Defined in: [WAProto/index.d.ts:5823](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5823)

* * *

### SILENCED\_UNKNOWN\_CALLER[​](#silenced_unknown_caller "Direct link to SILENCED_UNKNOWN_CALLER")

> **SILENCED\_UNKNOWN\_CALLER**: `7`

Defined in: [WAProto/index.d.ts:5824](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5824)

---

<a name="enumeration-calltype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/enumerations/CallType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/enumerations/CallType)

Defined in: [WAProto/index.d.ts:5845](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5845)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### REGULAR[​](#regular "Direct link to REGULAR")

> **REGULAR**: `0`

Defined in: [WAProto/index.d.ts:5846](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5846)

* * *

### SCHEDULED\_CALL[​](#scheduled_call "Direct link to SCHEDULED_CALL")

> **SCHEDULED\_CALL**: `1`

Defined in: [WAProto/index.d.ts:5847](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5847)

* * *

### VOICE\_CHAT[​](#voice_chat "Direct link to VOICE_CHAT")

> **VOICE\_CHAT**: `2`

Defined in: [WAProto/index.d.ts:5848](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5848)

---

<a name="interface-icallparticipant"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/interfaces/ICallParticipant](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/interfaces/ICallParticipant)

Defined in: [WAProto/index.d.ts:5827](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5827)

## Properties[​](#properties "Direct link to Properties")

### callOutcome?[​](#calloutcome "Direct link to callOutcome?")

> `optional` **callOutcome**: `null` | [`CallOutcome`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CallLogMessage/enumerations/CallOutcome)

Defined in: [WAProto/index.d.ts:5829](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5829)

* * *

### jid?[​](#jid "Direct link to jid?")

> `optional` **jid**: `null` | `string`

Defined in: [WAProto/index.d.ts:5828](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5828)

---

<a name="cloudapithreadcontrolnotification"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [CloudAPIThreadControl](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/enumerations/CloudAPIThreadControl)

## Classes[​](#classes "Direct link to Classes")

*   [CloudAPIThreadControlNotificationContent](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/classes/CloudAPIThreadControlNotificationContent)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [ICloudAPIThreadControlNotificationContent](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/interfaces/ICloudAPIThreadControlNotificationContent)

---

<a name="class-cloudapithreadcontrolnotificationcontent"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/classes/CloudAPIThreadControlNotificationContent](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/classes/CloudAPIThreadControlNotificationContent)

Defined in: [WAProto/index.d.ts:5925](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5925)

## Implements[​](#implements "Direct link to Implements")

*   [`ICloudAPIThreadControlNotificationContent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/interfaces/ICloudAPIThreadControlNotificationContent)

## Constructors[​](#constructors "Direct link to Constructors")

### new CloudAPIThreadControlNotificationContent()[​](#new-cloudapithreadcontrolnotificationcontent "Direct link to new CloudAPIThreadControlNotificationContent()")

> **new CloudAPIThreadControlNotificationContent**(`p`?): [`CloudAPIThreadControlNotificationContent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/classes/CloudAPIThreadControlNotificationContent)

Defined in: [WAProto/index.d.ts:5926](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5926)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICloudAPIThreadControlNotificationContent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/interfaces/ICloudAPIThreadControlNotificationContent)

#### Returns[​](#returns "Direct link to Returns")

[`CloudAPIThreadControlNotificationContent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/classes/CloudAPIThreadControlNotificationContent)

## Properties[​](#properties "Direct link to Properties")

### extraJson?[​](#extrajson "Direct link to extraJson?")

> `optional` **extraJson**: `null` | `string`

Defined in: [WAProto/index.d.ts:5928](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5928)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICloudAPIThreadControlNotificationContent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/interfaces/ICloudAPIThreadControlNotificationContent).[`extraJson`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/interfaces/ICloudAPIThreadControlNotificationContent#extrajson)

* * *

### handoffNotificationText?[​](#handoffnotificationtext "Direct link to handoffNotificationText?")

> `optional` **handoffNotificationText**: `null` | `string`

Defined in: [WAProto/index.d.ts:5927](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5927)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ICloudAPIThreadControlNotificationContent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/interfaces/ICloudAPIThreadControlNotificationContent).[`handoffNotificationText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/interfaces/ICloudAPIThreadControlNotificationContent#handoffnotificationtext)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:5934](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5934)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CloudAPIThreadControlNotificationContent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/classes/CloudAPIThreadControlNotificationContent)

Defined in: [WAProto/index.d.ts:5929](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5929)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICloudAPIThreadControlNotificationContent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/interfaces/ICloudAPIThreadControlNotificationContent)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CloudAPIThreadControlNotificationContent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/classes/CloudAPIThreadControlNotificationContent)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CloudAPIThreadControlNotificationContent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/classes/CloudAPIThreadControlNotificationContent)

Defined in: [WAProto/index.d.ts:5931](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5931)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CloudAPIThreadControlNotificationContent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/classes/CloudAPIThreadControlNotificationContent)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:5930](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5930)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICloudAPIThreadControlNotificationContent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/interfaces/ICloudAPIThreadControlNotificationContent)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CloudAPIThreadControlNotificationContent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/classes/CloudAPIThreadControlNotificationContent)

Defined in: [WAProto/index.d.ts:5932](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5932)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CloudAPIThreadControlNotificationContent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/classes/CloudAPIThreadControlNotificationContent)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:5935](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5935)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:5933](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5933)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CloudAPIThreadControlNotificationContent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/classes/CloudAPIThreadControlNotificationContent)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-cloudapithreadcontrol"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/enumerations/CloudAPIThreadControl](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/enumerations/CloudAPIThreadControl)

Defined in: [WAProto/index.d.ts:5914](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5914)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### CONTROL\_PASSED[​](#control_passed "Direct link to CONTROL_PASSED")

> **CONTROL\_PASSED**: `1`

Defined in: [WAProto/index.d.ts:5916](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5916)

* * *

### CONTROL\_TAKEN[​](#control_taken "Direct link to CONTROL_TAKEN")

> **CONTROL\_TAKEN**: `2`

Defined in: [WAProto/index.d.ts:5917](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5917)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:5915](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5915)

---

<a name="interface-icloudapithreadcontrolnotificationcontent"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/interfaces/ICloudAPIThreadControlNotificationContent](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/CloudAPIThreadControlNotification/interfaces/ICloudAPIThreadControlNotificationContent)

Defined in: [WAProto/index.d.ts:5920](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5920)

## Properties[​](#properties "Direct link to Properties")

### extraJson?[​](#extrajson "Direct link to extraJson?")

> `optional` **extraJson**: `null` | `string`

Defined in: [WAProto/index.d.ts:5922](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5922)

* * *

### handoffNotificationText?[​](#handoffnotificationtext "Direct link to handoffNotificationText?")

> `optional` **handoffNotificationText**: `null` | `string`

Defined in: [WAProto/index.d.ts:5921](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L5921)

---

<a name="eventresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/EventResponseMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/EventResponseMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [EventResponseType](/docs/api/namespaces/proto/namespaces/Message/namespaces/EventResponseMessage/enumerations/EventResponseType)

---

<a name="enumeration-eventresponsetype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/EventResponseMessage/enumerations/EventResponseType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/EventResponseMessage/enumerations/EventResponseType)

Defined in: [WAProto/index.d.ts:6211](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6211)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### GOING[​](#going "Direct link to GOING")

> **GOING**: `1`

Defined in: [WAProto/index.d.ts:6213](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6213)

* * *

### MAYBE[​](#maybe "Direct link to MAYBE")

> **MAYBE**: `3`

Defined in: [WAProto/index.d.ts:6215](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6215)

* * *

### NOT\_GOING[​](#not_going "Direct link to NOT_GOING")

> **NOT\_GOING**: `2`

Defined in: [WAProto/index.d.ts:6214](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6214)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:6212](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6212)

---

<a name="extendedtextmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ExtendedTextMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ExtendedTextMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [FontType](/docs/api/namespaces/proto/namespaces/Message/namespaces/ExtendedTextMessage/enumerations/FontType)
*   [InviteLinkGroupType](/docs/api/namespaces/proto/namespaces/Message/namespaces/ExtendedTextMessage/enumerations/InviteLinkGroupType)
*   [PreviewType](/docs/api/namespaces/proto/namespaces/Message/namespaces/ExtendedTextMessage/enumerations/PreviewType)

---

<a name="enumeration-fonttype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ExtendedTextMessage/enumerations/FontType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ExtendedTextMessage/enumerations/FontType)

Defined in: [WAProto/index.d.ts:6299](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6299)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### CALISTOGA\_REGULAR[​](#calistoga_regular "Direct link to CALISTOGA_REGULAR")

> **CALISTOGA\_REGULAR**: `8`

Defined in: [WAProto/index.d.ts:6305](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6305)

* * *

### COURIERPRIME\_BOLD[​](#courierprime_bold "Direct link to COURIERPRIME_BOLD")

> **COURIERPRIME\_BOLD**: `10`

Defined in: [WAProto/index.d.ts:6307](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6307)

* * *

### EXO2\_EXTRABOLD[​](#exo2_extrabold "Direct link to EXO2_EXTRABOLD")

> **EXO2\_EXTRABOLD**: `9`

Defined in: [WAProto/index.d.ts:6306](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6306)

* * *

### FB\_SCRIPT[​](#fb_script "Direct link to FB_SCRIPT")

> **FB\_SCRIPT**: `2`

Defined in: [WAProto/index.d.ts:6302](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6302)

* * *

### MORNINGBREEZE\_REGULAR[​](#morningbreeze_regular "Direct link to MORNINGBREEZE_REGULAR")

> **MORNINGBREEZE\_REGULAR**: `7`

Defined in: [WAProto/index.d.ts:6304](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6304)

* * *

### SYSTEM[​](#system "Direct link to SYSTEM")

> **SYSTEM**: `0`

Defined in: [WAProto/index.d.ts:6300](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6300)

* * *

### SYSTEM\_BOLD[​](#system_bold "Direct link to SYSTEM_BOLD")

> **SYSTEM\_BOLD**: `6`

Defined in: [WAProto/index.d.ts:6303](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6303)

* * *

### SYSTEM\_TEXT[​](#system_text "Direct link to SYSTEM_TEXT")

> **SYSTEM\_TEXT**: `1`

Defined in: [WAProto/index.d.ts:6301](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6301)

---

<a name="enumeration-invitelinkgrouptype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ExtendedTextMessage/enumerations/InviteLinkGroupType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ExtendedTextMessage/enumerations/InviteLinkGroupType)

Defined in: [WAProto/index.d.ts:6310](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6310)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### DEFAULT[​](#default "Direct link to DEFAULT")

> **DEFAULT**: `0`

Defined in: [WAProto/index.d.ts:6311](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6311)

* * *

### DEFAULT\_SUB[​](#default_sub "Direct link to DEFAULT_SUB")

> **DEFAULT\_SUB**: `3`

Defined in: [WAProto/index.d.ts:6314](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6314)

* * *

### PARENT[​](#parent "Direct link to PARENT")

> **PARENT**: `1`

Defined in: [WAProto/index.d.ts:6312](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6312)

* * *

### SUB[​](#sub "Direct link to SUB")

> **SUB**: `2`

Defined in: [WAProto/index.d.ts:6313](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6313)

---

<a name="enumeration-previewtype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ExtendedTextMessage/enumerations/PreviewType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ExtendedTextMessage/enumerations/PreviewType)

Defined in: [WAProto/index.d.ts:6317](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6317)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### IMAGE[​](#image "Direct link to IMAGE")

> **IMAGE**: `5`

Defined in: [WAProto/index.d.ts:6321](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6321)

* * *

### NONE[​](#none "Direct link to NONE")

> **NONE**: `0`

Defined in: [WAProto/index.d.ts:6318](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6318)

* * *

### PAYMENT\_LINKS[​](#payment_links "Direct link to PAYMENT_LINKS")

> **PAYMENT\_LINKS**: `6`

Defined in: [WAProto/index.d.ts:6322](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6322)

* * *

### PLACEHOLDER[​](#placeholder "Direct link to PLACEHOLDER")

> **PLACEHOLDER**: `4`

Defined in: [WAProto/index.d.ts:6320](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6320)

* * *

### PROFILE[​](#profile "Direct link to PROFILE")

> **PROFILE**: `7`

Defined in: [WAProto/index.d.ts:6323](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6323)

* * *

### VIDEO[​](#video "Direct link to VIDEO")

> **VIDEO**: `1`

Defined in: [WAProto/index.d.ts:6319](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6319)

---

<a name="groupinvitemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/GroupInviteMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/GroupInviteMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [GroupType](/docs/api/namespaces/proto/namespaces/Message/namespaces/GroupInviteMessage/enumerations/GroupType)

---

<a name="enumeration-grouptype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/GroupInviteMessage/enumerations/GroupType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/GroupInviteMessage/enumerations/GroupType)

Defined in: [WAProto/index.d.ts:6391](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6391)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### DEFAULT[​](#default "Direct link to DEFAULT")

> **DEFAULT**: `0`

Defined in: [WAProto/index.d.ts:6392](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6392)

* * *

### PARENT[​](#parent "Direct link to PARENT")

> **PARENT**: `1`

Defined in: [WAProto/index.d.ts:6393](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6393)

---

<a name="highlystructuredmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [HSMLocalizableParameter](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/)

## Classes[​](#classes "Direct link to Classes")

*   [HSMLocalizableParameter](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/classes/HSMLocalizableParameter)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IHSMLocalizableParameter](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/interfaces/IHSMLocalizableParameter)

---

<a name="class-hsmlocalizableparameter"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/classes/HSMLocalizableParameter](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/classes/HSMLocalizableParameter)

Defined in: [WAProto/index.d.ts:6437](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6437)

## Implements[​](#implements "Direct link to Implements")

*   [`IHSMLocalizableParameter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/interfaces/IHSMLocalizableParameter)

## Constructors[​](#constructors "Direct link to Constructors")

### new HSMLocalizableParameter()[​](#new-hsmlocalizableparameter "Direct link to new HSMLocalizableParameter()")

> **new HSMLocalizableParameter**(`p`?): [`HSMLocalizableParameter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/classes/HSMLocalizableParameter)

Defined in: [WAProto/index.d.ts:6438](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6438)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHSMLocalizableParameter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/interfaces/IHSMLocalizableParameter)

#### Returns[​](#returns "Direct link to Returns")

[`HSMLocalizableParameter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/classes/HSMLocalizableParameter)

## Properties[​](#properties "Direct link to Properties")

### currency?[​](#currency "Direct link to currency?")

> `optional` **currency**: `null` | [`IHSMCurrency`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMCurrency)

Defined in: [WAProto/index.d.ts:6440](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6440)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHSMLocalizableParameter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/interfaces/IHSMLocalizableParameter).[`currency`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/interfaces/IHSMLocalizableParameter#currency)

* * *

### dateTime?[​](#datetime "Direct link to dateTime?")

> `optional` **dateTime**: `null` | [`IHSMDateTime`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMDateTime)

Defined in: [WAProto/index.d.ts:6441](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6441)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IHSMLocalizableParameter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/interfaces/IHSMLocalizableParameter).[`dateTime`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/interfaces/IHSMLocalizableParameter#datetime)

* * *

### default?[​](#default "Direct link to default?")

> `optional` **default**: `null` | `string`

Defined in: [WAProto/index.d.ts:6439](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6439)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IHSMLocalizableParameter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/interfaces/IHSMLocalizableParameter).[`default`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/interfaces/IHSMLocalizableParameter#default)

* * *

### paramOneof?[​](#paramoneof "Direct link to paramOneof?")

> `optional` **paramOneof**: `"currency"` | `"dateTime"`

Defined in: [WAProto/index.d.ts:6442](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6442)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6448](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6448)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`HSMLocalizableParameter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/classes/HSMLocalizableParameter)

Defined in: [WAProto/index.d.ts:6443](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6443)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHSMLocalizableParameter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/interfaces/IHSMLocalizableParameter)

#### Returns[​](#returns-2 "Direct link to Returns")

[`HSMLocalizableParameter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/classes/HSMLocalizableParameter)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`HSMLocalizableParameter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/classes/HSMLocalizableParameter)

Defined in: [WAProto/index.d.ts:6445](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6445)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`HSMLocalizableParameter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/classes/HSMLocalizableParameter)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6444](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6444)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHSMLocalizableParameter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/interfaces/IHSMLocalizableParameter)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`HSMLocalizableParameter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/classes/HSMLocalizableParameter)

Defined in: [WAProto/index.d.ts:6446](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6446)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`HSMLocalizableParameter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/classes/HSMLocalizableParameter)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6449](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6449)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6447](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6447)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`HSMLocalizableParameter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/classes/HSMLocalizableParameter)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ihsmlocalizableparameter"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/interfaces/IHSMLocalizableParameter](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/interfaces/IHSMLocalizableParameter)

Defined in: [WAProto/index.d.ts:6431](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6431)

## Properties[​](#properties "Direct link to Properties")

### currency?[​](#currency "Direct link to currency?")

> `optional` **currency**: `null` | [`IHSMCurrency`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMCurrency)

Defined in: [WAProto/index.d.ts:6433](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6433)

* * *

### dateTime?[​](#datetime "Direct link to dateTime?")

> `optional` **dateTime**: `null` | [`IHSMDateTime`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMDateTime)

Defined in: [WAProto/index.d.ts:6434](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6434)

* * *

### default?[​](#default "Direct link to default?")

> `optional` **default**: `null` | `string`

Defined in: [WAProto/index.d.ts:6432](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6432)

---

<a name="hsmlocalizableparameter"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [HSMDateTime](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/)

## Classes[​](#classes "Direct link to Classes")

*   [HSMCurrency](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMCurrency)
*   [HSMDateTime](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMDateTime)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IHSMCurrency](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMCurrency)
*   [IHSMDateTime](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMDateTime)

---

<a name="class-hsmcurrency"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMCurrency](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMCurrency)

Defined in: [WAProto/index.d.ts:6459](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6459)

## Implements[​](#implements "Direct link to Implements")

*   [`IHSMCurrency`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMCurrency)

## Constructors[​](#constructors "Direct link to Constructors")

### new HSMCurrency()[​](#new-hsmcurrency "Direct link to new HSMCurrency()")

> **new HSMCurrency**(`p`?): [`HSMCurrency`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMCurrency)

Defined in: [WAProto/index.d.ts:6460](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6460)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHSMCurrency`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMCurrency)

#### Returns[​](#returns "Direct link to Returns")

[`HSMCurrency`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMCurrency)

## Properties[​](#properties "Direct link to Properties")

### amount1000?[​](#amount1000 "Direct link to amount1000?")

> `optional` **amount1000**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6462](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6462)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHSMCurrency`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMCurrency).[`amount1000`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMCurrency#amount1000)

* * *

### currencyCode?[​](#currencycode "Direct link to currencyCode?")

> `optional` **currencyCode**: `null` | `string`

Defined in: [WAProto/index.d.ts:6461](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6461)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IHSMCurrency`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMCurrency).[`currencyCode`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMCurrency#currencycode)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6468](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6468)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`HSMCurrency`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMCurrency)

Defined in: [WAProto/index.d.ts:6463](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6463)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHSMCurrency`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMCurrency)

#### Returns[​](#returns-2 "Direct link to Returns")

[`HSMCurrency`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMCurrency)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`HSMCurrency`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMCurrency)

Defined in: [WAProto/index.d.ts:6465](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6465)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`HSMCurrency`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMCurrency)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6464](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6464)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHSMCurrency`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMCurrency)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`HSMCurrency`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMCurrency)

Defined in: [WAProto/index.d.ts:6466](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6466)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`HSMCurrency`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMCurrency)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6469](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6469)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6467](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6467)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`HSMCurrency`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMCurrency)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-hsmdatetime"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMDateTime](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMDateTime)

Defined in: [WAProto/index.d.ts:6477](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6477)

## Implements[​](#implements "Direct link to Implements")

*   [`IHSMDateTime`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMDateTime)

## Constructors[​](#constructors "Direct link to Constructors")

### new HSMDateTime()[​](#new-hsmdatetime "Direct link to new HSMDateTime()")

> **new HSMDateTime**(`p`?): [`HSMDateTime`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMDateTime)

Defined in: [WAProto/index.d.ts:6478](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6478)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHSMDateTime`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMDateTime)

#### Returns[​](#returns "Direct link to Returns")

[`HSMDateTime`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMDateTime)

## Properties[​](#properties "Direct link to Properties")

### component?[​](#component "Direct link to component?")

> `optional` **component**: `null` | [`IHSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent)

Defined in: [WAProto/index.d.ts:6479](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6479)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHSMDateTime`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMDateTime).[`component`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMDateTime#component)

* * *

### datetimeOneof?[​](#datetimeoneof "Direct link to datetimeOneof?")

> `optional` **datetimeOneof**: `"component"` | `"unixEpoch"`

Defined in: [WAProto/index.d.ts:6481](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6481)

* * *

### unixEpoch?[​](#unixepoch "Direct link to unixEpoch?")

> `optional` **unixEpoch**: `null` | [`IHSMDateTimeUnixEpoch`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeUnixEpoch)

Defined in: [WAProto/index.d.ts:6480](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6480)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IHSMDateTime`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMDateTime).[`unixEpoch`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMDateTime#unixepoch)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6487](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6487)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`HSMDateTime`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMDateTime)

Defined in: [WAProto/index.d.ts:6482](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6482)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHSMDateTime`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMDateTime)

#### Returns[​](#returns-2 "Direct link to Returns")

[`HSMDateTime`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMDateTime)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`HSMDateTime`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMDateTime)

Defined in: [WAProto/index.d.ts:6484](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6484)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`HSMDateTime`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMDateTime)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6483](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6483)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHSMDateTime`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMDateTime)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`HSMDateTime`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMDateTime)

Defined in: [WAProto/index.d.ts:6485](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6485)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`HSMDateTime`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMDateTime)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6488](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6488)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6486](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6486)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`HSMDateTime`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/classes/HSMDateTime)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ihsmcurrency"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMCurrency](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMCurrency)

Defined in: [WAProto/index.d.ts:6454](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6454)

## Properties[​](#properties "Direct link to Properties")

### amount1000?[​](#amount1000 "Direct link to amount1000?")

> `optional` **amount1000**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6456](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6456)

* * *

### currencyCode?[​](#currencycode "Direct link to currencyCode?")

> `optional` **currencyCode**: `null` | `string`

Defined in: [WAProto/index.d.ts:6455](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6455)

---

<a name="interface-ihsmdatetime"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMDateTime](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/interfaces/IHSMDateTime)

Defined in: [WAProto/index.d.ts:6472](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6472)

## Properties[​](#properties "Direct link to Properties")

### component?[​](#component "Direct link to component?")

> `optional` **component**: `null` | [`IHSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent)

Defined in: [WAProto/index.d.ts:6473](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6473)

* * *

### unixEpoch?[​](#unixepoch "Direct link to unixEpoch?")

> `optional` **unixEpoch**: `null` | [`IHSMDateTimeUnixEpoch`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeUnixEpoch)

Defined in: [WAProto/index.d.ts:6474](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6474)

---

<a name="hsmdatetime"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [HSMDateTimeComponent](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/namespaces/HSMDateTimeComponent/)

## Classes[​](#classes "Direct link to Classes")

*   [HSMDateTimeComponent](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeComponent)
*   [HSMDateTimeUnixEpoch](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeUnixEpoch)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IHSMDateTimeComponent](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent)
*   [IHSMDateTimeUnixEpoch](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeUnixEpoch)

---

<a name="class-hsmdatetimecomponent"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeComponent](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeComponent)

Defined in: [WAProto/index.d.ts:6503](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6503)

## Implements[​](#implements "Direct link to Implements")

*   [`IHSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent)

## Constructors[​](#constructors "Direct link to Constructors")

### new HSMDateTimeComponent()[​](#new-hsmdatetimecomponent "Direct link to new HSMDateTimeComponent()")

> **new HSMDateTimeComponent**(`p`?): [`HSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeComponent)

Defined in: [WAProto/index.d.ts:6504](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6504)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent)

#### Returns[​](#returns "Direct link to Returns")

[`HSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeComponent)

## Properties[​](#properties "Direct link to Properties")

### calendar?[​](#calendar "Direct link to calendar?")

> `optional` **calendar**: `null` | [`CalendarType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/namespaces/HSMDateTimeComponent/enumerations/CalendarType)

Defined in: [WAProto/index.d.ts:6511](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6511)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent).[`calendar`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent#calendar)

* * *

### dayOfMonth?[​](#dayofmonth "Direct link to dayOfMonth?")

> `optional` **dayOfMonth**: `null` | `number`

Defined in: [WAProto/index.d.ts:6508](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6508)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IHSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent).[`dayOfMonth`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent#dayofmonth)

* * *

### dayOfWeek?[​](#dayofweek "Direct link to dayOfWeek?")

> `optional` **dayOfWeek**: `null` | [`DayOfWeekType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/namespaces/HSMDateTimeComponent/enumerations/DayOfWeekType)

Defined in: [WAProto/index.d.ts:6505](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6505)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IHSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent).[`dayOfWeek`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent#dayofweek)

* * *

### hour?[​](#hour "Direct link to hour?")

> `optional` **hour**: `null` | `number`

Defined in: [WAProto/index.d.ts:6509](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6509)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IHSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent).[`hour`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent#hour)

* * *

### minute?[​](#minute "Direct link to minute?")

> `optional` **minute**: `null` | `number`

Defined in: [WAProto/index.d.ts:6510](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6510)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IHSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent).[`minute`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent#minute)

* * *

### month?[​](#month "Direct link to month?")

> `optional` **month**: `null` | `number`

Defined in: [WAProto/index.d.ts:6507](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6507)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IHSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent).[`month`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent#month)

* * *

### year?[​](#year "Direct link to year?")

> `optional` **year**: `null` | `number`

Defined in: [WAProto/index.d.ts:6506](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6506)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IHSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent).[`year`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent#year)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6517](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6517)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`HSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeComponent)

Defined in: [WAProto/index.d.ts:6512](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6512)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent)

#### Returns[​](#returns-2 "Direct link to Returns")

[`HSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeComponent)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`HSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeComponent)

Defined in: [WAProto/index.d.ts:6514](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6514)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`HSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeComponent)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6513](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6513)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`HSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeComponent)

Defined in: [WAProto/index.d.ts:6515](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6515)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`HSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeComponent)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6518](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6518)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6516](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6516)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`HSMDateTimeComponent`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeComponent)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-hsmdatetimeunixepoch"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeUnixEpoch](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeUnixEpoch)

Defined in: [WAProto/index.d.ts:6543](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6543)

## Implements[​](#implements "Direct link to Implements")

*   [`IHSMDateTimeUnixEpoch`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeUnixEpoch)

## Constructors[​](#constructors "Direct link to Constructors")

### new HSMDateTimeUnixEpoch()[​](#new-hsmdatetimeunixepoch "Direct link to new HSMDateTimeUnixEpoch()")

> **new HSMDateTimeUnixEpoch**(`p`?): [`HSMDateTimeUnixEpoch`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeUnixEpoch)

Defined in: [WAProto/index.d.ts:6544](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6544)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHSMDateTimeUnixEpoch`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeUnixEpoch)

#### Returns[​](#returns "Direct link to Returns")

[`HSMDateTimeUnixEpoch`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeUnixEpoch)

## Properties[​](#properties "Direct link to Properties")

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6545](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6545)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHSMDateTimeUnixEpoch`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeUnixEpoch).[`timestamp`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeUnixEpoch#timestamp)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6551](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6551)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`HSMDateTimeUnixEpoch`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeUnixEpoch)

Defined in: [WAProto/index.d.ts:6546](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6546)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHSMDateTimeUnixEpoch`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeUnixEpoch)

#### Returns[​](#returns-2 "Direct link to Returns")

[`HSMDateTimeUnixEpoch`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeUnixEpoch)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`HSMDateTimeUnixEpoch`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeUnixEpoch)

Defined in: [WAProto/index.d.ts:6548](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6548)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`HSMDateTimeUnixEpoch`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeUnixEpoch)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6547](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6547)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHSMDateTimeUnixEpoch`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeUnixEpoch)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`HSMDateTimeUnixEpoch`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeUnixEpoch)

Defined in: [WAProto/index.d.ts:6549](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6549)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`HSMDateTimeUnixEpoch`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeUnixEpoch)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6552](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6552)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6550](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6550)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`HSMDateTimeUnixEpoch`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/classes/HSMDateTimeUnixEpoch)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ihsmdatetimecomponent"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeComponent)

Defined in: [WAProto/index.d.ts:6493](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6493)

## Properties[​](#properties "Direct link to Properties")

### calendar?[​](#calendar "Direct link to calendar?")

> `optional` **calendar**: `null` | [`CalendarType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/namespaces/HSMDateTimeComponent/enumerations/CalendarType)

Defined in: [WAProto/index.d.ts:6500](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6500)

* * *

### dayOfMonth?[​](#dayofmonth "Direct link to dayOfMonth?")

> `optional` **dayOfMonth**: `null` | `number`

Defined in: [WAProto/index.d.ts:6497](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6497)

* * *

### dayOfWeek?[​](#dayofweek "Direct link to dayOfWeek?")

> `optional` **dayOfWeek**: `null` | [`DayOfWeekType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/namespaces/HSMDateTimeComponent/enumerations/DayOfWeekType)

Defined in: [WAProto/index.d.ts:6494](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6494)

* * *

### hour?[​](#hour "Direct link to hour?")

> `optional` **hour**: `null` | `number`

Defined in: [WAProto/index.d.ts:6498](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6498)

* * *

### minute?[​](#minute "Direct link to minute?")

> `optional` **minute**: `null` | `number`

Defined in: [WAProto/index.d.ts:6499](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6499)

* * *

### month?[​](#month "Direct link to month?")

> `optional` **month**: `null` | `number`

Defined in: [WAProto/index.d.ts:6496](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6496)

* * *

### year?[​](#year "Direct link to year?")

> `optional` **year**: `null` | `number`

Defined in: [WAProto/index.d.ts:6495](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6495)

---

<a name="interface-ihsmdatetimeunixepoch"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeUnixEpoch](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/interfaces/IHSMDateTimeUnixEpoch)

Defined in: [WAProto/index.d.ts:6539](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6539)

## Properties[​](#properties "Direct link to Properties")

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:6540](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6540)

---

<a name="hsmdatetimecomponent"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/namespaces/HSMDateTimeComponent/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/namespaces/HSMDateTimeComponent/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [CalendarType](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/namespaces/HSMDateTimeComponent/enumerations/CalendarType)
*   [DayOfWeekType](/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/namespaces/HSMDateTimeComponent/enumerations/DayOfWeekType)

---

<a name="enumeration-calendartype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/namespaces/HSMDateTimeComponent/enumerations/CalendarType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/namespaces/HSMDateTimeComponent/enumerations/CalendarType)

Defined in: [WAProto/index.d.ts:6523](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6523)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### GREGORIAN[​](#gregorian "Direct link to GREGORIAN")

> **GREGORIAN**: `1`

Defined in: [WAProto/index.d.ts:6524](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6524)

* * *

### SOLAR\_HIJRI[​](#solar_hijri "Direct link to SOLAR_HIJRI")

> **SOLAR\_HIJRI**: `2`

Defined in: [WAProto/index.d.ts:6525](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6525)

---

<a name="enumeration-dayofweektype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/namespaces/HSMDateTimeComponent/enumerations/DayOfWeekType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/HighlyStructuredMessage/namespaces/HSMLocalizableParameter/namespaces/HSMDateTime/namespaces/HSMDateTimeComponent/enumerations/DayOfWeekType)

Defined in: [WAProto/index.d.ts:6528](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6528)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### FRIDAY[​](#friday "Direct link to FRIDAY")

> **FRIDAY**: `5`

Defined in: [WAProto/index.d.ts:6533](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6533)

* * *

### MONDAY[​](#monday "Direct link to MONDAY")

> **MONDAY**: `1`

Defined in: [WAProto/index.d.ts:6529](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6529)

* * *

### SATURDAY[​](#saturday "Direct link to SATURDAY")

> **SATURDAY**: `6`

Defined in: [WAProto/index.d.ts:6534](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6534)

* * *

### SUNDAY[​](#sunday "Direct link to SUNDAY")

> **SUNDAY**: `7`

Defined in: [WAProto/index.d.ts:6535](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6535)

* * *

### THURSDAY[​](#thursday "Direct link to THURSDAY")

> **THURSDAY**: `4`

Defined in: [WAProto/index.d.ts:6532](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6532)

* * *

### TUESDAY[​](#tuesday "Direct link to TUESDAY")

> **TUESDAY**: `2`

Defined in: [WAProto/index.d.ts:6530](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6530)

* * *

### WEDNESDAY[​](#wednesday "Direct link to WEDNESDAY")

> **WEDNESDAY**: `3`

Defined in: [WAProto/index.d.ts:6531](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6531)

---

<a name="imagemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ImageMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ImageMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [ImageSourceType](/docs/api/namespaces/proto/namespaces/Message/namespaces/ImageMessage/enumerations/ImageSourceType)

---

<a name="enumeration-imagesourcetype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ImageMessage/enumerations/ImageSourceType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ImageMessage/enumerations/ImageSourceType)

Defined in: [WAProto/index.d.ts:6708](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6708)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AI\_GENERATED[​](#ai_generated "Direct link to AI_GENERATED")

> **AI\_GENERATED**: `1`

Defined in: [WAProto/index.d.ts:6710](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6710)

* * *

### AI\_MODIFIED[​](#ai_modified "Direct link to AI_MODIFIED")

> **AI\_MODIFIED**: `2`

Defined in: [WAProto/index.d.ts:6711](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6711)

* * *

### RASTERIZED\_TEXT\_STATUS[​](#rasterized_text_status "Direct link to RASTERIZED_TEXT_STATUS")

> **RASTERIZED\_TEXT\_STATUS**: `3`

Defined in: [WAProto/index.d.ts:6712](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6712)

* * *

### USER\_IMAGE[​](#user_image "Direct link to USER_IMAGE")

> **USER\_IMAGE**: `0`

Defined in: [WAProto/index.d.ts:6709](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6709)

---

<a name="interactivemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [CarouselMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/CarouselMessage/)
*   [NativeFlowMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/)
*   [ShopMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/ShopMessage/)

## Classes[​](#classes "Direct link to Classes")

*   [Body](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Body)
*   [CarouselMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CarouselMessage)
*   [CollectionMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CollectionMessage)
*   [Footer](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Footer)
*   [Header](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Header)
*   [NativeFlowMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/NativeFlowMessage)
*   [ShopMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/ShopMessage)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IBody](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IBody)
*   [ICarouselMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICarouselMessage)
*   [ICollectionMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICollectionMessage)
*   [IFooter](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IFooter)
*   [IHeader](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader)
*   [INativeFlowMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/INativeFlowMessage)
*   [IShopMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IShopMessage)

---

<a name="class-body"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Body](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Body)

Defined in: [WAProto/index.d.ts:6771](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6771)

## Implements[​](#implements "Direct link to Implements")

*   [`IBody`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IBody)

## Constructors[​](#constructors "Direct link to Constructors")

### new Body()[​](#new-body "Direct link to new Body()")

> **new Body**(`p`?): [`Body`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Body)

Defined in: [WAProto/index.d.ts:6772](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6772)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBody`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IBody)

#### Returns[​](#returns "Direct link to Returns")

[`Body`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Body)

## Properties[​](#properties "Direct link to Properties")

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:6773](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6773)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBody`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IBody).[`text`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IBody#text)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6779](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6779)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Body`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Body)

Defined in: [WAProto/index.d.ts:6774](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6774)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBody`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IBody)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Body`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Body)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Body`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Body)

Defined in: [WAProto/index.d.ts:6776](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6776)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Body`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Body)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6775](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6775)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBody`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IBody)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Body`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Body)

Defined in: [WAProto/index.d.ts:6777](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6777)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Body`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Body)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6780](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6780)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6778](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6778)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Body`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Body)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-carouselmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CarouselMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CarouselMessage)

Defined in: [WAProto/index.d.ts:6789](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6789)

## Implements[​](#implements "Direct link to Implements")

*   [`ICarouselMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICarouselMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new CarouselMessage()[​](#new-carouselmessage "Direct link to new CarouselMessage()")

> **new CarouselMessage**(`p`?): [`CarouselMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CarouselMessage)

Defined in: [WAProto/index.d.ts:6790](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6790)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICarouselMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICarouselMessage)

#### Returns[​](#returns "Direct link to Returns")

[`CarouselMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CarouselMessage)

## Properties[​](#properties "Direct link to Properties")

### cards[​](#cards "Direct link to cards")

> **cards**: [`IInteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage)\[\]

Defined in: [WAProto/index.d.ts:6791](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6791)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICarouselMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICarouselMessage).[`cards`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICarouselMessage#cards)

* * *

### carouselCardType?[​](#carouselcardtype "Direct link to carouselCardType?")

> `optional` **carouselCardType**: `null` | [`CarouselCardType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/CarouselMessage/enumerations/CarouselCardType)

Defined in: [WAProto/index.d.ts:6793](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6793)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ICarouselMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICarouselMessage).[`carouselCardType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICarouselMessage#carouselcardtype)

* * *

### messageVersion?[​](#messageversion "Direct link to messageVersion?")

> `optional` **messageVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:6792](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6792)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ICarouselMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICarouselMessage).[`messageVersion`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICarouselMessage#messageversion)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6799](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6799)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CarouselMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CarouselMessage)

Defined in: [WAProto/index.d.ts:6794](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6794)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICarouselMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICarouselMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CarouselMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CarouselMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CarouselMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CarouselMessage)

Defined in: [WAProto/index.d.ts:6796](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6796)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CarouselMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CarouselMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6795](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6795)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICarouselMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICarouselMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CarouselMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CarouselMessage)

Defined in: [WAProto/index.d.ts:6797](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6797)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CarouselMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CarouselMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6800](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6800)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6798](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6798)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CarouselMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CarouselMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-collectionmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CollectionMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CollectionMessage)

Defined in: [WAProto/index.d.ts:6818](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6818)

## Implements[​](#implements "Direct link to Implements")

*   [`ICollectionMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICollectionMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new CollectionMessage()[​](#new-collectionmessage "Direct link to new CollectionMessage()")

> **new CollectionMessage**(`p`?): [`CollectionMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CollectionMessage)

Defined in: [WAProto/index.d.ts:6819](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6819)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICollectionMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICollectionMessage)

#### Returns[​](#returns "Direct link to Returns")

[`CollectionMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CollectionMessage)

## Properties[​](#properties "Direct link to Properties")

### bizJid?[​](#bizjid "Direct link to bizJid?")

> `optional` **bizJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:6820](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6820)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICollectionMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICollectionMessage).[`bizJid`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICollectionMessage#bizjid)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:6821](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6821)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ICollectionMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICollectionMessage).[`id`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICollectionMessage#id)

* * *

### messageVersion?[​](#messageversion "Direct link to messageVersion?")

> `optional` **messageVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:6822](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6822)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ICollectionMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICollectionMessage).[`messageVersion`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICollectionMessage#messageversion)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6828](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6828)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CollectionMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CollectionMessage)

Defined in: [WAProto/index.d.ts:6823](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6823)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICollectionMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICollectionMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CollectionMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CollectionMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CollectionMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CollectionMessage)

Defined in: [WAProto/index.d.ts:6825](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6825)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CollectionMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CollectionMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6824](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6824)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICollectionMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICollectionMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CollectionMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CollectionMessage)

Defined in: [WAProto/index.d.ts:6826](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6826)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CollectionMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CollectionMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6829](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6829)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6827](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6827)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CollectionMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/CollectionMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-footer"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Footer](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Footer)

Defined in: [WAProto/index.d.ts:6838](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6838)

## Implements[​](#implements "Direct link to Implements")

*   [`IFooter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IFooter)

## Constructors[​](#constructors "Direct link to Constructors")

### new Footer()[​](#new-footer "Direct link to new Footer()")

> **new Footer**(`p`?): [`Footer`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Footer)

Defined in: [WAProto/index.d.ts:6839](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6839)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IFooter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IFooter)

#### Returns[​](#returns "Direct link to Returns")

[`Footer`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Footer)

## Properties[​](#properties "Direct link to Properties")

### audioMessage?[​](#audiomessage "Direct link to audioMessage?")

> `optional` **audioMessage**: `null` | [`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage)

Defined in: [WAProto/index.d.ts:6842](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6842)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IFooter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IFooter).[`audioMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IFooter#audiomessage)

* * *

### hasMediaAttachment?[​](#hasmediaattachment "Direct link to hasMediaAttachment?")

> `optional` **hasMediaAttachment**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6841](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6841)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IFooter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IFooter).[`hasMediaAttachment`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IFooter#hasmediaattachment)

* * *

### media?[​](#media "Direct link to media?")

> `optional` **media**: `"audioMessage"`

Defined in: [WAProto/index.d.ts:6843](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6843)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:6840](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6840)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IFooter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IFooter).[`text`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IFooter#text)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6849](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6849)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Footer`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Footer)

Defined in: [WAProto/index.d.ts:6844](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6844)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IFooter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IFooter)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Footer`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Footer)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Footer`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Footer)

Defined in: [WAProto/index.d.ts:6846](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6846)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Footer`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Footer)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6845](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6845)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IFooter`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IFooter)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Footer`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Footer)

Defined in: [WAProto/index.d.ts:6847](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6847)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Footer`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Footer)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6850](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6850)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6848](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6848)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Footer`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Footer)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-header"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Header](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Header)

Defined in: [WAProto/index.d.ts:6865](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6865)

## Implements[​](#implements "Direct link to Implements")

*   [`IHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader)

## Constructors[​](#constructors "Direct link to Constructors")

### new Header()[​](#new-header "Direct link to new Header()")

> **new Header**(`p`?): [`Header`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Header)

Defined in: [WAProto/index.d.ts:6866](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6866)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader)

#### Returns[​](#returns "Direct link to Returns")

[`Header`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Header)

## Properties[​](#properties "Direct link to Properties")

### documentMessage?[​](#documentmessage "Direct link to documentMessage?")

> `optional` **documentMessage**: `null` | [`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage)

Defined in: [WAProto/index.d.ts:6870](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6870)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader).[`documentMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader#documentmessage)

* * *

### hasMediaAttachment?[​](#hasmediaattachment "Direct link to hasMediaAttachment?")

> `optional` **hasMediaAttachment**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6869](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6869)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader).[`hasMediaAttachment`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader#hasmediaattachment)

* * *

### imageMessage?[​](#imagemessage "Direct link to imageMessage?")

> `optional` **imageMessage**: `null` | [`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage)

Defined in: [WAProto/index.d.ts:6871](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6871)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader).[`imageMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader#imagemessage)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6872](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6872)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader).[`jpegThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader#jpegthumbnail)

* * *

### locationMessage?[​](#locationmessage "Direct link to locationMessage?")

> `optional` **locationMessage**: `null` | [`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage)

Defined in: [WAProto/index.d.ts:6874](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6874)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader).[`locationMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader#locationmessage)

* * *

### media?[​](#media "Direct link to media?")

> `optional` **media**: `"imageMessage"` | `"locationMessage"` | `"documentMessage"` | `"videoMessage"` | `"productMessage"` | `"jpegThumbnail"`

Defined in: [WAProto/index.d.ts:6876](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6876)

* * *

### productMessage?[​](#productmessage "Direct link to productMessage?")

> `optional` **productMessage**: `null` | [`IProductMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage)

Defined in: [WAProto/index.d.ts:6875](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6875)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader).[`productMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader#productmessage)

* * *

### subtitle?[​](#subtitle "Direct link to subtitle?")

> `optional` **subtitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:6868](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6868)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader).[`subtitle`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader#subtitle)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:6867](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6867)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader).[`title`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader#title)

* * *

### videoMessage?[​](#videomessage "Direct link to videoMessage?")

> `optional` **videoMessage**: `null` | [`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage)

Defined in: [WAProto/index.d.ts:6873](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6873)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader).[`videoMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader#videomessage)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6882](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6882)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Header`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Header)

Defined in: [WAProto/index.d.ts:6877](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6877)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Header`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Header)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Header`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Header)

Defined in: [WAProto/index.d.ts:6879](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6879)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Header`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Header)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6878](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6878)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Header`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Header)

Defined in: [WAProto/index.d.ts:6880](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6880)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Header`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Header)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6883](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6883)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6881](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6881)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Header`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/Header)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-nativeflowmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/NativeFlowMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/NativeFlowMessage)

Defined in: [WAProto/index.d.ts:6892](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6892)

## Implements[​](#implements "Direct link to Implements")

*   [`INativeFlowMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/INativeFlowMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new NativeFlowMessage()[​](#new-nativeflowmessage "Direct link to new NativeFlowMessage()")

> **new NativeFlowMessage**(`p`?): [`NativeFlowMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/NativeFlowMessage)

Defined in: [WAProto/index.d.ts:6893](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6893)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`INativeFlowMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/INativeFlowMessage)

#### Returns[​](#returns "Direct link to Returns")

[`NativeFlowMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/NativeFlowMessage)

## Properties[​](#properties "Direct link to Properties")

### buttons[​](#buttons "Direct link to buttons")

> **buttons**: [`INativeFlowButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/interfaces/INativeFlowButton)\[\]

Defined in: [WAProto/index.d.ts:6894](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6894)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`INativeFlowMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/INativeFlowMessage).[`buttons`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/INativeFlowMessage#buttons)

* * *

### messageParamsJson?[​](#messageparamsjson "Direct link to messageParamsJson?")

> `optional` **messageParamsJson**: `null` | `string`

Defined in: [WAProto/index.d.ts:6895](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6895)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`INativeFlowMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/INativeFlowMessage).[`messageParamsJson`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/INativeFlowMessage#messageparamsjson)

* * *

### messageVersion?[​](#messageversion "Direct link to messageVersion?")

> `optional` **messageVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:6896](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6896)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`INativeFlowMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/INativeFlowMessage).[`messageVersion`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/INativeFlowMessage#messageversion)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6902](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6902)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`NativeFlowMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/NativeFlowMessage)

Defined in: [WAProto/index.d.ts:6897](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6897)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`INativeFlowMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/INativeFlowMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`NativeFlowMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/NativeFlowMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`NativeFlowMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/NativeFlowMessage)

Defined in: [WAProto/index.d.ts:6899](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6899)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`NativeFlowMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/NativeFlowMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6898](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6898)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`INativeFlowMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/INativeFlowMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`NativeFlowMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/NativeFlowMessage)

Defined in: [WAProto/index.d.ts:6900](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6900)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`NativeFlowMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/NativeFlowMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6903](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6903)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6901](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6901)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`NativeFlowMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/NativeFlowMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-shopmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/ShopMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/ShopMessage)

Defined in: [WAProto/index.d.ts:6933](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6933)

## Implements[​](#implements "Direct link to Implements")

*   [`IShopMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IShopMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new ShopMessage()[​](#new-shopmessage "Direct link to new ShopMessage()")

> **new ShopMessage**(`p`?): [`ShopMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/ShopMessage)

Defined in: [WAProto/index.d.ts:6934](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6934)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IShopMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IShopMessage)

#### Returns[​](#returns "Direct link to Returns")

[`ShopMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/ShopMessage)

## Properties[​](#properties "Direct link to Properties")

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:6935](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6935)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IShopMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IShopMessage).[`id`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IShopMessage#id)

* * *

### messageVersion?[​](#messageversion "Direct link to messageVersion?")

> `optional` **messageVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:6937](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6937)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IShopMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IShopMessage).[`messageVersion`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IShopMessage#messageversion)

* * *

### surface?[​](#surface "Direct link to surface?")

> `optional` **surface**: `null` | [`Surface`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/ShopMessage/enumerations/Surface)

Defined in: [WAProto/index.d.ts:6936](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6936)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IShopMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IShopMessage).[`surface`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IShopMessage#surface)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6943](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6943)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ShopMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/ShopMessage)

Defined in: [WAProto/index.d.ts:6938](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6938)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IShopMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IShopMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ShopMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/ShopMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ShopMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/ShopMessage)

Defined in: [WAProto/index.d.ts:6940](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6940)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ShopMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/ShopMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6939](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6939)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IShopMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IShopMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ShopMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/ShopMessage)

Defined in: [WAProto/index.d.ts:6941](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6941)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ShopMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/ShopMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6944](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6944)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6942](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6942)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ShopMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/classes/ShopMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ibody"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IBody](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IBody)

Defined in: [WAProto/index.d.ts:6767](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6767)

## Properties[​](#properties "Direct link to Properties")

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:6768](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6768)

---

<a name="interface-icarouselmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICarouselMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICarouselMessage)

Defined in: [WAProto/index.d.ts:6783](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6783)

## Properties[​](#properties "Direct link to Properties")

### cards?[​](#cards "Direct link to cards?")

> `optional` **cards**: `null` | [`IInteractiveMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IInteractiveMessage)\[\]

Defined in: [WAProto/index.d.ts:6784](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6784)

* * *

### carouselCardType?[​](#carouselcardtype "Direct link to carouselCardType?")

> `optional` **carouselCardType**: `null` | [`CarouselCardType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/CarouselMessage/enumerations/CarouselCardType)

Defined in: [WAProto/index.d.ts:6786](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6786)

* * *

### messageVersion?[​](#messageversion "Direct link to messageVersion?")

> `optional` **messageVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:6785](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6785)

---

<a name="interface-icollectionmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICollectionMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/ICollectionMessage)

Defined in: [WAProto/index.d.ts:6812](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6812)

## Properties[​](#properties "Direct link to Properties")

### bizJid?[​](#bizjid "Direct link to bizJid?")

> `optional` **bizJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:6813](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6813)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:6814](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6814)

* * *

### messageVersion?[​](#messageversion "Direct link to messageVersion?")

> `optional` **messageVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:6815](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6815)

---

<a name="interface-ifooter"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IFooter](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IFooter)

Defined in: [WAProto/index.d.ts:6832](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6832)

## Properties[​](#properties "Direct link to Properties")

### audioMessage?[​](#audiomessage "Direct link to audioMessage?")

> `optional` **audioMessage**: `null` | [`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage)

Defined in: [WAProto/index.d.ts:6835](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6835)

* * *

### hasMediaAttachment?[​](#hasmediaattachment "Direct link to hasMediaAttachment?")

> `optional` **hasMediaAttachment**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6834](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6834)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:6833](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6833)

---

<a name="interface-iheader"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IHeader)

Defined in: [WAProto/index.d.ts:6853](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6853)

## Properties[​](#properties "Direct link to Properties")

### documentMessage?[​](#documentmessage "Direct link to documentMessage?")

> `optional` **documentMessage**: `null` | [`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage)

Defined in: [WAProto/index.d.ts:6857](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6857)

* * *

### hasMediaAttachment?[​](#hasmediaattachment "Direct link to hasMediaAttachment?")

> `optional` **hasMediaAttachment**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:6856](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6856)

* * *

### imageMessage?[​](#imagemessage "Direct link to imageMessage?")

> `optional` **imageMessage**: `null` | [`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage)

Defined in: [WAProto/index.d.ts:6858](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6858)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:6859](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6859)

* * *

### locationMessage?[​](#locationmessage "Direct link to locationMessage?")

> `optional` **locationMessage**: `null` | [`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage)

Defined in: [WAProto/index.d.ts:6861](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6861)

* * *

### productMessage?[​](#productmessage "Direct link to productMessage?")

> `optional` **productMessage**: `null` | [`IProductMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IProductMessage)

Defined in: [WAProto/index.d.ts:6862](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6862)

* * *

### subtitle?[​](#subtitle "Direct link to subtitle?")

> `optional` **subtitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:6855](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6855)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:6854](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6854)

* * *

### videoMessage?[​](#videomessage "Direct link to videoMessage?")

> `optional` **videoMessage**: `null` | [`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage)

Defined in: [WAProto/index.d.ts:6860](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6860)

---

<a name="interface-inativeflowmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/INativeFlowMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/INativeFlowMessage)

Defined in: [WAProto/index.d.ts:6886](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6886)

## Properties[​](#properties "Direct link to Properties")

### buttons?[​](#buttons "Direct link to buttons?")

> `optional` **buttons**: `null` | [`INativeFlowButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/interfaces/INativeFlowButton)\[\]

Defined in: [WAProto/index.d.ts:6887](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6887)

* * *

### messageParamsJson?[​](#messageparamsjson "Direct link to messageParamsJson?")

> `optional` **messageParamsJson**: `null` | `string`

Defined in: [WAProto/index.d.ts:6888](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6888)

* * *

### messageVersion?[​](#messageversion "Direct link to messageVersion?")

> `optional` **messageVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:6889](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6889)

---

<a name="interface-ishopmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IShopMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/interfaces/IShopMessage)

Defined in: [WAProto/index.d.ts:6927](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6927)

## Properties[​](#properties "Direct link to Properties")

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:6928](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6928)

* * *

### messageVersion?[​](#messageversion "Direct link to messageVersion?")

> `optional` **messageVersion**: `null` | `number`

Defined in: [WAProto/index.d.ts:6930](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6930)

* * *

### surface?[​](#surface "Direct link to surface?")

> `optional` **surface**: `null` | [`Surface`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/ShopMessage/enumerations/Surface)

Defined in: [WAProto/index.d.ts:6929](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6929)

---

<a name="carouselmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/CarouselMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/CarouselMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [CarouselCardType](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/CarouselMessage/enumerations/CarouselCardType)

---

<a name="enumeration-carouselcardtype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/CarouselMessage/enumerations/CarouselCardType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/CarouselMessage/enumerations/CarouselCardType)

Defined in: [WAProto/index.d.ts:6805](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6805)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### ALBUM\_IMAGE[​](#album_image "Direct link to ALBUM_IMAGE")

> **ALBUM\_IMAGE**: `2`

Defined in: [WAProto/index.d.ts:6808](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6808)

* * *

### HSCROLL\_CARDS[​](#hscroll_cards "Direct link to HSCROLL_CARDS")

> **HSCROLL\_CARDS**: `1`

Defined in: [WAProto/index.d.ts:6807](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6807)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:6806](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6806)

---

<a name="nativeflowmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/)

## Classes[​](#classes "Direct link to Classes")

*   [NativeFlowButton](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/classes/NativeFlowButton)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [INativeFlowButton](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/interfaces/INativeFlowButton)

---

<a name="class-nativeflowbutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/classes/NativeFlowButton](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/classes/NativeFlowButton)

Defined in: [WAProto/index.d.ts:6913](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6913)

## Implements[​](#implements "Direct link to Implements")

*   [`INativeFlowButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/interfaces/INativeFlowButton)

## Constructors[​](#constructors "Direct link to Constructors")

### new NativeFlowButton()[​](#new-nativeflowbutton "Direct link to new NativeFlowButton()")

> **new NativeFlowButton**(`p`?): [`NativeFlowButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/classes/NativeFlowButton)

Defined in: [WAProto/index.d.ts:6914](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6914)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`INativeFlowButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/interfaces/INativeFlowButton)

#### Returns[​](#returns "Direct link to Returns")

[`NativeFlowButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/classes/NativeFlowButton)

## Properties[​](#properties "Direct link to Properties")

### buttonParamsJson?[​](#buttonparamsjson "Direct link to buttonParamsJson?")

> `optional` **buttonParamsJson**: `null` | `string`

Defined in: [WAProto/index.d.ts:6916](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6916)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`INativeFlowButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/interfaces/INativeFlowButton).[`buttonParamsJson`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/interfaces/INativeFlowButton#buttonparamsjson)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:6915](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6915)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`INativeFlowButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/interfaces/INativeFlowButton).[`name`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/interfaces/INativeFlowButton#name)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6922](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6922)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`NativeFlowButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/classes/NativeFlowButton)

Defined in: [WAProto/index.d.ts:6917](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6917)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`INativeFlowButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/interfaces/INativeFlowButton)

#### Returns[​](#returns-2 "Direct link to Returns")

[`NativeFlowButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/classes/NativeFlowButton)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`NativeFlowButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/classes/NativeFlowButton)

Defined in: [WAProto/index.d.ts:6919](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6919)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`NativeFlowButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/classes/NativeFlowButton)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6918](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6918)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`INativeFlowButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/interfaces/INativeFlowButton)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`NativeFlowButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/classes/NativeFlowButton)

Defined in: [WAProto/index.d.ts:6920](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6920)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`NativeFlowButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/classes/NativeFlowButton)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6923](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6923)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6921](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6921)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`NativeFlowButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/classes/NativeFlowButton)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-inativeflowbutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/interfaces/INativeFlowButton](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/NativeFlowMessage/interfaces/INativeFlowButton)

Defined in: [WAProto/index.d.ts:6908](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6908)

## Properties[​](#properties "Direct link to Properties")

### buttonParamsJson?[​](#buttonparamsjson "Direct link to buttonParamsJson?")

> `optional` **buttonParamsJson**: `null` | `string`

Defined in: [WAProto/index.d.ts:6910](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6910)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:6909](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6909)

---

<a name="shopmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/ShopMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/ShopMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Surface](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/ShopMessage/enumerations/Surface)

---

<a name="enumeration-surface"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/ShopMessage/enumerations/Surface](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveMessage/namespaces/ShopMessage/enumerations/Surface)

Defined in: [WAProto/index.d.ts:6949](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6949)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### FB[​](#fb "Direct link to FB")

> **FB**: `1`

Defined in: [WAProto/index.d.ts:6951](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6951)

* * *

### IG[​](#ig "Direct link to IG")

> **IG**: `2`

Defined in: [WAProto/index.d.ts:6952](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6952)

* * *

### UNKNOWN\_SURFACE[​](#unknown_surface "Direct link to UNKNOWN_SURFACE")

> **UNKNOWN\_SURFACE**: `0`

Defined in: [WAProto/index.d.ts:6950](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6950)

* * *

### WA[​](#wa "Direct link to WA")

> **WA**: `3`

Defined in: [WAProto/index.d.ts:6953](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6953)

---

<a name="interactiveresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [Body](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/namespaces/Body/)

## Classes[​](#classes "Direct link to Classes")

*   [Body](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/Body)
*   [NativeFlowResponseMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/NativeFlowResponseMessage)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IBody](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/IBody)
*   [INativeFlowResponseMessage](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/INativeFlowResponseMessage)

---

<a name="class-body"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/Body](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/Body)

Defined in: [WAProto/index.d.ts:6986](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6986)

## Implements[​](#implements "Direct link to Implements")

*   [`IBody`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/IBody)

## Constructors[​](#constructors "Direct link to Constructors")

### new Body()[​](#new-body "Direct link to new Body()")

> **new Body**(`p`?): [`Body`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/Body)

Defined in: [WAProto/index.d.ts:6987](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6987)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBody`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/IBody)

#### Returns[​](#returns "Direct link to Returns")

[`Body`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/Body)

## Properties[​](#properties "Direct link to Properties")

### format?[​](#format "Direct link to format?")

> `optional` **format**: `null` | [`Format`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/namespaces/Body/enumerations/Format)

Defined in: [WAProto/index.d.ts:6989](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6989)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBody`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/IBody).[`format`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/IBody#format)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:6988](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6988)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBody`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/IBody).[`text`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/IBody#text)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:6995](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6995)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Body`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/Body)

Defined in: [WAProto/index.d.ts:6990](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6990)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBody`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/IBody)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Body`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/Body)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Body`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/Body)

Defined in: [WAProto/index.d.ts:6992](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6992)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Body`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/Body)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:6991](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6991)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBody`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/IBody)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Body`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/Body)

Defined in: [WAProto/index.d.ts:6993](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6993)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Body`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/Body)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:6996](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6996)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:6994](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6994)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Body`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/Body)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-nativeflowresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/NativeFlowResponseMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/NativeFlowResponseMessage)

Defined in: [WAProto/index.d.ts:7013](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7013)

## Implements[​](#implements "Direct link to Implements")

*   [`INativeFlowResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/INativeFlowResponseMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new NativeFlowResponseMessage()[​](#new-nativeflowresponsemessage "Direct link to new NativeFlowResponseMessage()")

> **new NativeFlowResponseMessage**(`p`?): [`NativeFlowResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/NativeFlowResponseMessage)

Defined in: [WAProto/index.d.ts:7014](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7014)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`INativeFlowResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/INativeFlowResponseMessage)

#### Returns[​](#returns "Direct link to Returns")

[`NativeFlowResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/NativeFlowResponseMessage)

## Properties[​](#properties "Direct link to Properties")

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:7015](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7015)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`INativeFlowResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/INativeFlowResponseMessage).[`name`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/INativeFlowResponseMessage#name)

* * *

### paramsJson?[​](#paramsjson "Direct link to paramsJson?")

> `optional` **paramsJson**: `null` | `string`

Defined in: [WAProto/index.d.ts:7016](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7016)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`INativeFlowResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/INativeFlowResponseMessage).[`paramsJson`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/INativeFlowResponseMessage#paramsjson)

* * *

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | `number`

Defined in: [WAProto/index.d.ts:7017](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7017)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`INativeFlowResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/INativeFlowResponseMessage).[`version`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/INativeFlowResponseMessage#version)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7023](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7023)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`NativeFlowResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/NativeFlowResponseMessage)

Defined in: [WAProto/index.d.ts:7018](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7018)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`INativeFlowResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/INativeFlowResponseMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`NativeFlowResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/NativeFlowResponseMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`NativeFlowResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/NativeFlowResponseMessage)

Defined in: [WAProto/index.d.ts:7020](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7020)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`NativeFlowResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/NativeFlowResponseMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7019](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7019)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`INativeFlowResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/INativeFlowResponseMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`NativeFlowResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/NativeFlowResponseMessage)

Defined in: [WAProto/index.d.ts:7021](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7021)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`NativeFlowResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/NativeFlowResponseMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7024](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7024)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7022](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7022)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`NativeFlowResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/classes/NativeFlowResponseMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ibody"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/IBody](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/IBody)

Defined in: [WAProto/index.d.ts:6981](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6981)

## Properties[​](#properties "Direct link to Properties")

### format?[​](#format "Direct link to format?")

> `optional` **format**: `null` | [`Format`](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/namespaces/Body/enumerations/Format)

Defined in: [WAProto/index.d.ts:6983](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6983)

* * *

### text?[​](#text "Direct link to text?")

> `optional` **text**: `null` | `string`

Defined in: [WAProto/index.d.ts:6982](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L6982)

---

<a name="interface-inativeflowresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/INativeFlowResponseMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/interfaces/INativeFlowResponseMessage)

Defined in: [WAProto/index.d.ts:7007](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7007)

## Properties[​](#properties "Direct link to Properties")

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:7008](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7008)

* * *

### paramsJson?[​](#paramsjson "Direct link to paramsJson?")

> `optional` **paramsJson**: `null` | `string`

Defined in: [WAProto/index.d.ts:7009](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7009)

* * *

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | `number`

Defined in: [WAProto/index.d.ts:7010](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7010)

---

<a name="body"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/namespaces/Body/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/namespaces/Body/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Format](/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/namespaces/Body/enumerations/Format)

---

<a name="enumeration-format"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/namespaces/Body/enumerations/Format](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InteractiveResponseMessage/namespaces/Body/enumerations/Format)

Defined in: [WAProto/index.d.ts:7001](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7001)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### DEFAULT[​](#default "Direct link to DEFAULT")

> **DEFAULT**: `0`

Defined in: [WAProto/index.d.ts:7002](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7002)

* * *

### EXTENSIONS\_1[​](#extensions_1 "Direct link to EXTENSIONS_1")

> **EXTENSIONS\_1**: `1`

Defined in: [WAProto/index.d.ts:7003](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7003)

---

<a name="invoicemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InvoiceMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InvoiceMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [AttachmentType](/docs/api/namespaces/proto/namespaces/Message/namespaces/InvoiceMessage/enumerations/AttachmentType)

---

<a name="enumeration-attachmenttype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InvoiceMessage/enumerations/AttachmentType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/InvoiceMessage/enumerations/AttachmentType)

Defined in: [WAProto/index.d.ts:7064](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7064)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### IMAGE[​](#image "Direct link to IMAGE")

> **IMAGE**: `0`

Defined in: [WAProto/index.d.ts:7065](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7065)

* * *

### PDF[​](#pdf "Direct link to PDF")

> **PDF**: `1`

Defined in: [WAProto/index.d.ts:7066](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7066)

---

<a name="linkpreviewmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/LinkPreviewMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/LinkPreviewMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [SocialMediaPostType](/docs/api/namespaces/proto/namespaces/Message/namespaces/LinkPreviewMetadata/enumerations/SocialMediaPostType)

---

<a name="enumeration-socialmediaposttype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/LinkPreviewMetadata/enumerations/SocialMediaPostType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/LinkPreviewMetadata/enumerations/SocialMediaPostType)

Defined in: [WAProto/index.d.ts:7124](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7124)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### CAROUSEL[​](#carousel "Direct link to CAROUSEL")

> **CAROUSEL**: `5`

Defined in: [WAProto/index.d.ts:7130](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7130)

* * *

### LIVE\_VIDEO[​](#live_video "Direct link to LIVE_VIDEO")

> **LIVE\_VIDEO**: `2`

Defined in: [WAProto/index.d.ts:7127](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7127)

* * *

### LONG\_VIDEO[​](#long_video "Direct link to LONG_VIDEO")

> **LONG\_VIDEO**: `3`

Defined in: [WAProto/index.d.ts:7128](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7128)

* * *

### NONE[​](#none "Direct link to NONE")

> **NONE**: `0`

Defined in: [WAProto/index.d.ts:7125](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7125)

* * *

### REEL[​](#reel "Direct link to REEL")

> **REEL**: `1`

Defined in: [WAProto/index.d.ts:7126](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7126)

* * *

### SINGLE\_IMAGE[​](#single_image "Direct link to SINGLE_IMAGE")

> **SINGLE\_IMAGE**: `4`

Defined in: [WAProto/index.d.ts:7129](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7129)

---

<a name="listmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [ListType](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/enumerations/ListType)

## Classes[​](#classes "Direct link to Classes")

*   [Product](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Product)
*   [ProductListHeaderImage](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListHeaderImage)
*   [ProductListInfo](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListInfo)
*   [ProductSection](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductSection)
*   [Row](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Row)
*   [Section](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Section)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IProduct](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProduct)
*   [IProductListHeaderImage](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListHeaderImage)
*   [IProductListInfo](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListInfo)
*   [IProductSection](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductSection)
*   [IRow](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IRow)
*   [ISection](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/ISection)

---

<a name="class-product"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Product](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Product)

Defined in: [WAProto/index.d.ts:7176](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7176)

## Implements[​](#implements "Direct link to Implements")

*   [`IProduct`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProduct)

## Constructors[​](#constructors "Direct link to Constructors")

### new Product()[​](#new-product "Direct link to new Product()")

> **new Product**(`p`?): [`Product`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Product)

Defined in: [WAProto/index.d.ts:7177](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7177)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IProduct`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProduct)

#### Returns[​](#returns "Direct link to Returns")

[`Product`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Product)

## Properties[​](#properties "Direct link to Properties")

### productId?[​](#productid "Direct link to productId?")

> `optional` **productId**: `null` | `string`

Defined in: [WAProto/index.d.ts:7178](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7178)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IProduct`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProduct).[`productId`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProduct#productid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7184](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7184)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Product`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Product)

Defined in: [WAProto/index.d.ts:7179](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7179)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IProduct`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProduct)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Product`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Product)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Product`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Product)

Defined in: [WAProto/index.d.ts:7181](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7181)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Product`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Product)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7180](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7180)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IProduct`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProduct)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Product`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Product)

Defined in: [WAProto/index.d.ts:7182](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7182)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Product`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Product)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7185](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7185)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7183](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7183)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Product`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Product)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-productlistheaderimage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListHeaderImage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListHeaderImage)

Defined in: [WAProto/index.d.ts:7193](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7193)

## Implements[​](#implements "Direct link to Implements")

*   [`IProductListHeaderImage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListHeaderImage)

## Constructors[​](#constructors "Direct link to Constructors")

### new ProductListHeaderImage()[​](#new-productlistheaderimage "Direct link to new ProductListHeaderImage()")

> **new ProductListHeaderImage**(`p`?): [`ProductListHeaderImage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListHeaderImage)

Defined in: [WAProto/index.d.ts:7194](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7194)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IProductListHeaderImage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListHeaderImage)

#### Returns[​](#returns "Direct link to Returns")

[`ProductListHeaderImage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListHeaderImage)

## Properties[​](#properties "Direct link to Properties")

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7196](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7196)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IProductListHeaderImage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListHeaderImage).[`jpegThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListHeaderImage#jpegthumbnail)

* * *

### productId?[​](#productid "Direct link to productId?")

> `optional` **productId**: `null` | `string`

Defined in: [WAProto/index.d.ts:7195](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7195)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IProductListHeaderImage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListHeaderImage).[`productId`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListHeaderImage#productid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7202](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7202)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ProductListHeaderImage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListHeaderImage)

Defined in: [WAProto/index.d.ts:7197](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7197)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IProductListHeaderImage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListHeaderImage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ProductListHeaderImage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListHeaderImage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ProductListHeaderImage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListHeaderImage)

Defined in: [WAProto/index.d.ts:7199](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7199)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ProductListHeaderImage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListHeaderImage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7198](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7198)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IProductListHeaderImage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListHeaderImage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ProductListHeaderImage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListHeaderImage)

Defined in: [WAProto/index.d.ts:7200](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7200)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ProductListHeaderImage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListHeaderImage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7203](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7203)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7201](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7201)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ProductListHeaderImage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListHeaderImage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-productlistinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListInfo)

Defined in: [WAProto/index.d.ts:7212](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7212)

## Implements[​](#implements "Direct link to Implements")

*   [`IProductListInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListInfo)

## Constructors[​](#constructors "Direct link to Constructors")

### new ProductListInfo()[​](#new-productlistinfo "Direct link to new ProductListInfo()")

> **new ProductListInfo**(`p`?): [`ProductListInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListInfo)

Defined in: [WAProto/index.d.ts:7213](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7213)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IProductListInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListInfo)

#### Returns[​](#returns "Direct link to Returns")

[`ProductListInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListInfo)

## Properties[​](#properties "Direct link to Properties")

### businessOwnerJid?[​](#businessownerjid "Direct link to businessOwnerJid?")

> `optional` **businessOwnerJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:7216](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7216)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IProductListInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListInfo).[`businessOwnerJid`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListInfo#businessownerjid)

* * *

### headerImage?[​](#headerimage "Direct link to headerImage?")

> `optional` **headerImage**: `null` | [`IProductListHeaderImage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListHeaderImage)

Defined in: [WAProto/index.d.ts:7215](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7215)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IProductListInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListInfo).[`headerImage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListInfo#headerimage)

* * *

### productSections[​](#productsections "Direct link to productSections")

> **productSections**: [`IProductSection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductSection)\[\]

Defined in: [WAProto/index.d.ts:7214](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7214)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IProductListInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListInfo).[`productSections`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListInfo#productsections)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7222](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7222)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ProductListInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListInfo)

Defined in: [WAProto/index.d.ts:7217](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7217)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IProductListInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListInfo)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ProductListInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListInfo)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ProductListInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListInfo)

Defined in: [WAProto/index.d.ts:7219](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7219)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ProductListInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListInfo)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7218](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7218)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IProductListInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListInfo)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ProductListInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListInfo)

Defined in: [WAProto/index.d.ts:7220](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7220)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ProductListInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListInfo)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7223](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7223)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7221](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7221)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ProductListInfo`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductListInfo)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-productsection"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductSection](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductSection)

Defined in: [WAProto/index.d.ts:7231](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7231)

## Implements[​](#implements "Direct link to Implements")

*   [`IProductSection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductSection)

## Constructors[​](#constructors "Direct link to Constructors")

### new ProductSection()[​](#new-productsection "Direct link to new ProductSection()")

> **new ProductSection**(`p`?): [`ProductSection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductSection)

Defined in: [WAProto/index.d.ts:7232](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7232)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IProductSection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductSection)

#### Returns[​](#returns "Direct link to Returns")

[`ProductSection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductSection)

## Properties[​](#properties "Direct link to Properties")

### products[​](#products "Direct link to products")

> **products**: [`IProduct`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProduct)\[\]

Defined in: [WAProto/index.d.ts:7234](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7234)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IProductSection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductSection).[`products`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductSection#products)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:7233](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7233)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IProductSection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductSection).[`title`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductSection#title)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7240](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7240)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ProductSection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductSection)

Defined in: [WAProto/index.d.ts:7235](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7235)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IProductSection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductSection)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ProductSection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductSection)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ProductSection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductSection)

Defined in: [WAProto/index.d.ts:7237](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7237)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ProductSection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductSection)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7236](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7236)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IProductSection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductSection)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ProductSection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductSection)

Defined in: [WAProto/index.d.ts:7238](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7238)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ProductSection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductSection)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7241](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7241)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7239](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7239)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ProductSection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/ProductSection)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-row"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Row](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Row)

Defined in: [WAProto/index.d.ts:7250](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7250)

## Implements[​](#implements "Direct link to Implements")

*   [`IRow`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IRow)

## Constructors[​](#constructors "Direct link to Constructors")

### new Row()[​](#new-row "Direct link to new Row()")

> **new Row**(`p`?): [`Row`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Row)

Defined in: [WAProto/index.d.ts:7251](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7251)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IRow`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IRow)

#### Returns[​](#returns "Direct link to Returns")

[`Row`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Row)

## Properties[​](#properties "Direct link to Properties")

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:7253](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7253)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IRow`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IRow).[`description`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IRow#description)

* * *

### rowId?[​](#rowid "Direct link to rowId?")

> `optional` **rowId**: `null` | `string`

Defined in: [WAProto/index.d.ts:7254](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7254)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IRow`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IRow).[`rowId`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IRow#rowid)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:7252](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7252)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IRow`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IRow).[`title`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IRow#title)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7260](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7260)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Row`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Row)

Defined in: [WAProto/index.d.ts:7255](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7255)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IRow`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IRow)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Row`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Row)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Row`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Row)

Defined in: [WAProto/index.d.ts:7257](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7257)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Row`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Row)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7256](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7256)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IRow`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IRow)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Row`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Row)

Defined in: [WAProto/index.d.ts:7258](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7258)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Row`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Row)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7261](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7261)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7259](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7259)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Row`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Row)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-section"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Section](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Section)

Defined in: [WAProto/index.d.ts:7269](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7269)

## Implements[​](#implements "Direct link to Implements")

*   [`ISection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/ISection)

## Constructors[​](#constructors "Direct link to Constructors")

### new Section()[​](#new-section "Direct link to new Section()")

> **new Section**(`p`?): [`Section`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Section)

Defined in: [WAProto/index.d.ts:7270](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7270)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/ISection)

#### Returns[​](#returns "Direct link to Returns")

[`Section`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Section)

## Properties[​](#properties "Direct link to Properties")

### rows[​](#rows "Direct link to rows")

> **rows**: [`IRow`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IRow)\[\]

Defined in: [WAProto/index.d.ts:7272](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7272)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/ISection).[`rows`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/ISection#rows)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:7271](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7271)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/ISection).[`title`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/ISection#title)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7278](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7278)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Section`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Section)

Defined in: [WAProto/index.d.ts:7273](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7273)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/ISection)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Section`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Section)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Section`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Section)

Defined in: [WAProto/index.d.ts:7275](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7275)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Section`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Section)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7274](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7274)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/ISection)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Section`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Section)

Defined in: [WAProto/index.d.ts:7276](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7276)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Section`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Section)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7279](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7279)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7277](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7277)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Section`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/classes/Section)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-listtype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/enumerations/ListType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/enumerations/ListType)

Defined in: [WAProto/index.d.ts:7166](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7166)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### PRODUCT\_LIST[​](#product_list "Direct link to PRODUCT_LIST")

> **PRODUCT\_LIST**: `2`

Defined in: [WAProto/index.d.ts:7169](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7169)

* * *

### SINGLE\_SELECT[​](#single_select "Direct link to SINGLE_SELECT")

> **SINGLE\_SELECT**: `1`

Defined in: [WAProto/index.d.ts:7168](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7168)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:7167](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7167)

---

<a name="interface-iproduct"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProduct](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProduct)

Defined in: [WAProto/index.d.ts:7172](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7172)

## Properties[​](#properties "Direct link to Properties")

### productId?[​](#productid "Direct link to productId?")

> `optional` **productId**: `null` | `string`

Defined in: [WAProto/index.d.ts:7173](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7173)

---

<a name="interface-iproductlistheaderimage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListHeaderImage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListHeaderImage)

Defined in: [WAProto/index.d.ts:7188](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7188)

## Properties[​](#properties "Direct link to Properties")

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:7190](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7190)

* * *

### productId?[​](#productid "Direct link to productId?")

> `optional` **productId**: `null` | `string`

Defined in: [WAProto/index.d.ts:7189](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7189)

---

<a name="interface-iproductlistinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListInfo](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListInfo)

Defined in: [WAProto/index.d.ts:7206](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7206)

## Properties[​](#properties "Direct link to Properties")

### businessOwnerJid?[​](#businessownerjid "Direct link to businessOwnerJid?")

> `optional` **businessOwnerJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:7209](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7209)

* * *

### headerImage?[​](#headerimage "Direct link to headerImage?")

> `optional` **headerImage**: `null` | [`IProductListHeaderImage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductListHeaderImage)

Defined in: [WAProto/index.d.ts:7208](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7208)

* * *

### productSections?[​](#productsections "Direct link to productSections?")

> `optional` **productSections**: `null` | [`IProductSection`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductSection)\[\]

Defined in: [WAProto/index.d.ts:7207](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7207)

---

<a name="interface-iproductsection"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductSection](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProductSection)

Defined in: [WAProto/index.d.ts:7226](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7226)

## Properties[​](#properties "Direct link to Properties")

### products?[​](#products "Direct link to products?")

> `optional` **products**: `null` | [`IProduct`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IProduct)\[\]

Defined in: [WAProto/index.d.ts:7228](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7228)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:7227](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7227)

---

<a name="interface-irow"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IRow](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IRow)

Defined in: [WAProto/index.d.ts:7244](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7244)

## Properties[​](#properties "Direct link to Properties")

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:7246](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7246)

* * *

### rowId?[​](#rowid "Direct link to rowId?")

> `optional` **rowId**: `null` | `string`

Defined in: [WAProto/index.d.ts:7247](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7247)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:7245](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7245)

---

<a name="interface-isection"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/ISection](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/ISection)

Defined in: [WAProto/index.d.ts:7264](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7264)

## Properties[​](#properties "Direct link to Properties")

### rows?[​](#rows "Direct link to rows?")

> `optional` **rows**: `null` | [`IRow`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListMessage/interfaces/IRow)\[\]

Defined in: [WAProto/index.d.ts:7266](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7266)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:7265](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7265)

---

<a name="listresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [ListType](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/enumerations/ListType)

## Classes[​](#classes "Direct link to Classes")

*   [SingleSelectReply](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/classes/SingleSelectReply)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [ISingleSelectReply](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/interfaces/ISingleSelectReply)

---

<a name="class-singleselectreply"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/classes/SingleSelectReply](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/classes/SingleSelectReply)

Defined in: [WAProto/index.d.ts:7318](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7318)

## Implements[​](#implements "Direct link to Implements")

*   [`ISingleSelectReply`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/interfaces/ISingleSelectReply)

## Constructors[​](#constructors "Direct link to Constructors")

### new SingleSelectReply()[​](#new-singleselectreply "Direct link to new SingleSelectReply()")

> **new SingleSelectReply**(`p`?): [`SingleSelectReply`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/classes/SingleSelectReply)

Defined in: [WAProto/index.d.ts:7319](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7319)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISingleSelectReply`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/interfaces/ISingleSelectReply)

#### Returns[​](#returns "Direct link to Returns")

[`SingleSelectReply`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/classes/SingleSelectReply)

## Properties[​](#properties "Direct link to Properties")

### selectedRowId?[​](#selectedrowid "Direct link to selectedRowId?")

> `optional` **selectedRowId**: `null` | `string`

Defined in: [WAProto/index.d.ts:7320](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7320)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISingleSelectReply`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/interfaces/ISingleSelectReply).[`selectedRowId`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/interfaces/ISingleSelectReply#selectedrowid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7326](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7326)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SingleSelectReply`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/classes/SingleSelectReply)

Defined in: [WAProto/index.d.ts:7321](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7321)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISingleSelectReply`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/interfaces/ISingleSelectReply)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SingleSelectReply`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/classes/SingleSelectReply)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SingleSelectReply`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/classes/SingleSelectReply)

Defined in: [WAProto/index.d.ts:7323](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7323)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SingleSelectReply`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/classes/SingleSelectReply)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7322](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7322)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISingleSelectReply`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/interfaces/ISingleSelectReply)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SingleSelectReply`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/classes/SingleSelectReply)

Defined in: [WAProto/index.d.ts:7324](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7324)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SingleSelectReply`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/classes/SingleSelectReply)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7327](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7327)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7325](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7325)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SingleSelectReply`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/classes/SingleSelectReply)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-listtype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/enumerations/ListType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/enumerations/ListType)

Defined in: [WAProto/index.d.ts:7309](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7309)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### SINGLE\_SELECT[​](#single_select "Direct link to SINGLE_SELECT")

> **SINGLE\_SELECT**: `1`

Defined in: [WAProto/index.d.ts:7311](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7311)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:7310](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7310)

---

<a name="interface-isingleselectreply"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/interfaces/ISingleSelectReply](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ListResponseMessage/interfaces/ISingleSelectReply)

Defined in: [WAProto/index.d.ts:7314](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7314)

## Properties[​](#properties "Direct link to Properties")

### selectedRowId?[​](#selectedrowid "Direct link to selectedRowId?")

> `optional` **selectedRowId**: `null` | `string`

Defined in: [WAProto/index.d.ts:7315](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7315)

---

<a name="ordermessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/OrderMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/OrderMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [OrderStatus](/docs/api/namespaces/proto/namespaces/Message/namespaces/OrderMessage/enumerations/OrderStatus)
*   [OrderSurface](/docs/api/namespaces/proto/namespaces/Message/namespaces/OrderMessage/enumerations/OrderSurface)

---

<a name="enumeration-orderstatus"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/OrderMessage/enumerations/OrderStatus](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/OrderMessage/enumerations/OrderStatus)

Defined in: [WAProto/index.d.ts:7605](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7605)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### ACCEPTED[​](#accepted "Direct link to ACCEPTED")

> **ACCEPTED**: `2`

Defined in: [WAProto/index.d.ts:7607](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7607)

* * *

### DECLINED[​](#declined "Direct link to DECLINED")

> **DECLINED**: `3`

Defined in: [WAProto/index.d.ts:7608](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7608)

* * *

### INQUIRY[​](#inquiry "Direct link to INQUIRY")

> **INQUIRY**: `1`

Defined in: [WAProto/index.d.ts:7606](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7606)

---

<a name="enumeration-ordersurface"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/OrderMessage/enumerations/OrderSurface](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/OrderMessage/enumerations/OrderSurface)

Defined in: [WAProto/index.d.ts:7611](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7611)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### CATALOG[​](#catalog "Direct link to CATALOG")

> **CATALOG**: `1`

Defined in: [WAProto/index.d.ts:7612](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7612)

---

<a name="paymentinvitemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentInviteMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentInviteMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [ServiceType](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentInviteMessage/enumerations/ServiceType)

---

<a name="enumeration-servicetype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentInviteMessage/enumerations/ServiceType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentInviteMessage/enumerations/ServiceType)

Defined in: [WAProto/index.d.ts:7656](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7656)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### FBPAY[​](#fbpay "Direct link to FBPAY")

> **FBPAY**: `1`

Defined in: [WAProto/index.d.ts:7658](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7658)

* * *

### NOVI[​](#novi "Direct link to NOVI")

> **NOVI**: `2`

Defined in: [WAProto/index.d.ts:7659](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7659)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:7657](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7657)

* * *

### UPI[​](#upi "Direct link to UPI")

> **UPI**: `3`

Defined in: [WAProto/index.d.ts:7660](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7660)

---

<a name="paymentlinkmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [PaymentLinkHeader](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/namespaces/PaymentLinkHeader/)

## Classes[​](#classes "Direct link to Classes")

*   [PaymentLinkButton](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkButton)
*   [PaymentLinkHeader](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkHeader)
*   [PaymentLinkProvider](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkProvider)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IPaymentLinkButton](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkButton)
*   [IPaymentLinkHeader](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkHeader)
*   [IPaymentLinkProvider](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkProvider)

---

<a name="class-paymentlinkbutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkButton](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkButton)

Defined in: [WAProto/index.d.ts:7690](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7690)

## Implements[​](#implements "Direct link to Implements")

*   [`IPaymentLinkButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkButton)

## Constructors[​](#constructors "Direct link to Constructors")

### new PaymentLinkButton()[​](#new-paymentlinkbutton "Direct link to new PaymentLinkButton()")

> **new PaymentLinkButton**(`p`?): [`PaymentLinkButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkButton)

Defined in: [WAProto/index.d.ts:7691](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7691)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPaymentLinkButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkButton)

#### Returns[​](#returns "Direct link to Returns")

[`PaymentLinkButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkButton)

## Properties[​](#properties "Direct link to Properties")

### displayText?[​](#displaytext "Direct link to displayText?")

> `optional` **displayText**: `null` | `string`

Defined in: [WAProto/index.d.ts:7692](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7692)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPaymentLinkButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkButton).[`displayText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkButton#displaytext)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7698](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7698)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PaymentLinkButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkButton)

Defined in: [WAProto/index.d.ts:7693](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7693)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPaymentLinkButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkButton)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PaymentLinkButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkButton)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PaymentLinkButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkButton)

Defined in: [WAProto/index.d.ts:7695](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7695)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PaymentLinkButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkButton)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7694](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7694)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPaymentLinkButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkButton)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PaymentLinkButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkButton)

Defined in: [WAProto/index.d.ts:7696](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7696)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PaymentLinkButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkButton)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7699](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7699)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7697](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7697)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PaymentLinkButton`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkButton)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-paymentlinkheader"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkHeader](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkHeader)

Defined in: [WAProto/index.d.ts:7706](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7706)

## Implements[​](#implements "Direct link to Implements")

*   [`IPaymentLinkHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkHeader)

## Constructors[​](#constructors "Direct link to Constructors")

### new PaymentLinkHeader()[​](#new-paymentlinkheader "Direct link to new PaymentLinkHeader()")

> **new PaymentLinkHeader**(`p`?): [`PaymentLinkHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkHeader)

Defined in: [WAProto/index.d.ts:7707](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7707)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPaymentLinkHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkHeader)

#### Returns[​](#returns "Direct link to Returns")

[`PaymentLinkHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkHeader)

## Properties[​](#properties "Direct link to Properties")

### headerType?[​](#headertype "Direct link to headerType?")

> `optional` **headerType**: `null` | [`PaymentLinkHeaderType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/namespaces/PaymentLinkHeader/enumerations/PaymentLinkHeaderType)

Defined in: [WAProto/index.d.ts:7708](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7708)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPaymentLinkHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkHeader).[`headerType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkHeader#headertype)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7714](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7714)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PaymentLinkHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkHeader)

Defined in: [WAProto/index.d.ts:7709](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7709)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPaymentLinkHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkHeader)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PaymentLinkHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkHeader)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PaymentLinkHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkHeader)

Defined in: [WAProto/index.d.ts:7711](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7711)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PaymentLinkHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkHeader)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7710](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7710)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPaymentLinkHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkHeader)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PaymentLinkHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkHeader)

Defined in: [WAProto/index.d.ts:7712](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7712)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PaymentLinkHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkHeader)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7715](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7715)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7713](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7713)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PaymentLinkHeader`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkHeader)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-paymentlinkprovider"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkProvider](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkProvider)

Defined in: [WAProto/index.d.ts:7730](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7730)

## Implements[​](#implements "Direct link to Implements")

*   [`IPaymentLinkProvider`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkProvider)

## Constructors[​](#constructors "Direct link to Constructors")

### new PaymentLinkProvider()[​](#new-paymentlinkprovider "Direct link to new PaymentLinkProvider()")

> **new PaymentLinkProvider**(`p`?): [`PaymentLinkProvider`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkProvider)

Defined in: [WAProto/index.d.ts:7731](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7731)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPaymentLinkProvider`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkProvider)

#### Returns[​](#returns "Direct link to Returns")

[`PaymentLinkProvider`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkProvider)

## Properties[​](#properties "Direct link to Properties")

### paramsJson?[​](#paramsjson "Direct link to paramsJson?")

> `optional` **paramsJson**: `null` | `string`

Defined in: [WAProto/index.d.ts:7732](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7732)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPaymentLinkProvider`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkProvider).[`paramsJson`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkProvider#paramsjson)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7738](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7738)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PaymentLinkProvider`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkProvider)

Defined in: [WAProto/index.d.ts:7733](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7733)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPaymentLinkProvider`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkProvider)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PaymentLinkProvider`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkProvider)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PaymentLinkProvider`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkProvider)

Defined in: [WAProto/index.d.ts:7735](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7735)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PaymentLinkProvider`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkProvider)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7734](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7734)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPaymentLinkProvider`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkProvider)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PaymentLinkProvider`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkProvider)

Defined in: [WAProto/index.d.ts:7736](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7736)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PaymentLinkProvider`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkProvider)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7739](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7739)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7737](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7737)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PaymentLinkProvider`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/classes/PaymentLinkProvider)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ipaymentlinkbutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkButton](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkButton)

Defined in: [WAProto/index.d.ts:7686](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7686)

## Properties[​](#properties "Direct link to Properties")

### displayText?[​](#displaytext "Direct link to displayText?")

> `optional` **displayText**: `null` | `string`

Defined in: [WAProto/index.d.ts:7687](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7687)

---

<a name="interface-ipaymentlinkheader"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkHeader](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkHeader)

Defined in: [WAProto/index.d.ts:7702](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7702)

## Properties[​](#properties "Direct link to Properties")

### headerType?[​](#headertype "Direct link to headerType?")

> `optional` **headerType**: `null` | [`PaymentLinkHeaderType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/namespaces/PaymentLinkHeader/enumerations/PaymentLinkHeaderType)

Defined in: [WAProto/index.d.ts:7703](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7703)

---

<a name="interface-ipaymentlinkprovider"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkProvider](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/interfaces/IPaymentLinkProvider)

Defined in: [WAProto/index.d.ts:7726](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7726)

## Properties[​](#properties "Direct link to Properties")

### paramsJson?[​](#paramsjson "Direct link to paramsJson?")

> `optional` **paramsJson**: `null` | `string`

Defined in: [WAProto/index.d.ts:7727](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7727)

---

<a name="paymentlinkheader"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/namespaces/PaymentLinkHeader/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/namespaces/PaymentLinkHeader/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [PaymentLinkHeaderType](/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/namespaces/PaymentLinkHeader/enumerations/PaymentLinkHeaderType)

---

<a name="enumeration-paymentlinkheadertype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/namespaces/PaymentLinkHeader/enumerations/PaymentLinkHeaderType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PaymentLinkMetadata/namespaces/PaymentLinkHeader/enumerations/PaymentLinkHeaderType)

Defined in: [WAProto/index.d.ts:7720](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7720)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### LINK\_PREVIEW[​](#link_preview "Direct link to LINK_PREVIEW")

> **LINK\_PREVIEW**: `0`

Defined in: [WAProto/index.d.ts:7721](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7721)

* * *

### ORDER[​](#order "Direct link to ORDER")

> **ORDER**: `1`

Defined in: [WAProto/index.d.ts:7722](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7722)

---

<a name="peerdataoperationrequestmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [GalaxyFlowAction](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/namespaces/GalaxyFlowAction/)

## Classes[​](#classes "Direct link to Classes")

*   [FullHistorySyncOnDemandRequest](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/FullHistorySyncOnDemandRequest)
*   [GalaxyFlowAction](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/GalaxyFlowAction)
*   [HistorySyncChunkRetryRequest](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncChunkRetryRequest)
*   [HistorySyncOnDemandRequest](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncOnDemandRequest)
*   [PlaceholderMessageResendRequest](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/PlaceholderMessageResendRequest)
*   [RequestStickerReupload](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestStickerReupload)
*   [RequestUrlPreview](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestUrlPreview)
*   [SyncDCollectionFatalRecoveryRequest](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/SyncDCollectionFatalRecoveryRequest)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IFullHistorySyncOnDemandRequest](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IFullHistorySyncOnDemandRequest)
*   [IGalaxyFlowAction](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IGalaxyFlowAction)
*   [IHistorySyncChunkRetryRequest](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncChunkRetryRequest)
*   [IHistorySyncOnDemandRequest](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest)
*   [IPlaceholderMessageResendRequest](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IPlaceholderMessageResendRequest)
*   [IRequestStickerReupload](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestStickerReupload)
*   [IRequestUrlPreview](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestUrlPreview)
*   [ISyncDCollectionFatalRecoveryRequest](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/ISyncDCollectionFatalRecoveryRequest)

---

<a name="class-fullhistorysyncondemandrequest"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/FullHistorySyncOnDemandRequest](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/FullHistorySyncOnDemandRequest)

Defined in: [WAProto/index.d.ts:7782](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7782)

## Implements[​](#implements "Direct link to Implements")

*   [`IFullHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IFullHistorySyncOnDemandRequest)

## Constructors[​](#constructors "Direct link to Constructors")

### new FullHistorySyncOnDemandRequest()[​](#new-fullhistorysyncondemandrequest "Direct link to new FullHistorySyncOnDemandRequest()")

> **new FullHistorySyncOnDemandRequest**(`p`?): [`FullHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/FullHistorySyncOnDemandRequest)

Defined in: [WAProto/index.d.ts:7783](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7783)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IFullHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IFullHistorySyncOnDemandRequest)

#### Returns[​](#returns "Direct link to Returns")

[`FullHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/FullHistorySyncOnDemandRequest)

## Properties[​](#properties "Direct link to Properties")

### historySyncConfig?[​](#historysyncconfig "Direct link to historySyncConfig?")

> `optional` **historySyncConfig**: `null` | [`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig)

Defined in: [WAProto/index.d.ts:7785](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7785)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IFullHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IFullHistorySyncOnDemandRequest).[`historySyncConfig`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IFullHistorySyncOnDemandRequest#historysyncconfig)

* * *

### requestMetadata?[​](#requestmetadata "Direct link to requestMetadata?")

> `optional` **requestMetadata**: `null` | [`IFullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFullHistorySyncOnDemandRequestMetadata)

Defined in: [WAProto/index.d.ts:7784](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7784)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IFullHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IFullHistorySyncOnDemandRequest).[`requestMetadata`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IFullHistorySyncOnDemandRequest#requestmetadata)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7791](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7791)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`FullHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/FullHistorySyncOnDemandRequest)

Defined in: [WAProto/index.d.ts:7786](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7786)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IFullHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IFullHistorySyncOnDemandRequest)

#### Returns[​](#returns-2 "Direct link to Returns")

[`FullHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/FullHistorySyncOnDemandRequest)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`FullHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/FullHistorySyncOnDemandRequest)

Defined in: [WAProto/index.d.ts:7788](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7788)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`FullHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/FullHistorySyncOnDemandRequest)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7787](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7787)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IFullHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IFullHistorySyncOnDemandRequest)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`FullHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/FullHistorySyncOnDemandRequest)

Defined in: [WAProto/index.d.ts:7789](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7789)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`FullHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/FullHistorySyncOnDemandRequest)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7792](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7792)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7790](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7790)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`FullHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/FullHistorySyncOnDemandRequest)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-galaxyflowaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/GalaxyFlowAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/GalaxyFlowAction)

Defined in: [WAProto/index.d.ts:7801](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7801)

## Implements[​](#implements "Direct link to Implements")

*   [`IGalaxyFlowAction`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IGalaxyFlowAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new GalaxyFlowAction()[​](#new-galaxyflowaction "Direct link to new GalaxyFlowAction()")

> **new GalaxyFlowAction**(`p`?): [`GalaxyFlowAction`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/GalaxyFlowAction)

Defined in: [WAProto/index.d.ts:7802](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7802)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IGalaxyFlowAction`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IGalaxyFlowAction)

#### Returns[​](#returns "Direct link to Returns")

[`GalaxyFlowAction`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/GalaxyFlowAction)

## Properties[​](#properties "Direct link to Properties")

### flowId?[​](#flowid "Direct link to flowId?")

> `optional` **flowId**: `null` | `string`

Defined in: [WAProto/index.d.ts:7804](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7804)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IGalaxyFlowAction`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IGalaxyFlowAction).[`flowId`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IGalaxyFlowAction#flowid)

* * *

### stanzaId?[​](#stanzaid "Direct link to stanzaId?")

> `optional` **stanzaId**: `null` | `string`

Defined in: [WAProto/index.d.ts:7805](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7805)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IGalaxyFlowAction`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IGalaxyFlowAction).[`stanzaId`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IGalaxyFlowAction#stanzaid)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`NOTIFY_LAUNCH`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/namespaces/GalaxyFlowAction/enumerations/GalaxyFlowActionType#notify_launch)

Defined in: [WAProto/index.d.ts:7803](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7803)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IGalaxyFlowAction`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IGalaxyFlowAction).[`type`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IGalaxyFlowAction#type)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7811](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7811)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`GalaxyFlowAction`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/GalaxyFlowAction)

Defined in: [WAProto/index.d.ts:7806](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7806)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IGalaxyFlowAction`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IGalaxyFlowAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`GalaxyFlowAction`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/GalaxyFlowAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`GalaxyFlowAction`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/GalaxyFlowAction)

Defined in: [WAProto/index.d.ts:7808](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7808)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`GalaxyFlowAction`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/GalaxyFlowAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7807](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7807)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IGalaxyFlowAction`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IGalaxyFlowAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`GalaxyFlowAction`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/GalaxyFlowAction)

Defined in: [WAProto/index.d.ts:7809](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7809)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`GalaxyFlowAction`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/GalaxyFlowAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7812](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7812)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7810](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7810)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`GalaxyFlowAction`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/GalaxyFlowAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-historysyncchunkretryrequest"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncChunkRetryRequest](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncChunkRetryRequest)

Defined in: [WAProto/index.d.ts:7829](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7829)

## Implements[​](#implements "Direct link to Implements")

*   [`IHistorySyncChunkRetryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncChunkRetryRequest)

## Constructors[​](#constructors "Direct link to Constructors")

### new HistorySyncChunkRetryRequest()[​](#new-historysyncchunkretryrequest "Direct link to new HistorySyncChunkRetryRequest()")

> **new HistorySyncChunkRetryRequest**(`p`?): [`HistorySyncChunkRetryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncChunkRetryRequest)

Defined in: [WAProto/index.d.ts:7830](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7830)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHistorySyncChunkRetryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncChunkRetryRequest)

#### Returns[​](#returns "Direct link to Returns")

[`HistorySyncChunkRetryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncChunkRetryRequest)

## Properties[​](#properties "Direct link to Properties")

### chunkNotificationId?[​](#chunknotificationid "Direct link to chunkNotificationId?")

> `optional` **chunkNotificationId**: `null` | `string`

Defined in: [WAProto/index.d.ts:7833](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7833)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHistorySyncChunkRetryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncChunkRetryRequest).[`chunkNotificationId`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncChunkRetryRequest#chunknotificationid)

* * *

### chunkOrder?[​](#chunkorder "Direct link to chunkOrder?")

> `optional` **chunkOrder**: `null` | `number`

Defined in: [WAProto/index.d.ts:7832](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7832)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IHistorySyncChunkRetryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncChunkRetryRequest).[`chunkOrder`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncChunkRetryRequest#chunkorder)

* * *

### regenerateChunk?[​](#regeneratechunk "Direct link to regenerateChunk?")

> `optional` **regenerateChunk**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:7834](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7834)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IHistorySyncChunkRetryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncChunkRetryRequest).[`regenerateChunk`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncChunkRetryRequest#regeneratechunk)

* * *

### syncType?[​](#synctype "Direct link to syncType?")

> `optional` **syncType**: `null` | [`HistorySyncType`](/docs/api/namespaces/proto/namespaces/Message/enumerations/HistorySyncType)

Defined in: [WAProto/index.d.ts:7831](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7831)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IHistorySyncChunkRetryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncChunkRetryRequest).[`syncType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncChunkRetryRequest#synctype)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7840](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7840)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`HistorySyncChunkRetryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncChunkRetryRequest)

Defined in: [WAProto/index.d.ts:7835](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7835)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHistorySyncChunkRetryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncChunkRetryRequest)

#### Returns[​](#returns-2 "Direct link to Returns")

[`HistorySyncChunkRetryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncChunkRetryRequest)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`HistorySyncChunkRetryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncChunkRetryRequest)

Defined in: [WAProto/index.d.ts:7837](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7837)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`HistorySyncChunkRetryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncChunkRetryRequest)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7836](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7836)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHistorySyncChunkRetryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncChunkRetryRequest)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`HistorySyncChunkRetryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncChunkRetryRequest)

Defined in: [WAProto/index.d.ts:7838](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7838)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`HistorySyncChunkRetryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncChunkRetryRequest)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7841](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7841)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7839](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7839)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`HistorySyncChunkRetryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncChunkRetryRequest)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-historysyncondemandrequest"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncOnDemandRequest](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncOnDemandRequest)

Defined in: [WAProto/index.d.ts:7853](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7853)

## Implements[​](#implements "Direct link to Implements")

*   [`IHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest)

## Constructors[​](#constructors "Direct link to Constructors")

### new HistorySyncOnDemandRequest()[​](#new-historysyncondemandrequest "Direct link to new HistorySyncOnDemandRequest()")

> **new HistorySyncOnDemandRequest**(`p`?): [`HistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncOnDemandRequest)

Defined in: [WAProto/index.d.ts:7854](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7854)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest)

#### Returns[​](#returns "Direct link to Returns")

[`HistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncOnDemandRequest)

## Properties[​](#properties "Direct link to Properties")

### accountLid?[​](#accountlid "Direct link to accountLid?")

> `optional` **accountLid**: `null` | `string`

Defined in: [WAProto/index.d.ts:7860](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7860)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest).[`accountLid`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest#accountlid)

* * *

### chatJid?[​](#chatjid "Direct link to chatJid?")

> `optional` **chatJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:7855](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7855)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest).[`chatJid`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest#chatjid)

* * *

### oldestMsgFromMe?[​](#oldestmsgfromme "Direct link to oldestMsgFromMe?")

> `optional` **oldestMsgFromMe**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:7857](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7857)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest).[`oldestMsgFromMe`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest#oldestmsgfromme)

* * *

### oldestMsgId?[​](#oldestmsgid "Direct link to oldestMsgId?")

> `optional` **oldestMsgId**: `null` | `string`

Defined in: [WAProto/index.d.ts:7856](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7856)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest).[`oldestMsgId`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest#oldestmsgid)

* * *

### oldestMsgTimestampMs?[​](#oldestmsgtimestampms "Direct link to oldestMsgTimestampMs?")

> `optional` **oldestMsgTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7859](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7859)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest).[`oldestMsgTimestampMs`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest#oldestmsgtimestampms)

* * *

### onDemandMsgCount?[​](#ondemandmsgcount "Direct link to onDemandMsgCount?")

> `optional` **onDemandMsgCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:7858](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7858)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest).[`onDemandMsgCount`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest#ondemandmsgcount)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7866](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7866)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`HistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncOnDemandRequest)

Defined in: [WAProto/index.d.ts:7861](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7861)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest)

#### Returns[​](#returns-2 "Direct link to Returns")

[`HistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncOnDemandRequest)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`HistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncOnDemandRequest)

Defined in: [WAProto/index.d.ts:7863](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7863)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`HistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncOnDemandRequest)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7862](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7862)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`HistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncOnDemandRequest)

Defined in: [WAProto/index.d.ts:7864](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7864)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`HistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncOnDemandRequest)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7867](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7867)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7865](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7865)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`HistorySyncOnDemandRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/HistorySyncOnDemandRequest)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-placeholdermessageresendrequest"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/PlaceholderMessageResendRequest](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/PlaceholderMessageResendRequest)

Defined in: [WAProto/index.d.ts:7874](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7874)

## Implements[​](#implements "Direct link to Implements")

*   [`IPlaceholderMessageResendRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IPlaceholderMessageResendRequest)

## Constructors[​](#constructors "Direct link to Constructors")

### new PlaceholderMessageResendRequest()[​](#new-placeholdermessageresendrequest "Direct link to new PlaceholderMessageResendRequest()")

> **new PlaceholderMessageResendRequest**(`p`?): [`PlaceholderMessageResendRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/PlaceholderMessageResendRequest)

Defined in: [WAProto/index.d.ts:7875](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7875)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPlaceholderMessageResendRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IPlaceholderMessageResendRequest)

#### Returns[​](#returns "Direct link to Returns")

[`PlaceholderMessageResendRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/PlaceholderMessageResendRequest)

## Properties[​](#properties "Direct link to Properties")

### messageKey?[​](#messagekey "Direct link to messageKey?")

> `optional` **messageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:7876](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7876)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPlaceholderMessageResendRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IPlaceholderMessageResendRequest).[`messageKey`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IPlaceholderMessageResendRequest#messagekey)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7882](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7882)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PlaceholderMessageResendRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/PlaceholderMessageResendRequest)

Defined in: [WAProto/index.d.ts:7877](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7877)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPlaceholderMessageResendRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IPlaceholderMessageResendRequest)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PlaceholderMessageResendRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/PlaceholderMessageResendRequest)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PlaceholderMessageResendRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/PlaceholderMessageResendRequest)

Defined in: [WAProto/index.d.ts:7879](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7879)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PlaceholderMessageResendRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/PlaceholderMessageResendRequest)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7878](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7878)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPlaceholderMessageResendRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IPlaceholderMessageResendRequest)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PlaceholderMessageResendRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/PlaceholderMessageResendRequest)

Defined in: [WAProto/index.d.ts:7880](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7880)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PlaceholderMessageResendRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/PlaceholderMessageResendRequest)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7883](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7883)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7881](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7881)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PlaceholderMessageResendRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/PlaceholderMessageResendRequest)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-requeststickerreupload"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestStickerReupload](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestStickerReupload)

Defined in: [WAProto/index.d.ts:7890](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7890)

## Implements[​](#implements "Direct link to Implements")

*   [`IRequestStickerReupload`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestStickerReupload)

## Constructors[​](#constructors "Direct link to Constructors")

### new RequestStickerReupload()[​](#new-requeststickerreupload "Direct link to new RequestStickerReupload()")

> **new RequestStickerReupload**(`p`?): [`RequestStickerReupload`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestStickerReupload)

Defined in: [WAProto/index.d.ts:7891](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7891)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IRequestStickerReupload`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestStickerReupload)

#### Returns[​](#returns "Direct link to Returns")

[`RequestStickerReupload`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestStickerReupload)

## Properties[​](#properties "Direct link to Properties")

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `string`

Defined in: [WAProto/index.d.ts:7892](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7892)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IRequestStickerReupload`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestStickerReupload).[`fileSha256`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestStickerReupload#filesha256)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7898](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7898)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`RequestStickerReupload`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestStickerReupload)

Defined in: [WAProto/index.d.ts:7893](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7893)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IRequestStickerReupload`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestStickerReupload)

#### Returns[​](#returns-2 "Direct link to Returns")

[`RequestStickerReupload`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestStickerReupload)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`RequestStickerReupload`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestStickerReupload)

Defined in: [WAProto/index.d.ts:7895](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7895)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`RequestStickerReupload`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestStickerReupload)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7894](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7894)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IRequestStickerReupload`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestStickerReupload)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`RequestStickerReupload`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestStickerReupload)

Defined in: [WAProto/index.d.ts:7896](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7896)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`RequestStickerReupload`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestStickerReupload)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7899](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7899)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7897](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7897)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`RequestStickerReupload`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestStickerReupload)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-requesturlpreview"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestUrlPreview](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestUrlPreview)

Defined in: [WAProto/index.d.ts:7907](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7907)

## Implements[​](#implements "Direct link to Implements")

*   [`IRequestUrlPreview`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestUrlPreview)

## Constructors[​](#constructors "Direct link to Constructors")

### new RequestUrlPreview()[​](#new-requesturlpreview "Direct link to new RequestUrlPreview()")

> **new RequestUrlPreview**(`p`?): [`RequestUrlPreview`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestUrlPreview)

Defined in: [WAProto/index.d.ts:7908](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7908)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IRequestUrlPreview`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestUrlPreview)

#### Returns[​](#returns "Direct link to Returns")

[`RequestUrlPreview`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestUrlPreview)

## Properties[​](#properties "Direct link to Properties")

### includeHqThumbnail?[​](#includehqthumbnail "Direct link to includeHqThumbnail?")

> `optional` **includeHqThumbnail**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:7910](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7910)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IRequestUrlPreview`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestUrlPreview).[`includeHqThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestUrlPreview#includehqthumbnail)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:7909](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7909)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IRequestUrlPreview`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestUrlPreview).[`url`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestUrlPreview#url)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7916](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7916)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`RequestUrlPreview`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestUrlPreview)

Defined in: [WAProto/index.d.ts:7911](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7911)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IRequestUrlPreview`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestUrlPreview)

#### Returns[​](#returns-2 "Direct link to Returns")

[`RequestUrlPreview`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestUrlPreview)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`RequestUrlPreview`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestUrlPreview)

Defined in: [WAProto/index.d.ts:7913](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7913)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`RequestUrlPreview`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestUrlPreview)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7912](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7912)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IRequestUrlPreview`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestUrlPreview)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`RequestUrlPreview`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestUrlPreview)

Defined in: [WAProto/index.d.ts:7914](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7914)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`RequestUrlPreview`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestUrlPreview)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7917](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7917)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7915](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7915)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`RequestUrlPreview`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/RequestUrlPreview)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-syncdcollectionfatalrecoveryrequest"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/SyncDCollectionFatalRecoveryRequest](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/SyncDCollectionFatalRecoveryRequest)

Defined in: [WAProto/index.d.ts:7925](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7925)

## Implements[​](#implements "Direct link to Implements")

*   [`ISyncDCollectionFatalRecoveryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/ISyncDCollectionFatalRecoveryRequest)

## Constructors[​](#constructors "Direct link to Constructors")

### new SyncDCollectionFatalRecoveryRequest()[​](#new-syncdcollectionfatalrecoveryrequest "Direct link to new SyncDCollectionFatalRecoveryRequest()")

> **new SyncDCollectionFatalRecoveryRequest**(`p`?): [`SyncDCollectionFatalRecoveryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/SyncDCollectionFatalRecoveryRequest)

Defined in: [WAProto/index.d.ts:7926](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7926)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISyncDCollectionFatalRecoveryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/ISyncDCollectionFatalRecoveryRequest)

#### Returns[​](#returns "Direct link to Returns")

[`SyncDCollectionFatalRecoveryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/SyncDCollectionFatalRecoveryRequest)

## Properties[​](#properties "Direct link to Properties")

### collectionName?[​](#collectionname "Direct link to collectionName?")

> `optional` **collectionName**: `null` | `string`

Defined in: [WAProto/index.d.ts:7927](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7927)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISyncDCollectionFatalRecoveryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/ISyncDCollectionFatalRecoveryRequest).[`collectionName`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/ISyncDCollectionFatalRecoveryRequest#collectionname)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7928](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7928)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISyncDCollectionFatalRecoveryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/ISyncDCollectionFatalRecoveryRequest).[`timestamp`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/ISyncDCollectionFatalRecoveryRequest#timestamp)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7934](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7934)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SyncDCollectionFatalRecoveryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/SyncDCollectionFatalRecoveryRequest)

Defined in: [WAProto/index.d.ts:7929](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7929)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISyncDCollectionFatalRecoveryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/ISyncDCollectionFatalRecoveryRequest)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SyncDCollectionFatalRecoveryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/SyncDCollectionFatalRecoveryRequest)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SyncDCollectionFatalRecoveryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/SyncDCollectionFatalRecoveryRequest)

Defined in: [WAProto/index.d.ts:7931](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7931)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SyncDCollectionFatalRecoveryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/SyncDCollectionFatalRecoveryRequest)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7930](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7930)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISyncDCollectionFatalRecoveryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/ISyncDCollectionFatalRecoveryRequest)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SyncDCollectionFatalRecoveryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/SyncDCollectionFatalRecoveryRequest)

Defined in: [WAProto/index.d.ts:7932](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7932)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SyncDCollectionFatalRecoveryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/SyncDCollectionFatalRecoveryRequest)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7935](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7935)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7933](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7933)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SyncDCollectionFatalRecoveryRequest`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/classes/SyncDCollectionFatalRecoveryRequest)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ifullhistorysyncondemandrequest"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IFullHistorySyncOnDemandRequest](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IFullHistorySyncOnDemandRequest)

Defined in: [WAProto/index.d.ts:7777](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7777)

## Properties[​](#properties "Direct link to Properties")

### historySyncConfig?[​](#historysyncconfig "Direct link to historySyncConfig?")

> `optional` **historySyncConfig**: `null` | [`IHistorySyncConfig`](/docs/api/namespaces/proto/namespaces/DeviceProps/interfaces/IHistorySyncConfig)

Defined in: [WAProto/index.d.ts:7779](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7779)

* * *

### requestMetadata?[​](#requestmetadata "Direct link to requestMetadata?")

> `optional` **requestMetadata**: `null` | [`IFullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFullHistorySyncOnDemandRequestMetadata)

Defined in: [WAProto/index.d.ts:7778](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7778)

---

<a name="interface-igalaxyflowaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IGalaxyFlowAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IGalaxyFlowAction)

Defined in: [WAProto/index.d.ts:7795](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7795)

## Properties[​](#properties "Direct link to Properties")

### flowId?[​](#flowid "Direct link to flowId?")

> `optional` **flowId**: `null` | `string`

Defined in: [WAProto/index.d.ts:7797](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7797)

* * *

### stanzaId?[​](#stanzaid "Direct link to stanzaId?")

> `optional` **stanzaId**: `null` | `string`

Defined in: [WAProto/index.d.ts:7798](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7798)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`NOTIFY_LAUNCH`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/namespaces/GalaxyFlowAction/enumerations/GalaxyFlowActionType#notify_launch)

Defined in: [WAProto/index.d.ts:7796](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7796)

---

<a name="interface-ihistorysyncchunkretryrequest"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncChunkRetryRequest](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncChunkRetryRequest)

Defined in: [WAProto/index.d.ts:7822](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7822)

## Properties[​](#properties "Direct link to Properties")

### chunkNotificationId?[​](#chunknotificationid "Direct link to chunkNotificationId?")

> `optional` **chunkNotificationId**: `null` | `string`

Defined in: [WAProto/index.d.ts:7825](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7825)

* * *

### chunkOrder?[​](#chunkorder "Direct link to chunkOrder?")

> `optional` **chunkOrder**: `null` | `number`

Defined in: [WAProto/index.d.ts:7824](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7824)

* * *

### regenerateChunk?[​](#regeneratechunk "Direct link to regenerateChunk?")

> `optional` **regenerateChunk**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:7826](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7826)

* * *

### syncType?[​](#synctype "Direct link to syncType?")

> `optional` **syncType**: `null` | [`HistorySyncType`](/docs/api/namespaces/proto/namespaces/Message/enumerations/HistorySyncType)

Defined in: [WAProto/index.d.ts:7823](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7823)

---

<a name="interface-ihistorysyncondemandrequest"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IHistorySyncOnDemandRequest)

Defined in: [WAProto/index.d.ts:7844](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7844)

## Properties[​](#properties "Direct link to Properties")

### accountLid?[​](#accountlid "Direct link to accountLid?")

> `optional` **accountLid**: `null` | `string`

Defined in: [WAProto/index.d.ts:7850](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7850)

* * *

### chatJid?[​](#chatjid "Direct link to chatJid?")

> `optional` **chatJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:7845](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7845)

* * *

### oldestMsgFromMe?[​](#oldestmsgfromme "Direct link to oldestMsgFromMe?")

> `optional` **oldestMsgFromMe**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:7847](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7847)

* * *

### oldestMsgId?[​](#oldestmsgid "Direct link to oldestMsgId?")

> `optional` **oldestMsgId**: `null` | `string`

Defined in: [WAProto/index.d.ts:7846](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7846)

* * *

### oldestMsgTimestampMs?[​](#oldestmsgtimestampms "Direct link to oldestMsgTimestampMs?")

> `optional` **oldestMsgTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7849](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7849)

* * *

### onDemandMsgCount?[​](#ondemandmsgcount "Direct link to onDemandMsgCount?")

> `optional` **onDemandMsgCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:7848](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7848)

---

<a name="interface-iplaceholdermessageresendrequest"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IPlaceholderMessageResendRequest](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IPlaceholderMessageResendRequest)

Defined in: [WAProto/index.d.ts:7870](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7870)

## Properties[​](#properties "Direct link to Properties")

### messageKey?[​](#messagekey "Direct link to messageKey?")

> `optional` **messageKey**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:7871](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7871)

---

<a name="interface-irequeststickerreupload"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestStickerReupload](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestStickerReupload)

Defined in: [WAProto/index.d.ts:7886](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7886)

## Properties[​](#properties "Direct link to Properties")

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `string`

Defined in: [WAProto/index.d.ts:7887](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7887)

---

<a name="interface-irequesturlpreview"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestUrlPreview](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/IRequestUrlPreview)

Defined in: [WAProto/index.d.ts:7902](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7902)

## Properties[​](#properties "Direct link to Properties")

### includeHqThumbnail?[​](#includehqthumbnail "Direct link to includeHqThumbnail?")

> `optional` **includeHqThumbnail**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:7904](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7904)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:7903](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7903)

---

<a name="interface-isyncdcollectionfatalrecoveryrequest"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/ISyncDCollectionFatalRecoveryRequest](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/interfaces/ISyncDCollectionFatalRecoveryRequest)

Defined in: [WAProto/index.d.ts:7920](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7920)

## Properties[​](#properties "Direct link to Properties")

### collectionName?[​](#collectionname "Direct link to collectionName?")

> `optional` **collectionName**: `null` | `string`

Defined in: [WAProto/index.d.ts:7921](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7921)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:7922](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7922)

---

<a name="galaxyflowaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/namespaces/GalaxyFlowAction/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/namespaces/GalaxyFlowAction/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [GalaxyFlowActionType](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/namespaces/GalaxyFlowAction/enumerations/GalaxyFlowActionType)

---

<a name="enumeration-galaxyflowactiontype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/namespaces/GalaxyFlowAction/enumerations/GalaxyFlowActionType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestMessage/namespaces/GalaxyFlowAction/enumerations/GalaxyFlowActionType)

Defined in: [WAProto/index.d.ts:7817](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7817)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### NOTIFY\_LAUNCH[​](#notify_launch "Direct link to NOTIFY_LAUNCH")

> **NOTIFY\_LAUNCH**: `1`

Defined in: [WAProto/index.d.ts:7818](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7818)

---

<a name="peerdataoperationrequestresponsemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [PeerDataOperationResult](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/)

## Classes[​](#classes "Direct link to Classes")

*   [PeerDataOperationResult](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/classes/PeerDataOperationResult)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IPeerDataOperationResult](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult)

---

<a name="class-peerdataoperationresult"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/classes/PeerDataOperationResult](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/classes/PeerDataOperationResult)

Defined in: [WAProto/index.d.ts:7974](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7974)

## Implements[​](#implements "Direct link to Implements")

*   [`IPeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult)

## Constructors[​](#constructors "Direct link to Constructors")

### new PeerDataOperationResult()[​](#new-peerdataoperationresult "Direct link to new PeerDataOperationResult()")

> **new PeerDataOperationResult**(`p`?): [`PeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/classes/PeerDataOperationResult)

Defined in: [WAProto/index.d.ts:7975](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7975)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult)

#### Returns[​](#returns "Direct link to Returns")

[`PeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/classes/PeerDataOperationResult)

## Properties[​](#properties "Direct link to Properties")

### companionCanonicalUserNonceFetchRequestResponse?[​](#companioncanonicalusernoncefetchrequestresponse "Direct link to companionCanonicalUserNonceFetchRequestResponse?")

> `optional` **companionCanonicalUserNonceFetchRequestResponse**: `null` | [`ICompanionCanonicalUserNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionCanonicalUserNonceFetchResponse)

Defined in: [WAProto/index.d.ts:7984](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7984)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult).[`companionCanonicalUserNonceFetchRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult#companioncanonicalusernoncefetchrequestresponse)

* * *

### companionMetaNonceFetchRequestResponse?[​](#companionmetanoncefetchrequestresponse "Direct link to companionMetaNonceFetchRequestResponse?")

> `optional` **companionMetaNonceFetchRequestResponse**: `null` | [`ICompanionMetaNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionMetaNonceFetchResponse)

Defined in: [WAProto/index.d.ts:7982](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7982)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult).[`companionMetaNonceFetchRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult#companionmetanoncefetchrequestresponse)

* * *

### fullHistorySyncOnDemandRequestResponse?[​](#fullhistorysyncondemandrequestresponse "Direct link to fullHistorySyncOnDemandRequestResponse?")

> `optional` **fullHistorySyncOnDemandRequestResponse**: `null` | [`IFullHistorySyncOnDemandRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IFullHistorySyncOnDemandRequestResponse)

Defined in: [WAProto/index.d.ts:7981](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7981)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult).[`fullHistorySyncOnDemandRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult#fullhistorysyncondemandrequestresponse)

* * *

### historySyncChunkRetryResponse?[​](#historysyncchunkretryresponse "Direct link to historySyncChunkRetryResponse?")

> `optional` **historySyncChunkRetryResponse**: `null` | [`IHistorySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IHistorySyncChunkRetryResponse)

Defined in: [WAProto/index.d.ts:7985](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7985)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IPeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult).[`historySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult#historysyncchunkretryresponse)

* * *

### linkPreviewResponse?[​](#linkpreviewresponse "Direct link to linkPreviewResponse?")

> `optional` **linkPreviewResponse**: `null` | [`ILinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse)

Defined in: [WAProto/index.d.ts:7978](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7978)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IPeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult).[`linkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult#linkpreviewresponse)

* * *

### mediaUploadResult?[​](#mediauploadresult "Direct link to mediaUploadResult?")

> `optional` **mediaUploadResult**: `null` | [`ResultType`](/docs/api/namespaces/proto/namespaces/MediaRetryNotification/enumerations/ResultType)

Defined in: [WAProto/index.d.ts:7976](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7976)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IPeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult).[`mediaUploadResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult#mediauploadresult)

* * *

### placeholderMessageResendResponse?[​](#placeholdermessageresendresponse "Direct link to placeholderMessageResendResponse?")

> `optional` **placeholderMessageResendResponse**: `null` | [`IPlaceholderMessageResendResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IPlaceholderMessageResendResponse)

Defined in: [WAProto/index.d.ts:7979](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7979)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IPeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult).[`placeholderMessageResendResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult#placeholdermessageresendresponse)

* * *

### stickerMessage?[​](#stickermessage "Direct link to stickerMessage?")

> `optional` **stickerMessage**: `null` | [`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage)

Defined in: [WAProto/index.d.ts:7977](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7977)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IPeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult).[`stickerMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult#stickermessage)

* * *

### syncdSnapshotFatalRecoveryResponse?[​](#syncdsnapshotfatalrecoveryresponse "Direct link to syncdSnapshotFatalRecoveryResponse?")

> `optional` **syncdSnapshotFatalRecoveryResponse**: `null` | [`ISyncDSnapshotFatalRecoveryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ISyncDSnapshotFatalRecoveryResponse)

Defined in: [WAProto/index.d.ts:7983](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7983)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IPeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult).[`syncdSnapshotFatalRecoveryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult#syncdsnapshotfatalrecoveryresponse)

* * *

### waffleNonceFetchRequestResponse?[​](#wafflenoncefetchrequestresponse "Direct link to waffleNonceFetchRequestResponse?")

> `optional` **waffleNonceFetchRequestResponse**: `null` | [`IWaffleNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IWaffleNonceFetchResponse)

Defined in: [WAProto/index.d.ts:7980](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7980)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IPeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult).[`waffleNonceFetchRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult#wafflenoncefetchrequestresponse)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:7991](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7991)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/classes/PeerDataOperationResult)

Defined in: [WAProto/index.d.ts:7986](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7986)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/classes/PeerDataOperationResult)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/classes/PeerDataOperationResult)

Defined in: [WAProto/index.d.ts:7988](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7988)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/classes/PeerDataOperationResult)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:7987](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7987)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/classes/PeerDataOperationResult)

Defined in: [WAProto/index.d.ts:7989](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7989)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/classes/PeerDataOperationResult)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:7992](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7992)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:7990](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7990)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PeerDataOperationResult`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/classes/PeerDataOperationResult)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ipeerdataoperationresult"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/interfaces/IPeerDataOperationResult)

Defined in: [WAProto/index.d.ts:7961](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7961)

## Properties[​](#properties "Direct link to Properties")

### companionCanonicalUserNonceFetchRequestResponse?[​](#companioncanonicalusernoncefetchrequestresponse "Direct link to companionCanonicalUserNonceFetchRequestResponse?")

> `optional` **companionCanonicalUserNonceFetchRequestResponse**: `null` | [`ICompanionCanonicalUserNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionCanonicalUserNonceFetchResponse)

Defined in: [WAProto/index.d.ts:7970](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7970)

* * *

### companionMetaNonceFetchRequestResponse?[​](#companionmetanoncefetchrequestresponse "Direct link to companionMetaNonceFetchRequestResponse?")

> `optional` **companionMetaNonceFetchRequestResponse**: `null` | [`ICompanionMetaNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionMetaNonceFetchResponse)

Defined in: [WAProto/index.d.ts:7968](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7968)

* * *

### fullHistorySyncOnDemandRequestResponse?[​](#fullhistorysyncondemandrequestresponse "Direct link to fullHistorySyncOnDemandRequestResponse?")

> `optional` **fullHistorySyncOnDemandRequestResponse**: `null` | [`IFullHistorySyncOnDemandRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IFullHistorySyncOnDemandRequestResponse)

Defined in: [WAProto/index.d.ts:7967](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7967)

* * *

### historySyncChunkRetryResponse?[​](#historysyncchunkretryresponse "Direct link to historySyncChunkRetryResponse?")

> `optional` **historySyncChunkRetryResponse**: `null` | [`IHistorySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IHistorySyncChunkRetryResponse)

Defined in: [WAProto/index.d.ts:7971](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7971)

* * *

### linkPreviewResponse?[​](#linkpreviewresponse "Direct link to linkPreviewResponse?")

> `optional` **linkPreviewResponse**: `null` | [`ILinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse)

Defined in: [WAProto/index.d.ts:7964](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7964)

* * *

### mediaUploadResult?[​](#mediauploadresult "Direct link to mediaUploadResult?")

> `optional` **mediaUploadResult**: `null` | [`ResultType`](/docs/api/namespaces/proto/namespaces/MediaRetryNotification/enumerations/ResultType)

Defined in: [WAProto/index.d.ts:7962](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7962)

* * *

### placeholderMessageResendResponse?[​](#placeholdermessageresendresponse "Direct link to placeholderMessageResendResponse?")

> `optional` **placeholderMessageResendResponse**: `null` | [`IPlaceholderMessageResendResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IPlaceholderMessageResendResponse)

Defined in: [WAProto/index.d.ts:7965](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7965)

* * *

### stickerMessage?[​](#stickermessage "Direct link to stickerMessage?")

> `optional` **stickerMessage**: `null` | [`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage)

Defined in: [WAProto/index.d.ts:7963](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7963)

* * *

### syncdSnapshotFatalRecoveryResponse?[​](#syncdsnapshotfatalrecoveryresponse "Direct link to syncdSnapshotFatalRecoveryResponse?")

> `optional` **syncdSnapshotFatalRecoveryResponse**: `null` | [`ISyncDSnapshotFatalRecoveryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ISyncDSnapshotFatalRecoveryResponse)

Defined in: [WAProto/index.d.ts:7969](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7969)

* * *

### waffleNonceFetchRequestResponse?[​](#wafflenoncefetchrequestresponse "Direct link to waffleNonceFetchRequestResponse?")

> `optional` **waffleNonceFetchRequestResponse**: `null` | [`IWaffleNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IWaffleNonceFetchResponse)

Defined in: [WAProto/index.d.ts:7966](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7966)

---

<a name="peerdataoperationresult"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [LinkPreviewResponse](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [FullHistorySyncOnDemandResponseCode](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/enumerations/FullHistorySyncOnDemandResponseCode)
*   [HistorySyncChunkRetryResponseCode](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/enumerations/HistorySyncChunkRetryResponseCode)

## Classes[​](#classes "Direct link to Classes")

*   [CompanionCanonicalUserNonceFetchResponse](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionCanonicalUserNonceFetchResponse)
*   [CompanionMetaNonceFetchResponse](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionMetaNonceFetchResponse)
*   [FullHistorySyncOnDemandRequestResponse](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/FullHistorySyncOnDemandRequestResponse)
*   [HistorySyncChunkRetryResponse](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/HistorySyncChunkRetryResponse)
*   [LinkPreviewResponse](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/LinkPreviewResponse)
*   [PlaceholderMessageResendResponse](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/PlaceholderMessageResendResponse)
*   [SyncDSnapshotFatalRecoveryResponse](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/SyncDSnapshotFatalRecoveryResponse)
*   [WaffleNonceFetchResponse](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/WaffleNonceFetchResponse)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [ICompanionCanonicalUserNonceFetchResponse](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionCanonicalUserNonceFetchResponse)
*   [ICompanionMetaNonceFetchResponse](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionMetaNonceFetchResponse)
*   [IFullHistorySyncOnDemandRequestResponse](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IFullHistorySyncOnDemandRequestResponse)
*   [IHistorySyncChunkRetryResponse](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IHistorySyncChunkRetryResponse)
*   [ILinkPreviewResponse](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse)
*   [IPlaceholderMessageResendResponse](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IPlaceholderMessageResendResponse)
*   [ISyncDSnapshotFatalRecoveryResponse](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ISyncDSnapshotFatalRecoveryResponse)
*   [IWaffleNonceFetchResponse](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IWaffleNonceFetchResponse)

---

<a name="class-companioncanonicalusernoncefetchresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionCanonicalUserNonceFetchResponse](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionCanonicalUserNonceFetchResponse)

Defined in: [WAProto/index.d.ts:8003](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8003)

## Implements[​](#implements "Direct link to Implements")

*   [`ICompanionCanonicalUserNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionCanonicalUserNonceFetchResponse)

## Constructors[​](#constructors "Direct link to Constructors")

### new CompanionCanonicalUserNonceFetchResponse()[​](#new-companioncanonicalusernoncefetchresponse "Direct link to new CompanionCanonicalUserNonceFetchResponse()")

> **new CompanionCanonicalUserNonceFetchResponse**(`p`?): [`CompanionCanonicalUserNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionCanonicalUserNonceFetchResponse)

Defined in: [WAProto/index.d.ts:8004](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8004)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICompanionCanonicalUserNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionCanonicalUserNonceFetchResponse)

#### Returns[​](#returns "Direct link to Returns")

[`CompanionCanonicalUserNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionCanonicalUserNonceFetchResponse)

## Properties[​](#properties "Direct link to Properties")

### forceRefresh?[​](#forcerefresh "Direct link to forceRefresh?")

> `optional` **forceRefresh**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:8007](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8007)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICompanionCanonicalUserNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionCanonicalUserNonceFetchResponse).[`forceRefresh`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionCanonicalUserNonceFetchResponse#forcerefresh)

* * *

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `null` | `string`

Defined in: [WAProto/index.d.ts:8005](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8005)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ICompanionCanonicalUserNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionCanonicalUserNonceFetchResponse).[`nonce`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionCanonicalUserNonceFetchResponse#nonce)

* * *

### waFbid?[​](#wafbid "Direct link to waFbid?")

> `optional` **waFbid**: `null` | `string`

Defined in: [WAProto/index.d.ts:8006](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8006)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ICompanionCanonicalUserNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionCanonicalUserNonceFetchResponse).[`waFbid`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionCanonicalUserNonceFetchResponse#wafbid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8013](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8013)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CompanionCanonicalUserNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionCanonicalUserNonceFetchResponse)

Defined in: [WAProto/index.d.ts:8008](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8008)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICompanionCanonicalUserNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionCanonicalUserNonceFetchResponse)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CompanionCanonicalUserNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionCanonicalUserNonceFetchResponse)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CompanionCanonicalUserNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionCanonicalUserNonceFetchResponse)

Defined in: [WAProto/index.d.ts:8010](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8010)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CompanionCanonicalUserNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionCanonicalUserNonceFetchResponse)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8009](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8009)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICompanionCanonicalUserNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionCanonicalUserNonceFetchResponse)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CompanionCanonicalUserNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionCanonicalUserNonceFetchResponse)

Defined in: [WAProto/index.d.ts:8011](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8011)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CompanionCanonicalUserNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionCanonicalUserNonceFetchResponse)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8014](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8014)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8012](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8012)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CompanionCanonicalUserNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionCanonicalUserNonceFetchResponse)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-companionmetanoncefetchresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionMetaNonceFetchResponse](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionMetaNonceFetchResponse)

Defined in: [WAProto/index.d.ts:8021](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8021)

## Implements[​](#implements "Direct link to Implements")

*   [`ICompanionMetaNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionMetaNonceFetchResponse)

## Constructors[​](#constructors "Direct link to Constructors")

### new CompanionMetaNonceFetchResponse()[​](#new-companionmetanoncefetchresponse "Direct link to new CompanionMetaNonceFetchResponse()")

> **new CompanionMetaNonceFetchResponse**(`p`?): [`CompanionMetaNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionMetaNonceFetchResponse)

Defined in: [WAProto/index.d.ts:8022](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8022)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICompanionMetaNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionMetaNonceFetchResponse)

#### Returns[​](#returns "Direct link to Returns")

[`CompanionMetaNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionMetaNonceFetchResponse)

## Properties[​](#properties "Direct link to Properties")

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `null` | `string`

Defined in: [WAProto/index.d.ts:8023](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8023)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICompanionMetaNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionMetaNonceFetchResponse).[`nonce`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionMetaNonceFetchResponse#nonce)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8029](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8029)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CompanionMetaNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionMetaNonceFetchResponse)

Defined in: [WAProto/index.d.ts:8024](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8024)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICompanionMetaNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionMetaNonceFetchResponse)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CompanionMetaNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionMetaNonceFetchResponse)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CompanionMetaNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionMetaNonceFetchResponse)

Defined in: [WAProto/index.d.ts:8026](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8026)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CompanionMetaNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionMetaNonceFetchResponse)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8025](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8025)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICompanionMetaNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionMetaNonceFetchResponse)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CompanionMetaNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionMetaNonceFetchResponse)

Defined in: [WAProto/index.d.ts:8027](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8027)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CompanionMetaNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionMetaNonceFetchResponse)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8030](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8030)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8028](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8028)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CompanionMetaNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/CompanionMetaNonceFetchResponse)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-fullhistorysyncondemandrequestresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/FullHistorySyncOnDemandRequestResponse](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/FullHistorySyncOnDemandRequestResponse)

Defined in: [WAProto/index.d.ts:8038](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8038)

## Implements[​](#implements "Direct link to Implements")

*   [`IFullHistorySyncOnDemandRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IFullHistorySyncOnDemandRequestResponse)

## Constructors[​](#constructors "Direct link to Constructors")

### new FullHistorySyncOnDemandRequestResponse()[​](#new-fullhistorysyncondemandrequestresponse "Direct link to new FullHistorySyncOnDemandRequestResponse()")

> **new FullHistorySyncOnDemandRequestResponse**(`p`?): [`FullHistorySyncOnDemandRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/FullHistorySyncOnDemandRequestResponse)

Defined in: [WAProto/index.d.ts:8039](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8039)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IFullHistorySyncOnDemandRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IFullHistorySyncOnDemandRequestResponse)

#### Returns[​](#returns "Direct link to Returns")

[`FullHistorySyncOnDemandRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/FullHistorySyncOnDemandRequestResponse)

## Properties[​](#properties "Direct link to Properties")

### requestMetadata?[​](#requestmetadata "Direct link to requestMetadata?")

> `optional` **requestMetadata**: `null` | [`IFullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFullHistorySyncOnDemandRequestMetadata)

Defined in: [WAProto/index.d.ts:8040](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8040)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IFullHistorySyncOnDemandRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IFullHistorySyncOnDemandRequestResponse).[`requestMetadata`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IFullHistorySyncOnDemandRequestResponse#requestmetadata)

* * *

### responseCode?[​](#responsecode "Direct link to responseCode?")

> `optional` **responseCode**: `null` | [`FullHistorySyncOnDemandResponseCode`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/enumerations/FullHistorySyncOnDemandResponseCode)

Defined in: [WAProto/index.d.ts:8041](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8041)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IFullHistorySyncOnDemandRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IFullHistorySyncOnDemandRequestResponse).[`responseCode`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IFullHistorySyncOnDemandRequestResponse#responsecode)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8047](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8047)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`FullHistorySyncOnDemandRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/FullHistorySyncOnDemandRequestResponse)

Defined in: [WAProto/index.d.ts:8042](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8042)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IFullHistorySyncOnDemandRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IFullHistorySyncOnDemandRequestResponse)

#### Returns[​](#returns-2 "Direct link to Returns")

[`FullHistorySyncOnDemandRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/FullHistorySyncOnDemandRequestResponse)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`FullHistorySyncOnDemandRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/FullHistorySyncOnDemandRequestResponse)

Defined in: [WAProto/index.d.ts:8044](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8044)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`FullHistorySyncOnDemandRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/FullHistorySyncOnDemandRequestResponse)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8043](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8043)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IFullHistorySyncOnDemandRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IFullHistorySyncOnDemandRequestResponse)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`FullHistorySyncOnDemandRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/FullHistorySyncOnDemandRequestResponse)

Defined in: [WAProto/index.d.ts:8045](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8045)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`FullHistorySyncOnDemandRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/FullHistorySyncOnDemandRequestResponse)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8048](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8048)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8046](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8046)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`FullHistorySyncOnDemandRequestResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/FullHistorySyncOnDemandRequestResponse)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-historysyncchunkretryresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/HistorySyncChunkRetryResponse](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/HistorySyncChunkRetryResponse)

Defined in: [WAProto/index.d.ts:8069](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8069)

## Implements[​](#implements "Direct link to Implements")

*   [`IHistorySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IHistorySyncChunkRetryResponse)

## Constructors[​](#constructors "Direct link to Constructors")

### new HistorySyncChunkRetryResponse()[​](#new-historysyncchunkretryresponse "Direct link to new HistorySyncChunkRetryResponse()")

> **new HistorySyncChunkRetryResponse**(`p`?): [`HistorySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/HistorySyncChunkRetryResponse)

Defined in: [WAProto/index.d.ts:8070](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8070)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHistorySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IHistorySyncChunkRetryResponse)

#### Returns[​](#returns "Direct link to Returns")

[`HistorySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/HistorySyncChunkRetryResponse)

## Properties[​](#properties "Direct link to Properties")

### canRecover?[​](#canrecover "Direct link to canRecover?")

> `optional` **canRecover**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:8075](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8075)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHistorySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IHistorySyncChunkRetryResponse).[`canRecover`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IHistorySyncChunkRetryResponse#canrecover)

* * *

### chunkOrder?[​](#chunkorder "Direct link to chunkOrder?")

> `optional` **chunkOrder**: `null` | `number`

Defined in: [WAProto/index.d.ts:8072](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8072)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IHistorySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IHistorySyncChunkRetryResponse).[`chunkOrder`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IHistorySyncChunkRetryResponse#chunkorder)

* * *

### requestId?[​](#requestid "Direct link to requestId?")

> `optional` **requestId**: `null` | `string`

Defined in: [WAProto/index.d.ts:8073](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8073)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IHistorySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IHistorySyncChunkRetryResponse).[`requestId`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IHistorySyncChunkRetryResponse#requestid)

* * *

### responseCode?[​](#responsecode "Direct link to responseCode?")

> `optional` **responseCode**: `null` | [`HistorySyncChunkRetryResponseCode`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/enumerations/HistorySyncChunkRetryResponseCode)

Defined in: [WAProto/index.d.ts:8074](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8074)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IHistorySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IHistorySyncChunkRetryResponse).[`responseCode`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IHistorySyncChunkRetryResponse#responsecode)

* * *

### syncType?[​](#synctype "Direct link to syncType?")

> `optional` **syncType**: `null` | [`HistorySyncType`](/docs/api/namespaces/proto/namespaces/Message/enumerations/HistorySyncType)

Defined in: [WAProto/index.d.ts:8071](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8071)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IHistorySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IHistorySyncChunkRetryResponse).[`syncType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IHistorySyncChunkRetryResponse#synctype)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8081](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8081)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`HistorySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/HistorySyncChunkRetryResponse)

Defined in: [WAProto/index.d.ts:8076](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8076)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHistorySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IHistorySyncChunkRetryResponse)

#### Returns[​](#returns-2 "Direct link to Returns")

[`HistorySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/HistorySyncChunkRetryResponse)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`HistorySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/HistorySyncChunkRetryResponse)

Defined in: [WAProto/index.d.ts:8078](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8078)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`HistorySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/HistorySyncChunkRetryResponse)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8077](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8077)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHistorySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IHistorySyncChunkRetryResponse)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`HistorySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/HistorySyncChunkRetryResponse)

Defined in: [WAProto/index.d.ts:8079](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8079)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`HistorySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/HistorySyncChunkRetryResponse)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8082](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8082)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8080](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8080)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`HistorySyncChunkRetryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/HistorySyncChunkRetryResponse)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-linkpreviewresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/LinkPreviewResponse](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/LinkPreviewResponse)

Defined in: [WAProto/index.d.ts:8105](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8105)

## Implements[​](#implements "Direct link to Implements")

*   [`ILinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse)

## Constructors[​](#constructors "Direct link to Constructors")

### new LinkPreviewResponse()[​](#new-linkpreviewresponse "Direct link to new LinkPreviewResponse()")

> **new LinkPreviewResponse**(`p`?): [`LinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/LinkPreviewResponse)

Defined in: [WAProto/index.d.ts:8106](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8106)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ILinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse)

#### Returns[​](#returns "Direct link to Returns")

[`LinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/LinkPreviewResponse)

## Properties[​](#properties "Direct link to Properties")

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:8109](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8109)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse).[`description`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse#description)

* * *

### hqThumbnail?[​](#hqthumbnail "Direct link to hqThumbnail?")

> `optional` **hqThumbnail**: `null` | [`ILinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail)

Defined in: [WAProto/index.d.ts:8113](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8113)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ILinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse).[`hqThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse#hqthumbnail)

* * *

### matchText?[​](#matchtext "Direct link to matchText?")

> `optional` **matchText**: `null` | `string`

Defined in: [WAProto/index.d.ts:8111](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8111)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ILinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse).[`matchText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse#matchtext)

* * *

### previewMetadata?[​](#previewmetadata "Direct link to previewMetadata?")

> `optional` **previewMetadata**: `null` | [`IPaymentLinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/IPaymentLinkPreviewMetadata)

Defined in: [WAProto/index.d.ts:8114](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8114)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ILinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse).[`previewMetadata`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse#previewmetadata)

* * *

### previewType?[​](#previewtype "Direct link to previewType?")

> `optional` **previewType**: `null` | `string`

Defined in: [WAProto/index.d.ts:8112](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8112)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ILinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse).[`previewType`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse#previewtype)

* * *

### thumbData?[​](#thumbdata "Direct link to thumbData?")

> `optional` **thumbData**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8110](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8110)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`ILinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse).[`thumbData`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse#thumbdata)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:8108](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8108)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`ILinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse).[`title`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse#title)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:8107](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8107)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`ILinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse).[`url`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse#url)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8120](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8120)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`LinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/LinkPreviewResponse)

Defined in: [WAProto/index.d.ts:8115](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8115)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ILinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse)

#### Returns[​](#returns-2 "Direct link to Returns")

[`LinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/LinkPreviewResponse)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`LinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/LinkPreviewResponse)

Defined in: [WAProto/index.d.ts:8117](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8117)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`LinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/LinkPreviewResponse)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8116](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8116)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ILinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`LinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/LinkPreviewResponse)

Defined in: [WAProto/index.d.ts:8118](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8118)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`LinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/LinkPreviewResponse)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8121](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8121)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8119](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8119)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`LinkPreviewResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/LinkPreviewResponse)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-placeholdermessageresendresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/PlaceholderMessageResendResponse](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/PlaceholderMessageResendResponse)

Defined in: [WAProto/index.d.ts:8177](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8177)

## Implements[​](#implements "Direct link to Implements")

*   [`IPlaceholderMessageResendResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IPlaceholderMessageResendResponse)

## Constructors[​](#constructors "Direct link to Constructors")

### new PlaceholderMessageResendResponse()[​](#new-placeholdermessageresendresponse "Direct link to new PlaceholderMessageResendResponse()")

> **new PlaceholderMessageResendResponse**(`p`?): [`PlaceholderMessageResendResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/PlaceholderMessageResendResponse)

Defined in: [WAProto/index.d.ts:8178](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8178)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPlaceholderMessageResendResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IPlaceholderMessageResendResponse)

#### Returns[​](#returns "Direct link to Returns")

[`PlaceholderMessageResendResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/PlaceholderMessageResendResponse)

## Properties[​](#properties "Direct link to Properties")

### webMessageInfoBytes?[​](#webmessageinfobytes "Direct link to webMessageInfoBytes?")

> `optional` **webMessageInfoBytes**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8179](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8179)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPlaceholderMessageResendResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IPlaceholderMessageResendResponse).[`webMessageInfoBytes`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IPlaceholderMessageResendResponse#webmessageinfobytes)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8185](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8185)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PlaceholderMessageResendResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/PlaceholderMessageResendResponse)

Defined in: [WAProto/index.d.ts:8180](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8180)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPlaceholderMessageResendResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IPlaceholderMessageResendResponse)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PlaceholderMessageResendResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/PlaceholderMessageResendResponse)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PlaceholderMessageResendResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/PlaceholderMessageResendResponse)

Defined in: [WAProto/index.d.ts:8182](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8182)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PlaceholderMessageResendResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/PlaceholderMessageResendResponse)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8181](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8181)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPlaceholderMessageResendResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IPlaceholderMessageResendResponse)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PlaceholderMessageResendResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/PlaceholderMessageResendResponse)

Defined in: [WAProto/index.d.ts:8183](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8183)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PlaceholderMessageResendResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/PlaceholderMessageResendResponse)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8186](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8186)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8184](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8184)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PlaceholderMessageResendResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/PlaceholderMessageResendResponse)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-syncdsnapshotfatalrecoveryresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/SyncDSnapshotFatalRecoveryResponse](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/SyncDSnapshotFatalRecoveryResponse)

Defined in: [WAProto/index.d.ts:8194](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8194)

## Implements[​](#implements "Direct link to Implements")

*   [`ISyncDSnapshotFatalRecoveryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ISyncDSnapshotFatalRecoveryResponse)

## Constructors[​](#constructors "Direct link to Constructors")

### new SyncDSnapshotFatalRecoveryResponse()[​](#new-syncdsnapshotfatalrecoveryresponse "Direct link to new SyncDSnapshotFatalRecoveryResponse()")

> **new SyncDSnapshotFatalRecoveryResponse**(`p`?): [`SyncDSnapshotFatalRecoveryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/SyncDSnapshotFatalRecoveryResponse)

Defined in: [WAProto/index.d.ts:8195](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8195)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISyncDSnapshotFatalRecoveryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ISyncDSnapshotFatalRecoveryResponse)

#### Returns[​](#returns "Direct link to Returns")

[`SyncDSnapshotFatalRecoveryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/SyncDSnapshotFatalRecoveryResponse)

## Properties[​](#properties "Direct link to Properties")

### collectionSnapshot?[​](#collectionsnapshot "Direct link to collectionSnapshot?")

> `optional` **collectionSnapshot**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8196](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8196)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISyncDSnapshotFatalRecoveryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ISyncDSnapshotFatalRecoveryResponse).[`collectionSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ISyncDSnapshotFatalRecoveryResponse#collectionsnapshot)

* * *

### isCompressed?[​](#iscompressed "Direct link to isCompressed?")

> `optional` **isCompressed**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:8197](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8197)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISyncDSnapshotFatalRecoveryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ISyncDSnapshotFatalRecoveryResponse).[`isCompressed`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ISyncDSnapshotFatalRecoveryResponse#iscompressed)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8203](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8203)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SyncDSnapshotFatalRecoveryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/SyncDSnapshotFatalRecoveryResponse)

Defined in: [WAProto/index.d.ts:8198](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8198)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISyncDSnapshotFatalRecoveryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ISyncDSnapshotFatalRecoveryResponse)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SyncDSnapshotFatalRecoveryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/SyncDSnapshotFatalRecoveryResponse)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SyncDSnapshotFatalRecoveryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/SyncDSnapshotFatalRecoveryResponse)

Defined in: [WAProto/index.d.ts:8200](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8200)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SyncDSnapshotFatalRecoveryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/SyncDSnapshotFatalRecoveryResponse)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8199](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8199)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISyncDSnapshotFatalRecoveryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ISyncDSnapshotFatalRecoveryResponse)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SyncDSnapshotFatalRecoveryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/SyncDSnapshotFatalRecoveryResponse)

Defined in: [WAProto/index.d.ts:8201](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8201)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SyncDSnapshotFatalRecoveryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/SyncDSnapshotFatalRecoveryResponse)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8204](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8204)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8202](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8202)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SyncDSnapshotFatalRecoveryResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/SyncDSnapshotFatalRecoveryResponse)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-wafflenoncefetchresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/WaffleNonceFetchResponse](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/WaffleNonceFetchResponse)

Defined in: [WAProto/index.d.ts:8212](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8212)

## Implements[​](#implements "Direct link to Implements")

*   [`IWaffleNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IWaffleNonceFetchResponse)

## Constructors[​](#constructors "Direct link to Constructors")

### new WaffleNonceFetchResponse()[​](#new-wafflenoncefetchresponse "Direct link to new WaffleNonceFetchResponse()")

> **new WaffleNonceFetchResponse**(`p`?): [`WaffleNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/WaffleNonceFetchResponse)

Defined in: [WAProto/index.d.ts:8213](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8213)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IWaffleNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IWaffleNonceFetchResponse)

#### Returns[​](#returns "Direct link to Returns")

[`WaffleNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/WaffleNonceFetchResponse)

## Properties[​](#properties "Direct link to Properties")

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `null` | `string`

Defined in: [WAProto/index.d.ts:8214](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8214)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IWaffleNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IWaffleNonceFetchResponse).[`nonce`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IWaffleNonceFetchResponse#nonce)

* * *

### waEntFbid?[​](#waentfbid "Direct link to waEntFbid?")

> `optional` **waEntFbid**: `null` | `string`

Defined in: [WAProto/index.d.ts:8215](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8215)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IWaffleNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IWaffleNonceFetchResponse).[`waEntFbid`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IWaffleNonceFetchResponse#waentfbid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8221](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8221)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`WaffleNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/WaffleNonceFetchResponse)

Defined in: [WAProto/index.d.ts:8216](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8216)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IWaffleNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IWaffleNonceFetchResponse)

#### Returns[​](#returns-2 "Direct link to Returns")

[`WaffleNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/WaffleNonceFetchResponse)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`WaffleNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/WaffleNonceFetchResponse)

Defined in: [WAProto/index.d.ts:8218](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8218)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`WaffleNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/WaffleNonceFetchResponse)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8217](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8217)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IWaffleNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IWaffleNonceFetchResponse)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`WaffleNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/WaffleNonceFetchResponse)

Defined in: [WAProto/index.d.ts:8219](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8219)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`WaffleNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/WaffleNonceFetchResponse)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8222](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8222)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8220](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8220)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`WaffleNonceFetchResponse`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/classes/WaffleNonceFetchResponse)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-fullhistorysyncondemandresponsecode"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/enumerations/FullHistorySyncOnDemandResponseCode](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/enumerations/FullHistorySyncOnDemandResponseCode)

Defined in: [WAProto/index.d.ts:8051](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8051)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### DECLINED\_SHARING\_HISTORY[​](#declined_sharing_history "Direct link to DECLINED_SHARING_HISTORY")

> **DECLINED\_SHARING\_HISTORY**: `2`

Defined in: [WAProto/index.d.ts:8054](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8054)

* * *

### ERROR\_HOSTED\_DEVICE\_LOGIN\_TIME\_NOT\_SET[​](#error_hosted_device_login_time_not_set "Direct link to ERROR_HOSTED_DEVICE_LOGIN_TIME_NOT_SET")

> **ERROR\_HOSTED\_DEVICE\_LOGIN\_TIME\_NOT\_SET**: `6`

Defined in: [WAProto/index.d.ts:8058](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8058)

* * *

### ERROR\_HOSTED\_DEVICE\_NOT\_CONNECTED[​](#error_hosted_device_not_connected "Direct link to ERROR_HOSTED_DEVICE_NOT_CONNECTED")

> **ERROR\_HOSTED\_DEVICE\_NOT\_CONNECTED**: `5`

Defined in: [WAProto/index.d.ts:8057](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8057)

* * *

### ERROR\_REQUEST\_ON\_NON\_SMB\_PRIMARY[​](#error_request_on_non_smb_primary "Direct link to ERROR_REQUEST_ON_NON_SMB_PRIMARY")

> **ERROR\_REQUEST\_ON\_NON\_SMB\_PRIMARY**: `4`

Defined in: [WAProto/index.d.ts:8056](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8056)

* * *

### GENERIC\_ERROR[​](#generic_error "Direct link to GENERIC_ERROR")

> **GENERIC\_ERROR**: `3`

Defined in: [WAProto/index.d.ts:8055](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8055)

* * *

### REQUEST\_SUCCESS[​](#request_success "Direct link to REQUEST_SUCCESS")

> **REQUEST\_SUCCESS**: `0`

Defined in: [WAProto/index.d.ts:8052](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8052)

* * *

### REQUEST\_TIME\_EXPIRED[​](#request_time_expired "Direct link to REQUEST_TIME_EXPIRED")

> **REQUEST\_TIME\_EXPIRED**: `1`

Defined in: [WAProto/index.d.ts:8053](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8053)

---

<a name="enumeration-historysyncchunkretryresponsecode"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/enumerations/HistorySyncChunkRetryResponseCode](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/enumerations/HistorySyncChunkRetryResponseCode)

Defined in: [WAProto/index.d.ts:8085](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8085)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### CHUNK\_CONSUMED[​](#chunk_consumed "Direct link to CHUNK_CONSUMED")

> **CHUNK\_CONSUMED**: `2`

Defined in: [WAProto/index.d.ts:8087](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8087)

* * *

### CHUNK\_EXHAUSTED[​](#chunk_exhausted "Direct link to CHUNK_EXHAUSTED")

> **CHUNK\_EXHAUSTED**: `5`

Defined in: [WAProto/index.d.ts:8090](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8090)

* * *

### DUPLICATED\_REQUEST[​](#duplicated_request "Direct link to DUPLICATED_REQUEST")

> **DUPLICATED\_REQUEST**: `6`

Defined in: [WAProto/index.d.ts:8091](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8091)

* * *

### GENERATION\_ERROR[​](#generation_error "Direct link to GENERATION_ERROR")

> **GENERATION\_ERROR**: `1`

Defined in: [WAProto/index.d.ts:8086](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8086)

* * *

### SESSION\_EXHAUSTED[​](#session_exhausted "Direct link to SESSION_EXHAUSTED")

> **SESSION\_EXHAUSTED**: `4`

Defined in: [WAProto/index.d.ts:8089](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8089)

* * *

### TIMEOUT[​](#timeout "Direct link to TIMEOUT")

> **TIMEOUT**: `3`

Defined in: [WAProto/index.d.ts:8088](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8088)

---

<a name="interface-icompanioncanonicalusernoncefetchresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionCanonicalUserNonceFetchResponse](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionCanonicalUserNonceFetchResponse)

Defined in: [WAProto/index.d.ts:7997](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7997)

## Properties[​](#properties "Direct link to Properties")

### forceRefresh?[​](#forcerefresh "Direct link to forceRefresh?")

> `optional` **forceRefresh**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:8000](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8000)

* * *

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `null` | `string`

Defined in: [WAProto/index.d.ts:7998](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7998)

* * *

### waFbid?[​](#wafbid "Direct link to waFbid?")

> `optional` **waFbid**: `null` | `string`

Defined in: [WAProto/index.d.ts:7999](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L7999)

---

<a name="interface-icompanionmetanoncefetchresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionMetaNonceFetchResponse](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ICompanionMetaNonceFetchResponse)

Defined in: [WAProto/index.d.ts:8017](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8017)

## Properties[​](#properties "Direct link to Properties")

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `null` | `string`

Defined in: [WAProto/index.d.ts:8018](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8018)

---

<a name="interface-ifullhistorysyncondemandrequestresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IFullHistorySyncOnDemandRequestResponse](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IFullHistorySyncOnDemandRequestResponse)

Defined in: [WAProto/index.d.ts:8033](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8033)

## Properties[​](#properties "Direct link to Properties")

### requestMetadata?[​](#requestmetadata "Direct link to requestMetadata?")

> `optional` **requestMetadata**: `null` | [`IFullHistorySyncOnDemandRequestMetadata`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IFullHistorySyncOnDemandRequestMetadata)

Defined in: [WAProto/index.d.ts:8034](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8034)

* * *

### responseCode?[​](#responsecode "Direct link to responseCode?")

> `optional` **responseCode**: `null` | [`FullHistorySyncOnDemandResponseCode`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/enumerations/FullHistorySyncOnDemandResponseCode)

Defined in: [WAProto/index.d.ts:8035](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8035)

---

<a name="interface-ihistorysyncchunkretryresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IHistorySyncChunkRetryResponse](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IHistorySyncChunkRetryResponse)

Defined in: [WAProto/index.d.ts:8061](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8061)

## Properties[​](#properties "Direct link to Properties")

### canRecover?[​](#canrecover "Direct link to canRecover?")

> `optional` **canRecover**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:8066](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8066)

* * *

### chunkOrder?[​](#chunkorder "Direct link to chunkOrder?")

> `optional` **chunkOrder**: `null` | `number`

Defined in: [WAProto/index.d.ts:8063](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8063)

* * *

### requestId?[​](#requestid "Direct link to requestId?")

> `optional` **requestId**: `null` | `string`

Defined in: [WAProto/index.d.ts:8064](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8064)

* * *

### responseCode?[​](#responsecode "Direct link to responseCode?")

> `optional` **responseCode**: `null` | [`HistorySyncChunkRetryResponseCode`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/enumerations/HistorySyncChunkRetryResponseCode)

Defined in: [WAProto/index.d.ts:8065](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8065)

* * *

### syncType?[​](#synctype "Direct link to syncType?")

> `optional` **syncType**: `null` | [`HistorySyncType`](/docs/api/namespaces/proto/namespaces/Message/enumerations/HistorySyncType)

Defined in: [WAProto/index.d.ts:8062](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8062)

---

<a name="interface-ilinkpreviewresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ILinkPreviewResponse)

Defined in: [WAProto/index.d.ts:8094](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8094)

## Properties[​](#properties "Direct link to Properties")

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:8097](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8097)

* * *

### hqThumbnail?[​](#hqthumbnail "Direct link to hqThumbnail?")

> `optional` **hqThumbnail**: `null` | [`ILinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail)

Defined in: [WAProto/index.d.ts:8101](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8101)

* * *

### matchText?[​](#matchtext "Direct link to matchText?")

> `optional` **matchText**: `null` | `string`

Defined in: [WAProto/index.d.ts:8099](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8099)

* * *

### previewMetadata?[​](#previewmetadata "Direct link to previewMetadata?")

> `optional` **previewMetadata**: `null` | [`IPaymentLinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/IPaymentLinkPreviewMetadata)

Defined in: [WAProto/index.d.ts:8102](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8102)

* * *

### previewType?[​](#previewtype "Direct link to previewType?")

> `optional` **previewType**: `null` | `string`

Defined in: [WAProto/index.d.ts:8100](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8100)

* * *

### thumbData?[​](#thumbdata "Direct link to thumbData?")

> `optional` **thumbData**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8098](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8098)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:8096](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8096)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:8095](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8095)

---

<a name="interface-iplaceholdermessageresendresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IPlaceholderMessageResendResponse](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IPlaceholderMessageResendResponse)

Defined in: [WAProto/index.d.ts:8173](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8173)

## Properties[​](#properties "Direct link to Properties")

### webMessageInfoBytes?[​](#webmessageinfobytes "Direct link to webMessageInfoBytes?")

> `optional` **webMessageInfoBytes**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8174](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8174)

---

<a name="interface-isyncdsnapshotfatalrecoveryresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ISyncDSnapshotFatalRecoveryResponse](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/ISyncDSnapshotFatalRecoveryResponse)

Defined in: [WAProto/index.d.ts:8189](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8189)

## Properties[​](#properties "Direct link to Properties")

### collectionSnapshot?[​](#collectionsnapshot "Direct link to collectionSnapshot?")

> `optional` **collectionSnapshot**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8190](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8190)

* * *

### isCompressed?[​](#iscompressed "Direct link to isCompressed?")

> `optional` **isCompressed**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:8191](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8191)

---

<a name="interface-iwafflenoncefetchresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IWaffleNonceFetchResponse](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/interfaces/IWaffleNonceFetchResponse)

Defined in: [WAProto/index.d.ts:8207](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8207)

## Properties[​](#properties "Direct link to Properties")

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `null` | `string`

Defined in: [WAProto/index.d.ts:8208](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8208)

* * *

### waEntFbid?[​](#waentfbid "Direct link to waEntFbid?")

> `optional` **waEntFbid**: `null` | `string`

Defined in: [WAProto/index.d.ts:8209](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8209)

---

<a name="linkpreviewresponse"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/)

## Classes[​](#classes "Direct link to Classes")

*   [LinkPreviewHighQualityThumbnail](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/LinkPreviewHighQualityThumbnail)
*   [PaymentLinkPreviewMetadata](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/PaymentLinkPreviewMetadata)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [ILinkPreviewHighQualityThumbnail](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail)
*   [IPaymentLinkPreviewMetadata](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/IPaymentLinkPreviewMetadata)

---

<a name="class-linkpreviewhighqualitythumbnail"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/LinkPreviewHighQualityThumbnail](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/LinkPreviewHighQualityThumbnail)

Defined in: [WAProto/index.d.ts:8136](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8136)

## Implements[​](#implements "Direct link to Implements")

*   [`ILinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail)

## Constructors[​](#constructors "Direct link to Constructors")

### new LinkPreviewHighQualityThumbnail()[​](#new-linkpreviewhighqualitythumbnail "Direct link to new LinkPreviewHighQualityThumbnail()")

> **new LinkPreviewHighQualityThumbnail**(`p`?): [`LinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/LinkPreviewHighQualityThumbnail)

Defined in: [WAProto/index.d.ts:8137](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8137)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ILinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail)

#### Returns[​](#returns "Direct link to Returns")

[`LinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/LinkPreviewHighQualityThumbnail)

## Properties[​](#properties "Direct link to Properties")

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:8138](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8138)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail).[`directPath`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail#directpath)

* * *

### encThumbHash?[​](#encthumbhash "Direct link to encThumbHash?")

> `optional` **encThumbHash**: `null` | `string`

Defined in: [WAProto/index.d.ts:8140](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8140)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ILinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail).[`encThumbHash`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail#encthumbhash)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8141](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8141)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ILinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail).[`mediaKey`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail#mediakey)

* * *

### mediaKeyTimestampMs?[​](#mediakeytimestampms "Direct link to mediaKeyTimestampMs?")

> `optional` **mediaKeyTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8142](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8142)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ILinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail).[`mediaKeyTimestampMs`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail#mediakeytimestampms)

* * *

### thumbHash?[​](#thumbhash "Direct link to thumbHash?")

> `optional` **thumbHash**: `null` | `string`

Defined in: [WAProto/index.d.ts:8139](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8139)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ILinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail).[`thumbHash`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail#thumbhash)

* * *

### thumbHeight?[​](#thumbheight "Direct link to thumbHeight?")

> `optional` **thumbHeight**: `null` | `number`

Defined in: [WAProto/index.d.ts:8144](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8144)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`ILinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail).[`thumbHeight`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail#thumbheight)

* * *

### thumbWidth?[​](#thumbwidth "Direct link to thumbWidth?")

> `optional` **thumbWidth**: `null` | `number`

Defined in: [WAProto/index.d.ts:8143](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8143)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`ILinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail).[`thumbWidth`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail#thumbwidth)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8150](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8150)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`LinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/LinkPreviewHighQualityThumbnail)

Defined in: [WAProto/index.d.ts:8145](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8145)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ILinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail)

#### Returns[​](#returns-2 "Direct link to Returns")

[`LinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/LinkPreviewHighQualityThumbnail)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`LinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/LinkPreviewHighQualityThumbnail)

Defined in: [WAProto/index.d.ts:8147](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8147)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`LinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/LinkPreviewHighQualityThumbnail)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8146](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8146)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ILinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`LinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/LinkPreviewHighQualityThumbnail)

Defined in: [WAProto/index.d.ts:8148](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8148)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`LinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/LinkPreviewHighQualityThumbnail)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8151](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8151)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8149](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8149)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`LinkPreviewHighQualityThumbnail`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/LinkPreviewHighQualityThumbnail)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-paymentlinkpreviewmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/PaymentLinkPreviewMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/PaymentLinkPreviewMetadata)

Defined in: [WAProto/index.d.ts:8159](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8159)

## Implements[​](#implements "Direct link to Implements")

*   [`IPaymentLinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/IPaymentLinkPreviewMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new PaymentLinkPreviewMetadata()[​](#new-paymentlinkpreviewmetadata "Direct link to new PaymentLinkPreviewMetadata()")

> **new PaymentLinkPreviewMetadata**(`p`?): [`PaymentLinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/PaymentLinkPreviewMetadata)

Defined in: [WAProto/index.d.ts:8160](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8160)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPaymentLinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/IPaymentLinkPreviewMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`PaymentLinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/PaymentLinkPreviewMetadata)

## Properties[​](#properties "Direct link to Properties")

### isBusinessVerified?[​](#isbusinessverified "Direct link to isBusinessVerified?")

> `optional` **isBusinessVerified**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:8161](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8161)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPaymentLinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/IPaymentLinkPreviewMetadata).[`isBusinessVerified`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/IPaymentLinkPreviewMetadata#isbusinessverified)

* * *

### providerName?[​](#providername "Direct link to providerName?")

> `optional` **providerName**: `null` | `string`

Defined in: [WAProto/index.d.ts:8162](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8162)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPaymentLinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/IPaymentLinkPreviewMetadata).[`providerName`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/IPaymentLinkPreviewMetadata#providername)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8168](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8168)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PaymentLinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/PaymentLinkPreviewMetadata)

Defined in: [WAProto/index.d.ts:8163](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8163)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPaymentLinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/IPaymentLinkPreviewMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PaymentLinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/PaymentLinkPreviewMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PaymentLinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/PaymentLinkPreviewMetadata)

Defined in: [WAProto/index.d.ts:8165](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8165)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PaymentLinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/PaymentLinkPreviewMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8164](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8164)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPaymentLinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/IPaymentLinkPreviewMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PaymentLinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/PaymentLinkPreviewMetadata)

Defined in: [WAProto/index.d.ts:8166](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8166)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PaymentLinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/PaymentLinkPreviewMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8169](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8169)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8167](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8167)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PaymentLinkPreviewMetadata`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/classes/PaymentLinkPreviewMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ilinkpreviewhighqualitythumbnail"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/ILinkPreviewHighQualityThumbnail)

Defined in: [WAProto/index.d.ts:8126](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8126)

## Properties[​](#properties "Direct link to Properties")

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:8127](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8127)

* * *

### encThumbHash?[​](#encthumbhash "Direct link to encThumbHash?")

> `optional` **encThumbHash**: `null` | `string`

Defined in: [WAProto/index.d.ts:8129](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8129)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:8130](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8130)

* * *

### mediaKeyTimestampMs?[​](#mediakeytimestampms "Direct link to mediaKeyTimestampMs?")

> `optional` **mediaKeyTimestampMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8131](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8131)

* * *

### thumbHash?[​](#thumbhash "Direct link to thumbHash?")

> `optional` **thumbHash**: `null` | `string`

Defined in: [WAProto/index.d.ts:8128](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8128)

* * *

### thumbHeight?[​](#thumbheight "Direct link to thumbHeight?")

> `optional` **thumbHeight**: `null` | `number`

Defined in: [WAProto/index.d.ts:8133](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8133)

* * *

### thumbWidth?[​](#thumbwidth "Direct link to thumbWidth?")

> `optional` **thumbWidth**: `null` | `number`

Defined in: [WAProto/index.d.ts:8132](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8132)

---

<a name="interface-ipaymentlinkpreviewmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/IPaymentLinkPreviewMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PeerDataOperationRequestResponseMessage/namespaces/PeerDataOperationResult/namespaces/LinkPreviewResponse/interfaces/IPaymentLinkPreviewMetadata)

Defined in: [WAProto/index.d.ts:8154](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8154)

## Properties[​](#properties "Direct link to Properties")

### isBusinessVerified?[​](#isbusinessverified "Direct link to isBusinessVerified?")

> `optional` **isBusinessVerified**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:8155](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8155)

* * *

### providerName?[​](#providername "Direct link to providerName?")

> `optional` **providerName**: `null` | `string`

Defined in: [WAProto/index.d.ts:8156](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8156)

---

<a name="pininchatmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PinInChatMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PinInChatMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Type](/docs/api/namespaces/proto/namespaces/Message/namespaces/PinInChatMessage/enumerations/Type)

---

<a name="enumeration-type"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PinInChatMessage/enumerations/Type](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PinInChatMessage/enumerations/Type)

Defined in: [WAProto/index.d.ts:8264](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8264)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### PIN\_FOR\_ALL[​](#pin_for_all "Direct link to PIN_FOR_ALL")

> **PIN\_FOR\_ALL**: `1`

Defined in: [WAProto/index.d.ts:8266](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8266)

* * *

### UNKNOWN\_TYPE[​](#unknown_type "Direct link to UNKNOWN_TYPE")

> **UNKNOWN\_TYPE**: `0`

Defined in: [WAProto/index.d.ts:8265](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8265)

* * *

### UNPIN\_FOR\_ALL[​](#unpin_for_all "Direct link to UNPIN_FOR_ALL")

> **UNPIN\_FOR\_ALL**: `2`

Defined in: [WAProto/index.d.ts:8267](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8267)

---

<a name="placeholdermessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PlaceholderMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PlaceholderMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [PlaceholderType](/docs/api/namespaces/proto/namespaces/Message/namespaces/PlaceholderMessage/enumerations/PlaceholderType)

---

<a name="enumeration-placeholdertype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PlaceholderMessage/enumerations/PlaceholderType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PlaceholderMessage/enumerations/PlaceholderType)

Defined in: [WAProto/index.d.ts:8289](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8289)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### MASK\_LINKED\_DEVICES[​](#mask_linked_devices "Direct link to MASK_LINKED_DEVICES")

> **MASK\_LINKED\_DEVICES**: `0`

Defined in: [WAProto/index.d.ts:8290](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8290)

---

<a name="pollcreationmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/)

## Classes[​](#classes "Direct link to Classes")

*   [Option](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/classes/Option)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IOption](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/interfaces/IOption)

---

<a name="class-option"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/classes/Option](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/classes/Option)

Defined in: [WAProto/index.d.ts:8337](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8337)

## Implements[​](#implements "Direct link to Implements")

*   [`IOption`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/interfaces/IOption)

## Constructors[​](#constructors "Direct link to Constructors")

### new Option()[​](#new-option "Direct link to new Option()")

> **new Option**(`p`?): [`Option`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/classes/Option)

Defined in: [WAProto/index.d.ts:8338](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8338)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IOption`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/interfaces/IOption)

#### Returns[​](#returns "Direct link to Returns")

[`Option`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/classes/Option)

## Properties[​](#properties "Direct link to Properties")

### optionHash?[​](#optionhash "Direct link to optionHash?")

> `optional` **optionHash**: `null` | `string`

Defined in: [WAProto/index.d.ts:8340](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8340)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IOption`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/interfaces/IOption).[`optionHash`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/interfaces/IOption#optionhash)

* * *

### optionName?[​](#optionname "Direct link to optionName?")

> `optional` **optionName**: `null` | `string`

Defined in: [WAProto/index.d.ts:8339](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8339)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IOption`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/interfaces/IOption).[`optionName`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/interfaces/IOption#optionname)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8346](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8346)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Option`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/classes/Option)

Defined in: [WAProto/index.d.ts:8341](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8341)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IOption`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/interfaces/IOption)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Option`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/classes/Option)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Option`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/classes/Option)

Defined in: [WAProto/index.d.ts:8343](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8343)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Option`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/classes/Option)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8342](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8342)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IOption`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/interfaces/IOption)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Option`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/classes/Option)

Defined in: [WAProto/index.d.ts:8344](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8344)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Option`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/classes/Option)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8347](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8347)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8345](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8345)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Option`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/classes/Option)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ioption"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/interfaces/IOption](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PollCreationMessage/interfaces/IOption)

Defined in: [WAProto/index.d.ts:8332](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8332)

## Properties[​](#properties "Direct link to Properties")

### optionHash?[​](#optionhash "Direct link to optionHash?")

> `optional` **optionHash**: `null` | `string`

Defined in: [WAProto/index.d.ts:8334](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8334)

* * *

### optionName?[​](#optionname "Direct link to optionName?")

> `optional` **optionName**: `null` | `string`

Defined in: [WAProto/index.d.ts:8333](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8333)

---

<a name="pollresultsnapshotmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/)

## Classes[​](#classes "Direct link to Classes")

*   [PollVote](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/classes/PollVote)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IPollVote](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/interfaces/IPollVote)

---

<a name="class-pollvote"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/classes/PollVote](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/classes/PollVote)

Defined in: [WAProto/index.d.ts:8398](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8398)

## Implements[​](#implements "Direct link to Implements")

*   [`IPollVote`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/interfaces/IPollVote)

## Constructors[​](#constructors "Direct link to Constructors")

### new PollVote()[​](#new-pollvote "Direct link to new PollVote()")

> **new PollVote**(`p`?): [`PollVote`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/classes/PollVote)

Defined in: [WAProto/index.d.ts:8399](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8399)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPollVote`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/interfaces/IPollVote)

#### Returns[​](#returns "Direct link to Returns")

[`PollVote`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/classes/PollVote)

## Properties[​](#properties "Direct link to Properties")

### optionName?[​](#optionname "Direct link to optionName?")

> `optional` **optionName**: `null` | `string`

Defined in: [WAProto/index.d.ts:8400](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8400)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPollVote`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/interfaces/IPollVote).[`optionName`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/interfaces/IPollVote#optionname)

* * *

### optionVoteCount?[​](#optionvotecount "Direct link to optionVoteCount?")

> `optional` **optionVoteCount**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8401](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8401)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPollVote`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/interfaces/IPollVote).[`optionVoteCount`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/interfaces/IPollVote#optionvotecount)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8407](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8407)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PollVote`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/classes/PollVote)

Defined in: [WAProto/index.d.ts:8402](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8402)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPollVote`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/interfaces/IPollVote)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PollVote`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/classes/PollVote)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PollVote`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/classes/PollVote)

Defined in: [WAProto/index.d.ts:8404](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8404)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PollVote`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/classes/PollVote)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8403](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8403)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPollVote`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/interfaces/IPollVote)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PollVote`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/classes/PollVote)

Defined in: [WAProto/index.d.ts:8405](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8405)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PollVote`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/classes/PollVote)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8408](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8408)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8406](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8406)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PollVote`](/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/classes/PollVote)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ipollvote"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/interfaces/IPollVote](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/PollResultSnapshotMessage/interfaces/IPollVote)

Defined in: [WAProto/index.d.ts:8393](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8393)

## Properties[​](#properties "Direct link to Properties")

### optionName?[​](#optionname "Direct link to optionName?")

> `optional` **optionName**: `null` | `string`

Defined in: [WAProto/index.d.ts:8394](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8394)

* * *

### optionVoteCount?[​](#optionvotecount "Direct link to optionVoteCount?")

> `optional` **optionVoteCount**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8395](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8395)

---

<a name="productmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/)

## Classes[​](#classes "Direct link to Classes")

*   [CatalogSnapshot](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/CatalogSnapshot)
*   [ProductSnapshot](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/ProductSnapshot)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [ICatalogSnapshot](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/ICatalogSnapshot)
*   [IProductSnapshot](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot)

---

<a name="class-catalogsnapshot"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/CatalogSnapshot](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/CatalogSnapshot)

Defined in: [WAProto/index.d.ts:8503](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8503)

## Implements[​](#implements "Direct link to Implements")

*   [`ICatalogSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/ICatalogSnapshot)

## Constructors[​](#constructors "Direct link to Constructors")

### new CatalogSnapshot()[​](#new-catalogsnapshot "Direct link to new CatalogSnapshot()")

> **new CatalogSnapshot**(`p`?): [`CatalogSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/CatalogSnapshot)

Defined in: [WAProto/index.d.ts:8504](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8504)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICatalogSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/ICatalogSnapshot)

#### Returns[​](#returns "Direct link to Returns")

[`CatalogSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/CatalogSnapshot)

## Properties[​](#properties "Direct link to Properties")

### catalogImage?[​](#catalogimage "Direct link to catalogImage?")

> `optional` **catalogImage**: `null` | [`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage)

Defined in: [WAProto/index.d.ts:8505](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8505)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICatalogSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/ICatalogSnapshot).[`catalogImage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/ICatalogSnapshot#catalogimage)

* * *

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:8507](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8507)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ICatalogSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/ICatalogSnapshot).[`description`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/ICatalogSnapshot#description)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:8506](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8506)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ICatalogSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/ICatalogSnapshot).[`title`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/ICatalogSnapshot#title)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8513](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8513)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CatalogSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/CatalogSnapshot)

Defined in: [WAProto/index.d.ts:8508](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8508)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICatalogSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/ICatalogSnapshot)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CatalogSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/CatalogSnapshot)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CatalogSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/CatalogSnapshot)

Defined in: [WAProto/index.d.ts:8510](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8510)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CatalogSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/CatalogSnapshot)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8509](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8509)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICatalogSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/ICatalogSnapshot)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CatalogSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/CatalogSnapshot)

Defined in: [WAProto/index.d.ts:8511](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8511)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CatalogSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/CatalogSnapshot)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8514](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8514)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8512](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8512)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CatalogSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/CatalogSnapshot)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-productsnapshot"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/ProductSnapshot](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/ProductSnapshot)

Defined in: [WAProto/index.d.ts:8532](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8532)

## Implements[​](#implements "Direct link to Implements")

*   [`IProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot)

## Constructors[​](#constructors "Direct link to Constructors")

### new ProductSnapshot()[​](#new-productsnapshot "Direct link to new ProductSnapshot()")

> **new ProductSnapshot**(`p`?): [`ProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/ProductSnapshot)

Defined in: [WAProto/index.d.ts:8533](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8533)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot)

#### Returns[​](#returns "Direct link to Returns")

[`ProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/ProductSnapshot)

## Properties[​](#properties "Direct link to Properties")

### currencyCode?[​](#currencycode "Direct link to currencyCode?")

> `optional` **currencyCode**: `null` | `string`

Defined in: [WAProto/index.d.ts:8538](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8538)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot).[`currencyCode`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot#currencycode)

* * *

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:8537](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8537)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot).[`description`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot#description)

* * *

### firstImageId?[​](#firstimageid "Direct link to firstImageId?")

> `optional` **firstImageId**: `null` | `string`

Defined in: [WAProto/index.d.ts:8543](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8543)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot).[`firstImageId`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot#firstimageid)

* * *

### priceAmount1000?[​](#priceamount1000 "Direct link to priceAmount1000?")

> `optional` **priceAmount1000**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8539](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8539)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot).[`priceAmount1000`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot#priceamount1000)

* * *

### productId?[​](#productid "Direct link to productId?")

> `optional` **productId**: `null` | `string`

Defined in: [WAProto/index.d.ts:8535](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8535)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot).[`productId`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot#productid)

* * *

### productImage?[​](#productimage "Direct link to productImage?")

> `optional` **productImage**: `null` | [`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage)

Defined in: [WAProto/index.d.ts:8534](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8534)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot).[`productImage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot#productimage)

* * *

### productImageCount?[​](#productimagecount "Direct link to productImageCount?")

> `optional` **productImageCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:8542](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8542)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot).[`productImageCount`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot#productimagecount)

* * *

### retailerId?[​](#retailerid "Direct link to retailerId?")

> `optional` **retailerId**: `null` | `string`

Defined in: [WAProto/index.d.ts:8540](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8540)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot).[`retailerId`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot#retailerid)

* * *

### salePriceAmount1000?[​](#salepriceamount1000 "Direct link to salePriceAmount1000?")

> `optional` **salePriceAmount1000**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:8544](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8544)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot).[`salePriceAmount1000`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot#salepriceamount1000)

* * *

### signedUrl?[​](#signedurl "Direct link to signedUrl?")

> `optional` **signedUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:8545](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8545)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot).[`signedUrl`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot#signedurl)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:8536](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8536)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot).[`title`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot#title)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:8541](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8541)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot).[`url`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot#url)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:8551](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8551)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/ProductSnapshot)

Defined in: [WAProto/index.d.ts:8546](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8546)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/ProductSnapshot)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/ProductSnapshot)

Defined in: [WAProto/index.d.ts:8548](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8548)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/ProductSnapshot)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:8547](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8547)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/ProductSnapshot)

Defined in: [WAProto/index.d.ts:8549](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8549)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/ProductSnapshot)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:8552](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8552)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:8550](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8550)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/classes/ProductSnapshot)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-icatalogsnapshot"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/ICatalogSnapshot](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/ICatalogSnapshot)

Defined in: [WAProto/index.d.ts:8497](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8497)

## Properties[​](#properties "Direct link to Properties")

### catalogImage?[​](#catalogimage "Direct link to catalogImage?")

> `optional` **catalogImage**: `null` | [`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage)

Defined in: [WAProto/index.d.ts:8498](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8498)

* * *

### description?[​](#description "Direct link to description?")

> `optional` **description**: `null` | `string`

Defined in: [WAProto/index.d.ts:8500](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8500)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:8499](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8499)

---

<a name="protocolmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ProtocolMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ProtocolMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Type](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProtocolMessage/enumerations/Type)

---

<a name="requestwelcomemessagemetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/RequestWelcomeMessageMetadata/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/RequestWelcomeMessageMetadata/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [LocalChatState](/docs/api/namespaces/proto/namespaces/Message/namespaces/RequestWelcomeMessageMetadata/enumerations/LocalChatState)

---

<a name="enumeration-localchatstate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/RequestWelcomeMessageMetadata/enumerations/LocalChatState](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/RequestWelcomeMessageMetadata/enumerations/LocalChatState)

Defined in: [WAProto/index.d.ts:8752](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8752)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### EMPTY[​](#empty "Direct link to EMPTY")

> **EMPTY**: `0`

Defined in: [WAProto/index.d.ts:8753](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8753)

* * *

### NON\_EMPTY[​](#non_empty "Direct link to NON_EMPTY")

> **NON\_EMPTY**: `1`

Defined in: [WAProto/index.d.ts:8754](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8754)

---

<a name="scheduledcallcreationmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ScheduledCallCreationMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ScheduledCallCreationMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [CallType](/docs/api/namespaces/proto/namespaces/Message/namespaces/ScheduledCallCreationMessage/enumerations/CallType)

---

<a name="enumeration-calltype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ScheduledCallCreationMessage/enumerations/CallType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ScheduledCallCreationMessage/enumerations/CallType)

Defined in: [WAProto/index.d.ts:8780](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8780)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:8781](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8781)

* * *

### VIDEO[​](#video "Direct link to VIDEO")

> **VIDEO**: `2`

Defined in: [WAProto/index.d.ts:8783](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8783)

* * *

### VOICE[​](#voice "Direct link to VOICE")

> **VOICE**: `1`

Defined in: [WAProto/index.d.ts:8782](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8782)

---

<a name="scheduledcalleditmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ScheduledCallEditMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/ScheduledCallEditMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [EditType](/docs/api/namespaces/proto/namespaces/Message/namespaces/ScheduledCallEditMessage/enumerations/EditType)

---

<a name="secretencryptedmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/SecretEncryptedMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/SecretEncryptedMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [SecretEncType](/docs/api/namespaces/proto/namespaces/Message/namespaces/SecretEncryptedMessage/enumerations/SecretEncType)

---

<a name="enumeration-secretenctype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/SecretEncryptedMessage/enumerations/SecretEncType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/SecretEncryptedMessage/enumerations/SecretEncType)

Defined in: [WAProto/index.d.ts:8837](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8837)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### EVENT\_EDIT[​](#event_edit "Direct link to EVENT_EDIT")

> **EVENT\_EDIT**: `1`

Defined in: [WAProto/index.d.ts:8839](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8839)

* * *

### MESSAGE\_EDIT[​](#message_edit "Direct link to MESSAGE_EDIT")

> **MESSAGE\_EDIT**: `2`

Defined in: [WAProto/index.d.ts:8840](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8840)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:8838](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8838)

---

<a name="statusnotificationmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusNotificationMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusNotificationMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [StatusNotificationType](/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusNotificationMessage/enumerations/StatusNotificationType)

---

<a name="enumeration-statusnotificationtype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusNotificationMessage/enumerations/StatusNotificationType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusNotificationMessage/enumerations/StatusNotificationType)

Defined in: [WAProto/index.d.ts:8906](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8906)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### STATUS\_ADD\_YOURS[​](#status_add_yours "Direct link to STATUS_ADD_YOURS")

> **STATUS\_ADD\_YOURS**: `1`

Defined in: [WAProto/index.d.ts:8908](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8908)

* * *

### STATUS\_QUESTION\_ANSWER\_RESHARE[​](#status_question_answer_reshare "Direct link to STATUS_QUESTION_ANSWER_RESHARE")

> **STATUS\_QUESTION\_ANSWER\_RESHARE**: `3`

Defined in: [WAProto/index.d.ts:8910](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8910)

* * *

### STATUS\_RESHARE[​](#status_reshare "Direct link to STATUS_RESHARE")

> **STATUS\_RESHARE**: `2`

Defined in: [WAProto/index.d.ts:8909](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8909)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:8907](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8907)

---

<a name="statusquotedmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusQuotedMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusQuotedMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [StatusQuotedMessageType](/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusQuotedMessage/enumerations/StatusQuotedMessageType)

---

<a name="enumeration-statusquotedmessagetype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusQuotedMessage/enumerations/StatusQuotedMessageType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusQuotedMessage/enumerations/StatusQuotedMessageType)

Defined in: [WAProto/index.d.ts:8956](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8956)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### QUESTION\_ANSWER[​](#question_answer "Direct link to QUESTION_ANSWER")

> **QUESTION\_ANSWER**: `1`

Defined in: [WAProto/index.d.ts:8957](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8957)

---

<a name="statusstickerinteractionmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusStickerInteractionMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusStickerInteractionMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [StatusStickerType](/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusStickerInteractionMessage/enumerations/StatusStickerType)

---

<a name="enumeration-statusstickertype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusStickerInteractionMessage/enumerations/StatusStickerType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/StatusStickerInteractionMessage/enumerations/StatusStickerType)

Defined in: [WAProto/index.d.ts:8983](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8983)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### REACTION[​](#reaction "Direct link to REACTION")

> **REACTION**: `1`

Defined in: [WAProto/index.d.ts:8985](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8985)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:8984](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L8984)

---

<a name="interface-isticker"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/StickerPackMessage/interfaces/ISticker](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/StickerPackMessage/interfaces/ISticker)

Defined in: [WAProto/index.d.ts:9105](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9105)

## Properties[​](#properties "Direct link to Properties")

### accessibilityLabel?[​](#accessibilitylabel "Direct link to accessibilityLabel?")

> `optional` **accessibilityLabel**: `null` | `string`

Defined in: [WAProto/index.d.ts:9109](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9109)

* * *

### emojis?[​](#emojis "Direct link to emojis?")

> `optional` **emojis**: `null` | `string`\[\]

Defined in: [WAProto/index.d.ts:9108](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9108)

* * *

### fileName?[​](#filename "Direct link to fileName?")

> `optional` **fileName**: `null` | `string`

Defined in: [WAProto/index.d.ts:9106](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9106)

* * *

### isAnimated?[​](#isanimated "Direct link to isAnimated?")

> `optional` **isAnimated**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9107](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9107)

* * *

### isLottie?[​](#islottie "Direct link to isLottie?")

> `optional` **isLottie**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9110](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9110)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:9111](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9111)

---

<a name="templatemessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/)

## Classes[​](#classes "Direct link to Classes")

*   [FourRowTemplate](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/FourRowTemplate)
*   [HydratedFourRowTemplate](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/HydratedFourRowTemplate)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IFourRowTemplate](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate)
*   [IHydratedFourRowTemplate](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate)

---

<a name="class-fourrowtemplate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/FourRowTemplate](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/FourRowTemplate)

Defined in: [WAProto/index.d.ts:9222](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9222)

## Implements[​](#implements "Direct link to Implements")

*   [`IFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate)

## Constructors[​](#constructors "Direct link to Constructors")

### new FourRowTemplate()[​](#new-fourrowtemplate "Direct link to new FourRowTemplate()")

> **new FourRowTemplate**(`p`?): [`FourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/FourRowTemplate)

Defined in: [WAProto/index.d.ts:9223](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9223)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate)

#### Returns[​](#returns "Direct link to Returns")

[`FourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/FourRowTemplate)

## Properties[​](#properties "Direct link to Properties")

### buttons[​](#buttons "Direct link to buttons")

> **buttons**: [`ITemplateButton`](/docs/api/namespaces/proto/interfaces/ITemplateButton)\[\]

Defined in: [WAProto/index.d.ts:9226](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9226)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate).[`buttons`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate#buttons)

* * *

### content?[​](#content "Direct link to content?")

> `optional` **content**: `null` | [`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:9224](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9224)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate).[`content`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate#content)

* * *

### documentMessage?[​](#documentmessage "Direct link to documentMessage?")

> `optional` **documentMessage**: `null` | [`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage)

Defined in: [WAProto/index.d.ts:9227](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9227)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate).[`documentMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate#documentmessage)

* * *

### footer?[​](#footer "Direct link to footer?")

> `optional` **footer**: `null` | [`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:9225](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9225)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate).[`footer`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate#footer)

* * *

### highlyStructuredMessage?[​](#highlystructuredmessage "Direct link to highlyStructuredMessage?")

> `optional` **highlyStructuredMessage**: `null` | [`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:9228](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9228)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate).[`highlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate#highlystructuredmessage)

* * *

### imageMessage?[​](#imagemessage "Direct link to imageMessage?")

> `optional` **imageMessage**: `null` | [`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage)

Defined in: [WAProto/index.d.ts:9229](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9229)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate).[`imageMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate#imagemessage)

* * *

### locationMessage?[​](#locationmessage "Direct link to locationMessage?")

> `optional` **locationMessage**: `null` | [`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage)

Defined in: [WAProto/index.d.ts:9231](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9231)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate).[`locationMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate#locationmessage)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `"imageMessage"` | `"locationMessage"` | `"documentMessage"` | `"videoMessage"` | `"highlyStructuredMessage"`

Defined in: [WAProto/index.d.ts:9232](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9232)

* * *

### videoMessage?[​](#videomessage "Direct link to videoMessage?")

> `optional` **videoMessage**: `null` | [`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage)

Defined in: [WAProto/index.d.ts:9230](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9230)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate).[`videoMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate#videomessage)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9238](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9238)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`FourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/FourRowTemplate)

Defined in: [WAProto/index.d.ts:9233](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9233)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate)

#### Returns[​](#returns-2 "Direct link to Returns")

[`FourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/FourRowTemplate)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`FourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/FourRowTemplate)

Defined in: [WAProto/index.d.ts:9235](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9235)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`FourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/FourRowTemplate)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9234](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9234)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`FourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/FourRowTemplate)

Defined in: [WAProto/index.d.ts:9236](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9236)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`FourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/FourRowTemplate)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9239](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9239)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9237](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9237)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`FourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/FourRowTemplate)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-hydratedfourrowtemplate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/HydratedFourRowTemplate](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/HydratedFourRowTemplate)

Defined in: [WAProto/index.d.ts:9255](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9255)

## Implements[​](#implements "Direct link to Implements")

*   [`IHydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate)

## Constructors[​](#constructors "Direct link to Constructors")

### new HydratedFourRowTemplate()[​](#new-hydratedfourrowtemplate "Direct link to new HydratedFourRowTemplate()")

> **new HydratedFourRowTemplate**(`p`?): [`HydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/HydratedFourRowTemplate)

Defined in: [WAProto/index.d.ts:9256](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9256)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IHydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate)

#### Returns[​](#returns "Direct link to Returns")

[`HydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/HydratedFourRowTemplate)

## Properties[​](#properties "Direct link to Properties")

### documentMessage?[​](#documentmessage "Direct link to documentMessage?")

> `optional` **documentMessage**: `null` | [`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage)

Defined in: [WAProto/index.d.ts:9262](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9262)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IHydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate).[`documentMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate#documentmessage)

* * *

### hydratedButtons[​](#hydratedbuttons "Direct link to hydratedButtons")

> **hydratedButtons**: [`IHydratedTemplateButton`](/docs/api/namespaces/proto/interfaces/IHydratedTemplateButton)\[\]

Defined in: [WAProto/index.d.ts:9259](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9259)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IHydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate).[`hydratedButtons`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate#hydratedbuttons)

* * *

### hydratedContentText?[​](#hydratedcontenttext "Direct link to hydratedContentText?")

> `optional` **hydratedContentText**: `null` | `string`

Defined in: [WAProto/index.d.ts:9257](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9257)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IHydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate).[`hydratedContentText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate#hydratedcontenttext)

* * *

### hydratedFooterText?[​](#hydratedfootertext "Direct link to hydratedFooterText?")

> `optional` **hydratedFooterText**: `null` | `string`

Defined in: [WAProto/index.d.ts:9258](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9258)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IHydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate).[`hydratedFooterText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate#hydratedfootertext)

* * *

### hydratedTitleText?[​](#hydratedtitletext "Direct link to hydratedTitleText?")

> `optional` **hydratedTitleText**: `null` | `string`

Defined in: [WAProto/index.d.ts:9263](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9263)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IHydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate).[`hydratedTitleText`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate#hydratedtitletext)

* * *

### imageMessage?[​](#imagemessage "Direct link to imageMessage?")

> `optional` **imageMessage**: `null` | [`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage)

Defined in: [WAProto/index.d.ts:9264](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9264)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IHydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate).[`imageMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate#imagemessage)

* * *

### locationMessage?[​](#locationmessage "Direct link to locationMessage?")

> `optional` **locationMessage**: `null` | [`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage)

Defined in: [WAProto/index.d.ts:9266](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9266)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IHydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate).[`locationMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate#locationmessage)

* * *

### maskLinkedDevices?[​](#masklinkeddevices "Direct link to maskLinkedDevices?")

> `optional` **maskLinkedDevices**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9261](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9261)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IHydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate).[`maskLinkedDevices`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate#masklinkeddevices)

* * *

### templateId?[​](#templateid "Direct link to templateId?")

> `optional` **templateId**: `null` | `string`

Defined in: [WAProto/index.d.ts:9260](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9260)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IHydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate).[`templateId`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate#templateid)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `"imageMessage"` | `"locationMessage"` | `"documentMessage"` | `"videoMessage"` | `"hydratedTitleText"`

Defined in: [WAProto/index.d.ts:9267](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9267)

* * *

### videoMessage?[​](#videomessage "Direct link to videoMessage?")

> `optional` **videoMessage**: `null` | [`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage)

Defined in: [WAProto/index.d.ts:9265](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9265)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IHydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate).[`videoMessage`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate#videomessage)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9273](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9273)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`HydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/HydratedFourRowTemplate)

Defined in: [WAProto/index.d.ts:9268](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9268)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IHydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate)

#### Returns[​](#returns-2 "Direct link to Returns")

[`HydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/HydratedFourRowTemplate)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`HydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/HydratedFourRowTemplate)

Defined in: [WAProto/index.d.ts:9270](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9270)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`HydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/HydratedFourRowTemplate)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9269](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9269)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IHydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`HydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/HydratedFourRowTemplate)

Defined in: [WAProto/index.d.ts:9271](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9271)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`HydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/HydratedFourRowTemplate)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9274](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9274)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9272](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9272)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`HydratedFourRowTemplate`](/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/classes/HydratedFourRowTemplate)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ifourrowtemplate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IFourRowTemplate)

Defined in: [WAProto/index.d.ts:9211](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9211)

## Properties[​](#properties "Direct link to Properties")

### buttons?[​](#buttons "Direct link to buttons?")

> `optional` **buttons**: `null` | [`ITemplateButton`](/docs/api/namespaces/proto/interfaces/ITemplateButton)\[\]

Defined in: [WAProto/index.d.ts:9214](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9214)

* * *

### content?[​](#content "Direct link to content?")

> `optional` **content**: `null` | [`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:9212](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9212)

* * *

### documentMessage?[​](#documentmessage "Direct link to documentMessage?")

> `optional` **documentMessage**: `null` | [`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage)

Defined in: [WAProto/index.d.ts:9215](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9215)

* * *

### footer?[​](#footer "Direct link to footer?")

> `optional` **footer**: `null` | [`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:9213](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9213)

* * *

### highlyStructuredMessage?[​](#highlystructuredmessage "Direct link to highlyStructuredMessage?")

> `optional` **highlyStructuredMessage**: `null` | [`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:9216](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9216)

* * *

### imageMessage?[​](#imagemessage "Direct link to imageMessage?")

> `optional` **imageMessage**: `null` | [`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage)

Defined in: [WAProto/index.d.ts:9217](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9217)

* * *

### locationMessage?[​](#locationmessage "Direct link to locationMessage?")

> `optional` **locationMessage**: `null` | [`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage)

Defined in: [WAProto/index.d.ts:9219](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9219)

* * *

### videoMessage?[​](#videomessage "Direct link to videoMessage?")

> `optional` **videoMessage**: `null` | [`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage)

Defined in: [WAProto/index.d.ts:9218](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9218)

---

<a name="interface-ihydratedfourrowtemplate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/TemplateMessage/interfaces/IHydratedFourRowTemplate)

Defined in: [WAProto/index.d.ts:9242](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9242)

## Properties[​](#properties "Direct link to Properties")

### documentMessage?[​](#documentmessage "Direct link to documentMessage?")

> `optional` **documentMessage**: `null` | [`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage)

Defined in: [WAProto/index.d.ts:9248](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9248)

* * *

### hydratedButtons?[​](#hydratedbuttons "Direct link to hydratedButtons?")

> `optional` **hydratedButtons**: `null` | [`IHydratedTemplateButton`](/docs/api/namespaces/proto/interfaces/IHydratedTemplateButton)\[\]

Defined in: [WAProto/index.d.ts:9245](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9245)

* * *

### hydratedContentText?[​](#hydratedcontenttext "Direct link to hydratedContentText?")

> `optional` **hydratedContentText**: `null` | `string`

Defined in: [WAProto/index.d.ts:9243](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9243)

* * *

### hydratedFooterText?[​](#hydratedfootertext "Direct link to hydratedFooterText?")

> `optional` **hydratedFooterText**: `null` | `string`

Defined in: [WAProto/index.d.ts:9244](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9244)

* * *

### hydratedTitleText?[​](#hydratedtitletext "Direct link to hydratedTitleText?")

> `optional` **hydratedTitleText**: `null` | `string`

Defined in: [WAProto/index.d.ts:9249](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9249)

* * *

### imageMessage?[​](#imagemessage "Direct link to imageMessage?")

> `optional` **imageMessage**: `null` | [`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage)

Defined in: [WAProto/index.d.ts:9250](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9250)

* * *

### locationMessage?[​](#locationmessage "Direct link to locationMessage?")

> `optional` **locationMessage**: `null` | [`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage)

Defined in: [WAProto/index.d.ts:9252](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9252)

* * *

### maskLinkedDevices?[​](#masklinkeddevices "Direct link to maskLinkedDevices?")

> `optional` **maskLinkedDevices**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:9247](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9247)

* * *

### templateId?[​](#templateid "Direct link to templateId?")

> `optional` **templateId**: `null` | `string`

Defined in: [WAProto/index.d.ts:9246](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9246)

* * *

### videoMessage?[​](#videomessage "Direct link to videoMessage?")

> `optional` **videoMessage**: `null` | [`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage)

Defined in: [WAProto/index.d.ts:9251](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9251)

---

<a name="videomessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/VideoMessage/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/VideoMessage/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Attribution](/docs/api/namespaces/proto/namespaces/Message/namespaces/VideoMessage/enumerations/Attribution)
*   [VideoSourceType](/docs/api/namespaces/proto/namespaces/Message/namespaces/VideoMessage/enumerations/VideoSourceType)

---

<a name="enumeration-attribution"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/VideoMessage/enumerations/Attribution](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/VideoMessage/enumerations/Attribution)

Defined in: [WAProto/index.d.ts:9394](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9394)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### GIPHY[​](#giphy "Direct link to GIPHY")

> **GIPHY**: `1`

Defined in: [WAProto/index.d.ts:9396](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9396)

* * *

### KLIPY[​](#klipy "Direct link to KLIPY")

> **KLIPY**: `3`

Defined in: [WAProto/index.d.ts:9398](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9398)

* * *

### NONE[​](#none "Direct link to NONE")

> **NONE**: `0`

Defined in: [WAProto/index.d.ts:9395](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9395)

* * *

### TENOR[​](#tenor "Direct link to TENOR")

> **TENOR**: `2`

Defined in: [WAProto/index.d.ts:9397](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9397)

---

<a name="enumeration-videosourcetype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/VideoMessage/enumerations/VideoSourceType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/Message/namespaces/VideoMessage/enumerations/VideoSourceType)

Defined in: [WAProto/index.d.ts:9401](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9401)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AI\_GENERATED[​](#ai_generated "Direct link to AI_GENERATED")

> **AI\_GENERATED**: `1`

Defined in: [WAProto/index.d.ts:9403](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9403)

* * *

### USER\_VIDEO[​](#user_video "Direct link to USER_VIDEO")

> **USER\_VIDEO**: `0`

Defined in: [WAProto/index.d.ts:9402](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9402)

---

<a name="messageaddon"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/MessageAddOn/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/MessageAddOn/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [MessageAddOnType](/docs/api/namespaces/proto/namespaces/MessageAddOn/enumerations/MessageAddOnType)

---

<a name="enumeration-messageaddontype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/MessageAddOn/enumerations/MessageAddOnType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/MessageAddOn/enumerations/MessageAddOnType)

Defined in: [WAProto/index.d.ts:9440](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9440)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### EVENT\_RESPONSE[​](#event_response "Direct link to EVENT_RESPONSE")

> **EVENT\_RESPONSE**: `2`

Defined in: [WAProto/index.d.ts:9443](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9443)

* * *

### PIN\_IN\_CHAT[​](#pin_in_chat "Direct link to PIN_IN_CHAT")

> **PIN\_IN\_CHAT**: `4`

Defined in: [WAProto/index.d.ts:9445](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9445)

* * *

### POLL\_UPDATE[​](#poll_update "Direct link to POLL_UPDATE")

> **POLL\_UPDATE**: `3`

Defined in: [WAProto/index.d.ts:9444](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9444)

* * *

### REACTION[​](#reaction "Direct link to REACTION")

> **REACTION**: `1`

Defined in: [WAProto/index.d.ts:9442](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9442)

* * *

### UNDEFINED[​](#undefined "Direct link to UNDEFINED")

> **UNDEFINED**: `0`

Defined in: [WAProto/index.d.ts:9441](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9441)

---

<a name="messageassociation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/MessageAssociation/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/MessageAssociation/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [AssociationType](/docs/api/namespaces/proto/namespaces/MessageAssociation/enumerations/AssociationType)

---

<a name="enumeration-associationtype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/MessageAssociation/enumerations/AssociationType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/MessageAssociation/enumerations/AssociationType)

Defined in: [WAProto/index.d.ts:9489](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9489)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### BOT\_PLUGIN[​](#bot_plugin "Direct link to BOT_PLUGIN")

> **BOT\_PLUGIN**: `2`

Defined in: [WAProto/index.d.ts:9492](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9492)

* * *

### EVENT\_COVER\_IMAGE[​](#event_cover_image "Direct link to EVENT_COVER_IMAGE")

> **EVENT\_COVER\_IMAGE**: `3`

Defined in: [WAProto/index.d.ts:9493](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9493)

* * *

### HD\_IMAGE\_DUAL\_UPLOAD[​](#hd_image_dual_upload "Direct link to HD_IMAGE_DUAL_UPLOAD")

> **HD\_IMAGE\_DUAL\_UPLOAD**: `10`

Defined in: [WAProto/index.d.ts:9500](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9500)

* * *

### HD\_VIDEO\_DUAL\_UPLOAD[​](#hd_video_dual_upload "Direct link to HD_VIDEO_DUAL_UPLOAD")

> **HD\_VIDEO\_DUAL\_UPLOAD**: `5`

Defined in: [WAProto/index.d.ts:9495](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9495)

* * *

### HEVC\_VIDEO\_DUAL\_UPLOAD[​](#hevc_video_dual_upload "Direct link to HEVC_VIDEO_DUAL_UPLOAD")

> **HEVC\_VIDEO\_DUAL\_UPLOAD**: `19`

Defined in: [WAProto/index.d.ts:9509](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9509)

* * *

### MEDIA\_ALBUM[​](#media_album "Direct link to MEDIA_ALBUM")

> **MEDIA\_ALBUM**: `1`

Defined in: [WAProto/index.d.ts:9491](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9491)

* * *

### MEDIA\_POLL[​](#media_poll "Direct link to MEDIA_POLL")

> **MEDIA\_POLL**: `7`

Defined in: [WAProto/index.d.ts:9497](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9497)

* * *

### MOTION\_PHOTO[​](#motion_photo "Direct link to MOTION_PHOTO")

> **MOTION\_PHOTO**: `12`

Defined in: [WAProto/index.d.ts:9502](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9502)

* * *

### STATUS\_ADD\_YOURS[​](#status_add_yours "Direct link to STATUS_ADD_YOURS")

> **STATUS\_ADD\_YOURS**: `8`

Defined in: [WAProto/index.d.ts:9498](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9498)

* * *

### STATUS\_ADD\_YOURS\_AI\_IMAGINE[​](#status_add_yours_ai_imagine "Direct link to STATUS_ADD_YOURS_AI_IMAGINE")

> **STATUS\_ADD\_YOURS\_AI\_IMAGINE**: `15`

Defined in: [WAProto/index.d.ts:9505](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9505)

* * *

### STATUS\_ADD\_YOURS\_DIWALI[​](#status_add_yours_diwali "Direct link to STATUS_ADD_YOURS_DIWALI")

> **STATUS\_ADD\_YOURS\_DIWALI**: `17`

Defined in: [WAProto/index.d.ts:9507](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9507)

* * *

### STATUS\_EXTERNAL\_RESHARE[​](#status_external_reshare "Direct link to STATUS_EXTERNAL_RESHARE")

> **STATUS\_EXTERNAL\_RESHARE**: `6`

Defined in: [WAProto/index.d.ts:9496](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9496)

* * *

### STATUS\_LINK\_ACTION[​](#status_link_action "Direct link to STATUS_LINK_ACTION")

> **STATUS\_LINK\_ACTION**: `13`

Defined in: [WAProto/index.d.ts:9503](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9503)

* * *

### STATUS\_NOTIFICATION[​](#status_notification "Direct link to STATUS_NOTIFICATION")

> **STATUS\_NOTIFICATION**: `9`

Defined in: [WAProto/index.d.ts:9499](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9499)

* * *

### STATUS\_POLL[​](#status_poll "Direct link to STATUS_POLL")

> **STATUS\_POLL**: `4`

Defined in: [WAProto/index.d.ts:9494](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9494)

* * *

### STATUS\_QUESTION[​](#status_question "Direct link to STATUS_QUESTION")

> **STATUS\_QUESTION**: `16`

Defined in: [WAProto/index.d.ts:9506](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9506)

* * *

### STATUS\_REACTION[​](#status_reaction "Direct link to STATUS_REACTION")

> **STATUS\_REACTION**: `18`

Defined in: [WAProto/index.d.ts:9508](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9508)

* * *

### STICKER\_ANNOTATION[​](#sticker_annotation "Direct link to STICKER_ANNOTATION")

> **STICKER\_ANNOTATION**: `11`

Defined in: [WAProto/index.d.ts:9501](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9501)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:9490](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9490)

* * *

### VIEW\_ALL\_REPLIES[​](#view_all_replies "Direct link to VIEW_ALL_REPLIES")

> **VIEW\_ALL\_REPLIES**: `14`

Defined in: [WAProto/index.d.ts:9504](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9504)

---

<a name="messagecontextinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/MessageContextInfo/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/MessageContextInfo/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [MessageAddonExpiryType](/docs/api/namespaces/proto/namespaces/MessageContextInfo/enumerations/MessageAddonExpiryType)

---

<a name="enumeration-messageaddonexpirytype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/MessageContextInfo/enumerations/MessageAddonExpiryType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/MessageContextInfo/enumerations/MessageAddonExpiryType)

Defined in: [WAProto/index.d.ts:9561](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9561)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### DEPENDENT\_ON\_PARENT[​](#dependent_on_parent "Direct link to DEPENDENT_ON_PARENT")

> **DEPENDENT\_ON\_PARENT**: `2`

Defined in: [WAProto/index.d.ts:9563](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9563)

* * *

### STATIC[​](#static "Direct link to STATIC")

> **STATIC**: `1`

Defined in: [WAProto/index.d.ts:9562](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9562)

---

<a name="msgopaquedata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [PollContentType](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/enumerations/PollContentType)
*   [PollType](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/enumerations/PollType)

## Classes[​](#classes "Direct link to Classes")

*   [EventLocation](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/EventLocation)
*   [PollOption](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollOption)
*   [PollVoteSnapshot](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVoteSnapshot)
*   [PollVotesSnapshot](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVotesSnapshot)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IEventLocation](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation)
*   [IPollOption](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollOption)
*   [IPollVoteSnapshot](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVoteSnapshot)
*   [IPollVotesSnapshot](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVotesSnapshot)

---

<a name="class-eventlocation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/EventLocation](https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/EventLocation)

Defined in: [WAProto/index.d.ts:9740](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9740)

## Implements[​](#implements "Direct link to Implements")

*   [`IEventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation)

## Constructors[​](#constructors "Direct link to Constructors")

### new EventLocation()[​](#new-eventlocation "Direct link to new EventLocation()")

> **new EventLocation**(`p`?): [`EventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/EventLocation)

Defined in: [WAProto/index.d.ts:9741](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9741)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IEventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation)

#### Returns[​](#returns "Direct link to Returns")

[`EventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/EventLocation)

## Properties[​](#properties "Direct link to Properties")

### address?[​](#address "Direct link to address?")

> `optional` **address**: `null` | `string`

Defined in: [WAProto/index.d.ts:9745](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9745)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IEventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation).[`address`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation#address)

* * *

### degreesLatitude?[​](#degreeslatitude "Direct link to degreesLatitude?")

> `optional` **degreesLatitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:9742](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9742)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IEventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation).[`degreesLatitude`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation#degreeslatitude)

* * *

### degreesLongitude?[​](#degreeslongitude "Direct link to degreesLongitude?")

> `optional` **degreesLongitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:9743](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9743)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IEventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation).[`degreesLongitude`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation#degreeslongitude)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9747](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9747)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IEventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation).[`jpegThumbnail`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation#jpegthumbnail)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:9744](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9744)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IEventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation).[`name`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation#name)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:9746](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9746)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IEventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation).[`url`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation#url)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9753](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9753)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`EventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/EventLocation)

Defined in: [WAProto/index.d.ts:9748](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9748)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IEventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation)

#### Returns[​](#returns-2 "Direct link to Returns")

[`EventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/EventLocation)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`EventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/EventLocation)

Defined in: [WAProto/index.d.ts:9750](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9750)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`EventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/EventLocation)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9749](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9749)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IEventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`EventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/EventLocation)

Defined in: [WAProto/index.d.ts:9751](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9751)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`EventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/EventLocation)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9754](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9754)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9752](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9752)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`EventLocation`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/EventLocation)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-polloption"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollOption](https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollOption)

Defined in: [WAProto/index.d.ts:9768](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9768)

## Implements[​](#implements "Direct link to Implements")

*   [`IPollOption`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollOption)

## Constructors[​](#constructors "Direct link to Constructors")

### new PollOption()[​](#new-polloption "Direct link to new PollOption()")

> **new PollOption**(`p`?): [`PollOption`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollOption)

Defined in: [WAProto/index.d.ts:9769](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9769)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPollOption`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollOption)

#### Returns[​](#returns "Direct link to Returns")

[`PollOption`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollOption)

## Properties[​](#properties "Direct link to Properties")

### hash?[​](#hash "Direct link to hash?")

> `optional` **hash**: `null` | `string`

Defined in: [WAProto/index.d.ts:9771](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9771)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPollOption`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollOption).[`hash`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollOption#hash)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:9770](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9770)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPollOption`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollOption).[`name`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollOption#name)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9777](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9777)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PollOption`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollOption)

Defined in: [WAProto/index.d.ts:9772](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9772)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPollOption`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollOption)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PollOption`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollOption)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PollOption`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollOption)

Defined in: [WAProto/index.d.ts:9774](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9774)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PollOption`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollOption)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9773](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9773)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPollOption`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollOption)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PollOption`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollOption)

Defined in: [WAProto/index.d.ts:9775](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9775)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PollOption`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollOption)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9778](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9778)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9776](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9776)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PollOption`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollOption)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pollvotesnapshot"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVoteSnapshot](https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVoteSnapshot)

Defined in: [WAProto/index.d.ts:9791](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9791)

## Implements[​](#implements "Direct link to Implements")

*   [`IPollVoteSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVoteSnapshot)

## Constructors[​](#constructors "Direct link to Constructors")

### new PollVoteSnapshot()[​](#new-pollvotesnapshot "Direct link to new PollVoteSnapshot()")

> **new PollVoteSnapshot**(`p`?): [`PollVoteSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVoteSnapshot)

Defined in: [WAProto/index.d.ts:9792](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9792)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPollVoteSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVoteSnapshot)

#### Returns[​](#returns "Direct link to Returns")

[`PollVoteSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVoteSnapshot)

## Properties[​](#properties "Direct link to Properties")

### option?[​](#option "Direct link to option?")

> `optional` **option**: `null` | [`IPollOption`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollOption)

Defined in: [WAProto/index.d.ts:9793](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9793)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPollVoteSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVoteSnapshot).[`option`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVoteSnapshot#option)

* * *

### optionVoteCount?[​](#optionvotecount "Direct link to optionVoteCount?")

> `optional` **optionVoteCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:9794](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9794)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPollVoteSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVoteSnapshot).[`optionVoteCount`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVoteSnapshot#optionvotecount)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9800](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9800)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PollVoteSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVoteSnapshot)

Defined in: [WAProto/index.d.ts:9795](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9795)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPollVoteSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVoteSnapshot)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PollVoteSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVoteSnapshot)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PollVoteSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVoteSnapshot)

Defined in: [WAProto/index.d.ts:9797](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9797)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PollVoteSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVoteSnapshot)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9796](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9796)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPollVoteSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVoteSnapshot)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PollVoteSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVoteSnapshot)

Defined in: [WAProto/index.d.ts:9798](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9798)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PollVoteSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVoteSnapshot)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9801](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9801)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9799](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9799)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PollVoteSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVoteSnapshot)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pollvotessnapshot"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVotesSnapshot](https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVotesSnapshot)

Defined in: [WAProto/index.d.ts:9808](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9808)

## Implements[​](#implements "Direct link to Implements")

*   [`IPollVotesSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVotesSnapshot)

## Constructors[​](#constructors "Direct link to Constructors")

### new PollVotesSnapshot()[​](#new-pollvotessnapshot "Direct link to new PollVotesSnapshot()")

> **new PollVotesSnapshot**(`p`?): [`PollVotesSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVotesSnapshot)

Defined in: [WAProto/index.d.ts:9809](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9809)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPollVotesSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVotesSnapshot)

#### Returns[​](#returns "Direct link to Returns")

[`PollVotesSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVotesSnapshot)

## Properties[​](#properties "Direct link to Properties")

### pollVotes[​](#pollvotes "Direct link to pollVotes")

> **pollVotes**: [`IPollVoteSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVoteSnapshot)\[\]

Defined in: [WAProto/index.d.ts:9810](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9810)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPollVotesSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVotesSnapshot).[`pollVotes`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVotesSnapshot#pollvotes)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9816](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9816)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PollVotesSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVotesSnapshot)

Defined in: [WAProto/index.d.ts:9811](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9811)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPollVotesSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVotesSnapshot)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PollVotesSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVotesSnapshot)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PollVotesSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVotesSnapshot)

Defined in: [WAProto/index.d.ts:9813](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9813)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PollVotesSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVotesSnapshot)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9812](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9812)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPollVotesSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVotesSnapshot)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PollVotesSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVotesSnapshot)

Defined in: [WAProto/index.d.ts:9814](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9814)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PollVotesSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVotesSnapshot)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9817](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9817)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9815](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9815)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PollVotesSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/classes/PollVotesSnapshot)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-pollcontenttype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/enumerations/PollContentType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/enumerations/PollContentType)

Defined in: [WAProto/index.d.ts:9757](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9757)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### IMAGE[​](#image "Direct link to IMAGE")

> **IMAGE**: `2`

Defined in: [WAProto/index.d.ts:9760](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9760)

* * *

### TEXT[​](#text "Direct link to TEXT")

> **TEXT**: `1`

Defined in: [WAProto/index.d.ts:9759](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9759)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:9758](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9758)

---

<a name="enumeration-polltype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/enumerations/PollType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/enumerations/PollType)

Defined in: [WAProto/index.d.ts:9781](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9781)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### POLL[​](#poll "Direct link to POLL")

> **POLL**: `0`

Defined in: [WAProto/index.d.ts:9782](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9782)

* * *

### QUIZ[​](#quiz "Direct link to QUIZ")

> **QUIZ**: `1`

Defined in: [WAProto/index.d.ts:9783](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9783)

---

<a name="interface-ieventlocation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation](https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IEventLocation)

Defined in: [WAProto/index.d.ts:9731](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9731)

## Properties[​](#properties "Direct link to Properties")

### address?[​](#address "Direct link to address?")

> `optional` **address**: `null` | `string`

Defined in: [WAProto/index.d.ts:9735](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9735)

* * *

### degreesLatitude?[​](#degreeslatitude "Direct link to degreesLatitude?")

> `optional` **degreesLatitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:9732](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9732)

* * *

### degreesLongitude?[​](#degreeslongitude "Direct link to degreesLongitude?")

> `optional` **degreesLongitude**: `null` | `number`

Defined in: [WAProto/index.d.ts:9733](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9733)

* * *

### jpegThumbnail?[​](#jpegthumbnail "Direct link to jpegThumbnail?")

> `optional` **jpegThumbnail**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9737](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9737)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:9734](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9734)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:9736](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9736)

---

<a name="interface-ipolloption"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollOption](https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollOption)

Defined in: [WAProto/index.d.ts:9763](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9763)

## Properties[​](#properties "Direct link to Properties")

### hash?[​](#hash "Direct link to hash?")

> `optional` **hash**: `null` | `string`

Defined in: [WAProto/index.d.ts:9765](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9765)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:9764](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9764)

---

<a name="interface-ipollvotesnapshot"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVoteSnapshot](https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVoteSnapshot)

Defined in: [WAProto/index.d.ts:9786](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9786)

## Properties[​](#properties "Direct link to Properties")

### option?[​](#option "Direct link to option?")

> `optional` **option**: `null` | [`IPollOption`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollOption)

Defined in: [WAProto/index.d.ts:9787](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9787)

* * *

### optionVoteCount?[​](#optionvotecount "Direct link to optionVoteCount?")

> `optional` **optionVoteCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:9788](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9788)

---

<a name="interface-ipollvotessnapshot"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVotesSnapshot](https://baileys.wiki/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVotesSnapshot)

Defined in: [WAProto/index.d.ts:9804](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9804)

## Properties[​](#properties "Direct link to Properties")

### pollVotes?[​](#pollvotes "Direct link to pollVotes?")

> `optional` **pollVotes**: `null` | [`IPollVoteSnapshot`](/docs/api/namespaces/proto/namespaces/MsgOpaqueData/interfaces/IPollVoteSnapshot)\[\]

Defined in: [WAProto/index.d.ts:9805](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9805)

---

<a name="noisecertificate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/NoiseCertificate/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/NoiseCertificate/)

## Classes[​](#classes "Direct link to Classes")

*   [Details](/docs/api/namespaces/proto/namespaces/NoiseCertificate/classes/Details)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IDetails](/docs/api/namespaces/proto/namespaces/NoiseCertificate/interfaces/IDetails)

---

<a name="class-details"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/NoiseCertificate/classes/Details](https://baileys.wiki/docs/api/namespaces/proto/namespaces/NoiseCertificate/classes/Details)

Defined in: [WAProto/index.d.ts:9943](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9943)

## Implements[​](#implements "Direct link to Implements")

*   [`IDetails`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/interfaces/IDetails)

## Constructors[​](#constructors "Direct link to Constructors")

### new Details()[​](#new-details "Direct link to new Details()")

> **new Details**(`p`?): [`Details`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/classes/Details)

Defined in: [WAProto/index.d.ts:9944](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9944)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IDetails`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/interfaces/IDetails)

#### Returns[​](#returns "Direct link to Returns")

[`Details`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/classes/Details)

## Properties[​](#properties "Direct link to Properties")

### expires?[​](#expires "Direct link to expires?")

> `optional` **expires**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9947](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9947)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IDetails`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/interfaces/IDetails).[`expires`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/interfaces/IDetails#expires)

* * *

### issuer?[​](#issuer "Direct link to issuer?")

> `optional` **issuer**: `null` | `string`

Defined in: [WAProto/index.d.ts:9946](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9946)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IDetails`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/interfaces/IDetails).[`issuer`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/interfaces/IDetails#issuer)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9949](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9949)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IDetails`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/interfaces/IDetails).[`key`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/interfaces/IDetails#key)

* * *

### serial?[​](#serial "Direct link to serial?")

> `optional` **serial**: `null` | `number`

Defined in: [WAProto/index.d.ts:9945](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9945)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IDetails`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/interfaces/IDetails).[`serial`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/interfaces/IDetails#serial)

* * *

### subject?[​](#subject "Direct link to subject?")

> `optional` **subject**: `null` | `string`

Defined in: [WAProto/index.d.ts:9948](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9948)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IDetails`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/interfaces/IDetails).[`subject`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/interfaces/IDetails#subject)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:9955](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9955)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Details`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/classes/Details)

Defined in: [WAProto/index.d.ts:9950](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9950)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IDetails`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/interfaces/IDetails)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Details`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/classes/Details)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Details`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/classes/Details)

Defined in: [WAProto/index.d.ts:9952](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9952)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Details`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/classes/Details)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:9951](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9951)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IDetails`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/interfaces/IDetails)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Details`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/classes/Details)

Defined in: [WAProto/index.d.ts:9953](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9953)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Details`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/classes/Details)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:9956](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9956)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:9954](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9954)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Details`](/docs/api/namespaces/proto/namespaces/NoiseCertificate/classes/Details)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-idetails"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/NoiseCertificate/interfaces/IDetails](https://baileys.wiki/docs/api/namespaces/proto/namespaces/NoiseCertificate/interfaces/IDetails)

Defined in: [WAProto/index.d.ts:9935](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9935)

## Properties[​](#properties "Direct link to Properties")

### expires?[​](#expires "Direct link to expires?")

> `optional` **expires**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:9938](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9938)

* * *

### issuer?[​](#issuer "Direct link to issuer?")

> `optional` **issuer**: `null` | `string`

Defined in: [WAProto/index.d.ts:9937](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9937)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:9940](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9940)

* * *

### serial?[​](#serial "Direct link to serial?")

> `optional` **serial**: `null` | `number`

Defined in: [WAProto/index.d.ts:9936](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9936)

* * *

### subject?[​](#subject "Direct link to subject?")

> `optional` **subject**: `null` | `string`

Defined in: [WAProto/index.d.ts:9939](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L9939)

---

<a name="pastparticipant"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/PastParticipant/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/PastParticipant/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [LeaveReason](/docs/api/namespaces/proto/namespaces/PastParticipant/enumerations/LeaveReason)

---

<a name="enumeration-leavereason"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/PastParticipant/enumerations/LeaveReason](https://baileys.wiki/docs/api/namespaces/proto/namespaces/PastParticipant/enumerations/LeaveReason)

Defined in: [WAProto/index.d.ts:10050](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10050)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### LEFT[​](#left "Direct link to LEFT")

> **LEFT**: `0`

Defined in: [WAProto/index.d.ts:10051](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10051)

* * *

### REMOVED[​](#removed "Direct link to REMOVED")

> **REMOVED**: `1`

Defined in: [WAProto/index.d.ts:10052](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10052)

---

<a name="patchdebugdata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/PatchDebugData/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/PatchDebugData/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Platform](/docs/api/namespaces/proto/namespaces/PatchDebugData/enumerations/Platform)

---

<a name="enumeration-platform"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/PatchDebugData/enumerations/Platform](https://baileys.wiki/docs/api/namespaces/proto/namespaces/PatchDebugData/enumerations/Platform)

Defined in: [WAProto/index.d.ts:10112](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10112)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### ANDROID[​](#android "Direct link to ANDROID")

> **ANDROID**: `0`

Defined in: [WAProto/index.d.ts:10113](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10113)

* * *

### CAPI[​](#capi "Direct link to CAPI")

> **CAPI**: `11`

Defined in: [WAProto/index.d.ts:10124](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10124)

* * *

### DARWIN[​](#darwin "Direct link to DARWIN")

> **DARWIN**: `6`

Defined in: [WAProto/index.d.ts:10119](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10119)

* * *

### IPAD[​](#ipad "Direct link to IPAD")

> **IPAD**: `7`

Defined in: [WAProto/index.d.ts:10120](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10120)

* * *

### IPHONE[​](#iphone "Direct link to IPHONE")

> **IPHONE**: `2`

Defined in: [WAProto/index.d.ts:10115](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10115)

* * *

### SMBA[​](#smba "Direct link to SMBA")

> **SMBA**: `1`

Defined in: [WAProto/index.d.ts:10114](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10114)

* * *

### SMBI[​](#smbi "Direct link to SMBI")

> **SMBI**: `3`

Defined in: [WAProto/index.d.ts:10116](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10116)

* * *

### UWP[​](#uwp "Direct link to UWP")

> **UWP**: `5`

Defined in: [WAProto/index.d.ts:10118](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10118)

* * *

### WASG[​](#wasg "Direct link to WASG")

> **WASG**: `9`

Defined in: [WAProto/index.d.ts:10122](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10122)

* * *

### WEARM[​](#wearm "Direct link to WEARM")

> **WEARM**: `10`

Defined in: [WAProto/index.d.ts:10123](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10123)

* * *

### WEAROS[​](#wearos "Direct link to WEAROS")

> **WEAROS**: `8`

Defined in: [WAProto/index.d.ts:10121](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10121)

* * *

### WEB[​](#web "Direct link to WEB")

> **WEB**: `4`

Defined in: [WAProto/index.d.ts:10117](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10117)

---

<a name="paymentbackground"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/PaymentBackground/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/PaymentBackground/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Type](/docs/api/namespaces/proto/namespaces/PaymentBackground/enumerations/Type)

## Classes[​](#classes "Direct link to Classes")

*   [MediaData](/docs/api/namespaces/proto/namespaces/PaymentBackground/classes/MediaData)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IMediaData](/docs/api/namespaces/proto/namespaces/PaymentBackground/interfaces/IMediaData)

---

<a name="class-mediadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/PaymentBackground/classes/MediaData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/PaymentBackground/classes/MediaData)

Defined in: [WAProto/index.d.ts:10172](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10172)

## Implements[​](#implements "Direct link to Implements")

*   [`IMediaData`](/docs/api/namespaces/proto/namespaces/PaymentBackground/interfaces/IMediaData)

## Constructors[​](#constructors "Direct link to Constructors")

### new MediaData()[​](#new-mediadata "Direct link to new MediaData()")

> **new MediaData**(`p`?): [`MediaData`](/docs/api/namespaces/proto/namespaces/PaymentBackground/classes/MediaData)

Defined in: [WAProto/index.d.ts:10173](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10173)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMediaData`](/docs/api/namespaces/proto/namespaces/PaymentBackground/interfaces/IMediaData)

#### Returns[​](#returns "Direct link to Returns")

[`MediaData`](/docs/api/namespaces/proto/namespaces/PaymentBackground/classes/MediaData)

## Properties[​](#properties "Direct link to Properties")

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:10178](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10178)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMediaData`](/docs/api/namespaces/proto/namespaces/PaymentBackground/interfaces/IMediaData).[`directPath`](/docs/api/namespaces/proto/namespaces/PaymentBackground/interfaces/IMediaData#directpath)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10177](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10177)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMediaData`](/docs/api/namespaces/proto/namespaces/PaymentBackground/interfaces/IMediaData).[`fileEncSha256`](/docs/api/namespaces/proto/namespaces/PaymentBackground/interfaces/IMediaData#fileencsha256)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10176](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10176)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMediaData`](/docs/api/namespaces/proto/namespaces/PaymentBackground/interfaces/IMediaData).[`fileSha256`](/docs/api/namespaces/proto/namespaces/PaymentBackground/interfaces/IMediaData#filesha256)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10174](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10174)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IMediaData`](/docs/api/namespaces/proto/namespaces/PaymentBackground/interfaces/IMediaData).[`mediaKey`](/docs/api/namespaces/proto/namespaces/PaymentBackground/interfaces/IMediaData#mediakey)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10175](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10175)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IMediaData`](/docs/api/namespaces/proto/namespaces/PaymentBackground/interfaces/IMediaData).[`mediaKeyTimestamp`](/docs/api/namespaces/proto/namespaces/PaymentBackground/interfaces/IMediaData#mediakeytimestamp)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10184](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10184)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MediaData`](/docs/api/namespaces/proto/namespaces/PaymentBackground/classes/MediaData)

Defined in: [WAProto/index.d.ts:10179](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10179)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMediaData`](/docs/api/namespaces/proto/namespaces/PaymentBackground/interfaces/IMediaData)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MediaData`](/docs/api/namespaces/proto/namespaces/PaymentBackground/classes/MediaData)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MediaData`](/docs/api/namespaces/proto/namespaces/PaymentBackground/classes/MediaData)

Defined in: [WAProto/index.d.ts:10181](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10181)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MediaData`](/docs/api/namespaces/proto/namespaces/PaymentBackground/classes/MediaData)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10180](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10180)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMediaData`](/docs/api/namespaces/proto/namespaces/PaymentBackground/interfaces/IMediaData)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MediaData`](/docs/api/namespaces/proto/namespaces/PaymentBackground/classes/MediaData)

Defined in: [WAProto/index.d.ts:10182](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10182)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MediaData`](/docs/api/namespaces/proto/namespaces/PaymentBackground/classes/MediaData)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10185](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10185)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10183](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10183)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MediaData`](/docs/api/namespaces/proto/namespaces/PaymentBackground/classes/MediaData)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-type"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/PaymentBackground/enumerations/Type](https://baileys.wiki/docs/api/namespaces/proto/namespaces/PaymentBackground/enumerations/Type)

Defined in: [WAProto/index.d.ts:10188](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10188)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### DEFAULT[​](#default "Direct link to DEFAULT")

> **DEFAULT**: `1`

Defined in: [WAProto/index.d.ts:10190](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10190)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:10189](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10189)

---

<a name="interface-imediadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/PaymentBackground/interfaces/IMediaData](https://baileys.wiki/docs/api/namespaces/proto/namespaces/PaymentBackground/interfaces/IMediaData)

Defined in: [WAProto/index.d.ts:10164](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10164)

## Properties[​](#properties "Direct link to Properties")

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:10169](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10169)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10168](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10168)

* * *

### fileSha256?[​](#filesha256 "Direct link to fileSha256?")

> `optional` **fileSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10167](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10167)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10165](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10165)

* * *

### mediaKeyTimestamp?[​](#mediakeytimestamp "Direct link to mediaKeyTimestamp?")

> `optional` **mediaKeyTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:10166](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10166)

---

<a name="paymentinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/PaymentInfo/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/PaymentInfo/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Currency](/docs/api/namespaces/proto/namespaces/PaymentInfo/enumerations/Currency)
*   [Status](/docs/api/namespaces/proto/namespaces/PaymentInfo/enumerations/Status)
*   [TxnStatus](/docs/api/namespaces/proto/namespaces/PaymentInfo/enumerations/TxnStatus)

---

<a name="enumeration-currency"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/PaymentInfo/enumerations/Currency](https://baileys.wiki/docs/api/namespaces/proto/namespaces/PaymentInfo/enumerations/Currency)

Defined in: [WAProto/index.d.ts:10236](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10236)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### INR[​](#inr "Direct link to INR")

> **INR**: `1`

Defined in: [WAProto/index.d.ts:10238](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10238)

* * *

### UNKNOWN\_CURRENCY[​](#unknown_currency "Direct link to UNKNOWN_CURRENCY")

> **UNKNOWN\_CURRENCY**: `0`

Defined in: [WAProto/index.d.ts:10237](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10237)

---

<a name="enumeration-status"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/PaymentInfo/enumerations/Status](https://baileys.wiki/docs/api/namespaces/proto/namespaces/PaymentInfo/enumerations/Status)

Defined in: [WAProto/index.d.ts:10241](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10241)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### CANCELLED[​](#cancelled "Direct link to CANCELLED")

> **CANCELLED**: `9`

Defined in: [WAProto/index.d.ts:10251](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10251)

* * *

### COMPLETE[​](#complete "Direct link to COMPLETE")

> **COMPLETE**: `4`

Defined in: [WAProto/index.d.ts:10246](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10246)

* * *

### COULD\_NOT\_COMPLETE[​](#could_not_complete "Direct link to COULD_NOT_COMPLETE")

> **COULD\_NOT\_COMPLETE**: `5`

Defined in: [WAProto/index.d.ts:10247](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10247)

* * *

### EXPIRED[​](#expired "Direct link to EXPIRED")

> **EXPIRED**: `7`

Defined in: [WAProto/index.d.ts:10249](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10249)

* * *

### NEED\_TO\_ACCEPT[​](#need_to_accept "Direct link to NEED_TO_ACCEPT")

> **NEED\_TO\_ACCEPT**: `3`

Defined in: [WAProto/index.d.ts:10245](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10245)

* * *

### PROCESSING[​](#processing "Direct link to PROCESSING")

> **PROCESSING**: `1`

Defined in: [WAProto/index.d.ts:10243](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10243)

* * *

### REFUNDED[​](#refunded "Direct link to REFUNDED")

> **REFUNDED**: `6`

Defined in: [WAProto/index.d.ts:10248](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10248)

* * *

### REJECTED[​](#rejected "Direct link to REJECTED")

> **REJECTED**: `8`

Defined in: [WAProto/index.d.ts:10250](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10250)

* * *

### SENT[​](#sent "Direct link to SENT")

> **SENT**: `2`

Defined in: [WAProto/index.d.ts:10244](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10244)

* * *

### UNKNOWN\_STATUS[​](#unknown_status "Direct link to UNKNOWN_STATUS")

> **UNKNOWN\_STATUS**: `0`

Defined in: [WAProto/index.d.ts:10242](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10242)

* * *

### WAITING[​](#waiting "Direct link to WAITING")

> **WAITING**: `11`

Defined in: [WAProto/index.d.ts:10253](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10253)

* * *

### WAITING\_FOR\_PAYER[​](#waiting_for_payer "Direct link to WAITING_FOR_PAYER")

> **WAITING\_FOR\_PAYER**: `10`

Defined in: [WAProto/index.d.ts:10252](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10252)

---

<a name="enumeration-txnstatus"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/PaymentInfo/enumerations/TxnStatus](https://baileys.wiki/docs/api/namespaces/proto/namespaces/PaymentInfo/enumerations/TxnStatus)

Defined in: [WAProto/index.d.ts:10256](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10256)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AUTH\_CANCEL\_FAILED[​](#auth_cancel_failed "Direct link to AUTH_CANCEL_FAILED")

> **AUTH\_CANCEL\_FAILED**: `19`

Defined in: [WAProto/index.d.ts:10276](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10276)

* * *

### AUTH\_CANCEL\_FAILED\_PROCESSING[​](#auth_cancel_failed_processing "Direct link to AUTH_CANCEL_FAILED_PROCESSING")

> **AUTH\_CANCEL\_FAILED\_PROCESSING**: `18`

Defined in: [WAProto/index.d.ts:10275](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10275)

* * *

### AUTH\_CANCELED[​](#auth_canceled "Direct link to AUTH_CANCELED")

> **AUTH\_CANCELED**: `17`

Defined in: [WAProto/index.d.ts:10274](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10274)

* * *

### COLLECT\_CANCELED[​](#collect_canceled "Direct link to COLLECT_CANCELED")

> **COLLECT\_CANCELED**: `26`

Defined in: [WAProto/index.d.ts:10283](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10283)

* * *

### COLLECT\_CANCELLING[​](#collect_cancelling "Direct link to COLLECT_CANCELLING")

> **COLLECT\_CANCELLING**: `27`

Defined in: [WAProto/index.d.ts:10284](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10284)

* * *

### COLLECT\_EXPIRED[​](#collect_expired "Direct link to COLLECT_EXPIRED")

> **COLLECT\_EXPIRED**: `25`

Defined in: [WAProto/index.d.ts:10282](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10282)

* * *

### COLLECT\_FAILED[​](#collect_failed "Direct link to COLLECT_FAILED")

> **COLLECT\_FAILED**: `22`

Defined in: [WAProto/index.d.ts:10279](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10279)

* * *

### COLLECT\_FAILED\_RISK[​](#collect_failed_risk "Direct link to COLLECT_FAILED_RISK")

> **COLLECT\_FAILED\_RISK**: `23`

Defined in: [WAProto/index.d.ts:10280](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10280)

* * *

### COLLECT\_INIT[​](#collect_init "Direct link to COLLECT_INIT")

> **COLLECT\_INIT**: `20`

Defined in: [WAProto/index.d.ts:10277](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10277)

* * *

### COLLECT\_REJECTED[​](#collect_rejected "Direct link to COLLECT_REJECTED")

> **COLLECT\_REJECTED**: `24`

Defined in: [WAProto/index.d.ts:10281](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10281)

* * *

### COLLECT\_SUCCESS[​](#collect_success "Direct link to COLLECT_SUCCESS")

> **COLLECT\_SUCCESS**: `21`

Defined in: [WAProto/index.d.ts:10278](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10278)

* * *

### COMPLETED[​](#completed "Direct link to COMPLETED")

> **COMPLETED**: `5`

Defined in: [WAProto/index.d.ts:10262](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10262)

* * *

### EXPIRED\_TXN[​](#expired_txn "Direct link to EXPIRED_TXN")

> **EXPIRED\_TXN**: `16`

Defined in: [WAProto/index.d.ts:10273](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10273)

* * *

### FAILED[​](#failed "Direct link to FAILED")

> **FAILED**: `6`

Defined in: [WAProto/index.d.ts:10263](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10263)

* * *

### FAILED\_DA[​](#failed_da "Direct link to FAILED_DA")

> **FAILED\_DA**: `10`

Defined in: [WAProto/index.d.ts:10267](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10267)

* * *

### FAILED\_DA\_FINAL[​](#failed_da_final "Direct link to FAILED_DA_FINAL")

> **FAILED\_DA\_FINAL**: `11`

Defined in: [WAProto/index.d.ts:10268](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10268)

* * *

### FAILED\_PROCESSING[​](#failed_processing "Direct link to FAILED_PROCESSING")

> **FAILED\_PROCESSING**: `8`

Defined in: [WAProto/index.d.ts:10265](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10265)

* * *

### FAILED\_RECEIVER\_PROCESSING[​](#failed_receiver_processing "Direct link to FAILED_RECEIVER_PROCESSING")

> **FAILED\_RECEIVER\_PROCESSING**: `9`

Defined in: [WAProto/index.d.ts:10266](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10266)

* * *

### FAILED\_RISK[​](#failed_risk "Direct link to FAILED_RISK")

> **FAILED\_RISK**: `7`

Defined in: [WAProto/index.d.ts:10264](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10264)

* * *

### IN\_REVIEW[​](#in_review "Direct link to IN_REVIEW")

> **IN\_REVIEW**: `28`

Defined in: [WAProto/index.d.ts:10285](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10285)

* * *

### INIT[​](#init "Direct link to INIT")

> **INIT**: `3`

Defined in: [WAProto/index.d.ts:10260](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10260)

* * *

### PENDING\_RECEIVER\_SETUP[​](#pending_receiver_setup "Direct link to PENDING_RECEIVER_SETUP")

> **PENDING\_RECEIVER\_SETUP**: `2`

Defined in: [WAProto/index.d.ts:10259](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10259)

* * *

### PENDING\_SETUP[​](#pending_setup "Direct link to PENDING_SETUP")

> **PENDING\_SETUP**: `1`

Defined in: [WAProto/index.d.ts:10258](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10258)

* * *

### REFUND\_FAILED[​](#refund_failed "Direct link to REFUND_FAILED")

> **REFUND\_FAILED**: `13`

Defined in: [WAProto/index.d.ts:10270](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10270)

* * *

### REFUND\_FAILED\_DA[​](#refund_failed_da "Direct link to REFUND_FAILED_DA")

> **REFUND\_FAILED\_DA**: `15`

Defined in: [WAProto/index.d.ts:10272](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10272)

* * *

### REFUND\_FAILED\_PROCESSING[​](#refund_failed_processing "Direct link to REFUND_FAILED_PROCESSING")

> **REFUND\_FAILED\_PROCESSING**: `14`

Defined in: [WAProto/index.d.ts:10271](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10271)

* * *

### REFUND\_PENDING[​](#refund_pending "Direct link to REFUND_PENDING")

> **REFUND\_PENDING**: `31`

Defined in: [WAProto/index.d.ts:10288](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10288)

* * *

### REFUNDED\_TXN[​](#refunded_txn "Direct link to REFUNDED_TXN")

> **REFUNDED\_TXN**: `12`

Defined in: [WAProto/index.d.ts:10269](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10269)

* * *

### REVERSAL\_PENDING[​](#reversal_pending "Direct link to REVERSAL_PENDING")

> **REVERSAL\_PENDING**: `30`

Defined in: [WAProto/index.d.ts:10287](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10287)

* * *

### REVERSAL\_SUCCESS[​](#reversal_success "Direct link to REVERSAL_SUCCESS")

> **REVERSAL\_SUCCESS**: `29`

Defined in: [WAProto/index.d.ts:10286](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10286)

* * *

### SUCCESS[​](#success "Direct link to SUCCESS")

> **SUCCESS**: `4`

Defined in: [WAProto/index.d.ts:10261](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10261)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:10257](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10257)

---

<a name="pininchat"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/PinInChat/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/PinInChat/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Type](/docs/api/namespaces/proto/namespaces/PinInChat/enumerations/Type)

---

<a name="enumeration-type"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/PinInChat/enumerations/Type](https://baileys.wiki/docs/api/namespaces/proto/namespaces/PinInChat/enumerations/Type)

Defined in: [WAProto/index.d.ts:10356](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10356)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### PIN\_FOR\_ALL[​](#pin_for_all "Direct link to PIN_FOR_ALL")

> **PIN\_FOR\_ALL**: `1`

Defined in: [WAProto/index.d.ts:10358](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10358)

* * *

### UNKNOWN\_TYPE[​](#unknown_type "Direct link to UNKNOWN_TYPE")

> **UNKNOWN\_TYPE**: `0`

Defined in: [WAProto/index.d.ts:10357](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10357)

* * *

### UNPIN\_FOR\_ALL[​](#unpin_for_all "Direct link to UNPIN_FOR_ALL")

> **UNPIN\_FOR\_ALL**: `2`

Defined in: [WAProto/index.d.ts:10359](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10359)

---

<a name="processedvideo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ProcessedVideo/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ProcessedVideo/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [VideoQuality](/docs/api/namespaces/proto/namespaces/ProcessedVideo/enumerations/VideoQuality)

---

<a name="enumeration-videoquality"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ProcessedVideo/enumerations/VideoQuality](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ProcessedVideo/enumerations/VideoQuality)

Defined in: [WAProto/index.d.ts:10561](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10561)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### HIGH[​](#high "Direct link to HIGH")

> **HIGH**: `3`

Defined in: [WAProto/index.d.ts:10565](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10565)

* * *

### LOW[​](#low "Direct link to LOW")

> **LOW**: `1`

Defined in: [WAProto/index.d.ts:10563](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10563)

* * *

### MID[​](#mid "Direct link to MID")

> **MID**: `2`

Defined in: [WAProto/index.d.ts:10564](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10564)

* * *

### UNDEFINED[​](#undefined "Direct link to UNDEFINED")

> **UNDEFINED**: `0`

Defined in: [WAProto/index.d.ts:10562](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10562)

---

<a name="senderkeystatestructure"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/)

## Classes[​](#classes "Direct link to Classes")

*   [SenderChainKey](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderChainKey)
*   [SenderMessageKey](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderMessageKey)
*   [SenderSigningKey](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderSigningKey)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [ISenderChainKey](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderChainKey)
*   [ISenderMessageKey](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderMessageKey)
*   [ISenderSigningKey](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderSigningKey)

---

<a name="class-senderchainkey"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderChainKey](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderChainKey)

Defined in: [WAProto/index.d.ts:10808](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10808)

## Implements[​](#implements "Direct link to Implements")

*   [`ISenderChainKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderChainKey)

## Constructors[​](#constructors "Direct link to Constructors")

### new SenderChainKey()[​](#new-senderchainkey "Direct link to new SenderChainKey()")

> **new SenderChainKey**(`p`?): [`SenderChainKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderChainKey)

Defined in: [WAProto/index.d.ts:10809](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10809)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISenderChainKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderChainKey)

#### Returns[​](#returns "Direct link to Returns")

[`SenderChainKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderChainKey)

## Properties[​](#properties "Direct link to Properties")

### iteration?[​](#iteration "Direct link to iteration?")

> `optional` **iteration**: `null` | `number`

Defined in: [WAProto/index.d.ts:10810](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10810)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISenderChainKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderChainKey).[`iteration`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderChainKey#iteration)

* * *

### seed?[​](#seed "Direct link to seed?")

> `optional` **seed**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10811](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10811)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISenderChainKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderChainKey).[`seed`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderChainKey#seed)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10817](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10817)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SenderChainKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderChainKey)

Defined in: [WAProto/index.d.ts:10812](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10812)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISenderChainKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderChainKey)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SenderChainKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderChainKey)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SenderChainKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderChainKey)

Defined in: [WAProto/index.d.ts:10814](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10814)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SenderChainKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderChainKey)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10813](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10813)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISenderChainKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderChainKey)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SenderChainKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderChainKey)

Defined in: [WAProto/index.d.ts:10815](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10815)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SenderChainKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderChainKey)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10818](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10818)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10816](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10816)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SenderChainKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderChainKey)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-sendermessagekey"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderMessageKey](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderMessageKey)

Defined in: [WAProto/index.d.ts:10826](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10826)

## Implements[​](#implements "Direct link to Implements")

*   [`ISenderMessageKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderMessageKey)

## Constructors[​](#constructors "Direct link to Constructors")

### new SenderMessageKey()[​](#new-sendermessagekey "Direct link to new SenderMessageKey()")

> **new SenderMessageKey**(`p`?): [`SenderMessageKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderMessageKey)

Defined in: [WAProto/index.d.ts:10827](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10827)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISenderMessageKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderMessageKey)

#### Returns[​](#returns "Direct link to Returns")

[`SenderMessageKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderMessageKey)

## Properties[​](#properties "Direct link to Properties")

### iteration?[​](#iteration "Direct link to iteration?")

> `optional` **iteration**: `null` | `number`

Defined in: [WAProto/index.d.ts:10828](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10828)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISenderMessageKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderMessageKey).[`iteration`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderMessageKey#iteration)

* * *

### seed?[​](#seed "Direct link to seed?")

> `optional` **seed**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10829](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10829)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISenderMessageKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderMessageKey).[`seed`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderMessageKey#seed)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10835](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10835)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SenderMessageKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderMessageKey)

Defined in: [WAProto/index.d.ts:10830](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10830)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISenderMessageKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderMessageKey)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SenderMessageKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderMessageKey)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SenderMessageKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderMessageKey)

Defined in: [WAProto/index.d.ts:10832](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10832)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SenderMessageKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderMessageKey)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10831](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10831)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISenderMessageKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderMessageKey)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SenderMessageKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderMessageKey)

Defined in: [WAProto/index.d.ts:10833](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10833)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SenderMessageKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderMessageKey)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10836](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10836)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10834](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10834)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SenderMessageKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderMessageKey)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-sendersigningkey"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderSigningKey](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderSigningKey)

Defined in: [WAProto/index.d.ts:10844](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10844)

## Implements[​](#implements "Direct link to Implements")

*   [`ISenderSigningKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderSigningKey)

## Constructors[​](#constructors "Direct link to Constructors")

### new SenderSigningKey()[​](#new-sendersigningkey "Direct link to new SenderSigningKey()")

> **new SenderSigningKey**(`p`?): [`SenderSigningKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderSigningKey)

Defined in: [WAProto/index.d.ts:10845](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10845)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISenderSigningKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderSigningKey)

#### Returns[​](#returns "Direct link to Returns")

[`SenderSigningKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderSigningKey)

## Properties[​](#properties "Direct link to Properties")

### private?[​](#private "Direct link to private?")

> `optional` **private**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10847](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10847)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISenderSigningKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderSigningKey).[`private`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderSigningKey#private)

* * *

### public?[​](#public "Direct link to public?")

> `optional` **public**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10846](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10846)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISenderSigningKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderSigningKey).[`public`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderSigningKey#public)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10853](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10853)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SenderSigningKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderSigningKey)

Defined in: [WAProto/index.d.ts:10848](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10848)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISenderSigningKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderSigningKey)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SenderSigningKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderSigningKey)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SenderSigningKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderSigningKey)

Defined in: [WAProto/index.d.ts:10850](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10850)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SenderSigningKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderSigningKey)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10849](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10849)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISenderSigningKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderSigningKey)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SenderSigningKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderSigningKey)

Defined in: [WAProto/index.d.ts:10851](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10851)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SenderSigningKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderSigningKey)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10854](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10854)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10852](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10852)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SenderSigningKey`](/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/classes/SenderSigningKey)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-isenderchainkey"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderChainKey](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderChainKey)

Defined in: [WAProto/index.d.ts:10803](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10803)

## Properties[​](#properties "Direct link to Properties")

### iteration?[​](#iteration "Direct link to iteration?")

> `optional` **iteration**: `null` | `number`

Defined in: [WAProto/index.d.ts:10804](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10804)

* * *

### seed?[​](#seed "Direct link to seed?")

> `optional` **seed**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10805](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10805)

---

<a name="interface-isendermessagekey"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderMessageKey](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderMessageKey)

Defined in: [WAProto/index.d.ts:10821](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10821)

## Properties[​](#properties "Direct link to Properties")

### iteration?[​](#iteration "Direct link to iteration?")

> `optional` **iteration**: `null` | `number`

Defined in: [WAProto/index.d.ts:10822](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10822)

* * *

### seed?[​](#seed "Direct link to seed?")

> `optional` **seed**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10823](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10823)

---

<a name="interface-isendersigningkey"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderSigningKey](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SenderKeyStateStructure/interfaces/ISenderSigningKey)

Defined in: [WAProto/index.d.ts:10839](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10839)

## Properties[​](#properties "Direct link to Properties")

### private?[​](#private "Direct link to private?")

> `optional` **private**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10841](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10841)

* * *

### public?[​](#public "Direct link to public?")

> `optional` **public**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10840](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10840)

---

<a name="sessionstructure"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [Chain](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/)

## Classes[​](#classes "Direct link to Classes")

*   [Chain](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/Chain)
*   [PendingKeyExchange](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingKeyExchange)
*   [PendingPreKey](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingPreKey)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IChain](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IChain)
*   [IPendingKeyExchange](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange)
*   [IPendingPreKey](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingPreKey)

---

<a name="class-chain"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/classes/Chain](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/classes/Chain)

Defined in: [WAProto/index.d.ts:10923](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10923)

## Implements[​](#implements "Direct link to Implements")

*   [`IChain`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IChain)

## Constructors[​](#constructors "Direct link to Constructors")

### new Chain()[​](#new-chain "Direct link to new Chain()")

> **new Chain**(`p`?): [`Chain`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/Chain)

Defined in: [WAProto/index.d.ts:10924](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10924)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IChain`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IChain)

#### Returns[​](#returns "Direct link to Returns")

[`Chain`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/Chain)

## Properties[​](#properties "Direct link to Properties")

### chainKey?[​](#chainkey "Direct link to chainKey?")

> `optional` **chainKey**: `null` | [`IChainKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IChainKey)

Defined in: [WAProto/index.d.ts:10927](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10927)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IChain`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IChain).[`chainKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IChain#chainkey)

* * *

### messageKeys[​](#messagekeys "Direct link to messageKeys")

> **messageKeys**: [`IMessageKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IMessageKey)\[\]

Defined in: [WAProto/index.d.ts:10928](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10928)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IChain`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IChain).[`messageKeys`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IChain#messagekeys)

* * *

### senderRatchetKey?[​](#senderratchetkey "Direct link to senderRatchetKey?")

> `optional` **senderRatchetKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10925](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10925)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IChain`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IChain).[`senderRatchetKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IChain#senderratchetkey)

* * *

### senderRatchetKeyPrivate?[​](#senderratchetkeyprivate "Direct link to senderRatchetKeyPrivate?")

> `optional` **senderRatchetKeyPrivate**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10926](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10926)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IChain`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IChain).[`senderRatchetKeyPrivate`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IChain#senderratchetkeyprivate)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10934](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10934)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Chain`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/Chain)

Defined in: [WAProto/index.d.ts:10929](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10929)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IChain`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IChain)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Chain`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/Chain)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Chain`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/Chain)

Defined in: [WAProto/index.d.ts:10931](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10931)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Chain`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/Chain)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10930](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10930)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IChain`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IChain)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Chain`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/Chain)

Defined in: [WAProto/index.d.ts:10932](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10932)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Chain`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/Chain)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10935](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10935)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10933](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10933)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Chain`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/Chain)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pendingkeyexchange"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingKeyExchange](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingKeyExchange)

Defined in: [WAProto/index.d.ts:10991](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10991)

## Implements[​](#implements "Direct link to Implements")

*   [`IPendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange)

## Constructors[​](#constructors "Direct link to Constructors")

### new PendingKeyExchange()[​](#new-pendingkeyexchange "Direct link to new PendingKeyExchange()")

> **new PendingKeyExchange**(`p`?): [`PendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingKeyExchange)

Defined in: [WAProto/index.d.ts:10992](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10992)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange)

#### Returns[​](#returns "Direct link to Returns")

[`PendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingKeyExchange)

## Properties[​](#properties "Direct link to Properties")

### localBaseKey?[​](#localbasekey "Direct link to localBaseKey?")

> `optional` **localBaseKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10994](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10994)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange).[`localBaseKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange#localbasekey)

* * *

### localBaseKeyPrivate?[​](#localbasekeyprivate "Direct link to localBaseKeyPrivate?")

> `optional` **localBaseKeyPrivate**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10995](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10995)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange).[`localBaseKeyPrivate`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange#localbasekeyprivate)

* * *

### localIdentityKey?[​](#localidentitykey "Direct link to localIdentityKey?")

> `optional` **localIdentityKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10998](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10998)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange).[`localIdentityKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange#localidentitykey)

* * *

### localIdentityKeyPrivate?[​](#localidentitykeyprivate "Direct link to localIdentityKeyPrivate?")

> `optional` **localIdentityKeyPrivate**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10999](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10999)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IPendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange).[`localIdentityKeyPrivate`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange#localidentitykeyprivate)

* * *

### localRatchetKey?[​](#localratchetkey "Direct link to localRatchetKey?")

> `optional` **localRatchetKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10996](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10996)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IPendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange).[`localRatchetKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange#localratchetkey)

* * *

### localRatchetKeyPrivate?[​](#localratchetkeyprivate "Direct link to localRatchetKeyPrivate?")

> `optional` **localRatchetKeyPrivate**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10997](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10997)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IPendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange).[`localRatchetKeyPrivate`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange#localratchetkeyprivate)

* * *

### sequence?[​](#sequence "Direct link to sequence?")

> `optional` **sequence**: `null` | `number`

Defined in: [WAProto/index.d.ts:10993](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10993)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IPendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange).[`sequence`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange#sequence)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11005](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11005)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingKeyExchange)

Defined in: [WAProto/index.d.ts:11000](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11000)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingKeyExchange)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingKeyExchange)

Defined in: [WAProto/index.d.ts:11002](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11002)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingKeyExchange)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11001](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11001)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingKeyExchange)

Defined in: [WAProto/index.d.ts:11003](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11003)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingKeyExchange)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11006](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11006)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11004](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11004)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PendingKeyExchange`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingKeyExchange)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pendingprekey"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingPreKey](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingPreKey)

Defined in: [WAProto/index.d.ts:11015](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11015)

## Implements[​](#implements "Direct link to Implements")

*   [`IPendingPreKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingPreKey)

## Constructors[​](#constructors "Direct link to Constructors")

### new PendingPreKey()[​](#new-pendingprekey "Direct link to new PendingPreKey()")

> **new PendingPreKey**(`p`?): [`PendingPreKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingPreKey)

Defined in: [WAProto/index.d.ts:11016](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11016)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPendingPreKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingPreKey)

#### Returns[​](#returns "Direct link to Returns")

[`PendingPreKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingPreKey)

## Properties[​](#properties "Direct link to Properties")

### baseKey?[​](#basekey "Direct link to baseKey?")

> `optional` **baseKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11019](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11019)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPendingPreKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingPreKey).[`baseKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingPreKey#basekey)

* * *

### preKeyId?[​](#prekeyid "Direct link to preKeyId?")

> `optional` **preKeyId**: `null` | `number`

Defined in: [WAProto/index.d.ts:11017](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11017)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPendingPreKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingPreKey).[`preKeyId`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingPreKey#prekeyid)

* * *

### signedPreKeyId?[​](#signedprekeyid "Direct link to signedPreKeyId?")

> `optional` **signedPreKeyId**: `null` | `number`

Defined in: [WAProto/index.d.ts:11018](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11018)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IPendingPreKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingPreKey).[`signedPreKeyId`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingPreKey#signedprekeyid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11025](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11025)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PendingPreKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingPreKey)

Defined in: [WAProto/index.d.ts:11020](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11020)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPendingPreKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingPreKey)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PendingPreKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingPreKey)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PendingPreKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingPreKey)

Defined in: [WAProto/index.d.ts:11022](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11022)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PendingPreKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingPreKey)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11021](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11021)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPendingPreKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingPreKey)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PendingPreKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingPreKey)

Defined in: [WAProto/index.d.ts:11023](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11023)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PendingPreKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingPreKey)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11026](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11026)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11024](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11024)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PendingPreKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/classes/PendingPreKey)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ichain"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IChain](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IChain)

Defined in: [WAProto/index.d.ts:10916](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10916)

## Properties[​](#properties "Direct link to Properties")

### chainKey?[​](#chainkey "Direct link to chainKey?")

> `optional` **chainKey**: `null` | [`IChainKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IChainKey)

Defined in: [WAProto/index.d.ts:10919](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10919)

* * *

### messageKeys?[​](#messagekeys "Direct link to messageKeys?")

> `optional` **messageKeys**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IMessageKey)\[\]

Defined in: [WAProto/index.d.ts:10920](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10920)

* * *

### senderRatchetKey?[​](#senderratchetkey "Direct link to senderRatchetKey?")

> `optional` **senderRatchetKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10917](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10917)

* * *

### senderRatchetKeyPrivate?[​](#senderratchetkeyprivate "Direct link to senderRatchetKeyPrivate?")

> `optional` **senderRatchetKeyPrivate**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10918](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10918)

---

<a name="interface-ipendingkeyexchange"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingKeyExchange)

Defined in: [WAProto/index.d.ts:10981](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10981)

## Properties[​](#properties "Direct link to Properties")

### localBaseKey?[​](#localbasekey "Direct link to localBaseKey?")

> `optional` **localBaseKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10983](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10983)

* * *

### localBaseKeyPrivate?[​](#localbasekeyprivate "Direct link to localBaseKeyPrivate?")

> `optional` **localBaseKeyPrivate**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10984](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10984)

* * *

### localIdentityKey?[​](#localidentitykey "Direct link to localIdentityKey?")

> `optional` **localIdentityKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10987](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10987)

* * *

### localIdentityKeyPrivate?[​](#localidentitykeyprivate "Direct link to localIdentityKeyPrivate?")

> `optional` **localIdentityKeyPrivate**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10988](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10988)

* * *

### localRatchetKey?[​](#localratchetkey "Direct link to localRatchetKey?")

> `optional` **localRatchetKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10985](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10985)

* * *

### localRatchetKeyPrivate?[​](#localratchetkeyprivate "Direct link to localRatchetKeyPrivate?")

> `optional` **localRatchetKeyPrivate**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10986](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10986)

* * *

### sequence?[​](#sequence "Direct link to sequence?")

> `optional` **sequence**: `null` | `number`

Defined in: [WAProto/index.d.ts:10982](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10982)

---

<a name="interface-ipendingprekey"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingPreKey](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/interfaces/IPendingPreKey)

Defined in: [WAProto/index.d.ts:11009](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11009)

## Properties[​](#properties "Direct link to Properties")

### baseKey?[​](#basekey "Direct link to baseKey?")

> `optional` **baseKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:11012](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11012)

* * *

### preKeyId?[​](#prekeyid "Direct link to preKeyId?")

> `optional` **preKeyId**: `null` | `number`

Defined in: [WAProto/index.d.ts:11010](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11010)

* * *

### signedPreKeyId?[​](#signedprekeyid "Direct link to signedPreKeyId?")

> `optional` **signedPreKeyId**: `null` | `number`

Defined in: [WAProto/index.d.ts:11011](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11011)

---

<a name="chain"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/)

## Classes[​](#classes "Direct link to Classes")

*   [ChainKey](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/ChainKey)
*   [MessageKey](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/MessageKey)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IChainKey](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IChainKey)
*   [IMessageKey](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IMessageKey)

---

<a name="class-chainkey"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/ChainKey](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/ChainKey)

Defined in: [WAProto/index.d.ts:10945](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10945)

## Implements[​](#implements "Direct link to Implements")

*   [`IChainKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IChainKey)

## Constructors[​](#constructors "Direct link to Constructors")

### new ChainKey()[​](#new-chainkey "Direct link to new ChainKey()")

> **new ChainKey**(`p`?): [`ChainKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/ChainKey)

Defined in: [WAProto/index.d.ts:10946](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10946)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IChainKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IChainKey)

#### Returns[​](#returns "Direct link to Returns")

[`ChainKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/ChainKey)

## Properties[​](#properties "Direct link to Properties")

### index?[​](#index "Direct link to index?")

> `optional` **index**: `null` | `number`

Defined in: [WAProto/index.d.ts:10947](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10947)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IChainKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IChainKey).[`index`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IChainKey#index)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10948](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10948)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IChainKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IChainKey).[`key`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IChainKey#key)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10954](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10954)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ChainKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/ChainKey)

Defined in: [WAProto/index.d.ts:10949](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10949)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IChainKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IChainKey)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ChainKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/ChainKey)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ChainKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/ChainKey)

Defined in: [WAProto/index.d.ts:10951](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10951)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ChainKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/ChainKey)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10950](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10950)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IChainKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IChainKey)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ChainKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/ChainKey)

Defined in: [WAProto/index.d.ts:10952](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10952)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ChainKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/ChainKey)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10955](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10955)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10953](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10953)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ChainKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/ChainKey)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-messagekey"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/MessageKey](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/MessageKey)

Defined in: [WAProto/index.d.ts:10965](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10965)

## Implements[​](#implements "Direct link to Implements")

*   [`IMessageKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IMessageKey)

## Constructors[​](#constructors "Direct link to Constructors")

### new MessageKey()[​](#new-messagekey "Direct link to new MessageKey()")

> **new MessageKey**(`p`?): [`MessageKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/MessageKey)

Defined in: [WAProto/index.d.ts:10966](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10966)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMessageKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IMessageKey)

#### Returns[​](#returns "Direct link to Returns")

[`MessageKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/MessageKey)

## Properties[​](#properties "Direct link to Properties")

### cipherKey?[​](#cipherkey "Direct link to cipherKey?")

> `optional` **cipherKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10968](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10968)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMessageKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IMessageKey).[`cipherKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IMessageKey#cipherkey)

* * *

### index?[​](#index "Direct link to index?")

> `optional` **index**: `null` | `number`

Defined in: [WAProto/index.d.ts:10967](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10967)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMessageKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IMessageKey).[`index`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IMessageKey#index)

* * *

### iv?[​](#iv "Direct link to iv?")

> `optional` **iv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10970](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10970)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMessageKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IMessageKey).[`iv`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IMessageKey#iv)

* * *

### macKey?[​](#mackey "Direct link to macKey?")

> `optional` **macKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10969](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10969)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IMessageKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IMessageKey).[`macKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IMessageKey#mackey)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:10976](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10976)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MessageKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/MessageKey)

Defined in: [WAProto/index.d.ts:10971](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10971)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMessageKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IMessageKey)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MessageKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/MessageKey)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MessageKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/MessageKey)

Defined in: [WAProto/index.d.ts:10973](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10973)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MessageKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/MessageKey)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:10972](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10972)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMessageKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IMessageKey)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MessageKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/MessageKey)

Defined in: [WAProto/index.d.ts:10974](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10974)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MessageKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/MessageKey)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:10977](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10977)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:10975](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10975)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MessageKey`](/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/classes/MessageKey)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ichainkey"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IChainKey](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IChainKey)

Defined in: [WAProto/index.d.ts:10940](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10940)

## Properties[​](#properties "Direct link to Properties")

### index?[​](#index "Direct link to index?")

> `optional` **index**: `null` | `number`

Defined in: [WAProto/index.d.ts:10941](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10941)

* * *

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10942](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10942)

---

<a name="interface-imessagekey"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IMessageKey](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SessionStructure/namespaces/Chain/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:10958](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10958)

## Properties[​](#properties "Direct link to Properties")

### cipherKey?[​](#cipherkey "Direct link to cipherKey?")

> `optional` **cipherKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10960](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10960)

* * *

### index?[​](#index "Direct link to index?")

> `optional` **index**: `null` | `number`

Defined in: [WAProto/index.d.ts:10959](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10959)

* * *

### iv?[​](#iv "Direct link to iv?")

> `optional` **iv**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10962](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10962)

* * *

### macKey?[​](#mackey "Direct link to macKey?")

> `optional` **macKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:10961](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L10961)

---

<a name="statusattribution"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [AiCreatedAttribution](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/AiCreatedAttribution/)
*   [ExternalShare](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/ExternalShare/)
*   [RLAttribution](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/RLAttribution/)
*   [StatusReshare](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Type](/docs/api/namespaces/proto/namespaces/StatusAttribution/enumerations/Type)

## Classes[​](#classes "Direct link to Classes")

*   [AiCreatedAttribution](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/AiCreatedAttribution)
*   [ExternalShare](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/ExternalShare)
*   [GroupStatus](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/GroupStatus)
*   [Music](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/Music)
*   [RLAttribution](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/RLAttribution)
*   [StatusReshare](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/StatusReshare)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IAiCreatedAttribution](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IAiCreatedAttribution)
*   [IExternalShare](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IExternalShare)
*   [IGroupStatus](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IGroupStatus)
*   [IMusic](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic)
*   [IRLAttribution](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IRLAttribution)
*   [IStatusReshare](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IStatusReshare)

---

<a name="class-aicreatedattribution"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/AiCreatedAttribution](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/AiCreatedAttribution)

Defined in: [WAProto/index.d.ts:11138](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11138)

## Implements[​](#implements "Direct link to Implements")

*   [`IAiCreatedAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IAiCreatedAttribution)

## Constructors[​](#constructors "Direct link to Constructors")

### new AiCreatedAttribution()[​](#new-aicreatedattribution "Direct link to new AiCreatedAttribution()")

> **new AiCreatedAttribution**(`p`?): [`AiCreatedAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/AiCreatedAttribution)

Defined in: [WAProto/index.d.ts:11139](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11139)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAiCreatedAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IAiCreatedAttribution)

#### Returns[​](#returns "Direct link to Returns")

[`AiCreatedAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/AiCreatedAttribution)

## Properties[​](#properties "Direct link to Properties")

### source?[​](#source "Direct link to source?")

> `optional` **source**: `null` | [`Source`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/AiCreatedAttribution/enumerations/Source)

Defined in: [WAProto/index.d.ts:11140](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11140)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAiCreatedAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IAiCreatedAttribution).[`source`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IAiCreatedAttribution#source)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11146](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11146)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AiCreatedAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/AiCreatedAttribution)

Defined in: [WAProto/index.d.ts:11141](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11141)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAiCreatedAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IAiCreatedAttribution)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AiCreatedAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/AiCreatedAttribution)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AiCreatedAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/AiCreatedAttribution)

Defined in: [WAProto/index.d.ts:11143](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11143)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AiCreatedAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/AiCreatedAttribution)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11142](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11142)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAiCreatedAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IAiCreatedAttribution)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AiCreatedAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/AiCreatedAttribution)

Defined in: [WAProto/index.d.ts:11144](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11144)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AiCreatedAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/AiCreatedAttribution)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11147](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11147)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11145](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11145)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AiCreatedAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/AiCreatedAttribution)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-externalshare"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/ExternalShare](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/ExternalShare)

Defined in: [WAProto/index.d.ts:11165](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11165)

## Implements[​](#implements "Direct link to Implements")

*   [`IExternalShare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IExternalShare)

## Constructors[​](#constructors "Direct link to Constructors")

### new ExternalShare()[​](#new-externalshare "Direct link to new ExternalShare()")

> **new ExternalShare**(`p`?): [`ExternalShare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/ExternalShare)

Defined in: [WAProto/index.d.ts:11166](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11166)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IExternalShare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IExternalShare)

#### Returns[​](#returns "Direct link to Returns")

[`ExternalShare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/ExternalShare)

## Properties[​](#properties "Direct link to Properties")

### actionFallbackUrl?[​](#actionfallbackurl "Direct link to actionFallbackUrl?")

> `optional` **actionFallbackUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:11170](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11170)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IExternalShare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IExternalShare).[`actionFallbackUrl`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IExternalShare#actionfallbackurl)

* * *

### actionUrl?[​](#actionurl "Direct link to actionUrl?")

> `optional` **actionUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:11167](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11167)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IExternalShare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IExternalShare).[`actionUrl`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IExternalShare#actionurl)

* * *

### duration?[​](#duration "Direct link to duration?")

> `optional` **duration**: `null` | `number`

Defined in: [WAProto/index.d.ts:11169](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11169)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IExternalShare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IExternalShare).[`duration`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IExternalShare#duration)

* * *

### source?[​](#source "Direct link to source?")

> `optional` **source**: `null` | [`Source`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/ExternalShare/enumerations/Source)

Defined in: [WAProto/index.d.ts:11168](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11168)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IExternalShare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IExternalShare).[`source`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IExternalShare#source)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11176](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11176)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ExternalShare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/ExternalShare)

Defined in: [WAProto/index.d.ts:11171](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11171)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IExternalShare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IExternalShare)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ExternalShare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/ExternalShare)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ExternalShare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/ExternalShare)

Defined in: [WAProto/index.d.ts:11173](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11173)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ExternalShare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/ExternalShare)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11172](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11172)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IExternalShare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IExternalShare)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ExternalShare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/ExternalShare)

Defined in: [WAProto/index.d.ts:11174](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11174)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ExternalShare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/ExternalShare)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11177](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11177)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11175](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11175)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ExternalShare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/ExternalShare)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-groupstatus"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/GroupStatus](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/GroupStatus)

Defined in: [WAProto/index.d.ts:11201](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11201)

## Implements[​](#implements "Direct link to Implements")

*   [`IGroupStatus`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IGroupStatus)

## Constructors[​](#constructors "Direct link to Constructors")

### new GroupStatus()[​](#new-groupstatus "Direct link to new GroupStatus()")

> **new GroupStatus**(`p`?): [`GroupStatus`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/GroupStatus)

Defined in: [WAProto/index.d.ts:11202](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11202)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IGroupStatus`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IGroupStatus)

#### Returns[​](#returns "Direct link to Returns")

[`GroupStatus`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/GroupStatus)

## Properties[​](#properties "Direct link to Properties")

### authorJid?[​](#authorjid "Direct link to authorJid?")

> `optional` **authorJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:11203](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11203)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IGroupStatus`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IGroupStatus).[`authorJid`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IGroupStatus#authorjid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11209](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11209)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`GroupStatus`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/GroupStatus)

Defined in: [WAProto/index.d.ts:11204](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11204)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IGroupStatus`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IGroupStatus)

#### Returns[​](#returns-2 "Direct link to Returns")

[`GroupStatus`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/GroupStatus)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`GroupStatus`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/GroupStatus)

Defined in: [WAProto/index.d.ts:11206](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11206)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`GroupStatus`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/GroupStatus)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11205](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11205)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IGroupStatus`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IGroupStatus)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`GroupStatus`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/GroupStatus)

Defined in: [WAProto/index.d.ts:11207](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11207)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`GroupStatus`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/GroupStatus)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11210](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11210)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11208](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11208)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`GroupStatus`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/GroupStatus)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-music"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/Music](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/Music)

Defined in: [WAProto/index.d.ts:11222](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11222)

## Implements[​](#implements "Direct link to Implements")

*   [`IMusic`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic)

## Constructors[​](#constructors "Direct link to Constructors")

### new Music()[​](#new-music "Direct link to new Music()")

> **new Music**(`p`?): [`Music`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/Music)

Defined in: [WAProto/index.d.ts:11223](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11223)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMusic`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic)

#### Returns[​](#returns "Direct link to Returns")

[`Music`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/Music)

## Properties[​](#properties "Direct link to Properties")

### artistAttribution?[​](#artistattribution "Direct link to artistAttribution?")

> `optional` **artistAttribution**: `null` | `string`

Defined in: [WAProto/index.d.ts:11228](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11228)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMusic`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic).[`artistAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic#artistattribution)

* * *

### author?[​](#author "Direct link to author?")

> `optional` **author**: `null` | `string`

Defined in: [WAProto/index.d.ts:11227](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11227)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMusic`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic).[`author`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic#author)

* * *

### authorName?[​](#authorname "Direct link to authorName?")

> `optional` **authorName**: `null` | `string`

Defined in: [WAProto/index.d.ts:11224](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11224)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMusic`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic).[`authorName`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic#authorname)

* * *

### isExplicit?[​](#isexplicit "Direct link to isExplicit?")

> `optional` **isExplicit**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11229](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11229)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IMusic`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic).[`isExplicit`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic#isexplicit)

* * *

### songId?[​](#songid "Direct link to songId?")

> `optional` **songId**: `null` | `string`

Defined in: [WAProto/index.d.ts:11225](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11225)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IMusic`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic).[`songId`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic#songid)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:11226](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11226)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IMusic`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic).[`title`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic#title)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11235](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11235)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Music`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/Music)

Defined in: [WAProto/index.d.ts:11230](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11230)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMusic`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Music`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/Music)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Music`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/Music)

Defined in: [WAProto/index.d.ts:11232](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11232)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Music`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/Music)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11231](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11231)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMusic`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Music`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/Music)

Defined in: [WAProto/index.d.ts:11233](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11233)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Music`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/Music)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11236](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11236)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11234](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11234)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Music`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/Music)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-rlattribution"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/RLAttribution](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/RLAttribution)

Defined in: [WAProto/index.d.ts:11243](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11243)

## Implements[​](#implements "Direct link to Implements")

*   [`IRLAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IRLAttribution)

## Constructors[​](#constructors "Direct link to Constructors")

### new RLAttribution()[​](#new-rlattribution "Direct link to new RLAttribution()")

> **new RLAttribution**(`p`?): [`RLAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/RLAttribution)

Defined in: [WAProto/index.d.ts:11244](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11244)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IRLAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IRLAttribution)

#### Returns[​](#returns "Direct link to Returns")

[`RLAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/RLAttribution)

## Properties[​](#properties "Direct link to Properties")

### source?[​](#source "Direct link to source?")

> `optional` **source**: `null` | [`Source`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/RLAttribution/enumerations/Source)

Defined in: [WAProto/index.d.ts:11245](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11245)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IRLAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IRLAttribution).[`source`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IRLAttribution#source)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11251](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11251)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`RLAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/RLAttribution)

Defined in: [WAProto/index.d.ts:11246](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11246)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IRLAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IRLAttribution)

#### Returns[​](#returns-2 "Direct link to Returns")

[`RLAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/RLAttribution)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`RLAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/RLAttribution)

Defined in: [WAProto/index.d.ts:11248](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11248)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`RLAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/RLAttribution)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11247](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11247)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IRLAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IRLAttribution)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`RLAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/RLAttribution)

Defined in: [WAProto/index.d.ts:11249](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11249)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`RLAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/RLAttribution)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11252](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11252)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11250](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11250)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`RLAttribution`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/RLAttribution)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-statusreshare"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/StatusReshare](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/StatusReshare)

Defined in: [WAProto/index.d.ts:11270](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11270)

## Implements[​](#implements "Direct link to Implements")

*   [`IStatusReshare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IStatusReshare)

## Constructors[​](#constructors "Direct link to Constructors")

### new StatusReshare()[​](#new-statusreshare "Direct link to new StatusReshare()")

> **new StatusReshare**(`p`?): [`StatusReshare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/StatusReshare)

Defined in: [WAProto/index.d.ts:11271](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11271)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IStatusReshare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IStatusReshare)

#### Returns[​](#returns "Direct link to Returns")

[`StatusReshare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/StatusReshare)

## Properties[​](#properties "Direct link to Properties")

### metadata?[​](#metadata "Direct link to metadata?")

> `optional` **metadata**: `null` | [`IMetadata`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/interfaces/IMetadata)

Defined in: [WAProto/index.d.ts:11273](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11273)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IStatusReshare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IStatusReshare).[`metadata`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IStatusReshare#metadata)

* * *

### source?[​](#source "Direct link to source?")

> `optional` **source**: `null` | [`Source`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/enumerations/Source)

Defined in: [WAProto/index.d.ts:11272](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11272)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IStatusReshare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IStatusReshare).[`source`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IStatusReshare#source)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11279](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11279)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`StatusReshare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/StatusReshare)

Defined in: [WAProto/index.d.ts:11274](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11274)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IStatusReshare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IStatusReshare)

#### Returns[​](#returns-2 "Direct link to Returns")

[`StatusReshare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/StatusReshare)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`StatusReshare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/StatusReshare)

Defined in: [WAProto/index.d.ts:11276](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11276)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`StatusReshare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/StatusReshare)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11275](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11275)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IStatusReshare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IStatusReshare)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`StatusReshare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/StatusReshare)

Defined in: [WAProto/index.d.ts:11277](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11277)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`StatusReshare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/StatusReshare)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11280](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11280)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11278](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11278)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`StatusReshare`](/docs/api/namespaces/proto/namespaces/StatusAttribution/classes/StatusReshare)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-type"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/enumerations/Type](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/enumerations/Type)

Defined in: [WAProto/index.d.ts:11316](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11316)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AI\_CREATED[​](#ai_created "Direct link to AI_CREATED")

> **AI\_CREATED**: `7`

Defined in: [WAProto/index.d.ts:11324](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11324)

* * *

### EXTERNAL\_SHARE[​](#external_share "Direct link to EXTERNAL_SHARE")

> **EXTERNAL\_SHARE**: `2`

Defined in: [WAProto/index.d.ts:11319](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11319)

* * *

### GROUP\_STATUS[​](#group_status "Direct link to GROUP_STATUS")

> **GROUP\_STATUS**: `5`

Defined in: [WAProto/index.d.ts:11322](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11322)

* * *

### LAYOUTS[​](#layouts "Direct link to LAYOUTS")

> **LAYOUTS**: `8`

Defined in: [WAProto/index.d.ts:11325](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11325)

* * *

### MUSIC[​](#music "Direct link to MUSIC")

> **MUSIC**: `3`

Defined in: [WAProto/index.d.ts:11320](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11320)

* * *

### RESHARE[​](#reshare "Direct link to RESHARE")

> **RESHARE**: `1`

Defined in: [WAProto/index.d.ts:11318](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11318)

* * *

### RL\_ATTRIBUTION[​](#rl_attribution "Direct link to RL_ATTRIBUTION")

> **RL\_ATTRIBUTION**: `6`

Defined in: [WAProto/index.d.ts:11323](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11323)

* * *

### STATUS\_MENTION[​](#status_mention "Direct link to STATUS_MENTION")

> **STATUS\_MENTION**: `4`

Defined in: [WAProto/index.d.ts:11321](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11321)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:11317](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11317)

---

<a name="interface-iaicreatedattribution"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IAiCreatedAttribution](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IAiCreatedAttribution)

Defined in: [WAProto/index.d.ts:11134](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11134)

## Properties[​](#properties "Direct link to Properties")

### source?[​](#source "Direct link to source?")

> `optional` **source**: `null` | [`Source`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/AiCreatedAttribution/enumerations/Source)

Defined in: [WAProto/index.d.ts:11135](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11135)

---

<a name="interface-iexternalshare"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IExternalShare](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IExternalShare)

Defined in: [WAProto/index.d.ts:11158](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11158)

## Properties[​](#properties "Direct link to Properties")

### actionFallbackUrl?[​](#actionfallbackurl "Direct link to actionFallbackUrl?")

> `optional` **actionFallbackUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:11162](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11162)

* * *

### actionUrl?[​](#actionurl "Direct link to actionUrl?")

> `optional` **actionUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:11159](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11159)

* * *

### duration?[​](#duration "Direct link to duration?")

> `optional` **duration**: `null` | `number`

Defined in: [WAProto/index.d.ts:11161](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11161)

* * *

### source?[​](#source "Direct link to source?")

> `optional` **source**: `null` | [`Source`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/ExternalShare/enumerations/Source)

Defined in: [WAProto/index.d.ts:11160](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11160)

---

<a name="interface-igroupstatus"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IGroupStatus](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IGroupStatus)

Defined in: [WAProto/index.d.ts:11197](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11197)

## Properties[​](#properties "Direct link to Properties")

### authorJid?[​](#authorjid "Direct link to authorJid?")

> `optional` **authorJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:11198](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11198)

---

<a name="interface-imusic"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IMusic)

Defined in: [WAProto/index.d.ts:11213](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11213)

## Properties[​](#properties "Direct link to Properties")

### artistAttribution?[​](#artistattribution "Direct link to artistAttribution?")

> `optional` **artistAttribution**: `null` | `string`

Defined in: [WAProto/index.d.ts:11218](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11218)

* * *

### author?[​](#author "Direct link to author?")

> `optional` **author**: `null` | `string`

Defined in: [WAProto/index.d.ts:11217](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11217)

* * *

### authorName?[​](#authorname "Direct link to authorName?")

> `optional` **authorName**: `null` | `string`

Defined in: [WAProto/index.d.ts:11214](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11214)

* * *

### isExplicit?[​](#isexplicit "Direct link to isExplicit?")

> `optional` **isExplicit**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11219](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11219)

* * *

### songId?[​](#songid "Direct link to songId?")

> `optional` **songId**: `null` | `string`

Defined in: [WAProto/index.d.ts:11215](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11215)

* * *

### title?[​](#title "Direct link to title?")

> `optional` **title**: `null` | `string`

Defined in: [WAProto/index.d.ts:11216](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11216)

---

<a name="interface-irlattribution"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IRLAttribution](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IRLAttribution)

Defined in: [WAProto/index.d.ts:11239](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11239)

## Properties[​](#properties "Direct link to Properties")

### source?[​](#source "Direct link to source?")

> `optional` **source**: `null` | [`Source`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/RLAttribution/enumerations/Source)

Defined in: [WAProto/index.d.ts:11240](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11240)

---

<a name="interface-istatusreshare"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IStatusReshare](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/interfaces/IStatusReshare)

Defined in: [WAProto/index.d.ts:11265](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11265)

## Properties[​](#properties "Direct link to Properties")

### metadata?[​](#metadata "Direct link to metadata?")

> `optional` **metadata**: `null` | [`IMetadata`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/interfaces/IMetadata)

Defined in: [WAProto/index.d.ts:11267](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11267)

* * *

### source?[​](#source "Direct link to source?")

> `optional` **source**: `null` | [`Source`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/enumerations/Source)

Defined in: [WAProto/index.d.ts:11266](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11266)

---

<a name="aicreatedattribution"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/AiCreatedAttribution/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/AiCreatedAttribution/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Source](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/AiCreatedAttribution/enumerations/Source)

---

<a name="enumeration-source"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/AiCreatedAttribution/enumerations/Source](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/AiCreatedAttribution/enumerations/Source)

Defined in: [WAProto/index.d.ts:11152](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11152)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### STATUS\_MIMICRY[​](#status_mimicry "Direct link to STATUS_MIMICRY")

> **STATUS\_MIMICRY**: `1`

Defined in: [WAProto/index.d.ts:11154](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11154)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:11153](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11153)

---

<a name="externalshare"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/ExternalShare/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/ExternalShare/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Source](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/ExternalShare/enumerations/Source)

---

<a name="enumeration-source"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/ExternalShare/enumerations/Source](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/ExternalShare/enumerations/Source)

Defined in: [WAProto/index.d.ts:11182](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11182)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### APPLE\_MUSIC[​](#apple_music "Direct link to APPLE_MUSIC")

> **APPLE\_MUSIC**: `8`

Defined in: [WAProto/index.d.ts:11191](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11191)

* * *

### FACEBOOK[​](#facebook "Direct link to FACEBOOK")

> **FACEBOOK**: `2`

Defined in: [WAProto/index.d.ts:11185](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11185)

* * *

### GOOGLE\_PHOTOS[​](#google_photos "Direct link to GOOGLE_PHOTOS")

> **GOOGLE\_PHOTOS**: `10`

Defined in: [WAProto/index.d.ts:11193](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11193)

* * *

### INSTAGRAM[​](#instagram "Direct link to INSTAGRAM")

> **INSTAGRAM**: `1`

Defined in: [WAProto/index.d.ts:11184](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11184)

* * *

### MESSENGER[​](#messenger "Direct link to MESSENGER")

> **MESSENGER**: `3`

Defined in: [WAProto/index.d.ts:11186](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11186)

* * *

### PINTEREST[​](#pinterest "Direct link to PINTEREST")

> **PINTEREST**: `6`

Defined in: [WAProto/index.d.ts:11189](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11189)

* * *

### SHARECHAT[​](#sharechat "Direct link to SHARECHAT")

> **SHARECHAT**: `9`

Defined in: [WAProto/index.d.ts:11192](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11192)

* * *

### SPOTIFY[​](#spotify "Direct link to SPOTIFY")

> **SPOTIFY**: `4`

Defined in: [WAProto/index.d.ts:11187](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11187)

* * *

### THREADS[​](#threads "Direct link to THREADS")

> **THREADS**: `7`

Defined in: [WAProto/index.d.ts:11190](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11190)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:11183](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11183)

* * *

### YOUTUBE[​](#youtube "Direct link to YOUTUBE")

> **YOUTUBE**: `5`

Defined in: [WAProto/index.d.ts:11188](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11188)

---

<a name="rlattribution"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/RLAttribution/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/RLAttribution/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Source](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/RLAttribution/enumerations/Source)

---

<a name="enumeration-source"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/RLAttribution/enumerations/Source](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/RLAttribution/enumerations/Source)

Defined in: [WAProto/index.d.ts:11257](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11257)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### HYPERNOVA\_GLASSES[​](#hypernova_glasses "Direct link to HYPERNOVA_GLASSES")

> **HYPERNOVA\_GLASSES**: `3`

Defined in: [WAProto/index.d.ts:11261](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11261)

* * *

### OAKLEY\_META\_GLASSES[​](#oakley_meta_glasses "Direct link to OAKLEY_META_GLASSES")

> **OAKLEY\_META\_GLASSES**: `2`

Defined in: [WAProto/index.d.ts:11260](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11260)

* * *

### RAY\_BAN\_META\_GLASSES[​](#ray_ban_meta_glasses "Direct link to RAY_BAN_META_GLASSES")

> **RAY\_BAN\_META\_GLASSES**: `1`

Defined in: [WAProto/index.d.ts:11259](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11259)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:11258](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11258)

---

<a name="statusreshare"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Source](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/enumerations/Source)

## Classes[​](#classes "Direct link to Classes")

*   [Metadata](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/classes/Metadata)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IMetadata](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/interfaces/IMetadata)

---

<a name="class-metadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/classes/Metadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/classes/Metadata)

Defined in: [WAProto/index.d.ts:11292](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11292)

## Implements[​](#implements "Direct link to Implements")

*   [`IMetadata`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/interfaces/IMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new Metadata()[​](#new-metadata "Direct link to new Metadata()")

> **new Metadata**(`p`?): [`Metadata`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/classes/Metadata)

Defined in: [WAProto/index.d.ts:11293](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11293)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMetadata`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/interfaces/IMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`Metadata`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/classes/Metadata)

## Properties[​](#properties "Direct link to Properties")

### channelJid?[​](#channeljid "Direct link to channelJid?")

> `optional` **channelJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:11295](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11295)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMetadata`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/interfaces/IMetadata).[`channelJid`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/interfaces/IMetadata#channeljid)

* * *

### channelMessageId?[​](#channelmessageid "Direct link to channelMessageId?")

> `optional` **channelMessageId**: `null` | `number`

Defined in: [WAProto/index.d.ts:11296](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11296)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMetadata`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/interfaces/IMetadata).[`channelMessageId`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/interfaces/IMetadata#channelmessageid)

* * *

### duration?[​](#duration "Direct link to duration?")

> `optional` **duration**: `null` | `number`

Defined in: [WAProto/index.d.ts:11294](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11294)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMetadata`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/interfaces/IMetadata).[`duration`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/interfaces/IMetadata#duration)

* * *

### hasMultipleReshares?[​](#hasmultiplereshares "Direct link to hasMultipleReshares?")

> `optional` **hasMultipleReshares**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11297](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11297)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IMetadata`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/interfaces/IMetadata).[`hasMultipleReshares`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/interfaces/IMetadata#hasmultiplereshares)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11303](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11303)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Metadata`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/classes/Metadata)

Defined in: [WAProto/index.d.ts:11298](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11298)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMetadata`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/interfaces/IMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Metadata`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/classes/Metadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Metadata`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/classes/Metadata)

Defined in: [WAProto/index.d.ts:11300](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11300)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Metadata`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/classes/Metadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11299](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11299)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMetadata`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/interfaces/IMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Metadata`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/classes/Metadata)

Defined in: [WAProto/index.d.ts:11301](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11301)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Metadata`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/classes/Metadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11304](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11304)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11302](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11302)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Metadata`](/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/classes/Metadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-source"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/enumerations/Source](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/enumerations/Source)

Defined in: [WAProto/index.d.ts:11307](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11307)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### CHANNEL\_RESHARE[​](#channel_reshare "Direct link to CHANNEL_RESHARE")

> **CHANNEL\_RESHARE**: `3`

Defined in: [WAProto/index.d.ts:11311](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11311)

* * *

### FORWARD[​](#forward "Direct link to FORWARD")

> **FORWARD**: `4`

Defined in: [WAProto/index.d.ts:11312](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11312)

* * *

### INTERNAL\_RESHARE[​](#internal_reshare "Direct link to INTERNAL_RESHARE")

> **INTERNAL\_RESHARE**: `1`

Defined in: [WAProto/index.d.ts:11309](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11309)

* * *

### MENTION\_RESHARE[​](#mention_reshare "Direct link to MENTION_RESHARE")

> **MENTION\_RESHARE**: `2`

Defined in: [WAProto/index.d.ts:11310](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11310)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:11308](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11308)

---

<a name="interface-imetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/interfaces/IMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/StatusAttribution/namespaces/StatusReshare/interfaces/IMetadata)

Defined in: [WAProto/index.d.ts:11285](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11285)

## Properties[​](#properties "Direct link to Properties")

### channelJid?[​](#channeljid "Direct link to channelJid?")

> `optional` **channelJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:11287](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11287)

* * *

### channelMessageId?[​](#channelmessageid "Direct link to channelMessageId?")

> `optional` **channelMessageId**: `null` | `number`

Defined in: [WAProto/index.d.ts:11288](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11288)

* * *

### duration?[​](#duration "Direct link to duration?")

> `optional` **duration**: `null` | `number`

Defined in: [WAProto/index.d.ts:11286](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11286)

* * *

### hasMultipleReshares?[​](#hasmultiplereshares "Direct link to hasMultipleReshares?")

> `optional` **hasMultipleReshares**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11289](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11289)

---

<a name="syncactionvalue"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [AvatarUpdatedAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/AvatarUpdatedAction/)
*   [FavoritesAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/)
*   [InteractiveMessageAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/InteractiveMessageAction/)
*   [LabelEditAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/LabelEditAction/)
*   [MaibaAIFeaturesControlAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MaibaAIFeaturesControlAction/)
*   [MarketingMessageAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MarketingMessageAction/)
*   [MerchantPaymentPartnerAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MerchantPaymentPartnerAction/)
*   [NoteEditAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/NoteEditAction/)
*   [NotificationActivitySettingAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/NotificationActivitySettingAction/)
*   [PaymentTosAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/PaymentTosAction/)
*   [PrivateProcessingSettingAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/PrivateProcessingSettingAction/)
*   [StatusPrivacyAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/StatusPrivacyAction/)
*   [UsernameChatStartModeAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/UsernameChatStartModeAction/)
*   [WaffleAccountLinkStateAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/WaffleAccountLinkStateAction/)

## Classes[​](#classes "Direct link to Classes")

*   [AgentAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AgentAction)
*   [AiThreadRenameAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AiThreadRenameAction)
*   [AndroidUnsupportedActions](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AndroidUnsupportedActions)
*   [ArchiveChatAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ArchiveChatAction)
*   [AvatarUpdatedAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AvatarUpdatedAction)
*   [BotWelcomeRequestAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BotWelcomeRequestAction)
*   [BroadcastListParticipant](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BroadcastListParticipant)
*   [BusinessBroadcastAssociationAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastAssociationAction)
*   [BusinessBroadcastListAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastListAction)
*   [CallLogAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CallLogAction)
*   [ChatAssignmentAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentAction)
*   [ChatAssignmentOpenedStatusAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentOpenedStatusAction)
*   [ClearChatAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ClearChatAction)
*   [ContactAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ContactAction)
*   [CtwaPerCustomerDataSharingAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CtwaPerCustomerDataSharingAction)
*   [CustomPaymentMethod](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethod)
*   [CustomPaymentMethodMetadata](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodMetadata)
*   [CustomPaymentMethodsAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodsAction)
*   [DeleteChatAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteChatAction)
*   [DeleteIndividualCallLogAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteIndividualCallLogAction)
*   [DeleteMessageForMeAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteMessageForMeAction)
*   [DetectedOutcomesStatusAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DetectedOutcomesStatusAction)
*   [ExternalWebBetaAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ExternalWebBetaAction)
*   [FavoritesAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/FavoritesAction)
*   [InteractiveMessageAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/InteractiveMessageAction)
*   [KeyExpiration](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/KeyExpiration)
*   [LabelAssociationAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelAssociationAction)
*   [LabelEditAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelEditAction)
*   [LabelReorderingAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelReorderingAction)
*   [LidContactAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LidContactAction)
*   [LocaleSetting](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LocaleSetting)
*   [LockChatAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LockChatAction)
*   [MaibaAIFeaturesControlAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MaibaAIFeaturesControlAction)
*   [MarkChatAsReadAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarkChatAsReadAction)
*   [MarketingMessageAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageAction)
*   [MarketingMessageBroadcastAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageBroadcastAction)
*   [MerchantPaymentPartnerAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MerchantPaymentPartnerAction)
*   [MusicUserIdAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MusicUserIdAction)
*   [MuteAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MuteAction)
*   [NewsletterSavedInterestsAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NewsletterSavedInterestsAction)
*   [NoteEditAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NoteEditAction)
*   [NotificationActivitySettingAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NotificationActivitySettingAction)
*   [NuxAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NuxAction)
*   [PaymentInfoAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentInfoAction)
*   [PaymentTosAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentTosAction)
*   [PinAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PinAction)
*   [PnForLidChatAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PnForLidChatAction)
*   [PrimaryFeature](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryFeature)
*   [PrimaryVersionAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryVersionAction)
*   [PrivacySettingChannelsPersonalisedRecommendationAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingChannelsPersonalisedRecommendationAction)
*   [PrivacySettingDisableLinkPreviewsAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingDisableLinkPreviewsAction)
*   [PrivacySettingRelayAllCalls](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingRelayAllCalls)
*   [PrivateProcessingSettingAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivateProcessingSettingAction)
*   [PushNameSetting](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PushNameSetting)
*   [QuickReplyAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/QuickReplyAction)
*   [RecentEmojiWeightsAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RecentEmojiWeightsAction)
*   [RemoveRecentStickerAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RemoveRecentStickerAction)
*   [StarAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StarAction)
*   [StatusPostOptInNotificationPreferencesAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPostOptInNotificationPreferencesAction)
*   [StatusPrivacyAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPrivacyAction)
*   [StickerAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StickerAction)
*   [SubscriptionAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SubscriptionAction)
*   [SyncActionMessage](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessage)
*   [SyncActionMessageRange](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessageRange)
*   [TimeFormatAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/TimeFormatAction)
*   [UGCBot](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UGCBot)
*   [UnarchiveChatsSetting](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UnarchiveChatsSetting)
*   [UsernameChatStartModeAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UsernameChatStartModeAction)
*   [UserStatusMuteAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UserStatusMuteAction)
*   [WaffleAccountLinkStateAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WaffleAccountLinkStateAction)
*   [WamoUserIdentifierAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WamoUserIdentifierAction)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IAgentAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAgentAction)
*   [IAiThreadRenameAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAiThreadRenameAction)
*   [IAndroidUnsupportedActions](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAndroidUnsupportedActions)
*   [IArchiveChatAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IArchiveChatAction)
*   [IAvatarUpdatedAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAvatarUpdatedAction)
*   [IBotWelcomeRequestAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBotWelcomeRequestAction)
*   [IBroadcastListParticipant](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBroadcastListParticipant)
*   [IBusinessBroadcastAssociationAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastAssociationAction)
*   [IBusinessBroadcastListAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastListAction)
*   [ICallLogAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICallLogAction)
*   [IChatAssignmentAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentAction)
*   [IChatAssignmentOpenedStatusAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentOpenedStatusAction)
*   [IClearChatAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IClearChatAction)
*   [IContactAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction)
*   [ICtwaPerCustomerDataSharingAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICtwaPerCustomerDataSharingAction)
*   [ICustomPaymentMethod](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethod)
*   [ICustomPaymentMethodMetadata](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodMetadata)
*   [ICustomPaymentMethodsAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodsAction)
*   [IDeleteChatAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteChatAction)
*   [IDeleteIndividualCallLogAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteIndividualCallLogAction)
*   [IDeleteMessageForMeAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteMessageForMeAction)
*   [IDetectedOutcomesStatusAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDetectedOutcomesStatusAction)
*   [IExternalWebBetaAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IExternalWebBetaAction)
*   [IFavoritesAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IFavoritesAction)
*   [IInteractiveMessageAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IInteractiveMessageAction)
*   [IKeyExpiration](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IKeyExpiration)
*   [ILabelAssociationAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelAssociationAction)
*   [ILabelEditAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction)
*   [ILabelReorderingAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelReorderingAction)
*   [ILidContactAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILidContactAction)
*   [ILocaleSetting](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILocaleSetting)
*   [ILockChatAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILockChatAction)
*   [IMaibaAIFeaturesControlAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMaibaAIFeaturesControlAction)
*   [IMarkChatAsReadAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarkChatAsReadAction)
*   [IMarketingMessageAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction)
*   [IMarketingMessageBroadcastAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageBroadcastAction)
*   [IMerchantPaymentPartnerAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMerchantPaymentPartnerAction)
*   [IMusicUserIdAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMusicUserIdAction)
*   [IMuteAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMuteAction)
*   [INewsletterSavedInterestsAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INewsletterSavedInterestsAction)
*   [INoteEditAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INoteEditAction)
*   [INotificationActivitySettingAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INotificationActivitySettingAction)
*   [INuxAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INuxAction)
*   [IPaymentInfoAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentInfoAction)
*   [IPaymentTosAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentTosAction)
*   [IPinAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPinAction)
*   [IPnForLidChatAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPnForLidChatAction)
*   [IPrimaryFeature](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryFeature)
*   [IPrimaryVersionAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryVersionAction)
*   [IPrivacySettingChannelsPersonalisedRecommendationAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingChannelsPersonalisedRecommendationAction)
*   [IPrivacySettingDisableLinkPreviewsAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingDisableLinkPreviewsAction)
*   [IPrivacySettingRelayAllCalls](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingRelayAllCalls)
*   [IPrivateProcessingSettingAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivateProcessingSettingAction)
*   [IPushNameSetting](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPushNameSetting)
*   [IQuickReplyAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IQuickReplyAction)
*   [IRecentEmojiWeightsAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRecentEmojiWeightsAction)
*   [IRemoveRecentStickerAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRemoveRecentStickerAction)
*   [IStarAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStarAction)
*   [IStatusPostOptInNotificationPreferencesAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPostOptInNotificationPreferencesAction)
*   [IStatusPrivacyAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPrivacyAction)
*   [IStickerAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction)
*   [ISubscriptionAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISubscriptionAction)
*   [ISyncActionMessage](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessage)
*   [ISyncActionMessageRange](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange)
*   [ITimeFormatAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ITimeFormatAction)
*   [IUGCBot](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUGCBot)
*   [IUnarchiveChatsSetting](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUnarchiveChatsSetting)
*   [IUsernameChatStartModeAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUsernameChatStartModeAction)
*   [IUserStatusMuteAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUserStatusMuteAction)
*   [IWaffleAccountLinkStateAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWaffleAccountLinkStateAction)
*   [IWamoUserIdentifierAction](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWamoUserIdentifierAction)

---

<a name="class-agentaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AgentAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AgentAction)

Defined in: [WAProto/index.d.ts:11587](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11587)

## Implements[​](#implements "Direct link to Implements")

*   [`IAgentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAgentAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new AgentAction()[​](#new-agentaction "Direct link to new AgentAction()")

> **new AgentAction**(`p`?): [`AgentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AgentAction)

Defined in: [WAProto/index.d.ts:11588](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11588)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAgentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAgentAction)

#### Returns[​](#returns "Direct link to Returns")

[`AgentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AgentAction)

## Properties[​](#properties "Direct link to Properties")

### deviceID?[​](#deviceid "Direct link to deviceID?")

> `optional` **deviceID**: `null` | `number`

Defined in: [WAProto/index.d.ts:11590](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11590)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAgentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAgentAction).[`deviceID`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAgentAction#deviceid)

* * *

### isDeleted?[​](#isdeleted "Direct link to isDeleted?")

> `optional` **isDeleted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11591](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11591)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAgentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAgentAction).[`isDeleted`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAgentAction#isdeleted)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:11589](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11589)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IAgentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAgentAction).[`name`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAgentAction#name)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11597](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11597)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AgentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AgentAction)

Defined in: [WAProto/index.d.ts:11592](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11592)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAgentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAgentAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AgentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AgentAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AgentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AgentAction)

Defined in: [WAProto/index.d.ts:11594](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11594)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AgentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AgentAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11593](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11593)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAgentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAgentAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AgentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AgentAction)

Defined in: [WAProto/index.d.ts:11595](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11595)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AgentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AgentAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11598](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11598)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11596](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11596)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AgentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AgentAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-aithreadrenameaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AiThreadRenameAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AiThreadRenameAction)

Defined in: [WAProto/index.d.ts:11605](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11605)

## Implements[​](#implements "Direct link to Implements")

*   [`IAiThreadRenameAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAiThreadRenameAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new AiThreadRenameAction()[​](#new-aithreadrenameaction "Direct link to new AiThreadRenameAction()")

> **new AiThreadRenameAction**(`p`?): [`AiThreadRenameAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AiThreadRenameAction)

Defined in: [WAProto/index.d.ts:11606](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11606)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAiThreadRenameAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAiThreadRenameAction)

#### Returns[​](#returns "Direct link to Returns")

[`AiThreadRenameAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AiThreadRenameAction)

## Properties[​](#properties "Direct link to Properties")

### newTitle?[​](#newtitle "Direct link to newTitle?")

> `optional` **newTitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:11607](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11607)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAiThreadRenameAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAiThreadRenameAction).[`newTitle`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAiThreadRenameAction#newtitle)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11613](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11613)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AiThreadRenameAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AiThreadRenameAction)

Defined in: [WAProto/index.d.ts:11608](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11608)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAiThreadRenameAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAiThreadRenameAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AiThreadRenameAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AiThreadRenameAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AiThreadRenameAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AiThreadRenameAction)

Defined in: [WAProto/index.d.ts:11610](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11610)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AiThreadRenameAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AiThreadRenameAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11609](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11609)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAiThreadRenameAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAiThreadRenameAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AiThreadRenameAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AiThreadRenameAction)

Defined in: [WAProto/index.d.ts:11611](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11611)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AiThreadRenameAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AiThreadRenameAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11614](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11614)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11612](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11612)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AiThreadRenameAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AiThreadRenameAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-androidunsupportedactions"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AndroidUnsupportedActions](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AndroidUnsupportedActions)

Defined in: [WAProto/index.d.ts:11621](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11621)

## Implements[​](#implements "Direct link to Implements")

*   [`IAndroidUnsupportedActions`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAndroidUnsupportedActions)

## Constructors[​](#constructors "Direct link to Constructors")

### new AndroidUnsupportedActions()[​](#new-androidunsupportedactions "Direct link to new AndroidUnsupportedActions()")

> **new AndroidUnsupportedActions**(`p`?): [`AndroidUnsupportedActions`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AndroidUnsupportedActions)

Defined in: [WAProto/index.d.ts:11622](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11622)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAndroidUnsupportedActions`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAndroidUnsupportedActions)

#### Returns[​](#returns "Direct link to Returns")

[`AndroidUnsupportedActions`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AndroidUnsupportedActions)

## Properties[​](#properties "Direct link to Properties")

### allowed?[​](#allowed "Direct link to allowed?")

> `optional` **allowed**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11623](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11623)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAndroidUnsupportedActions`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAndroidUnsupportedActions).[`allowed`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAndroidUnsupportedActions#allowed)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11629](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11629)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AndroidUnsupportedActions`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AndroidUnsupportedActions)

Defined in: [WAProto/index.d.ts:11624](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11624)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAndroidUnsupportedActions`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAndroidUnsupportedActions)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AndroidUnsupportedActions`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AndroidUnsupportedActions)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AndroidUnsupportedActions`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AndroidUnsupportedActions)

Defined in: [WAProto/index.d.ts:11626](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11626)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AndroidUnsupportedActions`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AndroidUnsupportedActions)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11625](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11625)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAndroidUnsupportedActions`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAndroidUnsupportedActions)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AndroidUnsupportedActions`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AndroidUnsupportedActions)

Defined in: [WAProto/index.d.ts:11627](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11627)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AndroidUnsupportedActions`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AndroidUnsupportedActions)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11630](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11630)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11628](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11628)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AndroidUnsupportedActions`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AndroidUnsupportedActions)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-archivechataction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ArchiveChatAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ArchiveChatAction)

Defined in: [WAProto/index.d.ts:11638](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11638)

## Implements[​](#implements "Direct link to Implements")

*   [`IArchiveChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IArchiveChatAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new ArchiveChatAction()[​](#new-archivechataction "Direct link to new ArchiveChatAction()")

> **new ArchiveChatAction**(`p`?): [`ArchiveChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ArchiveChatAction)

Defined in: [WAProto/index.d.ts:11639](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11639)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IArchiveChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IArchiveChatAction)

#### Returns[​](#returns "Direct link to Returns")

[`ArchiveChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ArchiveChatAction)

## Properties[​](#properties "Direct link to Properties")

### archived?[​](#archived "Direct link to archived?")

> `optional` **archived**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11640](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11640)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IArchiveChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IArchiveChatAction).[`archived`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IArchiveChatAction#archived)

* * *

### messageRange?[​](#messagerange "Direct link to messageRange?")

> `optional` **messageRange**: `null` | [`ISyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange)

Defined in: [WAProto/index.d.ts:11641](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11641)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IArchiveChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IArchiveChatAction).[`messageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IArchiveChatAction#messagerange)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11647](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11647)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ArchiveChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ArchiveChatAction)

Defined in: [WAProto/index.d.ts:11642](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11642)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IArchiveChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IArchiveChatAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ArchiveChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ArchiveChatAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ArchiveChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ArchiveChatAction)

Defined in: [WAProto/index.d.ts:11644](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11644)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ArchiveChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ArchiveChatAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11643](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11643)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IArchiveChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IArchiveChatAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ArchiveChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ArchiveChatAction)

Defined in: [WAProto/index.d.ts:11645](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11645)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ArchiveChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ArchiveChatAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11648](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11648)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11646](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11646)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ArchiveChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ArchiveChatAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-avatarupdatedaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AvatarUpdatedAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AvatarUpdatedAction)

Defined in: [WAProto/index.d.ts:11656](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11656)

## Implements[​](#implements "Direct link to Implements")

*   [`IAvatarUpdatedAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAvatarUpdatedAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new AvatarUpdatedAction()[​](#new-avatarupdatedaction "Direct link to new AvatarUpdatedAction()")

> **new AvatarUpdatedAction**(`p`?): [`AvatarUpdatedAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AvatarUpdatedAction)

Defined in: [WAProto/index.d.ts:11657](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11657)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IAvatarUpdatedAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAvatarUpdatedAction)

#### Returns[​](#returns "Direct link to Returns")

[`AvatarUpdatedAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AvatarUpdatedAction)

## Properties[​](#properties "Direct link to Properties")

### eventType?[​](#eventtype "Direct link to eventType?")

> `optional` **eventType**: `null` | [`AvatarEventType`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/AvatarUpdatedAction/enumerations/AvatarEventType)

Defined in: [WAProto/index.d.ts:11658](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11658)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IAvatarUpdatedAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAvatarUpdatedAction).[`eventType`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAvatarUpdatedAction#eventtype)

* * *

### recentAvatarStickers[​](#recentavatarstickers "Direct link to recentAvatarStickers")

> **recentAvatarStickers**: [`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction)\[\]

Defined in: [WAProto/index.d.ts:11659](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11659)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IAvatarUpdatedAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAvatarUpdatedAction).[`recentAvatarStickers`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAvatarUpdatedAction#recentavatarstickers)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11665](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11665)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`AvatarUpdatedAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AvatarUpdatedAction)

Defined in: [WAProto/index.d.ts:11660](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11660)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IAvatarUpdatedAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAvatarUpdatedAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`AvatarUpdatedAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AvatarUpdatedAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`AvatarUpdatedAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AvatarUpdatedAction)

Defined in: [WAProto/index.d.ts:11662](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11662)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`AvatarUpdatedAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AvatarUpdatedAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11661](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11661)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IAvatarUpdatedAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAvatarUpdatedAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`AvatarUpdatedAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AvatarUpdatedAction)

Defined in: [WAProto/index.d.ts:11663](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11663)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`AvatarUpdatedAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AvatarUpdatedAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11666](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11666)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11664](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11664)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`AvatarUpdatedAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/AvatarUpdatedAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-botwelcomerequestaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BotWelcomeRequestAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BotWelcomeRequestAction)

Defined in: [WAProto/index.d.ts:11682](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11682)

## Implements[​](#implements "Direct link to Implements")

*   [`IBotWelcomeRequestAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBotWelcomeRequestAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new BotWelcomeRequestAction()[​](#new-botwelcomerequestaction "Direct link to new BotWelcomeRequestAction()")

> **new BotWelcomeRequestAction**(`p`?): [`BotWelcomeRequestAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BotWelcomeRequestAction)

Defined in: [WAProto/index.d.ts:11683](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11683)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBotWelcomeRequestAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBotWelcomeRequestAction)

#### Returns[​](#returns "Direct link to Returns")

[`BotWelcomeRequestAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BotWelcomeRequestAction)

## Properties[​](#properties "Direct link to Properties")

### isSent?[​](#issent "Direct link to isSent?")

> `optional` **isSent**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11684](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11684)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBotWelcomeRequestAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBotWelcomeRequestAction).[`isSent`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBotWelcomeRequestAction#issent)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11690](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11690)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BotWelcomeRequestAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BotWelcomeRequestAction)

Defined in: [WAProto/index.d.ts:11685](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11685)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBotWelcomeRequestAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBotWelcomeRequestAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BotWelcomeRequestAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BotWelcomeRequestAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BotWelcomeRequestAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BotWelcomeRequestAction)

Defined in: [WAProto/index.d.ts:11687](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11687)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BotWelcomeRequestAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BotWelcomeRequestAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11686](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11686)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBotWelcomeRequestAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBotWelcomeRequestAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BotWelcomeRequestAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BotWelcomeRequestAction)

Defined in: [WAProto/index.d.ts:11688](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11688)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BotWelcomeRequestAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BotWelcomeRequestAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11691](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11691)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11689](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11689)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BotWelcomeRequestAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BotWelcomeRequestAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-broadcastlistparticipant"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BroadcastListParticipant](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BroadcastListParticipant)

Defined in: [WAProto/index.d.ts:11699](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11699)

## Implements[​](#implements "Direct link to Implements")

*   [`IBroadcastListParticipant`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBroadcastListParticipant)

## Constructors[​](#constructors "Direct link to Constructors")

### new BroadcastListParticipant()[​](#new-broadcastlistparticipant "Direct link to new BroadcastListParticipant()")

> **new BroadcastListParticipant**(`p`?): [`BroadcastListParticipant`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BroadcastListParticipant)

Defined in: [WAProto/index.d.ts:11700](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11700)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBroadcastListParticipant`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBroadcastListParticipant)

#### Returns[​](#returns "Direct link to Returns")

[`BroadcastListParticipant`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BroadcastListParticipant)

## Properties[​](#properties "Direct link to Properties")

### lidJid[​](#lidjid "Direct link to lidJid")

> **lidJid**: `string`

Defined in: [WAProto/index.d.ts:11701](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11701)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBroadcastListParticipant`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBroadcastListParticipant).[`lidJid`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBroadcastListParticipant#lidjid)

* * *

### pnJid?[​](#pnjid "Direct link to pnJid?")

> `optional` **pnJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:11702](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11702)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBroadcastListParticipant`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBroadcastListParticipant).[`pnJid`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBroadcastListParticipant#pnjid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11708](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11708)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BroadcastListParticipant`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BroadcastListParticipant)

Defined in: [WAProto/index.d.ts:11703](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11703)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBroadcastListParticipant`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBroadcastListParticipant)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BroadcastListParticipant`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BroadcastListParticipant)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BroadcastListParticipant`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BroadcastListParticipant)

Defined in: [WAProto/index.d.ts:11705](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11705)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BroadcastListParticipant`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BroadcastListParticipant)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11704](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11704)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBroadcastListParticipant`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBroadcastListParticipant)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BroadcastListParticipant`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BroadcastListParticipant)

Defined in: [WAProto/index.d.ts:11706](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11706)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BroadcastListParticipant`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BroadcastListParticipant)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11709](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11709)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11707](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11707)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BroadcastListParticipant`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BroadcastListParticipant)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-businessbroadcastassociationaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastAssociationAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastAssociationAction)

Defined in: [WAProto/index.d.ts:11716](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11716)

## Implements[​](#implements "Direct link to Implements")

*   [`IBusinessBroadcastAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastAssociationAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new BusinessBroadcastAssociationAction()[​](#new-businessbroadcastassociationaction "Direct link to new BusinessBroadcastAssociationAction()")

> **new BusinessBroadcastAssociationAction**(`p`?): [`BusinessBroadcastAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastAssociationAction)

Defined in: [WAProto/index.d.ts:11717](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11717)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBusinessBroadcastAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastAssociationAction)

#### Returns[​](#returns "Direct link to Returns")

[`BusinessBroadcastAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastAssociationAction)

## Properties[​](#properties "Direct link to Properties")

### deleted?[​](#deleted "Direct link to deleted?")

> `optional` **deleted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11718](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11718)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBusinessBroadcastAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastAssociationAction).[`deleted`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastAssociationAction#deleted)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11724](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11724)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BusinessBroadcastAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastAssociationAction)

Defined in: [WAProto/index.d.ts:11719](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11719)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBusinessBroadcastAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastAssociationAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BusinessBroadcastAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastAssociationAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BusinessBroadcastAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastAssociationAction)

Defined in: [WAProto/index.d.ts:11721](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11721)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BusinessBroadcastAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastAssociationAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11720](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11720)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBusinessBroadcastAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastAssociationAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BusinessBroadcastAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastAssociationAction)

Defined in: [WAProto/index.d.ts:11722](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11722)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BusinessBroadcastAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastAssociationAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11725](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11725)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11723](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11723)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BusinessBroadcastAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastAssociationAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-businessbroadcastlistaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastListAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastListAction)

Defined in: [WAProto/index.d.ts:11734](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11734)

## Implements[​](#implements "Direct link to Implements")

*   [`IBusinessBroadcastListAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastListAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new BusinessBroadcastListAction()[​](#new-businessbroadcastlistaction "Direct link to new BusinessBroadcastListAction()")

> **new BusinessBroadcastListAction**(`p`?): [`BusinessBroadcastListAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastListAction)

Defined in: [WAProto/index.d.ts:11735](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11735)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IBusinessBroadcastListAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastListAction)

#### Returns[​](#returns "Direct link to Returns")

[`BusinessBroadcastListAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastListAction)

## Properties[​](#properties "Direct link to Properties")

### deleted?[​](#deleted "Direct link to deleted?")

> `optional` **deleted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11736](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11736)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IBusinessBroadcastListAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastListAction).[`deleted`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastListAction#deleted)

* * *

### listName?[​](#listname "Direct link to listName?")

> `optional` **listName**: `null` | `string`

Defined in: [WAProto/index.d.ts:11738](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11738)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IBusinessBroadcastListAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastListAction).[`listName`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastListAction#listname)

* * *

### participants[​](#participants "Direct link to participants")

> **participants**: [`IBroadcastListParticipant`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBroadcastListParticipant)\[\]

Defined in: [WAProto/index.d.ts:11737](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11737)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IBusinessBroadcastListAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastListAction).[`participants`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastListAction#participants)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11744](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11744)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`BusinessBroadcastListAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastListAction)

Defined in: [WAProto/index.d.ts:11739](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11739)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IBusinessBroadcastListAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastListAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`BusinessBroadcastListAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastListAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`BusinessBroadcastListAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastListAction)

Defined in: [WAProto/index.d.ts:11741](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11741)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`BusinessBroadcastListAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastListAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11740](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11740)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IBusinessBroadcastListAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastListAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`BusinessBroadcastListAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastListAction)

Defined in: [WAProto/index.d.ts:11742](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11742)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`BusinessBroadcastListAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastListAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11745](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11745)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11743](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11743)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`BusinessBroadcastListAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/BusinessBroadcastListAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-calllogaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CallLogAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CallLogAction)

Defined in: [WAProto/index.d.ts:11752](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11752)

## Implements[​](#implements "Direct link to Implements")

*   [`ICallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICallLogAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new CallLogAction()[​](#new-calllogaction "Direct link to new CallLogAction()")

> **new CallLogAction**(`p`?): [`CallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CallLogAction)

Defined in: [WAProto/index.d.ts:11753](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11753)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICallLogAction)

#### Returns[​](#returns "Direct link to Returns")

[`CallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CallLogAction)

## Properties[​](#properties "Direct link to Properties")

### callLogRecord?[​](#calllogrecord "Direct link to callLogRecord?")

> `optional` **callLogRecord**: `null` | [`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord)

Defined in: [WAProto/index.d.ts:11754](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11754)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICallLogAction).[`callLogRecord`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICallLogAction#calllogrecord)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11760](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11760)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CallLogAction)

Defined in: [WAProto/index.d.ts:11755](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11755)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICallLogAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CallLogAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CallLogAction)

Defined in: [WAProto/index.d.ts:11757](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11757)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CallLogAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11756](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11756)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICallLogAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CallLogAction)

Defined in: [WAProto/index.d.ts:11758](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11758)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CallLogAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11761](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11761)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11759](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11759)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CallLogAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-chatassignmentaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentAction)

Defined in: [WAProto/index.d.ts:11768](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11768)

## Implements[​](#implements "Direct link to Implements")

*   [`IChatAssignmentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new ChatAssignmentAction()[​](#new-chatassignmentaction "Direct link to new ChatAssignmentAction()")

> **new ChatAssignmentAction**(`p`?): [`ChatAssignmentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentAction)

Defined in: [WAProto/index.d.ts:11769](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11769)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IChatAssignmentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentAction)

#### Returns[​](#returns "Direct link to Returns")

[`ChatAssignmentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentAction)

## Properties[​](#properties "Direct link to Properties")

### deviceAgentID?[​](#deviceagentid "Direct link to deviceAgentID?")

> `optional` **deviceAgentID**: `null` | `string`

Defined in: [WAProto/index.d.ts:11770](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11770)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IChatAssignmentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentAction).[`deviceAgentID`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentAction#deviceagentid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11776](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11776)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ChatAssignmentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentAction)

Defined in: [WAProto/index.d.ts:11771](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11771)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IChatAssignmentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ChatAssignmentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ChatAssignmentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentAction)

Defined in: [WAProto/index.d.ts:11773](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11773)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ChatAssignmentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11772](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11772)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IChatAssignmentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ChatAssignmentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentAction)

Defined in: [WAProto/index.d.ts:11774](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11774)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ChatAssignmentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11777](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11777)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11775](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11775)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ChatAssignmentAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-chatassignmentopenedstatusaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentOpenedStatusAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentOpenedStatusAction)

Defined in: [WAProto/index.d.ts:11784](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11784)

## Implements[​](#implements "Direct link to Implements")

*   [`IChatAssignmentOpenedStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentOpenedStatusAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new ChatAssignmentOpenedStatusAction()[​](#new-chatassignmentopenedstatusaction "Direct link to new ChatAssignmentOpenedStatusAction()")

> **new ChatAssignmentOpenedStatusAction**(`p`?): [`ChatAssignmentOpenedStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentOpenedStatusAction)

Defined in: [WAProto/index.d.ts:11785](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11785)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IChatAssignmentOpenedStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentOpenedStatusAction)

#### Returns[​](#returns "Direct link to Returns")

[`ChatAssignmentOpenedStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentOpenedStatusAction)

## Properties[​](#properties "Direct link to Properties")

### chatOpened?[​](#chatopened "Direct link to chatOpened?")

> `optional` **chatOpened**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11786](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11786)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IChatAssignmentOpenedStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentOpenedStatusAction).[`chatOpened`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentOpenedStatusAction#chatopened)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11792](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11792)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ChatAssignmentOpenedStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentOpenedStatusAction)

Defined in: [WAProto/index.d.ts:11787](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11787)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IChatAssignmentOpenedStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentOpenedStatusAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ChatAssignmentOpenedStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentOpenedStatusAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ChatAssignmentOpenedStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentOpenedStatusAction)

Defined in: [WAProto/index.d.ts:11789](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11789)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ChatAssignmentOpenedStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentOpenedStatusAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11788](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11788)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IChatAssignmentOpenedStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentOpenedStatusAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ChatAssignmentOpenedStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentOpenedStatusAction)

Defined in: [WAProto/index.d.ts:11790](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11790)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ChatAssignmentOpenedStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentOpenedStatusAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11793](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11793)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11791](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11791)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ChatAssignmentOpenedStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ChatAssignmentOpenedStatusAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-clearchataction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ClearChatAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ClearChatAction)

Defined in: [WAProto/index.d.ts:11800](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11800)

## Implements[​](#implements "Direct link to Implements")

*   [`IClearChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IClearChatAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new ClearChatAction()[​](#new-clearchataction "Direct link to new ClearChatAction()")

> **new ClearChatAction**(`p`?): [`ClearChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ClearChatAction)

Defined in: [WAProto/index.d.ts:11801](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11801)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IClearChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IClearChatAction)

#### Returns[​](#returns "Direct link to Returns")

[`ClearChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ClearChatAction)

## Properties[​](#properties "Direct link to Properties")

### messageRange?[​](#messagerange "Direct link to messageRange?")

> `optional` **messageRange**: `null` | [`ISyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange)

Defined in: [WAProto/index.d.ts:11802](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11802)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IClearChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IClearChatAction).[`messageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IClearChatAction#messagerange)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11808](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11808)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ClearChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ClearChatAction)

Defined in: [WAProto/index.d.ts:11803](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11803)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IClearChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IClearChatAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ClearChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ClearChatAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ClearChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ClearChatAction)

Defined in: [WAProto/index.d.ts:11805](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11805)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ClearChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ClearChatAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11804](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11804)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IClearChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IClearChatAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ClearChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ClearChatAction)

Defined in: [WAProto/index.d.ts:11806](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11806)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ClearChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ClearChatAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11809](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11809)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11807](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11807)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ClearChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ClearChatAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-contactaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ContactAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ContactAction)

Defined in: [WAProto/index.d.ts:11821](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11821)

## Implements[​](#implements "Direct link to Implements")

*   [`IContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new ContactAction()[​](#new-contactaction "Direct link to new ContactAction()")

> **new ContactAction**(`p`?): [`ContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ContactAction)

Defined in: [WAProto/index.d.ts:11822](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11822)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction)

#### Returns[​](#returns "Direct link to Returns")

[`ContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ContactAction)

## Properties[​](#properties "Direct link to Properties")

### firstName?[​](#firstname "Direct link to firstName?")

> `optional` **firstName**: `null` | `string`

Defined in: [WAProto/index.d.ts:11824](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11824)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction).[`firstName`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction#firstname)

* * *

### fullName?[​](#fullname "Direct link to fullName?")

> `optional` **fullName**: `null` | `string`

Defined in: [WAProto/index.d.ts:11823](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11823)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction).[`fullName`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction#fullname)

* * *

### lidJid?[​](#lidjid "Direct link to lidJid?")

> `optional` **lidJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:11825](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11825)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction).[`lidJid`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction#lidjid)

* * *

### pnJid?[​](#pnjid "Direct link to pnJid?")

> `optional` **pnJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:11827](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11827)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction).[`pnJid`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction#pnjid)

* * *

### saveOnPrimaryAddressbook?[​](#saveonprimaryaddressbook "Direct link to saveOnPrimaryAddressbook?")

> `optional` **saveOnPrimaryAddressbook**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11826](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11826)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction).[`saveOnPrimaryAddressbook`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction#saveonprimaryaddressbook)

* * *

### username?[​](#username "Direct link to username?")

> `optional` **username**: `null` | `string`

Defined in: [WAProto/index.d.ts:11828](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11828)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction).[`username`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction#username)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11834](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11834)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ContactAction)

Defined in: [WAProto/index.d.ts:11829](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11829)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ContactAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ContactAction)

Defined in: [WAProto/index.d.ts:11831](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11831)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ContactAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11830](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11830)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ContactAction)

Defined in: [WAProto/index.d.ts:11832](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11832)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ContactAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11835](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11835)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11833](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11833)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ContactAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-ctwapercustomerdatasharingaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CtwaPerCustomerDataSharingAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CtwaPerCustomerDataSharingAction)

Defined in: [WAProto/index.d.ts:11842](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11842)

## Implements[​](#implements "Direct link to Implements")

*   [`ICtwaPerCustomerDataSharingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICtwaPerCustomerDataSharingAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new CtwaPerCustomerDataSharingAction()[​](#new-ctwapercustomerdatasharingaction "Direct link to new CtwaPerCustomerDataSharingAction()")

> **new CtwaPerCustomerDataSharingAction**(`p`?): [`CtwaPerCustomerDataSharingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CtwaPerCustomerDataSharingAction)

Defined in: [WAProto/index.d.ts:11843](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11843)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICtwaPerCustomerDataSharingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICtwaPerCustomerDataSharingAction)

#### Returns[​](#returns "Direct link to Returns")

[`CtwaPerCustomerDataSharingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CtwaPerCustomerDataSharingAction)

## Properties[​](#properties "Direct link to Properties")

### isCtwaPerCustomerDataSharingEnabled?[​](#isctwapercustomerdatasharingenabled "Direct link to isCtwaPerCustomerDataSharingEnabled?")

> `optional` **isCtwaPerCustomerDataSharingEnabled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11844](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11844)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICtwaPerCustomerDataSharingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICtwaPerCustomerDataSharingAction).[`isCtwaPerCustomerDataSharingEnabled`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICtwaPerCustomerDataSharingAction#isctwapercustomerdatasharingenabled)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11850](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11850)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CtwaPerCustomerDataSharingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CtwaPerCustomerDataSharingAction)

Defined in: [WAProto/index.d.ts:11845](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11845)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICtwaPerCustomerDataSharingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICtwaPerCustomerDataSharingAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CtwaPerCustomerDataSharingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CtwaPerCustomerDataSharingAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CtwaPerCustomerDataSharingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CtwaPerCustomerDataSharingAction)

Defined in: [WAProto/index.d.ts:11847](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11847)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CtwaPerCustomerDataSharingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CtwaPerCustomerDataSharingAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11846](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11846)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICtwaPerCustomerDataSharingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICtwaPerCustomerDataSharingAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CtwaPerCustomerDataSharingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CtwaPerCustomerDataSharingAction)

Defined in: [WAProto/index.d.ts:11848](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11848)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CtwaPerCustomerDataSharingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CtwaPerCustomerDataSharingAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11851](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11851)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11849](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11849)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CtwaPerCustomerDataSharingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CtwaPerCustomerDataSharingAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-custompaymentmethod"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethod](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethod)

Defined in: [WAProto/index.d.ts:11861](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11861)

## Implements[​](#implements "Direct link to Implements")

*   [`ICustomPaymentMethod`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethod)

## Constructors[​](#constructors "Direct link to Constructors")

### new CustomPaymentMethod()[​](#new-custompaymentmethod "Direct link to new CustomPaymentMethod()")

> **new CustomPaymentMethod**(`p`?): [`CustomPaymentMethod`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethod)

Defined in: [WAProto/index.d.ts:11862](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11862)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICustomPaymentMethod`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethod)

#### Returns[​](#returns "Direct link to Returns")

[`CustomPaymentMethod`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethod)

## Properties[​](#properties "Direct link to Properties")

### country[​](#country "Direct link to country")

> **country**: `string`

Defined in: [WAProto/index.d.ts:11864](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11864)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICustomPaymentMethod`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethod).[`country`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethod#country)

* * *

### credentialId[​](#credentialid "Direct link to credentialId")

> **credentialId**: `string`

Defined in: [WAProto/index.d.ts:11863](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11863)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ICustomPaymentMethod`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethod).[`credentialId`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethod#credentialid)

* * *

### metadata[​](#metadata "Direct link to metadata")

> **metadata**: [`ICustomPaymentMethodMetadata`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodMetadata)\[\]

Defined in: [WAProto/index.d.ts:11866](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11866)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ICustomPaymentMethod`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethod).[`metadata`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethod#metadata)

* * *

### type[​](#type "Direct link to type")

> **type**: `string`

Defined in: [WAProto/index.d.ts:11865](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11865)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ICustomPaymentMethod`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethod).[`type`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethod#type)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11872](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11872)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CustomPaymentMethod`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethod)

Defined in: [WAProto/index.d.ts:11867](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11867)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICustomPaymentMethod`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethod)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CustomPaymentMethod`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethod)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CustomPaymentMethod`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethod)

Defined in: [WAProto/index.d.ts:11869](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11869)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CustomPaymentMethod`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethod)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11868](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11868)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICustomPaymentMethod`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethod)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CustomPaymentMethod`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethod)

Defined in: [WAProto/index.d.ts:11870](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11870)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CustomPaymentMethod`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethod)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11873](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11873)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11871](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11871)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CustomPaymentMethod`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethod)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-custompaymentmethodmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodMetadata)

Defined in: [WAProto/index.d.ts:11881](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11881)

## Implements[​](#implements "Direct link to Implements")

*   [`ICustomPaymentMethodMetadata`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodMetadata)

## Constructors[​](#constructors "Direct link to Constructors")

### new CustomPaymentMethodMetadata()[​](#new-custompaymentmethodmetadata "Direct link to new CustomPaymentMethodMetadata()")

> **new CustomPaymentMethodMetadata**(`p`?): [`CustomPaymentMethodMetadata`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodMetadata)

Defined in: [WAProto/index.d.ts:11882](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11882)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICustomPaymentMethodMetadata`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodMetadata)

#### Returns[​](#returns "Direct link to Returns")

[`CustomPaymentMethodMetadata`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodMetadata)

## Properties[​](#properties "Direct link to Properties")

### key[​](#key "Direct link to key")

> **key**: `string`

Defined in: [WAProto/index.d.ts:11883](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11883)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICustomPaymentMethodMetadata`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodMetadata).[`key`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodMetadata#key)

* * *

### value[​](#value "Direct link to value")

> **value**: `string`

Defined in: [WAProto/index.d.ts:11884](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11884)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ICustomPaymentMethodMetadata`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodMetadata).[`value`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodMetadata#value)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11890](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11890)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CustomPaymentMethodMetadata`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodMetadata)

Defined in: [WAProto/index.d.ts:11885](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11885)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICustomPaymentMethodMetadata`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodMetadata)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CustomPaymentMethodMetadata`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodMetadata)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CustomPaymentMethodMetadata`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodMetadata)

Defined in: [WAProto/index.d.ts:11887](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11887)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CustomPaymentMethodMetadata`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodMetadata)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11886](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11886)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICustomPaymentMethodMetadata`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodMetadata)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CustomPaymentMethodMetadata`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodMetadata)

Defined in: [WAProto/index.d.ts:11888](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11888)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CustomPaymentMethodMetadata`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodMetadata)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11891](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11891)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11889](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11889)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CustomPaymentMethodMetadata`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodMetadata)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-custompaymentmethodsaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodsAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodsAction)

Defined in: [WAProto/index.d.ts:11898](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11898)

## Implements[​](#implements "Direct link to Implements")

*   [`ICustomPaymentMethodsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodsAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new CustomPaymentMethodsAction()[​](#new-custompaymentmethodsaction "Direct link to new CustomPaymentMethodsAction()")

> **new CustomPaymentMethodsAction**(`p`?): [`CustomPaymentMethodsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodsAction)

Defined in: [WAProto/index.d.ts:11899](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11899)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICustomPaymentMethodsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodsAction)

#### Returns[​](#returns "Direct link to Returns")

[`CustomPaymentMethodsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodsAction)

## Properties[​](#properties "Direct link to Properties")

### customPaymentMethods[​](#custompaymentmethods "Direct link to customPaymentMethods")

> **customPaymentMethods**: [`ICustomPaymentMethod`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethod)\[\]

Defined in: [WAProto/index.d.ts:11900](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11900)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICustomPaymentMethodsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodsAction).[`customPaymentMethods`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodsAction#custompaymentmethods)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11906](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11906)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CustomPaymentMethodsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodsAction)

Defined in: [WAProto/index.d.ts:11901](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11901)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICustomPaymentMethodsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodsAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CustomPaymentMethodsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodsAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CustomPaymentMethodsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodsAction)

Defined in: [WAProto/index.d.ts:11903](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11903)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CustomPaymentMethodsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodsAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11902](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11902)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICustomPaymentMethodsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodsAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CustomPaymentMethodsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodsAction)

Defined in: [WAProto/index.d.ts:11904](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11904)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CustomPaymentMethodsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodsAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11907](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11907)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11905](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11905)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CustomPaymentMethodsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/CustomPaymentMethodsAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-deletechataction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteChatAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteChatAction)

Defined in: [WAProto/index.d.ts:11914](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11914)

## Implements[​](#implements "Direct link to Implements")

*   [`IDeleteChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteChatAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new DeleteChatAction()[​](#new-deletechataction "Direct link to new DeleteChatAction()")

> **new DeleteChatAction**(`p`?): [`DeleteChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteChatAction)

Defined in: [WAProto/index.d.ts:11915](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11915)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IDeleteChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteChatAction)

#### Returns[​](#returns "Direct link to Returns")

[`DeleteChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteChatAction)

## Properties[​](#properties "Direct link to Properties")

### messageRange?[​](#messagerange "Direct link to messageRange?")

> `optional` **messageRange**: `null` | [`ISyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange)

Defined in: [WAProto/index.d.ts:11916](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11916)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IDeleteChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteChatAction).[`messageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteChatAction#messagerange)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11922](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11922)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`DeleteChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteChatAction)

Defined in: [WAProto/index.d.ts:11917](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11917)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IDeleteChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteChatAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`DeleteChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteChatAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`DeleteChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteChatAction)

Defined in: [WAProto/index.d.ts:11919](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11919)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`DeleteChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteChatAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11918](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11918)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IDeleteChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteChatAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`DeleteChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteChatAction)

Defined in: [WAProto/index.d.ts:11920](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11920)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`DeleteChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteChatAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11923](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11923)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11921](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11921)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`DeleteChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteChatAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-deleteindividualcalllogaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteIndividualCallLogAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteIndividualCallLogAction)

Defined in: [WAProto/index.d.ts:11931](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11931)

## Implements[​](#implements "Direct link to Implements")

*   [`IDeleteIndividualCallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteIndividualCallLogAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new DeleteIndividualCallLogAction()[​](#new-deleteindividualcalllogaction "Direct link to new DeleteIndividualCallLogAction()")

> **new DeleteIndividualCallLogAction**(`p`?): [`DeleteIndividualCallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteIndividualCallLogAction)

Defined in: [WAProto/index.d.ts:11932](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11932)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IDeleteIndividualCallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteIndividualCallLogAction)

#### Returns[​](#returns "Direct link to Returns")

[`DeleteIndividualCallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteIndividualCallLogAction)

## Properties[​](#properties "Direct link to Properties")

### isIncoming?[​](#isincoming "Direct link to isIncoming?")

> `optional` **isIncoming**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11934](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11934)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IDeleteIndividualCallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteIndividualCallLogAction).[`isIncoming`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteIndividualCallLogAction#isincoming)

* * *

### peerJid?[​](#peerjid "Direct link to peerJid?")

> `optional` **peerJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:11933](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11933)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IDeleteIndividualCallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteIndividualCallLogAction).[`peerJid`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteIndividualCallLogAction#peerjid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11940](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11940)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`DeleteIndividualCallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteIndividualCallLogAction)

Defined in: [WAProto/index.d.ts:11935](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11935)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IDeleteIndividualCallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteIndividualCallLogAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`DeleteIndividualCallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteIndividualCallLogAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`DeleteIndividualCallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteIndividualCallLogAction)

Defined in: [WAProto/index.d.ts:11937](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11937)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`DeleteIndividualCallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteIndividualCallLogAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11936](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11936)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IDeleteIndividualCallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteIndividualCallLogAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`DeleteIndividualCallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteIndividualCallLogAction)

Defined in: [WAProto/index.d.ts:11938](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11938)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`DeleteIndividualCallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteIndividualCallLogAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11941](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11941)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11939](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11939)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`DeleteIndividualCallLogAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteIndividualCallLogAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-deletemessageformeaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteMessageForMeAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteMessageForMeAction)

Defined in: [WAProto/index.d.ts:11949](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11949)

## Implements[​](#implements "Direct link to Implements")

*   [`IDeleteMessageForMeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteMessageForMeAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new DeleteMessageForMeAction()[​](#new-deletemessageformeaction "Direct link to new DeleteMessageForMeAction()")

> **new DeleteMessageForMeAction**(`p`?): [`DeleteMessageForMeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteMessageForMeAction)

Defined in: [WAProto/index.d.ts:11950](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11950)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IDeleteMessageForMeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteMessageForMeAction)

#### Returns[​](#returns "Direct link to Returns")

[`DeleteMessageForMeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteMessageForMeAction)

## Properties[​](#properties "Direct link to Properties")

### deleteMedia?[​](#deletemedia "Direct link to deleteMedia?")

> `optional` **deleteMedia**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11951](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11951)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IDeleteMessageForMeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteMessageForMeAction).[`deleteMedia`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteMessageForMeAction#deletemedia)

* * *

### messageTimestamp?[​](#messagetimestamp "Direct link to messageTimestamp?")

> `optional` **messageTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:11952](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11952)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IDeleteMessageForMeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteMessageForMeAction).[`messageTimestamp`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteMessageForMeAction#messagetimestamp)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11958](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11958)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`DeleteMessageForMeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteMessageForMeAction)

Defined in: [WAProto/index.d.ts:11953](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11953)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IDeleteMessageForMeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteMessageForMeAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`DeleteMessageForMeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteMessageForMeAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`DeleteMessageForMeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteMessageForMeAction)

Defined in: [WAProto/index.d.ts:11955](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11955)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`DeleteMessageForMeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteMessageForMeAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11954](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11954)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IDeleteMessageForMeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteMessageForMeAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`DeleteMessageForMeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteMessageForMeAction)

Defined in: [WAProto/index.d.ts:11956](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11956)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`DeleteMessageForMeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteMessageForMeAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11959](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11959)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11957](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11957)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`DeleteMessageForMeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DeleteMessageForMeAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-detectedoutcomesstatusaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DetectedOutcomesStatusAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DetectedOutcomesStatusAction)

Defined in: [WAProto/index.d.ts:11966](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11966)

## Implements[​](#implements "Direct link to Implements")

*   [`IDetectedOutcomesStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDetectedOutcomesStatusAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new DetectedOutcomesStatusAction()[​](#new-detectedoutcomesstatusaction "Direct link to new DetectedOutcomesStatusAction()")

> **new DetectedOutcomesStatusAction**(`p`?): [`DetectedOutcomesStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DetectedOutcomesStatusAction)

Defined in: [WAProto/index.d.ts:11967](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11967)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IDetectedOutcomesStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDetectedOutcomesStatusAction)

#### Returns[​](#returns "Direct link to Returns")

[`DetectedOutcomesStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DetectedOutcomesStatusAction)

## Properties[​](#properties "Direct link to Properties")

### isEnabled?[​](#isenabled "Direct link to isEnabled?")

> `optional` **isEnabled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11968](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11968)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IDetectedOutcomesStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDetectedOutcomesStatusAction).[`isEnabled`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDetectedOutcomesStatusAction#isenabled)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11974](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11974)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`DetectedOutcomesStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DetectedOutcomesStatusAction)

Defined in: [WAProto/index.d.ts:11969](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11969)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IDetectedOutcomesStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDetectedOutcomesStatusAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`DetectedOutcomesStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DetectedOutcomesStatusAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`DetectedOutcomesStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DetectedOutcomesStatusAction)

Defined in: [WAProto/index.d.ts:11971](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11971)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`DetectedOutcomesStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DetectedOutcomesStatusAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11970](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11970)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IDetectedOutcomesStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDetectedOutcomesStatusAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`DetectedOutcomesStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DetectedOutcomesStatusAction)

Defined in: [WAProto/index.d.ts:11972](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11972)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`DetectedOutcomesStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DetectedOutcomesStatusAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11975](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11975)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11973](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11973)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`DetectedOutcomesStatusAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/DetectedOutcomesStatusAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-externalwebbetaaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ExternalWebBetaAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ExternalWebBetaAction)

Defined in: [WAProto/index.d.ts:11982](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11982)

## Implements[​](#implements "Direct link to Implements")

*   [`IExternalWebBetaAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IExternalWebBetaAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new ExternalWebBetaAction()[​](#new-externalwebbetaaction "Direct link to new ExternalWebBetaAction()")

> **new ExternalWebBetaAction**(`p`?): [`ExternalWebBetaAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ExternalWebBetaAction)

Defined in: [WAProto/index.d.ts:11983](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11983)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IExternalWebBetaAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IExternalWebBetaAction)

#### Returns[​](#returns "Direct link to Returns")

[`ExternalWebBetaAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ExternalWebBetaAction)

## Properties[​](#properties "Direct link to Properties")

### isOptIn?[​](#isoptin "Direct link to isOptIn?")

> `optional` **isOptIn**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11984](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11984)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IExternalWebBetaAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IExternalWebBetaAction).[`isOptIn`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IExternalWebBetaAction#isoptin)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:11990](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11990)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`ExternalWebBetaAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ExternalWebBetaAction)

Defined in: [WAProto/index.d.ts:11985](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11985)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IExternalWebBetaAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IExternalWebBetaAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`ExternalWebBetaAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ExternalWebBetaAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`ExternalWebBetaAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ExternalWebBetaAction)

Defined in: [WAProto/index.d.ts:11987](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11987)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`ExternalWebBetaAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ExternalWebBetaAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:11986](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11986)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IExternalWebBetaAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IExternalWebBetaAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`ExternalWebBetaAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ExternalWebBetaAction)

Defined in: [WAProto/index.d.ts:11988](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11988)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`ExternalWebBetaAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ExternalWebBetaAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:11991](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11991)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:11989](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11989)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`ExternalWebBetaAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/ExternalWebBetaAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-favoritesaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/FavoritesAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/FavoritesAction)

Defined in: [WAProto/index.d.ts:11998](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11998)

## Implements[​](#implements "Direct link to Implements")

*   [`IFavoritesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IFavoritesAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new FavoritesAction()[​](#new-favoritesaction "Direct link to new FavoritesAction()")

> **new FavoritesAction**(`p`?): [`FavoritesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/FavoritesAction)

Defined in: [WAProto/index.d.ts:11999](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11999)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IFavoritesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IFavoritesAction)

#### Returns[​](#returns "Direct link to Returns")

[`FavoritesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/FavoritesAction)

## Properties[​](#properties "Direct link to Properties")

### favorites[​](#favorites "Direct link to favorites")

> **favorites**: [`IFavorite`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/interfaces/IFavorite)\[\]

Defined in: [WAProto/index.d.ts:12000](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12000)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IFavoritesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IFavoritesAction).[`favorites`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IFavoritesAction#favorites)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12006](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12006)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`FavoritesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/FavoritesAction)

Defined in: [WAProto/index.d.ts:12001](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12001)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IFavoritesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IFavoritesAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`FavoritesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/FavoritesAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`FavoritesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/FavoritesAction)

Defined in: [WAProto/index.d.ts:12003](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12003)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`FavoritesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/FavoritesAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12002](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12002)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IFavoritesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IFavoritesAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`FavoritesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/FavoritesAction)

Defined in: [WAProto/index.d.ts:12004](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12004)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`FavoritesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/FavoritesAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12007](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12007)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12005](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12005)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`FavoritesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/FavoritesAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-interactivemessageaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/InteractiveMessageAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/InteractiveMessageAction)

Defined in: [WAProto/index.d.ts:12033](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12033)

## Implements[​](#implements "Direct link to Implements")

*   [`IInteractiveMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IInteractiveMessageAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new InteractiveMessageAction()[​](#new-interactivemessageaction "Direct link to new InteractiveMessageAction()")

> **new InteractiveMessageAction**(`p`?): [`InteractiveMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/InteractiveMessageAction)

Defined in: [WAProto/index.d.ts:12034](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12034)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IInteractiveMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IInteractiveMessageAction)

#### Returns[​](#returns "Direct link to Returns")

[`InteractiveMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/InteractiveMessageAction)

## Properties[​](#properties "Direct link to Properties")

### type[​](#type "Direct link to type")

> **type**: [`DISABLE_CTA`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/InteractiveMessageAction/enumerations/InteractiveMessageActionMode#disable_cta)

Defined in: [WAProto/index.d.ts:12035](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12035)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IInteractiveMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IInteractiveMessageAction).[`type`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IInteractiveMessageAction#type)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12041](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12041)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`InteractiveMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/InteractiveMessageAction)

Defined in: [WAProto/index.d.ts:12036](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12036)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IInteractiveMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IInteractiveMessageAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`InteractiveMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/InteractiveMessageAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`InteractiveMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/InteractiveMessageAction)

Defined in: [WAProto/index.d.ts:12038](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12038)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`InteractiveMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/InteractiveMessageAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12037](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12037)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IInteractiveMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IInteractiveMessageAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`InteractiveMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/InteractiveMessageAction)

Defined in: [WAProto/index.d.ts:12039](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12039)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`InteractiveMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/InteractiveMessageAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12042](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12042)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12040](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12040)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`InteractiveMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/InteractiveMessageAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-keyexpiration"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/KeyExpiration](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/KeyExpiration)

Defined in: [WAProto/index.d.ts:12056](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12056)

## Implements[​](#implements "Direct link to Implements")

*   [`IKeyExpiration`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IKeyExpiration)

## Constructors[​](#constructors "Direct link to Constructors")

### new KeyExpiration()[​](#new-keyexpiration "Direct link to new KeyExpiration()")

> **new KeyExpiration**(`p`?): [`KeyExpiration`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/KeyExpiration)

Defined in: [WAProto/index.d.ts:12057](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12057)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IKeyExpiration`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IKeyExpiration)

#### Returns[​](#returns "Direct link to Returns")

[`KeyExpiration`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/KeyExpiration)

## Properties[​](#properties "Direct link to Properties")

### expiredKeyEpoch?[​](#expiredkeyepoch "Direct link to expiredKeyEpoch?")

> `optional` **expiredKeyEpoch**: `null` | `number`

Defined in: [WAProto/index.d.ts:12058](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12058)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IKeyExpiration`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IKeyExpiration).[`expiredKeyEpoch`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IKeyExpiration#expiredkeyepoch)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12064](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12064)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`KeyExpiration`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/KeyExpiration)

Defined in: [WAProto/index.d.ts:12059](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12059)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IKeyExpiration`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IKeyExpiration)

#### Returns[​](#returns-2 "Direct link to Returns")

[`KeyExpiration`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/KeyExpiration)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`KeyExpiration`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/KeyExpiration)

Defined in: [WAProto/index.d.ts:12061](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12061)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`KeyExpiration`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/KeyExpiration)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12060](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12060)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IKeyExpiration`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IKeyExpiration)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`KeyExpiration`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/KeyExpiration)

Defined in: [WAProto/index.d.ts:12062](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12062)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`KeyExpiration`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/KeyExpiration)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12065](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12065)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12063](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12063)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`KeyExpiration`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/KeyExpiration)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-labelassociationaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelAssociationAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelAssociationAction)

Defined in: [WAProto/index.d.ts:12072](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12072)

## Implements[​](#implements "Direct link to Implements")

*   [`ILabelAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelAssociationAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new LabelAssociationAction()[​](#new-labelassociationaction "Direct link to new LabelAssociationAction()")

> **new LabelAssociationAction**(`p`?): [`LabelAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelAssociationAction)

Defined in: [WAProto/index.d.ts:12073](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12073)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ILabelAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelAssociationAction)

#### Returns[​](#returns "Direct link to Returns")

[`LabelAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelAssociationAction)

## Properties[​](#properties "Direct link to Properties")

### labeled?[​](#labeled "Direct link to labeled?")

> `optional` **labeled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12074](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12074)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILabelAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelAssociationAction).[`labeled`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelAssociationAction#labeled)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12080](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12080)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`LabelAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelAssociationAction)

Defined in: [WAProto/index.d.ts:12075](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12075)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ILabelAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelAssociationAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`LabelAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelAssociationAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`LabelAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelAssociationAction)

Defined in: [WAProto/index.d.ts:12077](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12077)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`LabelAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelAssociationAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12076](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12076)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ILabelAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelAssociationAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`LabelAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelAssociationAction)

Defined in: [WAProto/index.d.ts:12078](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12078)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`LabelAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelAssociationAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12081](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12081)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12079](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12079)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`LabelAssociationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelAssociationAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-labeleditaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelEditAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelEditAction)

Defined in: [WAProto/index.d.ts:12096](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12096)

## Implements[​](#implements "Direct link to Implements")

*   [`ILabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new LabelEditAction()[​](#new-labeleditaction "Direct link to new LabelEditAction()")

> **new LabelEditAction**(`p`?): [`LabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelEditAction)

Defined in: [WAProto/index.d.ts:12097](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12097)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ILabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction)

#### Returns[​](#returns "Direct link to Returns")

[`LabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelEditAction)

## Properties[​](#properties "Direct link to Properties")

### color?[​](#color "Direct link to color?")

> `optional` **color**: `null` | `number`

Defined in: [WAProto/index.d.ts:12099](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12099)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction).[`color`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction#color)

* * *

### deleted?[​](#deleted "Direct link to deleted?")

> `optional` **deleted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12101](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12101)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ILabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction).[`deleted`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction#deleted)

* * *

### isActive?[​](#isactive "Direct link to isActive?")

> `optional` **isActive**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12103](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12103)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ILabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction).[`isActive`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction#isactive)

* * *

### isImmutable?[​](#isimmutable "Direct link to isImmutable?")

> `optional` **isImmutable**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12105](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12105)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ILabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction).[`isImmutable`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction#isimmutable)

* * *

### muteEndTimeMs?[​](#muteendtimems "Direct link to muteEndTimeMs?")

> `optional` **muteEndTimeMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12106](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12106)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ILabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction).[`muteEndTimeMs`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction#muteendtimems)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:12098](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12098)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`ILabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction).[`name`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction#name)

* * *

### orderIndex?[​](#orderindex "Direct link to orderIndex?")

> `optional` **orderIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:12102](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12102)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`ILabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction).[`orderIndex`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction#orderindex)

* * *

### predefinedId?[​](#predefinedid "Direct link to predefinedId?")

> `optional` **predefinedId**: `null` | `number`

Defined in: [WAProto/index.d.ts:12100](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12100)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`ILabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction).[`predefinedId`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction#predefinedid)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`ListType`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/LabelEditAction/enumerations/ListType)

Defined in: [WAProto/index.d.ts:12104](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12104)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`ILabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction).[`type`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction#type)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12112](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12112)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`LabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelEditAction)

Defined in: [WAProto/index.d.ts:12107](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12107)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ILabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`LabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelEditAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`LabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelEditAction)

Defined in: [WAProto/index.d.ts:12109](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12109)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`LabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelEditAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12108](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12108)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ILabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`LabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelEditAction)

Defined in: [WAProto/index.d.ts:12110](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12110)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`LabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelEditAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12113](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12113)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12111](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12111)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`LabelEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelEditAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-labelreorderingaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelReorderingAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelReorderingAction)

Defined in: [WAProto/index.d.ts:12136](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12136)

## Implements[​](#implements "Direct link to Implements")

*   [`ILabelReorderingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelReorderingAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new LabelReorderingAction()[​](#new-labelreorderingaction "Direct link to new LabelReorderingAction()")

> **new LabelReorderingAction**(`p`?): [`LabelReorderingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelReorderingAction)

Defined in: [WAProto/index.d.ts:12137](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12137)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ILabelReorderingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelReorderingAction)

#### Returns[​](#returns "Direct link to Returns")

[`LabelReorderingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelReorderingAction)

## Properties[​](#properties "Direct link to Properties")

### sortedLabelIds[​](#sortedlabelids "Direct link to sortedLabelIds")

> **sortedLabelIds**: `number`\[\]

Defined in: [WAProto/index.d.ts:12138](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12138)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILabelReorderingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelReorderingAction).[`sortedLabelIds`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelReorderingAction#sortedlabelids)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12144](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12144)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`LabelReorderingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelReorderingAction)

Defined in: [WAProto/index.d.ts:12139](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12139)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ILabelReorderingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelReorderingAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`LabelReorderingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelReorderingAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`LabelReorderingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelReorderingAction)

Defined in: [WAProto/index.d.ts:12141](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12141)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`LabelReorderingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelReorderingAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12140](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12140)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ILabelReorderingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelReorderingAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`LabelReorderingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelReorderingAction)

Defined in: [WAProto/index.d.ts:12142](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12142)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`LabelReorderingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelReorderingAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12145](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12145)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12143](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12143)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`LabelReorderingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LabelReorderingAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-lidcontactaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LidContactAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LidContactAction)

Defined in: [WAProto/index.d.ts:12154](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12154)

## Implements[​](#implements "Direct link to Implements")

*   [`ILidContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILidContactAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new LidContactAction()[​](#new-lidcontactaction "Direct link to new LidContactAction()")

> **new LidContactAction**(`p`?): [`LidContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LidContactAction)

Defined in: [WAProto/index.d.ts:12155](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12155)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ILidContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILidContactAction)

#### Returns[​](#returns "Direct link to Returns")

[`LidContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LidContactAction)

## Properties[​](#properties "Direct link to Properties")

### firstName?[​](#firstname "Direct link to firstName?")

> `optional` **firstName**: `null` | `string`

Defined in: [WAProto/index.d.ts:12157](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12157)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILidContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILidContactAction).[`firstName`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILidContactAction#firstname)

* * *

### fullName?[​](#fullname "Direct link to fullName?")

> `optional` **fullName**: `null` | `string`

Defined in: [WAProto/index.d.ts:12156](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12156)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ILidContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILidContactAction).[`fullName`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILidContactAction#fullname)

* * *

### username?[​](#username "Direct link to username?")

> `optional` **username**: `null` | `string`

Defined in: [WAProto/index.d.ts:12158](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12158)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ILidContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILidContactAction).[`username`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILidContactAction#username)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12164](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12164)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`LidContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LidContactAction)

Defined in: [WAProto/index.d.ts:12159](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12159)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ILidContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILidContactAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`LidContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LidContactAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`LidContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LidContactAction)

Defined in: [WAProto/index.d.ts:12161](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12161)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`LidContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LidContactAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12160](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12160)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ILidContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILidContactAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`LidContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LidContactAction)

Defined in: [WAProto/index.d.ts:12162](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12162)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`LidContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LidContactAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12165](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12165)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12163](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12163)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`LidContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LidContactAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-localesetting"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LocaleSetting](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LocaleSetting)

Defined in: [WAProto/index.d.ts:12172](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12172)

## Implements[​](#implements "Direct link to Implements")

*   [`ILocaleSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILocaleSetting)

## Constructors[​](#constructors "Direct link to Constructors")

### new LocaleSetting()[​](#new-localesetting "Direct link to new LocaleSetting()")

> **new LocaleSetting**(`p`?): [`LocaleSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LocaleSetting)

Defined in: [WAProto/index.d.ts:12173](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12173)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ILocaleSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILocaleSetting)

#### Returns[​](#returns "Direct link to Returns")

[`LocaleSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LocaleSetting)

## Properties[​](#properties "Direct link to Properties")

### locale?[​](#locale "Direct link to locale?")

> `optional` **locale**: `null` | `string`

Defined in: [WAProto/index.d.ts:12174](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12174)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILocaleSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILocaleSetting).[`locale`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILocaleSetting#locale)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12180](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12180)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`LocaleSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LocaleSetting)

Defined in: [WAProto/index.d.ts:12175](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12175)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ILocaleSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILocaleSetting)

#### Returns[​](#returns-2 "Direct link to Returns")

[`LocaleSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LocaleSetting)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`LocaleSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LocaleSetting)

Defined in: [WAProto/index.d.ts:12177](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12177)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`LocaleSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LocaleSetting)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12176](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12176)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ILocaleSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILocaleSetting)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`LocaleSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LocaleSetting)

Defined in: [WAProto/index.d.ts:12178](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12178)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`LocaleSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LocaleSetting)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12181](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12181)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12179](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12179)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`LocaleSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LocaleSetting)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-lockchataction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LockChatAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LockChatAction)

Defined in: [WAProto/index.d.ts:12188](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12188)

## Implements[​](#implements "Direct link to Implements")

*   [`ILockChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILockChatAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new LockChatAction()[​](#new-lockchataction "Direct link to new LockChatAction()")

> **new LockChatAction**(`p`?): [`LockChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LockChatAction)

Defined in: [WAProto/index.d.ts:12189](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12189)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ILockChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILockChatAction)

#### Returns[​](#returns "Direct link to Returns")

[`LockChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LockChatAction)

## Properties[​](#properties "Direct link to Properties")

### locked?[​](#locked "Direct link to locked?")

> `optional` **locked**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12190](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12190)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILockChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILockChatAction).[`locked`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILockChatAction#locked)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12196](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12196)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`LockChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LockChatAction)

Defined in: [WAProto/index.d.ts:12191](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12191)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ILockChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILockChatAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`LockChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LockChatAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`LockChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LockChatAction)

Defined in: [WAProto/index.d.ts:12193](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12193)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`LockChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LockChatAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12192](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12192)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ILockChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILockChatAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`LockChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LockChatAction)

Defined in: [WAProto/index.d.ts:12194](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12194)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`LockChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LockChatAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12197](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12197)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12195](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12195)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`LockChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/LockChatAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-maibaaifeaturescontrolaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MaibaAIFeaturesControlAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MaibaAIFeaturesControlAction)

Defined in: [WAProto/index.d.ts:12204](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12204)

## Implements[​](#implements "Direct link to Implements")

*   [`IMaibaAIFeaturesControlAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMaibaAIFeaturesControlAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new MaibaAIFeaturesControlAction()[​](#new-maibaaifeaturescontrolaction "Direct link to new MaibaAIFeaturesControlAction()")

> **new MaibaAIFeaturesControlAction**(`p`?): [`MaibaAIFeaturesControlAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MaibaAIFeaturesControlAction)

Defined in: [WAProto/index.d.ts:12205](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12205)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMaibaAIFeaturesControlAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMaibaAIFeaturesControlAction)

#### Returns[​](#returns "Direct link to Returns")

[`MaibaAIFeaturesControlAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MaibaAIFeaturesControlAction)

## Properties[​](#properties "Direct link to Properties")

### aiFeatureStatus?[​](#aifeaturestatus "Direct link to aiFeatureStatus?")

> `optional` **aiFeatureStatus**: `null` | [`MaibaAIFeatureStatus`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MaibaAIFeaturesControlAction/enumerations/MaibaAIFeatureStatus)

Defined in: [WAProto/index.d.ts:12206](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12206)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMaibaAIFeaturesControlAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMaibaAIFeaturesControlAction).[`aiFeatureStatus`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMaibaAIFeaturesControlAction#aifeaturestatus)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12212](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12212)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MaibaAIFeaturesControlAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MaibaAIFeaturesControlAction)

Defined in: [WAProto/index.d.ts:12207](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12207)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMaibaAIFeaturesControlAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMaibaAIFeaturesControlAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MaibaAIFeaturesControlAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MaibaAIFeaturesControlAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MaibaAIFeaturesControlAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MaibaAIFeaturesControlAction)

Defined in: [WAProto/index.d.ts:12209](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12209)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MaibaAIFeaturesControlAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MaibaAIFeaturesControlAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12208](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12208)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMaibaAIFeaturesControlAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMaibaAIFeaturesControlAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MaibaAIFeaturesControlAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MaibaAIFeaturesControlAction)

Defined in: [WAProto/index.d.ts:12210](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12210)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MaibaAIFeaturesControlAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MaibaAIFeaturesControlAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12213](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12213)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12211](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12211)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MaibaAIFeaturesControlAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MaibaAIFeaturesControlAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-markchatasreadaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarkChatAsReadAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarkChatAsReadAction)

Defined in: [WAProto/index.d.ts:12230](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12230)

## Implements[​](#implements "Direct link to Implements")

*   [`IMarkChatAsReadAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarkChatAsReadAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new MarkChatAsReadAction()[​](#new-markchatasreadaction "Direct link to new MarkChatAsReadAction()")

> **new MarkChatAsReadAction**(`p`?): [`MarkChatAsReadAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarkChatAsReadAction)

Defined in: [WAProto/index.d.ts:12231](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12231)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMarkChatAsReadAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarkChatAsReadAction)

#### Returns[​](#returns "Direct link to Returns")

[`MarkChatAsReadAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarkChatAsReadAction)

## Properties[​](#properties "Direct link to Properties")

### messageRange?[​](#messagerange "Direct link to messageRange?")

> `optional` **messageRange**: `null` | [`ISyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange)

Defined in: [WAProto/index.d.ts:12233](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12233)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMarkChatAsReadAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarkChatAsReadAction).[`messageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarkChatAsReadAction#messagerange)

* * *

### read?[​](#read "Direct link to read?")

> `optional` **read**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12232](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12232)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMarkChatAsReadAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarkChatAsReadAction).[`read`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarkChatAsReadAction#read)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12239](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12239)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MarkChatAsReadAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarkChatAsReadAction)

Defined in: [WAProto/index.d.ts:12234](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12234)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMarkChatAsReadAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarkChatAsReadAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MarkChatAsReadAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarkChatAsReadAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MarkChatAsReadAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarkChatAsReadAction)

Defined in: [WAProto/index.d.ts:12236](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12236)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MarkChatAsReadAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarkChatAsReadAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12235](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12235)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMarkChatAsReadAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarkChatAsReadAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MarkChatAsReadAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarkChatAsReadAction)

Defined in: [WAProto/index.d.ts:12237](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12237)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MarkChatAsReadAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarkChatAsReadAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12240](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12240)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12238](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12238)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MarkChatAsReadAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarkChatAsReadAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-marketingmessageaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageAction)

Defined in: [WAProto/index.d.ts:12253](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12253)

## Implements[​](#implements "Direct link to Implements")

*   [`IMarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new MarketingMessageAction()[​](#new-marketingmessageaction "Direct link to new MarketingMessageAction()")

> **new MarketingMessageAction**(`p`?): [`MarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageAction)

Defined in: [WAProto/index.d.ts:12254](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12254)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction)

#### Returns[​](#returns "Direct link to Returns")

[`MarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageAction)

## Properties[​](#properties "Direct link to Properties")

### createdAt?[​](#createdat "Direct link to createdAt?")

> `optional` **createdAt**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12258](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12258)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction).[`createdAt`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction#createdat)

* * *

### isDeleted?[​](#isdeleted "Direct link to isDeleted?")

> `optional` **isDeleted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12260](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12260)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction).[`isDeleted`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction#isdeleted)

* * *

### lastSentAt?[​](#lastsentat "Direct link to lastSentAt?")

> `optional` **lastSentAt**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12259](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12259)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction).[`lastSentAt`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction#lastsentat)

* * *

### mediaId?[​](#mediaid "Direct link to mediaId?")

> `optional` **mediaId**: `null` | `string`

Defined in: [WAProto/index.d.ts:12261](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12261)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IMarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction).[`mediaId`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction#mediaid)

* * *

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | `string`

Defined in: [WAProto/index.d.ts:12256](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12256)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IMarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction).[`message`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction#message)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:12255](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12255)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IMarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction).[`name`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction#name)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`PERSONALIZED`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MarketingMessageAction/enumerations/MarketingMessagePrototypeType#personalized)

Defined in: [WAProto/index.d.ts:12257](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12257)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IMarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction).[`type`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction#type)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12267](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12267)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageAction)

Defined in: [WAProto/index.d.ts:12262](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12262)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageAction)

Defined in: [WAProto/index.d.ts:12264](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12264)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12263](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12263)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageAction)

Defined in: [WAProto/index.d.ts:12265](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12265)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12268](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12268)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12266](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12266)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MarketingMessageAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-marketingmessagebroadcastaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageBroadcastAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageBroadcastAction)

Defined in: [WAProto/index.d.ts:12282](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12282)

## Implements[​](#implements "Direct link to Implements")

*   [`IMarketingMessageBroadcastAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageBroadcastAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new MarketingMessageBroadcastAction()[​](#new-marketingmessagebroadcastaction "Direct link to new MarketingMessageBroadcastAction()")

> **new MarketingMessageBroadcastAction**(`p`?): [`MarketingMessageBroadcastAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageBroadcastAction)

Defined in: [WAProto/index.d.ts:12283](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12283)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMarketingMessageBroadcastAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageBroadcastAction)

#### Returns[​](#returns "Direct link to Returns")

[`MarketingMessageBroadcastAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageBroadcastAction)

## Properties[​](#properties "Direct link to Properties")

### repliedCount?[​](#repliedcount "Direct link to repliedCount?")

> `optional` **repliedCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:12284](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12284)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMarketingMessageBroadcastAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageBroadcastAction).[`repliedCount`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageBroadcastAction#repliedcount)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12290](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12290)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MarketingMessageBroadcastAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageBroadcastAction)

Defined in: [WAProto/index.d.ts:12285](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12285)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMarketingMessageBroadcastAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageBroadcastAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MarketingMessageBroadcastAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageBroadcastAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MarketingMessageBroadcastAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageBroadcastAction)

Defined in: [WAProto/index.d.ts:12287](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12287)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MarketingMessageBroadcastAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageBroadcastAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12286](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12286)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMarketingMessageBroadcastAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageBroadcastAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MarketingMessageBroadcastAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageBroadcastAction)

Defined in: [WAProto/index.d.ts:12288](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12288)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MarketingMessageBroadcastAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageBroadcastAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12291](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12291)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12289](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12289)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MarketingMessageBroadcastAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MarketingMessageBroadcastAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-merchantpaymentpartneraction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MerchantPaymentPartnerAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MerchantPaymentPartnerAction)

Defined in: [WAProto/index.d.ts:12301](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12301)

## Implements[​](#implements "Direct link to Implements")

*   [`IMerchantPaymentPartnerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMerchantPaymentPartnerAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new MerchantPaymentPartnerAction()[​](#new-merchantpaymentpartneraction "Direct link to new MerchantPaymentPartnerAction()")

> **new MerchantPaymentPartnerAction**(`p`?): [`MerchantPaymentPartnerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MerchantPaymentPartnerAction)

Defined in: [WAProto/index.d.ts:12302](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12302)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMerchantPaymentPartnerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMerchantPaymentPartnerAction)

#### Returns[​](#returns "Direct link to Returns")

[`MerchantPaymentPartnerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MerchantPaymentPartnerAction)

## Properties[​](#properties "Direct link to Properties")

### country[​](#country "Direct link to country")

> **country**: `string`

Defined in: [WAProto/index.d.ts:12304](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12304)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMerchantPaymentPartnerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMerchantPaymentPartnerAction).[`country`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMerchantPaymentPartnerAction#country)

* * *

### credentialId?[​](#credentialid "Direct link to credentialId?")

> `optional` **credentialId**: `null` | `string`

Defined in: [WAProto/index.d.ts:12306](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12306)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMerchantPaymentPartnerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMerchantPaymentPartnerAction).[`credentialId`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMerchantPaymentPartnerAction#credentialid)

* * *

### gatewayName?[​](#gatewayname "Direct link to gatewayName?")

> `optional` **gatewayName**: `null` | `string`

Defined in: [WAProto/index.d.ts:12305](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12305)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMerchantPaymentPartnerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMerchantPaymentPartnerAction).[`gatewayName`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMerchantPaymentPartnerAction#gatewayname)

* * *

### status[​](#status "Direct link to status")

> **status**: [`Status`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MerchantPaymentPartnerAction/enumerations/Status)

Defined in: [WAProto/index.d.ts:12303](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12303)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IMerchantPaymentPartnerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMerchantPaymentPartnerAction).[`status`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMerchantPaymentPartnerAction#status)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12312](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12312)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MerchantPaymentPartnerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MerchantPaymentPartnerAction)

Defined in: [WAProto/index.d.ts:12307](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12307)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMerchantPaymentPartnerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMerchantPaymentPartnerAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MerchantPaymentPartnerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MerchantPaymentPartnerAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MerchantPaymentPartnerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MerchantPaymentPartnerAction)

Defined in: [WAProto/index.d.ts:12309](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12309)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MerchantPaymentPartnerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MerchantPaymentPartnerAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12308](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12308)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMerchantPaymentPartnerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMerchantPaymentPartnerAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MerchantPaymentPartnerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MerchantPaymentPartnerAction)

Defined in: [WAProto/index.d.ts:12310](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12310)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MerchantPaymentPartnerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MerchantPaymentPartnerAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12313](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12313)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12311](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12311)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MerchantPaymentPartnerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MerchantPaymentPartnerAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-musicuseridaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MusicUserIdAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MusicUserIdAction)

Defined in: [WAProto/index.d.ts:12329](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12329)

## Implements[​](#implements "Direct link to Implements")

*   [`IMusicUserIdAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMusicUserIdAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new MusicUserIdAction()[​](#new-musicuseridaction "Direct link to new MusicUserIdAction()")

> **new MusicUserIdAction**(`p`?): [`MusicUserIdAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MusicUserIdAction)

Defined in: [WAProto/index.d.ts:12330](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12330)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMusicUserIdAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMusicUserIdAction)

#### Returns[​](#returns "Direct link to Returns")

[`MusicUserIdAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MusicUserIdAction)

## Properties[​](#properties "Direct link to Properties")

### musicUserId?[​](#musicuserid "Direct link to musicUserId?")

> `optional` **musicUserId**: `null` | `string`

Defined in: [WAProto/index.d.ts:12331](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12331)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMusicUserIdAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMusicUserIdAction).[`musicUserId`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMusicUserIdAction#musicuserid)

* * *

### musicUserIdMap[​](#musicuseridmap "Direct link to musicUserIdMap")

> **musicUserIdMap**: `object`

Defined in: [WAProto/index.d.ts:12332](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12332)

#### Index Signature[​](#index-signature "Direct link to Index Signature")

\[`k`: `string`\]: `string`

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMusicUserIdAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMusicUserIdAction).[`musicUserIdMap`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMusicUserIdAction#musicuseridmap)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12338](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12338)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MusicUserIdAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MusicUserIdAction)

Defined in: [WAProto/index.d.ts:12333](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12333)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMusicUserIdAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMusicUserIdAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MusicUserIdAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MusicUserIdAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MusicUserIdAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MusicUserIdAction)

Defined in: [WAProto/index.d.ts:12335](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12335)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MusicUserIdAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MusicUserIdAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12334](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12334)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMusicUserIdAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMusicUserIdAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MusicUserIdAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MusicUserIdAction)

Defined in: [WAProto/index.d.ts:12336](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12336)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MusicUserIdAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MusicUserIdAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12339](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12339)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12337](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12337)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MusicUserIdAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MusicUserIdAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-muteaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MuteAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MuteAction)

Defined in: [WAProto/index.d.ts:12348](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12348)

## Implements[​](#implements "Direct link to Implements")

*   [`IMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMuteAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new MuteAction()[​](#new-muteaction "Direct link to new MuteAction()")

> **new MuteAction**(`p`?): [`MuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MuteAction)

Defined in: [WAProto/index.d.ts:12349](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12349)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMuteAction)

#### Returns[​](#returns "Direct link to Returns")

[`MuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MuteAction)

## Properties[​](#properties "Direct link to Properties")

### autoMuted?[​](#automuted "Direct link to autoMuted?")

> `optional` **autoMuted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12352](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12352)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMuteAction).[`autoMuted`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMuteAction#automuted)

* * *

### muted?[​](#muted "Direct link to muted?")

> `optional` **muted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12350](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12350)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMuteAction).[`muted`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMuteAction#muted)

* * *

### muteEndTimestamp?[​](#muteendtimestamp "Direct link to muteEndTimestamp?")

> `optional` **muteEndTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12351](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12351)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMuteAction).[`muteEndTimestamp`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMuteAction#muteendtimestamp)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12358](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12358)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`MuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MuteAction)

Defined in: [WAProto/index.d.ts:12353](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12353)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMuteAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`MuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MuteAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`MuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MuteAction)

Defined in: [WAProto/index.d.ts:12355](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12355)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`MuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MuteAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12354](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12354)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMuteAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`MuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MuteAction)

Defined in: [WAProto/index.d.ts:12356](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12356)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`MuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MuteAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12359](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12359)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12357](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12357)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`MuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/MuteAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-newslettersavedinterestsaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NewsletterSavedInterestsAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NewsletterSavedInterestsAction)

Defined in: [WAProto/index.d.ts:12366](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12366)

## Implements[​](#implements "Direct link to Implements")

*   [`INewsletterSavedInterestsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INewsletterSavedInterestsAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new NewsletterSavedInterestsAction()[​](#new-newslettersavedinterestsaction "Direct link to new NewsletterSavedInterestsAction()")

> **new NewsletterSavedInterestsAction**(`p`?): [`NewsletterSavedInterestsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NewsletterSavedInterestsAction)

Defined in: [WAProto/index.d.ts:12367](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12367)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`INewsletterSavedInterestsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INewsletterSavedInterestsAction)

#### Returns[​](#returns "Direct link to Returns")

[`NewsletterSavedInterestsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NewsletterSavedInterestsAction)

## Properties[​](#properties "Direct link to Properties")

### newsletterSavedInterests?[​](#newslettersavedinterests "Direct link to newsletterSavedInterests?")

> `optional` **newsletterSavedInterests**: `null` | `string`

Defined in: [WAProto/index.d.ts:12368](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12368)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`INewsletterSavedInterestsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INewsletterSavedInterestsAction).[`newsletterSavedInterests`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INewsletterSavedInterestsAction#newslettersavedinterests)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12374](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12374)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`NewsletterSavedInterestsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NewsletterSavedInterestsAction)

Defined in: [WAProto/index.d.ts:12369](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12369)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`INewsletterSavedInterestsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INewsletterSavedInterestsAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`NewsletterSavedInterestsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NewsletterSavedInterestsAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`NewsletterSavedInterestsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NewsletterSavedInterestsAction)

Defined in: [WAProto/index.d.ts:12371](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12371)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`NewsletterSavedInterestsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NewsletterSavedInterestsAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12370](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12370)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`INewsletterSavedInterestsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INewsletterSavedInterestsAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`NewsletterSavedInterestsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NewsletterSavedInterestsAction)

Defined in: [WAProto/index.d.ts:12372](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12372)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`NewsletterSavedInterestsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NewsletterSavedInterestsAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12375](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12375)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12373](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12373)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`NewsletterSavedInterestsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NewsletterSavedInterestsAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-noteeditaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NoteEditAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NoteEditAction)

Defined in: [WAProto/index.d.ts:12386](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12386)

## Implements[​](#implements "Direct link to Implements")

*   [`INoteEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INoteEditAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new NoteEditAction()[​](#new-noteeditaction "Direct link to new NoteEditAction()")

> **new NoteEditAction**(`p`?): [`NoteEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NoteEditAction)

Defined in: [WAProto/index.d.ts:12387](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12387)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`INoteEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INoteEditAction)

#### Returns[​](#returns "Direct link to Returns")

[`NoteEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NoteEditAction)

## Properties[​](#properties "Direct link to Properties")

### chatJid?[​](#chatjid "Direct link to chatJid?")

> `optional` **chatJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:12389](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12389)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`INoteEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INoteEditAction).[`chatJid`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INoteEditAction#chatjid)

* * *

### createdAt?[​](#createdat "Direct link to createdAt?")

> `optional` **createdAt**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12390](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12390)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`INoteEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INoteEditAction).[`createdAt`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INoteEditAction#createdat)

* * *

### deleted?[​](#deleted "Direct link to deleted?")

> `optional` **deleted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12391](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12391)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`INoteEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INoteEditAction).[`deleted`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INoteEditAction#deleted)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`NoteType`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/NoteEditAction/enumerations/NoteType)

Defined in: [WAProto/index.d.ts:12388](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12388)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`INoteEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INoteEditAction).[`type`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INoteEditAction#type)

* * *

### unstructuredContent?[​](#unstructuredcontent "Direct link to unstructuredContent?")

> `optional` **unstructuredContent**: `null` | `string`

Defined in: [WAProto/index.d.ts:12392](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12392)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`INoteEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INoteEditAction).[`unstructuredContent`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INoteEditAction#unstructuredcontent)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12398](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12398)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`NoteEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NoteEditAction)

Defined in: [WAProto/index.d.ts:12393](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12393)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`INoteEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INoteEditAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`NoteEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NoteEditAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`NoteEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NoteEditAction)

Defined in: [WAProto/index.d.ts:12395](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12395)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`NoteEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NoteEditAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12394](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12394)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`INoteEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INoteEditAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`NoteEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NoteEditAction)

Defined in: [WAProto/index.d.ts:12396](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12396)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`NoteEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NoteEditAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12399](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12399)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12397](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12397)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`NoteEditAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NoteEditAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-notificationactivitysettingaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NotificationActivitySettingAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NotificationActivitySettingAction)

Defined in: [WAProto/index.d.ts:12414](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12414)

## Implements[​](#implements "Direct link to Implements")

*   [`INotificationActivitySettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INotificationActivitySettingAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new NotificationActivitySettingAction()[​](#new-notificationactivitysettingaction "Direct link to new NotificationActivitySettingAction()")

> **new NotificationActivitySettingAction**(`p`?): [`NotificationActivitySettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NotificationActivitySettingAction)

Defined in: [WAProto/index.d.ts:12415](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12415)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`INotificationActivitySettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INotificationActivitySettingAction)

#### Returns[​](#returns "Direct link to Returns")

[`NotificationActivitySettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NotificationActivitySettingAction)

## Properties[​](#properties "Direct link to Properties")

### notificationActivitySetting?[​](#notificationactivitysetting "Direct link to notificationActivitySetting?")

> `optional` **notificationActivitySetting**: `null` | [`NotificationActivitySetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/NotificationActivitySettingAction/enumerations/NotificationActivitySetting)

Defined in: [WAProto/index.d.ts:12416](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12416)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`INotificationActivitySettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INotificationActivitySettingAction).[`notificationActivitySetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INotificationActivitySettingAction#notificationactivitysetting)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12422](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12422)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`NotificationActivitySettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NotificationActivitySettingAction)

Defined in: [WAProto/index.d.ts:12417](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12417)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`INotificationActivitySettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INotificationActivitySettingAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`NotificationActivitySettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NotificationActivitySettingAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`NotificationActivitySettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NotificationActivitySettingAction)

Defined in: [WAProto/index.d.ts:12419](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12419)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`NotificationActivitySettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NotificationActivitySettingAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12418](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12418)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`INotificationActivitySettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INotificationActivitySettingAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`NotificationActivitySettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NotificationActivitySettingAction)

Defined in: [WAProto/index.d.ts:12420](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12420)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`NotificationActivitySettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NotificationActivitySettingAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12423](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12423)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12421](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12421)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`NotificationActivitySettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NotificationActivitySettingAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-nuxaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NuxAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NuxAction)

Defined in: [WAProto/index.d.ts:12440](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12440)

## Implements[​](#implements "Direct link to Implements")

*   [`INuxAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INuxAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new NuxAction()[​](#new-nuxaction "Direct link to new NuxAction()")

> **new NuxAction**(`p`?): [`NuxAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NuxAction)

Defined in: [WAProto/index.d.ts:12441](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12441)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`INuxAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INuxAction)

#### Returns[​](#returns "Direct link to Returns")

[`NuxAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NuxAction)

## Properties[​](#properties "Direct link to Properties")

### acknowledged?[​](#acknowledged "Direct link to acknowledged?")

> `optional` **acknowledged**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12442](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12442)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`INuxAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INuxAction).[`acknowledged`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INuxAction#acknowledged)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12448](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12448)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`NuxAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NuxAction)

Defined in: [WAProto/index.d.ts:12443](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12443)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`INuxAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INuxAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`NuxAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NuxAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`NuxAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NuxAction)

Defined in: [WAProto/index.d.ts:12445](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12445)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`NuxAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NuxAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12444](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12444)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`INuxAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INuxAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`NuxAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NuxAction)

Defined in: [WAProto/index.d.ts:12446](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12446)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`NuxAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NuxAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12449](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12449)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12447](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12447)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`NuxAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/NuxAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-paymentinfoaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentInfoAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentInfoAction)

Defined in: [WAProto/index.d.ts:12456](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12456)

## Implements[​](#implements "Direct link to Implements")

*   [`IPaymentInfoAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentInfoAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new PaymentInfoAction()[​](#new-paymentinfoaction "Direct link to new PaymentInfoAction()")

> **new PaymentInfoAction**(`p`?): [`PaymentInfoAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentInfoAction)

Defined in: [WAProto/index.d.ts:12457](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12457)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPaymentInfoAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentInfoAction)

#### Returns[​](#returns "Direct link to Returns")

[`PaymentInfoAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentInfoAction)

## Properties[​](#properties "Direct link to Properties")

### cpi?[​](#cpi "Direct link to cpi?")

> `optional` **cpi**: `null` | `string`

Defined in: [WAProto/index.d.ts:12458](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12458)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPaymentInfoAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentInfoAction).[`cpi`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentInfoAction#cpi)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12464](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12464)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PaymentInfoAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentInfoAction)

Defined in: [WAProto/index.d.ts:12459](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12459)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPaymentInfoAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentInfoAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PaymentInfoAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentInfoAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PaymentInfoAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentInfoAction)

Defined in: [WAProto/index.d.ts:12461](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12461)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PaymentInfoAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentInfoAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12460](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12460)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPaymentInfoAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentInfoAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PaymentInfoAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentInfoAction)

Defined in: [WAProto/index.d.ts:12462](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12462)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PaymentInfoAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentInfoAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12465](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12465)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12463](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12463)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PaymentInfoAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentInfoAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-paymenttosaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentTosAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentTosAction)

Defined in: [WAProto/index.d.ts:12473](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12473)

## Implements[​](#implements "Direct link to Implements")

*   [`IPaymentTosAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentTosAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new PaymentTosAction()[​](#new-paymenttosaction "Direct link to new PaymentTosAction()")

> **new PaymentTosAction**(`p`?): [`PaymentTosAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentTosAction)

Defined in: [WAProto/index.d.ts:12474](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12474)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPaymentTosAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentTosAction)

#### Returns[​](#returns "Direct link to Returns")

[`PaymentTosAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentTosAction)

## Properties[​](#properties "Direct link to Properties")

### accepted[​](#accepted "Direct link to accepted")

> **accepted**: `boolean`

Defined in: [WAProto/index.d.ts:12476](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12476)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPaymentTosAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentTosAction).[`accepted`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentTosAction#accepted)

* * *

### paymentNotice[​](#paymentnotice "Direct link to paymentNotice")

> **paymentNotice**: [`BR_PAY_PRIVACY_POLICY`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/PaymentTosAction/enumerations/PaymentNotice#br_pay_privacy_policy)

Defined in: [WAProto/index.d.ts:12475](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12475)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IPaymentTosAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentTosAction).[`paymentNotice`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentTosAction#paymentnotice)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12482](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12482)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PaymentTosAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentTosAction)

Defined in: [WAProto/index.d.ts:12477](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12477)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPaymentTosAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentTosAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PaymentTosAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentTosAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PaymentTosAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentTosAction)

Defined in: [WAProto/index.d.ts:12479](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12479)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PaymentTosAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentTosAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12478](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12478)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPaymentTosAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentTosAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PaymentTosAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentTosAction)

Defined in: [WAProto/index.d.ts:12480](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12480)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PaymentTosAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentTosAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12483](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12483)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12481](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12481)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PaymentTosAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PaymentTosAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pinaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PinAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PinAction)

Defined in: [WAProto/index.d.ts:12497](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12497)

## Implements[​](#implements "Direct link to Implements")

*   [`IPinAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPinAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new PinAction()[​](#new-pinaction "Direct link to new PinAction()")

> **new PinAction**(`p`?): [`PinAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PinAction)

Defined in: [WAProto/index.d.ts:12498](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12498)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPinAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPinAction)

#### Returns[​](#returns "Direct link to Returns")

[`PinAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PinAction)

## Properties[​](#properties "Direct link to Properties")

### pinned?[​](#pinned "Direct link to pinned?")

> `optional` **pinned**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12499](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12499)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPinAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPinAction).[`pinned`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPinAction#pinned)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12505](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12505)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PinAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PinAction)

Defined in: [WAProto/index.d.ts:12500](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12500)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPinAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPinAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PinAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PinAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PinAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PinAction)

Defined in: [WAProto/index.d.ts:12502](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12502)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PinAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PinAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12501](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12501)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPinAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPinAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PinAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PinAction)

Defined in: [WAProto/index.d.ts:12503](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12503)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PinAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PinAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12506](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12506)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12504](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12504)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PinAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PinAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pnforlidchataction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PnForLidChatAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PnForLidChatAction)

Defined in: [WAProto/index.d.ts:12513](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12513)

## Implements[​](#implements "Direct link to Implements")

*   [`IPnForLidChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPnForLidChatAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new PnForLidChatAction()[​](#new-pnforlidchataction "Direct link to new PnForLidChatAction()")

> **new PnForLidChatAction**(`p`?): [`PnForLidChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PnForLidChatAction)

Defined in: [WAProto/index.d.ts:12514](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12514)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPnForLidChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPnForLidChatAction)

#### Returns[​](#returns "Direct link to Returns")

[`PnForLidChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PnForLidChatAction)

## Properties[​](#properties "Direct link to Properties")

### pnJid?[​](#pnjid "Direct link to pnJid?")

> `optional` **pnJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:12515](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12515)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPnForLidChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPnForLidChatAction).[`pnJid`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPnForLidChatAction#pnjid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12521](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12521)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PnForLidChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PnForLidChatAction)

Defined in: [WAProto/index.d.ts:12516](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12516)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPnForLidChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPnForLidChatAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PnForLidChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PnForLidChatAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PnForLidChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PnForLidChatAction)

Defined in: [WAProto/index.d.ts:12518](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12518)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PnForLidChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PnForLidChatAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12517](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12517)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPnForLidChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPnForLidChatAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PnForLidChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PnForLidChatAction)

Defined in: [WAProto/index.d.ts:12519](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12519)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PnForLidChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PnForLidChatAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12522](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12522)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12520](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12520)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PnForLidChatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PnForLidChatAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-primaryfeature"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryFeature](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryFeature)

Defined in: [WAProto/index.d.ts:12529](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12529)

## Implements[​](#implements "Direct link to Implements")

*   [`IPrimaryFeature`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryFeature)

## Constructors[​](#constructors "Direct link to Constructors")

### new PrimaryFeature()[​](#new-primaryfeature "Direct link to new PrimaryFeature()")

> **new PrimaryFeature**(`p`?): [`PrimaryFeature`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryFeature)

Defined in: [WAProto/index.d.ts:12530](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12530)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPrimaryFeature`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryFeature)

#### Returns[​](#returns "Direct link to Returns")

[`PrimaryFeature`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryFeature)

## Properties[​](#properties "Direct link to Properties")

### flags[​](#flags "Direct link to flags")

> **flags**: `string`\[\]

Defined in: [WAProto/index.d.ts:12531](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12531)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPrimaryFeature`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryFeature).[`flags`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryFeature#flags)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12537](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12537)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PrimaryFeature`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryFeature)

Defined in: [WAProto/index.d.ts:12532](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12532)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPrimaryFeature`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryFeature)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PrimaryFeature`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryFeature)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PrimaryFeature`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryFeature)

Defined in: [WAProto/index.d.ts:12534](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12534)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PrimaryFeature`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryFeature)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12533](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12533)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPrimaryFeature`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryFeature)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PrimaryFeature`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryFeature)

Defined in: [WAProto/index.d.ts:12535](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12535)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PrimaryFeature`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryFeature)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12538](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12538)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12536](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12536)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PrimaryFeature`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryFeature)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-primaryversionaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryVersionAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryVersionAction)

Defined in: [WAProto/index.d.ts:12545](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12545)

## Implements[​](#implements "Direct link to Implements")

*   [`IPrimaryVersionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryVersionAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new PrimaryVersionAction()[​](#new-primaryversionaction "Direct link to new PrimaryVersionAction()")

> **new PrimaryVersionAction**(`p`?): [`PrimaryVersionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryVersionAction)

Defined in: [WAProto/index.d.ts:12546](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12546)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPrimaryVersionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryVersionAction)

#### Returns[​](#returns "Direct link to Returns")

[`PrimaryVersionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryVersionAction)

## Properties[​](#properties "Direct link to Properties")

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | `string`

Defined in: [WAProto/index.d.ts:12547](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12547)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPrimaryVersionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryVersionAction).[`version`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryVersionAction#version)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12553](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12553)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PrimaryVersionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryVersionAction)

Defined in: [WAProto/index.d.ts:12548](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12548)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPrimaryVersionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryVersionAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PrimaryVersionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryVersionAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PrimaryVersionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryVersionAction)

Defined in: [WAProto/index.d.ts:12550](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12550)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PrimaryVersionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryVersionAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12549](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12549)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPrimaryVersionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryVersionAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PrimaryVersionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryVersionAction)

Defined in: [WAProto/index.d.ts:12551](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12551)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PrimaryVersionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryVersionAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12554](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12554)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12552](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12552)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PrimaryVersionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrimaryVersionAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-privacysettingchannelspersonalisedrecommendationaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingChannelsPersonalisedRecommendationAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingChannelsPersonalisedRecommendationAction)

Defined in: [WAProto/index.d.ts:12561](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12561)

## Implements[​](#implements "Direct link to Implements")

*   [`IPrivacySettingChannelsPersonalisedRecommendationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingChannelsPersonalisedRecommendationAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new PrivacySettingChannelsPersonalisedRecommendationAction()[​](#new-privacysettingchannelspersonalisedrecommendationaction "Direct link to new PrivacySettingChannelsPersonalisedRecommendationAction()")

> **new PrivacySettingChannelsPersonalisedRecommendationAction**(`p`?): [`PrivacySettingChannelsPersonalisedRecommendationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingChannelsPersonalisedRecommendationAction)

Defined in: [WAProto/index.d.ts:12562](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12562)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPrivacySettingChannelsPersonalisedRecommendationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingChannelsPersonalisedRecommendationAction)

#### Returns[​](#returns "Direct link to Returns")

[`PrivacySettingChannelsPersonalisedRecommendationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingChannelsPersonalisedRecommendationAction)

## Properties[​](#properties "Direct link to Properties")

### isUserOptedOut?[​](#isuseroptedout "Direct link to isUserOptedOut?")

> `optional` **isUserOptedOut**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12563](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12563)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPrivacySettingChannelsPersonalisedRecommendationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingChannelsPersonalisedRecommendationAction).[`isUserOptedOut`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingChannelsPersonalisedRecommendationAction#isuseroptedout)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12569](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12569)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PrivacySettingChannelsPersonalisedRecommendationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingChannelsPersonalisedRecommendationAction)

Defined in: [WAProto/index.d.ts:12564](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12564)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPrivacySettingChannelsPersonalisedRecommendationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingChannelsPersonalisedRecommendationAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PrivacySettingChannelsPersonalisedRecommendationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingChannelsPersonalisedRecommendationAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PrivacySettingChannelsPersonalisedRecommendationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingChannelsPersonalisedRecommendationAction)

Defined in: [WAProto/index.d.ts:12566](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12566)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PrivacySettingChannelsPersonalisedRecommendationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingChannelsPersonalisedRecommendationAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12565](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12565)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPrivacySettingChannelsPersonalisedRecommendationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingChannelsPersonalisedRecommendationAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PrivacySettingChannelsPersonalisedRecommendationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingChannelsPersonalisedRecommendationAction)

Defined in: [WAProto/index.d.ts:12567](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12567)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PrivacySettingChannelsPersonalisedRecommendationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingChannelsPersonalisedRecommendationAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12570](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12570)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12568](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12568)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PrivacySettingChannelsPersonalisedRecommendationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingChannelsPersonalisedRecommendationAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-privacysettingdisablelinkpreviewsaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingDisableLinkPreviewsAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingDisableLinkPreviewsAction)

Defined in: [WAProto/index.d.ts:12577](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12577)

## Implements[​](#implements "Direct link to Implements")

*   [`IPrivacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingDisableLinkPreviewsAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new PrivacySettingDisableLinkPreviewsAction()[​](#new-privacysettingdisablelinkpreviewsaction "Direct link to new PrivacySettingDisableLinkPreviewsAction()")

> **new PrivacySettingDisableLinkPreviewsAction**(`p`?): [`PrivacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingDisableLinkPreviewsAction)

Defined in: [WAProto/index.d.ts:12578](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12578)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPrivacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingDisableLinkPreviewsAction)

#### Returns[​](#returns "Direct link to Returns")

[`PrivacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingDisableLinkPreviewsAction)

## Properties[​](#properties "Direct link to Properties")

### isPreviewsDisabled?[​](#ispreviewsdisabled "Direct link to isPreviewsDisabled?")

> `optional` **isPreviewsDisabled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12579](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12579)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPrivacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingDisableLinkPreviewsAction).[`isPreviewsDisabled`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingDisableLinkPreviewsAction#ispreviewsdisabled)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12585](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12585)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PrivacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingDisableLinkPreviewsAction)

Defined in: [WAProto/index.d.ts:12580](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12580)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPrivacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingDisableLinkPreviewsAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PrivacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingDisableLinkPreviewsAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PrivacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingDisableLinkPreviewsAction)

Defined in: [WAProto/index.d.ts:12582](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12582)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PrivacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingDisableLinkPreviewsAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12581](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12581)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPrivacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingDisableLinkPreviewsAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PrivacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingDisableLinkPreviewsAction)

Defined in: [WAProto/index.d.ts:12583](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12583)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PrivacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingDisableLinkPreviewsAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12586](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12586)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12584](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12584)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PrivacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingDisableLinkPreviewsAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-privacysettingrelayallcalls"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingRelayAllCalls](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingRelayAllCalls)

Defined in: [WAProto/index.d.ts:12593](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12593)

## Implements[​](#implements "Direct link to Implements")

*   [`IPrivacySettingRelayAllCalls`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingRelayAllCalls)

## Constructors[​](#constructors "Direct link to Constructors")

### new PrivacySettingRelayAllCalls()[​](#new-privacysettingrelayallcalls "Direct link to new PrivacySettingRelayAllCalls()")

> **new PrivacySettingRelayAllCalls**(`p`?): [`PrivacySettingRelayAllCalls`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingRelayAllCalls)

Defined in: [WAProto/index.d.ts:12594](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12594)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPrivacySettingRelayAllCalls`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingRelayAllCalls)

#### Returns[​](#returns "Direct link to Returns")

[`PrivacySettingRelayAllCalls`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingRelayAllCalls)

## Properties[​](#properties "Direct link to Properties")

### isEnabled?[​](#isenabled "Direct link to isEnabled?")

> `optional` **isEnabled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12595](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12595)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPrivacySettingRelayAllCalls`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingRelayAllCalls).[`isEnabled`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingRelayAllCalls#isenabled)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12601](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12601)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PrivacySettingRelayAllCalls`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingRelayAllCalls)

Defined in: [WAProto/index.d.ts:12596](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12596)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPrivacySettingRelayAllCalls`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingRelayAllCalls)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PrivacySettingRelayAllCalls`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingRelayAllCalls)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PrivacySettingRelayAllCalls`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingRelayAllCalls)

Defined in: [WAProto/index.d.ts:12598](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12598)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PrivacySettingRelayAllCalls`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingRelayAllCalls)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12597](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12597)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPrivacySettingRelayAllCalls`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingRelayAllCalls)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PrivacySettingRelayAllCalls`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingRelayAllCalls)

Defined in: [WAProto/index.d.ts:12599](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12599)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PrivacySettingRelayAllCalls`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingRelayAllCalls)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12602](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12602)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12600](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12600)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PrivacySettingRelayAllCalls`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivacySettingRelayAllCalls)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-privateprocessingsettingaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivateProcessingSettingAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivateProcessingSettingAction)

Defined in: [WAProto/index.d.ts:12609](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12609)

## Implements[​](#implements "Direct link to Implements")

*   [`IPrivateProcessingSettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivateProcessingSettingAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new PrivateProcessingSettingAction()[​](#new-privateprocessingsettingaction "Direct link to new PrivateProcessingSettingAction()")

> **new PrivateProcessingSettingAction**(`p`?): [`PrivateProcessingSettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivateProcessingSettingAction)

Defined in: [WAProto/index.d.ts:12610](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12610)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPrivateProcessingSettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivateProcessingSettingAction)

#### Returns[​](#returns "Direct link to Returns")

[`PrivateProcessingSettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivateProcessingSettingAction)

## Properties[​](#properties "Direct link to Properties")

### privateProcessingStatus?[​](#privateprocessingstatus "Direct link to privateProcessingStatus?")

> `optional` **privateProcessingStatus**: `null` | [`PrivateProcessingStatus`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/PrivateProcessingSettingAction/enumerations/PrivateProcessingStatus)

Defined in: [WAProto/index.d.ts:12611](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12611)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPrivateProcessingSettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivateProcessingSettingAction).[`privateProcessingStatus`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivateProcessingSettingAction#privateprocessingstatus)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12617](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12617)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PrivateProcessingSettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivateProcessingSettingAction)

Defined in: [WAProto/index.d.ts:12612](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12612)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPrivateProcessingSettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivateProcessingSettingAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PrivateProcessingSettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivateProcessingSettingAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PrivateProcessingSettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivateProcessingSettingAction)

Defined in: [WAProto/index.d.ts:12614](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12614)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PrivateProcessingSettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivateProcessingSettingAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12613](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12613)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPrivateProcessingSettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivateProcessingSettingAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PrivateProcessingSettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivateProcessingSettingAction)

Defined in: [WAProto/index.d.ts:12615](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12615)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PrivateProcessingSettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivateProcessingSettingAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12618](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12618)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12616](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12616)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PrivateProcessingSettingAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PrivateProcessingSettingAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-pushnamesetting"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PushNameSetting](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PushNameSetting)

Defined in: [WAProto/index.d.ts:12634](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12634)

## Implements[​](#implements "Direct link to Implements")

*   [`IPushNameSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPushNameSetting)

## Constructors[​](#constructors "Direct link to Constructors")

### new PushNameSetting()[​](#new-pushnamesetting "Direct link to new PushNameSetting()")

> **new PushNameSetting**(`p`?): [`PushNameSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PushNameSetting)

Defined in: [WAProto/index.d.ts:12635](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12635)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IPushNameSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPushNameSetting)

#### Returns[​](#returns "Direct link to Returns")

[`PushNameSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PushNameSetting)

## Properties[​](#properties "Direct link to Properties")

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:12636](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12636)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IPushNameSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPushNameSetting).[`name`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPushNameSetting#name)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12642](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12642)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`PushNameSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PushNameSetting)

Defined in: [WAProto/index.d.ts:12637](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12637)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IPushNameSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPushNameSetting)

#### Returns[​](#returns-2 "Direct link to Returns")

[`PushNameSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PushNameSetting)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`PushNameSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PushNameSetting)

Defined in: [WAProto/index.d.ts:12639](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12639)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`PushNameSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PushNameSetting)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12638](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12638)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IPushNameSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPushNameSetting)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`PushNameSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PushNameSetting)

Defined in: [WAProto/index.d.ts:12640](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12640)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`PushNameSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PushNameSetting)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12643](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12643)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12641](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12641)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`PushNameSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/PushNameSetting)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-quickreplyaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/QuickReplyAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/QuickReplyAction)

Defined in: [WAProto/index.d.ts:12654](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12654)

## Implements[​](#implements "Direct link to Implements")

*   [`IQuickReplyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IQuickReplyAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new QuickReplyAction()[​](#new-quickreplyaction "Direct link to new QuickReplyAction()")

> **new QuickReplyAction**(`p`?): [`QuickReplyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/QuickReplyAction)

Defined in: [WAProto/index.d.ts:12655](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12655)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IQuickReplyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IQuickReplyAction)

#### Returns[​](#returns "Direct link to Returns")

[`QuickReplyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/QuickReplyAction)

## Properties[​](#properties "Direct link to Properties")

### count?[​](#count "Direct link to count?")

> `optional` **count**: `null` | `number`

Defined in: [WAProto/index.d.ts:12659](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12659)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IQuickReplyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IQuickReplyAction).[`count`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IQuickReplyAction#count)

* * *

### deleted?[​](#deleted "Direct link to deleted?")

> `optional` **deleted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12660](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12660)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IQuickReplyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IQuickReplyAction).[`deleted`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IQuickReplyAction#deleted)

* * *

### keywords[​](#keywords "Direct link to keywords")

> **keywords**: `string`\[\]

Defined in: [WAProto/index.d.ts:12658](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12658)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IQuickReplyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IQuickReplyAction).[`keywords`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IQuickReplyAction#keywords)

* * *

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | `string`

Defined in: [WAProto/index.d.ts:12657](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12657)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IQuickReplyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IQuickReplyAction).[`message`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IQuickReplyAction#message)

* * *

### shortcut?[​](#shortcut "Direct link to shortcut?")

> `optional` **shortcut**: `null` | `string`

Defined in: [WAProto/index.d.ts:12656](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12656)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IQuickReplyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IQuickReplyAction).[`shortcut`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IQuickReplyAction#shortcut)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12666](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12666)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`QuickReplyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/QuickReplyAction)

Defined in: [WAProto/index.d.ts:12661](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12661)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IQuickReplyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IQuickReplyAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`QuickReplyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/QuickReplyAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`QuickReplyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/QuickReplyAction)

Defined in: [WAProto/index.d.ts:12663](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12663)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`QuickReplyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/QuickReplyAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12662](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12662)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IQuickReplyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IQuickReplyAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`QuickReplyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/QuickReplyAction)

Defined in: [WAProto/index.d.ts:12664](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12664)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`QuickReplyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/QuickReplyAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12667](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12667)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12665](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12665)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`QuickReplyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/QuickReplyAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-recentemojiweightsaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RecentEmojiWeightsAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RecentEmojiWeightsAction)

Defined in: [WAProto/index.d.ts:12674](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12674)

## Implements[​](#implements "Direct link to Implements")

*   [`IRecentEmojiWeightsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRecentEmojiWeightsAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new RecentEmojiWeightsAction()[​](#new-recentemojiweightsaction "Direct link to new RecentEmojiWeightsAction()")

> **new RecentEmojiWeightsAction**(`p`?): [`RecentEmojiWeightsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RecentEmojiWeightsAction)

Defined in: [WAProto/index.d.ts:12675](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12675)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IRecentEmojiWeightsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRecentEmojiWeightsAction)

#### Returns[​](#returns "Direct link to Returns")

[`RecentEmojiWeightsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RecentEmojiWeightsAction)

## Properties[​](#properties "Direct link to Properties")

### weights[​](#weights "Direct link to weights")

> **weights**: [`IRecentEmojiWeight`](/docs/api/namespaces/proto/interfaces/IRecentEmojiWeight)\[\]

Defined in: [WAProto/index.d.ts:12676](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12676)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IRecentEmojiWeightsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRecentEmojiWeightsAction).[`weights`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRecentEmojiWeightsAction#weights)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12682](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12682)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`RecentEmojiWeightsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RecentEmojiWeightsAction)

Defined in: [WAProto/index.d.ts:12677](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12677)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IRecentEmojiWeightsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRecentEmojiWeightsAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`RecentEmojiWeightsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RecentEmojiWeightsAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`RecentEmojiWeightsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RecentEmojiWeightsAction)

Defined in: [WAProto/index.d.ts:12679](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12679)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`RecentEmojiWeightsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RecentEmojiWeightsAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12678](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12678)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IRecentEmojiWeightsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRecentEmojiWeightsAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`RecentEmojiWeightsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RecentEmojiWeightsAction)

Defined in: [WAProto/index.d.ts:12680](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12680)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`RecentEmojiWeightsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RecentEmojiWeightsAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12683](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12683)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12681](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12681)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`RecentEmojiWeightsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RecentEmojiWeightsAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-removerecentstickeraction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RemoveRecentStickerAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RemoveRecentStickerAction)

Defined in: [WAProto/index.d.ts:12690](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12690)

## Implements[​](#implements "Direct link to Implements")

*   [`IRemoveRecentStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRemoveRecentStickerAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new RemoveRecentStickerAction()[​](#new-removerecentstickeraction "Direct link to new RemoveRecentStickerAction()")

> **new RemoveRecentStickerAction**(`p`?): [`RemoveRecentStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RemoveRecentStickerAction)

Defined in: [WAProto/index.d.ts:12691](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12691)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IRemoveRecentStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRemoveRecentStickerAction)

#### Returns[​](#returns "Direct link to Returns")

[`RemoveRecentStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RemoveRecentStickerAction)

## Properties[​](#properties "Direct link to Properties")

### lastStickerSentTs?[​](#laststickersentts "Direct link to lastStickerSentTs?")

> `optional` **lastStickerSentTs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12692](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12692)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IRemoveRecentStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRemoveRecentStickerAction).[`lastStickerSentTs`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRemoveRecentStickerAction#laststickersentts)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12698](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12698)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`RemoveRecentStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RemoveRecentStickerAction)

Defined in: [WAProto/index.d.ts:12693](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12693)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IRemoveRecentStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRemoveRecentStickerAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`RemoveRecentStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RemoveRecentStickerAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`RemoveRecentStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RemoveRecentStickerAction)

Defined in: [WAProto/index.d.ts:12695](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12695)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`RemoveRecentStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RemoveRecentStickerAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12694](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12694)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IRemoveRecentStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRemoveRecentStickerAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`RemoveRecentStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RemoveRecentStickerAction)

Defined in: [WAProto/index.d.ts:12696](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12696)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`RemoveRecentStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RemoveRecentStickerAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12699](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12699)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12697](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12697)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`RemoveRecentStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/RemoveRecentStickerAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-staraction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StarAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StarAction)

Defined in: [WAProto/index.d.ts:12706](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12706)

## Implements[​](#implements "Direct link to Implements")

*   [`IStarAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStarAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new StarAction()[​](#new-staraction "Direct link to new StarAction()")

> **new StarAction**(`p`?): [`StarAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StarAction)

Defined in: [WAProto/index.d.ts:12707](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12707)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IStarAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStarAction)

#### Returns[​](#returns "Direct link to Returns")

[`StarAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StarAction)

## Properties[​](#properties "Direct link to Properties")

### starred?[​](#starred "Direct link to starred?")

> `optional` **starred**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12708](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12708)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IStarAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStarAction).[`starred`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStarAction#starred)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12714](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12714)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`StarAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StarAction)

Defined in: [WAProto/index.d.ts:12709](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12709)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IStarAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStarAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`StarAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StarAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`StarAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StarAction)

Defined in: [WAProto/index.d.ts:12711](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12711)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`StarAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StarAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12710](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12710)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IStarAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStarAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`StarAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StarAction)

Defined in: [WAProto/index.d.ts:12712](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12712)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`StarAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StarAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12715](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12715)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12713](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12713)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`StarAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StarAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-statuspostoptinnotificationpreferencesaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPostOptInNotificationPreferencesAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPostOptInNotificationPreferencesAction)

Defined in: [WAProto/index.d.ts:12722](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12722)

## Implements[​](#implements "Direct link to Implements")

*   [`IStatusPostOptInNotificationPreferencesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPostOptInNotificationPreferencesAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new StatusPostOptInNotificationPreferencesAction()[​](#new-statuspostoptinnotificationpreferencesaction "Direct link to new StatusPostOptInNotificationPreferencesAction()")

> **new StatusPostOptInNotificationPreferencesAction**(`p`?): [`StatusPostOptInNotificationPreferencesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPostOptInNotificationPreferencesAction)

Defined in: [WAProto/index.d.ts:12723](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12723)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IStatusPostOptInNotificationPreferencesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPostOptInNotificationPreferencesAction)

#### Returns[​](#returns "Direct link to Returns")

[`StatusPostOptInNotificationPreferencesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPostOptInNotificationPreferencesAction)

## Properties[​](#properties "Direct link to Properties")

### enabled?[​](#enabled "Direct link to enabled?")

> `optional` **enabled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12724](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12724)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IStatusPostOptInNotificationPreferencesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPostOptInNotificationPreferencesAction).[`enabled`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPostOptInNotificationPreferencesAction#enabled)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12730](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12730)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`StatusPostOptInNotificationPreferencesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPostOptInNotificationPreferencesAction)

Defined in: [WAProto/index.d.ts:12725](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12725)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IStatusPostOptInNotificationPreferencesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPostOptInNotificationPreferencesAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`StatusPostOptInNotificationPreferencesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPostOptInNotificationPreferencesAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`StatusPostOptInNotificationPreferencesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPostOptInNotificationPreferencesAction)

Defined in: [WAProto/index.d.ts:12727](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12727)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`StatusPostOptInNotificationPreferencesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPostOptInNotificationPreferencesAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12726](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12726)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IStatusPostOptInNotificationPreferencesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPostOptInNotificationPreferencesAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`StatusPostOptInNotificationPreferencesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPostOptInNotificationPreferencesAction)

Defined in: [WAProto/index.d.ts:12728](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12728)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`StatusPostOptInNotificationPreferencesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPostOptInNotificationPreferencesAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12731](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12731)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12729](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12729)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`StatusPostOptInNotificationPreferencesAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPostOptInNotificationPreferencesAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-statusprivacyaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPrivacyAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPrivacyAction)

Defined in: [WAProto/index.d.ts:12739](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12739)

## Implements[​](#implements "Direct link to Implements")

*   [`IStatusPrivacyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPrivacyAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new StatusPrivacyAction()[​](#new-statusprivacyaction "Direct link to new StatusPrivacyAction()")

> **new StatusPrivacyAction**(`p`?): [`StatusPrivacyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPrivacyAction)

Defined in: [WAProto/index.d.ts:12740](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12740)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IStatusPrivacyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPrivacyAction)

#### Returns[​](#returns "Direct link to Returns")

[`StatusPrivacyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPrivacyAction)

## Properties[​](#properties "Direct link to Properties")

### mode?[​](#mode "Direct link to mode?")

> `optional` **mode**: `null` | [`StatusDistributionMode`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/StatusPrivacyAction/enumerations/StatusDistributionMode)

Defined in: [WAProto/index.d.ts:12741](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12741)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IStatusPrivacyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPrivacyAction).[`mode`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPrivacyAction#mode)

* * *

### userJid[​](#userjid "Direct link to userJid")

> **userJid**: `string`\[\]

Defined in: [WAProto/index.d.ts:12742](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12742)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IStatusPrivacyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPrivacyAction).[`userJid`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPrivacyAction#userjid)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12748](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12748)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`StatusPrivacyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPrivacyAction)

Defined in: [WAProto/index.d.ts:12743](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12743)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IStatusPrivacyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPrivacyAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`StatusPrivacyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPrivacyAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`StatusPrivacyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPrivacyAction)

Defined in: [WAProto/index.d.ts:12745](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12745)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`StatusPrivacyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPrivacyAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12744](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12744)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IStatusPrivacyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPrivacyAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`StatusPrivacyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPrivacyAction)

Defined in: [WAProto/index.d.ts:12746](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12746)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`StatusPrivacyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPrivacyAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12749](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12749)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12747](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12747)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`StatusPrivacyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StatusPrivacyAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-stickeraction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StickerAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StickerAction)

Defined in: [WAProto/index.d.ts:12778](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12778)

## Implements[​](#implements "Direct link to Implements")

*   [`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new StickerAction()[​](#new-stickeraction "Direct link to new StickerAction()")

> **new StickerAction**(`p`?): [`StickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StickerAction)

Defined in: [WAProto/index.d.ts:12779](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12779)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction)

#### Returns[​](#returns "Direct link to Returns")

[`StickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StickerAction)

## Properties[​](#properties "Direct link to Properties")

### deviceIdHint?[​](#deviceidhint "Direct link to deviceIdHint?")

> `optional` **deviceIdHint**: `null` | `number`

Defined in: [WAProto/index.d.ts:12789](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12789)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction).[`deviceIdHint`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction#deviceidhint)

* * *

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:12786](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12786)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction).[`directPath`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction#directpath)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:12781](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12781)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction).[`fileEncSha256`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction#fileencsha256)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12787](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12787)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction).[`fileLength`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction#filelength)

* * *

### height?[​](#height "Direct link to height?")

> `optional` **height**: `null` | `number`

Defined in: [WAProto/index.d.ts:12784](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12784)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction).[`height`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction#height)

* * *

### imageHash?[​](#imagehash "Direct link to imageHash?")

> `optional` **imageHash**: `null` | `string`

Defined in: [WAProto/index.d.ts:12791](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12791)

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction).[`imageHash`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction#imagehash)

* * *

### isAvatarSticker?[​](#isavatarsticker "Direct link to isAvatarSticker?")

> `optional` **isAvatarSticker**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12792](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12792)

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction).[`isAvatarSticker`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction#isavatarsticker)

* * *

### isFavorite?[​](#isfavorite "Direct link to isFavorite?")

> `optional` **isFavorite**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12788](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12788)

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction).[`isFavorite`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction#isfavorite)

* * *

### isLottie?[​](#islottie "Direct link to isLottie?")

> `optional` **isLottie**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12790](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12790)

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction).[`isLottie`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction#islottie)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:12782](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12782)

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction).[`mediaKey`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction#mediakey)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:12783](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12783)

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction).[`mimetype`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction#mimetype)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:12780](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12780)

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction).[`url`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction#url)

* * *

### width?[​](#width "Direct link to width?")

> `optional` **width**: `null` | `number`

Defined in: [WAProto/index.d.ts:12785](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12785)

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction).[`width`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction#width)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12798](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12798)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`StickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StickerAction)

Defined in: [WAProto/index.d.ts:12793](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12793)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`StickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StickerAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`StickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StickerAction)

Defined in: [WAProto/index.d.ts:12795](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12795)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`StickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StickerAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12794](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12794)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`StickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StickerAction)

Defined in: [WAProto/index.d.ts:12796](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12796)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`StickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StickerAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12799](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12799)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12797](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12797)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`StickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/StickerAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-subscriptionaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SubscriptionAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SubscriptionAction)

Defined in: [WAProto/index.d.ts:12808](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12808)

## Implements[​](#implements "Direct link to Implements")

*   [`ISubscriptionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISubscriptionAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new SubscriptionAction()[​](#new-subscriptionaction "Direct link to new SubscriptionAction()")

> **new SubscriptionAction**(`p`?): [`SubscriptionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SubscriptionAction)

Defined in: [WAProto/index.d.ts:12809](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12809)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISubscriptionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISubscriptionAction)

#### Returns[​](#returns "Direct link to Returns")

[`SubscriptionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SubscriptionAction)

## Properties[​](#properties "Direct link to Properties")

### expirationDate?[​](#expirationdate "Direct link to expirationDate?")

> `optional` **expirationDate**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12812](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12812)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISubscriptionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISubscriptionAction).[`expirationDate`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISubscriptionAction#expirationdate)

* * *

### isAutoRenewing?[​](#isautorenewing "Direct link to isAutoRenewing?")

> `optional` **isAutoRenewing**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12811](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12811)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISubscriptionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISubscriptionAction).[`isAutoRenewing`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISubscriptionAction#isautorenewing)

* * *

### isDeactivated?[​](#isdeactivated "Direct link to isDeactivated?")

> `optional` **isDeactivated**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12810](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12810)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ISubscriptionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISubscriptionAction).[`isDeactivated`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISubscriptionAction#isdeactivated)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12818](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12818)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SubscriptionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SubscriptionAction)

Defined in: [WAProto/index.d.ts:12813](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12813)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISubscriptionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISubscriptionAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SubscriptionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SubscriptionAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SubscriptionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SubscriptionAction)

Defined in: [WAProto/index.d.ts:12815](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12815)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SubscriptionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SubscriptionAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12814](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12814)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISubscriptionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISubscriptionAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SubscriptionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SubscriptionAction)

Defined in: [WAProto/index.d.ts:12816](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12816)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SubscriptionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SubscriptionAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12819](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12819)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12817](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12817)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SubscriptionAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SubscriptionAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-syncactionmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessage)

Defined in: [WAProto/index.d.ts:12827](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12827)

## Implements[​](#implements "Direct link to Implements")

*   [`ISyncActionMessage`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessage)

## Constructors[​](#constructors "Direct link to Constructors")

### new SyncActionMessage()[​](#new-syncactionmessage "Direct link to new SyncActionMessage()")

> **new SyncActionMessage**(`p`?): [`SyncActionMessage`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessage)

Defined in: [WAProto/index.d.ts:12828](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12828)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISyncActionMessage`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessage)

#### Returns[​](#returns "Direct link to Returns")

[`SyncActionMessage`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessage)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:12829](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12829)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISyncActionMessage`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessage).[`key`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessage#key)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12830](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12830)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISyncActionMessage`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessage).[`timestamp`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessage#timestamp)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12836](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12836)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SyncActionMessage`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessage)

Defined in: [WAProto/index.d.ts:12831](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12831)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISyncActionMessage`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessage)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SyncActionMessage`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessage)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SyncActionMessage`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessage)

Defined in: [WAProto/index.d.ts:12833](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12833)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SyncActionMessage`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessage)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12832](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12832)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISyncActionMessage`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessage)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SyncActionMessage`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessage)

Defined in: [WAProto/index.d.ts:12834](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12834)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SyncActionMessage`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessage)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12837](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12837)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12835](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12835)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SyncActionMessage`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessage)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-syncactionmessagerange"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessageRange](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessageRange)

Defined in: [WAProto/index.d.ts:12846](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12846)

## Implements[​](#implements "Direct link to Implements")

*   [`ISyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange)

## Constructors[​](#constructors "Direct link to Constructors")

### new SyncActionMessageRange()[​](#new-syncactionmessagerange "Direct link to new SyncActionMessageRange()")

> **new SyncActionMessageRange**(`p`?): [`SyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessageRange)

Defined in: [WAProto/index.d.ts:12847](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12847)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ISyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange)

#### Returns[​](#returns "Direct link to Returns")

[`SyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessageRange)

## Properties[​](#properties "Direct link to Properties")

### lastMessageTimestamp?[​](#lastmessagetimestamp "Direct link to lastMessageTimestamp?")

> `optional` **lastMessageTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12848](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12848)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ISyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange).[`lastMessageTimestamp`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange#lastmessagetimestamp)

* * *

### lastSystemMessageTimestamp?[​](#lastsystemmessagetimestamp "Direct link to lastSystemMessageTimestamp?")

> `optional` **lastSystemMessageTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12849](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12849)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ISyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange).[`lastSystemMessageTimestamp`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange#lastsystemmessagetimestamp)

* * *

### messages[​](#messages "Direct link to messages")

> **messages**: [`ISyncActionMessage`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessage)\[\]

Defined in: [WAProto/index.d.ts:12850](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12850)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ISyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange).[`messages`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange#messages)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12856](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12856)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`SyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessageRange)

Defined in: [WAProto/index.d.ts:12851](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12851)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ISyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange)

#### Returns[​](#returns-2 "Direct link to Returns")

[`SyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessageRange)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`SyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessageRange)

Defined in: [WAProto/index.d.ts:12853](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12853)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`SyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessageRange)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12852](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12852)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ISyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`SyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessageRange)

Defined in: [WAProto/index.d.ts:12854](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12854)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`SyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessageRange)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12857](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12857)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12855](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12855)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`SyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/SyncActionMessageRange)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-timeformataction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/TimeFormatAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/TimeFormatAction)

Defined in: [WAProto/index.d.ts:12864](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12864)

## Implements[​](#implements "Direct link to Implements")

*   [`ITimeFormatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ITimeFormatAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new TimeFormatAction()[​](#new-timeformataction "Direct link to new TimeFormatAction()")

> **new TimeFormatAction**(`p`?): [`TimeFormatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/TimeFormatAction)

Defined in: [WAProto/index.d.ts:12865](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12865)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ITimeFormatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ITimeFormatAction)

#### Returns[​](#returns "Direct link to Returns")

[`TimeFormatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/TimeFormatAction)

## Properties[​](#properties "Direct link to Properties")

### isTwentyFourHourFormatEnabled?[​](#istwentyfourhourformatenabled "Direct link to isTwentyFourHourFormatEnabled?")

> `optional` **isTwentyFourHourFormatEnabled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12866](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12866)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ITimeFormatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ITimeFormatAction).[`isTwentyFourHourFormatEnabled`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ITimeFormatAction#istwentyfourhourformatenabled)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12872](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12872)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`TimeFormatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/TimeFormatAction)

Defined in: [WAProto/index.d.ts:12867](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12867)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ITimeFormatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ITimeFormatAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`TimeFormatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/TimeFormatAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`TimeFormatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/TimeFormatAction)

Defined in: [WAProto/index.d.ts:12869](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12869)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`TimeFormatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/TimeFormatAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12868](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12868)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ITimeFormatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ITimeFormatAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`TimeFormatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/TimeFormatAction)

Defined in: [WAProto/index.d.ts:12870](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12870)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`TimeFormatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/TimeFormatAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12873](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12873)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12871](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12871)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`TimeFormatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/TimeFormatAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-ugcbot"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UGCBot](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UGCBot)

Defined in: [WAProto/index.d.ts:12880](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12880)

## Implements[​](#implements "Direct link to Implements")

*   [`IUGCBot`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUGCBot)

## Constructors[​](#constructors "Direct link to Constructors")

### new UGCBot()[​](#new-ugcbot "Direct link to new UGCBot()")

> **new UGCBot**(`p`?): [`UGCBot`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UGCBot)

Defined in: [WAProto/index.d.ts:12881](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12881)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IUGCBot`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUGCBot)

#### Returns[​](#returns "Direct link to Returns")

[`UGCBot`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UGCBot)

## Properties[​](#properties "Direct link to Properties")

### definition?[​](#definition "Direct link to definition?")

> `optional` **definition**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:12882](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12882)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IUGCBot`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUGCBot).[`definition`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUGCBot#definition)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12888](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12888)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`UGCBot`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UGCBot)

Defined in: [WAProto/index.d.ts:12883](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12883)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IUGCBot`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUGCBot)

#### Returns[​](#returns-2 "Direct link to Returns")

[`UGCBot`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UGCBot)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`UGCBot`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UGCBot)

Defined in: [WAProto/index.d.ts:12885](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12885)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`UGCBot`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UGCBot)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12884](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12884)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IUGCBot`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUGCBot)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`UGCBot`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UGCBot)

Defined in: [WAProto/index.d.ts:12886](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12886)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`UGCBot`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UGCBot)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12889](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12889)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12887](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12887)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`UGCBot`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UGCBot)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-unarchivechatssetting"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UnarchiveChatsSetting](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UnarchiveChatsSetting)

Defined in: [WAProto/index.d.ts:12896](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12896)

## Implements[​](#implements "Direct link to Implements")

*   [`IUnarchiveChatsSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUnarchiveChatsSetting)

## Constructors[​](#constructors "Direct link to Constructors")

### new UnarchiveChatsSetting()[​](#new-unarchivechatssetting "Direct link to new UnarchiveChatsSetting()")

> **new UnarchiveChatsSetting**(`p`?): [`UnarchiveChatsSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UnarchiveChatsSetting)

Defined in: [WAProto/index.d.ts:12897](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12897)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IUnarchiveChatsSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUnarchiveChatsSetting)

#### Returns[​](#returns "Direct link to Returns")

[`UnarchiveChatsSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UnarchiveChatsSetting)

## Properties[​](#properties "Direct link to Properties")

### unarchiveChats?[​](#unarchivechats "Direct link to unarchiveChats?")

> `optional` **unarchiveChats**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12898](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12898)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IUnarchiveChatsSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUnarchiveChatsSetting).[`unarchiveChats`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUnarchiveChatsSetting#unarchivechats)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12904](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12904)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`UnarchiveChatsSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UnarchiveChatsSetting)

Defined in: [WAProto/index.d.ts:12899](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12899)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IUnarchiveChatsSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUnarchiveChatsSetting)

#### Returns[​](#returns-2 "Direct link to Returns")

[`UnarchiveChatsSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UnarchiveChatsSetting)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`UnarchiveChatsSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UnarchiveChatsSetting)

Defined in: [WAProto/index.d.ts:12901](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12901)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`UnarchiveChatsSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UnarchiveChatsSetting)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12900](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12900)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IUnarchiveChatsSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUnarchiveChatsSetting)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`UnarchiveChatsSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UnarchiveChatsSetting)

Defined in: [WAProto/index.d.ts:12902](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12902)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`UnarchiveChatsSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UnarchiveChatsSetting)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12905](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12905)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12903](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12903)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`UnarchiveChatsSetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UnarchiveChatsSetting)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-userstatusmuteaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UserStatusMuteAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UserStatusMuteAction)

Defined in: [WAProto/index.d.ts:12912](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12912)

## Implements[​](#implements "Direct link to Implements")

*   [`IUserStatusMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUserStatusMuteAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new UserStatusMuteAction()[​](#new-userstatusmuteaction "Direct link to new UserStatusMuteAction()")

> **new UserStatusMuteAction**(`p`?): [`UserStatusMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UserStatusMuteAction)

Defined in: [WAProto/index.d.ts:12913](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12913)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IUserStatusMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUserStatusMuteAction)

#### Returns[​](#returns "Direct link to Returns")

[`UserStatusMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UserStatusMuteAction)

## Properties[​](#properties "Direct link to Properties")

### muted?[​](#muted "Direct link to muted?")

> `optional` **muted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12914](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12914)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IUserStatusMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUserStatusMuteAction).[`muted`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUserStatusMuteAction#muted)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12920](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12920)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`UserStatusMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UserStatusMuteAction)

Defined in: [WAProto/index.d.ts:12915](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12915)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IUserStatusMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUserStatusMuteAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`UserStatusMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UserStatusMuteAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`UserStatusMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UserStatusMuteAction)

Defined in: [WAProto/index.d.ts:12917](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12917)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`UserStatusMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UserStatusMuteAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12916](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12916)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IUserStatusMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUserStatusMuteAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`UserStatusMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UserStatusMuteAction)

Defined in: [WAProto/index.d.ts:12918](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12918)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`UserStatusMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UserStatusMuteAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12921](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12921)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12919](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12919)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`UserStatusMuteAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UserStatusMuteAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-usernamechatstartmodeaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UsernameChatStartModeAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UsernameChatStartModeAction)

Defined in: [WAProto/index.d.ts:12928](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12928)

## Implements[​](#implements "Direct link to Implements")

*   [`IUsernameChatStartModeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUsernameChatStartModeAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new UsernameChatStartModeAction()[​](#new-usernamechatstartmodeaction "Direct link to new UsernameChatStartModeAction()")

> **new UsernameChatStartModeAction**(`p`?): [`UsernameChatStartModeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UsernameChatStartModeAction)

Defined in: [WAProto/index.d.ts:12929](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12929)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IUsernameChatStartModeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUsernameChatStartModeAction)

#### Returns[​](#returns "Direct link to Returns")

[`UsernameChatStartModeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UsernameChatStartModeAction)

## Properties[​](#properties "Direct link to Properties")

### chatStartMode?[​](#chatstartmode "Direct link to chatStartMode?")

> `optional` **chatStartMode**: `null` | [`ChatStartMode`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/UsernameChatStartModeAction/enumerations/ChatStartMode)

Defined in: [WAProto/index.d.ts:12930](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12930)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IUsernameChatStartModeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUsernameChatStartModeAction).[`chatStartMode`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUsernameChatStartModeAction#chatstartmode)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12936](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12936)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`UsernameChatStartModeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UsernameChatStartModeAction)

Defined in: [WAProto/index.d.ts:12931](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12931)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IUsernameChatStartModeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUsernameChatStartModeAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`UsernameChatStartModeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UsernameChatStartModeAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`UsernameChatStartModeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UsernameChatStartModeAction)

Defined in: [WAProto/index.d.ts:12933](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12933)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`UsernameChatStartModeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UsernameChatStartModeAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12932](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12932)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IUsernameChatStartModeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUsernameChatStartModeAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`UsernameChatStartModeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UsernameChatStartModeAction)

Defined in: [WAProto/index.d.ts:12934](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12934)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`UsernameChatStartModeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UsernameChatStartModeAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12937](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12937)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12935](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12935)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`UsernameChatStartModeAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/UsernameChatStartModeAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-waffleaccountlinkstateaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WaffleAccountLinkStateAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WaffleAccountLinkStateAction)

Defined in: [WAProto/index.d.ts:12952](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12952)

## Implements[​](#implements "Direct link to Implements")

*   [`IWaffleAccountLinkStateAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWaffleAccountLinkStateAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new WaffleAccountLinkStateAction()[​](#new-waffleaccountlinkstateaction "Direct link to new WaffleAccountLinkStateAction()")

> **new WaffleAccountLinkStateAction**(`p`?): [`WaffleAccountLinkStateAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WaffleAccountLinkStateAction)

Defined in: [WAProto/index.d.ts:12953](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12953)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IWaffleAccountLinkStateAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWaffleAccountLinkStateAction)

#### Returns[​](#returns "Direct link to Returns")

[`WaffleAccountLinkStateAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WaffleAccountLinkStateAction)

## Properties[​](#properties "Direct link to Properties")

### linkState?[​](#linkstate "Direct link to linkState?")

> `optional` **linkState**: `null` | [`AccountLinkState`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/WaffleAccountLinkStateAction/enumerations/AccountLinkState)

Defined in: [WAProto/index.d.ts:12954](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12954)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IWaffleAccountLinkStateAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWaffleAccountLinkStateAction).[`linkState`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWaffleAccountLinkStateAction#linkstate)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12960](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12960)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`WaffleAccountLinkStateAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WaffleAccountLinkStateAction)

Defined in: [WAProto/index.d.ts:12955](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12955)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IWaffleAccountLinkStateAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWaffleAccountLinkStateAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`WaffleAccountLinkStateAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WaffleAccountLinkStateAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`WaffleAccountLinkStateAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WaffleAccountLinkStateAction)

Defined in: [WAProto/index.d.ts:12957](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12957)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`WaffleAccountLinkStateAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WaffleAccountLinkStateAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12956](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12956)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IWaffleAccountLinkStateAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWaffleAccountLinkStateAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`WaffleAccountLinkStateAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WaffleAccountLinkStateAction)

Defined in: [WAProto/index.d.ts:12958](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12958)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`WaffleAccountLinkStateAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WaffleAccountLinkStateAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12961](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12961)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12959](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12959)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`WaffleAccountLinkStateAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WaffleAccountLinkStateAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-wamouseridentifieraction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WamoUserIdentifierAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WamoUserIdentifierAction)

Defined in: [WAProto/index.d.ts:12977](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12977)

## Implements[​](#implements "Direct link to Implements")

*   [`IWamoUserIdentifierAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWamoUserIdentifierAction)

## Constructors[​](#constructors "Direct link to Constructors")

### new WamoUserIdentifierAction()[​](#new-wamouseridentifieraction "Direct link to new WamoUserIdentifierAction()")

> **new WamoUserIdentifierAction**(`p`?): [`WamoUserIdentifierAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WamoUserIdentifierAction)

Defined in: [WAProto/index.d.ts:12978](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12978)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IWamoUserIdentifierAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWamoUserIdentifierAction)

#### Returns[​](#returns "Direct link to Returns")

[`WamoUserIdentifierAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WamoUserIdentifierAction)

## Properties[​](#properties "Direct link to Properties")

### identifier?[​](#identifier "Direct link to identifier?")

> `optional` **identifier**: `null` | `string`

Defined in: [WAProto/index.d.ts:12979](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12979)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IWamoUserIdentifierAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWamoUserIdentifierAction).[`identifier`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWamoUserIdentifierAction#identifier)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12985](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12985)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`WamoUserIdentifierAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WamoUserIdentifierAction)

Defined in: [WAProto/index.d.ts:12980](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12980)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IWamoUserIdentifierAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWamoUserIdentifierAction)

#### Returns[​](#returns-2 "Direct link to Returns")

[`WamoUserIdentifierAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WamoUserIdentifierAction)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`WamoUserIdentifierAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WamoUserIdentifierAction)

Defined in: [WAProto/index.d.ts:12982](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12982)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`WamoUserIdentifierAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WamoUserIdentifierAction)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12981](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12981)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IWamoUserIdentifierAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWamoUserIdentifierAction)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`WamoUserIdentifierAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WamoUserIdentifierAction)

Defined in: [WAProto/index.d.ts:12983](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12983)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`WamoUserIdentifierAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WamoUserIdentifierAction)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12986](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12986)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12984](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12984)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`WamoUserIdentifierAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/classes/WamoUserIdentifierAction)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-iagentaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAgentAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAgentAction)

Defined in: [WAProto/index.d.ts:11581](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11581)

## Properties[​](#properties "Direct link to Properties")

### deviceID?[​](#deviceid "Direct link to deviceID?")

> `optional` **deviceID**: `null` | `number`

Defined in: [WAProto/index.d.ts:11583](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11583)

* * *

### isDeleted?[​](#isdeleted "Direct link to isDeleted?")

> `optional` **isDeleted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11584](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11584)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:11582](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11582)

---

<a name="interface-iaithreadrenameaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAiThreadRenameAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAiThreadRenameAction)

Defined in: [WAProto/index.d.ts:11601](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11601)

## Properties[​](#properties "Direct link to Properties")

### newTitle?[​](#newtitle "Direct link to newTitle?")

> `optional` **newTitle**: `null` | `string`

Defined in: [WAProto/index.d.ts:11602](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11602)

---

<a name="interface-iandroidunsupportedactions"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAndroidUnsupportedActions](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAndroidUnsupportedActions)

Defined in: [WAProto/index.d.ts:11617](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11617)

## Properties[​](#properties "Direct link to Properties")

### allowed?[​](#allowed "Direct link to allowed?")

> `optional` **allowed**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11618](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11618)

---

<a name="interface-iarchivechataction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IArchiveChatAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IArchiveChatAction)

Defined in: [WAProto/index.d.ts:11633](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11633)

## Properties[​](#properties "Direct link to Properties")

### archived?[​](#archived "Direct link to archived?")

> `optional` **archived**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11634](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11634)

* * *

### messageRange?[​](#messagerange "Direct link to messageRange?")

> `optional` **messageRange**: `null` | [`ISyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange)

Defined in: [WAProto/index.d.ts:11635](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11635)

---

<a name="interface-iavatarupdatedaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAvatarUpdatedAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IAvatarUpdatedAction)

Defined in: [WAProto/index.d.ts:11651](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11651)

## Properties[​](#properties "Direct link to Properties")

### eventType?[​](#eventtype "Direct link to eventType?")

> `optional` **eventType**: `null` | [`AvatarEventType`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/AvatarUpdatedAction/enumerations/AvatarEventType)

Defined in: [WAProto/index.d.ts:11652](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11652)

* * *

### recentAvatarStickers?[​](#recentavatarstickers "Direct link to recentAvatarStickers?")

> `optional` **recentAvatarStickers**: `null` | [`IStickerAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction)\[\]

Defined in: [WAProto/index.d.ts:11653](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11653)

---

<a name="interface-ibotwelcomerequestaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBotWelcomeRequestAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBotWelcomeRequestAction)

Defined in: [WAProto/index.d.ts:11678](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11678)

## Properties[​](#properties "Direct link to Properties")

### isSent?[​](#issent "Direct link to isSent?")

> `optional` **isSent**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11679](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11679)

---

<a name="interface-ibroadcastlistparticipant"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBroadcastListParticipant](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBroadcastListParticipant)

Defined in: [WAProto/index.d.ts:11694](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11694)

## Properties[​](#properties "Direct link to Properties")

### lidJid?[​](#lidjid "Direct link to lidJid?")

> `optional` **lidJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:11695](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11695)

* * *

### pnJid?[​](#pnjid "Direct link to pnJid?")

> `optional` **pnJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:11696](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11696)

---

<a name="interface-ibusinessbroadcastassociationaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastAssociationAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastAssociationAction)

Defined in: [WAProto/index.d.ts:11712](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11712)

## Properties[​](#properties "Direct link to Properties")

### deleted?[​](#deleted "Direct link to deleted?")

> `optional` **deleted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11713](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11713)

---

<a name="interface-ibusinessbroadcastlistaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastListAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBusinessBroadcastListAction)

Defined in: [WAProto/index.d.ts:11728](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11728)

## Properties[​](#properties "Direct link to Properties")

### deleted?[​](#deleted "Direct link to deleted?")

> `optional` **deleted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11729](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11729)

* * *

### listName?[​](#listname "Direct link to listName?")

> `optional` **listName**: `null` | `string`

Defined in: [WAProto/index.d.ts:11731](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11731)

* * *

### participants?[​](#participants "Direct link to participants?")

> `optional` **participants**: `null` | [`IBroadcastListParticipant`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IBroadcastListParticipant)\[\]

Defined in: [WAProto/index.d.ts:11730](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11730)

---

<a name="interface-icalllogaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICallLogAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICallLogAction)

Defined in: [WAProto/index.d.ts:11748](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11748)

## Properties[​](#properties "Direct link to Properties")

### callLogRecord?[​](#calllogrecord "Direct link to callLogRecord?")

> `optional` **callLogRecord**: `null` | [`ICallLogRecord`](/docs/api/namespaces/proto/interfaces/ICallLogRecord)

Defined in: [WAProto/index.d.ts:11749](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11749)

---

<a name="interface-ichatassignmentaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentAction)

Defined in: [WAProto/index.d.ts:11764](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11764)

## Properties[​](#properties "Direct link to Properties")

### deviceAgentID?[​](#deviceagentid "Direct link to deviceAgentID?")

> `optional` **deviceAgentID**: `null` | `string`

Defined in: [WAProto/index.d.ts:11765](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11765)

---

<a name="interface-ichatassignmentopenedstatusaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentOpenedStatusAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IChatAssignmentOpenedStatusAction)

Defined in: [WAProto/index.d.ts:11780](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11780)

## Properties[​](#properties "Direct link to Properties")

### chatOpened?[​](#chatopened "Direct link to chatOpened?")

> `optional` **chatOpened**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11781](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11781)

---

<a name="interface-iclearchataction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IClearChatAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IClearChatAction)

Defined in: [WAProto/index.d.ts:11796](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11796)

## Properties[​](#properties "Direct link to Properties")

### messageRange?[​](#messagerange "Direct link to messageRange?")

> `optional` **messageRange**: `null` | [`ISyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange)

Defined in: [WAProto/index.d.ts:11797](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11797)

---

<a name="interface-icontactaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction)

Defined in: [WAProto/index.d.ts:11812](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11812)

## Properties[​](#properties "Direct link to Properties")

### firstName?[​](#firstname "Direct link to firstName?")

> `optional` **firstName**: `null` | `string`

Defined in: [WAProto/index.d.ts:11814](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11814)

* * *

### fullName?[​](#fullname "Direct link to fullName?")

> `optional` **fullName**: `null` | `string`

Defined in: [WAProto/index.d.ts:11813](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11813)

* * *

### lidJid?[​](#lidjid "Direct link to lidJid?")

> `optional` **lidJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:11815](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11815)

* * *

### pnJid?[​](#pnjid "Direct link to pnJid?")

> `optional` **pnJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:11817](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11817)

* * *

### saveOnPrimaryAddressbook?[​](#saveonprimaryaddressbook "Direct link to saveOnPrimaryAddressbook?")

> `optional` **saveOnPrimaryAddressbook**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11816](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11816)

* * *

### username?[​](#username "Direct link to username?")

> `optional` **username**: `null` | `string`

Defined in: [WAProto/index.d.ts:11818](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11818)

---

<a name="interface-ictwapercustomerdatasharingaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICtwaPerCustomerDataSharingAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICtwaPerCustomerDataSharingAction)

Defined in: [WAProto/index.d.ts:11838](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11838)

## Properties[​](#properties "Direct link to Properties")

### isCtwaPerCustomerDataSharingEnabled?[​](#isctwapercustomerdatasharingenabled "Direct link to isCtwaPerCustomerDataSharingEnabled?")

> `optional` **isCtwaPerCustomerDataSharingEnabled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11839](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11839)

---

<a name="interface-icustompaymentmethod"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethod](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethod)

Defined in: [WAProto/index.d.ts:11854](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11854)

## Properties[​](#properties "Direct link to Properties")

### country?[​](#country "Direct link to country?")

> `optional` **country**: `null` | `string`

Defined in: [WAProto/index.d.ts:11856](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11856)

* * *

### credentialId?[​](#credentialid "Direct link to credentialId?")

> `optional` **credentialId**: `null` | `string`

Defined in: [WAProto/index.d.ts:11855](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11855)

* * *

### metadata?[​](#metadata "Direct link to metadata?")

> `optional` **metadata**: `null` | [`ICustomPaymentMethodMetadata`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodMetadata)\[\]

Defined in: [WAProto/index.d.ts:11858](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11858)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | `string`

Defined in: [WAProto/index.d.ts:11857](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11857)

---

<a name="interface-icustompaymentmethodmetadata"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodMetadata](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodMetadata)

Defined in: [WAProto/index.d.ts:11876](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11876)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `string`

Defined in: [WAProto/index.d.ts:11877](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11877)

* * *

### value?[​](#value "Direct link to value?")

> `optional` **value**: `null` | `string`

Defined in: [WAProto/index.d.ts:11878](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11878)

---

<a name="interface-icustompaymentmethodsaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodsAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethodsAction)

Defined in: [WAProto/index.d.ts:11894](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11894)

## Properties[​](#properties "Direct link to Properties")

### customPaymentMethods?[​](#custompaymentmethods "Direct link to customPaymentMethods?")

> `optional` **customPaymentMethods**: `null` | [`ICustomPaymentMethod`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ICustomPaymentMethod)\[\]

Defined in: [WAProto/index.d.ts:11895](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11895)

---

<a name="interface-ideletechataction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteChatAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteChatAction)

Defined in: [WAProto/index.d.ts:11910](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11910)

## Properties[​](#properties "Direct link to Properties")

### messageRange?[​](#messagerange "Direct link to messageRange?")

> `optional` **messageRange**: `null` | [`ISyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange)

Defined in: [WAProto/index.d.ts:11911](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11911)

---

<a name="interface-ideleteindividualcalllogaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteIndividualCallLogAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteIndividualCallLogAction)

Defined in: [WAProto/index.d.ts:11926](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11926)

## Properties[​](#properties "Direct link to Properties")

### isIncoming?[​](#isincoming "Direct link to isIncoming?")

> `optional` **isIncoming**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11928](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11928)

* * *

### peerJid?[​](#peerjid "Direct link to peerJid?")

> `optional` **peerJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:11927](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11927)

---

<a name="interface-ideletemessageformeaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteMessageForMeAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDeleteMessageForMeAction)

Defined in: [WAProto/index.d.ts:11944](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11944)

## Properties[​](#properties "Direct link to Properties")

### deleteMedia?[​](#deletemedia "Direct link to deleteMedia?")

> `optional` **deleteMedia**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11945](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11945)

* * *

### messageTimestamp?[​](#messagetimestamp "Direct link to messageTimestamp?")

> `optional` **messageTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:11946](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11946)

---

<a name="interface-idetectedoutcomesstatusaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDetectedOutcomesStatusAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IDetectedOutcomesStatusAction)

Defined in: [WAProto/index.d.ts:11962](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11962)

## Properties[​](#properties "Direct link to Properties")

### isEnabled?[​](#isenabled "Direct link to isEnabled?")

> `optional` **isEnabled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11963](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11963)

---

<a name="interface-iexternalwebbetaaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IExternalWebBetaAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IExternalWebBetaAction)

Defined in: [WAProto/index.d.ts:11978](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11978)

## Properties[​](#properties "Direct link to Properties")

### isOptIn?[​](#isoptin "Direct link to isOptIn?")

> `optional` **isOptIn**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:11979](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11979)

---

<a name="interface-ifavoritesaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IFavoritesAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IFavoritesAction)

Defined in: [WAProto/index.d.ts:11994](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11994)

## Properties[​](#properties "Direct link to Properties")

### favorites?[​](#favorites "Direct link to favorites?")

> `optional` **favorites**: `null` | [`IFavorite`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/interfaces/IFavorite)\[\]

Defined in: [WAProto/index.d.ts:11995](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11995)

---

<a name="interface-iinteractivemessageaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IInteractiveMessageAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IInteractiveMessageAction)

Defined in: [WAProto/index.d.ts:12029](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12029)

## Properties[​](#properties "Direct link to Properties")

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`DISABLE_CTA`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/InteractiveMessageAction/enumerations/InteractiveMessageActionMode#disable_cta)

Defined in: [WAProto/index.d.ts:12030](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12030)

---

<a name="interface-ikeyexpiration"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IKeyExpiration](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IKeyExpiration)

Defined in: [WAProto/index.d.ts:12052](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12052)

## Properties[​](#properties "Direct link to Properties")

### expiredKeyEpoch?[​](#expiredkeyepoch "Direct link to expiredKeyEpoch?")

> `optional` **expiredKeyEpoch**: `null` | `number`

Defined in: [WAProto/index.d.ts:12053](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12053)

---

<a name="interface-ilabelassociationaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelAssociationAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelAssociationAction)

Defined in: [WAProto/index.d.ts:12068](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12068)

## Properties[​](#properties "Direct link to Properties")

### labeled?[​](#labeled "Direct link to labeled?")

> `optional` **labeled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12069](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12069)

---

<a name="interface-ilabeleditaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelEditAction)

Defined in: [WAProto/index.d.ts:12084](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12084)

## Properties[​](#properties "Direct link to Properties")

### color?[​](#color "Direct link to color?")

> `optional` **color**: `null` | `number`

Defined in: [WAProto/index.d.ts:12086](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12086)

* * *

### deleted?[​](#deleted "Direct link to deleted?")

> `optional` **deleted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12088](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12088)

* * *

### isActive?[​](#isactive "Direct link to isActive?")

> `optional` **isActive**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12090](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12090)

* * *

### isImmutable?[​](#isimmutable "Direct link to isImmutable?")

> `optional` **isImmutable**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12092](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12092)

* * *

### muteEndTimeMs?[​](#muteendtimems "Direct link to muteEndTimeMs?")

> `optional` **muteEndTimeMs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12093](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12093)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:12085](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12085)

* * *

### orderIndex?[​](#orderindex "Direct link to orderIndex?")

> `optional` **orderIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:12089](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12089)

* * *

### predefinedId?[​](#predefinedid "Direct link to predefinedId?")

> `optional` **predefinedId**: `null` | `number`

Defined in: [WAProto/index.d.ts:12087](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12087)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`ListType`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/LabelEditAction/enumerations/ListType)

Defined in: [WAProto/index.d.ts:12091](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12091)

---

<a name="interface-ilabelreorderingaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelReorderingAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILabelReorderingAction)

Defined in: [WAProto/index.d.ts:12132](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12132)

## Properties[​](#properties "Direct link to Properties")

### sortedLabelIds?[​](#sortedlabelids "Direct link to sortedLabelIds?")

> `optional` **sortedLabelIds**: `null` | `number`\[\]

Defined in: [WAProto/index.d.ts:12133](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12133)

---

<a name="interface-ilidcontactaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILidContactAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILidContactAction)

Defined in: [WAProto/index.d.ts:12148](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12148)

## Properties[​](#properties "Direct link to Properties")

### firstName?[​](#firstname "Direct link to firstName?")

> `optional` **firstName**: `null` | `string`

Defined in: [WAProto/index.d.ts:12150](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12150)

* * *

### fullName?[​](#fullname "Direct link to fullName?")

> `optional` **fullName**: `null` | `string`

Defined in: [WAProto/index.d.ts:12149](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12149)

* * *

### username?[​](#username "Direct link to username?")

> `optional` **username**: `null` | `string`

Defined in: [WAProto/index.d.ts:12151](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12151)

---

<a name="interface-ilocalesetting"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILocaleSetting](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILocaleSetting)

Defined in: [WAProto/index.d.ts:12168](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12168)

## Properties[​](#properties "Direct link to Properties")

### locale?[​](#locale "Direct link to locale?")

> `optional` **locale**: `null` | `string`

Defined in: [WAProto/index.d.ts:12169](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12169)

---

<a name="interface-ilockchataction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILockChatAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ILockChatAction)

Defined in: [WAProto/index.d.ts:12184](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12184)

## Properties[​](#properties "Direct link to Properties")

### locked?[​](#locked "Direct link to locked?")

> `optional` **locked**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12185](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12185)

---

<a name="interface-imaibaaifeaturescontrolaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMaibaAIFeaturesControlAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMaibaAIFeaturesControlAction)

Defined in: [WAProto/index.d.ts:12200](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12200)

## Properties[​](#properties "Direct link to Properties")

### aiFeatureStatus?[​](#aifeaturestatus "Direct link to aiFeatureStatus?")

> `optional` **aiFeatureStatus**: `null` | [`MaibaAIFeatureStatus`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MaibaAIFeaturesControlAction/enumerations/MaibaAIFeatureStatus)

Defined in: [WAProto/index.d.ts:12201](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12201)

---

<a name="interface-imarkchatasreadaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarkChatAsReadAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarkChatAsReadAction)

Defined in: [WAProto/index.d.ts:12225](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12225)

## Properties[​](#properties "Direct link to Properties")

### messageRange?[​](#messagerange "Direct link to messageRange?")

> `optional` **messageRange**: `null` | [`ISyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange)

Defined in: [WAProto/index.d.ts:12227](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12227)

* * *

### read?[​](#read "Direct link to read?")

> `optional` **read**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12226](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12226)

---

<a name="interface-imarketingmessageaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageAction)

Defined in: [WAProto/index.d.ts:12243](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12243)

## Properties[​](#properties "Direct link to Properties")

### createdAt?[​](#createdat "Direct link to createdAt?")

> `optional` **createdAt**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12247](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12247)

* * *

### isDeleted?[​](#isdeleted "Direct link to isDeleted?")

> `optional` **isDeleted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12249](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12249)

* * *

### lastSentAt?[​](#lastsentat "Direct link to lastSentAt?")

> `optional` **lastSentAt**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12248](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12248)

* * *

### mediaId?[​](#mediaid "Direct link to mediaId?")

> `optional` **mediaId**: `null` | `string`

Defined in: [WAProto/index.d.ts:12250](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12250)

* * *

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | `string`

Defined in: [WAProto/index.d.ts:12245](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12245)

* * *

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:12244](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12244)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`PERSONALIZED`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MarketingMessageAction/enumerations/MarketingMessagePrototypeType#personalized)

Defined in: [WAProto/index.d.ts:12246](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12246)

---

<a name="interface-imarketingmessagebroadcastaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageBroadcastAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMarketingMessageBroadcastAction)

Defined in: [WAProto/index.d.ts:12278](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12278)

## Properties[​](#properties "Direct link to Properties")

### repliedCount?[​](#repliedcount "Direct link to repliedCount?")

> `optional` **repliedCount**: `null` | `number`

Defined in: [WAProto/index.d.ts:12279](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12279)

---

<a name="interface-imerchantpaymentpartneraction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMerchantPaymentPartnerAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMerchantPaymentPartnerAction)

Defined in: [WAProto/index.d.ts:12294](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12294)

## Properties[​](#properties "Direct link to Properties")

### country?[​](#country "Direct link to country?")

> `optional` **country**: `null` | `string`

Defined in: [WAProto/index.d.ts:12296](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12296)

* * *

### credentialId?[​](#credentialid "Direct link to credentialId?")

> `optional` **credentialId**: `null` | `string`

Defined in: [WAProto/index.d.ts:12298](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12298)

* * *

### gatewayName?[​](#gatewayname "Direct link to gatewayName?")

> `optional` **gatewayName**: `null` | `string`

Defined in: [WAProto/index.d.ts:12297](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12297)

* * *

### status?[​](#status "Direct link to status?")

> `optional` **status**: `null` | [`Status`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MerchantPaymentPartnerAction/enumerations/Status)

Defined in: [WAProto/index.d.ts:12295](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12295)

---

<a name="interface-imusicuseridaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMusicUserIdAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMusicUserIdAction)

Defined in: [WAProto/index.d.ts:12324](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12324)

## Properties[​](#properties "Direct link to Properties")

### musicUserId?[​](#musicuserid "Direct link to musicUserId?")

> `optional` **musicUserId**: `null` | `string`

Defined in: [WAProto/index.d.ts:12325](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12325)

* * *

### musicUserIdMap?[​](#musicuseridmap "Direct link to musicUserIdMap?")

> `optional` **musicUserIdMap**: `null` | {}

Defined in: [WAProto/index.d.ts:12326](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12326)

---

<a name="interface-imuteaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMuteAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IMuteAction)

Defined in: [WAProto/index.d.ts:12342](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12342)

## Properties[​](#properties "Direct link to Properties")

### autoMuted?[​](#automuted "Direct link to autoMuted?")

> `optional` **autoMuted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12345](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12345)

* * *

### muted?[​](#muted "Direct link to muted?")

> `optional` **muted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12343](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12343)

* * *

### muteEndTimestamp?[​](#muteendtimestamp "Direct link to muteEndTimestamp?")

> `optional` **muteEndTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12344](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12344)

---

<a name="interface-inewslettersavedinterestsaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INewsletterSavedInterestsAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INewsletterSavedInterestsAction)

Defined in: [WAProto/index.d.ts:12362](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12362)

## Properties[​](#properties "Direct link to Properties")

### newsletterSavedInterests?[​](#newslettersavedinterests "Direct link to newsletterSavedInterests?")

> `optional` **newsletterSavedInterests**: `null` | `string`

Defined in: [WAProto/index.d.ts:12363](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12363)

---

<a name="interface-inoteeditaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INoteEditAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INoteEditAction)

Defined in: [WAProto/index.d.ts:12378](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12378)

## Properties[​](#properties "Direct link to Properties")

### chatJid?[​](#chatjid "Direct link to chatJid?")

> `optional` **chatJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:12380](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12380)

* * *

### createdAt?[​](#createdat "Direct link to createdAt?")

> `optional` **createdAt**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12381](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12381)

* * *

### deleted?[​](#deleted "Direct link to deleted?")

> `optional` **deleted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12382](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12382)

* * *

### type?[​](#type "Direct link to type?")

> `optional` **type**: `null` | [`NoteType`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/NoteEditAction/enumerations/NoteType)

Defined in: [WAProto/index.d.ts:12379](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12379)

* * *

### unstructuredContent?[​](#unstructuredcontent "Direct link to unstructuredContent?")

> `optional` **unstructuredContent**: `null` | `string`

Defined in: [WAProto/index.d.ts:12383](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12383)

---

<a name="interface-inotificationactivitysettingaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INotificationActivitySettingAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INotificationActivitySettingAction)

Defined in: [WAProto/index.d.ts:12410](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12410)

## Properties[​](#properties "Direct link to Properties")

### notificationActivitySetting?[​](#notificationactivitysetting "Direct link to notificationActivitySetting?")

> `optional` **notificationActivitySetting**: `null` | [`NotificationActivitySetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/NotificationActivitySettingAction/enumerations/NotificationActivitySetting)

Defined in: [WAProto/index.d.ts:12411](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12411)

---

<a name="interface-inuxaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INuxAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/INuxAction)

Defined in: [WAProto/index.d.ts:12436](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12436)

## Properties[​](#properties "Direct link to Properties")

### acknowledged?[​](#acknowledged "Direct link to acknowledged?")

> `optional` **acknowledged**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12437](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12437)

---

<a name="interface-ipaymentinfoaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentInfoAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentInfoAction)

Defined in: [WAProto/index.d.ts:12452](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12452)

## Properties[​](#properties "Direct link to Properties")

### cpi?[​](#cpi "Direct link to cpi?")

> `optional` **cpi**: `null` | `string`

Defined in: [WAProto/index.d.ts:12453](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12453)

---

<a name="interface-ipaymenttosaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentTosAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPaymentTosAction)

Defined in: [WAProto/index.d.ts:12468](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12468)

## Properties[​](#properties "Direct link to Properties")

### accepted?[​](#accepted "Direct link to accepted?")

> `optional` **accepted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12470](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12470)

* * *

### paymentNotice?[​](#paymentnotice "Direct link to paymentNotice?")

> `optional` **paymentNotice**: `null` | [`BR_PAY_PRIVACY_POLICY`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/PaymentTosAction/enumerations/PaymentNotice#br_pay_privacy_policy)

Defined in: [WAProto/index.d.ts:12469](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12469)

---

<a name="interface-ipinaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPinAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPinAction)

Defined in: [WAProto/index.d.ts:12493](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12493)

## Properties[​](#properties "Direct link to Properties")

### pinned?[​](#pinned "Direct link to pinned?")

> `optional` **pinned**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12494](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12494)

---

<a name="interface-ipnforlidchataction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPnForLidChatAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPnForLidChatAction)

Defined in: [WAProto/index.d.ts:12509](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12509)

## Properties[​](#properties "Direct link to Properties")

### pnJid?[​](#pnjid "Direct link to pnJid?")

> `optional` **pnJid**: `null` | `string`

Defined in: [WAProto/index.d.ts:12510](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12510)

---

<a name="interface-iprimaryfeature"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryFeature](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryFeature)

Defined in: [WAProto/index.d.ts:12525](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12525)

## Properties[​](#properties "Direct link to Properties")

### flags?[​](#flags "Direct link to flags?")

> `optional` **flags**: `null` | `string`\[\]

Defined in: [WAProto/index.d.ts:12526](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12526)

---

<a name="interface-iprimaryversionaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryVersionAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrimaryVersionAction)

Defined in: [WAProto/index.d.ts:12541](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12541)

## Properties[​](#properties "Direct link to Properties")

### version?[​](#version "Direct link to version?")

> `optional` **version**: `null` | `string`

Defined in: [WAProto/index.d.ts:12542](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12542)

---

<a name="interface-iprivacysettingchannelspersonalisedrecommendationaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingChannelsPersonalisedRecommendationAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingChannelsPersonalisedRecommendationAction)

Defined in: [WAProto/index.d.ts:12557](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12557)

## Properties[​](#properties "Direct link to Properties")

### isUserOptedOut?[​](#isuseroptedout "Direct link to isUserOptedOut?")

> `optional` **isUserOptedOut**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12558](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12558)

---

<a name="interface-iprivacysettingdisablelinkpreviewsaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingDisableLinkPreviewsAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingDisableLinkPreviewsAction)

Defined in: [WAProto/index.d.ts:12573](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12573)

## Properties[​](#properties "Direct link to Properties")

### isPreviewsDisabled?[​](#ispreviewsdisabled "Direct link to isPreviewsDisabled?")

> `optional` **isPreviewsDisabled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12574](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12574)

---

<a name="interface-iprivacysettingrelayallcalls"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingRelayAllCalls](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingRelayAllCalls)

Defined in: [WAProto/index.d.ts:12589](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12589)

## Properties[​](#properties "Direct link to Properties")

### isEnabled?[​](#isenabled "Direct link to isEnabled?")

> `optional` **isEnabled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12590](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12590)

---

<a name="interface-iprivateprocessingsettingaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivateProcessingSettingAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivateProcessingSettingAction)

Defined in: [WAProto/index.d.ts:12605](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12605)

## Properties[​](#properties "Direct link to Properties")

### privateProcessingStatus?[​](#privateprocessingstatus "Direct link to privateProcessingStatus?")

> `optional` **privateProcessingStatus**: `null` | [`PrivateProcessingStatus`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/PrivateProcessingSettingAction/enumerations/PrivateProcessingStatus)

Defined in: [WAProto/index.d.ts:12606](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12606)

---

<a name="interface-ipushnamesetting"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPushNameSetting](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPushNameSetting)

Defined in: [WAProto/index.d.ts:12630](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12630)

## Properties[​](#properties "Direct link to Properties")

### name?[​](#name "Direct link to name?")

> `optional` **name**: `null` | `string`

Defined in: [WAProto/index.d.ts:12631](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12631)

---

<a name="interface-iquickreplyaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IQuickReplyAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IQuickReplyAction)

Defined in: [WAProto/index.d.ts:12646](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12646)

## Properties[​](#properties "Direct link to Properties")

### count?[​](#count "Direct link to count?")

> `optional` **count**: `null` | `number`

Defined in: [WAProto/index.d.ts:12650](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12650)

* * *

### deleted?[​](#deleted "Direct link to deleted?")

> `optional` **deleted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12651](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12651)

* * *

### keywords?[​](#keywords "Direct link to keywords?")

> `optional` **keywords**: `null` | `string`\[\]

Defined in: [WAProto/index.d.ts:12649](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12649)

* * *

### message?[​](#message "Direct link to message?")

> `optional` **message**: `null` | `string`

Defined in: [WAProto/index.d.ts:12648](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12648)

* * *

### shortcut?[​](#shortcut "Direct link to shortcut?")

> `optional` **shortcut**: `null` | `string`

Defined in: [WAProto/index.d.ts:12647](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12647)

---

<a name="interface-irecentemojiweightsaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRecentEmojiWeightsAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRecentEmojiWeightsAction)

Defined in: [WAProto/index.d.ts:12670](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12670)

## Properties[​](#properties "Direct link to Properties")

### weights?[​](#weights "Direct link to weights?")

> `optional` **weights**: `null` | [`IRecentEmojiWeight`](/docs/api/namespaces/proto/interfaces/IRecentEmojiWeight)\[\]

Defined in: [WAProto/index.d.ts:12671](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12671)

---

<a name="interface-iremoverecentstickeraction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRemoveRecentStickerAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IRemoveRecentStickerAction)

Defined in: [WAProto/index.d.ts:12686](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12686)

## Properties[​](#properties "Direct link to Properties")

### lastStickerSentTs?[​](#laststickersentts "Direct link to lastStickerSentTs?")

> `optional` **lastStickerSentTs**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12687](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12687)

---

<a name="interface-istaraction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStarAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStarAction)

Defined in: [WAProto/index.d.ts:12702](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12702)

## Properties[​](#properties "Direct link to Properties")

### starred?[​](#starred "Direct link to starred?")

> `optional` **starred**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12703](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12703)

---

<a name="interface-istatuspostoptinnotificationpreferencesaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPostOptInNotificationPreferencesAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPostOptInNotificationPreferencesAction)

Defined in: [WAProto/index.d.ts:12718](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12718)

## Properties[​](#properties "Direct link to Properties")

### enabled?[​](#enabled "Direct link to enabled?")

> `optional` **enabled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12719](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12719)

---

<a name="interface-istatusprivacyaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPrivacyAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPrivacyAction)

Defined in: [WAProto/index.d.ts:12734](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12734)

## Properties[​](#properties "Direct link to Properties")

### mode?[​](#mode "Direct link to mode?")

> `optional` **mode**: `null` | [`StatusDistributionMode`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/StatusPrivacyAction/enumerations/StatusDistributionMode)

Defined in: [WAProto/index.d.ts:12735](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12735)

* * *

### userJid?[​](#userjid "Direct link to userJid?")

> `optional` **userJid**: `null` | `string`\[\]

Defined in: [WAProto/index.d.ts:12736](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12736)

---

<a name="interface-istickeraction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStickerAction)

Defined in: [WAProto/index.d.ts:12762](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12762)

## Properties[​](#properties "Direct link to Properties")

### deviceIdHint?[​](#deviceidhint "Direct link to deviceIdHint?")

> `optional` **deviceIdHint**: `null` | `number`

Defined in: [WAProto/index.d.ts:12772](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12772)

* * *

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `null` | `string`

Defined in: [WAProto/index.d.ts:12769](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12769)

* * *

### fileEncSha256?[​](#fileencsha256 "Direct link to fileEncSha256?")

> `optional` **fileEncSha256**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:12764](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12764)

* * *

### fileLength?[​](#filelength "Direct link to fileLength?")

> `optional` **fileLength**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12770](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12770)

* * *

### height?[​](#height "Direct link to height?")

> `optional` **height**: `null` | `number`

Defined in: [WAProto/index.d.ts:12767](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12767)

* * *

### imageHash?[​](#imagehash "Direct link to imageHash?")

> `optional` **imageHash**: `null` | `string`

Defined in: [WAProto/index.d.ts:12774](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12774)

* * *

### isAvatarSticker?[​](#isavatarsticker "Direct link to isAvatarSticker?")

> `optional` **isAvatarSticker**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12775](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12775)

* * *

### isFavorite?[​](#isfavorite "Direct link to isFavorite?")

> `optional` **isFavorite**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12771](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12771)

* * *

### isLottie?[​](#islottie "Direct link to isLottie?")

> `optional` **isLottie**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12773](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12773)

* * *

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:12765](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12765)

* * *

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `null` | `string`

Defined in: [WAProto/index.d.ts:12766](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12766)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | `string`

Defined in: [WAProto/index.d.ts:12763](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12763)

* * *

### width?[​](#width "Direct link to width?")

> `optional` **width**: `null` | `number`

Defined in: [WAProto/index.d.ts:12768](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12768)

---

<a name="interface-isubscriptionaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISubscriptionAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISubscriptionAction)

Defined in: [WAProto/index.d.ts:12802](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12802)

## Properties[​](#properties "Direct link to Properties")

### expirationDate?[​](#expirationdate "Direct link to expirationDate?")

> `optional` **expirationDate**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12805](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12805)

* * *

### isAutoRenewing?[​](#isautorenewing "Direct link to isAutoRenewing?")

> `optional` **isAutoRenewing**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12804](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12804)

* * *

### isDeactivated?[​](#isdeactivated "Direct link to isDeactivated?")

> `optional` **isDeactivated**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12803](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12803)

---

<a name="interface-isyncactionmessage"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessage](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessage)

Defined in: [WAProto/index.d.ts:12822](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12822)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey)

Defined in: [WAProto/index.d.ts:12823](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12823)

* * *

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12824](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12824)

---

<a name="interface-isyncactionmessagerange"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange)

Defined in: [WAProto/index.d.ts:12840](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12840)

## Properties[​](#properties "Direct link to Properties")

### lastMessageTimestamp?[​](#lastmessagetimestamp "Direct link to lastMessageTimestamp?")

> `optional` **lastMessageTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12841](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12841)

* * *

### lastSystemMessageTimestamp?[​](#lastsystemmessagetimestamp "Direct link to lastSystemMessageTimestamp?")

> `optional` **lastSystemMessageTimestamp**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:12842](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12842)

* * *

### messages?[​](#messages "Direct link to messages?")

> `optional` **messages**: `null` | [`ISyncActionMessage`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessage)\[\]

Defined in: [WAProto/index.d.ts:12843](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12843)

---

<a name="interface-itimeformataction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ITimeFormatAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ITimeFormatAction)

Defined in: [WAProto/index.d.ts:12860](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12860)

## Properties[​](#properties "Direct link to Properties")

### isTwentyFourHourFormatEnabled?[​](#istwentyfourhourformatenabled "Direct link to isTwentyFourHourFormatEnabled?")

> `optional` **isTwentyFourHourFormatEnabled**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12861](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12861)

---

<a name="interface-iugcbot"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUGCBot](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUGCBot)

Defined in: [WAProto/index.d.ts:12876](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12876)

## Properties[​](#properties "Direct link to Properties")

### definition?[​](#definition "Direct link to definition?")

> `optional` **definition**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:12877](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12877)

---

<a name="interface-iunarchivechatssetting"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUnarchiveChatsSetting](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUnarchiveChatsSetting)

Defined in: [WAProto/index.d.ts:12892](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12892)

## Properties[​](#properties "Direct link to Properties")

### unarchiveChats?[​](#unarchivechats "Direct link to unarchiveChats?")

> `optional` **unarchiveChats**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12893](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12893)

---

<a name="interface-iuserstatusmuteaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUserStatusMuteAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUserStatusMuteAction)

Defined in: [WAProto/index.d.ts:12908](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12908)

## Properties[​](#properties "Direct link to Properties")

### muted?[​](#muted "Direct link to muted?")

> `optional` **muted**: `null` | `boolean`

Defined in: [WAProto/index.d.ts:12909](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12909)

---

<a name="interface-iusernamechatstartmodeaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUsernameChatStartModeAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IUsernameChatStartModeAction)

Defined in: [WAProto/index.d.ts:12924](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12924)

## Properties[​](#properties "Direct link to Properties")

### chatStartMode?[​](#chatstartmode "Direct link to chatStartMode?")

> `optional` **chatStartMode**: `null` | [`ChatStartMode`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/UsernameChatStartModeAction/enumerations/ChatStartMode)

Defined in: [WAProto/index.d.ts:12925](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12925)

---

<a name="interface-iwaffleaccountlinkstateaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWaffleAccountLinkStateAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWaffleAccountLinkStateAction)

Defined in: [WAProto/index.d.ts:12948](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12948)

## Properties[​](#properties "Direct link to Properties")

### linkState?[​](#linkstate "Direct link to linkState?")

> `optional` **linkState**: `null` | [`AccountLinkState`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/WaffleAccountLinkStateAction/enumerations/AccountLinkState)

Defined in: [WAProto/index.d.ts:12949](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12949)

---

<a name="interface-iwamouseridentifieraction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWamoUserIdentifierAction](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IWamoUserIdentifierAction)

Defined in: [WAProto/index.d.ts:12973](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12973)

## Properties[​](#properties "Direct link to Properties")

### identifier?[​](#identifier "Direct link to identifier?")

> `optional` **identifier**: `null` | `string`

Defined in: [WAProto/index.d.ts:12974](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12974)

---

<a name="avatarupdatedaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/AvatarUpdatedAction/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/AvatarUpdatedAction/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [AvatarEventType](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/AvatarUpdatedAction/enumerations/AvatarEventType)

---

<a name="enumeration-avatareventtype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/AvatarUpdatedAction/enumerations/AvatarEventType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/AvatarUpdatedAction/enumerations/AvatarEventType)

Defined in: [WAProto/index.d.ts:11671](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11671)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### CREATED[​](#created "Direct link to CREATED")

> **CREATED**: `1`

Defined in: [WAProto/index.d.ts:11673](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11673)

* * *

### DELETED[​](#deleted "Direct link to DELETED")

> **DELETED**: `2`

Defined in: [WAProto/index.d.ts:11674](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11674)

* * *

### UPDATED[​](#updated "Direct link to UPDATED")

> **UPDATED**: `0`

Defined in: [WAProto/index.d.ts:11672](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L11672)

---

<a name="favoritesaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/)

## Classes[​](#classes "Direct link to Classes")

*   [Favorite](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/classes/Favorite)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IFavorite](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/interfaces/IFavorite)

---

<a name="class-favorite"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/classes/Favorite](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/classes/Favorite)

Defined in: [WAProto/index.d.ts:12016](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12016)

## Implements[​](#implements "Direct link to Implements")

*   [`IFavorite`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/interfaces/IFavorite)

## Constructors[​](#constructors "Direct link to Constructors")

### new Favorite()[​](#new-favorite "Direct link to new Favorite()")

> **new Favorite**(`p`?): [`Favorite`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/classes/Favorite)

Defined in: [WAProto/index.d.ts:12017](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12017)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IFavorite`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/interfaces/IFavorite)

#### Returns[​](#returns "Direct link to Returns")

[`Favorite`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/classes/Favorite)

## Properties[​](#properties "Direct link to Properties")

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:12018](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12018)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IFavorite`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/interfaces/IFavorite).[`id`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/interfaces/IFavorite#id)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:12024](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12024)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Favorite`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/classes/Favorite)

Defined in: [WAProto/index.d.ts:12019](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12019)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IFavorite`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/interfaces/IFavorite)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Favorite`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/classes/Favorite)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Favorite`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/classes/Favorite)

Defined in: [WAProto/index.d.ts:12021](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12021)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Favorite`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/classes/Favorite)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:12020](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12020)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IFavorite`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/interfaces/IFavorite)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Favorite`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/classes/Favorite)

Defined in: [WAProto/index.d.ts:12022](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12022)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Favorite`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/classes/Favorite)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:12025](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12025)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:12023](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12023)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Favorite`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/classes/Favorite)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ifavorite"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/interfaces/IFavorite](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/FavoritesAction/interfaces/IFavorite)

Defined in: [WAProto/index.d.ts:12012](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12012)

## Properties[​](#properties "Direct link to Properties")

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:12013](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12013)

---

<a name="interactivemessageaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/InteractiveMessageAction/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/InteractiveMessageAction/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [InteractiveMessageActionMode](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/InteractiveMessageAction/enumerations/InteractiveMessageActionMode)

---

<a name="enumeration-interactivemessageactionmode"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/InteractiveMessageAction/enumerations/InteractiveMessageActionMode](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/InteractiveMessageAction/enumerations/InteractiveMessageActionMode)

Defined in: [WAProto/index.d.ts:12047](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12047)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### DISABLE\_CTA[​](#disable_cta "Direct link to DISABLE_CTA")

> **DISABLE\_CTA**: `1`

Defined in: [WAProto/index.d.ts:12048](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12048)

---

<a name="labeleditaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/LabelEditAction/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/LabelEditAction/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [ListType](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/LabelEditAction/enumerations/ListType)

---

<a name="enumeration-listtype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/LabelEditAction/enumerations/ListType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/LabelEditAction/enumerations/ListType)

Defined in: [WAProto/index.d.ts:12118](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12118)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AI\_HANDOFF[​](#ai_handoff "Direct link to AI_HANDOFF")

> **AI\_HANDOFF**: `9`

Defined in: [WAProto/index.d.ts:12128](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12128)

* * *

### COMMUNITY[​](#community "Direct link to COMMUNITY")

> **COMMUNITY**: `6`

Defined in: [WAProto/index.d.ts:12125](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12125)

* * *

### CUSTOM[​](#custom "Direct link to CUSTOM")

> **CUSTOM**: `5`

Defined in: [WAProto/index.d.ts:12124](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12124)

* * *

### DRAFTED[​](#drafted "Direct link to DRAFTED")

> **DRAFTED**: `8`

Defined in: [WAProto/index.d.ts:12127](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12127)

* * *

### FAVORITES[​](#favorites "Direct link to FAVORITES")

> **FAVORITES**: `3`

Defined in: [WAProto/index.d.ts:12122](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12122)

* * *

### GROUPS[​](#groups "Direct link to GROUPS")

> **GROUPS**: `2`

Defined in: [WAProto/index.d.ts:12121](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12121)

* * *

### NONE[​](#none "Direct link to NONE")

> **NONE**: `0`

Defined in: [WAProto/index.d.ts:12119](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12119)

* * *

### PREDEFINED[​](#predefined "Direct link to PREDEFINED")

> **PREDEFINED**: `4`

Defined in: [WAProto/index.d.ts:12123](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12123)

* * *

### SERVER\_ASSIGNED[​](#server_assigned "Direct link to SERVER_ASSIGNED")

> **SERVER\_ASSIGNED**: `7`

Defined in: [WAProto/index.d.ts:12126](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12126)

* * *

### UNREAD[​](#unread "Direct link to UNREAD")

> **UNREAD**: `1`

Defined in: [WAProto/index.d.ts:12120](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12120)

---

<a name="maibaaifeaturescontrolaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MaibaAIFeaturesControlAction/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MaibaAIFeaturesControlAction/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [MaibaAIFeatureStatus](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MaibaAIFeaturesControlAction/enumerations/MaibaAIFeatureStatus)

---

<a name="enumeration-maibaaifeaturestatus"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MaibaAIFeaturesControlAction/enumerations/MaibaAIFeatureStatus](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MaibaAIFeaturesControlAction/enumerations/MaibaAIFeatureStatus)

Defined in: [WAProto/index.d.ts:12218](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12218)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### DISABLED[​](#disabled "Direct link to DISABLED")

> **DISABLED**: `2`

Defined in: [WAProto/index.d.ts:12221](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12221)

* * *

### ENABLED[​](#enabled "Direct link to ENABLED")

> **ENABLED**: `0`

Defined in: [WAProto/index.d.ts:12219](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12219)

* * *

### ENABLED\_HAS\_LEARNING[​](#enabled_has_learning "Direct link to ENABLED_HAS_LEARNING")

> **ENABLED\_HAS\_LEARNING**: `1`

Defined in: [WAProto/index.d.ts:12220](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12220)

---

<a name="marketingmessageaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MarketingMessageAction/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MarketingMessageAction/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [MarketingMessagePrototypeType](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MarketingMessageAction/enumerations/MarketingMessagePrototypeType)

---

<a name="enumeration-marketingmessageprototypetype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MarketingMessageAction/enumerations/MarketingMessagePrototypeType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MarketingMessageAction/enumerations/MarketingMessagePrototypeType)

Defined in: [WAProto/index.d.ts:12273](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12273)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### PERSONALIZED[​](#personalized "Direct link to PERSONALIZED")

> **PERSONALIZED**: `0`

Defined in: [WAProto/index.d.ts:12274](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12274)

---

<a name="merchantpaymentpartneraction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MerchantPaymentPartnerAction/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MerchantPaymentPartnerAction/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Status](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MerchantPaymentPartnerAction/enumerations/Status)

---

<a name="enumeration-status"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MerchantPaymentPartnerAction/enumerations/Status](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/MerchantPaymentPartnerAction/enumerations/Status)

Defined in: [WAProto/index.d.ts:12318](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12318)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### ACTIVE[​](#active "Direct link to ACTIVE")

> **ACTIVE**: `0`

Defined in: [WAProto/index.d.ts:12319](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12319)

* * *

### INACTIVE[​](#inactive "Direct link to INACTIVE")

> **INACTIVE**: `1`

Defined in: [WAProto/index.d.ts:12320](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12320)

---

<a name="noteeditaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/NoteEditAction/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/NoteEditAction/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [NoteType](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/NoteEditAction/enumerations/NoteType)

---

<a name="enumeration-notetype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/NoteEditAction/enumerations/NoteType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/NoteEditAction/enumerations/NoteType)

Defined in: [WAProto/index.d.ts:12404](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12404)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### STRUCTURED[​](#structured "Direct link to STRUCTURED")

> **STRUCTURED**: `2`

Defined in: [WAProto/index.d.ts:12406](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12406)

* * *

### UNSTRUCTURED[​](#unstructured "Direct link to UNSTRUCTURED")

> **UNSTRUCTURED**: `1`

Defined in: [WAProto/index.d.ts:12405](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12405)

---

<a name="notificationactivitysettingaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/NotificationActivitySettingAction/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/NotificationActivitySettingAction/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [NotificationActivitySetting](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/NotificationActivitySettingAction/enumerations/NotificationActivitySetting)

---

<a name="enumeration-notificationactivitysetting"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/NotificationActivitySettingAction/enumerations/NotificationActivitySetting](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/NotificationActivitySettingAction/enumerations/NotificationActivitySetting)

Defined in: [WAProto/index.d.ts:12428](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12428)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### ALL\_MESSAGES[​](#all_messages "Direct link to ALL_MESSAGES")

> **ALL\_MESSAGES**: `1`

Defined in: [WAProto/index.d.ts:12430](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12430)

* * *

### DEFAULT\_ALL\_MESSAGES[​](#default_all_messages "Direct link to DEFAULT_ALL_MESSAGES")

> **DEFAULT\_ALL\_MESSAGES**: `0`

Defined in: [WAProto/index.d.ts:12429](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12429)

* * *

### DEFAULT\_HIGHLIGHTS[​](#default_highlights "Direct link to DEFAULT_HIGHLIGHTS")

> **DEFAULT\_HIGHLIGHTS**: `3`

Defined in: [WAProto/index.d.ts:12432](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12432)

* * *

### HIGHLIGHTS[​](#highlights "Direct link to HIGHLIGHTS")

> **HIGHLIGHTS**: `2`

Defined in: [WAProto/index.d.ts:12431](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12431)

---

<a name="paymenttosaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/PaymentTosAction/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/PaymentTosAction/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [PaymentNotice](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/PaymentTosAction/enumerations/PaymentNotice)

---

<a name="enumeration-paymentnotice"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/PaymentTosAction/enumerations/PaymentNotice](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/PaymentTosAction/enumerations/PaymentNotice)

Defined in: [WAProto/index.d.ts:12488](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12488)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### BR\_PAY\_PRIVACY\_POLICY[​](#br_pay_privacy_policy "Direct link to BR_PAY_PRIVACY_POLICY")

> **BR\_PAY\_PRIVACY\_POLICY**: `0`

Defined in: [WAProto/index.d.ts:12489](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12489)

---

<a name="privateprocessingsettingaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/PrivateProcessingSettingAction/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/PrivateProcessingSettingAction/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [PrivateProcessingStatus](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/PrivateProcessingSettingAction/enumerations/PrivateProcessingStatus)

---

<a name="enumeration-privateprocessingstatus"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/PrivateProcessingSettingAction/enumerations/PrivateProcessingStatus](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/PrivateProcessingSettingAction/enumerations/PrivateProcessingStatus)

Defined in: [WAProto/index.d.ts:12623](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12623)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### DISABLED[​](#disabled "Direct link to DISABLED")

> **DISABLED**: `2`

Defined in: [WAProto/index.d.ts:12626](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12626)

* * *

### ENABLED[​](#enabled "Direct link to ENABLED")

> **ENABLED**: `1`

Defined in: [WAProto/index.d.ts:12625](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12625)

* * *

### UNDEFINED[​](#undefined "Direct link to UNDEFINED")

> **UNDEFINED**: `0`

Defined in: [WAProto/index.d.ts:12624](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12624)

---

<a name="statusprivacyaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/StatusPrivacyAction/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/StatusPrivacyAction/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [StatusDistributionMode](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/StatusPrivacyAction/enumerations/StatusDistributionMode)

---

<a name="enumeration-statusdistributionmode"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/StatusPrivacyAction/enumerations/StatusDistributionMode](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/StatusPrivacyAction/enumerations/StatusDistributionMode)

Defined in: [WAProto/index.d.ts:12754](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12754)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### ALLOW\_LIST[​](#allow_list "Direct link to ALLOW_LIST")

> **ALLOW\_LIST**: `0`

Defined in: [WAProto/index.d.ts:12755](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12755)

* * *

### CLOSE\_FRIENDS[​](#close_friends "Direct link to CLOSE_FRIENDS")

> **CLOSE\_FRIENDS**: `3`

Defined in: [WAProto/index.d.ts:12758](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12758)

* * *

### CONTACTS[​](#contacts "Direct link to CONTACTS")

> **CONTACTS**: `2`

Defined in: [WAProto/index.d.ts:12757](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12757)

* * *

### DENY\_LIST[​](#deny_list "Direct link to DENY_LIST")

> **DENY\_LIST**: `1`

Defined in: [WAProto/index.d.ts:12756](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12756)

---

<a name="usernamechatstartmodeaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/UsernameChatStartModeAction/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/UsernameChatStartModeAction/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [ChatStartMode](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/UsernameChatStartModeAction/enumerations/ChatStartMode)

---

<a name="enumeration-chatstartmode"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/UsernameChatStartModeAction/enumerations/ChatStartMode](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/UsernameChatStartModeAction/enumerations/ChatStartMode)

Defined in: [WAProto/index.d.ts:12942](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12942)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### LID[​](#lid "Direct link to LID")

> **LID**: `1`

Defined in: [WAProto/index.d.ts:12943](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12943)

* * *

### PN[​](#pn "Direct link to PN")

> **PN**: `2`

Defined in: [WAProto/index.d.ts:12944](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12944)

---

<a name="waffleaccountlinkstateaction"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/WaffleAccountLinkStateAction/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/WaffleAccountLinkStateAction/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [AccountLinkState](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/WaffleAccountLinkStateAction/enumerations/AccountLinkState)

---

<a name="enumeration-accountlinkstate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/WaffleAccountLinkStateAction/enumerations/AccountLinkState](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/WaffleAccountLinkStateAction/enumerations/AccountLinkState)

Defined in: [WAProto/index.d.ts:12966](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12966)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### ACTIVE[​](#active "Direct link to ACTIVE")

> **ACTIVE**: `0`

Defined in: [WAProto/index.d.ts:12967](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12967)

* * *

### PAUSED[​](#paused "Direct link to PAUSED")

> **PAUSED**: `1`

Defined in: [WAProto/index.d.ts:12968](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12968)

* * *

### UNLINKED[​](#unlinked "Direct link to UNLINKED")

> **UNLINKED**: `2`

Defined in: [WAProto/index.d.ts:12969](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L12969)

---

<a name="syncdmutation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncdMutation/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncdMutation/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [SyncdOperation](/docs/api/namespaces/proto/namespaces/SyncdMutation/enumerations/SyncdOperation)

---

<a name="enumeration-syncdoperation"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncdMutation/enumerations/SyncdOperation](https://baileys.wiki/docs/api/namespaces/proto/namespaces/SyncdMutation/enumerations/SyncdOperation)

Defined in: [WAProto/index.d.ts:13026](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13026)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### REMOVE[​](#remove "Direct link to REMOVE")

> **REMOVE**: `1`

Defined in: [WAProto/index.d.ts:13028](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13028)

* * *

### SET[​](#set "Direct link to SET")

> **SET**: `0`

Defined in: [WAProto/index.d.ts:13027](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13027)

---

<a name="templatebutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/TemplateButton/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/TemplateButton/)

## Classes[​](#classes "Direct link to Classes")

*   [CallButton](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/CallButton)
*   [QuickReplyButton](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/QuickReplyButton)
*   [URLButton](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/URLButton)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [ICallButton](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/ICallButton)
*   [IQuickReplyButton](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IQuickReplyButton)
*   [IURLButton](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IURLButton)

---

<a name="class-callbutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/TemplateButton/classes/CallButton](https://baileys.wiki/docs/api/namespaces/proto/namespaces/TemplateButton/classes/CallButton)

Defined in: [WAProto/index.d.ts:13202](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13202)

## Implements[​](#implements "Direct link to Implements")

*   [`ICallButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/ICallButton)

## Constructors[​](#constructors "Direct link to Constructors")

### new CallButton()[​](#new-callbutton "Direct link to new CallButton()")

> **new CallButton**(`p`?): [`CallButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/CallButton)

Defined in: [WAProto/index.d.ts:13203](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13203)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ICallButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/ICallButton)

#### Returns[​](#returns "Direct link to Returns")

[`CallButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/CallButton)

## Properties[​](#properties "Direct link to Properties")

### displayText?[​](#displaytext "Direct link to displayText?")

> `optional` **displayText**: `null` | [`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:13204](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13204)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ICallButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/ICallButton).[`displayText`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/ICallButton#displaytext)

* * *

### phoneNumber?[​](#phonenumber "Direct link to phoneNumber?")

> `optional` **phoneNumber**: `null` | [`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:13205](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13205)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ICallButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/ICallButton).[`phoneNumber`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/ICallButton#phonenumber)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13211](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13211)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`CallButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/CallButton)

Defined in: [WAProto/index.d.ts:13206](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13206)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ICallButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/ICallButton)

#### Returns[​](#returns-2 "Direct link to Returns")

[`CallButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/CallButton)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`CallButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/CallButton)

Defined in: [WAProto/index.d.ts:13208](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13208)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`CallButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/CallButton)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13207](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13207)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ICallButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/ICallButton)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`CallButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/CallButton)

Defined in: [WAProto/index.d.ts:13209](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13209)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`CallButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/CallButton)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13212](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13212)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13210](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13210)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`CallButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/CallButton)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-quickreplybutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/TemplateButton/classes/QuickReplyButton](https://baileys.wiki/docs/api/namespaces/proto/namespaces/TemplateButton/classes/QuickReplyButton)

Defined in: [WAProto/index.d.ts:13220](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13220)

## Implements[​](#implements "Direct link to Implements")

*   [`IQuickReplyButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IQuickReplyButton)

## Constructors[​](#constructors "Direct link to Constructors")

### new QuickReplyButton()[​](#new-quickreplybutton "Direct link to new QuickReplyButton()")

> **new QuickReplyButton**(`p`?): [`QuickReplyButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/QuickReplyButton)

Defined in: [WAProto/index.d.ts:13221](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13221)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IQuickReplyButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IQuickReplyButton)

#### Returns[​](#returns "Direct link to Returns")

[`QuickReplyButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/QuickReplyButton)

## Properties[​](#properties "Direct link to Properties")

### displayText?[​](#displaytext "Direct link to displayText?")

> `optional` **displayText**: `null` | [`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:13222](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13222)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IQuickReplyButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IQuickReplyButton).[`displayText`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IQuickReplyButton#displaytext)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:13223](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13223)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IQuickReplyButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IQuickReplyButton).[`id`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IQuickReplyButton#id)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13229](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13229)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`QuickReplyButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/QuickReplyButton)

Defined in: [WAProto/index.d.ts:13224](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13224)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IQuickReplyButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IQuickReplyButton)

#### Returns[​](#returns-2 "Direct link to Returns")

[`QuickReplyButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/QuickReplyButton)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`QuickReplyButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/QuickReplyButton)

Defined in: [WAProto/index.d.ts:13226](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13226)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`QuickReplyButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/QuickReplyButton)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13225](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13225)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IQuickReplyButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IQuickReplyButton)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`QuickReplyButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/QuickReplyButton)

Defined in: [WAProto/index.d.ts:13227](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13227)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`QuickReplyButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/QuickReplyButton)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13230](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13230)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13228](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13228)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`QuickReplyButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/QuickReplyButton)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="class-urlbutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/TemplateButton/classes/URLButton](https://baileys.wiki/docs/api/namespaces/proto/namespaces/TemplateButton/classes/URLButton)

Defined in: [WAProto/index.d.ts:13238](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13238)

## Implements[​](#implements "Direct link to Implements")

*   [`IURLButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IURLButton)

## Constructors[​](#constructors "Direct link to Constructors")

### new URLButton()[​](#new-urlbutton "Direct link to new URLButton()")

> **new URLButton**(`p`?): [`URLButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/URLButton)

Defined in: [WAProto/index.d.ts:13239](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13239)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IURLButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IURLButton)

#### Returns[​](#returns "Direct link to Returns")

[`URLButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/URLButton)

## Properties[​](#properties "Direct link to Properties")

### displayText?[​](#displaytext "Direct link to displayText?")

> `optional` **displayText**: `null` | [`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:13240](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13240)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IURLButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IURLButton).[`displayText`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IURLButton#displaytext)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | [`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:13241](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13241)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IURLButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IURLButton).[`url`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IURLButton#url)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13247](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13247)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`URLButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/URLButton)

Defined in: [WAProto/index.d.ts:13242](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13242)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IURLButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IURLButton)

#### Returns[​](#returns-2 "Direct link to Returns")

[`URLButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/URLButton)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`URLButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/URLButton)

Defined in: [WAProto/index.d.ts:13244](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13244)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`URLButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/URLButton)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13243](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13243)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IURLButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IURLButton)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`URLButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/URLButton)

Defined in: [WAProto/index.d.ts:13245](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13245)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`URLButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/URLButton)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13248](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13248)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13246](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13246)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`URLButton`](/docs/api/namespaces/proto/namespaces/TemplateButton/classes/URLButton)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-icallbutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/ICallButton](https://baileys.wiki/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/ICallButton)

Defined in: [WAProto/index.d.ts:13197](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13197)

## Properties[​](#properties "Direct link to Properties")

### displayText?[​](#displaytext "Direct link to displayText?")

> `optional` **displayText**: `null` | [`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:13198](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13198)

* * *

### phoneNumber?[​](#phonenumber "Direct link to phoneNumber?")

> `optional` **phoneNumber**: `null` | [`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:13199](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13199)

---

<a name="interface-iquickreplybutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IQuickReplyButton](https://baileys.wiki/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IQuickReplyButton)

Defined in: [WAProto/index.d.ts:13215](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13215)

## Properties[​](#properties "Direct link to Properties")

### displayText?[​](#displaytext "Direct link to displayText?")

> `optional` **displayText**: `null` | [`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:13216](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13216)

* * *

### id?[​](#id "Direct link to id?")

> `optional` **id**: `null` | `string`

Defined in: [WAProto/index.d.ts:13217](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13217)

---

<a name="interface-iurlbutton"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IURLButton](https://baileys.wiki/docs/api/namespaces/proto/namespaces/TemplateButton/interfaces/IURLButton)

Defined in: [WAProto/index.d.ts:13233](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13233)

## Properties[​](#properties "Direct link to Properties")

### displayText?[​](#displaytext "Direct link to displayText?")

> `optional` **displayText**: `null` | [`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:13234](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13234)

* * *

### url?[​](#url "Direct link to url?")

> `optional` **url**: `null` | [`IHighlyStructuredMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHighlyStructuredMessage)

Defined in: [WAProto/index.d.ts:13235](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13235)

---

<a name="threadid"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ThreadID/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ThreadID/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [ThreadType](/docs/api/namespaces/proto/namespaces/ThreadID/enumerations/ThreadType)

---

<a name="enumeration-threadtype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/ThreadID/enumerations/ThreadType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/ThreadID/enumerations/ThreadType)

Defined in: [WAProto/index.d.ts:13272](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13272)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### AI\_THREAD[​](#ai_thread "Direct link to AI_THREAD")

> **AI\_THREAD**: `2`

Defined in: [WAProto/index.d.ts:13275](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13275)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:13273](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13273)

* * *

### VIEW\_REPLIES[​](#view_replies "Direct link to VIEW_REPLIES")

> **VIEW\_REPLIES**: `1`

Defined in: [WAProto/index.d.ts:13274](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13274)

---

<a name="urltrackingmap"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/UrlTrackingMap/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/UrlTrackingMap/)

## Classes[​](#classes "Direct link to Classes")

*   [UrlTrackingMapElement](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/classes/UrlTrackingMapElement)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IUrlTrackingMapElement](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/interfaces/IUrlTrackingMapElement)

---

<a name="class-urltrackingmapelement"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/UrlTrackingMap/classes/UrlTrackingMapElement](https://baileys.wiki/docs/api/namespaces/proto/namespaces/UrlTrackingMap/classes/UrlTrackingMapElement)

Defined in: [WAProto/index.d.ts:13304](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13304)

## Implements[​](#implements "Direct link to Implements")

*   [`IUrlTrackingMapElement`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/interfaces/IUrlTrackingMapElement)

## Constructors[​](#constructors "Direct link to Constructors")

### new UrlTrackingMapElement()[​](#new-urltrackingmapelement "Direct link to new UrlTrackingMapElement()")

> **new UrlTrackingMapElement**(`p`?): [`UrlTrackingMapElement`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/classes/UrlTrackingMapElement)

Defined in: [WAProto/index.d.ts:13305](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13305)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IUrlTrackingMapElement`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/interfaces/IUrlTrackingMapElement)

#### Returns[​](#returns "Direct link to Returns")

[`UrlTrackingMapElement`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/classes/UrlTrackingMapElement)

## Properties[​](#properties "Direct link to Properties")

### cardIndex?[​](#cardindex "Direct link to cardIndex?")

> `optional` **cardIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:13309](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13309)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IUrlTrackingMapElement`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/interfaces/IUrlTrackingMapElement).[`cardIndex`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/interfaces/IUrlTrackingMapElement#cardindex)

* * *

### consentedUsersUrl?[​](#consentedusersurl "Direct link to consentedUsersUrl?")

> `optional` **consentedUsersUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:13308](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13308)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IUrlTrackingMapElement`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/interfaces/IUrlTrackingMapElement).[`consentedUsersUrl`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/interfaces/IUrlTrackingMapElement#consentedusersurl)

* * *

### originalUrl?[​](#originalurl "Direct link to originalUrl?")

> `optional` **originalUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:13306](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13306)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IUrlTrackingMapElement`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/interfaces/IUrlTrackingMapElement).[`originalUrl`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/interfaces/IUrlTrackingMapElement#originalurl)

* * *

### unconsentedUsersUrl?[​](#unconsentedusersurl "Direct link to unconsentedUsersUrl?")

> `optional` **unconsentedUsersUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:13307](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13307)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IUrlTrackingMapElement`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/interfaces/IUrlTrackingMapElement).[`unconsentedUsersUrl`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/interfaces/IUrlTrackingMapElement#unconsentedusersurl)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13315](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13315)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`UrlTrackingMapElement`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/classes/UrlTrackingMapElement)

Defined in: [WAProto/index.d.ts:13310](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13310)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IUrlTrackingMapElement`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/interfaces/IUrlTrackingMapElement)

#### Returns[​](#returns-2 "Direct link to Returns")

[`UrlTrackingMapElement`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/classes/UrlTrackingMapElement)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`UrlTrackingMapElement`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/classes/UrlTrackingMapElement)

Defined in: [WAProto/index.d.ts:13312](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13312)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`UrlTrackingMapElement`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/classes/UrlTrackingMapElement)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13311](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13311)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IUrlTrackingMapElement`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/interfaces/IUrlTrackingMapElement)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`UrlTrackingMapElement`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/classes/UrlTrackingMapElement)

Defined in: [WAProto/index.d.ts:13313](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13313)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`UrlTrackingMapElement`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/classes/UrlTrackingMapElement)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13316](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13316)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13314](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13314)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`UrlTrackingMapElement`](/docs/api/namespaces/proto/namespaces/UrlTrackingMap/classes/UrlTrackingMapElement)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-iurltrackingmapelement"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/UrlTrackingMap/interfaces/IUrlTrackingMapElement](https://baileys.wiki/docs/api/namespaces/proto/namespaces/UrlTrackingMap/interfaces/IUrlTrackingMapElement)

Defined in: [WAProto/index.d.ts:13297](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13297)

## Properties[​](#properties "Direct link to Properties")

### cardIndex?[​](#cardindex "Direct link to cardIndex?")

> `optional` **cardIndex**: `null` | `number`

Defined in: [WAProto/index.d.ts:13301](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13301)

* * *

### consentedUsersUrl?[​](#consentedusersurl "Direct link to consentedUsersUrl?")

> `optional` **consentedUsersUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:13300](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13300)

* * *

### originalUrl?[​](#originalurl "Direct link to originalUrl?")

> `optional` **originalUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:13298](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13298)

* * *

### unconsentedUsersUrl?[​](#unconsentedusersurl "Direct link to unconsentedUsersUrl?")

> `optional` **unconsentedUsersUrl**: `null` | `string`

Defined in: [WAProto/index.d.ts:13299](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13299)

---

<a name="userpassword"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/UserPassword/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/UserPassword/)

## Namespaces[​](#namespaces "Direct link to Namespaces")

*   [TransformerArg](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Encoding](/docs/api/namespaces/proto/namespaces/UserPassword/enumerations/Encoding)
*   [Transformer](/docs/api/namespaces/proto/namespaces/UserPassword/enumerations/Transformer)

## Classes[​](#classes "Direct link to Classes")

*   [TransformerArg](/docs/api/namespaces/proto/namespaces/UserPassword/classes/TransformerArg)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [ITransformerArg](/docs/api/namespaces/proto/namespaces/UserPassword/interfaces/ITransformerArg)

---

<a name="class-transformerarg"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/UserPassword/classes/TransformerArg](https://baileys.wiki/docs/api/namespaces/proto/namespaces/UserPassword/classes/TransformerArg)

Defined in: [WAProto/index.d.ts:13360](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13360)

## Implements[​](#implements "Direct link to Implements")

*   [`ITransformerArg`](/docs/api/namespaces/proto/namespaces/UserPassword/interfaces/ITransformerArg)

## Constructors[​](#constructors "Direct link to Constructors")

### new TransformerArg()[​](#new-transformerarg "Direct link to new TransformerArg()")

> **new TransformerArg**(`p`?): [`TransformerArg`](/docs/api/namespaces/proto/namespaces/UserPassword/classes/TransformerArg)

Defined in: [WAProto/index.d.ts:13361](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13361)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`ITransformerArg`](/docs/api/namespaces/proto/namespaces/UserPassword/interfaces/ITransformerArg)

#### Returns[​](#returns "Direct link to Returns")

[`TransformerArg`](/docs/api/namespaces/proto/namespaces/UserPassword/classes/TransformerArg)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `string`

Defined in: [WAProto/index.d.ts:13362](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13362)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ITransformerArg`](/docs/api/namespaces/proto/namespaces/UserPassword/interfaces/ITransformerArg).[`key`](/docs/api/namespaces/proto/namespaces/UserPassword/interfaces/ITransformerArg#key)

* * *

### value?[​](#value "Direct link to value?")

> `optional` **value**: `null` | [`IValue`](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/interfaces/IValue)

Defined in: [WAProto/index.d.ts:13363](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13363)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ITransformerArg`](/docs/api/namespaces/proto/namespaces/UserPassword/interfaces/ITransformerArg).[`value`](/docs/api/namespaces/proto/namespaces/UserPassword/interfaces/ITransformerArg#value)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13369](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13369)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`TransformerArg`](/docs/api/namespaces/proto/namespaces/UserPassword/classes/TransformerArg)

Defined in: [WAProto/index.d.ts:13364](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13364)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`ITransformerArg`](/docs/api/namespaces/proto/namespaces/UserPassword/interfaces/ITransformerArg)

#### Returns[​](#returns-2 "Direct link to Returns")

[`TransformerArg`](/docs/api/namespaces/proto/namespaces/UserPassword/classes/TransformerArg)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`TransformerArg`](/docs/api/namespaces/proto/namespaces/UserPassword/classes/TransformerArg)

Defined in: [WAProto/index.d.ts:13366](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13366)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`TransformerArg`](/docs/api/namespaces/proto/namespaces/UserPassword/classes/TransformerArg)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13365](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13365)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`ITransformerArg`](/docs/api/namespaces/proto/namespaces/UserPassword/interfaces/ITransformerArg)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`TransformerArg`](/docs/api/namespaces/proto/namespaces/UserPassword/classes/TransformerArg)

Defined in: [WAProto/index.d.ts:13367](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13367)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`TransformerArg`](/docs/api/namespaces/proto/namespaces/UserPassword/classes/TransformerArg)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13370](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13370)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13368](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13368)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`TransformerArg`](/docs/api/namespaces/proto/namespaces/UserPassword/classes/TransformerArg)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="enumeration-encoding"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/UserPassword/enumerations/Encoding](https://baileys.wiki/docs/api/namespaces/proto/namespaces/UserPassword/enumerations/Encoding)

Defined in: [WAProto/index.d.ts:13344](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13344)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### UTF8[​](#utf8 "Direct link to UTF8")

> **UTF8**: `0`

Defined in: [WAProto/index.d.ts:13345](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13345)

* * *

### UTF8\_BROKEN[​](#utf8_broken "Direct link to UTF8_BROKEN")

> **UTF8\_BROKEN**: `1`

Defined in: [WAProto/index.d.ts:13346](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13346)

---

<a name="enumeration-transformer"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/UserPassword/enumerations/Transformer](https://baileys.wiki/docs/api/namespaces/proto/namespaces/UserPassword/enumerations/Transformer)

Defined in: [WAProto/index.d.ts:13349](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13349)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### NONE[​](#none "Direct link to NONE")

> **NONE**: `0`

Defined in: [WAProto/index.d.ts:13350](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13350)

* * *

### PBKDF2\_HMAC\_SHA384[​](#pbkdf2_hmac_sha384 "Direct link to PBKDF2_HMAC_SHA384")

> **PBKDF2\_HMAC\_SHA384**: `2`

Defined in: [WAProto/index.d.ts:13352](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13352)

* * *

### PBKDF2\_HMAC\_SHA512[​](#pbkdf2_hmac_sha512 "Direct link to PBKDF2_HMAC_SHA512")

> **PBKDF2\_HMAC\_SHA512**: `1`

Defined in: [WAProto/index.d.ts:13351](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13351)

---

<a name="interface-itransformerarg"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/UserPassword/interfaces/ITransformerArg](https://baileys.wiki/docs/api/namespaces/proto/namespaces/UserPassword/interfaces/ITransformerArg)

Defined in: [WAProto/index.d.ts:13355](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13355)

## Properties[​](#properties "Direct link to Properties")

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `string`

Defined in: [WAProto/index.d.ts:13356](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13356)

* * *

### value?[​](#value "Direct link to value?")

> `optional` **value**: `null` | [`IValue`](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/interfaces/IValue)

Defined in: [WAProto/index.d.ts:13357](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13357)

---

<a name="transformerarg"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/)

## Classes[​](#classes "Direct link to Classes")

*   [Value](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/classes/Value)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IValue](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/interfaces/IValue)

---

<a name="class-value"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/classes/Value](https://baileys.wiki/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/classes/Value)

Defined in: [WAProto/index.d.ts:13380](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13380)

## Implements[​](#implements "Direct link to Implements")

*   [`IValue`](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/interfaces/IValue)

## Constructors[​](#constructors "Direct link to Constructors")

### new Value()[​](#new-value "Direct link to new Value()")

> **new Value**(`p`?): [`Value`](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/classes/Value)

Defined in: [WAProto/index.d.ts:13381](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13381)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IValue`](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/interfaces/IValue)

#### Returns[​](#returns "Direct link to Returns")

[`Value`](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/classes/Value)

## Properties[​](#properties "Direct link to Properties")

### asBlob?[​](#asblob "Direct link to asBlob?")

> `optional` **asBlob**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13382](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13382)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IValue`](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/interfaces/IValue).[`asBlob`](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/interfaces/IValue#asblob)

* * *

### asUnsignedInteger?[​](#asunsignedinteger "Direct link to asUnsignedInteger?")

> `optional` **asUnsignedInteger**: `null` | `number`

Defined in: [WAProto/index.d.ts:13383](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13383)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IValue`](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/interfaces/IValue).[`asUnsignedInteger`](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/interfaces/IValue#asunsignedinteger)

* * *

### value?[​](#value "Direct link to value?")

> `optional` **value**: `"asBlob"` | `"asUnsignedInteger"`

Defined in: [WAProto/index.d.ts:13384](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13384)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13390](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13390)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Value`](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/classes/Value)

Defined in: [WAProto/index.d.ts:13385](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13385)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IValue`](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/interfaces/IValue)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Value`](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/classes/Value)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Value`](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/classes/Value)

Defined in: [WAProto/index.d.ts:13387](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13387)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Value`](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/classes/Value)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13386](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13386)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IValue`](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/interfaces/IValue)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Value`](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/classes/Value)

Defined in: [WAProto/index.d.ts:13388](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13388)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Value`](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/classes/Value)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13391](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13391)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13389](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13389)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Value`](/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/classes/Value)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-ivalue"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/interfaces/IValue](https://baileys.wiki/docs/api/namespaces/proto/namespaces/UserPassword/namespaces/TransformerArg/interfaces/IValue)

Defined in: [WAProto/index.d.ts:13375](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13375)

## Properties[​](#properties "Direct link to Properties")

### asBlob?[​](#asblob "Direct link to asBlob?")

> `optional` **asBlob**: `null` | `Uint8Array`<`ArrayBufferLike`\>

Defined in: [WAProto/index.d.ts:13376](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13376)

* * *

### asUnsignedInteger?[​](#asunsignedinteger "Direct link to asUnsignedInteger?")

> `optional` **asUnsignedInteger**: `null` | `number`

Defined in: [WAProto/index.d.ts:13377](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13377)

---

<a name="verifiednamecertificate"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/)

## Classes[​](#classes "Direct link to Classes")

*   [Details](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/classes/Details)

## Interfaces[​](#interfaces "Direct link to Interfaces")

*   [IDetails](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/interfaces/IDetails)

---

<a name="class-details"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/classes/Details](https://baileys.wiki/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/classes/Details)

Defined in: [WAProto/index.d.ts:13452](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13452)

## Implements[​](#implements "Direct link to Implements")

*   [`IDetails`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/interfaces/IDetails)

## Constructors[​](#constructors "Direct link to Constructors")

### new Details()[​](#new-details "Direct link to new Details()")

> **new Details**(`p`?): [`Details`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/classes/Details)

Defined in: [WAProto/index.d.ts:13453](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13453)

#### Parameters[​](#parameters "Direct link to Parameters")

##### p?[​](#p "Direct link to p?")

[`IDetails`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/interfaces/IDetails)

#### Returns[​](#returns "Direct link to Returns")

[`Details`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/classes/Details)

## Properties[​](#properties "Direct link to Properties")

### issuer?[​](#issuer "Direct link to issuer?")

> `optional` **issuer**: `null` | `string`

Defined in: [WAProto/index.d.ts:13455](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13455)

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IDetails`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/interfaces/IDetails).[`issuer`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/interfaces/IDetails#issuer)

* * *

### issueTime?[​](#issuetime "Direct link to issueTime?")

> `optional` **issueTime**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13458](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13458)

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IDetails`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/interfaces/IDetails).[`issueTime`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/interfaces/IDetails#issuetime)

* * *

### localizedNames[​](#localizednames "Direct link to localizedNames")

> **localizedNames**: [`ILocalizedName`](/docs/api/namespaces/proto/interfaces/ILocalizedName)\[\]

Defined in: [WAProto/index.d.ts:13457](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13457)

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IDetails`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/interfaces/IDetails).[`localizedNames`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/interfaces/IDetails#localizednames)

* * *

### serial?[​](#serial "Direct link to serial?")

> `optional` **serial**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13454](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13454)

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IDetails`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/interfaces/IDetails).[`serial`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/interfaces/IDetails#serial)

* * *

### verifiedName?[​](#verifiedname "Direct link to verifiedName?")

> `optional` **verifiedName**: `null` | `string`

Defined in: [WAProto/index.d.ts:13456](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13456)

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IDetails`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/interfaces/IDetails).[`verifiedName`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/interfaces/IDetails#verifiedname)

## Methods[​](#methods "Direct link to Methods")

### toJSON()[​](#tojson "Direct link to toJSON()")

> **toJSON**(): `object`

Defined in: [WAProto/index.d.ts:13464](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13464)

#### Returns[​](#returns-1 "Direct link to Returns")

`object`

* * *

### create()[​](#create "Direct link to create()")

> `static` **create**(`properties`?): [`Details`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/classes/Details)

Defined in: [WAProto/index.d.ts:13459](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13459)

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### properties?[​](#properties-1 "Direct link to properties?")

[`IDetails`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/interfaces/IDetails)

#### Returns[​](#returns-2 "Direct link to Returns")

[`Details`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/classes/Details)

* * *

### decode()[​](#decode "Direct link to decode()")

> `static` **decode**(`r`, `l`?): [`Details`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/classes/Details)

Defined in: [WAProto/index.d.ts:13461](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13461)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### r[​](#r "Direct link to r")

`Uint8Array`<`ArrayBufferLike`\> | `Reader`

##### l?[​](#l "Direct link to l?")

`number`

#### Returns[​](#returns-3 "Direct link to Returns")

[`Details`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/classes/Details)

* * *

### encode()[​](#encode "Direct link to encode()")

> `static` **encode**(`m`, `w`?): `Writer`

Defined in: [WAProto/index.d.ts:13460](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13460)

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### m[​](#m "Direct link to m")

[`IDetails`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/interfaces/IDetails)

##### w?[​](#w "Direct link to w?")

`Writer`

#### Returns[​](#returns-4 "Direct link to Returns")

`Writer`

* * *

### fromObject()[​](#fromobject "Direct link to fromObject()")

> `static` **fromObject**(`d`): [`Details`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/classes/Details)

Defined in: [WAProto/index.d.ts:13462](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13462)

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### d[​](#d "Direct link to d")

#### Returns[​](#returns-5 "Direct link to Returns")

[`Details`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/classes/Details)

* * *

### getTypeUrl()[​](#gettypeurl "Direct link to getTypeUrl()")

> `static` **getTypeUrl**(`typeUrlPrefix`?): `string`

Defined in: [WAProto/index.d.ts:13465](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13465)

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### typeUrlPrefix?[​](#typeurlprefix "Direct link to typeUrlPrefix?")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

* * *

### toObject()[​](#toobject "Direct link to toObject()")

> `static` **toObject**(`m`, `o`?): `object`

Defined in: [WAProto/index.d.ts:13463](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13463)

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### m[​](#m-1 "Direct link to m")

[`Details`](/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/classes/Details)

##### o?[​](#o "Direct link to o?")

`IConversionOptions`

#### Returns[​](#returns-7 "Direct link to Returns")

`object`

---

<a name="interface-idetails"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/interfaces/IDetails](https://baileys.wiki/docs/api/namespaces/proto/namespaces/VerifiedNameCertificate/interfaces/IDetails)

Defined in: [WAProto/index.d.ts:13444](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13444)

## Properties[​](#properties "Direct link to Properties")

### issuer?[​](#issuer "Direct link to issuer?")

> `optional` **issuer**: `null` | `string`

Defined in: [WAProto/index.d.ts:13446](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13446)

* * *

### issueTime?[​](#issuetime "Direct link to issueTime?")

> `optional` **issueTime**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13449](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13449)

* * *

### localizedNames?[​](#localizednames "Direct link to localizedNames?")

> `optional` **localizedNames**: `null` | [`ILocalizedName`](/docs/api/namespaces/proto/interfaces/ILocalizedName)\[\]

Defined in: [WAProto/index.d.ts:13448](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13448)

* * *

### serial?[​](#serial "Direct link to serial?")

> `optional` **serial**: `null` | `number` | `Long`

Defined in: [WAProto/index.d.ts:13445](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13445)

* * *

### verifiedName?[​](#verifiedname "Direct link to verifiedName?")

> `optional` **verifiedName**: `null` | `string`

Defined in: [WAProto/index.d.ts:13447](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13447)

---

<a name="webfeatures"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/WebFeatures/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/WebFeatures/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [Flag](/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

---

<a name="enumeration-flag"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag](https://baileys.wiki/docs/api/namespaces/proto/namespaces/WebFeatures/enumerations/Flag)

Defined in: [WAProto/index.d.ts:13593](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13593)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### DEVELOPMENT[​](#development "Direct link to DEVELOPMENT")

> **DEVELOPMENT**: `2`

Defined in: [WAProto/index.d.ts:13596](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13596)

* * *

### FORCE\_UPGRADE[​](#force_upgrade "Direct link to FORCE_UPGRADE")

> **FORCE\_UPGRADE**: `1`

Defined in: [WAProto/index.d.ts:13595](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13595)

* * *

### NOT\_STARTED[​](#not_started "Direct link to NOT_STARTED")

> **NOT\_STARTED**: `0`

Defined in: [WAProto/index.d.ts:13594](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13594)

* * *

### PRODUCTION[​](#production "Direct link to PRODUCTION")

> **PRODUCTION**: `3`

Defined in: [WAProto/index.d.ts:13597](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13597)

---

<a name="webmessageinfo"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/WebMessageInfo/](https://baileys.wiki/docs/api/namespaces/proto/namespaces/WebMessageInfo/)

## Enumerations[​](#enumerations "Direct link to Enumerations")

*   [BizPrivacyStatus](/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/BizPrivacyStatus)
*   [Status](/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/Status)
*   [StubType](/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/StubType)

---

<a name="enumeration-bizprivacystatus"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/BizPrivacyStatus](https://baileys.wiki/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/BizPrivacyStatus)

Defined in: [WAProto/index.d.ts:13754](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13754)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### BSP[​](#bsp "Direct link to BSP")

> **BSP**: `1`

Defined in: [WAProto/index.d.ts:13757](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13757)

* * *

### BSP\_AND\_FB[​](#bsp_and_fb "Direct link to BSP_AND_FB")

> **BSP\_AND\_FB**: `3`

Defined in: [WAProto/index.d.ts:13758](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13758)

* * *

### E2EE[​](#e2ee "Direct link to E2EE")

> **E2EE**: `0`

Defined in: [WAProto/index.d.ts:13755](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13755)

* * *

### FB[​](#fb "Direct link to FB")

> **FB**: `2`

Defined in: [WAProto/index.d.ts:13756](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13756)

---

<a name="enumeration-status"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/Status](https://baileys.wiki/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/Status)

Defined in: [WAProto/index.d.ts:13761](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13761)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### DELIVERY\_ACK[​](#delivery_ack "Direct link to DELIVERY_ACK")

> **DELIVERY\_ACK**: `3`

Defined in: [WAProto/index.d.ts:13765](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13765)

* * *

### ERROR[​](#error "Direct link to ERROR")

> **ERROR**: `0`

Defined in: [WAProto/index.d.ts:13762](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13762)

* * *

### PENDING[​](#pending "Direct link to PENDING")

> **PENDING**: `1`

Defined in: [WAProto/index.d.ts:13763](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13763)

* * *

### PLAYED[​](#played "Direct link to PLAYED")

> **PLAYED**: `5`

Defined in: [WAProto/index.d.ts:13767](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13767)

* * *

### READ[​](#read "Direct link to READ")

> **READ**: `4`

Defined in: [WAProto/index.d.ts:13766](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13766)

* * *

### SERVER\_ACK[​](#server_ack "Direct link to SERVER_ACK")

> **SERVER\_ACK**: `2`

Defined in: [WAProto/index.d.ts:13764](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13764)

---

<a name="enumeration-stubtype"></a>

> Source: [https://baileys.wiki/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/StubType](https://baileys.wiki/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/StubType)

Defined in: [WAProto/index.d.ts:13770](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13770)

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### ADMIN\_REVOKE[​](#admin_revoke "Direct link to ADMIN_REVOKE")

> **ADMIN\_REVOKE**: `132`

Defined in: [WAProto/index.d.ts:13903](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13903)

* * *

### BIZ\_AUTOMATICALLY\_LABELED\_CHAT\_SYSTEM\_MESSAGE[​](#biz_automatically_labeled_chat_system_message "Direct link to BIZ_AUTOMATICALLY_LABELED_CHAT_SYSTEM_MESSAGE")

> **BIZ\_AUTOMATICALLY\_LABELED\_CHAT\_SYSTEM\_MESSAGE**: `218`

Defined in: [WAProto/index.d.ts:13989](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13989)

* * *

### BIZ\_BOT\_1P\_MESSAGING\_ENABLED[​](#biz_bot_1p_messaging_enabled "Direct link to BIZ_BOT_1P_MESSAGING_ENABLED")

> **BIZ\_BOT\_1P\_MESSAGING\_ENABLED**: `192`

Defined in: [WAProto/index.d.ts:13963](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13963)

* * *

### BIZ\_BOT\_3P\_MESSAGING\_ENABLED[​](#biz_bot_3p_messaging_enabled "Direct link to BIZ_BOT_3P_MESSAGING_ENABLED")

> **BIZ\_BOT\_3P\_MESSAGING\_ENABLED**: `197`

Defined in: [WAProto/index.d.ts:13968](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13968)

* * *

### BIZ\_CHAT\_ASSIGNMENT[​](#biz_chat_assignment "Direct link to BIZ_CHAT_ASSIGNMENT")

> **BIZ\_CHAT\_ASSIGNMENT**: `154`

Defined in: [WAProto/index.d.ts:13925](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13925)

* * *

### BIZ\_CHAT\_ASSIGNMENT\_UNASSIGN[​](#biz_chat_assignment_unassign "Direct link to BIZ_CHAT_ASSIGNMENT_UNASSIGN")

> **BIZ\_CHAT\_ASSIGNMENT\_UNASSIGN**: `160`

Defined in: [WAProto/index.d.ts:13931](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13931)

* * *

### BIZ\_COEX\_PRIVACY\_INIT[​](#biz_coex_privacy_init "Direct link to BIZ_COEX_PRIVACY_INIT")

> **BIZ\_COEX\_PRIVACY\_INIT**: `201`

Defined in: [WAProto/index.d.ts:13972](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13972)

* * *

### BIZ\_COEX\_PRIVACY\_INIT\_SELF[​](#biz_coex_privacy_init_self "Direct link to BIZ_COEX_PRIVACY_INIT_SELF")

> **BIZ\_COEX\_PRIVACY\_INIT\_SELF**: `194`

Defined in: [WAProto/index.d.ts:13965](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13965)

* * *

### BIZ\_COEX\_PRIVACY\_TRANSITION[​](#biz_coex_privacy_transition "Direct link to BIZ_COEX_PRIVACY_TRANSITION")

> **BIZ\_COEX\_PRIVACY\_TRANSITION**: `202`

Defined in: [WAProto/index.d.ts:13973](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13973)

* * *

### BIZ\_COEX\_PRIVACY\_TRANSITION\_SELF[​](#biz_coex_privacy_transition_self "Direct link to BIZ_COEX_PRIVACY_TRANSITION_SELF")

> **BIZ\_COEX\_PRIVACY\_TRANSITION\_SELF**: `195`

Defined in: [WAProto/index.d.ts:13966](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13966)

* * *

### BIZ\_CUSTOMER\_3PD\_DATA\_SHARING\_OPT\_IN\_MESSAGE[​](#biz_customer_3pd_data_sharing_opt_in_message "Direct link to BIZ_CUSTOMER_3PD_DATA_SHARING_OPT_IN_MESSAGE")

> **BIZ\_CUSTOMER\_3PD\_DATA\_SHARING\_OPT\_IN\_MESSAGE**: `214`

Defined in: [WAProto/index.d.ts:13985](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13985)

* * *

### BIZ\_CUSTOMER\_3PD\_DATA\_SHARING\_OPT\_OUT\_MESSAGE[​](#biz_customer_3pd_data_sharing_opt_out_message "Direct link to BIZ_CUSTOMER_3PD_DATA_SHARING_OPT_OUT_MESSAGE")

> **BIZ\_CUSTOMER\_3PD\_DATA\_SHARING\_OPT\_OUT\_MESSAGE**: `215`

Defined in: [WAProto/index.d.ts:13986](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13986)

* * *

### BIZ\_INTRO\_BOTTOM[​](#biz_intro_bottom "Direct link to BIZ_INTRO_BOTTOM")

> **BIZ\_INTRO\_BOTTOM**: `63`

Defined in: [WAProto/index.d.ts:13834](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13834)

* * *

### BIZ\_INTRO\_TOP[​](#biz_intro_top "Direct link to BIZ_INTRO_TOP")

> **BIZ\_INTRO\_TOP**: `62`

Defined in: [WAProto/index.d.ts:13833](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13833)

* * *

### BIZ\_MOVE\_TO\_CONSUMER\_APP[​](#biz_move_to_consumer_app "Direct link to BIZ_MOVE_TO_CONSUMER_APP")

> **BIZ\_MOVE\_TO\_CONSUMER\_APP**: `65`

Defined in: [WAProto/index.d.ts:13836](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13836)

* * *

### BIZ\_NAME\_CHANGE[​](#biz_name_change "Direct link to BIZ_NAME_CHANGE")

> **BIZ\_NAME\_CHANGE**: `64`

Defined in: [WAProto/index.d.ts:13835](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13835)

* * *

### BIZ\_PRIVACY\_MODE\_INIT\_BSP[​](#biz_privacy_mode_init_bsp "Direct link to BIZ_PRIVACY_MODE_INIT_BSP")

> **BIZ\_PRIVACY\_MODE\_INIT\_BSP**: `127`

Defined in: [WAProto/index.d.ts:13898](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13898)

* * *

### BIZ\_PRIVACY\_MODE\_INIT\_FB[​](#biz_privacy_mode_init_fb "Direct link to BIZ_PRIVACY_MODE_INIT_FB")

> **BIZ\_PRIVACY\_MODE\_INIT\_FB**: `126`

Defined in: [WAProto/index.d.ts:13897](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13897)

* * *

### BIZ\_PRIVACY\_MODE\_TO\_BSP[​](#biz_privacy_mode_to_bsp "Direct link to BIZ_PRIVACY_MODE_TO_BSP")

> **BIZ\_PRIVACY\_MODE\_TO\_BSP**: `129`

Defined in: [WAProto/index.d.ts:13900](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13900)

* * *

### BIZ\_PRIVACY\_MODE\_TO\_FB[​](#biz_privacy_mode_to_fb "Direct link to BIZ_PRIVACY_MODE_TO_FB")

> **BIZ\_PRIVACY\_MODE\_TO\_FB**: `128`

Defined in: [WAProto/index.d.ts:13899](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13899)

* * *

### BIZ\_TWO\_TIER\_MIGRATION\_BOTTOM[​](#biz_two_tier_migration_bottom "Direct link to BIZ_TWO_TIER_MIGRATION_BOTTOM")

> **BIZ\_TWO\_TIER\_MIGRATION\_BOTTOM**: `67`

Defined in: [WAProto/index.d.ts:13838](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13838)

* * *

### BIZ\_TWO\_TIER\_MIGRATION\_TOP[​](#biz_two_tier_migration_top "Direct link to BIZ_TWO_TIER_MIGRATION_TOP")

> **BIZ\_TWO\_TIER\_MIGRATION\_TOP**: `66`

Defined in: [WAProto/index.d.ts:13837](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13837)

* * *

### BIZ\_VERIFIED\_TRANSITION\_BOTTOM\_TO\_TOP[​](#biz_verified_transition_bottom_to_top "Direct link to BIZ_VERIFIED_TRANSITION_BOTTOM_TO_TOP")

> **BIZ\_VERIFIED\_TRANSITION\_BOTTOM\_TO\_TOP**: `61`

Defined in: [WAProto/index.d.ts:13832](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13832)

* * *

### BIZ\_VERIFIED\_TRANSITION\_TOP\_TO\_BOTTOM[​](#biz_verified_transition_top_to_bottom "Direct link to BIZ_VERIFIED_TRANSITION_TOP_TO_BOTTOM")

> **BIZ\_VERIFIED\_TRANSITION\_TOP\_TO\_BOTTOM**: `60`

Defined in: [WAProto/index.d.ts:13831](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13831)

* * *

### BLOCK\_CONTACT[​](#block_contact "Direct link to BLOCK_CONTACT")

> **BLOCK\_CONTACT**: `122`

Defined in: [WAProto/index.d.ts:13893](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13893)

* * *

### BLUE\_MSG\_BSP\_FB\_TO\_BSP\_PREMISE[​](#blue_msg_bsp_fb_to_bsp_premise "Direct link to BLUE_MSG_BSP_FB_TO_BSP_PREMISE")

> **BLUE\_MSG\_BSP\_FB\_TO\_BSP\_PREMISE**: `76`

Defined in: [WAProto/index.d.ts:13847](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13847)

* * *

### BLUE\_MSG\_BSP\_FB\_TO\_SELF\_FB[​](#blue_msg_bsp_fb_to_self_fb "Direct link to BLUE_MSG_BSP_FB_TO_SELF_FB")

> **BLUE\_MSG\_BSP\_FB\_TO\_SELF\_FB**: `77`

Defined in: [WAProto/index.d.ts:13848](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13848)

* * *

### BLUE\_MSG\_BSP\_FB\_TO\_SELF\_PREMISE[​](#blue_msg_bsp_fb_to_self_premise "Direct link to BLUE_MSG_BSP_FB_TO_SELF_PREMISE")

> **BLUE\_MSG\_BSP\_FB\_TO\_SELF\_PREMISE**: `78`

Defined in: [WAProto/index.d.ts:13849](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13849)

* * *

### BLUE\_MSG\_BSP\_FB\_UNVERIFIED[​](#blue_msg_bsp_fb_unverified "Direct link to BLUE_MSG_BSP_FB_UNVERIFIED")

> **BLUE\_MSG\_BSP\_FB\_UNVERIFIED**: `79`

Defined in: [WAProto/index.d.ts:13850](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13850)

* * *

### BLUE\_MSG\_BSP\_FB\_UNVERIFIED\_TO\_BSP\_PREMISE\_VERIFIED[​](#blue_msg_bsp_fb_unverified_to_bsp_premise_verified "Direct link to BLUE_MSG_BSP_FB_UNVERIFIED_TO_BSP_PREMISE_VERIFIED")

> **BLUE\_MSG\_BSP\_FB\_UNVERIFIED\_TO\_BSP\_PREMISE\_VERIFIED**: `112`

Defined in: [WAProto/index.d.ts:13883](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13883)

* * *

### BLUE\_MSG\_BSP\_FB\_UNVERIFIED\_TO\_SELF\_FB\_VERIFIED[​](#blue_msg_bsp_fb_unverified_to_self_fb_verified "Direct link to BLUE_MSG_BSP_FB_UNVERIFIED_TO_SELF_FB_VERIFIED")

> **BLUE\_MSG\_BSP\_FB\_UNVERIFIED\_TO\_SELF\_FB\_VERIFIED**: `113`

Defined in: [WAProto/index.d.ts:13884](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13884)

* * *

### BLUE\_MSG\_BSP\_FB\_UNVERIFIED\_TO\_SELF\_PREMISE\_VERIFIED[​](#blue_msg_bsp_fb_unverified_to_self_premise_verified "Direct link to BLUE_MSG_BSP_FB_UNVERIFIED_TO_SELF_PREMISE_VERIFIED")

> **BLUE\_MSG\_BSP\_FB\_UNVERIFIED\_TO\_SELF\_PREMISE\_VERIFIED**: `80`

Defined in: [WAProto/index.d.ts:13851](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13851)

* * *

### BLUE\_MSG\_BSP\_FB\_VERIFIED[​](#blue_msg_bsp_fb_verified "Direct link to BLUE_MSG_BSP_FB_VERIFIED")

> **BLUE\_MSG\_BSP\_FB\_VERIFIED**: `81`

Defined in: [WAProto/index.d.ts:13852](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13852)

* * *

### BLUE\_MSG\_BSP\_FB\_VERIFIED\_TO\_BSP\_PREMISE\_UNVERIFIED[​](#blue_msg_bsp_fb_verified_to_bsp_premise_unverified "Direct link to BLUE_MSG_BSP_FB_VERIFIED_TO_BSP_PREMISE_UNVERIFIED")

> **BLUE\_MSG\_BSP\_FB\_VERIFIED\_TO\_BSP\_PREMISE\_UNVERIFIED**: `114`

Defined in: [WAProto/index.d.ts:13885](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13885)

* * *

### BLUE\_MSG\_BSP\_FB\_VERIFIED\_TO\_SELF\_FB\_UNVERIFIED[​](#blue_msg_bsp_fb_verified_to_self_fb_unverified "Direct link to BLUE_MSG_BSP_FB_VERIFIED_TO_SELF_FB_UNVERIFIED")

> **BLUE\_MSG\_BSP\_FB\_VERIFIED\_TO\_SELF\_FB\_UNVERIFIED**: `115`

Defined in: [WAProto/index.d.ts:13886](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13886)

* * *

### BLUE\_MSG\_BSP\_FB\_VERIFIED\_TO\_SELF\_PREMISE\_UNVERIFIED[​](#blue_msg_bsp_fb_verified_to_self_premise_unverified "Direct link to BLUE_MSG_BSP_FB_VERIFIED_TO_SELF_PREMISE_UNVERIFIED")

> **BLUE\_MSG\_BSP\_FB\_VERIFIED\_TO\_SELF\_PREMISE\_UNVERIFIED**: `82`

Defined in: [WAProto/index.d.ts:13853](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13853)

* * *

### BLUE\_MSG\_BSP\_PREMISE\_TO\_SELF\_PREMISE[​](#blue_msg_bsp_premise_to_self_premise "Direct link to BLUE_MSG_BSP_PREMISE_TO_SELF_PREMISE")

> **BLUE\_MSG\_BSP\_PREMISE\_TO\_SELF\_PREMISE**: `83`

Defined in: [WAProto/index.d.ts:13854](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13854)

* * *

### BLUE\_MSG\_BSP\_PREMISE\_UNVERIFIED[​](#blue_msg_bsp_premise_unverified "Direct link to BLUE_MSG_BSP_PREMISE_UNVERIFIED")

> **BLUE\_MSG\_BSP\_PREMISE\_UNVERIFIED**: `84`

Defined in: [WAProto/index.d.ts:13855](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13855)

* * *

### BLUE\_MSG\_BSP\_PREMISE\_UNVERIFIED\_TO\_SELF\_PREMISE\_VERIFIED[​](#blue_msg_bsp_premise_unverified_to_self_premise_verified "Direct link to BLUE_MSG_BSP_PREMISE_UNVERIFIED_TO_SELF_PREMISE_VERIFIED")

> **BLUE\_MSG\_BSP\_PREMISE\_UNVERIFIED\_TO\_SELF\_PREMISE\_VERIFIED**: `85`

Defined in: [WAProto/index.d.ts:13856](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13856)

* * *

### BLUE\_MSG\_BSP\_PREMISE\_VERIFIED[​](#blue_msg_bsp_premise_verified "Direct link to BLUE_MSG_BSP_PREMISE_VERIFIED")

> **BLUE\_MSG\_BSP\_PREMISE\_VERIFIED**: `86`

Defined in: [WAProto/index.d.ts:13857](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13857)

* * *

### BLUE\_MSG\_BSP\_PREMISE\_VERIFIED\_TO\_SELF\_PREMISE\_UNVERIFIED[​](#blue_msg_bsp_premise_verified_to_self_premise_unverified "Direct link to BLUE_MSG_BSP_PREMISE_VERIFIED_TO_SELF_PREMISE_UNVERIFIED")

> **BLUE\_MSG\_BSP\_PREMISE\_VERIFIED\_TO\_SELF\_PREMISE\_UNVERIFIED**: `87`

Defined in: [WAProto/index.d.ts:13858](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13858)

* * *

### BLUE\_MSG\_CONSUMER\_TO\_BSP\_FB\_UNVERIFIED[​](#blue_msg_consumer_to_bsp_fb_unverified "Direct link to BLUE_MSG_CONSUMER_TO_BSP_FB_UNVERIFIED")

> **BLUE\_MSG\_CONSUMER\_TO\_BSP\_FB\_UNVERIFIED**: `88`

Defined in: [WAProto/index.d.ts:13859](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13859)

* * *

### BLUE\_MSG\_CONSUMER\_TO\_BSP\_PREMISE\_UNVERIFIED[​](#blue_msg_consumer_to_bsp_premise_unverified "Direct link to BLUE_MSG_CONSUMER_TO_BSP_PREMISE_UNVERIFIED")

> **BLUE\_MSG\_CONSUMER\_TO\_BSP\_PREMISE\_UNVERIFIED**: `89`

Defined in: [WAProto/index.d.ts:13860](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13860)

* * *

### BLUE\_MSG\_CONSUMER\_TO\_SELF\_FB\_UNVERIFIED[​](#blue_msg_consumer_to_self_fb_unverified "Direct link to BLUE_MSG_CONSUMER_TO_SELF_FB_UNVERIFIED")

> **BLUE\_MSG\_CONSUMER\_TO\_SELF\_FB\_UNVERIFIED**: `90`

Defined in: [WAProto/index.d.ts:13861](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13861)

* * *

### BLUE\_MSG\_CONSUMER\_TO\_SELF\_PREMISE\_UNVERIFIED[​](#blue_msg_consumer_to_self_premise_unverified "Direct link to BLUE_MSG_CONSUMER_TO_SELF_PREMISE_UNVERIFIED")

> **BLUE\_MSG\_CONSUMER\_TO\_SELF\_PREMISE\_UNVERIFIED**: `91`

Defined in: [WAProto/index.d.ts:13862](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13862)

* * *

### BLUE\_MSG\_SELF\_FB\_TO\_BSP\_PREMISE[​](#blue_msg_self_fb_to_bsp_premise "Direct link to BLUE_MSG_SELF_FB_TO_BSP_PREMISE")

> **BLUE\_MSG\_SELF\_FB\_TO\_BSP\_PREMISE**: `92`

Defined in: [WAProto/index.d.ts:13863](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13863)

* * *

### BLUE\_MSG\_SELF\_FB\_TO\_SELF\_PREMISE[​](#blue_msg_self_fb_to_self_premise "Direct link to BLUE_MSG_SELF_FB_TO_SELF_PREMISE")

> **BLUE\_MSG\_SELF\_FB\_TO\_SELF\_PREMISE**: `93`

Defined in: [WAProto/index.d.ts:13864](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13864)

* * *

### BLUE\_MSG\_SELF\_FB\_UNVERIFIED[​](#blue_msg_self_fb_unverified "Direct link to BLUE_MSG_SELF_FB_UNVERIFIED")

> **BLUE\_MSG\_SELF\_FB\_UNVERIFIED**: `94`

Defined in: [WAProto/index.d.ts:13865](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13865)

* * *

### BLUE\_MSG\_SELF\_FB\_UNVERIFIED\_TO\_BSP\_PREMISE\_VERIFIED[​](#blue_msg_self_fb_unverified_to_bsp_premise_verified "Direct link to BLUE_MSG_SELF_FB_UNVERIFIED_TO_BSP_PREMISE_VERIFIED")

> **BLUE\_MSG\_SELF\_FB\_UNVERIFIED\_TO\_BSP\_PREMISE\_VERIFIED**: `116`

Defined in: [WAProto/index.d.ts:13887](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13887)

* * *

### BLUE\_MSG\_SELF\_FB\_UNVERIFIED\_TO\_SELF\_PREMISE\_VERIFIED[​](#blue_msg_self_fb_unverified_to_self_premise_verified "Direct link to BLUE_MSG_SELF_FB_UNVERIFIED_TO_SELF_PREMISE_VERIFIED")

> **BLUE\_MSG\_SELF\_FB\_UNVERIFIED\_TO\_SELF\_PREMISE\_VERIFIED**: `95`

Defined in: [WAProto/index.d.ts:13866](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13866)

* * *

### BLUE\_MSG\_SELF\_FB\_VERIFIED[​](#blue_msg_self_fb_verified "Direct link to BLUE_MSG_SELF_FB_VERIFIED")

> **BLUE\_MSG\_SELF\_FB\_VERIFIED**: `96`

Defined in: [WAProto/index.d.ts:13867](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13867)

* * *

### BLUE\_MSG\_SELF\_FB\_VERIFIED\_TO\_BSP\_PREMISE\_UNVERIFIED[​](#blue_msg_self_fb_verified_to_bsp_premise_unverified "Direct link to BLUE_MSG_SELF_FB_VERIFIED_TO_BSP_PREMISE_UNVERIFIED")

> **BLUE\_MSG\_SELF\_FB\_VERIFIED\_TO\_BSP\_PREMISE\_UNVERIFIED**: `117`

Defined in: [WAProto/index.d.ts:13888](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13888)

* * *

### BLUE\_MSG\_SELF\_FB\_VERIFIED\_TO\_SELF\_PREMISE\_UNVERIFIED[​](#blue_msg_self_fb_verified_to_self_premise_unverified "Direct link to BLUE_MSG_SELF_FB_VERIFIED_TO_SELF_PREMISE_UNVERIFIED")

> **BLUE\_MSG\_SELF\_FB\_VERIFIED\_TO\_SELF\_PREMISE\_UNVERIFIED**: `97`

Defined in: [WAProto/index.d.ts:13868](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13868)

* * *

### BLUE\_MSG\_SELF\_PREMISE\_TO\_BSP\_PREMISE[​](#blue_msg_self_premise_to_bsp_premise "Direct link to BLUE_MSG_SELF_PREMISE_TO_BSP_PREMISE")

> **BLUE\_MSG\_SELF\_PREMISE\_TO\_BSP\_PREMISE**: `98`

Defined in: [WAProto/index.d.ts:13869](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13869)

* * *

### BLUE\_MSG\_SELF\_PREMISE\_UNVERIFIED[​](#blue_msg_self_premise_unverified "Direct link to BLUE_MSG_SELF_PREMISE_UNVERIFIED")

> **BLUE\_MSG\_SELF\_PREMISE\_UNVERIFIED**: `99`

Defined in: [WAProto/index.d.ts:13870](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13870)

* * *

### BLUE\_MSG\_SELF\_PREMISE\_VERIFIED[​](#blue_msg_self_premise_verified "Direct link to BLUE_MSG_SELF_PREMISE_VERIFIED")

> **BLUE\_MSG\_SELF\_PREMISE\_VERIFIED**: `100`

Defined in: [WAProto/index.d.ts:13871](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13871)

* * *

### BLUE\_MSG\_TO\_BSP\_FB[​](#blue_msg_to_bsp_fb "Direct link to BLUE_MSG_TO_BSP_FB")

> **BLUE\_MSG\_TO\_BSP\_FB**: `101`

Defined in: [WAProto/index.d.ts:13872](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13872)

* * *

### BLUE\_MSG\_TO\_CONSUMER[​](#blue_msg_to_consumer "Direct link to BLUE_MSG_TO_CONSUMER")

> **BLUE\_MSG\_TO\_CONSUMER**: `102`

Defined in: [WAProto/index.d.ts:13873](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13873)

* * *

### BLUE\_MSG\_TO\_SELF\_FB[​](#blue_msg_to_self_fb "Direct link to BLUE_MSG_TO_SELF_FB")

> **BLUE\_MSG\_TO\_SELF\_FB**: `103`

Defined in: [WAProto/index.d.ts:13874](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13874)

* * *

### BLUE\_MSG\_UNVERIFIED\_TO\_BSP\_FB\_VERIFIED[​](#blue_msg_unverified_to_bsp_fb_verified "Direct link to BLUE_MSG_UNVERIFIED_TO_BSP_FB_VERIFIED")

> **BLUE\_MSG\_UNVERIFIED\_TO\_BSP\_FB\_VERIFIED**: `104`

Defined in: [WAProto/index.d.ts:13875](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13875)

* * *

### BLUE\_MSG\_UNVERIFIED\_TO\_BSP\_PREMISE\_VERIFIED[​](#blue_msg_unverified_to_bsp_premise_verified "Direct link to BLUE_MSG_UNVERIFIED_TO_BSP_PREMISE_VERIFIED")

> **BLUE\_MSG\_UNVERIFIED\_TO\_BSP\_PREMISE\_VERIFIED**: `105`

Defined in: [WAProto/index.d.ts:13876](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13876)

* * *

### BLUE\_MSG\_UNVERIFIED\_TO\_SELF\_FB\_VERIFIED[​](#blue_msg_unverified_to_self_fb_verified "Direct link to BLUE_MSG_UNVERIFIED_TO_SELF_FB_VERIFIED")

> **BLUE\_MSG\_UNVERIFIED\_TO\_SELF\_FB\_VERIFIED**: `106`

Defined in: [WAProto/index.d.ts:13877](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13877)

* * *

### BLUE\_MSG\_UNVERIFIED\_TO\_VERIFIED[​](#blue_msg_unverified_to_verified "Direct link to BLUE_MSG_UNVERIFIED_TO_VERIFIED")

> **BLUE\_MSG\_UNVERIFIED\_TO\_VERIFIED**: `107`

Defined in: [WAProto/index.d.ts:13878](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13878)

* * *

### BLUE\_MSG\_VERIFIED\_TO\_BSP\_FB\_UNVERIFIED[​](#blue_msg_verified_to_bsp_fb_unverified "Direct link to BLUE_MSG_VERIFIED_TO_BSP_FB_UNVERIFIED")

> **BLUE\_MSG\_VERIFIED\_TO\_BSP\_FB\_UNVERIFIED**: `108`

Defined in: [WAProto/index.d.ts:13879](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13879)

* * *

### BLUE\_MSG\_VERIFIED\_TO\_BSP\_PREMISE\_UNVERIFIED[​](#blue_msg_verified_to_bsp_premise_unverified "Direct link to BLUE_MSG_VERIFIED_TO_BSP_PREMISE_UNVERIFIED")

> **BLUE\_MSG\_VERIFIED\_TO\_BSP\_PREMISE\_UNVERIFIED**: `109`

Defined in: [WAProto/index.d.ts:13880](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13880)

* * *

### BLUE\_MSG\_VERIFIED\_TO\_SELF\_FB\_UNVERIFIED[​](#blue_msg_verified_to_self_fb_unverified "Direct link to BLUE_MSG_VERIFIED_TO_SELF_FB_UNVERIFIED")

> **BLUE\_MSG\_VERIFIED\_TO\_SELF\_FB\_UNVERIFIED**: `110`

Defined in: [WAProto/index.d.ts:13881](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13881)

* * *

### BLUE\_MSG\_VERIFIED\_TO\_UNVERIFIED[​](#blue_msg_verified_to_unverified "Direct link to BLUE_MSG_VERIFIED_TO_UNVERIFIED")

> **BLUE\_MSG\_VERIFIED\_TO\_UNVERIFIED**: `111`

Defined in: [WAProto/index.d.ts:13882](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13882)

* * *

### BROADCAST\_ADD[​](#broadcast_add "Direct link to BROADCAST_ADD")

> **BROADCAST\_ADD**: `35`

Defined in: [WAProto/index.d.ts:13806](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13806)

* * *

### BROADCAST\_CREATE[​](#broadcast_create "Direct link to BROADCAST_CREATE")

> **BROADCAST\_CREATE**: `34`

Defined in: [WAProto/index.d.ts:13805](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13805)

* * *

### BROADCAST\_REMOVE[​](#broadcast_remove "Direct link to BROADCAST_REMOVE")

> **BROADCAST\_REMOVE**: `36`

Defined in: [WAProto/index.d.ts:13807](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13807)

* * *

### CAG\_INVITE\_AUTO\_ADD[​](#cag_invite_auto_add "Direct link to CAG_INVITE_AUTO_ADD")

> **CAG\_INVITE\_AUTO\_ADD**: `159`

Defined in: [WAProto/index.d.ts:13930](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13930)

* * *

### CAG\_INVITE\_AUTO\_JOINED[​](#cag_invite_auto_joined "Direct link to CAG_INVITE_AUTO_JOINED")

> **CAG\_INVITE\_AUTO\_JOINED**: `161`

Defined in: [WAProto/index.d.ts:13932](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13932)

* * *

### CAG\_MASKED\_THREAD\_CREATED[​](#cag_masked_thread_created "Direct link to CAG_MASKED_THREAD_CREATED")

> **CAG\_MASKED\_THREAD\_CREATED**: `157`

Defined in: [WAProto/index.d.ts:13928](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13928)

* * *

### CALL\_MISSED\_GROUP\_VIDEO[​](#call_missed_group_video "Direct link to CALL_MISSED_GROUP_VIDEO")

> **CALL\_MISSED\_GROUP\_VIDEO**: `46`

Defined in: [WAProto/index.d.ts:13817](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13817)

* * *

### CALL\_MISSED\_GROUP\_VOICE[​](#call_missed_group_voice "Direct link to CALL_MISSED_GROUP_VOICE")

> **CALL\_MISSED\_GROUP\_VOICE**: `45`

Defined in: [WAProto/index.d.ts:13816](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13816)

* * *

### CALL\_MISSED\_VIDEO[​](#call_missed_video "Direct link to CALL_MISSED_VIDEO")

> **CALL\_MISSED\_VIDEO**: `41`

Defined in: [WAProto/index.d.ts:13812](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13812)

* * *

### CALL\_MISSED\_VOICE[​](#call_missed_voice "Direct link to CALL_MISSED_VOICE")

> **CALL\_MISSED\_VOICE**: `40`

Defined in: [WAProto/index.d.ts:13811](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13811)

* * *

### CAPI\_GROUP\_NE2EE\_SYSTEM\_MESSAGE[​](#capi_group_ne2ee_system_message "Direct link to CAPI_GROUP_NE2EE_SYSTEM_MESSAGE")

> **CAPI\_GROUP\_NE2EE\_SYSTEM\_MESSAGE**: `209`

Defined in: [WAProto/index.d.ts:13980](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13980)

* * *

### CHANGE\_EPHEMERAL\_SETTING[​](#change_ephemeral_setting "Direct link to CHANGE_EPHEMERAL_SETTING")

> **CHANGE\_EPHEMERAL\_SETTING**: `72`

Defined in: [WAProto/index.d.ts:13843](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13843)

* * *

### CHANGE\_LID[​](#change_lid "Direct link to CHANGE_LID")

> **CHANGE\_LID**: `213`

Defined in: [WAProto/index.d.ts:13984](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13984)

* * *

### CHANGE\_LIMIT\_SHARING[​](#change_limit_sharing "Direct link to CHANGE_LIMIT_SHARING")

> **CHANGE\_LIMIT\_SHARING**: `216`

Defined in: [WAProto/index.d.ts:13987](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13987)

* * *

### CHANGE\_USERNAME[​](#change_username "Direct link to CHANGE_USERNAME")

> **CHANGE\_USERNAME**: `193`

Defined in: [WAProto/index.d.ts:13964](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13964)

* * *

### CHAT\_POLL\_CREATION\_MESSAGE[​](#chat_poll_creation_message "Direct link to CHAT_POLL_CREATION_MESSAGE")

> **CHAT\_POLL\_CREATION\_MESSAGE**: `156`

Defined in: [WAProto/index.d.ts:13927](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13927)

* * *

### CHAT\_PSA[​](#chat_psa "Direct link to CHAT_PSA")

> **CHAT\_PSA**: `155`

Defined in: [WAProto/index.d.ts:13926](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13926)

* * *

### CIPHERTEXT[​](#ciphertext "Direct link to CIPHERTEXT")

> **CIPHERTEXT**: `2`

Defined in: [WAProto/index.d.ts:13773](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13773)

* * *

### COMMUNITY\_ALLOW\_MEMBER\_ADDED\_GROUPS[​](#community_allow_member_added_groups "Direct link to COMMUNITY_ALLOW_MEMBER_ADDED_GROUPS")

> **COMMUNITY\_ALLOW\_MEMBER\_ADDED\_GROUPS**: `176`

Defined in: [WAProto/index.d.ts:13947](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13947)

* * *

### COMMUNITY\_CHANGE\_DESCRIPTION[​](#community_change_description "Direct link to COMMUNITY_CHANGE_DESCRIPTION")

> **COMMUNITY\_CHANGE\_DESCRIPTION**: `173`

Defined in: [WAProto/index.d.ts:13944](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13944)

* * *

### COMMUNITY\_CREATE[​](#community_create "Direct link to COMMUNITY_CREATE")

> **COMMUNITY\_CREATE**: `142`

Defined in: [WAProto/index.d.ts:13913](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13913)

* * *

### COMMUNITY\_DEACTIVATE\_SIBLING\_GROUP[​](#community_deactivate_sibling_group "Direct link to COMMUNITY_DEACTIVATE_SIBLING_GROUP")

> **COMMUNITY\_DEACTIVATE\_SIBLING\_GROUP**: `204`

Defined in: [WAProto/index.d.ts:13975](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13975)

* * *

### COMMUNITY\_INVITE\_AUTO\_ADD\_RICH[​](#community_invite_auto_add_rich "Direct link to COMMUNITY_INVITE_AUTO_ADD_RICH")

> **COMMUNITY\_INVITE\_AUTO\_ADD\_RICH**: `164`

Defined in: [WAProto/index.d.ts:13935](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13935)

* * *

### COMMUNITY\_INVITE\_RICH[​](#community_invite_rich "Direct link to COMMUNITY_INVITE_RICH")

> **COMMUNITY\_INVITE\_RICH**: `163`

Defined in: [WAProto/index.d.ts:13934](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13934)

* * *

### COMMUNITY\_LINK\_PARENT\_GROUP[​](#community_link_parent_group "Direct link to COMMUNITY_LINK_PARENT_GROUP")

> **COMMUNITY\_LINK\_PARENT\_GROUP**: `134`

Defined in: [WAProto/index.d.ts:13905](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13905)

* * *

### COMMUNITY\_LINK\_PARENT\_GROUP\_MEMBERSHIP\_APPROVAL[​](#community_link_parent_group_membership_approval "Direct link to COMMUNITY_LINK_PARENT_GROUP_MEMBERSHIP_APPROVAL")

> **COMMUNITY\_LINK\_PARENT\_GROUP\_MEMBERSHIP\_APPROVAL**: `150`

Defined in: [WAProto/index.d.ts:13921](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13921)

* * *

### COMMUNITY\_LINK\_PARENT\_GROUP\_RICH[​](#community_link_parent_group_rich "Direct link to COMMUNITY_LINK_PARENT_GROUP_RICH")

> **COMMUNITY\_LINK\_PARENT\_GROUP\_RICH**: `167`

Defined in: [WAProto/index.d.ts:13938](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13938)

* * *

### COMMUNITY\_LINK\_SIBLING\_GROUP[​](#community_link_sibling_group "Direct link to COMMUNITY_LINK_SIBLING_GROUP")

> **COMMUNITY\_LINK\_SIBLING\_GROUP**: `135`

Defined in: [WAProto/index.d.ts:13906](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13906)

* * *

### COMMUNITY\_LINK\_SUB\_GROUP[​](#community_link_sub_group "Direct link to COMMUNITY_LINK_SUB_GROUP")

> **COMMUNITY\_LINK\_SUB\_GROUP**: `136`

Defined in: [WAProto/index.d.ts:13907](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13907)

* * *

### COMMUNITY\_OWNER\_UPDATED[​](#community_owner_updated "Direct link to COMMUNITY_OWNER_UPDATED")

> **COMMUNITY\_OWNER\_UPDATED**: `207`

Defined in: [WAProto/index.d.ts:13978](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13978)

* * *

### COMMUNITY\_PARENT\_GROUP\_DELETED[​](#community_parent_group_deleted "Direct link to COMMUNITY_PARENT_GROUP_DELETED")

> **COMMUNITY\_PARENT\_GROUP\_DELETED**: `149`

Defined in: [WAProto/index.d.ts:13920](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13920)

* * *

### COMMUNITY\_PARENT\_GROUP\_SUBJECT\_CHANGED[​](#community_parent_group_subject_changed "Direct link to COMMUNITY_PARENT_GROUP_SUBJECT_CHANGED")

> **COMMUNITY\_PARENT\_GROUP\_SUBJECT\_CHANGED**: `158`

Defined in: [WAProto/index.d.ts:13929](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13929)

* * *

### COMMUNITY\_PARTICIPANT\_ADD\_RICH[​](#community_participant_add_rich "Direct link to COMMUNITY_PARTICIPANT_ADD_RICH")

> **COMMUNITY\_PARTICIPANT\_ADD\_RICH**: `168`

Defined in: [WAProto/index.d.ts:13939](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13939)

* * *

### COMMUNITY\_PARTICIPANT\_DEMOTE[​](#community_participant_demote "Direct link to COMMUNITY_PARTICIPANT_DEMOTE")

> **COMMUNITY\_PARTICIPANT\_DEMOTE**: `148`

Defined in: [WAProto/index.d.ts:13919](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13919)

* * *

### COMMUNITY\_PARTICIPANT\_PROMOTE[​](#community_participant_promote "Direct link to COMMUNITY_PARTICIPANT_PROMOTE")

> **COMMUNITY\_PARTICIPANT\_PROMOTE**: `147`

Defined in: [WAProto/index.d.ts:13918](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13918)

* * *

### COMMUNITY\_SUB\_GROUP\_VISIBILITY\_HIDDEN[​](#community_sub_group_visibility_hidden "Direct link to COMMUNITY_SUB_GROUP_VISIBILITY_HIDDEN")

> **COMMUNITY\_SUB\_GROUP\_VISIBILITY\_HIDDEN**: `208`

Defined in: [WAProto/index.d.ts:13979](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13979)

* * *

### COMMUNITY\_UNLINK\_PARENT\_GROUP[​](#community_unlink_parent_group "Direct link to COMMUNITY_UNLINK_PARENT_GROUP")

> **COMMUNITY\_UNLINK\_PARENT\_GROUP**: `137`

Defined in: [WAProto/index.d.ts:13908](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13908)

* * *

### COMMUNITY\_UNLINK\_SIBLING\_GROUP[​](#community_unlink_sibling_group "Direct link to COMMUNITY_UNLINK_SIBLING_GROUP")

> **COMMUNITY\_UNLINK\_SIBLING\_GROUP**: `138`

Defined in: [WAProto/index.d.ts:13909](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13909)

* * *

### COMMUNITY\_UNLINK\_SUB\_GROUP[​](#community_unlink_sub_group "Direct link to COMMUNITY_UNLINK_SUB_GROUP")

> **COMMUNITY\_UNLINK\_SUB\_GROUP**: `139`

Defined in: [WAProto/index.d.ts:13910](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13910)

* * *

### DISAPPEARING\_MODE[​](#disappearing_mode "Direct link to DISAPPEARING_MODE")

> **DISAPPEARING\_MODE**: `130`

Defined in: [WAProto/index.d.ts:13901](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13901)

* * *

### E2E\_DEVICE\_CHANGED[​](#e2e_device_changed "Direct link to E2E_DEVICE_CHANGED")

> **E2E\_DEVICE\_CHANGED**: `73`

Defined in: [WAProto/index.d.ts:13844](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13844)

* * *

### E2E\_DEVICE\_FETCH\_FAILED[​](#e2e_device_fetch_failed "Direct link to E2E_DEVICE_FETCH_FAILED")

> **E2E\_DEVICE\_FETCH\_FAILED**: `131`

Defined in: [WAProto/index.d.ts:13902](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13902)

* * *

### E2E\_ENCRYPTED[​](#e2e_encrypted "Direct link to E2E_ENCRYPTED")

> **E2E\_ENCRYPTED**: `39`

Defined in: [WAProto/index.d.ts:13810](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13810)

* * *

### E2E\_ENCRYPTED\_NOW[​](#e2e_encrypted_now "Direct link to E2E_ENCRYPTED_NOW")

> **E2E\_ENCRYPTED\_NOW**: `75`

Defined in: [WAProto/index.d.ts:13846](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13846)

* * *

### E2E\_IDENTITY\_CHANGED[​](#e2e_identity_changed "Direct link to E2E_IDENTITY_CHANGED")

> **E2E\_IDENTITY\_CHANGED**: `38`

Defined in: [WAProto/index.d.ts:13809](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13809)

* * *

### E2E\_IDENTITY\_UNAVAILABLE[​](#e2e_identity_unavailable "Direct link to E2E_IDENTITY_UNAVAILABLE")

> **E2E\_IDENTITY\_UNAVAILABLE**: `118`

Defined in: [WAProto/index.d.ts:13889](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13889)

* * *

### EMPTY\_SUBGROUP\_CREATE[​](#empty_subgroup_create "Direct link to EMPTY_SUBGROUP_CREATE")

> **EMPTY\_SUBGROUP\_CREATE**: `183`

Defined in: [WAProto/index.d.ts:13954](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13954)

* * *

### EPHEMERAL\_KEEP\_IN\_CHAT[​](#ephemeral_keep_in_chat "Direct link to EPHEMERAL_KEEP_IN_CHAT")

> **EPHEMERAL\_KEEP\_IN\_CHAT**: `143`

Defined in: [WAProto/index.d.ts:13914](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13914)

* * *

### EPHEMERAL\_SETTING\_NOT\_APPLIED[​](#ephemeral_setting_not_applied "Direct link to EPHEMERAL_SETTING_NOT_APPLIED")

> **EPHEMERAL\_SETTING\_NOT\_APPLIED**: `123`

Defined in: [WAProto/index.d.ts:13894](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13894)

* * *

### EVENT\_CANCELED[​](#event_canceled "Direct link to EVENT_CANCELED")

> **EVENT\_CANCELED**: `206`

Defined in: [WAProto/index.d.ts:13977](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13977)

* * *

### EVENT\_UPDATED[​](#event_updated "Direct link to EVENT_UPDATED")

> **EVENT\_UPDATED**: `205`

Defined in: [WAProto/index.d.ts:13976](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13976)

* * *

### FUTUREPROOF[​](#futureproof "Direct link to FUTUREPROOF")

> **FUTUREPROOF**: `3`

Defined in: [WAProto/index.d.ts:13774](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13774)

* * *

### GENERAL\_CHAT\_ADD[​](#general_chat_add "Direct link to GENERAL_CHAT_ADD")

> **GENERAL\_CHAT\_ADD**: `189`

Defined in: [WAProto/index.d.ts:13960](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13960)

* * *

### GENERAL\_CHAT\_AUTO\_ADD\_DISABLED[​](#general_chat_auto_add_disabled "Direct link to GENERAL_CHAT_AUTO_ADD_DISABLED")

> **GENERAL\_CHAT\_AUTO\_ADD\_DISABLED**: `190`

Defined in: [WAProto/index.d.ts:13961](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13961)

* * *

### GENERAL\_CHAT\_CREATE[​](#general_chat_create "Direct link to GENERAL_CHAT_CREATE")

> **GENERAL\_CHAT\_CREATE**: `188`

Defined in: [WAProto/index.d.ts:13959](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13959)

* * *

### GENERIC\_NOTIFICATION[​](#generic_notification "Direct link to GENERIC_NOTIFICATION")

> **GENERIC\_NOTIFICATION**: `37`

Defined in: [WAProto/index.d.ts:13808](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13808)

* * *

### GROUP\_ANNOUNCE\_MODE\_MESSAGE\_BOUNCE[​](#group_announce_mode_message_bounce "Direct link to GROUP_ANNOUNCE_MODE_MESSAGE_BOUNCE")

> **GROUP\_ANNOUNCE\_MODE\_MESSAGE\_BOUNCE**: `44`

Defined in: [WAProto/index.d.ts:13815](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13815)

* * *

### GROUP\_BOUNCED[​](#group_bounced "Direct link to GROUP_BOUNCED")

> **GROUP\_BOUNCED**: `121`

Defined in: [WAProto/index.d.ts:13892](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13892)

* * *

### GROUP\_CHANGE\_ANNOUNCE[​](#group_change_announce "Direct link to GROUP_CHANGE_ANNOUNCE")

> **GROUP\_CHANGE\_ANNOUNCE**: `26`

Defined in: [WAProto/index.d.ts:13797](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13797)

* * *

### GROUP\_CHANGE\_DESCRIPTION[​](#group_change_description "Direct link to GROUP_CHANGE_DESCRIPTION")

> **GROUP\_CHANGE\_DESCRIPTION**: `24`

Defined in: [WAProto/index.d.ts:13795](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13795)

* * *

### GROUP\_CHANGE\_ICON[​](#group_change_icon "Direct link to GROUP_CHANGE_ICON")

> **GROUP\_CHANGE\_ICON**: `22`

Defined in: [WAProto/index.d.ts:13793](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13793)

* * *

### GROUP\_CHANGE\_INVITE\_LINK[​](#group_change_invite_link "Direct link to GROUP_CHANGE_INVITE_LINK")

> **GROUP\_CHANGE\_INVITE\_LINK**: `23`

Defined in: [WAProto/index.d.ts:13794](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13794)

* * *

### GROUP\_CHANGE\_NO\_FREQUENTLY\_FORWARDED[​](#group_change_no_frequently_forwarded "Direct link to GROUP_CHANGE_NO_FREQUENTLY_FORWARDED")

> **GROUP\_CHANGE\_NO\_FREQUENTLY\_FORWARDED**: `69`

Defined in: [WAProto/index.d.ts:13840](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13840)

* * *

### GROUP\_CHANGE\_RECENT\_HISTORY\_SHARING[​](#group_change_recent_history_sharing "Direct link to GROUP_CHANGE_RECENT_HISTORY_SHARING")

> **GROUP\_CHANGE\_RECENT\_HISTORY\_SHARING**: `186`

Defined in: [WAProto/index.d.ts:13957](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13957)

* * *

### GROUP\_CHANGE\_RESTRICT[​](#group_change_restrict "Direct link to GROUP_CHANGE_RESTRICT")

> **GROUP\_CHANGE\_RESTRICT**: `25`

Defined in: [WAProto/index.d.ts:13796](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13796)

* * *

### GROUP\_CHANGE\_SUBJECT[​](#group_change_subject "Direct link to GROUP_CHANGE_SUBJECT")

> **GROUP\_CHANGE\_SUBJECT**: `21`

Defined in: [WAProto/index.d.ts:13792](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13792)

* * *

### GROUP\_CREATE[​](#group_create "Direct link to GROUP_CREATE")

> **GROUP\_CREATE**: `20`

Defined in: [WAProto/index.d.ts:13791](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13791)

* * *

### GROUP\_CREATE\_FAILED[​](#group_create_failed "Direct link to GROUP_CREATE_FAILED")

> **GROUP\_CREATE\_FAILED**: `120`

Defined in: [WAProto/index.d.ts:13891](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13891)

* * *

### GROUP\_CREATING[​](#group_creating "Direct link to GROUP_CREATING")

> **GROUP\_CREATING**: `119`

Defined in: [WAProto/index.d.ts:13890](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13890)

* * *

### GROUP\_DEACTIVATED[​](#group_deactivated "Direct link to GROUP_DEACTIVATED")

> **GROUP\_DEACTIVATED**: `203`

Defined in: [WAProto/index.d.ts:13974](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13974)

* * *

### GROUP\_DELETE[​](#group_delete "Direct link to GROUP_DELETE")

> **GROUP\_DELETE**: `43`

Defined in: [WAProto/index.d.ts:13814](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13814)

* * *

### GROUP\_INVITE\_LINK\_GROWTH\_LOCKED[​](#group_invite_link_growth_locked "Direct link to GROUP_INVITE_LINK_GROWTH_LOCKED")

> **GROUP\_INVITE\_LINK\_GROWTH\_LOCKED**: `133`

Defined in: [WAProto/index.d.ts:13904](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13904)

* * *

### GROUP\_MEMBER\_ADD\_MODE[​](#group_member_add_mode "Direct link to GROUP_MEMBER_ADD_MODE")

> **GROUP\_MEMBER\_ADD\_MODE**: `171`

Defined in: [WAProto/index.d.ts:13942](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13942)

* * *

### GROUP\_MEMBER\_LINK\_MODE[​](#group_member_link_mode "Direct link to GROUP_MEMBER_LINK_MODE")

> **GROUP\_MEMBER\_LINK\_MODE**: `217`

Defined in: [WAProto/index.d.ts:13988](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13988)

* * *

### GROUP\_MEMBER\_SHARE\_GROUP\_HISTORY\_MODE[​](#group_member_share_group_history_mode "Direct link to GROUP_MEMBER_SHARE_GROUP_HISTORY_MODE")

> **GROUP\_MEMBER\_SHARE\_GROUP\_HISTORY\_MODE**: `221`

Defined in: [WAProto/index.d.ts:13992](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13992)

* * *

### GROUP\_MEMBERSHIP\_JOIN\_APPROVAL\_MODE[​](#group_membership_join_approval_mode "Direct link to GROUP_MEMBERSHIP_JOIN_APPROVAL_MODE")

> **GROUP\_MEMBERSHIP\_JOIN\_APPROVAL\_MODE**: `145`

Defined in: [WAProto/index.d.ts:13916](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13916)

* * *

### GROUP\_MEMBERSHIP\_JOIN\_APPROVAL\_REQUEST[​](#group_membership_join_approval_request "Direct link to GROUP_MEMBERSHIP_JOIN_APPROVAL_REQUEST")

> **GROUP\_MEMBERSHIP\_JOIN\_APPROVAL\_REQUEST**: `144`

Defined in: [WAProto/index.d.ts:13915](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13915)

* * *

### GROUP\_MEMBERSHIP\_JOIN\_APPROVAL\_REQUEST\_NON\_ADMIN\_ADD[​](#group_membership_join_approval_request_non_admin_add "Direct link to GROUP_MEMBERSHIP_JOIN_APPROVAL_REQUEST_NON_ADMIN_ADD")

> **GROUP\_MEMBERSHIP\_JOIN\_APPROVAL\_REQUEST\_NON\_ADMIN\_ADD**: `172`

Defined in: [WAProto/index.d.ts:13943](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13943)

* * *

### GROUP\_PARTICIPANT\_ACCEPT[​](#group_participant_accept "Direct link to GROUP_PARTICIPANT_ACCEPT")

> **GROUP\_PARTICIPANT\_ACCEPT**: `140`

Defined in: [WAProto/index.d.ts:13911](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13911)

* * *

### GROUP\_PARTICIPANT\_ADD[​](#group_participant_add "Direct link to GROUP_PARTICIPANT_ADD")

> **GROUP\_PARTICIPANT\_ADD**: `27`

Defined in: [WAProto/index.d.ts:13798](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13798)

* * *

### GROUP\_PARTICIPANT\_ADD\_REQUEST\_JOIN[​](#group_participant_add_request_join "Direct link to GROUP_PARTICIPANT_ADD_REQUEST_JOIN")

> **GROUP\_PARTICIPANT\_ADD\_REQUEST\_JOIN**: `71`

Defined in: [WAProto/index.d.ts:13842](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13842)

* * *

### GROUP\_PARTICIPANT\_CHANGE\_NUMBER[​](#group_participant_change_number "Direct link to GROUP_PARTICIPANT_CHANGE_NUMBER")

> **GROUP\_PARTICIPANT\_CHANGE\_NUMBER**: `33`

Defined in: [WAProto/index.d.ts:13804](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13804)

* * *

### GROUP\_PARTICIPANT\_DEMOTE[​](#group_participant_demote "Direct link to GROUP_PARTICIPANT_DEMOTE")

> **GROUP\_PARTICIPANT\_DEMOTE**: `30`

Defined in: [WAProto/index.d.ts:13801](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13801)

* * *

### GROUP\_PARTICIPANT\_INVITE[​](#group_participant_invite "Direct link to GROUP_PARTICIPANT_INVITE")

> **GROUP\_PARTICIPANT\_INVITE**: `31`

Defined in: [WAProto/index.d.ts:13802](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13802)

* * *

### GROUP\_PARTICIPANT\_JOINED\_GROUP\_AND\_PARENT\_GROUP[​](#group_participant_joined_group_and_parent_group "Direct link to GROUP_PARTICIPANT_JOINED_GROUP_AND_PARENT_GROUP")

> **GROUP\_PARTICIPANT\_JOINED\_GROUP\_AND\_PARENT\_GROUP**: `151`

Defined in: [WAProto/index.d.ts:13922](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13922)

* * *

### GROUP\_PARTICIPANT\_LEAVE[​](#group_participant_leave "Direct link to GROUP_PARTICIPANT_LEAVE")

> **GROUP\_PARTICIPANT\_LEAVE**: `32`

Defined in: [WAProto/index.d.ts:13803](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13803)

* * *

### GROUP\_PARTICIPANT\_LINKED\_GROUP\_JOIN[​](#group_participant_linked_group_join "Direct link to GROUP_PARTICIPANT_LINKED_GROUP_JOIN")

> **GROUP\_PARTICIPANT\_LINKED\_GROUP\_JOIN**: `141`

Defined in: [WAProto/index.d.ts:13912](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13912)

* * *

### GROUP\_PARTICIPANT\_PROMOTE[​](#group_participant_promote "Direct link to GROUP_PARTICIPANT_PROMOTE")

> **GROUP\_PARTICIPANT\_PROMOTE**: `29`

Defined in: [WAProto/index.d.ts:13800](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13800)

* * *

### GROUP\_PARTICIPANT\_REMOVE[​](#group_participant_remove "Direct link to GROUP_PARTICIPANT_REMOVE")

> **GROUP\_PARTICIPANT\_REMOVE**: `28`

Defined in: [WAProto/index.d.ts:13799](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13799)

* * *

### GROUP\_V4\_ADD\_INVITE\_SENT[​](#group_v4_add_invite_sent "Direct link to GROUP_V4_ADD_INVITE_SENT")

> **GROUP\_V4\_ADD\_INVITE\_SENT**: `70`

Defined in: [WAProto/index.d.ts:13841](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13841)

* * *

### INDIVIDUAL\_CHANGE\_NUMBER[​](#individual_change_number "Direct link to INDIVIDUAL_CHANGE_NUMBER")

> **INDIVIDUAL\_CHANGE\_NUMBER**: `42`

Defined in: [WAProto/index.d.ts:13813](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13813)

* * *

### INTEGRITY\_UNLINK\_PARENT\_GROUP[​](#integrity_unlink_parent_group "Direct link to INTEGRITY_UNLINK_PARENT_GROUP")

> **INTEGRITY\_UNLINK\_PARENT\_GROUP**: `146`

Defined in: [WAProto/index.d.ts:13917](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13917)

* * *

### LINKED\_GROUP\_CALL\_START[​](#linked_group_call_start "Direct link to LINKED_GROUP_CALL_START")

> **LINKED\_GROUP\_CALL\_START**: `181`

Defined in: [WAProto/index.d.ts:13952](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13952)

* * *

### MASKED\_THREAD\_CREATED[​](#masked_thread_created "Direct link to MASKED_THREAD_CREATED")

> **MASKED\_THREAD\_CREATED**: `152`

Defined in: [WAProto/index.d.ts:13923](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13923)

* * *

### MASKED\_THREAD\_UNMASKED[​](#masked_thread_unmasked "Direct link to MASKED_THREAD_UNMASKED")

> **MASKED\_THREAD\_UNMASKED**: `153`

Defined in: [WAProto/index.d.ts:13924](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13924)

* * *

### NON\_VERIFIED\_TRANSITION[​](#non_verified_transition "Direct link to NON_VERIFIED_TRANSITION")

> **NON\_VERIFIED\_TRANSITION**: `4`

Defined in: [WAProto/index.d.ts:13775](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13775)

* * *

### OVERSIZED[​](#oversized "Direct link to OVERSIZED")

> **OVERSIZED**: `68`

Defined in: [WAProto/index.d.ts:13839](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13839)

* * *

### PAID\_MESSAGE\_SERVER\_CAMPAIGN\_ID[​](#paid_message_server_campaign_id "Direct link to PAID_MESSAGE_SERVER_CAMPAIGN_ID")

> **PAID\_MESSAGE\_SERVER\_CAMPAIGN\_ID**: `187`

Defined in: [WAProto/index.d.ts:13958](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13958)

* * *

### PAYMENT\_ACTION\_ACCOUNT\_SETUP\_REMINDER[​](#payment_action_account_setup_reminder "Direct link to PAYMENT_ACTION_ACCOUNT_SETUP_REMINDER")

> **PAYMENT\_ACTION\_ACCOUNT\_SETUP\_REMINDER**: `54`

Defined in: [WAProto/index.d.ts:13825](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13825)

* * *

### PAYMENT\_ACTION\_REQUEST\_CANCELLED[​](#payment_action_request_cancelled "Direct link to PAYMENT_ACTION_REQUEST_CANCELLED")

> **PAYMENT\_ACTION\_REQUEST\_CANCELLED**: `59`

Defined in: [WAProto/index.d.ts:13830](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13830)

* * *

### PAYMENT\_ACTION\_REQUEST\_DECLINED[​](#payment_action_request_declined "Direct link to PAYMENT_ACTION_REQUEST_DECLINED")

> **PAYMENT\_ACTION\_REQUEST\_DECLINED**: `57`

Defined in: [WAProto/index.d.ts:13828](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13828)

* * *

### PAYMENT\_ACTION\_REQUEST\_EXPIRED[​](#payment_action_request_expired "Direct link to PAYMENT_ACTION_REQUEST_EXPIRED")

> **PAYMENT\_ACTION\_REQUEST\_EXPIRED**: `58`

Defined in: [WAProto/index.d.ts:13829](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13829)

* * *

### PAYMENT\_ACTION\_SEND\_PAYMENT\_INVITATION[​](#payment_action_send_payment_invitation "Direct link to PAYMENT_ACTION_SEND_PAYMENT_INVITATION")

> **PAYMENT\_ACTION\_SEND\_PAYMENT\_INVITATION**: `56`

Defined in: [WAProto/index.d.ts:13827](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13827)

* * *

### PAYMENT\_ACTION\_SEND\_PAYMENT\_REMINDER[​](#payment_action_send_payment_reminder "Direct link to PAYMENT_ACTION_SEND_PAYMENT_REMINDER")

> **PAYMENT\_ACTION\_SEND\_PAYMENT\_REMINDER**: `55`

Defined in: [WAProto/index.d.ts:13826](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13826)

* * *

### PAYMENT\_CIPHERTEXT[​](#payment_ciphertext "Direct link to PAYMENT_CIPHERTEXT")

> **PAYMENT\_CIPHERTEXT**: `47`

Defined in: [WAProto/index.d.ts:13818](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13818)

* * *

### PAYMENT\_FUTUREPROOF[​](#payment_futureproof "Direct link to PAYMENT_FUTUREPROOF")

> **PAYMENT\_FUTUREPROOF**: `48`

Defined in: [WAProto/index.d.ts:13819](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13819)

* * *

### PAYMENT\_INVITE\_SETUP\_INVITEE\_RECEIVE\_ONLY[​](#payment_invite_setup_invitee_receive_only "Direct link to PAYMENT_INVITE_SETUP_INVITEE_RECEIVE_ONLY")

> **PAYMENT\_INVITE\_SETUP\_INVITEE\_RECEIVE\_ONLY**: `179`

Defined in: [WAProto/index.d.ts:13950](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13950)

* * *

### PAYMENT\_INVITE\_SETUP\_INVITEE\_SEND\_AND\_RECEIVE[​](#payment_invite_setup_invitee_send_and_receive "Direct link to PAYMENT_INVITE_SETUP_INVITEE_SEND_AND_RECEIVE")

> **PAYMENT\_INVITE\_SETUP\_INVITEE\_SEND\_AND\_RECEIVE**: `180`

Defined in: [WAProto/index.d.ts:13951](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13951)

* * *

### PAYMENT\_INVITE\_SETUP\_INVITER[​](#payment_invite_setup_inviter "Direct link to PAYMENT_INVITE_SETUP_INVITER")

> **PAYMENT\_INVITE\_SETUP\_INVITER**: `178`

Defined in: [WAProto/index.d.ts:13949](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13949)

* * *

### PAYMENT\_TRANSACTION\_STATUS\_RECEIVER\_PENDING\_SETUP[​](#payment_transaction_status_receiver_pending_setup "Direct link to PAYMENT_TRANSACTION_STATUS_RECEIVER_PENDING_SETUP")

> **PAYMENT\_TRANSACTION\_STATUS\_RECEIVER\_PENDING\_SETUP**: `52`

Defined in: [WAProto/index.d.ts:13823](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13823)

* * *

### PAYMENT\_TRANSACTION\_STATUS\_RECEIVER\_SUCCESS\_AFTER\_HICCUP[​](#payment_transaction_status_receiver_success_after_hiccup "Direct link to PAYMENT_TRANSACTION_STATUS_RECEIVER_SUCCESS_AFTER_HICCUP")

> **PAYMENT\_TRANSACTION\_STATUS\_RECEIVER\_SUCCESS\_AFTER\_HICCUP**: `53`

Defined in: [WAProto/index.d.ts:13824](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13824)

* * *

### PAYMENT\_TRANSACTION\_STATUS\_UPDATE\_FAILED[​](#payment_transaction_status_update_failed "Direct link to PAYMENT_TRANSACTION_STATUS_UPDATE_FAILED")

> **PAYMENT\_TRANSACTION\_STATUS\_UPDATE\_FAILED**: `49`

Defined in: [WAProto/index.d.ts:13820](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13820)

* * *

### PAYMENT\_TRANSACTION\_STATUS\_UPDATE\_REFUND\_FAILED[​](#payment_transaction_status_update_refund_failed "Direct link to PAYMENT_TRANSACTION_STATUS_UPDATE_REFUND_FAILED")

> **PAYMENT\_TRANSACTION\_STATUS\_UPDATE\_REFUND\_FAILED**: `51`

Defined in: [WAProto/index.d.ts:13822](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13822)

* * *

### PAYMENT\_TRANSACTION\_STATUS\_UPDATE\_REFUNDED[​](#payment_transaction_status_update_refunded "Direct link to PAYMENT_TRANSACTION_STATUS_UPDATE_REFUNDED")

> **PAYMENT\_TRANSACTION\_STATUS\_UPDATE\_REFUNDED**: `50`

Defined in: [WAProto/index.d.ts:13821](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13821)

* * *

### PHONE\_NUMBER\_HIDING\_CHAT\_DEPRECATED\_MESSAGE[​](#phone_number_hiding_chat_deprecated_message "Direct link to PHONE_NUMBER_HIDING_CHAT_DEPRECATED_MESSAGE")

> **PHONE\_NUMBER\_HIDING\_CHAT\_DEPRECATED\_MESSAGE**: `219`

Defined in: [WAProto/index.d.ts:13990](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13990)

* * *

### PINNED\_MESSAGE\_IN\_CHAT[​](#pinned_message_in_chat "Direct link to PINNED_MESSAGE_IN_CHAT")

> **PINNED\_MESSAGE\_IN\_CHAT**: `177`

Defined in: [WAProto/index.d.ts:13948](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13948)

* * *

### QUARANTINED\_MESSAGE[​](#quarantined_message "Direct link to QUARANTINED_MESSAGE")

> **QUARANTINED\_MESSAGE**: `220`

Defined in: [WAProto/index.d.ts:13991](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13991)

* * *

### RECEIVER\_INVITE[​](#receiver_invite "Direct link to RECEIVER_INVITE")

> **RECEIVER\_INVITE**: `175`

Defined in: [WAProto/index.d.ts:13946](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13946)

* * *

### REMINDER\_CANCEL\_MESSAGE[​](#reminder_cancel_message "Direct link to REMINDER_CANCEL_MESSAGE")

> **REMINDER\_CANCEL\_MESSAGE**: `200`

Defined in: [WAProto/index.d.ts:13971](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13971)

* * *

### REMINDER\_SENT\_MESSAGE[​](#reminder_sent_message "Direct link to REMINDER_SENT_MESSAGE")

> **REMINDER\_SENT\_MESSAGE**: `199`

Defined in: [WAProto/index.d.ts:13970](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13970)

* * *

### REMINDER\_SETUP\_MESSAGE[​](#reminder_setup_message "Direct link to REMINDER_SETUP_MESSAGE")

> **REMINDER\_SETUP\_MESSAGE**: `198`

Defined in: [WAProto/index.d.ts:13969](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13969)

* * *

### REPORT\_TO\_ADMIN\_ENABLED\_STATUS[​](#report_to_admin_enabled_status "Direct link to REPORT_TO_ADMIN_ENABLED_STATUS")

> **REPORT\_TO\_ADMIN\_ENABLED\_STATUS**: `182`

Defined in: [WAProto/index.d.ts:13953](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13953)

* * *

### REVOKE[​](#revoke "Direct link to REVOKE")

> **REVOKE**: `1`

Defined in: [WAProto/index.d.ts:13772](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13772)

* * *

### SCHEDULED\_CALL\_CANCEL[​](#scheduled_call_cancel "Direct link to SCHEDULED_CALL_CANCEL")

> **SCHEDULED\_CALL\_CANCEL**: `184`

Defined in: [WAProto/index.d.ts:13955](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13955)

* * *

### SCHEDULED\_CALL\_START\_MESSAGE[​](#scheduled_call_start_message "Direct link to SCHEDULED_CALL_START_MESSAGE")

> **SCHEDULED\_CALL\_START\_MESSAGE**: `162`

Defined in: [WAProto/index.d.ts:13933](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13933)

* * *

### SENDER\_INVITE[​](#sender_invite "Direct link to SENDER_INVITE")

> **SENDER\_INVITE**: `174`

Defined in: [WAProto/index.d.ts:13945](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13945)

* * *

### SILENCED\_UNKNOWN\_CALLER\_AUDIO[​](#silenced_unknown_caller_audio "Direct link to SILENCED_UNKNOWN_CALLER_AUDIO")

> **SILENCED\_UNKNOWN\_CALLER\_AUDIO**: `169`

Defined in: [WAProto/index.d.ts:13940](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13940)

* * *

### SILENCED\_UNKNOWN\_CALLER\_VIDEO[​](#silenced_unknown_caller_video "Direct link to SILENCED_UNKNOWN_CALLER_VIDEO")

> **SILENCED\_UNKNOWN\_CALLER\_VIDEO**: `170`

Defined in: [WAProto/index.d.ts:13941](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13941)

* * *

### STATUS\_MENTION[​](#status_mention "Direct link to STATUS_MENTION")

> **STATUS\_MENTION**: `210`

Defined in: [WAProto/index.d.ts:13981](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13981)

* * *

### SUB\_GROUP\_INVITE\_RICH[​](#sub_group_invite_rich "Direct link to SUB_GROUP_INVITE_RICH")

> **SUB\_GROUP\_INVITE\_RICH**: `165`

Defined in: [WAProto/index.d.ts:13936](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13936)

* * *

### SUB\_GROUP\_PARTICIPANT\_ADD\_RICH[​](#sub_group_participant_add_rich "Direct link to SUB_GROUP_PARTICIPANT_ADD_RICH")

> **SUB\_GROUP\_PARTICIPANT\_ADD\_RICH**: `166`

Defined in: [WAProto/index.d.ts:13937](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13937)

* * *

### SUBGROUP\_ADMIN\_TRIGGERED\_AUTO\_ADD\_RICH[​](#subgroup_admin_triggered_auto_add_rich "Direct link to SUBGROUP_ADMIN_TRIGGERED_AUTO_ADD_RICH")

> **SUBGROUP\_ADMIN\_TRIGGERED\_AUTO\_ADD\_RICH**: `185`

Defined in: [WAProto/index.d.ts:13956](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13956)

* * *

### SUGGESTED\_SUBGROUP\_ANNOUNCE[​](#suggested_subgroup_announce "Direct link to SUGGESTED_SUBGROUP_ANNOUNCE")

> **SUGGESTED\_SUBGROUP\_ANNOUNCE**: `191`

Defined in: [WAProto/index.d.ts:13962](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13962)

* * *

### SUPPORT\_AI\_EDUCATION[​](#support_ai_education "Direct link to SUPPORT_AI_EDUCATION")

> **SUPPORT\_AI\_EDUCATION**: `196`

Defined in: [WAProto/index.d.ts:13967](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13967)

* * *

### SUPPORT\_SYSTEM\_MESSAGE[​](#support_system_message "Direct link to SUPPORT_SYSTEM_MESSAGE")

> **SUPPORT\_SYSTEM\_MESSAGE**: `212`

Defined in: [WAProto/index.d.ts:13983](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13983)

* * *

### SYNC\_FAILED[​](#sync_failed "Direct link to SYNC_FAILED")

> **SYNC\_FAILED**: `124`

Defined in: [WAProto/index.d.ts:13895](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13895)

* * *

### SYNCING[​](#syncing "Direct link to SYNCING")

> **SYNCING**: `125`

Defined in: [WAProto/index.d.ts:13896](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13896)

* * *

### UNKNOWN[​](#unknown "Direct link to UNKNOWN")

> **UNKNOWN**: `0`

Defined in: [WAProto/index.d.ts:13771](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13771)

* * *

### UNVERIFIED\_TRANSITION[​](#unverified_transition "Direct link to UNVERIFIED_TRANSITION")

> **UNVERIFIED\_TRANSITION**: `5`

Defined in: [WAProto/index.d.ts:13776](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13776)

* * *

### USER\_CONTROLS\_SYSTEM\_MESSAGE[​](#user_controls_system_message "Direct link to USER_CONTROLS_SYSTEM_MESSAGE")

> **USER\_CONTROLS\_SYSTEM\_MESSAGE**: `211`

Defined in: [WAProto/index.d.ts:13982](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13982)

* * *

### VERIFIED\_HIGH[​](#verified_high "Direct link to VERIFIED_HIGH")

> **VERIFIED\_HIGH**: `8`

Defined in: [WAProto/index.d.ts:13779](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13779)

* * *

### VERIFIED\_INITIAL\_HIGH[​](#verified_initial_high "Direct link to VERIFIED_INITIAL_HIGH")

> **VERIFIED\_INITIAL\_HIGH**: `11`

Defined in: [WAProto/index.d.ts:13782](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13782)

* * *

### VERIFIED\_INITIAL\_LOW[​](#verified_initial_low "Direct link to VERIFIED_INITIAL_LOW")

> **VERIFIED\_INITIAL\_LOW**: `10`

Defined in: [WAProto/index.d.ts:13781](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13781)

* * *

### VERIFIED\_INITIAL\_UNKNOWN[​](#verified_initial_unknown "Direct link to VERIFIED_INITIAL_UNKNOWN")

> **VERIFIED\_INITIAL\_UNKNOWN**: `9`

Defined in: [WAProto/index.d.ts:13780](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13780)

* * *

### VERIFIED\_LOW\_UNKNOWN[​](#verified_low_unknown "Direct link to VERIFIED_LOW_UNKNOWN")

> **VERIFIED\_LOW\_UNKNOWN**: `7`

Defined in: [WAProto/index.d.ts:13778](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13778)

* * *

### VERIFIED\_TRANSITION[​](#verified_transition "Direct link to VERIFIED_TRANSITION")

> **VERIFIED\_TRANSITION**: `6`

Defined in: [WAProto/index.d.ts:13777](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13777)

* * *

### VERIFIED\_TRANSITION\_ANY\_TO\_HIGH[​](#verified_transition_any_to_high "Direct link to VERIFIED_TRANSITION_ANY_TO_HIGH")

> **VERIFIED\_TRANSITION\_ANY\_TO\_HIGH**: `13`

Defined in: [WAProto/index.d.ts:13784](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13784)

* * *

### VERIFIED\_TRANSITION\_ANY\_TO\_NONE[​](#verified_transition_any_to_none "Direct link to VERIFIED_TRANSITION_ANY_TO_NONE")

> **VERIFIED\_TRANSITION\_ANY\_TO\_NONE**: `12`

Defined in: [WAProto/index.d.ts:13783](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13783)

* * *

### VERIFIED\_TRANSITION\_HIGH\_TO\_LOW[​](#verified_transition_high_to_low "Direct link to VERIFIED_TRANSITION_HIGH_TO_LOW")

> **VERIFIED\_TRANSITION\_HIGH\_TO\_LOW**: `14`

Defined in: [WAProto/index.d.ts:13785](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13785)

* * *

### VERIFIED\_TRANSITION\_HIGH\_TO\_UNKNOWN[​](#verified_transition_high_to_unknown "Direct link to VERIFIED_TRANSITION_HIGH_TO_UNKNOWN")

> **VERIFIED\_TRANSITION\_HIGH\_TO\_UNKNOWN**: `15`

Defined in: [WAProto/index.d.ts:13786](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13786)

* * *

### VERIFIED\_TRANSITION\_LOW\_TO\_UNKNOWN[​](#verified_transition_low_to_unknown "Direct link to VERIFIED_TRANSITION_LOW_TO_UNKNOWN")

> **VERIFIED\_TRANSITION\_LOW\_TO\_UNKNOWN**: `17`

Defined in: [WAProto/index.d.ts:13788](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13788)

* * *

### VERIFIED\_TRANSITION\_NONE\_TO\_LOW[​](#verified_transition_none_to_low "Direct link to VERIFIED_TRANSITION_NONE_TO_LOW")

> **VERIFIED\_TRANSITION\_NONE\_TO\_LOW**: `18`

Defined in: [WAProto/index.d.ts:13789](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13789)

* * *

### VERIFIED\_TRANSITION\_NONE\_TO\_UNKNOWN[​](#verified_transition_none_to_unknown "Direct link to VERIFIED_TRANSITION_NONE_TO_UNKNOWN")

> **VERIFIED\_TRANSITION\_NONE\_TO\_UNKNOWN**: `19`

Defined in: [WAProto/index.d.ts:13790](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13790)

* * *

### VERIFIED\_TRANSITION\_UNKNOWN\_TO\_LOW[​](#verified_transition_unknown_to_low "Direct link to VERIFIED_TRANSITION_UNKNOWN_TO_LOW")

> **VERIFIED\_TRANSITION\_UNKNOWN\_TO\_LOW**: `16`

Defined in: [WAProto/index.d.ts:13787](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13787)

* * *

### VIEWED\_ONCE[​](#viewed_once "Direct link to VIEWED_ONCE")

> **VIEWED\_ONCE**: `74`

Defined in: [WAProto/index.d.ts:13845](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/WAProto/index.d.ts#L13845)

---

<a name="type-alias-accountsettings"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/AccountSettings](https://baileys.wiki/docs/api/type-aliases/AccountSettings)

> **AccountSettings**: `object`

Defined in: [src/Types/Auth.ts:41](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Auth.ts#L41)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### defaultDisappearingMode?[​](#defaultdisappearingmode "Direct link to defaultDisappearingMode?")

> `optional` **defaultDisappearingMode**: `Pick`<[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation), `"ephemeralExpiration"` | `"ephemeralSettingTimestamp"`\>

the default mode to start new conversations with

### unarchiveChats[​](#unarchivechats "Direct link to unarchiveChats")

> **unarchiveChats**: `boolean`

unarchive chats when a new message is received

---

<a name="type-alias-anymediamessagecontent"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/AnyMediaMessageContent](https://baileys.wiki/docs/api/type-aliases/AnyMediaMessageContent)

> **AnyMediaMessageContent**: `object` & `Mentionable` & `Contextable` & `WithDimensions` | `object` & `Mentionable` & `Contextable` & `WithDimensions` | { `audio`: [`WAMediaUpload`](/docs/api/type-aliases/WAMediaUpload); `ptt`: `boolean`; `seconds`: `number`; } | `object` & `WithDimensions` | `object` & `Contextable` & `object` & `Editable`

Defined in: [src/Types/Message.ts:165](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L165)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### mimetype?[​](#mimetype "Direct link to mimetype?")

> `optional` **mimetype**: `string`

---

<a name="type-alias-anymessagecontent"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/AnyMessageContent](https://baileys.wiki/docs/api/type-aliases/AnyMessageContent)

> **AnyMessageContent**: [`AnyRegularMessageContent`](/docs/api/type-aliases/AnyRegularMessageContent) | { `force`: `boolean`; `forward`: [`WAMessage`](/docs/api/type-aliases/WAMessage); } | { `delete`: [`WAMessageKey`](/docs/api/type-aliases/WAMessageKey); } | { `disappearingMessagesInChat`: `boolean` | `number`; } | { `limitSharing`: `boolean`; }

Defined in: [src/Types/Message.ts:273](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L273)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

[`AnyRegularMessageContent`](/docs/api/type-aliases/AnyRegularMessageContent)

{ `force`: `boolean`; `forward`: [`WAMessage`](/docs/api/type-aliases/WAMessage); }

### force?[​](#force "Direct link to force?")

> `optional` **force**: `boolean`

### forward[​](#forward "Direct link to forward")

> **forward**: [`WAMessage`](/docs/api/type-aliases/WAMessage)

{ `delete`: [`WAMessageKey`](/docs/api/type-aliases/WAMessageKey); }

### delete[​](#delete "Direct link to delete")

> **delete**: [`WAMessageKey`](/docs/api/type-aliases/WAMessageKey)

Delete your message or anyone's message in a group (admin required)

{ `disappearingMessagesInChat`: `boolean` | `number`; }

### disappearingMessagesInChat[​](#disappearingmessagesinchat "Direct link to disappearingMessagesInChat")

> **disappearingMessagesInChat**: `boolean` | `number`

{ `limitSharing`: `boolean`; }

### limitSharing[​](#limitsharing "Direct link to limitSharing")

> **limitSharing**: `boolean`

---

<a name="type-alias-anyregularmessagecontent"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/AnyRegularMessageContent](https://baileys.wiki/docs/api/type-aliases/AnyRegularMessageContent)

> **AnyRegularMessageContent**: `object` & `Mentionable` & `Contextable` & `Editable` | [`AnyMediaMessageContent`](/docs/api/type-aliases/AnyMediaMessageContent) | { `event`: [`EventMessageOptions`](/docs/api/type-aliases/EventMessageOptions); } | `object` & `Mentionable` & `Contextable` & `Editable` | { `contacts`: { `contacts`: [`IContactMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactMessage)\[\]; `displayName`: `string`; }; } | { `location`: [`WALocationMessage`](/docs/api/type-aliases/WALocationMessage); } | { `react`: [`IReactionMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IReactionMessage); } | { `buttonReply`: [`ButtonReplyInfo`](/docs/api/type-aliases/ButtonReplyInfo); `type`: `"template"` | `"plain"`; } | { `groupInvite`: [`GroupInviteInfo`](/docs/api/type-aliases/GroupInviteInfo); } | { `listReply`: `Omit`<[`IListResponseMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IListResponseMessage), `"contextInfo"`\>; } | { `pin`: [`WAMessageKey`](/docs/api/type-aliases/WAMessageKey); `time`: `86400` | `604800` | `2592000`; `type`: [`Type`](/docs/api/namespaces/proto/namespaces/PinInChat/enumerations/Type); } | { `body`: `string`; `businessOwnerJid`: `string`; `footer`: `string`; `product`: [`WASendableProduct`](/docs/api/type-aliases/WASendableProduct); } | `SharePhoneNumber` | `RequestPhoneNumber` & `ViewOnce`

Defined in: [src/Types/Message.ts:220](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L220)

---

<a name="type-alias-authenticationcreds"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/AuthenticationCreds](https://baileys.wiki/docs/api/type-aliases/AuthenticationCreds)

> **AuthenticationCreds**: [`SignalCreds`](/docs/api/type-aliases/SignalCreds) & `object`

Defined in: [src/Types/Auth.ts:48](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Auth.ts#L48)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### account?[​](#account "Direct link to account?")

> `optional` **account**: [`IADVSignedDeviceIdentity`](/docs/api/namespaces/proto/interfaces/IADVSignedDeviceIdentity)

### accountSettings[​](#accountsettings "Direct link to accountSettings")

> **accountSettings**: [`AccountSettings`](/docs/api/type-aliases/AccountSettings)

### accountSyncCounter[​](#accountsynccounter "Direct link to accountSyncCounter")

> **accountSyncCounter**: `number`

number of times history & app state has been synced

### additionalData?[​](#additionaldata "Direct link to additionalData?")

> `optional` **additionalData**: `any`

### advSecretKey[​](#advsecretkey "Direct link to advSecretKey")

> **advSecretKey**: `string`

### firstUnuploadedPreKeyId[​](#firstunuploadedprekeyid "Direct link to firstUnuploadedPreKeyId")

> **firstUnuploadedPreKeyId**: `number`

### lastAccountSyncTimestamp?[​](#lastaccountsynctimestamp "Direct link to lastAccountSyncTimestamp?")

> `optional` **lastAccountSyncTimestamp**: `number`

### lastPropHash[​](#lastprophash "Direct link to lastPropHash")

> **lastPropHash**: `string` | `undefined`

### me?[​](#me "Direct link to me?")

> `optional` **me**: [`Contact`](/docs/api/interfaces/Contact)

### myAppStateKeyId?[​](#myappstatekeyid "Direct link to myAppStateKeyId?")

> `optional` **myAppStateKeyId**: `string`

### nextPreKeyId[​](#nextprekeyid "Direct link to nextPreKeyId")

> **nextPreKeyId**: `number`

### noiseKey[​](#noisekey "Direct link to noiseKey")

> `readonly` **noiseKey**: [`KeyPair`](/docs/api/type-aliases/KeyPair)

### pairingCode[​](#pairingcode "Direct link to pairingCode")

> **pairingCode**: `string` | `undefined`

### pairingEphemeralKeyPair[​](#pairingephemeralkeypair "Direct link to pairingEphemeralKeyPair")

> `readonly` **pairingEphemeralKeyPair**: [`KeyPair`](/docs/api/type-aliases/KeyPair)

### platform?[​](#platform "Direct link to platform?")

> `optional` **platform**: `string`

### processedHistoryMessages[​](#processedhistorymessages "Direct link to processedHistoryMessages")

> **processedHistoryMessages**: [`MinimalMessage`](/docs/api/type-aliases/MinimalMessage)\[\]

### registered[​](#registered "Direct link to registered")

> **registered**: `boolean`

### routingInfo[​](#routinginfo "Direct link to routingInfo")

> **routingInfo**: `Buffer` | `undefined`

### signalIdentities?[​](#signalidentities "Direct link to signalIdentities?")

> `optional` **signalIdentities**: [`SignalIdentity`](/docs/api/type-aliases/SignalIdentity)\[\]

---

<a name="type-alias-authenticationstate"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/AuthenticationState](https://baileys.wiki/docs/api/type-aliases/AuthenticationState)

> **AuthenticationState**: `object`

Defined in: [src/Types/Auth.ts:113](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Auth.ts#L113)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### creds[​](#creds "Direct link to creds")

> **creds**: [`AuthenticationCreds`](/docs/api/type-aliases/AuthenticationCreds)

### keys[​](#keys "Direct link to keys")

> **keys**: [`SignalKeyStore`](/docs/api/type-aliases/SignalKeyStore)

---

<a name="type-alias-baileysevent"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/BaileysEvent](https://baileys.wiki/docs/api/type-aliases/BaileysEvent)

> **BaileysEvent**: keyof [`BaileysEventMap`](/docs/api/type-aliases/BaileysEventMap)

Defined in: [src/Types/Events.ts:152](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Events.ts#L152)

---

<a name="type-alias-baileyseventmap"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/BaileysEventMap](https://baileys.wiki/docs/api/type-aliases/BaileysEventMap)

> **BaileysEventMap**: `object`

Defined in: [src/Types/Events.ts:20](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Events.ts#L20)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

#### blocklist.set[​](#blocklistset "Direct link to blocklist.set")

> **set**: `object`

#### blocklist.set.blocklist[​](#blocklistsetblocklist "Direct link to blocklist.set.blocklist")

> **blocklist**: `string`\[\]

#### blocklist.update[​](#blocklistupdate "Direct link to blocklist.update")

> **update**: `object`

#### blocklist.update.blocklist[​](#blocklistupdateblocklist "Direct link to blocklist.update.blocklist")

> **blocklist**: `string`\[\]

#### blocklist.update.type[​](#blocklistupdatetype "Direct link to blocklist.update.type")

> **type**: `"add"` | `"remove"`

### call[​](#call "Direct link to call")

> **call**: [`WACallEvent`](/docs/api/type-aliases/WACallEvent)\[\]

Receive an update on a call, including when the call was received, rejected, accepted

#### chats.delete[​](#chatsdelete "Direct link to chats.delete")

> **delete**: `string`\[\]

delete chats with given ID

#### chats.lock[​](#chatslock "Direct link to chats.lock")

> **lock**: `object`

Settings and actions sync events

#### chats.lock.id[​](#chatslockid "Direct link to chats.lock.id")

> **id**: `string`

#### chats.lock.locked[​](#chatslocklocked "Direct link to chats.lock.locked")

> **locked**: `boolean`

#### chats.update[​](#chatsupdate "Direct link to chats.update")

> **update**: [`ChatUpdate`](/docs/api/type-aliases/ChatUpdate)\[\]

update the given chats

#### chats.upsert[​](#chatsupsert "Direct link to chats.upsert")

> **upsert**: [`Chat`](/docs/api/type-aliases/Chat)\[\]

upsert chats

#### connection.update[​](#connectionupdate "Direct link to connection.update")

> **update**: `Partial`<[`ConnectionState`](/docs/api/type-aliases/ConnectionState)\>

connection state has been updated -- WS closed, opened, connecting etc.

#### contacts.update[​](#contactsupdate "Direct link to contacts.update")

> **update**: `Partial`<[`Contact`](/docs/api/interfaces/Contact)\>\[\]

#### contacts.upsert[​](#contactsupsert "Direct link to contacts.upsert")

> **upsert**: [`Contact`](/docs/api/interfaces/Contact)\[\]

#### creds.update[​](#credsupdate "Direct link to creds.update")

> **update**: `Partial`<[`AuthenticationCreds`](/docs/api/type-aliases/AuthenticationCreds)\>

credentials updated -- some metadata, keys or something

#### group-participants.update[​](#group-participantsupdate "Direct link to group-participants.update")

> **update**: `object`

apply an action to participants in a group

#### group-participants.update.action[​](#group-participantsupdateaction "Direct link to group-participants.update.action")

> **action**: [`ParticipantAction`](/docs/api/type-aliases/ParticipantAction)

#### group-participants.update.author[​](#group-participantsupdateauthor "Direct link to group-participants.update.author")

> **author**: `string`

#### group-participants.update.authorPn?[​](#group-participantsupdateauthorpn "Direct link to group-participants.update.authorPn?")

> `optional` **authorPn**: `string`

#### group-participants.update.id[​](#group-participantsupdateid "Direct link to group-participants.update.id")

> **id**: `string`

#### group-participants.update.participants[​](#group-participantsupdateparticipants "Direct link to group-participants.update.participants")

> **participants**: [`GroupParticipant`](/docs/api/type-aliases/GroupParticipant)\[\]

#### group.join-request[​](#groupjoin-request "Direct link to group.join-request")

> **join-request**: `object`

#### group.join-request.action[​](#groupjoin-requestaction "Direct link to group.join-request.action")

> **action**: [`RequestJoinAction`](/docs/api/type-aliases/RequestJoinAction)

#### group.join-request.author[​](#groupjoin-requestauthor "Direct link to group.join-request.author")

> **author**: `string`

#### group.join-request.authorPn?[​](#groupjoin-requestauthorpn "Direct link to group.join-request.authorPn?")

> `optional` **authorPn**: `string`

#### group.join-request.id[​](#groupjoin-requestid "Direct link to group.join-request.id")

> **id**: `string`

#### group.join-request.method[​](#groupjoin-requestmethod "Direct link to group.join-request.method")

> **method**: [`RequestJoinMethod`](/docs/api/type-aliases/RequestJoinMethod)

#### group.join-request.participant[​](#groupjoin-requestparticipant "Direct link to group.join-request.participant")

> **participant**: `string`

#### group.join-request.participantPn?[​](#groupjoin-requestparticipantpn "Direct link to group.join-request.participantPn?")

> `optional` **participantPn**: `string`

#### group.member-tag.update[​](#groupmember-tagupdate "Direct link to group.member-tag.update")

> **update**: `object`

#### group.member-tag.update.groupId[​](#groupmember-tagupdategroupid "Direct link to group.member-tag.update.groupId")

> **groupId**: `string`

#### group.member-tag.update.label[​](#groupmember-tagupdatelabel "Direct link to group.member-tag.update.label")

> **label**: `string`

#### group.member-tag.update.messageTimestamp?[​](#groupmember-tagupdatemessagetimestamp "Direct link to group.member-tag.update.messageTimestamp?")

> `optional` **messageTimestamp**: `number`

#### group.member-tag.update.participant[​](#groupmember-tagupdateparticipant "Direct link to group.member-tag.update.participant")

> **participant**: `string`

#### group.member-tag.update.participantAlt?[​](#groupmember-tagupdateparticipantalt "Direct link to group.member-tag.update.participantAlt?")

> `optional` **participantAlt**: `string`

#### groups.update[​](#groupsupdate "Direct link to groups.update")

> **update**: `Partial`<[`GroupMetadata`](/docs/api/interfaces/GroupMetadata)\>\[\]

#### groups.upsert[​](#groupsupsert "Direct link to groups.upsert")

> **upsert**: [`GroupMetadata`](/docs/api/interfaces/GroupMetadata)\[\]

#### labels.association[​](#labelsassociation "Direct link to labels.association")

> **association**: `object`

#### labels.association.association[​](#labelsassociationassociation "Direct link to labels.association.association")

> **association**: `LabelAssociation`

#### labels.association.type[​](#labelsassociationtype "Direct link to labels.association.type")

> **type**: `"add"` | `"remove"`

#### labels.edit[​](#labelsedit "Direct link to labels.edit")

> **edit**: `Label`

#### lid-mapping.update[​](#lid-mappingupdate "Direct link to lid-mapping.update")

> **update**: [`LIDMapping`](/docs/api/type-aliases/LIDMapping)

#### message-receipt.update[​](#message-receiptupdate "Direct link to message-receipt.update")

> **update**: [`MessageUserReceiptUpdate`](/docs/api/type-aliases/MessageUserReceiptUpdate)\[\]

#### messages.delete[​](#messagesdelete "Direct link to messages.delete")

> **delete**: { `keys`: [`WAMessageKey`](/docs/api/type-aliases/WAMessageKey)\[\]; } | { `all`: `true`; `jid`: `string`; }

#### messages.media-update[​](#messagesmedia-update "Direct link to messages.media-update")

> **media-update**: `object`\[\]

#### messages.reaction[​](#messagesreaction "Direct link to messages.reaction")

> **reaction**: `object`\[\]

message was reacted to. If reaction was removed -- then "reaction.text" will be falsey

#### messages.update[​](#messagesupdate "Direct link to messages.update")

> **update**: [`WAMessageUpdate`](/docs/api/type-aliases/WAMessageUpdate)\[\]

#### messages.upsert[​](#messagesupsert "Direct link to messages.upsert")

> **upsert**: `object`

add/update the given messages. If they were received while the connection was online, the update will have type: "notify" if requestId is provided, then the messages was received from the phone due to it being unavailable

#### messages.upsert.messages[​](#messagesupsertmessages "Direct link to messages.upsert.messages")

> **messages**: [`WAMessage`](/docs/api/type-aliases/WAMessage)\[\]

#### messages.upsert.requestId?[​](#messagesupsertrequestid "Direct link to messages.upsert.requestId?")

> `optional` **requestId**: `string`

#### messages.upsert.type[​](#messagesupserttype "Direct link to messages.upsert.type")

> **type**: [`MessageUpsertType`](/docs/api/type-aliases/MessageUpsertType)

#### messaging-history.set[​](#messaging-historyset "Direct link to messaging-history.set")

> **set**: `object`

set chats (history sync), everything is reverse chronologically sorted

#### messaging-history.set.chats[​](#messaging-historysetchats "Direct link to messaging-history.set.chats")

> **chats**: [`Chat`](/docs/api/type-aliases/Chat)\[\]

#### messaging-history.set.contacts[​](#messaging-historysetcontacts "Direct link to messaging-history.set.contacts")

> **contacts**: [`Contact`](/docs/api/interfaces/Contact)\[\]

#### messaging-history.set.isLatest?[​](#messaging-historysetislatest "Direct link to messaging-history.set.isLatest?")

> `optional` **isLatest**: `boolean`

#### messaging-history.set.lidPnMappings?[​](#messaging-historysetlidpnmappings "Direct link to messaging-history.set.lidPnMappings?")

> `optional` **lidPnMappings**: [`LIDMapping`](/docs/api/type-aliases/LIDMapping)\[\]

#### messaging-history.set.messages[​](#messaging-historysetmessages "Direct link to messaging-history.set.messages")

> **messages**: [`WAMessage`](/docs/api/type-aliases/WAMessage)\[\]

#### messaging-history.set.peerDataRequestSessionId?[​](#messaging-historysetpeerdatarequestsessionid "Direct link to messaging-history.set.peerDataRequestSessionId?")

> `optional` **peerDataRequestSessionId**: `string` | `null`

#### messaging-history.set.progress?[​](#messaging-historysetprogress "Direct link to messaging-history.set.progress?")

> `optional` **progress**: `number` | `null`

#### messaging-history.set.syncType?[​](#messaging-historysetsynctype "Direct link to messaging-history.set.syncType?")

> `optional` **syncType**: [`HistorySyncType`](/docs/api/namespaces/proto/namespaces/HistorySync/enumerations/HistorySyncType) | `null`

#### newsletter-participants.update[​](#newsletter-participantsupdate "Direct link to newsletter-participants.update")

> **update**: `object`

#### newsletter-participants.update.action[​](#newsletter-participantsupdateaction "Direct link to newsletter-participants.update.action")

> **action**: `string`

#### newsletter-participants.update.author[​](#newsletter-participantsupdateauthor "Direct link to newsletter-participants.update.author")

> **author**: `string`

#### newsletter-participants.update.id[​](#newsletter-participantsupdateid "Direct link to newsletter-participants.update.id")

> **id**: `string`

#### newsletter-participants.update.new\_role[​](#newsletter-participantsupdatenew_role "Direct link to newsletter-participants.update.new_role")

> **new\_role**: `string`

#### newsletter-participants.update.user[​](#newsletter-participantsupdateuser "Direct link to newsletter-participants.update.user")

> **user**: `string`

#### newsletter-settings.update[​](#newsletter-settingsupdate "Direct link to newsletter-settings.update")

> **update**: `object`

#### newsletter-settings.update.id[​](#newsletter-settingsupdateid "Direct link to newsletter-settings.update.id")

> **id**: `string`

#### newsletter-settings.update.update[​](#newsletter-settingsupdateupdate "Direct link to newsletter-settings.update.update")

> **update**: `any`

#### newsletter.reaction[​](#newsletterreaction "Direct link to newsletter.reaction")

> **reaction**: `object`

Newsletter-related events

#### newsletter.reaction.id[​](#newsletterreactionid "Direct link to newsletter.reaction.id")

> **id**: `string`

#### newsletter.reaction.reaction[​](#newsletterreactionreaction "Direct link to newsletter.reaction.reaction")

> **reaction**: `object`

#### newsletter.reaction.reaction.code?[​](#newsletterreactionreactioncode "Direct link to newsletter.reaction.reaction.code?")

> `optional` **code**: `string`

#### newsletter.reaction.reaction.count?[​](#newsletterreactionreactioncount "Direct link to newsletter.reaction.reaction.count?")

> `optional` **count**: `number`

#### newsletter.reaction.reaction.removed?[​](#newsletterreactionreactionremoved "Direct link to newsletter.reaction.reaction.removed?")

> `optional` **removed**: `boolean`

#### newsletter.reaction.server\_id[​](#newsletterreactionserver_id "Direct link to newsletter.reaction.server_id")

> **server\_id**: `string`

#### newsletter.view[​](#newsletterview "Direct link to newsletter.view")

> **view**: `object`

#### newsletter.view.count[​](#newsletterviewcount "Direct link to newsletter.view.count")

> **count**: `number`

#### newsletter.view.id[​](#newsletterviewid "Direct link to newsletter.view.id")

> **id**: `string`

#### newsletter.view.server\_id[​](#newsletterviewserver_id "Direct link to newsletter.view.server_id")

> **server\_id**: `string`

#### presence.update[​](#presenceupdate "Direct link to presence.update")

> **update**: `object`

presence of contact in a chat updated

#### presence.update.id[​](#presenceupdateid "Direct link to presence.update.id")

> **id**: `string`

#### presence.update.presences[​](#presenceupdatepresences "Direct link to presence.update.presences")

> **presences**: `object`

##### Index Signature[​](#index-signature "Direct link to Index Signature")

\[`participant`: `string`\]: [`PresenceData`](/docs/api/interfaces/PresenceData)

#### settings.update[​](#settingsupdate "Direct link to settings.update")

> **update**: { `setting`: `"unarchiveChats"`; `value`: `boolean`; } | { `setting`: `"locale"`; `value`: `string`; } | { `setting`: `"disableLinkPreviews"`; `value`: [`IPrivacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingDisableLinkPreviewsAction); } | { `setting`: `"timeFormat"`; `value`: [`ITimeFormatAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ITimeFormatAction); } | { `setting`: `"privacySettingRelayAllCalls"`; `value`: [`IPrivacySettingRelayAllCalls`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingRelayAllCalls); } | { `setting`: `"statusPrivacy"`; `value`: [`IStatusPrivacyAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IStatusPrivacyAction); } | { `setting`: `"notificationActivitySetting"`; `value`: [`NotificationActivitySetting`](/docs/api/namespaces/proto/namespaces/SyncActionValue/namespaces/NotificationActivitySettingAction/enumerations/NotificationActivitySetting); } | { `setting`: `"channelsPersonalisedRecommendation"`; `value`: [`IPrivacySettingChannelsPersonalisedRecommendationAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingChannelsPersonalisedRecommendationAction); }

---

<a name="type-alias-binarynode"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/BinaryNode](https://baileys.wiki/docs/api/type-aliases/BinaryNode)

> **BinaryNode**: `object`

Defined in: [src/WABinary/types.ts:9](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/types.ts#L9)

the binary node WA uses internally for communication

this is manipulated soley as an object and it does not have any functions. This is done for easy serialization, to prevent running into issues with prototypes & to maintain functional code structure

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### attrs[​](#attrs "Direct link to attrs")

> **attrs**: `object`

#### Index Signature[​](#index-signature "Direct link to Index Signature")

\[`key`: `string`\]: `string`

### content?[​](#content "Direct link to content?")

> `optional` **content**: [`BinaryNode`](/docs/api/type-aliases/BinaryNode)\[\] | `string` | `Uint8Array`

### tag[​](#tag "Direct link to tag")

> **tag**: `string`

---

<a name="type-alias-binarynodeattributes"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/BinaryNodeAttributes](https://baileys.wiki/docs/api/type-aliases/BinaryNodeAttributes)

> **BinaryNodeAttributes**: [`BinaryNode`](/docs/api/type-aliases/BinaryNode)\[`"attrs"`\]

Defined in: [src/WABinary/types.ts:14](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/types.ts#L14)

---

<a name="type-alias-binarynodecodingoptions"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/BinaryNodeCodingOptions](https://baileys.wiki/docs/api/type-aliases/BinaryNodeCodingOptions)

> **BinaryNodeCodingOptions**: _typeof_ `constants`

Defined in: [src/WABinary/types.ts:17](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/types.ts#L17)

---

<a name="type-alias-binarynodedata"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/BinaryNodeData](https://baileys.wiki/docs/api/type-aliases/BinaryNodeData)

> **BinaryNodeData**: [`BinaryNode`](/docs/api/type-aliases/BinaryNode)\[`"content"`\]

Defined in: [src/WABinary/types.ts:15](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/types.ts#L15)

---

<a name="type-alias-botlistinfo"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/BotListInfo](https://baileys.wiki/docs/api/type-aliases/BotListInfo)

> **BotListInfo**: `object`

Defined in: [src/Types/Chat.ts:41](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L41)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### jid[​](#jid "Direct link to jid")

> **jid**: `string`

### personaId[​](#personaid "Direct link to personaId")

> **personaId**: `string`

---

<a name="type-alias-browsersmap"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/BrowsersMap](https://baileys.wiki/docs/api/type-aliases/BrowsersMap)

> **BrowsersMap**: `object`

Defined in: [src/Types/index.ts:19](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/index.ts#L19)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### appropriate()[​](#appropriate "Direct link to appropriate()")

#### Parameters[​](#parameters "Direct link to Parameters")

##### browser[​](#browser "Direct link to browser")

`string`

#### Returns[​](#returns "Direct link to Returns")

\[`string`, `string`, `string`\]

### baileys()[​](#baileys "Direct link to baileys()")

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### browser[​](#browser-1 "Direct link to browser")

`string`

#### Returns[​](#returns-1 "Direct link to Returns")

\[`string`, `string`, `string`\]

### macOS()[​](#macos "Direct link to macOS()")

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### browser[​](#browser-2 "Direct link to browser")

`string`

#### Returns[​](#returns-2 "Direct link to Returns")

\[`string`, `string`, `string`\]

### ubuntu()[​](#ubuntu "Direct link to ubuntu()")

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### browser[​](#browser-3 "Direct link to browser")

`string`

#### Returns[​](#returns-3 "Direct link to Returns")

\[`string`, `string`, `string`\]

### windows()[​](#windows "Direct link to windows()")

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### browser[​](#browser-4 "Direct link to browser")

`string`

#### Returns[​](#returns-4 "Direct link to Returns")

\[`string`, `string`, `string`\]

---

<a name="type-alias-bufferedeventdata"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/BufferedEventData](https://baileys.wiki/docs/api/type-aliases/BufferedEventData)

> **BufferedEventData**: `object`

Defined in: [src/Types/Events.ts:128](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Events.ts#L128)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### chatDeletes[​](#chatdeletes "Direct link to chatDeletes")

> **chatDeletes**: `Set`<`string`\>

### chatUpdates[​](#chatupdates "Direct link to chatUpdates")

> **chatUpdates**: `object`

#### Index Signature[​](#index-signature "Direct link to Index Signature")

\[`jid`: `string`\]: `Partial`<[`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation) & `object` & `object`\>

### chatUpserts[​](#chatupserts "Direct link to chatUpserts")

> **chatUpserts**: `object`

#### Index Signature[​](#index-signature-1 "Direct link to Index Signature")

\[`jid`: `string`\]: [`Chat`](/docs/api/type-aliases/Chat)

### contactUpdates[​](#contactupdates "Direct link to contactUpdates")

> **contactUpdates**: `object`

#### Index Signature[​](#index-signature-2 "Direct link to Index Signature")

\[`jid`: `string`\]: `Partial`<[`Contact`](/docs/api/interfaces/Contact)\>

### contactUpserts[​](#contactupserts "Direct link to contactUpserts")

> **contactUpserts**: `object`

#### Index Signature[​](#index-signature-3 "Direct link to Index Signature")

\[`jid`: `string`\]: [`Contact`](/docs/api/interfaces/Contact)

### groupUpdates[​](#groupupdates "Direct link to groupUpdates")

> **groupUpdates**: `object`

#### Index Signature[​](#index-signature-4 "Direct link to Index Signature")

\[`jid`: `string`\]: `Partial`<[`GroupMetadata`](/docs/api/interfaces/GroupMetadata)\>

### historySets[​](#historysets "Direct link to historySets")

> **historySets**: `object`

#### historySets.chats[​](#historysetschats "Direct link to historySets.chats")

> **chats**: `object`

##### Index Signature[​](#index-signature-5 "Direct link to Index Signature")

\[`jid`: `string`\]: [`Chat`](/docs/api/type-aliases/Chat)

#### historySets.contacts[​](#historysetscontacts "Direct link to historySets.contacts")

> **contacts**: `object`

##### Index Signature[​](#index-signature-6 "Direct link to Index Signature")

\[`jid`: `string`\]: [`Contact`](/docs/api/interfaces/Contact)

#### historySets.empty[​](#historysetsempty "Direct link to historySets.empty")

> **empty**: `boolean`

#### historySets.isLatest[​](#historysetsislatest "Direct link to historySets.isLatest")

> **isLatest**: `boolean`

#### historySets.messages[​](#historysetsmessages "Direct link to historySets.messages")

> **messages**: `object`

##### Index Signature[​](#index-signature-7 "Direct link to Index Signature")

\[`uqId`: `string`\]: [`WAMessage`](/docs/api/type-aliases/WAMessage)

#### historySets.peerDataRequestSessionId?[​](#historysetspeerdatarequestsessionid "Direct link to historySets.peerDataRequestSessionId?")

> `optional` **peerDataRequestSessionId**: `string`

#### historySets.progress?[​](#historysetsprogress "Direct link to historySets.progress?")

> `optional` **progress**: `number` | `null`

#### historySets.syncType?[​](#historysetssynctype "Direct link to historySets.syncType?")

> `optional` **syncType**: [`HistorySyncType`](/docs/api/namespaces/proto/namespaces/HistorySync/enumerations/HistorySyncType)

### messageDeletes[​](#messagedeletes "Direct link to messageDeletes")

> **messageDeletes**: `object`

#### Index Signature[​](#index-signature-8 "Direct link to Index Signature")

\[`key`: `string`\]: [`WAMessageKey`](/docs/api/type-aliases/WAMessageKey)

### messageReactions[​](#messagereactions "Direct link to messageReactions")

> **messageReactions**: `object`

#### Index Signature[​](#index-signature-9 "Direct link to Index Signature")

\[`key`: `string`\]: `object`

### messageReceipts[​](#messagereceipts "Direct link to messageReceipts")

> **messageReceipts**: `object`

#### Index Signature[​](#index-signature-10 "Direct link to Index Signature")

\[`key`: `string`\]: `object`

### messageUpdates[​](#messageupdates "Direct link to messageUpdates")

> **messageUpdates**: `object`

#### Index Signature[​](#index-signature-11 "Direct link to Index Signature")

\[`key`: `string`\]: [`WAMessageUpdate`](/docs/api/type-aliases/WAMessageUpdate)

### messageUpserts[​](#messageupserts "Direct link to messageUpserts")

> **messageUpserts**: `object`

#### Index Signature[​](#index-signature-12 "Direct link to Index Signature")

\[`key`: `string`\]: `object`

---

<a name="type-alias-buttonreplyinfo"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/ButtonReplyInfo](https://baileys.wiki/docs/api/type-aliases/ButtonReplyInfo)

> **ButtonReplyInfo**: `object`

Defined in: [src/Types/Message.ts:202](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L202)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### displayText[​](#displaytext "Direct link to displayText")

> **displayText**: `string`

### id[​](#id "Direct link to id")

> **id**: `string`

### index[​](#index "Direct link to index")

> **index**: `number`

---

<a name="type-alias-cachestore"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/CacheStore](https://baileys.wiki/docs/api/type-aliases/CacheStore)

> **CacheStore**: `object`

Defined in: [src/Types/Socket.ts:13](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Socket.ts#L13)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### del()[​](#del "Direct link to del()")

delete a key from the cache

#### Parameters[​](#parameters "Direct link to Parameters")

##### key[​](#key "Direct link to key")

`string`

#### Returns[​](#returns "Direct link to Returns")

`number` | `boolean` | `void` | `Promise`<`void`\>

### flushAll()[​](#flushall "Direct link to flushAll()")

flush all data

#### Returns[​](#returns-1 "Direct link to Returns")

`void` | `Promise`<`void`\>

### get()[​](#get "Direct link to get()")

get a cached key and change the stats

#### Type Parameters[​](#type-parameters "Direct link to Type Parameters")

• **T**

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### key[​](#key-1 "Direct link to key")

`string`

#### Returns[​](#returns-2 "Direct link to Returns")

`undefined` | `T` | `Promise`<`T`\>

### set()[​](#set "Direct link to set()")

set a key in the cache

#### Type Parameters[​](#type-parameters-1 "Direct link to Type Parameters")

• **T**

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### key[​](#key-2 "Direct link to key")

`string`

##### value[​](#value "Direct link to value")

`T`

#### Returns[​](#returns-3 "Direct link to Returns")

`number` | `boolean` | `void` | `Promise`<`void`\>

---

<a name="type-alias-catalogcollection"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/CatalogCollection](https://baileys.wiki/docs/api/type-aliases/CatalogCollection)

> **CatalogCollection**: `object`

Defined in: [src/Types/Product.ts:20](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Product.ts#L20)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### id[​](#id "Direct link to id")

> **id**: `string`

### name[​](#name "Direct link to name")

> **name**: `string`

### products[​](#products "Direct link to products")

> **products**: [`Product`](/docs/api/type-aliases/Product)\[\]

### status[​](#status "Direct link to status")

> **status**: [`CatalogStatus`](/docs/api/type-aliases/CatalogStatus)

---

<a name="type-alias-catalogcursor"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/CatalogCursor](https://baileys.wiki/docs/api/type-aliases/CatalogCursor)

> **CatalogCursor**: `string`

Defined in: [src/Types/Product.ts:76](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Product.ts#L76)

---

<a name="type-alias-catalogresult"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/CatalogResult](https://baileys.wiki/docs/api/type-aliases/CatalogResult)

> **CatalogResult**: `object`

Defined in: [src/Types/Product.ts:3](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Product.ts#L3)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### data[​](#data "Direct link to data")

> **data**: `object`

#### data.data[​](#datadata "Direct link to data.data")

> **data**: `any`\[\]

#### data.paging[​](#datapaging "Direct link to data.paging")

> **paging**: `object`

#### data.paging.cursors[​](#datapagingcursors "Direct link to data.paging.cursors")

> **cursors**: `object`

#### data.paging.cursors.after[​](#datapagingcursorsafter "Direct link to data.paging.cursors.after")

> **after**: `string`

#### data.paging.cursors.before[​](#datapagingcursorsbefore "Direct link to data.paging.cursors.before")

> **before**: `string`

---

<a name="type-alias-catalogstatus"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/CatalogStatus](https://baileys.wiki/docs/api/type-aliases/CatalogStatus)

> **CatalogStatus**: `object`

Defined in: [src/Types/Product.ts:15](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Product.ts#L15)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### canAppeal[​](#canappeal "Direct link to canAppeal")

> **canAppeal**: `boolean`

### status[​](#status "Direct link to status")

> **status**: `string`

---

<a name="type-alias-chat"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/Chat](https://baileys.wiki/docs/api/type-aliases/Chat)

> **Chat**: [`IConversation`](/docs/api/namespaces/proto/interfaces/IConversation) & `object`

Defined in: [src/Types/Chat.ts:59](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L59)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### lastMessageRecvTimestamp?[​](#lastmessagerecvtimestamp "Direct link to lastMessageRecvTimestamp?")

> `optional` **lastMessageRecvTimestamp**: `number`

unix timestamp of when the last message was received in the chat

---

<a name="type-alias-chatmodification"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/ChatModification](https://baileys.wiki/docs/api/type-aliases/ChatModification)

> **ChatModification**: { `archive`: `boolean`; `lastMessages`: [`LastMessageList`](/docs/api/type-aliases/LastMessageList); } | { `pushNameSetting`: `string`; } | { `pin`: `boolean`; } | { `mute`: `number` | `null`; } | { `clear`: `boolean`; `lastMessages`: [`LastMessageList`](/docs/api/type-aliases/LastMessageList); } | { `deleteForMe`: { `deleteMedia`: `boolean`; `key`: [`WAMessageKey`](/docs/api/type-aliases/WAMessageKey); `timestamp`: `number`; }; } | { `star`: { `messages`: `object`\[\]; `star`: `boolean`; }; } | { `lastMessages`: [`LastMessageList`](/docs/api/type-aliases/LastMessageList); `markRead`: `boolean`; } | { `delete`: `true`; `lastMessages`: [`LastMessageList`](/docs/api/type-aliases/LastMessageList); } | { `contact`: [`IContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction) | `null`; } | { `disableLinkPreviews`: [`IPrivacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingDisableLinkPreviewsAction); } | { `addLabel`: `LabelActionBody`; } | { `addChatLabel`: `ChatLabelAssociationActionBody`; } | { `removeChatLabel`: `ChatLabelAssociationActionBody`; } | { `addMessageLabel`: `MessageLabelAssociationActionBody`; } | { `removeMessageLabel`: `MessageLabelAssociationActionBody`; } | { `quickReply`: `QuickReplyAction`; }

Defined in: [src/Types/Chat.ts:87](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L87)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

{ `archive`: `boolean`; `lastMessages`: [`LastMessageList`](/docs/api/type-aliases/LastMessageList); }

### archive[​](#archive "Direct link to archive")

> **archive**: `boolean`

### lastMessages[​](#lastmessages "Direct link to lastMessages")

> **lastMessages**: [`LastMessageList`](/docs/api/type-aliases/LastMessageList)

{ `pushNameSetting`: `string`; }

### pushNameSetting[​](#pushnamesetting "Direct link to pushNameSetting")

> **pushNameSetting**: `string`

{ `pin`: `boolean`; }

### pin[​](#pin "Direct link to pin")

> **pin**: `boolean`

{ `mute`: `number` | `null`; }

### mute[​](#mute "Direct link to mute")

> **mute**: `number` | `null`

mute for duration, or provide timestamp of mute to remove

{ `clear`: `boolean`; `lastMessages`: [`LastMessageList`](/docs/api/type-aliases/LastMessageList); }

### clear[​](#clear "Direct link to clear")

> **clear**: `boolean`

### lastMessages[​](#lastmessages-1 "Direct link to lastMessages")

> **lastMessages**: [`LastMessageList`](/docs/api/type-aliases/LastMessageList)

{ `deleteForMe`: { `deleteMedia`: `boolean`; `key`: [`WAMessageKey`](/docs/api/type-aliases/WAMessageKey); `timestamp`: `number`; }; }

### deleteForMe[​](#deleteforme "Direct link to deleteForMe")

> **deleteForMe**: `object`

#### deleteForMe.deleteMedia[​](#deleteformedeletemedia "Direct link to deleteForMe.deleteMedia")

> **deleteMedia**: `boolean`

#### deleteForMe.key[​](#deleteformekey "Direct link to deleteForMe.key")

> **key**: [`WAMessageKey`](/docs/api/type-aliases/WAMessageKey)

#### deleteForMe.timestamp[​](#deleteformetimestamp "Direct link to deleteForMe.timestamp")

> **timestamp**: `number`

{ `star`: { `messages`: `object`\[\]; `star`: `boolean`; }; }

### star[​](#star "Direct link to star")

> **star**: `object`

#### star.messages[​](#starmessages "Direct link to star.messages")

> **messages**: `object`\[\]

#### star.star[​](#starstar "Direct link to star.star")

> **star**: `boolean`

{ `lastMessages`: [`LastMessageList`](/docs/api/type-aliases/LastMessageList); `markRead`: `boolean`; }

### lastMessages[​](#lastmessages-2 "Direct link to lastMessages")

> **lastMessages**: [`LastMessageList`](/docs/api/type-aliases/LastMessageList)

### markRead[​](#markread "Direct link to markRead")

> **markRead**: `boolean`

{ `delete`: `true`; `lastMessages`: [`LastMessageList`](/docs/api/type-aliases/LastMessageList); }

### delete[​](#delete "Direct link to delete")

> **delete**: `true`

### lastMessages[​](#lastmessages-3 "Direct link to lastMessages")

> **lastMessages**: [`LastMessageList`](/docs/api/type-aliases/LastMessageList)

{ `contact`: [`IContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction) | `null`; }

### contact[​](#contact "Direct link to contact")

> **contact**: [`IContactAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IContactAction) | `null`

{ `disableLinkPreviews`: [`IPrivacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingDisableLinkPreviewsAction); }

### disableLinkPreviews[​](#disablelinkpreviews "Direct link to disableLinkPreviews")

> **disableLinkPreviews**: [`IPrivacySettingDisableLinkPreviewsAction`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/IPrivacySettingDisableLinkPreviewsAction)

{ `addLabel`: `LabelActionBody`; }

### addLabel[​](#addlabel "Direct link to addLabel")

> **addLabel**: `LabelActionBody`

{ `addChatLabel`: `ChatLabelAssociationActionBody`; }

### addChatLabel[​](#addchatlabel "Direct link to addChatLabel")

> **addChatLabel**: `ChatLabelAssociationActionBody`

{ `removeChatLabel`: `ChatLabelAssociationActionBody`; }

### removeChatLabel[​](#removechatlabel "Direct link to removeChatLabel")

> **removeChatLabel**: `ChatLabelAssociationActionBody`

{ `addMessageLabel`: `MessageLabelAssociationActionBody`; }

### addMessageLabel[​](#addmessagelabel "Direct link to addMessageLabel")

> **addMessageLabel**: `MessageLabelAssociationActionBody`

{ `removeMessageLabel`: `MessageLabelAssociationActionBody`; }

### removeMessageLabel[​](#removemessagelabel "Direct link to removeMessageLabel")

> **removeMessageLabel**: `MessageLabelAssociationActionBody`

{ `quickReply`: `QuickReplyAction`; }

### quickReply[​](#quickreply "Direct link to quickReply")

> **quickReply**: `QuickReplyAction`

---

<a name="type-alias-chatmutation"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/ChatMutation](https://baileys.wiki/docs/api/type-aliases/ChatMutation)

> **ChatMutation**: `object`

Defined in: [src/Types/Chat.ts:46](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L46)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### index[​](#index "Direct link to index")

> **index**: `string`\[\]

### syncAction[​](#syncaction "Direct link to syncAction")

> **syncAction**: [`ISyncActionData`](/docs/api/namespaces/proto/interfaces/ISyncActionData)

---

<a name="type-alias-chatmutationmap"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/ChatMutationMap](https://baileys.wiki/docs/api/type-aliases/ChatMutationMap)

> **ChatMutationMap**: `object`

Defined in: [src/Utils/chat-utils.ts:32](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/chat-utils.ts#L32)

## Index Signature[​](#index-signature "Direct link to Index Signature")

\[`index`: `string`\]: [`ChatMutation`](/docs/api/type-aliases/ChatMutation)

---

<a name="type-alias-chatupdate"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/ChatUpdate](https://baileys.wiki/docs/api/type-aliases/ChatUpdate)

> **ChatUpdate**: `Partial`<[`Chat`](/docs/api/type-aliases/Chat) & `object`\>

Defined in: [src/Types/Chat.ts:64](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L64)

---

<a name="type-alias-connectionstate"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/ConnectionState](https://baileys.wiki/docs/api/type-aliases/ConnectionState)

> **ConnectionState**: `object`

Defined in: [src/Types/State.ts:17](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/State.ts#L17)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### connection[​](#connection "Direct link to connection")

> **connection**: [`WAConnectionState`](/docs/api/type-aliases/WAConnectionState)

connection is now open, connecting or closed

### isNewLogin?[​](#isnewlogin "Direct link to isNewLogin?")

> `optional` **isNewLogin**: `boolean`

is this a new login

### isOnline?[​](#isonline "Direct link to isOnline?")

> `optional` **isOnline**: `boolean`

if the client is shown as an active, online client. If this is false, the primary phone and other devices will receive notifs

### lastDisconnect?[​](#lastdisconnect "Direct link to lastDisconnect?")

> `optional` **lastDisconnect**: `object`

the error that caused the connection to close

#### lastDisconnect.date[​](#lastdisconnectdate "Direct link to lastDisconnect.date")

> **date**: `Date`

#### lastDisconnect.error[​](#lastdisconnecterror "Direct link to lastDisconnect.error")

> **error**: `Boom` | `Error` | `undefined`

### legacy?[​](#legacy "Direct link to legacy?")

> `optional` **legacy**: `object`

legacy connection options

#### legacy.phoneConnected[​](#legacyphoneconnected "Direct link to legacy.phoneConnected")

> **phoneConnected**: `boolean`

#### legacy.user?[​](#legacyuser "Direct link to legacy.user?")

> `optional` **user**: [`Contact`](/docs/api/interfaces/Contact)

### qr?[​](#qr "Direct link to qr?")

> `optional` **qr**: `string`

the current QR code

### receivedPendingNotifications?[​](#receivedpendingnotifications "Direct link to receivedPendingNotifications?")

> `optional` **receivedPendingNotifications**: `boolean`

has the device received all pending notifications while it was offline

---

<a name="type-alias-curvekeypair"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/CurveKeyPair](https://baileys.wiki/docs/api/type-aliases/CurveKeyPair)

> **CurveKeyPair**: `object`

Defined in: [src/Types/index.ts:67](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/index.ts#L67)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### private[​](#private "Direct link to private")

> **private**: `Uint8Array`

### public[​](#public "Direct link to public")

> **public**: `Uint8Array`

---

<a name="type-alias-debouncedtimeout"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/DebouncedTimeout](https://baileys.wiki/docs/api/type-aliases/DebouncedTimeout)

> **DebouncedTimeout**: `ReturnType`<_typeof_ [`debouncedTimeout`](/docs/api/functions/debouncedTimeout)\>

Defined in: [src/Utils/generics.ts:105](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L105)

---

<a name="type-alias-devicelistdata"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/DeviceListData](https://baileys.wiki/docs/api/type-aliases/DeviceListData)

> **DeviceListData**: `object`

Defined in: [src/WAUSync/Protocols/USyncDeviceProtocol.ts:11](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncDeviceProtocol.ts#L11)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### id[​](#id "Direct link to id")

> **id**: `number`

### isHosted?[​](#ishosted "Direct link to isHosted?")

> `optional` **isHosted**: `boolean`

### keyIndex?[​](#keyindex "Direct link to keyIndex?")

> `optional` **keyIndex**: `number`

---

<a name="type-alias-disappearingmodedata"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/DisappearingModeData](https://baileys.wiki/docs/api/type-aliases/DisappearingModeData)

> **DisappearingModeData**: `object`

Defined in: [src/WAUSync/Protocols/USyncDisappearingModeProtocol.ts:4](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncDisappearingModeProtocol.ts#L4)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### duration[​](#duration "Direct link to duration")

> **duration**: `number`

### setAt?[​](#setat "Direct link to setAt?")

> `optional` **setAt**: `Date`

---

<a name="type-alias-downloadablemessage"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/DownloadableMessage](https://baileys.wiki/docs/api/type-aliases/DownloadableMessage)

> **DownloadableMessage**: `object`

Defined in: [src/Types/Message.ts:83](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L83)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### directPath?[​](#directpath "Direct link to directPath?")

> `optional` **directPath**: `string` | `null`

### mediaKey?[​](#mediakey "Direct link to mediaKey?")

> `optional` **mediaKey**: `Uint8Array` | `null`

### url?[​](#url "Direct link to url?")

> `optional` **url**: `string` | `null`

---

<a name="type-alias-event"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/Event](https://baileys.wiki/docs/api/type-aliases/Event)

> **Event**: `object`

Defined in: [src/WAM/constants.ts:22860](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAM/constants.ts#L22860)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### id[​](#id "Direct link to id")

> **id**: `number`

### name[​](#name "Direct link to name")

> **name**: `string`

### privateStatsIdInt?[​](#privatestatsidint "Direct link to privateStatsIdInt?")

> `optional` **privateStatsIdInt**: `number`

### props[​](#props "Direct link to props")

> **props**: `object`

#### Index Signature[​](#index-signature "Direct link to Index Signature")

\[`key`: `string`\]: \[`number`, `string` | {}\]

### wamChannel[​](#wamchannel "Direct link to wamChannel")

> **wamChannel**: `string`

### weight[​](#weight "Direct link to weight")

> **weight**: `number`

---

<a name="type-alias-eventinputtype"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/EventInputType](https://baileys.wiki/docs/api/type-aliases/EventInputType)

> **EventInputType**: `{ [key in Event["name"]]: { globals: (x: string) => Value; props: { [k in keyof EventByName<key>["props"]]: Value } } }` & `object`

Defined in: [src/WAM/constants.ts:22879](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAM/constants.ts#L22879)

---

<a name="type-alias-eventmessageoptions"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/EventMessageOptions](https://baileys.wiki/docs/api/type-aliases/EventMessageOptions)

> **EventMessageOptions**: `object`

Defined in: [src/Types/Message.ts:144](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L144)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### call?[​](#call "Direct link to call?")

> `optional` **call**: `"audio"` | `"video"`

### description?[​](#description "Direct link to description?")

> `optional` **description**: `string`

### endDate?[​](#enddate "Direct link to endDate?")

> `optional` **endDate**: `Date`

### extraGuestsAllowed?[​](#extraguestsallowed "Direct link to extraGuestsAllowed?")

> `optional` **extraGuestsAllowed**: `boolean`

### isCancelled?[​](#iscancelled "Direct link to isCancelled?")

> `optional` **isCancelled**: `boolean`

### isScheduleCall?[​](#isschedulecall "Direct link to isScheduleCall?")

> `optional` **isScheduleCall**: `boolean`

### location?[​](#location "Direct link to location?")

> `optional` **location**: [`WALocationMessage`](/docs/api/type-aliases/WALocationMessage)

### messageSecret?[​](#messagesecret "Direct link to messageSecret?")

> `optional` **messageSecret**: `Uint8Array`<`ArrayBufferLike`\>

### name[​](#name "Direct link to name")

> **name**: `string`

### startDate[​](#startdate "Direct link to startDate")

> **startDate**: `Date`

---

<a name="type-alias-fulljid"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/FullJid](https://baileys.wiki/docs/api/type-aliases/FullJid)

> **FullJid**: [`JidWithDevice`](/docs/api/type-aliases/JidWithDevice) & `object`

Defined in: [src/WABinary/jid-utils.ts:32](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L32)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### domainType?[​](#domaintype "Direct link to domainType?")

> `optional` **domainType**: `number`

### server[​](#server "Direct link to server")

> **server**: [`JidServer`](/docs/api/type-aliases/JidServer)

---

<a name="type-alias-getcatalogoptions"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/GetCatalogOptions](https://baileys.wiki/docs/api/type-aliases/GetCatalogOptions)

> **GetCatalogOptions**: `object`

Defined in: [src/Types/Product.ts:78](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Product.ts#L78)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### cursor?[​](#cursor "Direct link to cursor?")

> `optional` **cursor**: [`CatalogCursor`](/docs/api/type-aliases/CatalogCursor)

cursor to start from

### jid?[​](#jid "Direct link to jid?")

> `optional` **jid**: `string`

### limit?[​](#limit "Direct link to limit?")

> `optional` **limit**: `number`

number of products to fetch

---

<a name="type-alias-global"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/Global](https://baileys.wiki/docs/api/type-aliases/Global)

> **Global**: `object`

Defined in: [src/WAM/constants.ts:22869](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAM/constants.ts#L22869)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### channels[​](#channels "Direct link to channels")

> **channels**: `string`\[\]

### id[​](#id "Direct link to id")

> **id**: `number`

### name[​](#name "Direct link to name")

> **name**: `string`

### type[​](#type "Direct link to type")

> **type**: `string` | {}

### validator?[​](#validator "Direct link to validator?")

> `optional` **validator**: `string`

---

<a name="type-alias-groupinviteinfo"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/GroupInviteInfo](https://baileys.wiki/docs/api/type-aliases/GroupInviteInfo)

> **GroupInviteInfo**: `object`

Defined in: [src/Types/Message.ts:208](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L208)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### inviteCode[​](#invitecode "Direct link to inviteCode")

> **inviteCode**: `string`

### inviteExpiration[​](#inviteexpiration "Direct link to inviteExpiration")

> **inviteExpiration**: `number`

### jid[​](#jid "Direct link to jid")

> **jid**: `string`

### subject[​](#subject "Direct link to subject")

> **subject**: `string`

### text[​](#text "Direct link to text")

> **text**: `string`

---

<a name="type-alias-groupmetadataparticipants"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/GroupMetadataParticipants](https://baileys.wiki/docs/api/type-aliases/GroupMetadataParticipants)

> **GroupMetadataParticipants**: `Pick`<[`GroupMetadata`](/docs/api/interfaces/GroupMetadata), `"participants"`\>

Defined in: [src/Types/Message.ts:290](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L290)

---

<a name="type-alias-groupparticipant"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/GroupParticipant](https://baileys.wiki/docs/api/type-aliases/GroupParticipant)

> **GroupParticipant**: [`Contact`](/docs/api/interfaces/Contact) & `object`

Defined in: [src/Types/GroupMetadata.ts:4](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L4)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### admin?[​](#admin "Direct link to admin?")

> `optional` **admin**: `"admin"` | `"superadmin"` | `null`

### isAdmin?[​](#isadmin "Direct link to isAdmin?")

> `optional` **isAdmin**: `boolean`

### isSuperAdmin?[​](#issuperadmin "Direct link to isSuperAdmin?")

> `optional` **isSuperAdmin**: `boolean`

---

<a name="type-alias-identitychangecontext"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/IdentityChangeContext](https://baileys.wiki/docs/api/type-aliases/IdentityChangeContext)

> **IdentityChangeContext**: `object`

Defined in: [src/Utils/identity-change-handler.ts:17](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/identity-change-handler.ts#L17)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### assertSessions()[​](#assertsessions "Direct link to assertSessions()")

> **assertSessions**: (`jids`, `force`?) => `Promise`<`boolean`\>

#### Parameters[​](#parameters "Direct link to Parameters")

##### jids[​](#jids "Direct link to jids")

`string`\[\]

##### force?[​](#force "Direct link to force?")

`boolean`

#### Returns[​](#returns "Direct link to Returns")

`Promise`<`boolean`\>

### debounceCache[​](#debouncecache "Direct link to debounceCache")

> **debounceCache**: `NodeCache`<`boolean`\>

### logger[​](#logger "Direct link to logger")

> **logger**: `ILogger`

### meId[​](#meid "Direct link to meId")

> **meId**: `string` | `undefined`

### meLid[​](#melid "Direct link to meLid")

> **meLid**: `string` | `undefined`

### validateSession()[​](#validatesession "Direct link to validateSession()")

> **validateSession**: (`jid`) => `Promise`<{ `exists`: `boolean`; `reason`: `string`; }>

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### jid[​](#jid "Direct link to jid")

`string`

#### Returns[​](#returns-1 "Direct link to Returns")

`Promise`<{ `exists`: `boolean`; `reason`: `string`; }>

---

<a name="type-alias-identitychangeresult"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/IdentityChangeResult](https://baileys.wiki/docs/api/type-aliases/IdentityChangeResult)

> **IdentityChangeResult**: { `action`: `"no_identity_node"`; } | { `action`: `"invalid_notification"`; } | { `action`: `"skipped_companion_device"`; `device`: `number`; } | { `action`: `"skipped_self_primary"`; } | { `action`: `"debounced"`; } | { `action`: `"skipped_offline"`; } | { `action`: `"skipped_no_session"`; } | { `action`: `"session_refreshed"`; } | { `action`: `"session_refresh_failed"`; `error`: `unknown`; }

Defined in: [src/Utils/identity-change-handler.ts:6](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/identity-change-handler.ts#L6)

---

<a name="type-alias-initialappstatesyncoptions"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/InitialAppStateSyncOptions](https://baileys.wiki/docs/api/type-aliases/InitialAppStateSyncOptions)

> **InitialAppStateSyncOptions**: `object`

Defined in: [src/Types/Chat.ts:136](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L136)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### accountSettings[​](#accountsettings "Direct link to accountSettings")

> **accountSettings**: [`AccountSettings`](/docs/api/type-aliases/AccountSettings)

---

<a name="type-alias-initialreceivedchatsstate"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/InitialReceivedChatsState](https://baileys.wiki/docs/api/type-aliases/InitialReceivedChatsState)

> **InitialReceivedChatsState**: `object`

Defined in: [src/Types/Chat.ts:127](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L127)

## Index Signature[​](#index-signature "Direct link to Index Signature")

\[`jid`: `string`\]: `object`

---

<a name="type-alias-jidserver"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/JidServer](https://baileys.wiki/docs/api/type-aliases/JidServer)

> **JidServer**: `"c.us"` | `"g.us"` | `"broadcast"` | `"s.whatsapp.net"` | `"call"` | `"lid"` | `"newsletter"` | `"bot"` | `"hosted"` | `"hosted.lid"`

Defined in: [src/WABinary/jid-utils.ts:8](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L8)

---

<a name="type-alias-jidwithdevice"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/JidWithDevice](https://baileys.wiki/docs/api/type-aliases/JidWithDevice)

> **JidWithDevice**: `object`

Defined in: [src/WABinary/jid-utils.ts:27](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L27)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### device?[​](#device "Direct link to device?")

> `optional` **device**: `number`

### user[​](#user "Direct link to user")

> **user**: `string`

---

<a name="type-alias-keyindexdata"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/KeyIndexData](https://baileys.wiki/docs/api/type-aliases/KeyIndexData)

> **KeyIndexData**: `object`

Defined in: [src/WAUSync/Protocols/USyncDeviceProtocol.ts:5](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncDeviceProtocol.ts#L5)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### expectedTimestamp?[​](#expectedtimestamp "Direct link to expectedTimestamp?")

> `optional` **expectedTimestamp**: `number`

### signedKeyIndex?[​](#signedkeyindex "Direct link to signedKeyIndex?")

> `optional` **signedKeyIndex**: `Uint8Array`

### timestamp[​](#timestamp "Direct link to timestamp")

> **timestamp**: `number`

---

<a name="type-alias-keypair"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/KeyPair](https://baileys.wiki/docs/api/type-aliases/KeyPair)

> **KeyPair**: `object`

Defined in: [src/Types/Auth.ts:5](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Auth.ts#L5)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### private[​](#private "Direct link to private")

> **private**: `Uint8Array`

### public[​](#public "Direct link to public")

> **public**: `Uint8Array`

---

<a name="type-alias-lidmapping"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/LIDMapping](https://baileys.wiki/docs/api/type-aliases/LIDMapping)

> **LIDMapping**: `object`

Defined in: [src/Types/Auth.ts:22](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Auth.ts#L22)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### lid[​](#lid "Direct link to lid")

> **lid**: `string`

### pn[​](#pn "Direct link to pn")

> **pn**: `string`

---

<a name="type-alias-lthashstate"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/LTHashState](https://baileys.wiki/docs/api/type-aliases/LTHashState)

> **LTHashState**: `object`

Defined in: [src/Types/Auth.ts:27](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Auth.ts#L27)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### hash[​](#hash "Direct link to hash")

> **hash**: `Buffer`

### indexValueMap[​](#indexvaluemap "Direct link to indexValueMap")

> **indexValueMap**: `object`

#### Index Signature[​](#index-signature "Direct link to Index Signature")

\[`indexMacBase64`: `string`\]: `object`

### version[​](#version "Direct link to version")

> **version**: `number`

---

<a name="type-alias-lastmessagelist"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/LastMessageList](https://baileys.wiki/docs/api/type-aliases/LastMessageList)

> **LastMessageList**: [`MinimalMessage`](/docs/api/type-aliases/MinimalMessage)\[\] | [`ISyncActionMessageRange`](/docs/api/namespaces/proto/namespaces/SyncActionValue/interfaces/ISyncActionMessageRange)

Defined in: [src/Types/Chat.ts:85](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L85)

the last messages in a chat, sorted reverse-chronologically. That is, the latest message should be first in the chat for MD modifications, the last message in the array (i.e. the earlist message) must be the last message recv in the chat

---

<a name="type-alias-mediaconninfo"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/MediaConnInfo](https://baileys.wiki/docs/api/type-aliases/MediaConnInfo)

> **MediaConnInfo**: `object`

Defined in: [src/Types/Message.ts:95](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L95)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### auth[​](#auth "Direct link to auth")

> **auth**: `string`

### fetchDate[​](#fetchdate "Direct link to fetchDate")

> **fetchDate**: `Date`

### hosts[​](#hosts "Direct link to hosts")

> **hosts**: `object`\[\]

### ttl[​](#ttl "Direct link to ttl")

> **ttl**: `number`

---

<a name="type-alias-mediadecryptionkeyinfo"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/MediaDecryptionKeyInfo](https://baileys.wiki/docs/api/type-aliases/MediaDecryptionKeyInfo)

> **MediaDecryptionKeyInfo**: `object`

Defined in: [src/Types/Message.ts:376](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L376)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### cipherKey[​](#cipherkey "Direct link to cipherKey")

> **cipherKey**: `Uint8Array`

### iv[​](#iv "Direct link to iv")

> **iv**: `Uint8Array`

### macKey?[​](#mackey "Direct link to macKey?")

> `optional` **macKey**: `Uint8Array`

---

<a name="type-alias-mediadownloadoptions"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/MediaDownloadOptions](https://baileys.wiki/docs/api/type-aliases/MediaDownloadOptions)

> **MediaDownloadOptions**: `object`

Defined in: [src/Utils/messages-media.ts:510](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L510)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### endByte?[​](#endbyte "Direct link to endByte?")

> `optional` **endByte**: `number`

### options?[​](#options "Direct link to options?")

> `optional` **options**: `RequestInit`

### startByte?[​](#startbyte "Direct link to startByte?")

> `optional` **startByte**: `number`

---

<a name="type-alias-mediagenerationoptions"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/MediaGenerationOptions](https://baileys.wiki/docs/api/type-aliases/MediaGenerationOptions)

> **MediaGenerationOptions**: `object`

Defined in: [src/Types/Message.ts:338](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L338)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### backgroundColor?[​](#backgroundcolor "Direct link to backgroundColor?")

> `optional` **backgroundColor**: `string`

### font?[​](#font "Direct link to font?")

> `optional` **font**: `number`

### logger?[​](#logger "Direct link to logger?")

> `optional` **logger**: `ILogger`

### mediaCache?[​](#mediacache "Direct link to mediaCache?")

> `optional` **mediaCache**: [`CacheStore`](/docs/api/type-aliases/CacheStore)

cache media so it does not have to be uploaded again

### mediaTypeOverride?[​](#mediatypeoverride "Direct link to mediaTypeOverride?")

> `optional` **mediaTypeOverride**: [`MediaType`](/docs/api/type-aliases/MediaType)

### mediaUploadTimeoutMs?[​](#mediauploadtimeoutms "Direct link to mediaUploadTimeoutMs?")

> `optional` **mediaUploadTimeoutMs**: `number`

### options?[​](#options "Direct link to options?")

> `optional` **options**: `RequestInit`

### upload[​](#upload "Direct link to upload")

> **upload**: [`WAMediaUploadFunction`](/docs/api/type-aliases/WAMediaUploadFunction)

---

<a name="type-alias-mediatype"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/MediaType](https://baileys.wiki/docs/api/type-aliases/MediaType)

> **MediaType**: keyof _typeof_ [`MEDIA_HKDF_KEY_MAPPING`](/docs/api/variables/MEDIA_HKDF_KEY_MAPPING)

Defined in: [src/Defaults/index.ts:126](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L126)

---

<a name="type-alias-messagecontentgenerationoptions"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/MessageContentGenerationOptions](https://baileys.wiki/docs/api/type-aliases/MessageContentGenerationOptions)

> **MessageContentGenerationOptions**: [`MediaGenerationOptions`](/docs/api/type-aliases/MediaGenerationOptions) & `object`

Defined in: [src/Types/Message.ts:353](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L353)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### getCallLink()?[​](#getcalllink "Direct link to getCallLink()?")

> `optional` **getCallLink**: (`type`, `event`?) => `Promise`<`string` | `undefined`\>

#### Parameters[​](#parameters "Direct link to Parameters")

##### type[​](#type "Direct link to type")

`"audio"` | `"video"`

##### event?[​](#event "Direct link to event?")

###### startTime[​](#starttime "Direct link to startTime")

`number`

#### Returns[​](#returns "Direct link to Returns")

`Promise`<`string` | `undefined`\>

### getProfilePicUrl()?[​](#getprofilepicurl "Direct link to getProfilePicUrl()?")

> `optional` **getProfilePicUrl**: (`jid`, `type`) => `Promise`<`string` | `undefined`\>

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### jid[​](#jid "Direct link to jid")

`string`

##### type[​](#type-1 "Direct link to type")

`"image"` | `"preview"`

#### Returns[​](#returns-1 "Direct link to Returns")

`Promise`<`string` | `undefined`\>

### getUrlInfo()?[​](#geturlinfo "Direct link to getUrlInfo()?")

> `optional` **getUrlInfo**: (`text`) => `Promise`<[`WAUrlInfo`](/docs/api/interfaces/WAUrlInfo) | `undefined`\>

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### text[​](#text "Direct link to text")

`string`

#### Returns[​](#returns-2 "Direct link to Returns")

`Promise`<[`WAUrlInfo`](/docs/api/interfaces/WAUrlInfo) | `undefined`\>

### jid?[​](#jid-1 "Direct link to jid?")

> `optional` **jid**: `string`

---

<a name="type-alias-messagegenerationoptions"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/MessageGenerationOptions](https://baileys.wiki/docs/api/type-aliases/MessageGenerationOptions)

> **MessageGenerationOptions**: [`MessageContentGenerationOptions`](/docs/api/type-aliases/MessageContentGenerationOptions) & [`MessageGenerationOptionsFromContent`](/docs/api/type-aliases/MessageGenerationOptionsFromContent)

Defined in: [src/Types/Message.ts:359](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L359)

---

<a name="type-alias-messagegenerationoptionsfromcontent"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/MessageGenerationOptionsFromContent](https://baileys.wiki/docs/api/type-aliases/MessageGenerationOptionsFromContent)

> **MessageGenerationOptionsFromContent**: [`MiscMessageGenerationOptions`](/docs/api/type-aliases/MiscMessageGenerationOptions) & `object`

Defined in: [src/Types/Message.ts:329](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L329)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### userJid[​](#userjid "Direct link to userJid")

> **userJid**: `string`

---

<a name="type-alias-messagereceipttype"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/MessageReceiptType](https://baileys.wiki/docs/api/type-aliases/MessageReceiptType)

> **MessageReceiptType**: `"read"` | `"read-self"` | `"hist_sync"` | `"peer_msg"` | `"sender"` | `"inactive"` | `"played"` | `undefined`

Defined in: [src/Types/Message.ts:85](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L85)

---

<a name="type-alias-messagerelayoptions"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/MessageRelayOptions](https://baileys.wiki/docs/api/type-aliases/MessageRelayOptions)

> **MessageRelayOptions**: `MinimalRelayOptions` & `object`

Defined in: [src/Types/Message.ts:299](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L299)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### additionalAttributes?[​](#additionalattributes "Direct link to additionalAttributes?")

> `optional` **additionalAttributes**: `object`

additional attributes to add to the WA binary node

#### Index Signature[​](#index-signature "Direct link to Index Signature")

\[`_`: `string`\]: `string`

### additionalNodes?[​](#additionalnodes "Direct link to additionalNodes?")

> `optional` **additionalNodes**: [`BinaryNode`](/docs/api/type-aliases/BinaryNode)\[\]

### participant?[​](#participant "Direct link to participant?")

> `optional` **participant**: `object`

only send to a specific participant; used when a message decryption fails for a single user

#### participant.count[​](#participantcount "Direct link to participant.count")

> **count**: `number`

#### participant.jid[​](#participantjid "Direct link to participant.jid")

> **jid**: `string`

### statusJidList?[​](#statusjidlist "Direct link to statusJidList?")

> `optional` **statusJidList**: `string`\[\]

jid list of participants for status@broadcast

### useUserDevicesCache?[​](#useuserdevicescache "Direct link to useUserDevicesCache?")

> `optional` **useUserDevicesCache**: `boolean`

should we use the devices cache, or fetch afresh from the server; default assumed to be "true"

---

<a name="type-alias-messagetype"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/MessageType](https://baileys.wiki/docs/api/type-aliases/MessageType)

> **MessageType**: keyof [`Message`](/docs/api/namespaces/proto/classes/Message)

Defined in: [src/Types/Message.ts:43](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L43)

Set of message types that are supported by the library

---

<a name="type-alias-messageupserttype"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/MessageUpsertType](https://baileys.wiki/docs/api/type-aliases/MessageUpsertType)

> **MessageUpsertType**: `"append"` | `"notify"`

Defined in: [src/Types/Message.ts:366](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L366)

Type of message upsert

1.  notify => notify the user, this message was just received
2.  append => append the message to the chat history, no notification required

---

<a name="type-alias-messageuserreceipt"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/MessageUserReceipt](https://baileys.wiki/docs/api/type-aliases/MessageUserReceipt)

> **MessageUserReceipt**: [`IUserReceipt`](/docs/api/namespaces/proto/interfaces/IUserReceipt)

Defined in: [src/Types/Message.ts:368](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L368)

---

<a name="type-alias-messageuserreceiptupdate"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/MessageUserReceiptUpdate](https://baileys.wiki/docs/api/type-aliases/MessageUserReceiptUpdate)

> **MessageUserReceiptUpdate**: `object`

Defined in: [src/Types/Message.ts:374](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L374)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### key[​](#key "Direct link to key")

> **key**: [`WAMessageKey`](/docs/api/type-aliases/WAMessageKey)

### receipt[​](#receipt "Direct link to receipt")

> **receipt**: [`MessageUserReceipt`](/docs/api/type-aliases/MessageUserReceipt)

---

<a name="type-alias-messagewithcontextinfo"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/MessageWithContextInfo](https://baileys.wiki/docs/api/type-aliases/MessageWithContextInfo)

> **MessageWithContextInfo**: `"imageMessage"` | `"contactMessage"` | `"locationMessage"` | `"extendedTextMessage"` | `"documentMessage"` | `"audioMessage"` | `"videoMessage"` | `"call"` | `"contactsArrayMessage"` | `"liveLocationMessage"` | `"templateMessage"` | `"stickerMessage"` | `"groupInviteMessage"` | `"templateButtonReplyMessage"` | `"productMessage"` | `"listMessage"` | `"orderMessage"` | `"listResponseMessage"` | `"buttonsMessage"` | `"buttonsResponseMessage"` | `"interactiveMessage"` | `"interactiveResponseMessage"` | `"pollCreationMessage"` | `"requestPhoneNumberMessage"` | `"messageHistoryBundle"` | `"eventMessage"` | `"newsletterAdminInviteMessage"` | `"albumMessage"` | `"stickerPackMessage"` | `"pollResultSnapshotMessage"` | `"messageHistoryNotice"`

Defined in: [src/Types/Message.ts:50](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L50)

---

<a name="type-alias-minimalmessage"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/MinimalMessage](https://baileys.wiki/docs/api/type-aliases/MinimalMessage)

> **MinimalMessage**: `Pick`<[`WAMessage`](/docs/api/type-aliases/WAMessage), `"key"` | `"messageTimestamp"`\>

Defined in: [src/Types/Message.ts:382](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L382)

---

<a name="type-alias-miscmessagegenerationoptions"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/MiscMessageGenerationOptions](https://baileys.wiki/docs/api/type-aliases/MiscMessageGenerationOptions)

> **MiscMessageGenerationOptions**: `MinimalRelayOptions` & `object`

Defined in: [src/Types/Message.ts:311](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L311)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### backgroundColor?[​](#backgroundcolor "Direct link to backgroundColor?")

> `optional` **backgroundColor**: `string`

backgroundcolor for status

### broadcast?[​](#broadcast "Direct link to broadcast?")

> `optional` **broadcast**: `boolean`

if it is broadcast

### ephemeralExpiration?[​](#ephemeralexpiration "Direct link to ephemeralExpiration?")

> `optional` **ephemeralExpiration**: `number` | `string`

disappearing messages settings

### font?[​](#font "Direct link to font?")

> `optional` **font**: `number`

font type for status

### mediaUploadTimeoutMs?[​](#mediauploadtimeoutms "Direct link to mediaUploadTimeoutMs?")

> `optional` **mediaUploadTimeoutMs**: `number`

timeout for media upload to WA server

### quoted?[​](#quoted "Direct link to quoted?")

> `optional` **quoted**: [`WAMessage`](/docs/api/type-aliases/WAMessage)

the message you want to quote

### statusJidList?[​](#statusjidlist "Direct link to statusJidList?")

> `optional` **statusJidList**: `string`\[\]

jid list of participants for status@broadcast

### timestamp?[​](#timestamp "Direct link to timestamp?")

> `optional` **timestamp**: `Date`

optional, if you want to manually set the timestamp of the message

---

<a name="type-alias-newsletterupdate"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/NewsletterUpdate](https://baileys.wiki/docs/api/type-aliases/NewsletterUpdate)

> **NewsletterUpdate**: `object`

Defined in: [src/Types/Newsletter.ts:29](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L29)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### description?[​](#description "Direct link to description?")

> `optional` **description**: `string`

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

### picture?[​](#picture "Direct link to picture?")

> `optional` **picture**: `string`

---

<a name="type-alias-newsletterviewrole"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/NewsletterViewRole](https://baileys.wiki/docs/api/type-aliases/NewsletterViewRole)

> **NewsletterViewRole**: `"ADMIN"` | `"GUEST"` | `"OWNER"` | `"SUBSCRIBER"`

Defined in: [src/Types/Newsletter.ts:72](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Newsletter.ts#L72)

---

<a name="type-alias-orderdetails"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/OrderDetails](https://baileys.wiki/docs/api/type-aliases/OrderDetails)

> **OrderDetails**: `object`

Defined in: [src/Types/Product.ts:71](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Product.ts#L71)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### price[​](#price "Direct link to price")

> **price**: [`OrderPrice`](/docs/api/type-aliases/OrderPrice)

### products[​](#products "Direct link to products")

> **products**: [`OrderProduct`](/docs/api/type-aliases/OrderProduct)\[\]

---

<a name="type-alias-orderprice"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/OrderPrice](https://baileys.wiki/docs/api/type-aliases/OrderPrice)

> **OrderPrice**: `object`

Defined in: [src/Types/Product.ts:56](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Product.ts#L56)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### currency[​](#currency "Direct link to currency")

> **currency**: `string`

### total[​](#total "Direct link to total")

> **total**: `number`

---

<a name="type-alias-orderproduct"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/OrderProduct](https://baileys.wiki/docs/api/type-aliases/OrderProduct)

> **OrderProduct**: `object`

Defined in: [src/Types/Product.ts:61](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Product.ts#L61)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### currency[​](#currency "Direct link to currency")

> **currency**: `string`

### id[​](#id "Direct link to id")

> **id**: `string`

### imageUrl[​](#imageurl "Direct link to imageUrl")

> **imageUrl**: `string`

### name[​](#name "Direct link to name")

> **name**: `string`

### price[​](#price "Direct link to price")

> **price**: `number`

### quantity[​](#quantity "Direct link to quantity")

> **quantity**: `number`

---

<a name="type-alias-parseddeviceinfo"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/ParsedDeviceInfo](https://baileys.wiki/docs/api/type-aliases/ParsedDeviceInfo)

> **ParsedDeviceInfo**: `object`

Defined in: [src/WAUSync/Protocols/USyncDeviceProtocol.ts:17](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncDeviceProtocol.ts#L17)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### deviceList?[​](#devicelist "Direct link to deviceList?")

> `optional` **deviceList**: [`DeviceListData`](/docs/api/type-aliases/DeviceListData)\[\]

### keyIndex?[​](#keyindex "Direct link to keyIndex?")

> `optional` **keyIndex**: [`KeyIndexData`](/docs/api/type-aliases/KeyIndexData)

---

<a name="type-alias-participantaction"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/ParticipantAction](https://baileys.wiki/docs/api/type-aliases/ParticipantAction)

> **ParticipantAction**: `"add"` | `"remove"` | `"promote"` | `"demote"` | `"modify"`

Defined in: [src/Types/GroupMetadata.ts:10](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L10)

---

<a name="type-alias-patchedmessagewithrecipientjid"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/PatchedMessageWithRecipientJID](https://baileys.wiki/docs/api/type-aliases/PatchedMessageWithRecipientJID)

> **PatchedMessageWithRecipientJID**: [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage) & `object`

Defined in: [src/Types/Socket.ts:30](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Socket.ts#L30)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### recipientJid?[​](#recipientjid "Direct link to recipientJid?")

> `optional` **recipientJid**: `string`

---

<a name="type-alias-pendingphonerequest"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/PendingPhoneRequest](https://baileys.wiki/docs/api/type-aliases/PendingPhoneRequest)

> **PendingPhoneRequest**: `Record`<`string`, `ReturnType`<_typeof_ `setTimeout`\>>

Defined in: [src/Utils/message-retry-manager.ts:31](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/message-retry-manager.ts#L31)

---

<a name="type-alias-pollmessageoptions"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/PollMessageOptions](https://baileys.wiki/docs/api/type-aliases/PollMessageOptions)

> **PollMessageOptions**: `object`

Defined in: [src/Types/Message.ts:135](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L135)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### messageSecret?[​](#messagesecret "Direct link to messageSecret?")

> `optional` **messageSecret**: `Uint8Array`

32 byte message secret to encrypt poll selections

### name[​](#name "Direct link to name")

> **name**: `string`

### selectableCount?[​](#selectablecount "Direct link to selectableCount?")

> `optional` **selectableCount**: `number`

### toAnnouncementGroup?[​](#toannouncementgroup "Direct link to toAnnouncementGroup?")

> `optional` **toAnnouncementGroup**: `boolean`

### values[​](#values "Direct link to values")

> **values**: `string`\[\]

---

<a name="type-alias-possiblyextendedcachestore"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/PossiblyExtendedCacheStore](https://baileys.wiki/docs/api/type-aliases/PossiblyExtendedCacheStore)

> **PossiblyExtendedCacheStore**: [`CacheStore`](/docs/api/type-aliases/CacheStore) & `object`

Defined in: [src/Types/Socket.ts:24](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Socket.ts#L24)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### mdel()?[​](#mdel "Direct link to mdel()?")

> `optional` **mdel**: (`keys`) => `void` | `Promise`<`void`\> | `number` | `boolean`

#### Parameters[​](#parameters "Direct link to Parameters")

##### keys[​](#keys "Direct link to keys")

`string`\[\]

#### Returns[​](#returns "Direct link to Returns")

`void` | `Promise`<`void`\> | `number` | `boolean`

### mget()?[​](#mget "Direct link to mget()?")

> `optional` **mget**: <`T`\>(`keys`) => `Promise`<`Record`<`string`, `T` | `undefined`\>>

#### Type Parameters[​](#type-parameters "Direct link to Type Parameters")

• **T**

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### keys[​](#keys-1 "Direct link to keys")

`string`\[\]

#### Returns[​](#returns-1 "Direct link to Returns")

`Promise`<`Record`<`string`, `T` | `undefined`\>>

### mset()?[​](#mset "Direct link to mset()?")

> `optional` **mset**: <`T`\>(`entries`) => `Promise`<`void`\> | `void` | `number` | `boolean`

#### Type Parameters[​](#type-parameters-1 "Direct link to Type Parameters")

• **T**

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### entries[​](#entries "Direct link to entries")

`object`\[\]

#### Returns[​](#returns-2 "Direct link to Returns")

`Promise`<`void`\> | `void` | `number` | `boolean`

---

<a name="type-alias-product"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/Product](https://baileys.wiki/docs/api/type-aliases/Product)

> **Product**: [`ProductBase`](/docs/api/type-aliases/ProductBase) & `object`

Defined in: [src/Types/Product.ts:49](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Product.ts#L49)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### availability[​](#availability "Direct link to availability")

> **availability**: [`ProductAvailability`](/docs/api/type-aliases/ProductAvailability)

### id[​](#id "Direct link to id")

> **id**: `string`

### imageUrls[​](#imageurls "Direct link to imageUrls")

> **imageUrls**: `object`

#### Index Signature[​](#index-signature "Direct link to Index Signature")

\[`_`: `string`\]: `string`

### reviewStatus[​](#reviewstatus "Direct link to reviewStatus")

> **reviewStatus**: `object`

#### Index Signature[​](#index-signature-1 "Direct link to Index Signature")

\[`_`: `string`\]: `string`

---

<a name="type-alias-productavailability"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/ProductAvailability](https://baileys.wiki/docs/api/type-aliases/ProductAvailability)

> **ProductAvailability**: `"in stock"`

Defined in: [src/Types/Product.ts:28](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Product.ts#L28)

---

<a name="type-alias-productbase"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/ProductBase](https://baileys.wiki/docs/api/type-aliases/ProductBase)

> **ProductBase**: `object`

Defined in: [src/Types/Product.ts:30](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Product.ts#L30)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### currency[​](#currency "Direct link to currency")

> **currency**: `string`

### description[​](#description "Direct link to description")

> **description**: `string`

### isHidden?[​](#ishidden "Direct link to isHidden?")

> `optional` **isHidden**: `boolean`

### name[​](#name "Direct link to name")

> **name**: `string`

### price[​](#price "Direct link to price")

> **price**: `number`

### retailerId?[​](#retailerid "Direct link to retailerId?")

> `optional` **retailerId**: `string`

### url?[​](#url "Direct link to url?")

> `optional` **url**: `string`

---

<a name="type-alias-productcreate"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/ProductCreate](https://baileys.wiki/docs/api/type-aliases/ProductCreate)

> **ProductCreate**: [`ProductBase`](/docs/api/type-aliases/ProductBase) & `object`

Defined in: [src/Types/Product.ts:40](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Product.ts#L40)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### images[​](#images "Direct link to images")

> **images**: [`WAMediaUpload`](/docs/api/type-aliases/WAMediaUpload)\[\]

images of the product

### originCountryCode[​](#origincountrycode "Direct link to originCountryCode")

> **originCountryCode**: `string` | `undefined`

ISO country code for product origin. Set to undefined for no country

---

<a name="type-alias-productcreateresult"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/ProductCreateResult](https://baileys.wiki/docs/api/type-aliases/ProductCreateResult)

> **ProductCreateResult**: `object`

Defined in: [src/Types/Product.ts:11](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Product.ts#L11)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### data[​](#data "Direct link to data")

> **data**: `object`

#### data.product[​](#dataproduct "Direct link to data.product")

> **product**: `object`

---

<a name="type-alias-productupdate"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/ProductUpdate](https://baileys.wiki/docs/api/type-aliases/ProductUpdate)

> **ProductUpdate**: `Omit`<[`ProductCreate`](/docs/api/type-aliases/ProductCreate), `"originCountryCode"`\>

Defined in: [src/Types/Product.ts:47](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Product.ts#L47)

---

<a name="type-alias-protocoladdress"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/ProtocolAddress](https://baileys.wiki/docs/api/type-aliases/ProtocolAddress)

> **ProtocolAddress**: `object`

Defined in: [src/Types/Auth.ts:13](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Auth.ts#L13)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### deviceId[​](#deviceid "Direct link to deviceId")

> **deviceId**: `number`

### name[​](#name "Direct link to name")

> **name**: `string`

---

<a name="type-alias-requestjoinaction"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/RequestJoinAction](https://baileys.wiki/docs/api/type-aliases/RequestJoinAction)

> **RequestJoinAction**: `"created"` | `"revoked"` | `"rejected"`

Defined in: [src/Types/GroupMetadata.ts:12](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L12)

---

<a name="type-alias-requestjoinmethod"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/RequestJoinMethod](https://baileys.wiki/docs/api/type-aliases/RequestJoinMethod)

> **RequestJoinMethod**: `"invite_link"` | `"linked_group_join"` | `"non_admin_add"` | `undefined`

Defined in: [src/Types/GroupMetadata.ts:14](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/GroupMetadata.ts#L14)

---

<a name="type-alias-signalauthstate"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/SignalAuthState](https://baileys.wiki/docs/api/type-aliases/SignalAuthState)

> **SignalAuthState**: `object`

Defined in: [src/Types/Auth.ts:108](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Auth.ts#L108)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### creds[​](#creds "Direct link to creds")

> **creds**: [`SignalCreds`](/docs/api/type-aliases/SignalCreds)

### keys[​](#keys "Direct link to keys")

> **keys**: [`SignalKeyStore`](/docs/api/type-aliases/SignalKeyStore) | [`SignalKeyStoreWithTransaction`](/docs/api/type-aliases/SignalKeyStoreWithTransaction)

---

<a name="type-alias-signalcreds"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/SignalCreds](https://baileys.wiki/docs/api/type-aliases/SignalCreds)

> **SignalCreds**: `object`

Defined in: [src/Types/Auth.ts:35](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Auth.ts#L35)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### registrationId[​](#registrationid "Direct link to registrationId")

> `readonly` **registrationId**: `number`

### signedIdentityKey[​](#signedidentitykey "Direct link to signedIdentityKey")

> `readonly` **signedIdentityKey**: [`KeyPair`](/docs/api/type-aliases/KeyPair)

### signedPreKey[​](#signedprekey "Direct link to signedPreKey")

> `readonly` **signedPreKey**: [`SignedKeyPair`](/docs/api/type-aliases/SignedKeyPair)

---

<a name="type-alias-signaldataset"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/SignalDataSet](https://baileys.wiki/docs/api/type-aliases/SignalDataSet)

> **SignalDataSet**: { \[T in keyof SignalDataTypeMap\]?: (id: string) => null | SignalDataTypeMap\[T\] }

Defined in: [src/Types/Auth.ts:87](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Auth.ts#L87)

---

<a name="type-alias-signaldatatypemap"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/SignalDataTypeMap](https://baileys.wiki/docs/api/type-aliases/SignalDataTypeMap)

> **SignalDataTypeMap**: `object`

Defined in: [src/Types/Auth.ts:74](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Auth.ts#L74)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### app-state-sync-key[​](#app-state-sync-key "Direct link to app-state-sync-key")

> **app-state-sync-key**: [`IAppStateSyncKeyData`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAppStateSyncKeyData)

### app-state-sync-version[​](#app-state-sync-version "Direct link to app-state-sync-version")

> **app-state-sync-version**: [`LTHashState`](/docs/api/type-aliases/LTHashState)

### device-list[​](#device-list "Direct link to device-list")

> **device-list**: `string`\[\]

### identity-key[​](#identity-key "Direct link to identity-key")

> **identity-key**: `Uint8Array`

### lid-mapping[​](#lid-mapping "Direct link to lid-mapping")

> **lid-mapping**: `string`

### pre-key[​](#pre-key "Direct link to pre-key")

> **pre-key**: [`KeyPair`](/docs/api/type-aliases/KeyPair)

### sender-key[​](#sender-key "Direct link to sender-key")

> **sender-key**: `Uint8Array`

### sender-key-memory[​](#sender-key-memory "Direct link to sender-key-memory")

> **sender-key-memory**: `object`

#### Index Signature[​](#index-signature "Direct link to Index Signature")

\[`jid`: `string`\]: `boolean`

### session[​](#session "Direct link to session")

> **session**: `Uint8Array`

### tctoken[​](#tctoken "Direct link to tctoken")

> **tctoken**: `object`

#### tctoken.timestamp?[​](#tctokentimestamp "Direct link to tctoken.timestamp?")

> `optional` **timestamp**: `string`

#### tctoken.token[​](#tctokentoken "Direct link to tctoken.token")

> **token**: `Buffer`

---

<a name="type-alias-signalidentity"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/SignalIdentity](https://baileys.wiki/docs/api/type-aliases/SignalIdentity)

> **SignalIdentity**: `object`

Defined in: [src/Types/Auth.ts:17](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Auth.ts#L17)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### identifier[​](#identifier "Direct link to identifier")

> **identifier**: [`ProtocolAddress`](/docs/api/type-aliases/ProtocolAddress)

### identifierKey[​](#identifierkey "Direct link to identifierKey")

> **identifierKey**: `Uint8Array`

---

<a name="type-alias-signalkeystore"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/SignalKeyStore](https://baileys.wiki/docs/api/type-aliases/SignalKeyStore)

> **SignalKeyStore**: `object`

Defined in: [src/Types/Auth.ts:91](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Auth.ts#L91)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### clear()?[​](#clear "Direct link to clear()?")

clear all the data in the store

#### Returns[​](#returns "Direct link to Returns")

`Awaitable`<`void`\>

### get()[​](#get "Direct link to get()")

#### Type Parameters[​](#type-parameters "Direct link to Type Parameters")

• **T** _extends_ keyof [`SignalDataTypeMap`](/docs/api/type-aliases/SignalDataTypeMap)

#### Parameters[​](#parameters "Direct link to Parameters")

##### type[​](#type "Direct link to type")

`T`

##### ids[​](#ids "Direct link to ids")

`string`\[\]

#### Returns[​](#returns-1 "Direct link to Returns")

`Awaitable`<{}>

### set()[​](#set "Direct link to set()")

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### data[​](#data "Direct link to data")

[`SignalDataSet`](/docs/api/type-aliases/SignalDataSet)

#### Returns[​](#returns-2 "Direct link to Returns")

`Awaitable`<`void`\>

---

<a name="type-alias-signalkeystorewithtransaction"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/SignalKeyStoreWithTransaction](https://baileys.wiki/docs/api/type-aliases/SignalKeyStoreWithTransaction)

> **SignalKeyStoreWithTransaction**: [`SignalKeyStore`](/docs/api/type-aliases/SignalKeyStore) & `object`

Defined in: [src/Types/Auth.ts:98](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Auth.ts#L98)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### isInTransaction()[​](#isintransaction "Direct link to isInTransaction()")

> **isInTransaction**: () => `boolean`

#### Returns[​](#returns "Direct link to Returns")

`boolean`

### transaction()[​](#transaction "Direct link to transaction()")

#### Type Parameters[​](#type-parameters "Direct link to Type Parameters")

• **T**

#### Parameters[​](#parameters "Direct link to Parameters")

##### exec[​](#exec "Direct link to exec")

() => `Promise`<`T`\>

##### key[​](#key "Direct link to key")

`string`

#### Returns[​](#returns-1 "Direct link to Returns")

`Promise`<`T`\>

---

<a name="type-alias-signalrepository"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/SignalRepository](https://baileys.wiki/docs/api/type-aliases/SignalRepository)

> **SignalRepository**: `object`

Defined in: [src/Types/Signal.ts:53](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Signal.ts#L53)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### decryptGroupMessage()[​](#decryptgroupmessage "Direct link to decryptGroupMessage()")

#### Parameters[​](#parameters "Direct link to Parameters")

##### opts[​](#opts "Direct link to opts")

`DecryptGroupSignalOpts`

#### Returns[​](#returns "Direct link to Returns")

`Promise`<`Uint8Array`<`ArrayBufferLike`\>>

### decryptMessage()[​](#decryptmessage "Direct link to decryptMessage()")

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### opts[​](#opts-1 "Direct link to opts")

`DecryptSignalProtoOpts`

#### Returns[​](#returns-1 "Direct link to Returns")

`Promise`<`Uint8Array`<`ArrayBufferLike`\>>

### deleteSession()[​](#deletesession "Direct link to deleteSession()")

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### jids[​](#jids "Direct link to jids")

`string`\[\]

#### Returns[​](#returns-2 "Direct link to Returns")

`Promise`<`void`\>

### encryptGroupMessage()[​](#encryptgroupmessage "Direct link to encryptGroupMessage()")

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### opts[​](#opts-2 "Direct link to opts")

`EncryptGroupMessageOpts`

#### Returns[​](#returns-3 "Direct link to Returns")

`Promise`<{ `ciphertext`: `Uint8Array`; `senderKeyDistributionMessage`: `Uint8Array`; }>

### encryptMessage()[​](#encryptmessage "Direct link to encryptMessage()")

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### opts[​](#opts-3 "Direct link to opts")

`EncryptMessageOpts`

#### Returns[​](#returns-4 "Direct link to Returns")

`Promise`<{ `ciphertext`: `Uint8Array`; `type`: `"pkmsg"` | `"msg"`; }>

### injectE2ESession()[​](#injecte2esession "Direct link to injectE2ESession()")

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### opts[​](#opts-4 "Direct link to opts")

`E2ESessionOpts`

#### Returns[​](#returns-5 "Direct link to Returns")

`Promise`<`void`\>

### jidToSignalProtocolAddress()[​](#jidtosignalprotocoladdress "Direct link to jidToSignalProtocolAddress()")

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### jid[​](#jid "Direct link to jid")

`string`

#### Returns[​](#returns-6 "Direct link to Returns")

`string`

### migrateSession()[​](#migratesession "Direct link to migrateSession()")

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### fromJid[​](#fromjid "Direct link to fromJid")

`string`

##### toJid[​](#tojid "Direct link to toJid")

`string`

#### Returns[​](#returns-7 "Direct link to Returns")

`Promise`<{ `migrated`: `number`; `skipped`: `number`; `total`: `number`; }>

### processSenderKeyDistributionMessage()[​](#processsenderkeydistributionmessage "Direct link to processSenderKeyDistributionMessage()")

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### opts[​](#opts-5 "Direct link to opts")

`ProcessSenderKeyDistributionMessageOpts`

#### Returns[​](#returns-8 "Direct link to Returns")

`Promise`<`void`\>

### validateSession()[​](#validatesession "Direct link to validateSession()")

#### Call Signature[​](#call-signature "Direct link to Call Signature")

##### Parameters[​](#parameters-9 "Direct link to Parameters")

###### jid[​](#jid-1 "Direct link to jid")

`string`

##### Returns[​](#returns-9 "Direct link to Returns")

`Promise`<{ `exists`: `boolean`; `reason`: `string`; }>

#### Call Signature[​](#call-signature-1 "Direct link to Call Signature")

##### Parameters[​](#parameters-10 "Direct link to Parameters")

###### jid[​](#jid-2 "Direct link to jid")

`string`

##### Returns[​](#returns-10 "Direct link to Returns")

`Promise`<{ `exists`: `boolean`; `reason`: `string`; }>

---

<a name="type-alias-signedkeypair"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/SignedKeyPair](https://baileys.wiki/docs/api/type-aliases/SignedKeyPair)

> **SignedKeyPair**: `object`

Defined in: [src/Types/Auth.ts:6](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Auth.ts#L6)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### keyId[​](#keyid "Direct link to keyId")

> **keyId**: `number`

### keyPair[​](#keypair "Direct link to keyPair")

> **keyPair**: [`KeyPair`](/docs/api/type-aliases/KeyPair)

### signature[​](#signature "Direct link to signature")

> **signature**: `Uint8Array`

### timestampS?[​](#timestamps "Direct link to timestampS?")

> `optional` **timestampS**: `number`

---

<a name="type-alias-socketconfig"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/SocketConfig](https://baileys.wiki/docs/api/type-aliases/SocketConfig)

> **SocketConfig**: `object`

Defined in: [src/Types/Socket.ts:32](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Socket.ts#L32)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### agent?[​](#agent "Direct link to agent?")

> `optional` **agent**: `Agent`

proxy agent

### appStateMacVerification[​](#appstatemacverification "Direct link to appStateMacVerification")

> **appStateMacVerification**: `object`

verify app state MACs

#### appStateMacVerification.patch[​](#appstatemacverificationpatch "Direct link to appStateMacVerification.patch")

> **patch**: `boolean`

#### appStateMacVerification.snapshot[​](#appstatemacverificationsnapshot "Direct link to appStateMacVerification.snapshot")

> **snapshot**: `boolean`

### auth[​](#auth "Direct link to auth")

> **auth**: [`AuthenticationState`](/docs/api/type-aliases/AuthenticationState)

provide an auth state object to maintain the auth state

### browser[​](#browser "Direct link to browser")

> **browser**: [`WABrowserDescription`](/docs/api/type-aliases/WABrowserDescription)

override browser config

### cachedGroupMetadata()[​](#cachedgroupmetadata "Direct link to cachedGroupMetadata()")

> **cachedGroupMetadata**: (`jid`) => `Promise`<[`GroupMetadata`](/docs/api/interfaces/GroupMetadata) | `undefined`\>

cached group metadata, use to prevent redundant requests to WA & speed up msg sending

#### Parameters[​](#parameters "Direct link to Parameters")

##### jid[​](#jid "Direct link to jid")

`string`

#### Returns[​](#returns "Direct link to Returns")

`Promise`<[`GroupMetadata`](/docs/api/interfaces/GroupMetadata) | `undefined`\>

### callOfferCache?[​](#calloffercache "Direct link to callOfferCache?")

> `optional` **callOfferCache**: [`CacheStore`](/docs/api/type-aliases/CacheStore)

cache to store call offers

### connectTimeoutMs[​](#connecttimeoutms "Direct link to connectTimeoutMs")

> **connectTimeoutMs**: `number`

Fails the connection if the socket times out in this interval

### countryCode[​](#countrycode "Direct link to countryCode")

> **countryCode**: `string`

alphanumeric country code (USA -> US) for the number used

### customUploadHosts[​](#customuploadhosts "Direct link to customUploadHosts")

> **customUploadHosts**: [`MediaConnInfo`](/docs/api/type-aliases/MediaConnInfo)\[`"hosts"`\]

custom upload hosts to upload media to

### defaultQueryTimeoutMs[​](#defaultquerytimeoutms "Direct link to defaultQueryTimeoutMs")

> **defaultQueryTimeoutMs**: `number` | `undefined`

Default timeout for queries, undefined for no timeout

### emitOwnEvents[​](#emitownevents "Direct link to emitOwnEvents")

> **emitOwnEvents**: `boolean`

should events be emitted for actions done by this socket connection

### enableAutoSessionRecreation[​](#enableautosessionrecreation "Direct link to enableAutoSessionRecreation")

> **enableAutoSessionRecreation**: `boolean`

Enable automatic session recreation for failed messages

### enableRecentMessageCache[​](#enablerecentmessagecache "Direct link to enableRecentMessageCache")

> **enableRecentMessageCache**: `boolean`

Enable recent message caching for retry handling

### fetchAgent?[​](#fetchagent "Direct link to fetchAgent?")

> `optional` **fetchAgent**: `Agent`

agent used for fetch requests -- uploading/downloading media

### fireInitQueries[​](#fireinitqueries "Direct link to fireInitQueries")

> **fireInitQueries**: `boolean`

Should baileys fire init queries automatically, default true

### generateHighQualityLinkPreview[​](#generatehighqualitylinkpreview "Direct link to generateHighQualityLinkPreview")

> **generateHighQualityLinkPreview**: `boolean`

generate a high quality link preview, entails uploading the jpegThumbnail to WA

### getMessage()[​](#getmessage "Direct link to getMessage()")

> **getMessage**: (`key`) => `Promise`<[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage) | `undefined`\>

fetch a message from your store implement this so that messages failed to send (solves the "this message can take a while" issue) can be retried

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### key[​](#key "Direct link to key")

[`WAMessageKey`](/docs/api/type-aliases/WAMessageKey)

#### Returns[​](#returns-1 "Direct link to Returns")

`Promise`<[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage) | `undefined`\>

### keepAliveIntervalMs[​](#keepaliveintervalms "Direct link to keepAliveIntervalMs")

> **keepAliveIntervalMs**: `number`

ping-pong interval for WS connection

### linkPreviewImageThumbnailWidth[​](#linkpreviewimagethumbnailwidth "Direct link to linkPreviewImageThumbnailWidth")

> **linkPreviewImageThumbnailWidth**: `number`

width for link preview images

### logger[​](#logger "Direct link to logger")

> **logger**: `ILogger`

logger

### makeSignalRepository()[​](#makesignalrepository "Direct link to makeSignalRepository()")

> **makeSignalRepository**: (`auth`, `logger`, `pnToLIDFunc`?) => [`SignalRepositoryWithLIDStore`](/docs/api/interfaces/SignalRepositoryWithLIDStore)

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### auth[​](#auth-1 "Direct link to auth")

[`SignalAuthState`](/docs/api/type-aliases/SignalAuthState)

##### logger[​](#logger-1 "Direct link to logger")

`ILogger`

##### pnToLIDFunc?[​](#pntolidfunc "Direct link to pnToLIDFunc?")

(`jids`) => `Promise`<[`LIDMapping`](/docs/api/type-aliases/LIDMapping)\[\] | `undefined`\>

#### Returns[​](#returns-2 "Direct link to Returns")

[`SignalRepositoryWithLIDStore`](/docs/api/interfaces/SignalRepositoryWithLIDStore)

### markOnlineOnConnect[​](#markonlineonconnect "Direct link to markOnlineOnConnect")

> **markOnlineOnConnect**: `boolean`

marks the client as online whenever the socket successfully connects

### maxMsgRetryCount[​](#maxmsgretrycount "Direct link to maxMsgRetryCount")

> **maxMsgRetryCount**: `number`

max retry count

### mediaCache?[​](#mediacache "Direct link to mediaCache?")

> `optional` **mediaCache**: [`CacheStore`](/docs/api/type-aliases/CacheStore)

provide a cache to store media, so does not have to be re-uploaded

### mobile?[​](#mobile "Direct link to mobile")

> `optional` **mobile**: `boolean`

should baileys use the mobile api instead of the multi device api

#### Deprecated[​](#deprecated "Direct link to Deprecated")

This feature has been removed

### msgRetryCounterCache?[​](#msgretrycountercache "Direct link to msgRetryCounterCache?")

> `optional` **msgRetryCounterCache**: [`CacheStore`](/docs/api/type-aliases/CacheStore)

map to store the retry counts for failed messages; used to determine whether to retry a message or not

### options[​](#options "Direct link to options")

> **options**: `RequestInit`

options for HTTP fetch requests

### patchMessageBeforeSending()[​](#patchmessagebeforesending "Direct link to patchMessageBeforeSending()")

> **patchMessageBeforeSending**: (`msg`, `recipientJids`?) => `Promise`<[`PatchedMessageWithRecipientJID`](/docs/api/type-aliases/PatchedMessageWithRecipientJID)\[\] | [`PatchedMessageWithRecipientJID`](/docs/api/type-aliases/PatchedMessageWithRecipientJID)\> | [`PatchedMessageWithRecipientJID`](/docs/api/type-aliases/PatchedMessageWithRecipientJID)\[\] | [`PatchedMessageWithRecipientJID`](/docs/api/type-aliases/PatchedMessageWithRecipientJID)

Optionally patch the message before sending out

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### msg[​](#msg "Direct link to msg")

[`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

##### recipientJids?[​](#recipientjids "Direct link to recipientJids?")

`string`\[\]

#### Returns[​](#returns-3 "Direct link to Returns")

`Promise`<[`PatchedMessageWithRecipientJID`](/docs/api/type-aliases/PatchedMessageWithRecipientJID)\[\] | [`PatchedMessageWithRecipientJID`](/docs/api/type-aliases/PatchedMessageWithRecipientJID)\> | [`PatchedMessageWithRecipientJID`](/docs/api/type-aliases/PatchedMessageWithRecipientJID)\[\] | [`PatchedMessageWithRecipientJID`](/docs/api/type-aliases/PatchedMessageWithRecipientJID)

### placeholderResendCache?[​](#placeholderresendcache "Direct link to placeholderResendCache?")

> `optional` **placeholderResendCache**: [`CacheStore`](/docs/api/type-aliases/CacheStore)

cache to track placeholder resends

### printQRInTerminal?[​](#printqrinterminal "Direct link to printqrinterminal")

> `optional` **printQRInTerminal**: `boolean`

should the QR be printed in the terminal

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

This feature has been removed

### qrTimeout?[​](#qrtimeout "Direct link to qrTimeout?")

> `optional` **qrTimeout**: `number`

time to wait for the generation of the next QR in ms

### retryRequestDelayMs[​](#retryrequestdelayms "Direct link to retryRequestDelayMs")

> **retryRequestDelayMs**: `number`

time to wait between sending new retry requests

### shouldIgnoreJid()[​](#shouldignorejid "Direct link to shouldIgnoreJid()")

> **shouldIgnoreJid**: (`jid`) => `boolean` | `undefined`

Returns if a jid should be ignored, no event for that jid will be triggered. Messages from that jid will also not be decrypted

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### jid[​](#jid-1 "Direct link to jid")

`string`

#### Returns[​](#returns-4 "Direct link to Returns")

`boolean` | `undefined`

### shouldSyncHistoryMessage()[​](#shouldsynchistorymessage "Direct link to shouldSyncHistoryMessage()")

> **shouldSyncHistoryMessage**: (`msg`) => `boolean`

manage history processing with this control; by default will sync up everything

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### msg[​](#msg-1 "Direct link to msg")

[`IHistorySyncNotification`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IHistorySyncNotification)

#### Returns[​](#returns-5 "Direct link to Returns")

`boolean`

### syncFullHistory[​](#syncfullhistory "Direct link to syncFullHistory")

> **syncFullHistory**: `boolean`

Should Baileys ask the phone for full history, will be received async

### transactionOpts[​](#transactionopts "Direct link to transactionOpts")

> **transactionOpts**: [`TransactionCapabilityOptions`](/docs/api/type-aliases/TransactionCapabilityOptions)

transaction capability options for SignalKeyStore

### userDevicesCache?[​](#userdevicescache "Direct link to userDevicesCache?")

> `optional` **userDevicesCache**: [`PossiblyExtendedCacheStore`](/docs/api/type-aliases/PossiblyExtendedCacheStore)

provide a cache to store a user's device list

### version[​](#version "Direct link to version")

> **version**: [`WAVersion`](/docs/api/type-aliases/WAVersion)

version to connect with

### waWebSocketUrl[​](#wawebsocketurl "Direct link to waWebSocketUrl")

> **waWebSocketUrl**: `string` | `URL`

the WS url to connect to WA

---

<a name="type-alias-statusdata"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/StatusData](https://baileys.wiki/docs/api/type-aliases/StatusData)

> **StatusData**: `object`

Defined in: [src/WAUSync/Protocols/USyncStatusProtocol.ts:4](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/Protocols/USyncStatusProtocol.ts#L4)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### setAt?[​](#setat "Direct link to setAt?")

> `optional` **setAt**: `Date`

### status?[​](#status "Direct link to status?")

> `optional` **status**: `string` | `null`

---

<a name="type-alias-transactioncapabilityoptions"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/TransactionCapabilityOptions](https://baileys.wiki/docs/api/type-aliases/TransactionCapabilityOptions)

> **TransactionCapabilityOptions**: `object`

Defined in: [src/Types/Auth.ts:103](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Auth.ts#L103)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### delayBetweenTriesMs[​](#delaybetweentriesms "Direct link to delayBetweenTriesMs")

> **delayBetweenTriesMs**: `number`

### maxCommitRetries[​](#maxcommitretries "Direct link to maxCommitRetries")

> **maxCommitRetries**: `number`

---

<a name="type-alias-urlgenerationoptions"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/URLGenerationOptions](https://baileys.wiki/docs/api/type-aliases/URLGenerationOptions)

> **URLGenerationOptions**: `object`

Defined in: [src/Utils/link-preview.ts:15](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/link-preview.ts#L15)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### fetchOpts[​](#fetchopts "Direct link to fetchOpts")

> **fetchOpts**: `object`

#### fetchOpts.headers?[​](#fetchoptsheaders "Direct link to fetchOpts.headers?")

> `optional` **headers**: `HeadersInit`

#### fetchOpts.proxyUrl?[​](#fetchoptsproxyurl "Direct link to fetchOpts.proxyUrl?")

> `optional` **proxyUrl**: `string`

#### fetchOpts.timeout[​](#fetchoptstimeout "Direct link to fetchOpts.timeout")

> **timeout**: `number`

Timeout in ms

### logger?[​](#logger "Direct link to logger?")

> `optional` **logger**: `ILogger`

### thumbnailWidth[​](#thumbnailwidth "Direct link to thumbnailWidth")

> **thumbnailWidth**: `number`

### uploadImage?[​](#uploadimage "Direct link to uploadImage?")

> `optional` **uploadImage**: [`WAMediaUploadFunction`](/docs/api/type-aliases/WAMediaUploadFunction)

---

<a name="type-alias-usyncqueryresult"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/USyncQueryResult](https://baileys.wiki/docs/api/type-aliases/USyncQueryResult)

> **USyncQueryResult**: `object`

Defined in: [src/WAUSync/USyncQuery.ts:15](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncQuery.ts#L15)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### list[​](#list "Direct link to list")

> **list**: [`USyncQueryResultList`](/docs/api/type-aliases/USyncQueryResultList)\[\]

### sideList[​](#sidelist "Direct link to sideList")

> **sideList**: [`USyncQueryResultList`](/docs/api/type-aliases/USyncQueryResultList)\[\]

---

<a name="type-alias-usyncqueryresultlist"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/USyncQueryResultList](https://baileys.wiki/docs/api/type-aliases/USyncQueryResultList)

> **USyncQueryResultList**: `object`

Defined in: [src/WAUSync/USyncQuery.ts:13](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAUSync/USyncQuery.ts#L13)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

## Index Signature[​](#index-signature "Direct link to Index Signature")

\[`protocol`: `string`\]: `unknown`

### id[​](#id "Direct link to id")

> **id**: `string`

---

<a name="type-alias-uploadparams"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/UploadParams](https://baileys.wiki/docs/api/type-aliases/UploadParams)

> **UploadParams**: `object`

Defined in: [src/Utils/messages-media.ts:671](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/messages-media.ts#L671)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### agent?[​](#agent "Direct link to agent?")

> `optional` **agent**: `Agent`

### filePath[​](#filepath "Direct link to filePath")

> **filePath**: `string`

### headers[​](#headers "Direct link to headers")

> **headers**: `Record`<`string`, `string`\>

### timeoutMs?[​](#timeoutms "Direct link to timeoutMs?")

> `optional` **timeoutMs**: `number`

### url[​](#url "Direct link to url")

> **url**: `string`

---

<a name="type-alias-userfacingsocketconfig"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/UserFacingSocketConfig](https://baileys.wiki/docs/api/type-aliases/UserFacingSocketConfig)

> **UserFacingSocketConfig**: `Partial`<[`SocketConfig`](/docs/api/type-aliases/SocketConfig)\> & `object`

Defined in: [src/Types/index.ts:17](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/index.ts#L17)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### auth[​](#auth "Direct link to auth")

> **auth**: [`AuthenticationState`](/docs/api/type-aliases/AuthenticationState)

---

<a name="type-alias-value"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/Value](https://baileys.wiki/docs/api/type-aliases/Value)

> **Value**: `number` | `null` | `string`

Defined in: [src/WAM/constants.ts:22889](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAM/constants.ts#L22889)

---

<a name="type-alias-wabrowserdescription"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WABrowserDescription](https://baileys.wiki/docs/api/type-aliases/WABrowserDescription)

> **WABrowserDescription**: \[`string`, `string`, `string`\]

Defined in: [src/Types/Socket.ts:11](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Socket.ts#L11)

---

<a name="type-alias-wabusinesshoursconfig"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WABusinessHoursConfig](https://baileys.wiki/docs/api/type-aliases/WABusinessHoursConfig)

> **WABusinessHoursConfig**: `object`

Defined in: [src/Types/index.ts:46](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/index.ts#L46)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### close\_time?[​](#close_time "Direct link to close_time?")

> `optional` **close\_time**: `number`

### day\_of\_week[​](#day_of_week "Direct link to day_of_week")

> **day\_of\_week**: `string`

### mode[​](#mode "Direct link to mode")

> **mode**: `string`

### open\_time?[​](#open_time "Direct link to open_time?")

> `optional` **open\_time**: `number`

---

<a name="type-alias-wabusinessprofile"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WABusinessProfile](https://baileys.wiki/docs/api/type-aliases/WABusinessProfile)

> **WABusinessProfile**: `object`

Defined in: [src/Types/index.ts:53](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/index.ts#L53)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### address?[​](#address "Direct link to address?")

> `optional` **address**: `string`

### business\_hours[​](#business_hours "Direct link to business_hours")

> **business\_hours**: `object`

#### business\_hours.business\_config?[​](#business_hoursbusiness_config "Direct link to business_hours.business_config?")

> `optional` **business\_config**: [`WABusinessHoursConfig`](/docs/api/type-aliases/WABusinessHoursConfig)\[\]

#### business\_hours.config?[​](#business_hoursconfig "Direct link to business_hours.config?")

> `optional` **config**: [`WABusinessHoursConfig`](/docs/api/type-aliases/WABusinessHoursConfig)\[\]

#### business\_hours.timezone?[​](#business_hourstimezone "Direct link to business_hours.timezone?")

> `optional` **timezone**: `string`

### category?[​](#category "Direct link to category?")

> `optional` **category**: `string`

### description[​](#description "Direct link to description")

> **description**: `string`

### email[​](#email "Direct link to email")

> **email**: `string` | `undefined`

### website[​](#website "Direct link to website")

> **website**: `string`\[\]

### wid?[​](#wid "Direct link to wid?")

> `optional` **wid**: `string`

---

<a name="type-alias-wacallevent"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WACallEvent](https://baileys.wiki/docs/api/type-aliases/WACallEvent)

> **WACallEvent**: `object`

Defined in: [src/Types/Call.ts:3](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Call.ts#L3)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### callerPn?[​](#callerpn "Direct link to callerPn?")

> `optional` **callerPn**: `string`

### chatId[​](#chatid "Direct link to chatId")

> **chatId**: `string`

### date[​](#date "Direct link to date")

> **date**: `Date`

### from[​](#from "Direct link to from")

> **from**: `string`

### groupJid?[​](#groupjid "Direct link to groupJid?")

> `optional` **groupJid**: `string`

### id[​](#id "Direct link to id")

> **id**: `string`

### isGroup?[​](#isgroup "Direct link to isGroup?")

> `optional` **isGroup**: `boolean`

### isVideo?[​](#isvideo "Direct link to isVideo?")

> `optional` **isVideo**: `boolean`

### latencyMs?[​](#latencyms "Direct link to latencyMs?")

> `optional` **latencyMs**: `number`

### offline[​](#offline "Direct link to offline")

> **offline**: `boolean`

### status[​](#status "Direct link to status")

> **status**: [`WACallUpdateType`](/docs/api/type-aliases/WACallUpdateType)

---

<a name="type-alias-wacallupdatetype"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WACallUpdateType](https://baileys.wiki/docs/api/type-aliases/WACallUpdateType)

> **WACallUpdateType**: `"offer"` | `"ringing"` | `"timeout"` | `"reject"` | `"accept"` | `"terminate"`

Defined in: [src/Types/Call.ts:1](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Call.ts#L1)

---

<a name="type-alias-waconnectionstate"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAConnectionState](https://baileys.wiki/docs/api/type-aliases/WAConnectionState)

> **WAConnectionState**: `"open"` | `"connecting"` | `"close"`

Defined in: [src/Types/State.ts:15](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/State.ts#L15)

---

<a name="type-alias-wacontactmessage"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAContactMessage](https://baileys.wiki/docs/api/type-aliases/WAContactMessage)

> **WAContactMessage**: [`IContactMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactMessage)

Defined in: [src/Types/Message.ts:18](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L18)

---

<a name="type-alias-wacontactsarraymessage"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAContactsArrayMessage](https://baileys.wiki/docs/api/type-aliases/WAContactsArrayMessage)

> **WAContactsArrayMessage**: [`IContactsArrayMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IContactsArrayMessage)

Defined in: [src/Types/Message.ts:19](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L19)

---

<a name="type-alias-wacontextinfo"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAContextInfo](https://baileys.wiki/docs/api/type-aliases/WAContextInfo)

> **WAContextInfo**: [`IContextInfo`](/docs/api/namespaces/proto/interfaces/IContextInfo)

Defined in: [src/Types/Message.ts:28](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L28)

---

<a name="type-alias-wagenericmediamessage"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAGenericMediaMessage](https://baileys.wiki/docs/api/type-aliases/WAGenericMediaMessage)

> **WAGenericMediaMessage**: [`IVideoMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IVideoMessage) | [`IImageMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IImageMessage) | [`IAudioMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IAudioMessage) | [`IDocumentMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IDocumentMessage) | [`IStickerMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IStickerMessage)

Defined in: [src/Types/Message.ts:30](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L30)

---

<a name="type-alias-wainitresponse"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAInitResponse](https://baileys.wiki/docs/api/type-aliases/WAInitResponse)

> **WAInitResponse**: `object`

Defined in: [src/Types/index.ts:40](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/index.ts#L40)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### ref[​](#ref "Direct link to ref")

> **ref**: `string`

### status[​](#status "Direct link to status")

> **status**: `200`

### ttl[​](#ttl "Direct link to ttl")

> **ttl**: `number`

---

<a name="type-alias-walocationmessage"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WALocationMessage](https://baileys.wiki/docs/api/type-aliases/WALocationMessage)

> **WALocationMessage**: [`ILocationMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/ILocationMessage)

Defined in: [src/Types/Message.ts:29](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L29)

---

<a name="type-alias-wamediapayloadstream"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAMediaPayloadStream](https://baileys.wiki/docs/api/type-aliases/WAMediaPayloadStream)

> **WAMediaPayloadStream**: `object`

Defined in: [src/Types/Message.ts:40](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L40)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### stream[​](#stream "Direct link to stream")

> **stream**: `Readable`

---

<a name="type-alias-wamediapayloadurl"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAMediaPayloadURL](https://baileys.wiki/docs/api/type-aliases/WAMediaPayloadURL)

> **WAMediaPayloadURL**: `object`

Defined in: [src/Types/Message.ts:39](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L39)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### url[​](#url "Direct link to url")

> **url**: `URL` | `string`

---

<a name="type-alias-wamediaupload"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAMediaUpload](https://baileys.wiki/docs/api/type-aliases/WAMediaUpload)

> **WAMediaUpload**: `Buffer` | [`WAMediaPayloadStream`](/docs/api/type-aliases/WAMediaPayloadStream) | [`WAMediaPayloadURL`](/docs/api/type-aliases/WAMediaPayloadURL)

Defined in: [src/Types/Message.ts:41](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L41)

---

<a name="type-alias-wamediauploadfunction-"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAMediaUploadFunction](https://baileys.wiki/docs/api/type-aliases/WAMediaUploadFunction)

> **WAMediaUploadFunction**: (`encFilePath`, `opts`) => `Promise`<{ `directPath`: `string`; `fbid`: `number`; `mediaUrl`: `string`; `meta_hmac`: `string`; `ts`: `number`; }>

Defined in: [src/Types/Message.ts:333](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L333)

## Parameters[​](#parameters "Direct link to Parameters")

### encFilePath[​](#encfilepath "Direct link to encFilePath")

`string`

### opts[​](#opts "Direct link to opts")

#### fileEncSha256B64[​](#fileencsha256b64 "Direct link to fileEncSha256B64")

`string`

#### mediaType[​](#mediatype "Direct link to mediaType")

[`MediaType`](/docs/api/type-aliases/MediaType)

#### timeoutMs?[​](#timeoutms "Direct link to timeoutMs?")

`number`

## Returns[​](#returns "Direct link to Returns")

`Promise`<{ `directPath`: `string`; `fbid`: `number`; `mediaUrl`: `string`; `meta_hmac`: `string`; `ts`: `number`; }>

---

<a name="type-alias-wamessage"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAMessage](https://baileys.wiki/docs/api/type-aliases/WAMessage)

> **WAMessage**: [`IWebMessageInfo`](/docs/api/namespaces/proto/interfaces/IWebMessageInfo) & `object`

Defined in: [src/Types/Message.ts:11](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L11)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### category?[​](#category "Direct link to category?")

> `optional` **category**: `string`

### key[​](#key "Direct link to key")

> **key**: [`WAMessageKey`](/docs/api/type-aliases/WAMessageKey)

### messageStubParameters?[​](#messagestubparameters "Direct link to messageStubParameters?")

> `optional` **messageStubParameters**: `any`

### retryCount?[​](#retrycount "Direct link to retryCount?")

> `optional` **retryCount**: `number`

---

<a name="type-alias-wamessagecontent"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAMessageContent](https://baileys.wiki/docs/api/type-aliases/WAMessageContent)

> **WAMessageContent**: [`IMessage`](/docs/api/namespaces/proto/interfaces/IMessage)

Defined in: [src/Types/Message.ts:17](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L17)

---

<a name="type-alias-wamessagecursor"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAMessageCursor](https://baileys.wiki/docs/api/type-aliases/WAMessageCursor)

> **WAMessageCursor**: { `before`: [`WAMessageKey`](/docs/api/type-aliases/WAMessageKey) | `undefined`; } | { `after`: [`WAMessageKey`](/docs/api/type-aliases/WAMessageKey) | `undefined`; }

Defined in: [src/Types/Message.ts:372](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L372)

---

<a name="type-alias-wamessagekey"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAMessageKey](https://baileys.wiki/docs/api/type-aliases/WAMessageKey)

> **WAMessageKey**: [`IMessageKey`](/docs/api/namespaces/proto/interfaces/IMessageKey) & `object`

Defined in: [src/Types/Message.ts:20](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L20)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### addressingMode?[​](#addressingmode "Direct link to addressingMode?")

> `optional` **addressingMode**: `string`

### isViewOnce?[​](#isviewonce "Direct link to isViewOnce?")

> `optional` **isViewOnce**: `boolean`

### participantAlt?[​](#participantalt "Direct link to participantAlt?")

> `optional` **participantAlt**: `string`

### remoteJidAlt?[​](#remotejidalt "Direct link to remoteJidAlt?")

> `optional` **remoteJidAlt**: `string`

### server\_id?[​](#server_id "Direct link to server_id?")

> `optional` **server\_id**: `string`

---

<a name="type-alias-wamessageupdate"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAMessageUpdate](https://baileys.wiki/docs/api/type-aliases/WAMessageUpdate)

> **WAMessageUpdate**: `object`

Defined in: [src/Types/Message.ts:370](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L370)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### key[​](#key "Direct link to key")

> **key**: [`WAMessageKey`](/docs/api/type-aliases/WAMessageKey)

### update[​](#update "Direct link to update")

> **update**: `Partial`<[`WAMessage`](/docs/api/type-aliases/WAMessage)\>

---

<a name="type-alias-wapatchcreate"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAPatchCreate](https://baileys.wiki/docs/api/type-aliases/WAPatchCreate)

> **WAPatchCreate**: `object`

Defined in: [src/Types/Chat.ts:51](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L51)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### apiVersion[​](#apiversion "Direct link to apiVersion")

> **apiVersion**: `number`

### index[​](#index "Direct link to index")

> **index**: `string`\[\]

### operation[​](#operation "Direct link to operation")

> **operation**: [`SyncdOperation`](/docs/api/namespaces/proto/namespaces/SyncdMutation/enumerations/SyncdOperation)

### syncAction[​](#syncaction "Direct link to syncAction")

> **syncAction**: [`ISyncActionValue`](/docs/api/namespaces/proto/interfaces/ISyncActionValue)

### type[​](#type "Direct link to type")

> **type**: [`WAPatchName`](/docs/api/type-aliases/WAPatchName)

---

<a name="type-alias-wapatchname"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAPatchName](https://baileys.wiki/docs/api/type-aliases/WAPatchName)

> **WAPatchName**: _typeof_ [`ALL_WA_PATCH_NAMES`](/docs/api/variables/ALL_WA_PATCH_NAMES)\[`number`\]

Defined in: [src/Types/Chat.ts:34](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L34)

---

<a name="type-alias-wapresence"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAPresence](https://baileys.wiki/docs/api/type-aliases/WAPresence)

> **WAPresence**: `"unavailable"` | `"available"` | `"composing"` | `"recording"` | `"paused"`

Defined in: [src/Types/Chat.ts:24](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L24)

set of statuses visible to other people; see updatePresence() in WhatsAppWeb.Send

---

<a name="type-alias-waprivacycallvalue"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAPrivacyCallValue](https://baileys.wiki/docs/api/type-aliases/WAPrivacyCallValue)

> **WAPrivacyCallValue**: `"all"` | `"known"`

Defined in: [src/Types/Chat.ts:19](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L19)

---

<a name="type-alias-waprivacygroupaddvalue"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAPrivacyGroupAddValue](https://baileys.wiki/docs/api/type-aliases/WAPrivacyGroupAddValue)

> **WAPrivacyGroupAddValue**: `"all"` | `"contacts"` | `"contact_blacklist"`

Defined in: [src/Types/Chat.ts:15](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L15)

---

<a name="type-alias-waprivacymessagesvalue"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAPrivacyMessagesValue](https://baileys.wiki/docs/api/type-aliases/WAPrivacyMessagesValue)

> **WAPrivacyMessagesValue**: `"all"` | `"contacts"`

Defined in: [src/Types/Chat.ts:21](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L21)

---

<a name="type-alias-waprivacyonlinevalue"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAPrivacyOnlineValue](https://baileys.wiki/docs/api/type-aliases/WAPrivacyOnlineValue)

> **WAPrivacyOnlineValue**: `"all"` | `"match_last_seen"`

Defined in: [src/Types/Chat.ts:13](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L13)

---

<a name="type-alias-waprivacyvalue"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAPrivacyValue](https://baileys.wiki/docs/api/type-aliases/WAPrivacyValue)

> **WAPrivacyValue**: `"all"` | `"contacts"` | `"contact_blacklist"` | `"none"`

Defined in: [src/Types/Chat.ts:11](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L11)

privacy settings in WhatsApp Web

---

<a name="type-alias-wareadreceiptsvalue"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAReadReceiptsValue](https://baileys.wiki/docs/api/type-aliases/WAReadReceiptsValue)

> **WAReadReceiptsValue**: `"all"` | `"none"`

Defined in: [src/Types/Chat.ts:17](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L17)

---

<a name="type-alias-wasendableproduct"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WASendableProduct](https://baileys.wiki/docs/api/type-aliases/WASendableProduct)

> **WASendableProduct**: `Omit`<[`IProductSnapshot`](/docs/api/namespaces/proto/namespaces/Message/namespaces/ProductMessage/interfaces/IProductSnapshot), `"productImage"`\> & `object`

Defined in: [src/Types/Message.ts:216](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L216)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### productImage[​](#productimage "Direct link to productImage")

> **productImage**: [`WAMediaUpload`](/docs/api/type-aliases/WAMediaUpload)

---

<a name="type-alias-wasocket"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WASocket](https://baileys.wiki/docs/api/type-aliases/WASocket)

> **WASocket**: `ReturnType`<_typeof_ [`makeWASocket`](/docs/api/functions/makeWASocket)\>

Defined in: [src/index.ts:11](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/index.ts#L11)

---

<a name="type-alias-watextmessage"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WATextMessage](https://baileys.wiki/docs/api/type-aliases/WATextMessage)

> **WATextMessage**: [`IExtendedTextMessage`](/docs/api/namespaces/proto/namespaces/Message/interfaces/IExtendedTextMessage)

Defined in: [src/Types/Message.ts:27](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L27)

---

<a name="type-alias-waversion"></a>

> Source: [https://baileys.wiki/docs/api/type-aliases/WAVersion](https://baileys.wiki/docs/api/type-aliases/WAVersion)

> **WAVersion**: \[`number`, `number`, `number`\]

Defined in: [src/Types/Socket.ts:10](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Socket.ts#L10)

---

<a name="variable-all-_wa-_patch-_names"></a>

> Source: [https://baileys.wiki/docs/api/variables/ALL_WA_PATCH_NAMES](https://baileys.wiki/docs/api/variables/ALL_WA_PATCH_NAMES)

> `const` **ALL\_WA\_PATCH\_NAMES**: readonly \[`"critical_block"`, `"critical_unblock_low"`, `"regular_high"`, `"regular_low"`, `"regular"`\]

Defined in: [src/Types/Chat.ts:26](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Chat.ts#L26)

---

<a name="variable-browsers"></a>

> Source: [https://baileys.wiki/docs/api/variables/Browsers](https://baileys.wiki/docs/api/variables/Browsers)

> `const` **Browsers**: [`BrowsersMap`](/docs/api/type-aliases/BrowsersMap)

Defined in: [src/Utils/browser-utils.ts:19](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/browser-utils.ts#L19)

---

<a name="variable-bufferjson"></a>

> Source: [https://baileys.wiki/docs/api/variables/BufferJSON](https://baileys.wiki/docs/api/variables/BufferJSON)

> `const` **BufferJSON**: `object`

Defined in: [src/Utils/generics.ts:17](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/generics.ts#L17)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### replacer()[​](#replacer "Direct link to replacer()")

> **replacer**: (`k`, `value`) => `any`

#### Parameters[​](#parameters "Direct link to Parameters")

##### k[​](#k "Direct link to k")

`any`

##### value[​](#value "Direct link to value")

`any`

#### Returns[​](#returns "Direct link to Returns")

`any`

### reviver()[​](#reviver "Direct link to reviver()")

> **reviver**: (`_`, `value`) => `any`

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### \_[​](#_ "Direct link to _")

`any`

##### value[​](#value-1 "Direct link to value")

`any`

#### Returns[​](#returns-1 "Direct link to Returns")

`any`

---

<a name="variable-call-_audio-_prefix"></a>

> Source: [https://baileys.wiki/docs/api/variables/CALL_AUDIO_PREFIX](https://baileys.wiki/docs/api/variables/CALL_AUDIO_PREFIX)

> `const` **CALL\_AUDIO\_PREFIX**: `"https://call.whatsapp.com/voice/"` = `'https://call.whatsapp.com/voice/'`

Defined in: [src/Defaults/index.ts:13](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L13)

---

<a name="variable-call-_video-_prefix"></a>

> Source: [https://baileys.wiki/docs/api/variables/CALL_VIDEO_PREFIX](https://baileys.wiki/docs/api/variables/CALL_VIDEO_PREFIX)

> `const` **CALL\_VIDEO\_PREFIX**: `"https://call.whatsapp.com/video/"` = `'https://call.whatsapp.com/video/'`

Defined in: [src/Defaults/index.ts:12](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L12)

---

<a name="variable-curve"></a>

> Source: [https://baileys.wiki/docs/api/variables/Curve](https://baileys.wiki/docs/api/variables/Curve)

> `const` **Curve**: `object`

Defined in: [src/Utils/crypto.ts:14](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/crypto.ts#L14)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### generateKeyPair()[​](#generatekeypair "Direct link to generateKeyPair()")

> **generateKeyPair**: () => [`KeyPair`](/docs/api/type-aliases/KeyPair)

#### Returns[​](#returns "Direct link to Returns")

[`KeyPair`](/docs/api/type-aliases/KeyPair)

### sharedKey()[​](#sharedkey "Direct link to sharedKey()")

> **sharedKey**: (`privateKey`, `publicKey`) => `Buffer`<`ArrayBuffer`\>

#### Parameters[​](#parameters "Direct link to Parameters")

##### privateKey[​](#privatekey "Direct link to privateKey")

`Uint8Array`

##### publicKey[​](#publickey "Direct link to publicKey")

`Uint8Array`

#### Returns[​](#returns-1 "Direct link to Returns")

`Buffer`<`ArrayBuffer`\>

### sign()[​](#sign "Direct link to sign()")

> **sign**: (`privateKey`, `buf`) => `Uint8Array`<`ArrayBufferLike`\>

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### privateKey[​](#privatekey-1 "Direct link to privateKey")

`Uint8Array`

##### buf[​](#buf "Direct link to buf")

`Uint8Array`

#### Returns[​](#returns-2 "Direct link to Returns")

`Uint8Array`<`ArrayBufferLike`\>

### verify()[​](#verify "Direct link to verify()")

> **verify**: (`pubKey`, `message`, `signature`) => `boolean`

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### pubKey[​](#pubkey "Direct link to pubKey")

`Uint8Array`

##### message[​](#message "Direct link to message")

`Uint8Array`

##### signature[​](#signature "Direct link to signature")

`Uint8Array`

#### Returns[​](#returns-3 "Direct link to Returns")

`boolean`

---

<a name="variable-decryption-_retry-_config"></a>

> Source: [https://baileys.wiki/docs/api/variables/DECRYPTION_RETRY_CONFIG](https://baileys.wiki/docs/api/variables/DECRYPTION_RETRY_CONFIG)

> `const` **DECRYPTION\_RETRY\_CONFIG**: `object`

Defined in: [src/Utils/decode-wa-message.ts:56](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/decode-wa-message.ts#L56)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### baseDelayMs[​](#basedelayms "Direct link to baseDelayMs")

> **baseDelayMs**: `number` = `100`

### maxRetries[​](#maxretries "Direct link to maxRetries")

> **maxRetries**: `number` = `3`

### sessionRecordErrors[​](#sessionrecorderrors "Direct link to sessionRecordErrors")

> **sessionRecordErrors**: `string`\[\]

---

<a name="variable-default-_cache-_ttls"></a>

> Source: [https://baileys.wiki/docs/api/variables/DEFAULT_CACHE_TTLS](https://baileys.wiki/docs/api/variables/DEFAULT_CACHE_TTLS)

> `const` **DEFAULT\_CACHE\_TTLS**: `object`

Defined in: [src/Defaults/index.ts:137](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L137)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### CALL\_OFFER[​](#call_offer "Direct link to CALL_OFFER")

> **CALL\_OFFER**: `number`

### MSG\_RETRY[​](#msg_retry "Direct link to MSG_RETRY")

> **MSG\_RETRY**: `number`

### SIGNAL\_STORE[​](#signal_store "Direct link to SIGNAL_STORE")

> **SIGNAL\_STORE**: `number`

### USER\_DEVICES[​](#user_devices "Direct link to USER_DEVICES")

> **USER\_DEVICES**: `number`

---

<a name="variable-default-_connection-_config"></a>

> Source: [https://baileys.wiki/docs/api/variables/DEFAULT_CONNECTION_CONFIG](https://baileys.wiki/docs/api/variables/DEFAULT_CONNECTION_CONFIG)

> `const` **DEFAULT\_CONNECTION\_CONFIG**: [`SocketConfig`](/docs/api/type-aliases/SocketConfig)

Defined in: [src/Defaults/index.ts:54](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L54)

---

<a name="variable-default-_origin"></a>

> Source: [https://baileys.wiki/docs/api/variables/DEFAULT_ORIGIN](https://baileys.wiki/docs/api/variables/DEFAULT_ORIGIN)

> `const` **DEFAULT\_ORIGIN**: `"https://web.whatsapp.com"` = `'https://web.whatsapp.com'`

Defined in: [src/Defaults/index.ts:11](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L11)

---

<a name="variable-def-_callback-_prefix"></a>

> Source: [https://baileys.wiki/docs/api/variables/DEF_CALLBACK_PREFIX](https://baileys.wiki/docs/api/variables/DEF_CALLBACK_PREFIX)

> `const` **DEF\_CALLBACK\_PREFIX**: `"CB:"` = `'CB:'`

Defined in: [src/Defaults/index.ts:14](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L14)

---

<a name="variable-def-_tag-_prefix"></a>

> Source: [https://baileys.wiki/docs/api/variables/DEF_TAG_PREFIX](https://baileys.wiki/docs/api/variables/DEF_TAG_PREFIX)

> `const` **DEF\_TAG\_PREFIX**: `"TAG:"` = `'TAG:'`

Defined in: [src/Defaults/index.ts:15](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L15)

---

<a name="variable-dict-_version"></a>

> Source: [https://baileys.wiki/docs/api/variables/DICT_VERSION](https://baileys.wiki/docs/api/variables/DICT_VERSION)

> `const` **DICT\_VERSION**: `3` = `3`

Defined in: [src/Defaults/index.ts:32](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L32)

---

<a name="variable-flag-_byte"></a>

> Source: [https://baileys.wiki/docs/api/variables/FLAG_BYTE](https://baileys.wiki/docs/api/variables/FLAG_BYTE)

> `const` **FLAG\_BYTE**: `8` = `8`

Defined in: [src/WAM/constants.ts:22854](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAM/constants.ts#L22854)

---

<a name="variable-flag-_event"></a>

> Source: [https://baileys.wiki/docs/api/variables/FLAG_EVENT](https://baileys.wiki/docs/api/variables/FLAG_EVENT)

> `const` **FLAG\_EVENT**: `1` = `1`

Defined in: [src/WAM/constants.ts:22856](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAM/constants.ts#L22856)

---

<a name="variable-flag-_extended"></a>

> Source: [https://baileys.wiki/docs/api/variables/FLAG_EXTENDED](https://baileys.wiki/docs/api/variables/FLAG_EXTENDED)

> `const` **FLAG\_EXTENDED**: `4` = `4`

Defined in: [src/WAM/constants.ts:22858](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAM/constants.ts#L22858)

---

<a name="variable-flag-_field"></a>

> Source: [https://baileys.wiki/docs/api/variables/FLAG_FIELD](https://baileys.wiki/docs/api/variables/FLAG_FIELD)

> `const` **FLAG\_FIELD**: `2` = `2`

Defined in: [src/WAM/constants.ts:22857](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAM/constants.ts#L22857)

---

<a name="variable-flag-_global"></a>

> Source: [https://baileys.wiki/docs/api/variables/FLAG_GLOBAL](https://baileys.wiki/docs/api/variables/FLAG_GLOBAL)

> `const` **FLAG\_GLOBAL**: `0` = `0`

Defined in: [src/WAM/constants.ts:22855](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAM/constants.ts#L22855)

---

<a name="variable-initial-_prekey-_count"></a>

> Source: [https://baileys.wiki/docs/api/variables/INITIAL_PREKEY_COUNT](https://baileys.wiki/docs/api/variables/INITIAL_PREKEY_COUNT)

> `const` **INITIAL\_PREKEY\_COUNT**: `812` = `812`

Defined in: [src/Defaults/index.ts:132](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L132)

---

<a name="variable-key-_bundle-_type"></a>

> Source: [https://baileys.wiki/docs/api/variables/KEY_BUNDLE_TYPE](https://baileys.wiki/docs/api/variables/KEY_BUNDLE_TYPE)

> `const` **KEY\_BUNDLE\_TYPE**: `Buffer`<`ArrayBuffer`\>

Defined in: [src/Defaults/index.ts:33](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L33)

---

<a name="variable-lt-_hash-_anti-_tampering"></a>

> Source: [https://baileys.wiki/docs/api/variables/LT_HASH_ANTI_TAMPERING](https://baileys.wiki/docs/api/variables/LT_HASH_ANTI_TAMPERING)

> `const` **LT\_HASH\_ANTI\_TAMPERING**: `LTHashAntiTampering`

Defined in: [src/Utils/lt-hash.ts:8](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/lt-hash.ts#L8)

LT Hash is a summation based hash algorithm that maintains the integrity of a piece of data over a series of mutations. You can add/remove mutations and it'll return a hash equal to if the same series of mutations was made sequentially.

---

<a name="variable-media-_hkdf-_key-_mapping"></a>

> Source: [https://baileys.wiki/docs/api/variables/MEDIA_HKDF_KEY_MAPPING](https://baileys.wiki/docs/api/variables/MEDIA_HKDF_KEY_MAPPING)

> `const` **MEDIA\_HKDF\_KEY\_MAPPING**: `object`

Defined in: [src/Defaults/index.ts:104](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L104)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### audio[​](#audio "Direct link to audio")

> **audio**: `string` = `'Audio'`

### biz-cover-photo[​](#biz-cover-photo "Direct link to biz-cover-photo")

> **biz-cover-photo**: `string` = `'Image'`

### document[​](#document "Direct link to document")

> **document**: `string` = `'Document'`

### gif[​](#gif "Direct link to gif")

> **gif**: `string` = `'Video'`

### image[​](#image "Direct link to image")

> **image**: `string` = `'Image'`

### md-app-state[​](#md-app-state "Direct link to md-app-state")

> **md-app-state**: `string` = `'App State'`

### md-msg-hist[​](#md-msg-hist "Direct link to md-msg-hist")

> **md-msg-hist**: `string` = `'History'`

### payment-bg-image[​](#payment-bg-image "Direct link to payment-bg-image")

> **payment-bg-image**: `string` = `'Payment Background'`

### ppic[​](#ppic "Direct link to ppic")

> **ppic**: `string` = `''`

### product[​](#product "Direct link to product")

> **product**: `string` = `'Image'`

### product-catalog-image[​](#product-catalog-image "Direct link to product-catalog-image")

> **product-catalog-image**: `string` = `''`

### ptt[​](#ptt "Direct link to ptt")

> **ptt**: `string` = `'Audio'`

### ptv[​](#ptv "Direct link to ptv")

> **ptv**: `string` = `'Video'`

### sticker[​](#sticker "Direct link to sticker")

> **sticker**: `string` = `'Image'`

### thumbnail-document[​](#thumbnail-document "Direct link to thumbnail-document")

> **thumbnail-document**: `string` = `'Document Thumbnail'`

### thumbnail-image[​](#thumbnail-image "Direct link to thumbnail-image")

> **thumbnail-image**: `string` = `'Image Thumbnail'`

### thumbnail-link[​](#thumbnail-link "Direct link to thumbnail-link")

> **thumbnail-link**: `string` = `'Link Thumbnail'`

### thumbnail-video[​](#thumbnail-video "Direct link to thumbnail-video")

> **thumbnail-video**: `string` = `'Video Thumbnail'`

### video[​](#video "Direct link to video")

> **video**: `string` = `'Video'`

---

<a name="variable-media-_keys"></a>

> Source: [https://baileys.wiki/docs/api/variables/MEDIA_KEYS](https://baileys.wiki/docs/api/variables/MEDIA_KEYS)

> `const` **MEDIA\_KEYS**: (`"ppic"` | `"product"` | `"image"` | `"video"` | `"sticker"` | `"thumbnail-document"` | `"audio"` | `"thumbnail-image"` | `"biz-cover-photo"` | `"thumbnail-video"` | `"thumbnail-link"` | `"gif"` | `"md-app-state"` | `"md-msg-hist"` | `"document"` | `"ptt"` | `"product-catalog-image"` | `"payment-bg-image"` | `"ptv"`)\[\]

Defined in: [src/Defaults/index.ts:128](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L128)

---

<a name="variable-media-_path-_map"></a>

> Source: [https://baileys.wiki/docs/api/variables/MEDIA_PATH_MAP](https://baileys.wiki/docs/api/variables/MEDIA_PATH_MAP)

> `const` **MEDIA\_PATH\_MAP**: `{ [T in MediaType]?: string }`

Defined in: [src/Defaults/index.ts:91](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L91)

---

<a name="variable-meta-_ai-_jid"></a>

> Source: [https://baileys.wiki/docs/api/variables/META_AI_JID](https://baileys.wiki/docs/api/variables/META_AI_JID)

> `const` **META\_AI\_JID**: `"13135550002@c.us"` = `'13135550002@c.us'`

Defined in: [src/WABinary/jid-utils.ts:6](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L6)

---

<a name="variable-min-_prekey-_count"></a>

> Source: [https://baileys.wiki/docs/api/variables/MIN_PREKEY_COUNT](https://baileys.wiki/docs/api/variables/MIN_PREKEY_COUNT)

> `const` **MIN\_PREKEY\_COUNT**: `5` = `5`

Defined in: [src/Defaults/index.ts:130](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L130)

---

<a name="variable-min-_upload-_interval"></a>

> Source: [https://baileys.wiki/docs/api/variables/MIN_UPLOAD_INTERVAL](https://baileys.wiki/docs/api/variables/MIN_UPLOAD_INTERVAL)

> `const` **MIN\_UPLOAD\_INTERVAL**: `5000` = `5000`

Defined in: [src/Defaults/index.ts:135](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L135)

---

<a name="variable-missing-_keys-_error-_text"></a>

> Source: [https://baileys.wiki/docs/api/variables/MISSING_KEYS_ERROR_TEXT](https://baileys.wiki/docs/api/variables/MISSING_KEYS_ERROR_TEXT)

> `const` **MISSING\_KEYS\_ERROR\_TEXT**: `"Key used already or never filled"` = `'Key used already or never filled'`

Defined in: [src/Utils/decode-wa-message.ts:53](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/decode-wa-message.ts#L53)

---

<a name="variable-nack-_reasons"></a>

> Source: [https://baileys.wiki/docs/api/variables/NACK_REASONS](https://baileys.wiki/docs/api/variables/NACK_REASONS)

> `const` **NACK\_REASONS**: `object`

Defined in: [src/Utils/decode-wa-message.ts:62](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/decode-wa-message.ts#L62)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### DBOperationFailed[​](#dboperationfailed "Direct link to DBOperationFailed")

> **DBOperationFailed**: `number` = `552`

### InvalidHostedCompanionStanza[​](#invalidhostedcompanionstanza "Direct link to InvalidHostedCompanionStanza")

> **InvalidHostedCompanionStanza**: `number` = `493`

### InvalidProtobuf[​](#invalidprotobuf "Direct link to InvalidProtobuf")

> **InvalidProtobuf**: `number` = `491`

### MessageDeletedOnPeer[​](#messagedeletedonpeer "Direct link to MessageDeletedOnPeer")

> **MessageDeletedOnPeer**: `number` = `499`

### MissingMessageSecret[​](#missingmessagesecret "Direct link to MissingMessageSecret")

> **MissingMessageSecret**: `number` = `495`

### ParsingError[​](#parsingerror "Direct link to ParsingError")

> **ParsingError**: `number` = `487`

### SignalErrorOldCounter[​](#signalerroroldcounter "Direct link to SignalErrorOldCounter")

> **SignalErrorOldCounter**: `number` = `496`

### UnhandledError[​](#unhandlederror "Direct link to UnhandledError")

> **UnhandledError**: `number` = `500`

### UnrecognizedStanza[​](#unrecognizedstanza "Direct link to UnrecognizedStanza")

> **UnrecognizedStanza**: `number` = `488`

### UnrecognizedStanzaClass[​](#unrecognizedstanzaclass "Direct link to UnrecognizedStanzaClass")

> **UnrecognizedStanzaClass**: `number` = `489`

### UnrecognizedStanzaType[​](#unrecognizedstanzatype "Direct link to UnrecognizedStanzaType")

> **UnrecognizedStanzaType**: `number` = `490`

### UnsupportedAdminRevoke[​](#unsupportedadminrevoke "Direct link to UnsupportedAdminRevoke")

> **UnsupportedAdminRevoke**: `number` = `550`

### UnsupportedLIDGroup[​](#unsupportedlidgroup "Direct link to UnsupportedLIDGroup")

> **UnsupportedLIDGroup**: `number` = `551`

---

<a name="variable-noise-_mode"></a>

> Source: [https://baileys.wiki/docs/api/variables/NOISE_MODE](https://baileys.wiki/docs/api/variables/NOISE_MODE)

> `const` **NOISE\_MODE**: "Noise\_XX\_25519\_AESGCM\_SHA256\\u0000\\u0000\\u0000\\u0000" = `'Noise_XX_25519_AESGCM_SHA256\0\0\0\0'`

Defined in: [src/Defaults/index.ts:31](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L31)

---

<a name="variable-noise-_wa-_header"></a>

> Source: [https://baileys.wiki/docs/api/variables/NOISE_WA_HEADER](https://baileys.wiki/docs/api/variables/NOISE_WA_HEADER)

> `const` **NOISE\_WA\_HEADER**: `Buffer`<`ArrayBuffer`\>

Defined in: [src/Defaults/index.ts:34](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L34)

---

<a name="variable-no-_message-_found-_error-_text"></a>

> Source: [https://baileys.wiki/docs/api/variables/NO_MESSAGE_FOUND_ERROR_TEXT](https://baileys.wiki/docs/api/variables/NO_MESSAGE_FOUND_ERROR_TEXT)

> `const` **NO\_MESSAGE\_FOUND\_ERROR\_TEXT**: `"Message absent from node"` = `'Message absent from node'`

Defined in: [src/Utils/decode-wa-message.ts:52](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Utils/decode-wa-message.ts#L52)

---

<a name="variable-official-_biz-_jid"></a>

> Source: [https://baileys.wiki/docs/api/variables/OFFICIAL_BIZ_JID](https://baileys.wiki/docs/api/variables/OFFICIAL_BIZ_JID)

> `const` **OFFICIAL\_BIZ\_JID**: `"16505361212@c.us"` = `'16505361212@c.us'`

Defined in: [src/WABinary/jid-utils.ts:2](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L2)

---

<a name="variable-phone-_connection-_cb"></a>

> Source: [https://baileys.wiki/docs/api/variables/PHONE_CONNECTION_CB](https://baileys.wiki/docs/api/variables/PHONE_CONNECTION_CB)

> `const` **PHONE\_CONNECTION\_CB**: `"CB:Pong"` = `'CB:Pong'`

Defined in: [src/Defaults/index.ts:16](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L16)

---

<a name="variable-placeholder-_max-_age-_seconds"></a>

> Source: [https://baileys.wiki/docs/api/variables/PLACEHOLDER_MAX_AGE_SECONDS](https://baileys.wiki/docs/api/variables/PLACEHOLDER_MAX_AGE_SECONDS)

> `const` **PLACEHOLDER\_MAX\_AGE\_SECONDS**: `number`

Defined in: [src/Defaults/index.ts:29](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L29)

WA Web enforces a 14-day maximum age for placeholder resend requests

---

<a name="variable-processable-_history-_types"></a>

> Source: [https://baileys.wiki/docs/api/variables/PROCESSABLE_HISTORY_TYPES](https://baileys.wiki/docs/api/variables/PROCESSABLE_HISTORY_TYPES)

> `const` **PROCESSABLE\_HISTORY\_TYPES**: [`HistorySyncType`](/docs/api/namespaces/proto/namespaces/HistorySync/enumerations/HistorySyncType)\[\]

Defined in: [src/Defaults/index.ts:44](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L44)

---

<a name="variable-psa-_wid"></a>

> Source: [https://baileys.wiki/docs/api/variables/PSA_WID](https://baileys.wiki/docs/api/variables/PSA_WID)

> `const` **PSA\_WID**: `"0@c.us"` = `'0@c.us'`

Defined in: [src/WABinary/jid-utils.ts:4](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L4)

---

<a name="variable-server-_jid"></a>

> Source: [https://baileys.wiki/docs/api/variables/SERVER_JID](https://baileys.wiki/docs/api/variables/SERVER_JID)

> `const` **SERVER\_JID**: `"server@c.us"` = `'server@c.us'`

Defined in: [src/WABinary/jid-utils.ts:3](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L3)

---

<a name="variable-status-_expiry-_seconds"></a>

> Source: [https://baileys.wiki/docs/api/variables/STATUS_EXPIRY_SECONDS](https://baileys.wiki/docs/api/variables/STATUS_EXPIRY_SECONDS)

> `const` **STATUS\_EXPIRY\_SECONDS**: `number`

Defined in: [src/Defaults/index.ts:26](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L26)

Status messages older than 24 hours are considered expired

---

<a name="variable-stories-_jid"></a>

> Source: [https://baileys.wiki/docs/api/variables/STORIES_JID](https://baileys.wiki/docs/api/variables/STORIES_JID)

> `const` **STORIES\_JID**: `"status@broadcast"` = `'status@broadcast'`

Defined in: [src/WABinary/jid-utils.ts:5](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L5)

---

<a name="variable-s-_whatsapp-_net"></a>

> Source: [https://baileys.wiki/docs/api/variables/S_WHATSAPP_NET](https://baileys.wiki/docs/api/variables/S_WHATSAPP_NET)

> `const` **S\_WHATSAPP\_NET**: `"@s.whatsapp.net"` = `'@s.whatsapp.net'`

Defined in: [src/WABinary/jid-utils.ts:1](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WABinary/jid-utils.ts#L1)

---

<a name="variable-timems"></a>

> Source: [https://baileys.wiki/docs/api/variables/TimeMs](https://baileys.wiki/docs/api/variables/TimeMs)

> `const` **TimeMs**: `object`

Defined in: [src/Defaults/index.ts:144](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L144)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### Day[​](#day "Direct link to Day")

> **Day**: `number`

### Hour[​](#hour "Direct link to Hour")

> **Hour**: `number`

### Minute[​](#minute "Direct link to Minute")

> **Minute**: `number`

### Week[​](#week "Direct link to Week")

> **Week**: `number`

---

<a name="variable-unauthorized-_codes"></a>

> Source: [https://baileys.wiki/docs/api/variables/UNAUTHORIZED_CODES](https://baileys.wiki/docs/api/variables/UNAUTHORIZED_CODES)

> `const` **UNAUTHORIZED\_CODES**: `number`\[\]

Defined in: [src/Defaults/index.ts:9](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L9)

---

<a name="variable-upload-_timeout"></a>

> Source: [https://baileys.wiki/docs/api/variables/UPLOAD_TIMEOUT](https://baileys.wiki/docs/api/variables/UPLOAD_TIMEOUT)

> `const` **UPLOAD\_TIMEOUT**: `30000` = `30000`

Defined in: [src/Defaults/index.ts:134](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L134)

---

<a name="variable-url-_regex"></a>

> Source: [https://baileys.wiki/docs/api/variables/URL_REGEX](https://baileys.wiki/docs/api/variables/URL_REGEX)

> `const` **URL\_REGEX**: `RegExp`

Defined in: [src/Defaults/index.ts:36](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L36)

from: [https://stackoverflow.com/questions/3809401/what-is-a-good-regular-expression-to-match-a-url](https://stackoverflow.com/questions/3809401/what-is-a-good-regular-expression-to-match-a-url)

---

<a name="variable-wamessagestatus"></a>

> Source: [https://baileys.wiki/docs/api/variables/WAMessageStatus](https://baileys.wiki/docs/api/variables/WAMessageStatus)

> `const` **WAMessageStatus**: _typeof_ [`Status`](/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/Status) = `proto.WebMessageInfo.Status`

Defined in: [src/Types/Message.ts:37](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L37)

---

<a name="variable-wamessagestubtype"></a>

> Source: [https://baileys.wiki/docs/api/variables/WAMessageStubType](https://baileys.wiki/docs/api/variables/WAMessageStubType)

> `const` **WAMessageStubType**: _typeof_ [`StubType`](/docs/api/namespaces/proto/namespaces/WebMessageInfo/enumerations/StubType) = `proto.WebMessageInfo.StubType`

Defined in: [src/Types/Message.ts:36](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Types/Message.ts#L36)

---

<a name="variable-wa-_adv-_account-_sig-_prefix"></a>

> Source: [https://baileys.wiki/docs/api/variables/WA_ADV_ACCOUNT_SIG_PREFIX](https://baileys.wiki/docs/api/variables/WA_ADV_ACCOUNT_SIG_PREFIX)

> `const` **WA\_ADV\_ACCOUNT\_SIG\_PREFIX**: `Buffer`<`ArrayBuffer`\>

Defined in: [src/Defaults/index.ts:18](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L18)

---

<a name="variable-wa-_adv-_device-_sig-_prefix"></a>

> Source: [https://baileys.wiki/docs/api/variables/WA_ADV_DEVICE_SIG_PREFIX](https://baileys.wiki/docs/api/variables/WA_ADV_DEVICE_SIG_PREFIX)

> `const` **WA\_ADV\_DEVICE\_SIG\_PREFIX**: `Buffer`<`ArrayBuffer`\>

Defined in: [src/Defaults/index.ts:19](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L19)

---

<a name="variable-wa-_adv-_hosted-_account-_sig-_prefix"></a>

> Source: [https://baileys.wiki/docs/api/variables/WA_ADV_HOSTED_ACCOUNT_SIG_PREFIX](https://baileys.wiki/docs/api/variables/WA_ADV_HOSTED_ACCOUNT_SIG_PREFIX)

> `const` **WA\_ADV\_HOSTED\_ACCOUNT\_SIG\_PREFIX**: `Buffer`<`ArrayBuffer`\>

Defined in: [src/Defaults/index.ts:20](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L20)

---

<a name="variable-wa-_adv-_hosted-_device-_sig-_prefix"></a>

> Source: [https://baileys.wiki/docs/api/variables/WA_ADV_HOSTED_DEVICE_SIG_PREFIX](https://baileys.wiki/docs/api/variables/WA_ADV_HOSTED_DEVICE_SIG_PREFIX)

> `const` **WA\_ADV\_HOSTED\_DEVICE\_SIG\_PREFIX**: `Buffer`<`ArrayBuffer`\>

Defined in: [src/Defaults/index.ts:21](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L21)

---

<a name="variable-wa-_cert-_details"></a>

> Source: [https://baileys.wiki/docs/api/variables/WA_CERT_DETAILS](https://baileys.wiki/docs/api/variables/WA_CERT_DETAILS)

> `const` **WA\_CERT\_DETAILS**: `object`

Defined in: [src/Defaults/index.ts:38](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L38)

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### ISSUER[​](#issuer "Direct link to ISSUER")

> **ISSUER**: `string` = `'WhatsAppLongTerm1'`

### PUBLIC\_KEY[​](#public_key "Direct link to PUBLIC_KEY")

> **PUBLIC\_KEY**: `Buffer`<`ArrayBuffer`\>

### SERIAL[​](#serial "Direct link to SERIAL")

> **SERIAL**: `number` = `0`

---

<a name="variable-wa-_default-_ephemeral"></a>

> Source: [https://baileys.wiki/docs/api/variables/WA_DEFAULT_EPHEMERAL](https://baileys.wiki/docs/api/variables/WA_DEFAULT_EPHEMERAL)

> `const` **WA\_DEFAULT\_EPHEMERAL**: `number`

Defined in: [src/Defaults/index.ts:23](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/Defaults/index.ts#L23)

---

<a name="variable-web-_events"></a>

> Source: [https://baileys.wiki/docs/api/variables/WEB_EVENTS](https://baileys.wiki/docs/api/variables/WEB_EVENTS)

> `const` **WEB\_EVENTS**: [`Event`](/docs/api/type-aliases/Event)\[\]

Defined in: [src/WAM/constants.ts:1](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAM/constants.ts#L1)

---

<a name="variable-web-_globals"></a>

> Source: [https://baileys.wiki/docs/api/variables/WEB_GLOBALS](https://baileys.wiki/docs/api/variables/WEB_GLOBALS)

> `const` **WEB\_GLOBALS**: [`Global`](/docs/api/type-aliases/Global)\[\]

Defined in: [src/WAM/constants.ts:22404](https://github.com/WhiskeySockets/Baileys/blob/8e5093c198de5c5c0230a76e8a7224f6006ebb2e/src/WAM/constants.ts#L22404)

---

<a name="socket"></a>

> Source: [https://baileys.wiki/docs/category/socket](https://baileys.wiki/docs/category/socket)

[

## 📄️ Configuration

The first step into getting anywhere with Baileys is configuring the socket.

](/docs/socket/configuration)

[

## 📄️ Connecting

After configuring the socket, comes connecting to WhatsApp servers.

](/docs/socket/connecting)

[

## 📄️ History Sync

After connecting successfully, the socket will try to download and process old chats, contacts and messages.

](/docs/socket/history-sync)

[

## 📄️ Receiving Updates

After getting the initial "history" messages, let's get real-time messages and updates.

](/docs/socket/receiving-updates)

[

## 📄️ Handling Messages

Messages, from a history sync or from a messages.upsert event, come in the form of proto.IWebMessageInfo. This is the protobuf that WhatsApp Web stores its messages in.

](/docs/socket/handling-messages)

[

## 📄️ Sending Messages

One of the core features of any messaging experience is sending messages.

](/docs/socket/sending-messages)

[

## 📄️ Group Management

WhatsApp group support is pivotal for many users of this library. To this end, Baileys has very extensive group support.

](/docs/socket/group-management)

[

## 📄️ Privacy

Baileys has some missing privacy settings as of the writing of this page. The currently exposed methods are:

](/docs/socket/privacy)

[

## 📄️ App State Updates

WA uses an encrypted form of communication to send chat/app updates. This has been implemented mostly and you can send the following updates:

](/docs/socket/appstate-updates)

[

## 📄️ Business Features

Business only features are mostly implemented in Baileys, with the only thing missing being the modification of business profile data.

](/docs/socket/business-features)

[

## 📄️ Handling Broadcast Lists/Status

If you are

](/docs/socket/broadcast-lists)

---
