api_entities_Offering.Offering
Previousapi_entities_NumberedPortfolio.NumberedPortfolioNextapi_entities_PermissionGroup.PermissionGroup
Last updated
Was this helpful?
Last updated
Was this helpful?
/ / / Offering
.Offering
Represents an Asset Offering in the Polymesh blockchain
<, HumanReadable>
↳ Offering
Asset being offered
Defined in
• id: BigNumber
identifier number of the Offering
Defined in
• uuid: string
Inherited from
Defined in
â–¸ close(opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Close the Offering
Parameters
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
Retrieve the Offering's details
note can be subscribed to
Returns
Defined in
Parameters
callback
Returns
Defined in
â–¸ exists(): Promise<boolean>
Determine whether this Offering exists on chain
Returns
Promise<boolean>
Overrides
Defined in
Freeze the Offering
Parameters
opts?
Returns
Defined in
Retrieve all investments made on this Offering
note supports pagination
note uses the middleware
Parameters
opts
Object
-
opts.size?
BigNumber
page size
opts.start?
BigNumber
page offset
Returns
Defined in
â–¸ invest(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Invest in the Offering
note required roles:
Purchase Portfolio Custodian
Funding Portfolio Custodian
Parameters
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
â–¸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
Parameters
entity
Returns
boolean
Inherited from
Defined in
â–¸ modifyTimes(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Modify the start/end time of the Offering
throws if:
Trying to modify the start time on an Offering that already started
Trying to modify anything on an Offering that already ended
Trying to change start or end time to a past date
Parameters
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
â–¸ toHuman(): HumanReadable
Return the Offering's ID and Asset ticker
Returns
HumanReadable
Overrides
Defined in
Unfreeze the Offering
Parameters
opts?
Returns
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
• asset:
.
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
â–¸ details(): Promise<>
Promise<>
â–¸ details(callback): Promise<>
<>
Promise<>
.
â–¸ freeze(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[][]>>
â–¸ getInvestments(opts?): Promise<<>>
Promise<<>>
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
<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
.
â–¸ unfreeze(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[][]>>
.
.