Class Transaction

Class Transaction#

Inheritance Relationships#

Base Type#

Class Documentation#

class Transaction : public xbe::sdk::EntityBase#

Describes an transaction request.

Public Functions

inline Transaction()#
inline Transaction(const Transaction &value)#
inline Transaction(Transaction &&value)#
inline virtual ~Transaction()#
inline virtual Transaction &SetProperties(const std::map<utility::string_t, Variant> &value) override#

Sets the object’s underlying map of stored values.

inline virtual Transaction &SetProperties(std::map<utility::string_t, Variant> &&value) override#

Sets the underlying map of stored values for the object.

inline virtual Transaction &SetProperty(const utility::char_t *name, const Variant &value) override#

Sets the property of the given name to the provided value.

inline virtual Transaction &SetProperty(const utility::string_t &name, const Variant &value) override#

Sets the property of the given name to the provided value.

inline virtual Transaction &SetRemoteUrl(const utility::string_t &url) override#

Returns the URL of the remote server endpoint where the object is managed.

inline virtual Transaction &SetUid(const utility::string_t &value) override#

Sets the value of the Uid property.

Parameters:

value – The value to set.

inline virtual Transaction &SetDateCreated(const datetime &value) override#

Sets the value of the DateCreated property.

Parameters:

value – The value to set.

inline virtual Transaction &SetDateModified(const datetime &value) override#

Sets the value of the DateModified property.

Parameters:

value – The value to set.

inline virtual Transaction &SetVersion(const uint64_t value) override#

Sets the value of the Version property.

Parameters:

value – The value to set.

virtual void Validate() override#
const Status *GetStatus() const#

Returns the current status of the transaction.

const Type *GetType() const#

Returns the current type of the transaction. TYPE_AWARD or TYPE_REMOVAL can only be performed by a user with a trusted role.

utility::string_t GetFrom() const#

Returns the unique identifier of the user that this inventory belongs to.

utility::string_t GetTo() const#

Returns the unique identifier of the persona that this inventory belongs to. Empty for TYPE_AWARD or TYPE_REMOVAL.

Transaction &SetResources(const std::vector<std::shared_ptr<PersonaResource>> value)#

The list of resources involved in the transaction. If one or more resource(s) are specified belonging to the recipient then it will be transferred to the sender upon execution.

Parameters:

value – The value to set.

std::vector<std::shared_ptr<PersonaResource>> GetResources() const#

The list of resources involved in the transaction. If one or more resource(s) are specified belonging to the recipient then it will be transferred to the sender upon execution.

Parameters:

value – The value to set.

Transaction &SetApproval(const std::shared_ptr<Transaction::TransactionApproval> value)#

The list of resources involved in the transaction. If one or more resource(s) are specified belonging to the recipient then it will be transferred to the sender upon execution.

Parameters:

value – The value to set.

std::shared_ptr<Transaction::TransactionApproval> GetApproval() const#

The list of resources involved in the transaction. If one or more resource(s) are specified belonging to the recipient then it will be transferred to the sender upon execution.

Parameters:

value – The value to set.

std::vector<std::shared_ptr<InventoryItem>> GetPersonaOneInventoryItemsBefore() const#

Returns snapshot of inventory items before transaction.

std::vector<std::shared_ptr<InventoryItem>> GetPersonaOneInventoryItemsAfter() const#

Returns the snapshot of inventory items after transaction.

std::vector<std::shared_ptr<InventoryItem>> GetPersonaTwoInventoryItemsBefore() const#

Returns the snapshot of inventory items before transaction. Empty if not a trade.

std::vector<std::shared_ptr<InventoryItem>> GetPersonaTwoInventoryItemsAfter() const#

Returns the snapshot of inventory after transaction. Empty if not a trade.

Public Static Functions

static inline const utility::char_t *ClassName()#

Returns the fully qualified name of the class.