Class PostMessageTransport<T, K>

Internalapi

Type Parameters

T extends PostMessagePairingRequest | ExtendedPostMessagePairingResponse
K extends TRANSPORT_POSTMESSAGE_PEERS_DAPP | TRANSPORT_POSTMESSAGE_PEERS_WALLET

Hierarchy

Transport<T, K, PostMessageClient>
- PostMessageTransport

Index

Constructors

constructor

new PostMessageTransport<T, K>(name, keyPair, storage, storageKey): PostMessageTransport<T, K>
Type Parameters
- T extends PostMessagePairingRequest | ExtendedPostMessagePairingResponse
- K extends TRANSPORT_POSTMESSAGE_PEERS_DAPP | TRANSPORT_POSTMESSAGE_PEERS_WALLET
Parameters
- name: string
- keyPair: KeyPair
- storage: Storage
- storageKey: K
Returns PostMessageTransport<T, K>
Overrides Transport.constructor
- Defined in beacon-transport-postmessage/src/PostMessageTransport.ts:48

Properties

`Protected` _isConnected

_isConnected: TransportStatus

The status of the transport

`Protected` client

client: PostMessageClient

The client handling the encryption/decryption of messages

`Protected` `Readonly` name

name: string

The name of the app

`Protected` `Optional` newPeerListener

newPeerListener?: ((peer) => void)

Type declaration

- (peer): void
- The listener that will be invoked when a new peer is connected
  Parameters
  - peer: T
  Returns void

`Protected` `Readonly` peerManager

peerManager: PeerManager<K>

`Readonly` type

type: TransportType = TransportType.POST_MESSAGE

The type of the transport

Accessors

connectionStatus

get connectionStatus(): TransportStatus
Return the status of the connection

Returns TransportStatus
Inherited from Transport.connectionStatus
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:40

Methods

addListener

addListener(listener): Promise<void>
Add a listener to be called when a new message is received
Parameters
- listener: ((message, connectionInfo) => void)
  
  The listener that will be registered
  - - (message, connectionInfo): void
    - Parameters
      
      message: unknown
      
      connectionInfo: ConnectionContext
      
      Returns void
Returns Promise<void>
Inherited from Transport.addListener
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:66

addPeer

addPeer(newPeer, _sendPairingResponse?): Promise<void>
Parameters
- newPeer: T
- Optional _sendPairingResponse: boolean
Returns Promise<void>
Inherited from Transport.addPeer
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:74

connect

connect(): Promise<void>
Connect the transport

Returns Promise<void>
Overrides Transport.connect
- Defined in beacon-transport-postmessage/src/PostMessageTransport.ts:132

disconnect

disconnect(): Promise<void>
Disconnect the transport

Returns Promise<void>
Inherited from Transport.disconnect
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:53

getPairingRequestInfo

getPairingRequestInfo(): Promise<PostMessagePairingRequest>
Returns Promise<PostMessagePairingRequest>
- Defined in beacon-transport-postmessage/src/PostMessageTransport.ts:158

getPeers

getPeers(): Promise<T[]>
Returns Promise<T[]>
Inherited from Transport.getPeers
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:73

listen

listen(publicKey): Promise<void>
Parameters
- publicKey: string
Returns Promise<void>
Overrides Transport.listen
- Defined in beacon-transport-postmessage/src/PostMessageTransport.ts:162

`Protected` notifyListeners

notifyListeners(message, connectionInfo): Promise<void>
Notify the listeners when a new message comes in
Parameters
- message: unknown
  
  Message
- connectionInfo: ConnectionContext
  
  Context info about the connection
Returns Promise<void>
Inherited from Transport.notifyListeners
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:83

removeAllPeers

removeAllPeers(): Promise<void>
Returns Promise<void>
Inherited from Transport.removeAllPeers
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:76

removeListener

