Venue
Represents a Venue through which settlements are handled
Hierarchy
Entity‹UniqueIdentifiers, string›
↳ Venue
Index
Properties
Methods
Properties
Protected context
Protected context• context: Context
Inherited from CheckpointSchedule.context
Defined in src/api/entities/Entity.ts:48
id
• id: BigNumber
Defined in src/api/entities/Venue/index.ts:65
identifier number of the Venue
uuid
• uuid: string
Inherited from CheckpointSchedule.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:222
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 signing Account and Identity have the required roles and permissions to run it
Parameters:
Returns: Promise‹TransactionQueue‹Instruction[], Instruction››
addInstructions
▸ addInstructions(args: AddInstructionsParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹Instruction[]››
Defined in src/api/entities/Venue/index.ts:235
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 signing Account and Identity have the required roles and permissions to run it
Parameters:
Returns: Promise‹TransactionQueue‹Instruction[]››
details
▸ details(): Promise‹VenueDetails›
Defined in src/api/entities/Venue/index.ts:118
Retrieve information specific to this Venue
Returns: Promise‹VenueDetails›
exists
▸ exists(): Promise‹boolean›
Defined in src/api/entities/Venue/index.ts:99
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:176
Retrieve all pending Instructions in this Venue
deprecated in favor of getInstructions
Returns: Promise‹Instruction[]›
isEqual
▸ isEqual(entity: Entity‹unknown, unknown›): boolean
Inherited from CheckpointSchedule.isEqual
Defined in src/api/entities/Entity.ts:61
Determine whether this Entity is the same as another one
Parameters:
Returns: boolean
modify
▸ modify(args: ModifyVenueParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Defined in src/api/entities/Venue/index.ts:248
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 signing Account and Identity have the required roles and permissions to run it
Parameters:
Returns: Promise‹TransactionQueue‹void››
toJson
▸ toJson(): string
Defined in src/api/entities/Venue/index.ts:255
Return the Venue's ID
Returns: string
Static generateUuid
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
Inherited from CheckpointSchedule.generateUuid
Defined in src/api/entities/Entity.ts:14
Generate the Entity's UUID from its identifying properties
Type parameters:
▪ Identifiers
Parameters:
Returns: string
Static unserialize
Static unserialize▸ unserialize‹Identifiers›(serialized: string): Identifiers
Inherited from CheckpointSchedule.unserialize
Defined in src/api/entities/Entity.ts:23
Unserialize a UUID into its Unique Identifiers
Type parameters:
▪ Identifiers
Parameters:
Returns: Identifiers
Last updated