@did-btc1/method / IBeacon
Interface: IBeacon
Defined in: packages/method/src/interfaces/ibeacon.ts:12
Beacon interface IBeacon
Properties
id
> id: string
Defined in: packages/method/src/interfaces/ibeacon.ts:17
A unique identifier for the Beacon
service
> service: BeaconService
Defined in: packages/method/src/interfaces/ibeacon.ts:35
Returns the Beacon Service object
serviceEndpoint
> serviceEndpoint: DidServiceEndpoint
Defined in: packages/method/src/interfaces/ibeacon.ts:29
The service endpoint of the Beacon
type
> type: string
Defined in: packages/method/src/interfaces/ibeacon.ts:23
The type of the Beacon
Methods
broadcastSignal()
> broadcastSignal(didUpdatePayload): Promise<SignalsMetadata>
Defined in: packages/method/src/interfaces/ibeacon.ts:58
Broadcasts a signal.
Parameters
didUpdatePayload
DidUpdatePayload
The DID update payload.
Returns
Promise<SignalsMetadata>
The signal metadata.
generateSignal()
> generateSignal(didUpdatePayload): BeaconSignal
Defined in: packages/method/src/interfaces/ibeacon.ts:42
Generates a Beacon Signal Transaction
Parameters
didUpdatePayload
string
The DID update payload
Returns
The Beacon Signal
processSignal()
> processSignal(signal, signalsMetadata): Promise<undefined | DidUpdatePayload>
Defined in: packages/method/src/interfaces/ibeacon.ts:50
Processes a Beacon Signal.
Parameters
signal
The raw transaction
signalsMetadata
The signals metadata from the sidecar data
Returns
Promise<undefined | DidUpdatePayload>
The DID update payload