Venue
Represents a Venue through which settlements are handled

Hierarchy

    Entity‹UniqueIdentifiers, string›
    Venue

Index

Properties

Methods

Properties

Protected context

context: Context
Inherited from Entity.context

id

id: BigNumber
Identifier number of the venue

uuid

uuid: string
Inherited from Entity.uuid

Methods

addInstruction

addInstruction(args: AddInstructionParams, opts?: ProcedureOpts): Promise‹TransactionQueueInstruction[], Instruction››
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
opts?
Returns: Promise‹TransactionQueueInstruction[], Instruction››

addInstructions

addInstructions(args: AddInstructionsParams, opts?: ProcedureOpts): Promise‹TransactionQueueInstruction[]››
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
opts?
Returns: Promise‹TransactionQueueInstruction[]››

details

details(): Promise‹VenueDetails
Retrieve information specific to this venue
Returns: Promise‹VenueDetails

exists

exists(): Promise‹boolean›
Overrides Entity.exists
Determine whether this Venue exists on chain
Returns: Promise‹boolean›

getInstructions

getInstructions(): Promise‹Pick‹GroupedInstructions, "pending" | "failed"››
Retrieve all pending and failed Instructions in this Venue
Returns: Promise‹Pick‹GroupedInstructions, "pending" | "failed"››

getPendingInstructions

getPendingInstructions(): Promise‹Instruction[]›
Retrieve all pending Instructions in this Venue
deprecated in favor of getInstructions
Returns: Promise‹Instruction[]›

isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean
Inherited from Entity.isEqual
Determine whether this Entity is the same as another one
Parameters:
Name
Type
entity
Entity‹unknown, unknown›
Returns: boolean

modify

modify(args: ModifyVenueParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
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
opts?
Returns: Promise‹TransactionQueue‹void››

toJson

toJson(): string
Overrides Entity.toJson
Return the Venue's ID
Returns: string

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string
Inherited from Entity.generateUuid
Generate the Entity's UUID from its identifying properties
Type parameters:
Identifiers
Parameters:
Name
Type
Description
identifiers
Identifiers
Returns: string

Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers
Inherited from Entity.unserialize
Unserialize a UUID into its Unique Identifiers
Type parameters:
Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Last modified 26d ago