Class: Venue
api/entities/Venue.Venue
Represents a Venue through which settlements are handled
Hierarchy
-
Entity<UniqueIdentifiers,string>↳
Venue
Properties
id
• id: BigNumber
identifier number of the Venue
Defined in
api/entities/Venue/index.ts:66
uuid
• uuid: string
Inherited from
Defined in
Methods
addInstruction
▸ addInstruction(args, opts?): Promise<GenericPolymeshTransaction<Instruction[], Instruction>>
Creates a settlement Instruction in this Venue
Parameters
| Name | Type |
|---|---|
args | AddInstructionParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<Instruction[], Instruction>>
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
Defined in
api/entities/Venue/index.ts:256
addInstructions
▸ addInstructions(args, opts?): Promise<GenericPolymeshTransaction<Instruction[], Instruction[]>>
Creates a batch of settlement Instructions in this Venue
Parameters
| Name | Type |
|---|---|
args | AddInstructionsParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<Instruction[], Instruction[]>>
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
Defined in
api/entities/Venue/index.ts:269
details
▸ details(): Promise<VenueDetails>
Retrieve information specific to this Venue
Returns
Promise<VenueDetails>
Defined in
api/entities/Venue/index.ts:119
exists
▸ exists(): Promise<boolean>
Determine whether this Venue exists on chain
Returns
Promise<boolean>
Overrides
Defined in
api/entities/Venue/index.ts:100
getHistoricalInstructions
▸ getHistoricalInstructions(opts?): Promise<ResultSet<HistoricInstruction>>
Retrieve all Instructions that have been associated with this Venue instance
Parameters
| Name | Type | Description |
|---|---|---|
opts | Object | - |
opts.size? | BigNumber | page size |
opts.start? | BigNumber | page offset |
Returns
Promise<ResultSet<HistoricInstruction>>
Note
uses the middleware V2
Note
supports pagination
Defined in
api/entities/Venue/index.ts:208
getInstructions
▸ getInstructions(): Promise<Pick<GroupedInstructions, "pending" | "failed">>
Retrieve all pending and failed Instructions in this Venue
Returns
Promise<Pick<GroupedInstructions, "pending" | "failed">>
Defined in
api/entities/Venue/index.ts:148
isEqual
▸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
Parameters
| Name | Type |
|---|---|
entity | Entity<unknown, unknown> |
Returns
boolean
Inherited from
Defined in
modify
▸ modify(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Modify description and type
Parameters
| Name | Type |
|---|---|
args | ModifyVenueParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
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
Defined in
api/entities/Venue/index.ts:282
toHuman
▸ toHuman(): string
Return the Venue's ID
Returns
string
Overrides
Defined in
api/entities/Venue/index.ts:289
generateUuid
▸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters
| Name |
|---|
Identifiers |
Parameters
| Name | Type |
|---|---|
identifiers | Identifiers |
Returns
string
Inherited from
Defined in
unserialize
▸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
| Name |
|---|
Identifiers |
Parameters
| Name | Type | Description |
|---|---|---|
serialized | string | UUID to unserialize |
Returns
Identifiers