Advertising

Wallet Advertising API. More...

Functions
std::vector< budget_api_obj >	scorum::wallet::wallet_api::list_my_budgets ()
std::set< std::string >	scorum::wallet::wallet_api::list_post_budget_owners (const std::string &lowerbound, uint32_t limit)
std::set< std::string >	scorum::wallet::wallet_api::list_banner_budget_owners (const std::string &lowerbound, uint32_t limit)
std::vector< budget_api_obj >	scorum::wallet::wallet_api::get_post_budgets (const std::string &account_name)
std::vector< budget_api_obj >	scorum::wallet::wallet_api::get_banner_budgets (const std::string &account_name)
annotated_signed_transaction	scorum::wallet::wallet_api::create_budget_for_post (const std::string &owner, const uuid_type &uuid, const std::string &json_metadata, const asset &balance, const time_point_sec &start, const time_point_sec &deadline, bool broadcast)
annotated_signed_transaction	scorum::wallet::wallet_api::create_budget_for_banner (const std::string &owner, const uuid_type &uuid, const std::string &json_metadata, const asset &balance, const time_point_sec &start, const time_point_sec &deadline, bool broadcast)
annotated_signed_transaction	scorum::wallet::wallet_api::update_budget_for_banner (const std::string &owner, const uuid_type &uuid, const std::string &json_metadata, bool broadcast)
annotated_signed_transaction	scorum::wallet::wallet_api::update_budget_for_post (const std::string &owner, const uuid_type &uuid, const std::string &json_metadata, bool broadcast)
annotated_signed_transaction	scorum::wallet::wallet_api::close_budget_for_post (const uuid_type &uuid, const std::string &owner, bool broadcast)
annotated_signed_transaction	scorum::wallet::wallet_api::close_budget_for_banner (const uuid_type &uuid, const std::string &owner, bool broadcast)
annotated_signed_transaction	scorum::wallet::wallet_api::close_budget_for_post_by_moderator (const uuid_type &uuid, const std::string &moderator, bool broadcast)
annotated_signed_transaction	scorum::wallet::wallet_api::close_budget_for_banner_by_moderator (const uuid_type &uuid, const std::string &moderator, bool broadcast)

Detailed Description

Wallet Advertising API.

Function Documentation

close_budget_for_banner()

annotated_signed_transaction scorum::wallet::wallet_api::close_budget_for_banner	(	const uuid_type &	uuid,
		const std::string &	owner,
		bool	broadcast
	)

Closing the budget (for BANNER type). The budget rest is returned to the owner's account

Parameters

uuid
owner
broadcast

Definition at line 2698 of file wallet.cpp.

close_budget_for_banner_by_moderator()

annotated_signed_transaction scorum::wallet::wallet_api::close_budget_for_banner_by_moderator	(	const uuid_type &	uuid,
		const std::string &	moderator,
		bool	broadcast
	)

Closing the budget (for BANNER type). The budget rest is returned to the owner's account

Parameters

uuid
moderator
broadcast

Definition at line 2734 of file wallet.cpp.

close_budget_for_post()

annotated_signed_transaction scorum::wallet::wallet_api::close_budget_for_post	(	const uuid_type &	uuid,
		const std::string &	owner,
		bool	broadcast
	)

Closing the budget (for POST type). The budget rest is returned to the owner's account

Parameters

uuid
owner
broadcast

Definition at line 2680 of file wallet.cpp.

close_budget_for_post_by_moderator()

annotated_signed_transaction scorum::wallet::wallet_api::close_budget_for_post_by_moderator	(	const uuid_type &	uuid,
		const std::string &	moderator,
		bool	broadcast
	)

Closing the budget (for POST type). The budget rest is returned to the owner's account

Parameters

uuid
moderator
broadcast

Definition at line 2715 of file wallet.cpp.

create_budget_for_banner()

annotated_signed_transaction scorum::wallet::wallet_api::create_budget_for_banner	(	const std::string &	owner,
		const uuid_type &	uuid,
		const std::string &	json_metadata,
		const asset &	balance,
		const time_point_sec &	start,
		const time_point_sec &	deadline,
		bool	broadcast
	)

