Class: AggregateBeaconMessage ​
Defined in: packages/method/src/core/beacon/aggregation/cohort/messages/index.ts:46
AggregateBeaconMessage is a utility class that provides constants and type checks for various message types used in the aggregate beacon communication protocol. It includes methods to validate message types and retrieve message types from objects. AggregateBeaconMessage
Constructors ​
Constructor ​
new AggregateBeaconMessage():
AggregateBeaconMessage
Returns ​
AggregateBeaconMessage
Properties ​
ALL_MESSAGES ​
staticALL_MESSAGES:string[]
Defined in: packages/method/src/core/beacon/aggregation/cohort/messages/index.ts:73
BEACON_COHORT_ADVERT ​
staticBEACON_COHORT_ADVERT:string
Defined in: packages/method/src/core/beacon/aggregation/cohort/messages/index.ts:47
BEACON_COHORT_AGGREGATED_NONCE ​
staticBEACON_COHORT_AGGREGATED_NONCE:string
Defined in: packages/method/src/core/beacon/aggregation/cohort/messages/index.ts:62
BEACON_COHORT_AUTHORIZATION_REQUEST ​
staticBEACON_COHORT_AUTHORIZATION_REQUEST:string
Defined in: packages/method/src/core/beacon/aggregation/cohort/messages/index.ts:60
BEACON_COHORT_KEY_GEN_MESSAGES ​
staticBEACON_COHORT_KEY_GEN_MESSAGES:Map<string,string>
Defined in: packages/method/src/core/beacon/aggregation/cohort/messages/index.ts:52
BEACON_COHORT_NONCE_CONTRIBUTION ​
staticBEACON_COHORT_NONCE_CONTRIBUTION:string
Defined in: packages/method/src/core/beacon/aggregation/cohort/messages/index.ts:61
BEACON_COHORT_OPT_IN ​
staticBEACON_COHORT_OPT_IN:string
Defined in: packages/method/src/core/beacon/aggregation/cohort/messages/index.ts:48
BEACON_COHORT_OPT_IN_ACCEPT ​
staticBEACON_COHORT_OPT_IN_ACCEPT:string
Defined in: packages/method/src/core/beacon/aggregation/cohort/messages/index.ts:50
BEACON_COHORT_READY ​
staticBEACON_COHORT_READY:string
Defined in: packages/method/src/core/beacon/aggregation/cohort/messages/index.ts:49
BEACON_COHORT_REQUEST_SIGNATURE ​
staticBEACON_COHORT_REQUEST_SIGNATURE:string
Defined in: packages/method/src/core/beacon/aggregation/cohort/messages/index.ts:59
BEACON_COHORT_SIGN_MESSAGES ​
staticBEACON_COHORT_SIGN_MESSAGES:Map<string,string>
Defined in: packages/method/src/core/beacon/aggregation/cohort/messages/index.ts:65
BEACON_COHORT_SIGNATURE_AUTHORIZATION ​
staticBEACON_COHORT_SIGNATURE_AUTHORIZATION:string
Defined in: packages/method/src/core/beacon/aggregation/cohort/messages/index.ts:63
Methods ​
getMessageValueByType() ​
staticgetMessageValueByType(type):string|undefined
Defined in: packages/method/src/core/beacon/aggregation/cohort/messages/index.ts:99
Get the message value based on the type.
Parameters ​
type ​
string
The type (or name) of the message.
Returns ​
string | undefined
- The corresponding type value.
isKeyGenMessageValue() ​
staticisKeyGenMessageValue(value):boolean
Defined in: packages/method/src/core/beacon/aggregation/cohort/messages/index.ts:120
Checks if the provided type is a valid KeyGenMessageType.
Parameters ​
value ​
string
The message type to check.
Returns ​
boolean
- Returns true if the type is a key generation message type, otherwise false.
isSignMessageValue() ​
staticisSignMessageValue(value):boolean
Defined in: packages/method/src/core/beacon/aggregation/cohort/messages/index.ts:134
Checks if the provided type is a valid SignMessageType.
Parameters ​
value ​
string
The message type to check.
Returns ​
boolean
- Returns true if the type is a sign message type, otherwise false.
isValidType() ​
staticisValidType(type):boolean
Defined in: packages/method/src/core/beacon/aggregation/cohort/messages/index.ts:90
Checks if the name provided is a valid message name.
Parameters ​
type ​
string
The type of the message.
Returns ​
boolean
isValidValue() ​
staticisValidValue(type):boolean
Defined in: packages/method/src/core/beacon/aggregation/cohort/messages/index.ts:111
Checks if the provided type is a valid AggregateBeaconMessageType.
Parameters ​
type ​
string
The message type to check.
Returns ​
boolean
- Returns true if the type is valid, otherwise false.