Venue

Represents a Venue through which settlements are handled

Hierarchy

• Entity‹UniqueIdentifiers›

  ↳ Venue

Index

Properties

• context

• id

• uuid

Methods

• addInstruction

• details

• getPendingInstructions

• generateUuid

• unserialize

Properties

Protected context

• context: Context

Inherited from Entity.context

Defined in src/api/entities/Entity.ts:48

id

• id: BigNumber

Defined in src/api/entities/Venue/index.ts:39

Identifier number of the venue

uuid

• uuid: string

Inherited from Entity.uuid

Defined in src/api/entities/Entity.ts:46

Methods

addInstruction

▸ addInstruction(args: AddInstructionParams): Promise‹TransactionQueue‹Instruction››

Defined in src/api/entities/Venue/index.ts:111

Creates a settlement instruction in this Venue

Parameters:

Name	Type
args	AddInstructionParams

Returns: Promise‹TransactionQueue‹Instruction››

details

▸ details(): Promise‹VenueDetails›

Defined in src/api/entities/Venue/index.ts:55

Retrieve information specific to this venue

Returns: Promise‹VenueDetails›

getPendingInstructions

▸ getPendingInstructions(): Promise‹Instruction[]›

Defined in src/api/entities/Venue/index.ts:80

Retrieve all pending Instructions in this Venue

Returns: Promise‹Instruction[]›

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:

Name	Type	Description
identifiers	Identifiers

Returns: string

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:

Name	Type	Description
serialized	string	UUID to unserialize

Returns: Identifiers