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_object >	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. 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

graphene::app::custom_operations_api::custom_operations_api ( application & app )

explicit

Definition at line 1017 of file api.cpp.

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_id	The account name or ID to get info from. Optional.
catalog	The catalog to get info from. Each account can store data in multiple catalogs. Optional.
key	The key to get info from. Each catalog can contain multiple keys. Optional.
limit	The limitation of items each query can fetch, not greater than the configured value of api_limit_get_storage_info. Optional.
start_id	Start ID of stored object, fetch objects whose IDs are greater than or equal to this ID

Note

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.
If account_name_or_id is specified but cannot be tied to an account, an error will be returned.
limit can be omitted or be null, if so the configured value of api_limit_get_storage_info will be used.
start_id can be omitted or be null, if so the API will return the "first page" of objects.
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 1022 of file api.cpp.

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