DECENT
Functions
Subscription

Functions

signed_transaction subscribe_to_author (const string &from, const string &to, const string &price_amount, const string &price_asset_symbol, bool broadcast)
 Creates a subscription to author. This function is used by consumers. More...
 
signed_transaction subscribe_by_author (const string &from, const string &to, bool broadcast)
 Creates a subscription to author. This function is used by author. More...
 
signed_transaction set_subscription (const string &account, bool allow_subscription, uint32_t subscription_period, const string &price_amount, const string &price_asset_symbol, bool broadcast)
 This function can be used to allow/disallow subscription. More...
 
signed_transaction set_automatic_renewal_of_subscription (const string &account_id_or_name, subscription_id_type subscription_id, bool automatic_renewal, bool broadcast)
 This function can be used to allow/disallow automatic renewal of expired subscription. More...
 
vector< subscription_object > list_active_subscriptions_by_consumer (const string &account_id_or_name, const uint32_t count) const
 Get a list of consumer's active (not expired) subscriptions. More...
 
vector< subscription_object > list_subscriptions_by_consumer (const string &account_id_or_name, const uint32_t count) const
 Get a list of consumer's subscriptions. More...
 
vector< subscription_object > list_active_subscriptions_by_author (const string &account_id_or_name, const uint32_t count) const
 Get a list of active (not expired) subscriptions to author. More...
 
vector< subscription_object > list_subscriptions_by_author (const string &account_id_or_name, const uint32_t count) const
 Get a list of subscriptions to author. More...
 
signed_transaction graphene::wallet::wallet_api::subscribe_to_author (const string &from, const string &to, const string &price_amount, const string &price_asset_symbol, bool broadcast)
 Creates a subscription to author. This function is used by consumers. More...
 
signed_transaction graphene::wallet::wallet_api::subscribe_by_author (const string &from, const string &to, bool broadcast)
 Creates a subscription to author. This function is used by author. More...
 
signed_transaction graphene::wallet::wallet_api::set_subscription (const string &account, bool allow_subscription, uint32_t subscription_period, const string &price_amount, const string &price_asset_symbol, bool broadcast)
 This function can be used to allow/disallow subscription. More...
 
signed_transaction graphene::wallet::wallet_api::set_automatic_renewal_of_subscription (const string &account_id_or_name, subscription_id_type subscription_id, bool automatic_renewal, bool broadcast)
 This function can be used to allow/disallow automatic renewal of expired subscription. More...
 
vector< subscription_objectgraphene::wallet::wallet_api::list_active_subscriptions_by_consumer (const string &account_id_or_name, const uint32_t count) const
 Get a list of consumer's active (not expired) subscriptions. More...
 
vector< subscription_objectgraphene::wallet::wallet_api::list_subscriptions_by_consumer (const string &account_id_or_name, const uint32_t count) const
 Get a list of consumer's subscriptions. More...
 
vector< subscription_objectgraphene::wallet::wallet_api::list_active_subscriptions_by_author (const string &account_id_or_name, const uint32_t count) const
 Get a list of active (not expired) subscriptions to author. More...
 
vector< subscription_objectgraphene::wallet::wallet_api::list_subscriptions_by_author (const string &account_id_or_name, const uint32_t count) const
 Get a list of subscriptions to author. More...
 

Detailed Description

Function Documentation

◆ list_active_subscriptions_by_author() [1/2]

vector< subscription_object > list_active_subscriptions_by_author ( const string &  account_id_or_name,
const uint32_t  count 
) const

Get a list of active (not expired) subscriptions to author.

Parameters
account_id_or_namethe name or id of the author
countmaximum number of subscriptions to fetch (must not exceed 100)
Returns
list of active subscription objects corresponding to the provided author

◆ list_active_subscriptions_by_author() [2/2]

vector< subscription_object > wallet_api::list_active_subscriptions_by_author ( const string &  account_id_or_name,
const uint32_t  count 
) const

Get a list of active (not expired) subscriptions to author.

Parameters
account_id_or_namethe name or id of the author
countmaximum number of subscriptions to fetch (must not exceed 100)
Returns
list of active subscription objects corresponding to the provided author

Definition at line 49 of file wallet.cpp.

◆ list_active_subscriptions_by_consumer() [1/2]

vector< subscription_object > list_active_subscriptions_by_consumer ( const string &  account_id_or_name,
const uint32_t  count 
) const

Get a list of consumer's active (not expired) subscriptions.

Parameters
account_id_or_namethe name or id of the consumer
countmaximum number of subscriptions to fetch (must not exceed 100)
Returns
list of active subscription objects corresponding to the provided consumer

◆ list_active_subscriptions_by_consumer() [2/2]

vector< subscription_object > wallet_api::list_active_subscriptions_by_consumer ( const string &  account_id_or_name,
const uint32_t  count 
) const

Get a list of consumer's active (not expired) subscriptions.

Parameters
account_id_or_namethe name or id of the consumer
countmaximum number of subscriptions to fetch (must not exceed 100)
Returns
list of active subscription objects corresponding to the provided consumer

Definition at line 37 of file wallet.cpp.

◆ list_subscriptions_by_author() [1/2]

vector< subscription_object > list_subscriptions_by_author ( const string &  account_id_or_name,
const uint32_t  count 
) const

Get a list of subscriptions to author.

Parameters
account_id_or_namethe name or id of the author
countmaximum number of subscriptions to fetch (must not exceed 100)
Returns
list of subscription objects corresponding to the provided author

◆ list_subscriptions_by_author() [2/2]

vector< subscription_object > wallet_api::list_subscriptions_by_author ( const string &  account_id_or_name,
const uint32_t  count 
) const

Get a list of subscriptions to author.

