Interface: IBeacon ​
Defined in: packages/method/src/interfaces/beacon.ts:11
Beacon interface IBeacon
Properties ​
id ​
id:
string
Defined in: packages/method/src/interfaces/beacon.ts:16
A unique identifier for the Beacon
service ​
service:
BeaconService
Defined in: packages/method/src/interfaces/beacon.ts:34
Returns the Beacon Service object
serviceEndpoint ​
serviceEndpoint:
DidServiceEndpoint
Defined in: packages/method/src/interfaces/beacon.ts:28
The service endpoint of the Beacon
type ​
type:
string
Defined in: packages/method/src/interfaces/beacon.ts:22
The type of the Beacon
Methods ​
broadcastSignal() ​
broadcastSignal(
didUpdatePayload):Promise<SignalsMetadata>
Defined in: packages/method/src/interfaces/beacon.ts:57
Broadcasts a signal.
Parameters ​
didUpdatePayload ​
The DID update payload.
Returns ​
Promise<SignalsMetadata>
The signal metadata.
generateSignal() ​
generateSignal(
didUpdatePayload):BeaconSignal
Defined in: packages/method/src/interfaces/beacon.ts:41
Generates a Beacon Signal Transaction
Parameters ​
didUpdatePayload ​
string
The DID update payload
Returns ​
The Beacon Signal
processSignal() ​
processSignal(
signal,signalsMetadata):Promise<DidUpdatePayload|undefined>
Defined in: packages/method/src/interfaces/beacon.ts:49
Processes a Beacon Signal.
Parameters ​
signal ​
The raw transaction
signalsMetadata ​
The signals metadata from the sidecar data
Returns ​
Promise<DidUpdatePayload | undefined>
The DID update payload