Interface IBeacon

Beacon interface IBeacon

interface IBeacon {
    id: string;
    service: BeaconService;
    serviceEndpoint: DidServiceEndpoint;
    type: string;
    broadcastSignal(
        didUpdatePayload: DidUpdatePayload,
    ): Promise<SignalsMetadata>;
    generateSignal(didUpdatePayload: string): BeaconSignal;
    processSignal(
        signal: RawTransactionV2,
        signalsMetadata: SignalsMetadata,
    ): Promise<undefined | DidUpdatePayload>;
}

Implemented by

Beacon

Index

Properties

id service serviceEndpoint type

Methods

broadcastSignal generateSignal processSignal

Properties

id

id: string

A unique identifier for the Beacon

service

service: BeaconService

Returns the Beacon Service object

serviceEndpoint

serviceEndpoint: DidServiceEndpoint

The service endpoint of the Beacon

type

type: string

The type of the Beacon

Methods

broadcastSignal

broadcastSignal(didUpdatePayload: DidUpdatePayload): Promise<SignalsMetadata>
Broadcasts a signal.
Parameters
- didUpdatePayload: DidUpdatePayload
  The DID update payload.
Returns Promise<SignalsMetadata>
The signal metadata.
- Defined in packages/method/src/interfaces/ibeacon.ts:57

generateSignal

generateSignal(didUpdatePayload: string): BeaconSignal
Generates a Beacon Signal Transaction
Parameters
- didUpdatePayload: string
  The DID update payload
Returns BeaconSignal
The Beacon Signal
- Defined in packages/method/src/interfaces/ibeacon.ts:41

processSignal

processSignal(
signal: RawTransactionV2,
signalsMetadata: SignalsMetadata,
): Promise<undefined | DidUpdatePayload>
Processes a Beacon Signal.
Parameters
- signal: RawTransactionV2
  The raw transaction
- signalsMetadata: SignalsMetadata
  The signals metadata from the sidecar data
Returns Promise<undefined | DidUpdatePayload>
The DID update payload
- Defined in packages/method/src/interfaces/ibeacon.ts:49

Interface IBeacon

Implemented by

Index

Properties

Methods

Properties

id

service

serviceEndpoint

type

Methods

broadcastSignal

Parameters

Returns Promise<SignalsMetadata>

generateSignal

Parameters

Returns BeaconSignal

processSignal

Parameters

Returns Promise<undefined | DidUpdatePayload>

Settings

On This Page