Class MessageBasedClient`Abstract`

Internalapi

Hierarchy

CommunicationClient
- MessageBasedClient

Constructors

constructor

new MessageBasedClient(name, keyPair): MessageBasedClient
Parameters
- name: string
- keyPair: KeyPair
Returns MessageBasedClient
Overrides CommunicationClient.constructor
- Defined in beacon-core/dist/esm/transports/clients/MessageBasedClient.d.ts:15

Properties

`Protected` `Abstract` `Readonly` activeListeners

activeListeners: Map<string, unknown>

The listeners that will be notified of new messages

eventHandlers

eventHandlers: Map<ClientEvents, Function>

`Protected` isMobileOS

isMobileOS: (() => boolean)

Type declaration

- (): boolean
- Returns boolean

`Protected` `Optional` `Readonly` keyPair

keyPair?: KeyPair

`Protected` `Readonly` name

name: string

Methods

`Protected` createCryptoBoxClient

createCryptoBoxClient(otherPublicKey, selfKeypair): Promise<SessionKeys>
Create a cryptobox client
Parameters
- otherPublicKey: string
- selfKeypair: KeyPair
Returns Promise<SessionKeys>
Inherited from CommunicationClient.createCryptoBoxClient
- Defined in beacon-core/dist/esm/transports/clients/CommunicationClient.d.ts:36

`Protected` createCryptoBoxServer

createCryptoBoxServer(otherPublicKey, selfKeypair): Promise<SessionKeys>
Create a cryptobox server
Parameters
- otherPublicKey: string
- selfKeypair: KeyPair
Returns Promise<SessionKeys>
Inherited from CommunicationClient.createCryptoBoxServer
- Defined in beacon-core/dist/esm/transports/clients/CommunicationClient.d.ts:29

`Protected` decryptMessage

decryptMessage(senderPublicKey, payload): Promise<string>
Decrypt a message from a specific peer
Parameters
- senderPublicKey: string
- payload: string
Returns Promise<string>
- Defined in beacon-core/dist/esm/transports/clients/MessageBasedClient.d.ts:44

`Protected` encryptMessage

encryptMessage(recipientPublicKey, message): Promise<string>
Encrypt a message for a specific publicKey (receiver)
Parameters
- recipientPublicKey: string
- message: string
Returns Promise<string>
- Defined in beacon-core/dist/esm/transports/clients/MessageBasedClient.d.ts:51

`Protected` encryptMessageAsymmetric

encryptMessageAsymmetric(recipientPublicKey, message): Promise<string>
Encrypt a message for a specific publicKey (receiver, asymmetric)
Parameters
- recipientPublicKey: string
- message: string
Returns Promise<string>
Inherited from CommunicationClient.encryptMessageAsymmetric
- Defined in beacon-core/dist/esm/transports/clients/CommunicationClient.d.ts:43

getPairingRequestInfo

getPairingRequestInfo(): Promise<PostMessagePairingRequest>
Get the pairing request information. This will be shared with the peer during the connection setup

Returns Promise<PostMessagePairingRequest>
- Defined in beacon-core/dist/esm/transports/clients/MessageBasedClient.d.ts:23

getPairingResponseInfo

getPairingResponseInfo(request): Promise<PostMessagePairingResponse>
Get the pairing response information. This will be shared with the peer during the connection setup
Parameters
- request: PostMessagePairingRequest
Returns Promise<PostMessagePairingResponse>
- Defined in beacon-core/dist/esm/transports/clients/MessageBasedClient.d.ts:27

getPublicKey

getPublicKey(): Promise<string>
Get the public key

Returns Promise<string>
Inherited from CommunicationClient.getPublicKey
- Defined in beacon-core/dist/esm/transports/clients/CommunicationClient.d.ts:18

getPublicKeyHash

getPublicKeyHash(): Promise<string>
get the public key hash

Returns Promise<string>
Inherited from CommunicationClient.getPublicKeyHash
- Defined in beacon-core/dist/esm/transports/clients/CommunicationClient.d.ts:22

`Abstract` init

init(): Promise<void>
Initialize the connection

Returns Promise<void>
- Defined in beacon-core/dist/esm/transports/clients/MessageBasedClient.d.ts:55

`Abstract` sendMessage

sendMessage(message, peer?): Promise<void>
Parameters
- message: string
- Optional peer: PeerInfoType
Returns Promise<void>
Inherited from CommunicationClient.sendMessage
- Defined in beacon-core/dist/esm/transports/clients/CommunicationClient.d.ts:46

start

start(): Promise<void>
start the client and make sure all dependencies are ready

Returns Promise<void>
- Defined in beacon-core/dist/esm/transports/clients/MessageBasedClient.d.ts:19

unsubscribeFromEncryptedMessage

unsubscribeFromEncryptedMessage(senderPublicKey): Promise<void>
Unsubscribe from encrypted messages from a specific peer
Parameters
- senderPublicKey: string
Returns Promise<void>
Overrides CommunicationClient.unsubscribeFromEncryptedMessage
- Defined in beacon-core/dist/esm/transports/clients/MessageBasedClient.d.ts:33

unsubscribeFromEncryptedMessages

unsubscribeFromEncryptedMessages(): Promise<void>
Unsubscribe from all encrypted messages

Returns Promise<void>
Overrides CommunicationClient.unsubscribeFromEncryptedMessages
- Defined in beacon-core/dist/esm/transports/clients/MessageBasedClient.d.ts:37

Generated using TypeDoc