Venue
Represents a Venue through which settlements are handled
Hierarchy
Entity‹UniqueIdentifiers, string›
↳ 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:58
Identifier number of the venue
uuid
• uuid: string
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:243
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 |
| |
|
Returns: Promise‹TransactionQueue‹Instruction[], Instruction››
addInstructions
▸ addInstructions(args: AddInstructionsParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹Instruction[]››
Defined in src/api/entities/Venue/index.ts:256
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 |
| |
|
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›
Defined in src/api/entities/Venue/index.ts:92
Retrieve whether the Venue exists
Returns: Promise‹boolean›
getInstructions
▸ getInstructions(): Promise‹Pick‹GroupedInstructions, "pending" | "failed"››
Defined in src/api/entities/Venue/index.ts:145
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:199
Retrieve all pending Instructions in this Venue
deprecated in favor of getInstructions
Returns: Promise‹Instruction[]›
isEqual
▸ isEqual(entity: Entity‹unknown, unknown›): boolean
Defined in src/api/entities/Entity.ts:61
Whether this Entity is the same as another one
Parameters:
Name | Type |
| Entity‹unknown, unknown› |
Returns: boolean
modify
▸ modify(args: ModifyVenueParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Defined in src/api/entities/Venue/index.ts:269
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 |
| |
|
Returns: Promise‹TransactionQueue‹void››
toJson
▸ toJson(): string
Defined in src/api/entities/Venue/index.ts:276
Return the Venue's ID
Returns: string
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
Parameters:
Name | Type | Description |
| Identifiers |
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
Parameters:
Name | Type | Description |
| string | UUID to unserialize |
Returns: Identifiers
Last updated