Venue

Represents a Venue through which settlements are handled

Hierarchy

• Entity‹UniqueIdentifiers, string›

  ↳ Venue

Index

Properties

• context

• id

• uuid

Methods

• addInstruction

• addInstructions

• details

• exists

• getInstructions

• getPendingInstructions

• isEqual

• modify

• toJson

• 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:58

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, opts?: ProcedureOpts): Promise‹TransactionQueue‹Instruction[], Instruction››

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

Creates a settlement Instruction in this Venue

note required role:

• Venue Owner

note this method is of type ProcedureMethod, which means you can call addInstruction.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	AddInstructionParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹Instruction[], Instruction››

addInstructions

▸ addInstructions(args: AddInstructionsParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹Instruction[]››

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

Creates a batch of settlement Instructions in this Venue

note required role:

• Venue Owner

note this method is of type ProcedureMethod, which means you can call addInstructions.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	AddInstructionsParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹Instruction[]››

details

▸ details(): Promise‹VenueDetails›

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

Retrieve information specific to this venue

Returns: Promise‹VenueDetails›

exists

▸ exists(): Promise‹boolean›

Overrides Entity.exists

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

Determine whether this Venue exists on chain

Returns: Promise‹boolean›

getInstructions

▸ getInstructions(): Promise‹Pick‹GroupedInstructions, "pending" | "failed"››

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

Retrieve all pending and failed Instructions in this Venue

Returns: Promise‹Pick‹GroupedInstructions, "pending" | "failed"››

getPendingInstructions

▸ getPendingInstructions(): Promise‹Instruction[]›

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

Retrieve all pending Instructions in this Venue

deprecated in favor of getInstructions

Returns: Promise‹Instruction[]›

isEqual

▸ isEqual(entity: Entity‹unknown, unknown›): boolean

Inherited from Entity.isEqual

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

Determine whether this Entity is the same as another one

Parameters:

Name	Type
entity	Entity‹unknown, unknown›

Returns: boolean

modify

▸ modify(args: ModifyVenueParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

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

Modify description and type

note required role:

• Venue Owner

note this method is of type ProcedureMethod, which means you can call modify.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	ModifyVenueParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

toJson

▸ toJson(): string

Overrides Entity.toJson

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

Return the Venue's ID

Returns: string

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

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

Parameters:

Name	Type	Description
serialized	string	UUID to unserialize

Returns: Identifiers