Venue
Last updated
Was this helpful?
Last updated
Was this helpful?
Represents a Venue through which settlements are handled
‹UniqueIdentifiers, string›
↳ Venue
Protected context• id: BigNumber
Identifier number of the venue
• uuid: string
Creates a settlement Instruction in this Venue
note required role:
Venue Owner
Parameters:
Name
Type
args
opts?
Creates a batch of settlement Instructions in this Venue
note required role:
Venue Owner
Parameters:
Name
Type
args
opts?
Retrieve information specific to this venue
▸ exists(): Promise‹boolean›
Retrieve whether the Venue exists
Returns: Promise‹boolean›
Retrieve all pending and failed Instructions in this Venue
Retrieve all pending Instructions in this Venue
deprecated in favor of getInstructions
Whether this Entity is the same as another one
Parameters:
Name
Type
entity
Returns: boolean
Modify description and type
note required role:
Venue Owner
Parameters:
Name
Type
args
opts?
â–¸ toJson(): 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
• context:
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 addInstruction.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹[], ››
▸ addInstructions(args: , opts?: ): Promise‹‹[]››
Defined in
note this method is of type , which means you can call addInstructions.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹[]››
▸ details(): Promise‹›
Defined in
Returns: Promise‹›
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 modify.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
Overrides .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in