api_entities_Venue.Venue
Previousapi_entities_TickerReservation.TickerReservationNextapi_entities_common_namespaces_Authorizations.Authorizations
Last updated
Was this helpful?
Last updated
Was this helpful?
/ / / Venue
.Venue
Represents a Venue through which settlements are handled
<, string>
↳ Venue
• id: BigNumber
identifier number of the Venue
Defined in
• uuid: string
Inherited from
Defined in
Creates a settlement Instruction in this Venue
note required role:
Venue Owner
Parameters
args
opts?
Returns
Defined in
Creates a batch of settlement Instructions in this Venue
note required role:
Venue Owner
Parameters
args
opts?
Returns
Defined in
Retrieve information specific to this Venue
Returns
Defined in
â–¸ exists(): Promise<boolean>
Determine whether this Venue exists on chain
Returns
Promise<boolean>
Overrides
Defined in
Retrieve all pending and failed Instructions in this Venue
Returns
Defined in
Retrieve all pending Instructions in this Venue
deprecated in favor of getInstructions
Returns
Defined in
â–¸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
Parameters
entity
Returns
boolean
Inherited from
Defined in
â–¸ modify(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Modify description and type
note required role:
Venue Owner
Parameters
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
â–¸ toHuman(): string
Return the Venue's ID
Returns
string
Overrides
Defined in
â–¸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters
Identifiers
Parameters
identifiers
Identifiers
Returns
string
Inherited from
Defined in
â–¸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
Identifiers
Parameters
serialized
string
UUID to unserialize
Returns
Identifiers
Inherited from
Defined in
.
â–¸ addInstruction(args, opts?): Promise<TransactionQueue<[], , unknown[][]>>
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
Promise<TransactionQueue<[], , unknown[][]>>
â–¸ addInstructions(args, opts?): Promise<TransactionQueue<[], [], unknown[][]>>
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
Promise<TransactionQueue<[], [], unknown[][]>>
â–¸ details(): Promise<>
Promise<>
.
â–¸ getInstructions(): Promise<Pick<, "pending" | "failed">>
Promise<Pick<, "pending" | "failed">>
â–¸ getPendingInstructions(): Promise<[]>
Promise<[]>
<unknown, unknown>
.
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
.
.
.