Class CommunicationClient`Abstract`

Internalapi

Hierarchy (View Summary)

CommunicationClient
- MessageBasedClient
- P2PCommunicationClient

Index

Constructors

Properties

eventHandlers isMobileOS keyPair?

Methods

createCryptoBoxClient createCryptoBoxServer encryptMessageAsymmetric getPublicKey getPublicKeyHash sendMessage unsubscribeFromEncryptedMessage unsubscribeFromEncryptedMessages

Constructors

constructor

new CommunicationClient(keyPair?: KeyPair): CommunicationClient
Parameters
- OptionalkeyPair: KeyPair
Returns CommunicationClient
- Defined in beacon-core/dist/esm/transports/clients/CommunicationClient.d.ts:12

Properties

eventHandlers

eventHandlers: Map<ClientEvents, Function>

`Protected`isMobileOS

isMobileOS: () => boolean

`Protected` `Optional`keyPair

keyPair?: KeyPair

Methods

`Protected`createCryptoBoxClient

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

`Protected`createCryptoBoxServer

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

`Protected`encryptMessageAsymmetric

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

getPublicKey

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

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

getPublicKeyHash

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

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

`Abstract`sendMessage

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

`Abstract`unsubscribeFromEncryptedMessage

unsubscribeFromEncryptedMessage(senderPublicKey: string): Promise<void>
Parameters
- senderPublicKey: string
Returns Promise<void>
- Defined in beacon-core/dist/esm/transports/clients/CommunicationClient.d.ts:45

`Abstract`unsubscribeFromEncryptedMessages

unsubscribeFromEncryptedMessages(): Promise<void>
Returns Promise<void>
- Defined in beacon-core/dist/esm/transports/clients/CommunicationClient.d.ts:44