Venue
Represents a Venue through which settlements are handled
Hierarchy
Entity‹UniqueIdentifiers›
↳ Venue
Index
Properties
Methods
Properties
Protected context
Protected context• context: Context
Defined in src/api/entities/Entity.ts:48
id
• id: BigNumber
Defined in src/api/entities/Venue/index.ts:45
Identifier number of the venue
uuid
• uuid: string
Defined in src/api/entities/Entity.ts:46
Methods
addInstruction
▸ addInstruction(args: AddInstructionParams): Promise‹TransactionQueue‹Instruction››
Defined in src/api/entities/Venue/index.ts:119
Creates a settlement instruction in this Venue
Parameters:
Returns: Promise‹TransactionQueue‹Instruction››
details
▸ details(): Promise‹VenueDetails›
Defined in src/api/entities/Venue/index.ts:61
Retrieve information specific to this venue
Returns: Promise‹VenueDetails›
getPendingInstructions
▸ getPendingInstructions(): Promise‹Instruction[]›
Defined in src/api/entities/Venue/index.ts:86
Retrieve all pending Instructions in this Venue
Returns: Promise‹Instruction[]›
Static generateUuid
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
Inherited from Entity.generateUuid
Defined in src/api/entities/Entity.ts:14
Generate the Entity's UUID from its identifying properties
Type parameters:
▪ Identifiers: object
Parameters:
Returns: string
Static unserialize
Static unserialize▸ unserialize‹Identifiers›(serialized: string): Identifiers
Inherited from Entity.unserialize
Defined in src/api/entities/Entity.ts:23
Unserialize a UUID into its Unique Identifiers
Type parameters:
▪ Identifiers: object
Parameters:
Returns: Identifiers
Last updated