removeListener(listener): Promise<void>
Remove a listener
Parameters
- listener: ((message, connectionInfo) => void)
  - - (message, connectionInfo): void
    - Parameters
      
      message: string
      
      connectionInfo: ConnectionContext
      
      Returns void
Returns Promise<void>
Inherited from Transport.removeListener
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:72

removePeer

removePeer(peerToBeRemoved): Promise<void>
Parameters
- peerToBeRemoved: T
Returns Promise<void>
Inherited from Transport.removePeer
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:75

send

send(message, peer?): Promise<void>
Send a message through the transport
Parameters
- message: string
  
  The message to send
- Optional peer: PeerInfo
Returns Promise<void>
Inherited from Transport.send
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:60

setEventHandler

setEventHandler(event, fun): void
Parameters
- event: ClientEvents
- fun: Function
Returns void
Inherited from Transport.setEventHandler
- Defined in beacon-core/dist/esm/transports/Transport.d.ts:32

startOpenChannelListener

startOpenChannelListener(): Promise<void>
Returns Promise<void>
- Defined in beacon-transport-postmessage/src/PostMessageTransport.ts:154

`Static` getAvailableExtensions

getAvailableExtensions(): Promise<Extension[]>
Returns Promise<Extension[]>
- Defined in beacon-transport-postmessage/src/PostMessageTransport.ts:74

`Static` isAvailable

isAvailable(): Promise<boolean>
Returns a promise that resolves to true if the transport is available, false if it is not

Returns Promise<boolean>
Overrides Transport.isAvailable
- Defined in beacon-transport-postmessage/src/PostMessageTransport.ts:52

`Private` `Static` listenForExtensions

listenForExtensions(): void
Returns void
- Defined in beacon-transport-postmessage/src/PostMessageTransport.ts:97

Class PostMessageTransport<T, K>

Internalapi

Type Parameters

T extends PostMessagePairingRequest | ExtendedPostMessagePairingResponse

K extends TRANSPORT_POSTMESSAGE_PEERS_DAPP | TRANSPORT_POSTMESSAGE_PEERS_WALLET

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends PostMessagePairingRequest | ExtendedPostMessagePairingResponse

K extends TRANSPORT_POSTMESSAGE_PEERS_DAPP | TRANSPORT_POSTMESSAGE_PEERS_WALLET

Parameters

name: string

keyPair: KeyPair

storage: Storage

storageKey: K

Returns PostMessageTransport<T, K>

Properties

Protected _isConnected

Protected client

Protected Readonly name

Protected Optional newPeerListener

Type declaration

Parameters

peer: T

Returns void

Protected Readonly peerManager

Readonly type

Accessors

connectionStatus

Returns TransportStatus

Methods

addListener

Parameters

listener: ((message, connectionInfo) => void)

Parameters

message: unknown

connectionInfo: ConnectionContext

Returns void

Returns Promise<void>

addPeer

Parameters

newPeer: T

Optional _sendPairingResponse: boolean

Returns Promise<void>

connect

Returns Promise<void>

disconnect

Returns Promise<void>

getPairingRequestInfo

Returns Promise<PostMessagePairingRequest>

getPeers

Returns Promise<T[]>

listen

Parameters

publicKey: string

Returns Promise<void>

Protected notifyListeners

Parameters

message: unknown

connectionInfo: ConnectionContext

Returns Promise<void>

removeAllPeers

Returns Promise<void>

removeListener

Parameters

listener: ((message, connectionInfo) => void)

Parameters

message: string

connectionInfo: ConnectionContext

Returns void

Returns Promise<void>

removePeer

Parameters

peerToBeRemoved: T

`Protected` _isConnected

`Protected` client

`Protected` `Readonly` name

`Protected` `Optional` newPeerListener

`Protected` `Readonly` peerManager

`Readonly` type

`Optional` _sendPairingResponse: boolean

`Protected` notifyListeners

`Optional` peer: PeerInfo

`Static` getAvailableExtensions

`Static` isAvailable

`Private` `Static` listenForExtensions