api_entities_Venue.Venue
@polymeshassociation/polymesh-sdk / Modules / api/entities/Venue / Venue
Class: Venue
api/entities/Venue.Venue
Represents a Venue through which settlements are handled
Hierarchy
Entity<UniqueIdentifiers,string>↳
Venue
Table of contents
Properties
Methods
Properties
id
• id: BigNumber
identifier number of the Venue
Defined in
api/entities/Venue/index.ts:57
uuid
• uuid: string
Inherited from
Defined in
Methods
addInstruction
▸ addInstruction(args, opts?): Promise<TransactionQueue<Instruction[], Instruction, unknown[][]>>
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
| Name | Type |
|---|---|
| |
|
Returns
Promise<TransactionQueue<Instruction[], Instruction, unknown[][]>>
Defined in
api/entities/Venue/index.ts:214
addInstructions
▸ addInstructions(args, opts?): Promise<TransactionQueue<Instruction[], Instruction[], unknown[][]>>
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
| Name | Type |
|---|---|
| |
|
Returns
Promise<TransactionQueue<Instruction[], Instruction[], unknown[][]>>
Defined in
api/entities/Venue/index.ts:227
details
▸ details(): Promise<VenueDetails>
Retrieve information specific to this Venue
Returns
Promise<VenueDetails>
Defined in
api/entities/Venue/index.ts:110
exists
▸ exists(): Promise<boolean>
Determine whether this Venue exists on chain
Returns
Promise<boolean>
Overrides
Defined in
api/entities/Venue/index.ts:91
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:139
getPendingInstructions
▸ getPendingInstructions(): Promise<Instruction[]>
Retrieve all pending Instructions in this Venue
deprecated in favor of getInstructions
Returns
Promise<Instruction[]>
Defined in
api/entities/Venue/index.ts:168
isEqual
▸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
Parameters
| Name | Type |
|---|---|
|
|
Returns
boolean
Inherited from
Defined in
modify
▸ modify(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
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
| Name | Type |
|---|---|
| |
|
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
api/entities/Venue/index.ts:240
toHuman
▸ toHuman(): string
Return the Venue's ID
Returns
string
Overrides
Defined in
api/entities/Venue/index.ts:247
generateUuid
▸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters
| Name |
|---|
|
Parameters
| Name | Type |
|---|---|
|
|
Returns
string
Inherited from
Defined in
unserialize
▸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
| Name |
|---|
|
Parameters
| Name | Type | Description |
|---|---|---|
|
| UUID to unserialize |
Returns
Identifiers
Inherited from
Defined in
Last updated