2024-08-27 19:54:31 +00:00
<!DOCTYPE html> < html class = "default" lang = "en" > < head > < meta charSet = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > DecodedMessage | Documentation< / title > < meta name = "description" content = "Documentation for Documentation" / > < meta name = "viewport" content = "width=device-width, initial-scale=1" / > < link rel = "stylesheet" href = "../assets/style.css" / > < link rel = "stylesheet" href = "../assets/highlight.css" / > < script defer src = "../assets/main.js" > < / script > < script async src = "../assets/icons.js" id = "tsd-icons-script" > < / script > < script async src = "../assets/search.js" id = "tsd-search-script" > < / script > < script async src = "../assets/navigation.js" id = "tsd-nav-script" > < / script > < / head > < body > < script > document . documentElement . dataset . theme = localStorage . getItem ( "tsd-theme" ) || "os" ; document . body . style . display = "none" ; setTimeout ( ( ) => app ? app . showPage ( ) : document . body . style . removeProperty ( "display" ) , 500 ) < / script > < header class = "tsd-page-toolbar" > < div class = "tsd-toolbar-contents container" > < div class = "table-cell" id = "tsd-search" data-base = ".." > < div class = "field" > < label for = "tsd-search-field" class = "tsd-widget tsd-toolbar-icon search no-caption" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" > < use href = "../assets/icons.svg#icon-search" > < / use > < / svg > < / label > < input type = "text" id = "tsd-search-field" aria-label = "Search" / > < / div > < div class = "field" > < div id = "tsd-toolbar-links" > < / div > < / div > < ul class = "results" > < li class = "state loading" > Preparing search index...< / li > < li class = "state failure" > The search index is not available< / li > < / ul > < a href = "../index.html" class = "title" > Documentation< / a > < / div > < div class = "table-cell" id = "tsd-widgets" > < a href = "#" class = "tsd-widget tsd-toolbar-icon menu no-caption" data-toggle = "menu" aria-label = "Menu" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" > < use href = "../assets/icons.svg#icon-menu" > < / use > < / svg > < / a > < / div > < / div > < / header > < div class = "container container-main" > < div class = "col-content" > < div class = "tsd-page-title" > < ul class = "tsd-breadcrumb" > < li > < a href = "../index.html" > Documentation< / a > < / li > < li > < a href = "../modules/_waku_message_encryption.html" > @waku/message-encryption< / a > < / li > < li > < a href = "_waku_message_encryption.DecodedMessage.html" > DecodedMessage< / a > < / li > < / ul > < h1 > Class DecodedMessage< / h1 > < / div > < section class = "tsd-panel tsd-hierarchy" > < h4 > Hierarchy (< a class = "link" href = "../hierarchy.html#@waku/message-encryption.DecodedMessage" > view full< / a > )< / h4 > < ul class = "tsd-hierarchy" > < li > < a href = "_waku_core.DecodedMessage.html" class = "tsd-signature-type tsd-kind-class" > DecodedMessage< / a > < ul class = "tsd-hierarchy" > < li > < span class = "target" > DecodedMessage< / span > < / li > < / ul > < / li > < / ul > < / section > < section class = "tsd-panel" > < h4 > Implements< / h4 > < ul class = "tsd-hierarchy" > < li > < a href = "../interfaces/_waku_interfaces.IDecodedMessage.html" class = "tsd-signature-type tsd-kind-interface" > IDecodedMessage< / a > < / li > < / ul > < / section > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/waku-org/js-waku/blob/71384dfdfddd0ddea89488f841b555c6c3133e8d/packages/message-encryption/src/decoded_message.ts#L8" > packages/message-encryption/src/decoded_message.ts:8< / a > < / li > < / ul > < / aside > < section class = "tsd-panel-group tsd-index-group" > < section class = "tsd-panel tsd-index-panel" > < details class = "tsd-index-content tsd-index-accordion" open > < summary class = "tsd-accordion-summary tsd-index-summary" > < h5 class = "tsd-index-heading uppercase" role = "button" aria-expanded = "false" tabIndex = "0" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" > < use href = "../assets/icons.svg#icon-chevronSmall" > < / use > < / svg > Index< / h5 > < / summary > < div class = "tsd-accordion-details" > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Constructors< / h3 > < div class = "tsd-index-list" > < a href = "_waku_message_encryption.DecodedMessage.html#constructor" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-512" > < / use > < / svg > < span > constructor< / span > < / a >
2024-04-07 07:56:46 +00:00
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Properties< / h3 > < div class = "tsd-index-list" > < a href = "_waku_message_encryption.DecodedMessage.html#_decodedPayload" class = "tsd-index-link tsd-is-private" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > _decoded< wbr / > Payload< / span > < / a >
< a href = "_waku_message_encryption.DecodedMessage.html#proto" class = "tsd-index-link tsd-is-protected tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > proto< / span > < / a >
< a href = "_waku_message_encryption.DecodedMessage.html#pubsubTopic" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > pubsub< wbr / > Topic< / span > < / a >
< a href = "_waku_message_encryption.DecodedMessage.html#signature" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > signature?< / span > < / a >
< a href = "_waku_message_encryption.DecodedMessage.html#signaturePublicKey" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > signature< wbr / > Public< wbr / > Key?< / span > < / a >
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Accessors< / h3 > < div class = "tsd-index-list" > < a href = "_waku_message_encryption.DecodedMessage.html#_rawTimestamp" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > _raw< wbr / > Timestamp< / span > < / a >
< a href = "_waku_message_encryption.DecodedMessage.html#contentTopic" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > content< wbr / > Topic< / span > < / a >
< a href = "_waku_message_encryption.DecodedMessage.html#ephemeral" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > ephemeral< / span > < / a >
< a href = "_waku_message_encryption.DecodedMessage.html#meta" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > meta< / span > < / a >
< a href = "_waku_message_encryption.DecodedMessage.html#payload" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > payload< / span > < / a >
< a href = "_waku_message_encryption.DecodedMessage.html#rateLimitProof" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > rate< wbr / > Limit< wbr / > Proof< / span > < / a >
< a href = "_waku_message_encryption.DecodedMessage.html#timestamp" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > timestamp< / span > < / a >
< a href = "_waku_message_encryption.DecodedMessage.html#version" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > version< / span > < / a >
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Methods< / h3 > < div class = "tsd-index-list" > < a href = "_waku_message_encryption.DecodedMessage.html#verifySignature" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > verify< wbr / > Signature< / span > < / a >
2024-08-27 19:54:31 +00:00
< / div > < / section > < / div > < / details > < / section > < / section > < section class = "tsd-panel-group tsd-member-group" > < h2 > Constructors< / h2 > < section class = "tsd-panel tsd-member" > < a id = "constructor" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > constructor< / span > < a href = "#constructor" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "constructor.new_DecodedMessage" class = "tsd-anchor" > < / a > < span class = "tsd-kind-constructor-signature" > new < wbr / > Decoded< wbr / > Message< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > pubsubTopic< / span > , < span class = "tsd-kind-parameter" > proto< / span > , < span class = "tsd-kind-parameter" > decodedPayload< / span > , < span class = "tsd-kind-parameter" > signature< / span > < span class = "tsd-signature-symbol" > ?< / span > , < span class = "tsd-kind-parameter" > signaturePublicKey< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "_waku_message_encryption.DecodedMessage.html" class = "tsd-signature-type tsd-kind-class" > DecodedMessage< / a > < a href = "#constructor.new_DecodedMessage" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > pubsubTopic< / span > : < span class = "tsd-signature-type" > string< / span > < / span > < / li > < li > < span > < span class = "tsd-kind-parameter" > proto< / span > : < a href = "../modules/_waku_core.message.html" class = "tsd-signature-type tsd-kind-namespace" > message< / a > < span class = "tsd-signature-symbol" > .< / span > < a href = "../modules/_waku_core.message.version_0.html" class = "tsd-signature-type tsd-kind-namespace" > version_0< / a > < span class = "tsd-signature-symbol" > .< / span > < a href = "../modules/_waku_core.message.version_0.proto.html" class = "tsd-signature-type tsd-kind-namespace" > proto< / a > < span class = "tsd-signature-symbol" > .< / span > < a href = "../interfaces/_waku_core.message.version_0.proto.WakuMessage-1.html" class = "tsd-signature-type tsd-kind-interface" > WakuMessage< / a > < / span > < / li > < li > < span > < span class = "tsd-kind-parameter" > decodedPayload< / span > : < span class = "tsd-signature-type" > Uint8Array< / span > < / span > < / li > < li > < span > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span class = "tsd-kind-parameter" > signature< / span > : < span class = "tsd-signature-type" > Uint8Array< / span > < / span > < / li > < li > < span > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span class = "tsd-kind-parameter" > signaturePublicKey< / span > : < span class = "tsd-signature-type" > Uint8Array< / span > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < a href = "_waku_message_encryption.DecodedMessage.html" class = "tsd-signature-type tsd-kind-class" > DecodedMessage< / a > < / h4 > < aside class = "tsd-sources" > < p > Overrides < a href = "_waku_core.DecodedMessage.html" > DecodedMessage< / a > .< a href = "_waku_core.DecodedMessage.html#constructor" > constructor< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/waku-org/js-waku/blob/71384dfdfddd0ddea89488f841b555c6c3133e8d/packages/message-encryption/src/decoded_message.ts#L14" > packages/message-encryption/src/decoded_message.ts:14< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < / section > < section class = "tsd-panel-group tsd-member-group" > < h2 > Properties< / h2 > < section class = "tsd-panel tsd-member tsd-is-private" > < a id = "_decodedPayload" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag ts-flagPrivate" > Private< / code > < code class = "tsd-tag ts-flagReadonly" > Readonly< / code > < span > _decoded< wbr / > Payload< / span > < a href = "#_decodedPayload" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > _decoded< wbr / > Payload< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type
2024-02-26 21:11:31 +00:00
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > publicKey< / span > : < span class = "tsd-signature-type" > Uint8Array< / span > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > boolean< / span > < / h4 > < p > true if the signature matches the public key, false if not or if no signature is present.< / p >
2024-08-27 19:54:31 +00:00
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/waku-org/js-waku/blob/71384dfdfddd0ddea89488f841b555c6c3133e8d/packages/message-encryption/src/decoded_message.ts#L34" > packages/message-encryption/src/decoded_message.ts:34< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < / section > < / div > < div class = "col-sidebar" > < div class = "page-menu" > < div class = "tsd-navigation settings" > < details class = "tsd-index-accordion" > < summary class = "tsd-accordion-summary" > < h3 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Settings< / h3 > < / summary > < div class = "tsd-accordion-details" > < div class = "tsd-filter-visibility" > < h4 class = "uppercase" > Member Visibility< / h4 > < form > < ul id = "tsd-filter-options" > < li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-protected" name = "protected" / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < rect class = "tsd-checkbox-background" width = "30" height = "30" x = "1" y = "1" rx = "6" fill = "none" > < / rect > < path class = "tsd-checkbox-checkmark" d = "M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke = "none" stroke-width = "3.5" stroke-linejoin = "round" fill = "none" > < / path > < / svg > < span > Protected< / span > < / label > < / li > < li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-private" name = "private" / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < rect class = "tsd-checkbox-background" width = "30" height = "30" x = "1" y = "1" rx = "6" fill = "none" > < / rect > < path class = "tsd-checkbox-checkmark" d = "M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke = "none" stroke-width = "3.5" stroke-linejoin = "round" fill = "none" > < / path > < / svg > < span > Private< / span > < / label > < / li > < li class = "tsd-filter-item" > < label class = "tsd-filter-input" > < input type = "checkbox" id = "tsd-filter-inherited" name = "inherited" checked / > < svg width = "32" height = "32" viewBox = "0 0 32 32" aria-hidden = "true" > < rect class = "tsd-checkbox-background" width = "30" height = "30" x = "1" y = "1" rx = "6" fill = "none" > < / rect > < path class = "tsd-checkbox-checkmark" d = "M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke = "none" stroke-width = "3.5" stroke-linejoin = "round" fill = "none" > < / path > < / svg > < span > Inherited< / span > < / label > < / li > < / ul > < / form > < / div > < div class = "tsd-theme-toggle" > < h4 class = "uppercase" > Theme< / h4 > < select id = "tsd-theme" > < option value = "os" > OS< / option > < option value = "light" > Light< / option > < option value = "dark" > Dark< / option > < / select > < / div > < / div > < / details > < / div > < details open class = "tsd-index-accordion tsd-page-navigation" > < summary class = "tsd-accordion-summary" > < h3 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > On This Page< / h3 > < / summary > < div class = "tsd-accordion-details" > < a href = "#constructor" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-512" > < / use > < / svg > < span > constructor< / span > < / a > < a href = "#_decodedPayload" class = "tsd-is-private" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > _decoded< wbr / > Payload< / span > < / a > < a href = "#proto" class = "tsd-is-protected tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > proto< / span > < / a > < a href = "#pubsubTopic" class = "tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > pubsub< wbr / > Topic< / span > < / a > < a href = "#signature" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > signature< / span > < / a > < a href = "#signaturePublicKey" class = "" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > signature< wbr / > Public< wbr / > Key< / span > < / a > < a href = "#_rawTimestamp" class = "tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > _raw< wbr / > Timestamp< / span > < / a > < a href = "#contentTopic"
