Polymesh SDK API Reference
beta
beta
  • Globals
  • Classes
    • Account
    • AccountManagement
    • Asset
    • AssetHolders
    • AssetPermissions
    • Assets
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • CorporateAction
    • CorporateActionBase
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identities
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Network
    • NumberedPortfolio
    • Offering
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • Settlements
    • Subsidy
    • TickerReservation
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected context
  • id
  • uuid
  • Methods
  • addInstruction
  • addInstructions
  • details
  • exists
  • getInstructions
  • getPendingInstructions
  • isEqual
  • modify
  • toHuman
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

Venue

PreviousTrustedClaimIssuers

Last updated 2 years ago

Was this helpful?

Represents a Venue through which settlements are handled

Hierarchy

  • ‹UniqueIdentifiers, string›

    ↳ Venue

Index

Properties

Methods

Properties

Protected context

• context: Context


id

• id: BigNumber

identifier number of the Venue


uuid

• uuid: string

Methods

addInstruction

Creates a settlement Instruction in this Venue

note required role:

  • Venue Owner

Parameters:

Name
Type

args

opts?


addInstructions

Creates a batch of settlement Instructions in this Venue

note required role:

  • Venue Owner

Parameters:

Name
Type

args

opts?


details

Retrieve information specific to this Venue


exists

▸ exists(): Promise‹boolean›

Determine whether this Venue exists on chain

Returns: Promise‹boolean›


getInstructions

Retrieve all pending and failed Instructions in this Venue


getPendingInstructions

Retrieve all pending Instructions in this Venue

deprecated in favor of getInstructions


isEqual

Determine whether this Entity is the same as another one

Parameters:

Name
Type

entity

Returns: boolean


modify

Modify description and type

note required role:

  • Venue Owner

Parameters:

Name
Type

args

opts?


toHuman

â–¸ toHuman(): string

Return the Venue's ID

Returns: string


Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

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

Unserialize a UUID into its Unique Identifiers

Type parameters:

â–ª Identifiers

Parameters:

Name
Type
Description

serialized

string

UUID to unserialize

Returns: Identifiers

Inherited from .

Defined in

Defined in

Inherited from .

Defined in

▸ addInstruction(args: , opts?: ): Promise‹‹[], ››

Defined in

note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it

Returns: Promise‹‹[], ››

▸ addInstructions(args: , opts?: ): Promise‹‹[]››

Defined in

note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it

Returns: Promise‹‹[]››

▸ details(): Promise‹›

Defined in

Returns: Promise‹›

Overrides .

Defined in

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

Defined in

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

▸ getPendingInstructions(): Promise‹[]›

Defined in

Returns: Promise‹[]›

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

Inherited from .

Defined in

‹unknown, unknown›

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

Defined in

note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it

Returns: Promise‹‹void››

Overrides .

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

src/api/entities/Entity.ts:48
src/api/entities/Venue/index.ts:57
src/api/entities/Entity.ts:46
AddInstructionParams
ProcedureOpts
TransactionQueue
Instruction
Instruction
src/api/entities/Venue/index.ts:214
ProcedureMethod
addInstruction.checkAuthorization
TransactionQueue
Instruction
Instruction
AddInstructionsParams
ProcedureOpts
TransactionQueue
Instruction
src/api/entities/Venue/index.ts:227
ProcedureMethod
addInstructions.checkAuthorization
TransactionQueue
Instruction
VenueDetails
src/api/entities/Venue/index.ts:110
VenueDetails
src/api/entities/Venue/index.ts:91
GroupedInstructions
src/api/entities/Venue/index.ts:139
GroupedInstructions
Instruction
src/api/entities/Venue/index.ts:168
Instruction
Entity
src/api/entities/Entity.ts:61
src/api/entities/Venue/index.ts:240
ProcedureMethod
modify.checkAuthorization
TransactionQueue
src/api/entities/Venue/index.ts:247
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Entity
context
id
uuid
addInstruction
addInstructions
details
exists
getInstructions
getPendingInstructions
isEqual
modify
toHuman
generateUuid
unserialize
AddInstructionParams
ProcedureOpts
AddInstructionsParams
ProcedureOpts
Entity
ProcedureOpts
CheckpointSchedule
CheckpointSchedule
Entity
CheckpointSchedule
ProcedureOpts
TransactionQueue
Entity
CheckpointSchedule
CheckpointSchedule
context
uuid
isEqual
generateUuid
unserialize
ModifyVenueParams
ModifyVenueParams
exists
toHuman