xmpp_p2p
Preparing search index...
core/xmpp-secure
XmppSecureContext
Interface XmppSecureContext
Dependencies required by the secure messaging helpers.
interface
XmppSecureContext
{
jid
:
string
;
ready
:
Promise
<
void
>
;
cachePeerOpenPgpKey
(
peerId
:
string
,
armoredKey
:
string
)
:
void
;
emitError
(
error
:
unknown
)
:
void
;
emitMessage
(
message
:
XmppMessage
)
:
void
;
ensureTopicValidator
(
topic
:
string
,
kind
:
"secure"
)
:
void
;
getEncryptedTopicSecret
(
topic
:
string
)
:
string
|
undefined
;
getOmemoDeviceIdOrThrow
()
:
number
;
getOmemoStore
()
:
XmppOmemoStore
;
getOpenPgpPrivateKeyOrThrow
()
:
PrivateKey
;
getOrCreateStream
(
peerAddr
:
string
|
Multiaddr
)
:
Promise
<
XmppStream
>
;
getPeerOmemoBundle
(
peerAddr
:
string
|
Multiaddr
,
deviceId
:
number
,
)
:
Promise
<
XmppOmemoBundle
>
;
getPeerOmemoDevices
(
peerAddr
:
string
|
Multiaddr
)
:
Promise
<
number
[]
>
;
getPeerOpenPgpArmoredKey
(
peerId
:
string
)
:
string
|
undefined
;
getPubSubService
()
:
{
publish
(
topic
:
string
,
data
:
Uint8Array
)
:
Promise
<
void
>
;
subscribe
(
topic
:
string
)
:
Promise
<
void
>
;
}
;
sendIqRequest
(
target
:
string
|
Multiaddr
,
stanza
:
Element
,
timeoutMs
?:
number
,
)
:
Promise
<
Element
>
;
sendOrBufferStanza
(
peerId
:
string
,
stanza
:
Element
,
peerAddr
?:
string
|
Multiaddr
,
)
:
Promise
<
void
>
;
}
Index
Properties
jid
ready
Methods
cache
Peer
Open
Pgp
Key
emit
Error
emit
Message
ensure
Topic
Validator
get
Encrypted
Topic
Secret
get
Omemo
Device
Id
Or
Throw
get
Omemo
Store
get
Open
Pgp
Private
Key
Or
Throw
get
Or
Create
Stream
get
Peer
Omemo
Bundle
get
Peer
Omemo
Devices
get
Peer
Open
Pgp
Armored
Key
get
Pub
Sub
Service
send
Iq
Request
send
Or
Buffer
Stanza
Properties
jid
jid
:
string
ready
ready
:
Promise
<
void
>
Methods
cache
Peer
Open
Pgp
Key
cachePeerOpenPgpKey
(
peerId
:
string
,
armoredKey
:
string
)
:
void
Parameters
peerId
:
string
armoredKey
:
string
Returns
void
emit
Error
emitError
(
error
:
unknown
)
:
void
Parameters
error
:
unknown
Returns
void
emit
Message
emitMessage
(
message
:
XmppMessage
)
:
void
Parameters
message
:
XmppMessage
Returns
void
ensure
Topic
Validator
ensureTopicValidator
(
topic
:
string
,
kind
:
"secure"
)
:
void
Parameters
topic
:
string
kind
:
"secure"
Returns
void
get
Encrypted
Topic
Secret
getEncryptedTopicSecret
(
topic
:
string
)
:
string
|
undefined
Parameters
topic
:
string
Returns
string
|
undefined
get
Omemo
Device
Id
Or
Throw
getOmemoDeviceIdOrThrow
()
:
number
Returns
number
get
Omemo
Store
getOmemoStore
()
:
XmppOmemoStore
Returns
XmppOmemoStore
get
Open
Pgp
Private
Key
Or
Throw
getOpenPgpPrivateKeyOrThrow
()
:
PrivateKey
Returns
PrivateKey
get
Or
Create
Stream
getOrCreateStream
(
peerAddr
:
string
|
Multiaddr
)
:
Promise
<
XmppStream
>
Parameters
peerAddr
:
string
|
Multiaddr
Returns
Promise
<
XmppStream
>
get
Peer
Omemo
Bundle
getPeerOmemoBundle
(
peerAddr
:
string
|
Multiaddr
,
deviceId
:
number
,
)
:
Promise
<
XmppOmemoBundle
>
Parameters
peerAddr
:
string
|
Multiaddr
deviceId
:
number
Returns
Promise
<
XmppOmemoBundle
>
get
Peer
Omemo
Devices
getPeerOmemoDevices
(
peerAddr
:
string
|
Multiaddr
)
:
Promise
<
number
[]
>
Parameters
peerAddr
:
string
|
Multiaddr
Returns
Promise
<
number
[]
>
get
Peer
Open
Pgp
Armored
Key
getPeerOpenPgpArmoredKey
(
peerId
:
string
)
:
string
|
undefined
Parameters
peerId
:
string
Returns
string
|
undefined
get
Pub
Sub
Service
getPubSubService
()
:
{
publish
(
topic
:
string
,
data
:
Uint8Array
)
:
Promise
<
void
>
;
subscribe
(
topic
:
string
)
:
Promise
<
void
>
;
}
Returns
{
publish
(
topic
:
string
,
data
:
Uint8Array
)
:
Promise
<
void
>
;
subscribe
(
topic
:
string
)
:
Promise
<
void
>
;
}
send
Iq
Request
sendIqRequest
(
target
:
string
|
Multiaddr
,
stanza
:
Element
,
timeoutMs
?:
number
,
)
:
Promise
<
Element
>
Parameters
target
:
string
|
Multiaddr
stanza
:
Element
Optional
timeoutMs
:
number
Returns
Promise
<
Element
>
send
Or
Buffer
Stanza
sendOrBufferStanza
(
peerId
:
string
,
stanza
:
Element
,
peerAddr
?:
string
|
Multiaddr
,
)
:
Promise
<
void
>
Parameters
peerId
:
string
stanza
:
Element
Optional
peerAddr
:
string
|
Multiaddr
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
jid
ready
Methods
cache
Peer
Open
Pgp
Key
emit
Error
emit
Message
ensure
Topic
Validator
get
Encrypted
Topic
Secret
get
Omemo
Device
Id
Or
Throw
get
Omemo
Store
get
Open
Pgp
Private
Key
Or
Throw
get
Or
Create
Stream
get
Peer
Omemo
Bundle
get
Peer
Omemo
Devices
get
Peer
Open
Pgp
Armored
Key
get
Pub
Sub
Service
send
Iq
Request
send
Or
Buffer
Stanza
xmpp_p2p
Loading...
Dependencies required by the secure messaging helpers.