Parameters
account_id_or_namethe name or id of the author
countmaximum number of subscriptions to fetch (must not exceed 100)
Returns
list of subscription objects corresponding to the provided author

Definition at line 55 of file wallet.cpp.

◆ list_subscriptions_by_consumer() [1/2]

vector< subscription_object > list_subscriptions_by_consumer ( const string &  account_id_or_name,
const uint32_t  count 
) const

Get a list of consumer's subscriptions.

Parameters
account_id_or_namethe name or id of the consumer
countmaximum number of subscriptions to fetch (must not exceed 100)
Returns
list of subscription objects corresponding to the provided consumer

◆ list_subscriptions_by_consumer() [2/2]

vector< subscription_object > wallet_api::list_subscriptions_by_consumer ( const string &  account_id_or_name,
const uint32_t  count 
) const

Get a list of consumer's subscriptions.

Parameters
account_id_or_namethe name or id of the consumer
countmaximum number of subscriptions to fetch (must not exceed 100)
Returns
list of subscription objects corresponding to the provided consumer

Definition at line 43 of file wallet.cpp.

◆ set_automatic_renewal_of_subscription() [1/2]

signed_transaction set_automatic_renewal_of_subscription ( const string &  account_id_or_name,
subscription_id_type  subscription_id,
bool  automatic_renewal,
bool  broadcast 
)

This function can be used to allow/disallow automatic renewal of expired subscription.

Parameters
account_id_or_namethe name or id of the account to update
subscription_idthe ID of the subscription.
automatic_renewaltrue if account (consumer) wants to allow automatic renewal of subscription, false otherwise
broadcasttrue if you wish to broadcast the transaction
Returns
the signed transaction allowing/disallowing renewal of the subscription

◆ set_automatic_renewal_of_subscription() [2/2]

signed_transaction wallet_api::set_automatic_renewal_of_subscription ( const string &  account_id_or_name,
subscription_id_type  subscription_id,
bool  automatic_renewal,
bool  broadcast 
)

This function can be used to allow/disallow automatic renewal of expired subscription.

Parameters
account_id_or_namethe name or id of the account to update
subscription_idthe ID of the subscription.
automatic_renewaltrue if account (consumer) wants to allow automatic renewal of subscription, false otherwise
broadcasttrue if you wish to broadcast the transaction
Returns
the signed transaction allowing/disallowing renewal of the subscription

Definition at line 29 of file wallet.cpp.

◆ set_subscription() [1/2]

signed_transaction set_subscription ( const string &  account,
bool  allow_subscription,
uint32_t  subscription_period,
const string &  price_amount,
const string &  price_asset_symbol,
bool  broadcast 
)

This function can be used to allow/disallow subscription.

Parameters
accountthe name or id of the account to update
allow_subscriptiontrue if account (author) wants to allow subscription, false otherwise
subscription_periodduration of subscription in days
price_amountprice for subscription per one subscription period
price_asset_symbolticker symbol of the asset which will be used to buy subscription
broadcasttrue if you wish to broadcast the transaction
Returns
the signed transaction updating the account

◆ set_subscription() [2/2]

signed_transaction wallet_api::set_subscription ( const string &  account,
bool  allow_subscription,
uint32_t  subscription_period,
const string &  price_amount,
const string &  price_asset_symbol,
bool  broadcast 
)

This function can be used to allow/disallow subscription.

Parameters
accountthe name or id of the account to update
allow_subscriptiontrue if account (author) wants to allow subscription, false otherwise
subscription_periodduration of subscription in days
price_amountprice for subscription per one subscription period
price_asset_symbolticker symbol of the asset which will be used to buy subscription
broadcasttrue if you wish to broadcast the transaction
Returns
the signed transaction updating the account

Definition at line 19 of file wallet.cpp.

◆ subscribe_by_author() [1/2]

signed_transaction subscribe_by_author ( const string &  from,
const string &  to,
bool  broadcast 
)

Creates a subscription to author. This function is used by author.

Parameters
fromthe account obtaining subscription from the author
tothe name or id of the author
broadcasttrue if you wish to broadcast the transaction
Returns
the signed transaction subscribing the consumer to the author

◆ subscribe_by_author() [2/2]

signed_transaction wallet_api::subscribe_by_author ( const string &  from,
const string &  to,
bool  broadcast 
)

Creates a subscription to author. This function is used by author.

Parameters
fromthe account obtaining subscription from the author
tothe name or id of the author
broadcasttrue if you wish to broadcast the transaction
Returns
the signed transaction subscribing the consumer to the author

Definition at line 12 of file wallet.cpp.

◆ subscribe_to_author() [1/2]

signed_transaction subscribe_to_author ( const string &  from,
const string &  to,
const string &  price_amount,
const string &  price_asset_symbol,
bool  broadcast 
)

Creates a subscription to author. This function is used by consumers.

Parameters
fromaccount who wants subscription to author
tothe author you wish to subscribe to
price_amountprice for the subscription
price_asset_symbolticker symbol of the asset which will be used to buy subscription
broadcasttrue if you wish to broadcast the transaction
Returns
the signed transaction subscribing the consumer to the author

◆ subscribe_to_author() [2/2]

signed_transaction wallet_api::subscribe_to_author ( const string &  from,
const string &  to,
const string &  price_amount,
const string &  price_asset_symbol,
bool  broadcast 
)

Creates a subscription to author. This function is used by consumers.

Parameters
fromaccount who wants subscription to author
tothe author you wish to subscribe to
price_amountprice for the subscription
price_asset_symbolticker symbol of the asset which will be used to buy subscription
broadcasttrue if you wish to broadcast the transaction
Returns
the signed transaction subscribing the consumer to the author

Definition at line 3 of file wallet.cpp.