This method will create new budget (for BANNER type) linked to owner account.

Warning

The owner account must have sufficient balance for budget

Parameters

owner	the futrue owner of creating budget
uuid	budget uuid
json_metadata	the budget target identity (post or other)
balance
start	the time to start allocation cash from budget
deadline	the deadline time to close budget (even if there is rest of balance)
broadcast	true if you wish to broadcast the transaction

Definition at line 2618 of file wallet.cpp.

create_budget_for_post()

annotated_signed_transaction scorum::wallet::wallet_api::create_budget_for_post	(	const std::string &	owner,
		const uuid_type &	uuid,
		const std::string &	json_metadata,
		const asset &	balance,
		const time_point_sec &	start,
		const time_point_sec &	deadline,
		bool	broadcast
	)

This method will create new budget (for POST type) linked to owner account.

Warning

The owner account must have sufficient balance for budget

Parameters

owner	the futrue owner of creating budget
uuid	budget uuid
json_metadata	the budget target identity (post or other)
balance
start	the time to start allocation cash from budget
deadline	the deadline time to close budget (even if there is rest of balance)
broadcast	true if you wish to broadcast the transaction

Definition at line 2591 of file wallet.cpp.

get_banner_budgets()

std::vector< budget_api_obj > scorum::wallet::wallet_api::get_banner_budgets

(

const std::string &

account_name

)

Gets the budget (for BANNER type) information for certain account

Parameters

account_name

Returns

std::vector<budget_api_obj>

Definition at line 2584 of file wallet.cpp.

get_post_budgets()

std::vector< budget_api_obj > scorum::wallet::wallet_api::get_post_budgets

(

const std::string &

account_name

)

Gets the budget (for POST type) information for certain account

Parameters

account_name

Returns

std::vector<budget_api_obj>

Definition at line 2577 of file wallet.cpp.

list_banner_budget_owners()

std::set< std::string > scorum::wallet::wallet_api::list_banner_budget_owners	(	const std::string &	lowerbound,
		uint32_t	limit
	)

Gets the list of all budget (for BANNER type) owners (look list_accounts to understand input parameters)

Parameters

lowerbound
limit

Returns

std::set<std::string>

Definition at line 2572 of file wallet.cpp.

list_my_budgets()

std::vector< budget_api_obj > scorum::wallet::wallet_api::list_my_budgets

(

)

Gets the budget information for all my budgets (list_my_accounts)

Returns

std::vector<budget_api_obj>

Definition at line 2535 of file wallet.cpp.

list_post_budget_owners()

std::set< std::string > scorum::wallet::wallet_api::list_post_budget_owners	(	const std::string &	lowerbound,
		uint32_t	limit
	)

Gets the list of all budget (for POST type) owners (look list_accounts to understand input parameters)

Parameters

lowerbound
limit

Returns

std::set<std::string>

Definition at line 2567 of file wallet.cpp.

update_budget_for_banner()

annotated_signed_transaction scorum::wallet::wallet_api::update_budget_for_banner	(	const std::string &	owner,
		const uuid_type &	uuid,
		const std::string &	json_metadata,
		bool	broadcast
	)

This method will update budget metadata for banner by owner name and budget uuid

Parameters

owner	account name
uuid	budget uuid
json_metadata	some metadata
broadcast	true if you wish to broadcast the transaction

Definition at line 2661 of file wallet.cpp.

update_budget_for_post()

annotated_signed_transaction scorum::wallet::wallet_api::update_budget_for_post	(	const std::string &	owner,
		const uuid_type &	uuid,
		const std::string &	json_metadata,
		bool	broadcast
	)

This method will update budget metadata for post by owner name and budget uuid

Parameters

owner	account name
uuid	budget uuid
json_metadata	some metadata
broadcast	true if you wish to broadcast the transaction

Definition at line 2670 of file wallet.cpp.