This field contains the mongo collection name for entries
that are stored using PayoutDocument or the model
PayoutModel.
Note that this field is not part of document properties
and used only internally to perform queries that refer to
an individual collection name, e.g. $unionWith.
The document's creation timestamp. This field does represent a
payout's actual date of creation of the signed transaction. This
field does not represent the date of confirmation.
This is the payout's mosaics as defined by dHealth Network. It
contains an array of ObjectLiteral objects that consist of both
a mosaicId and amount field.
This field contains the actual tokens that have been paid out
to the end-user with this document. It can hold only a single
mosaic or up to 10 different mosaics that were sent to the end-
user for completing an activity (or other operations).
This field is optional, indexed and defaults to an empty
array.
This property is a flag that determines whether the payout has been executed before or not. The execution of said payout happens in multiple stages, with following possible update flows:
```
<br /><br />
Possible values for this field in the database are of type `number` and
listed in <a href="../enums/PayoutState.html">PayoutState</a>. Initially, the value will always be
`0` as this corresponds to "not-started".
<br /><br />
This field is **optional**, *indexed* and defaults to `0`.
This field contains the signed transaction bytes. This represents
the signed transaction in a binary payload expressed in hexadecimal
format.
Note that this field will be emptied once the transaction has been
broadcast and verified to be confirmed on dHealth Network.
This is the subject collection name. This name corresponds
to the origin database collection in which the above slug
can be found to be linked to one unique entity.
This field is required and indexed.
This is the subject slug. With the currently implemented
payout module, the subject is always an activity but in
future releases of the software, the subject may also be
a profile, or a leaderboard update, etc.
This field is required and indexed.
This is the transaction hash as defined by dHealth Network. It
contains an immutable sha3-256 hash created from the transaction
body.
Due to the usage of sha3-256, this hash is always a 32 bytes
transaction hash (64 characters in hexadecimal notation).
This field is required, indexed and values are expected
to be unique.
The document's update timestamp. This field does not reflect the date of update of an integration but rather the date of update of the cached database entry.
This is the user's address. The user corresponds to the
destination of said payout ("recipient").
This field is required and indexed.
This method implements a specialized query format to query items
individually, as documents, in the collection: account_integrations.
The individual document data that is used in a query.
This static method populates a PayoutDTO object from the values of a PayoutDocument as presented by mongoose queries.
The document as received from mongoose.
The DTO object that will be populated with values.
The dto object with fields set.
Generated using TypeDoc
This class defines the exact fields that are stored in the corresponding MongoDB documents. It should be used whenever database documents are being handled or read for the
payoutscollection.Note that this class uses the generic Transferable trait to enable a
toDTO()method on the model.Timestamp fields should be numbers to avoid timezone issues.
v0.4.0