Documentation
    Preparing search index...

    Class BeaconClientAbstract

    The beacon client is an abstract client that handles everything that is shared between all other clients. Specifically, it handles managing the beaconId and and the local keypair.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _beaconId _keyPair analytics appUrl? iconUrl? name storage

    Accessors

    beaconId keyPair

    Methods

    destroy initSDK

    Constructors

    Properties

    Protected_beaconId

    _beaconId: ExposedPromise<string>

    The beaconId is a public key that is used to identify one specific application (dapp or wallet). This is used inside a message to specify the sender, for example.

    Protected_keyPair

    _keyPair: ExposedPromise<KeyPair>

    The local keypair that is used for the communication encryption

    analytics: AnalyticsInterface
    appUrl?: string

    The URL of the dApp.

    iconUrl?: string

    The URL of the dApp Icon. This can be used to display the icon of the dApp on in the wallet

    name: string

    The name of the client

    storage: Storage

    Accessors

    • get beaconId(): Promise<string>

      Returns Promise<string>

    • get keyPair(): Promise<KeyPair>

      Returns Promise<KeyPair>

    Methods

    • This resets the SDK. After using this method, this instance is no longer usable. You will have to instanciate a new client.

      Returns Promise<void>

    • This method initializes the SDK by setting some values in the storage and generating a keypair.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods