BitShares-Core  6.1.0
BitShares blockchain implementation and command-line interface software
Public Member Functions | List of all members
graphene::app::custom_operations_api Class Reference

The custom_operations_api class exposes access to standard custom objects parsed by the custom_operations_plugin. More...

#include <api.hpp>

Public Member Functions

 custom_operations_api (application &app)
 
vector< account_storage_objectget_storage_info (const optional< std::string > &account_name_or_id=optional< std::string >(), const optional< std::string > &catalog=optional< std::string >(), const optional< std::string > &key=optional< std::string >(), const optional< uint32_t > &limit=optional< uint32_t >(), const optional< account_storage_id_type > &start_id=optional< account_storage_id_type >()) const
 Get stored objects. More...
 

Detailed Description

The custom_operations_api class exposes access to standard custom objects parsed by the custom_operations_plugin.

Definition at line 650 of file api.hpp.

Constructor & Destructor Documentation

◆ custom_operations_api()

graphene::app::custom_operations_api::custom_operations_api ( application app)
explicit

Definition at line 1019 of file api.cpp.

Member Function Documentation

◆ get_storage_info()

vector< account_storage_object > graphene::app::custom_operations_api::get_storage_info ( const optional< std::string > &  account_name_or_id = optional<std::string>(),
const optional< std::string > &  catalog = optional<std::string>(),
const optional< std::string > &  key = optional<std::string>(),
const optional< uint32_t > &  limit = optional<uint32_t>(),
const optional< account_storage_id_type > &  start_id = optional<account_storage_id_type>() 
) const

Get stored objects.

Parameters
account_name_or_idThe account name or ID to get info from. Optional.
catalogThe catalog to get info from. Each account can store data in multiple catalogs. Optional.
keyThe key to get info from. Each catalog can contain multiple keys. Optional.
limitThe limitation of items each query can fetch, not greater than the configured value of api_limit_get_storage_info. Optional.
start_idStart ID of stored object, fetch objects whose IDs are greater than or equal to this ID
Returns
The stored objects found, sorted by their ID
Note
  1. By passing null to various optional parameters, or omitting where applicable, this API can be used to query stored objects by a) account, catalog and key, or b) account and catalog, or c) account, or d) catalog and key, or e) catalog, or f) unconditionally. Queries with keys without a catalog are not allowed.
  2. If account_name_or_id is specified but cannot be tied to an account, an error will be returned.
  3. limit can be omitted or be null, if so the configured value of api_limit_get_storage_info will be used.
  4. start_id can be omitted or be null, if so the API will return the "first page" of objects.
  5. One or more optional parameters can be omitted from the end of the parameter list, and the optional parameters in the middle cannot be omitted (but can be null).

Definition at line 1024 of file api.cpp.


The documentation for this class was generated from the following files: