GetterFunction.md

Functions

getPlanData(providerAddress, planIndex) ⇒ Promise.<(PlanFetched|Failed)>

Getting Plan Data of a provider

checkSubscription(userAddress, providerAddress, planIndex) ⇒ Promise.<(BooleanResult|Failed)>

Check if the given user has a valid active subscription in the given plan index.

checkSubscriptionWithUsername(username-, providerAddress, planIndex) ⇒ Promise.<(BooleanResult|Failed)>

Check if the given user has a valid active subscription in the given plan index.

retrieveWholeDataWithUsername(username, password) ⇒ Promise.<(SubscriptionFetched|Failed)>

Retrieving Whole Subscription Data With Password of SubsCrypt dashboard

retrieveDataWithUsername(username, providerAddress, password) ⇒ Promise.<(SubscriptionFetched|Failed)>

Retrieving Subscription Data to given provider With Password

retrieveDataWithWallet(sender, providerAddress) ⇒ Promise.<(SubscriptionFetched|Failed)>

Retrieving Subscription Data to given provider With wallet

retrieveWholeDataWithWallet(sender) ⇒ Promise.<(SubscriptionFetched|Failed)>

Retrieving whole Subscription Data With wallet

userCheckAuth(userAddress, password) ⇒ Promise.<(BooleanResult|Failed)>

Check password of user for SubsCrypt Dashboard

providerCheckAuth(providerAddress, password) ⇒ Promise.<(BooleanResult|Failed)>

Check password of provider for SubsCrypt Dashboard

providerCheckAuthWithUsername(providerUsername, password) ⇒ Promise.<(BooleanResult|Failed)>

Check password of provider for SubsCrypt Dashboard with username

userCheckAuthWithUsername(username, password) ⇒ Promise.<(BooleanResult|Failed)>

Check password of user for SubsCrypt Dashboard with username

checkAuth(userAddress, providerAddress, password) ⇒ Promise.<(BooleanResult|Failed)>

Check password of user for given provider with wallet

checkAuthWithUsername(username, providerAddress, password) ⇒ Promise.<(BooleanResult|Failed)>

Check password of user for given provider with username

getSha2(anyString) ⇒ Promise.<(HashResult|Failed)>

Getting sha2 of string

getPlanCharacteristics(providerAddress, planIndex) ⇒ Promise.<(CharacteristicsFetched|Failed)>

Getting plan Characteristics of given plan

isUsernameAvailable(username) ⇒ Promise.<(boolean|Failed)>

if username is available or not

getUsername(sender) ⇒ Promise.<(string|Failed)>

returns username of given address

getAddressByUsername(username) ⇒ Promise.<(Address|Failed)>

returns address of given username

getPlanLength(providerAddress) ⇒ Promise.<(number|Failed)>

returns that how many plans a provider has

Typedefs

PlanConst

SubscriptionRecord

Failed

PlanFetched

CharacteristicsFetched

HashResult

BooleanResult

SubscriptionFetched

getPlanData(providerAddress, planIndex) ⇒ Promise.<(PlanFetched|Failed)>

Getting Plan Data of a provider

Kind: global function
Returns: Promise.<(PlanFetched|Failed)> - - Return a plan data or error

Param	Type	Description
providerAddress	string	Address of Provider
planIndex	number	plan_index

checkSubscription(userAddress, providerAddress, planIndex) ⇒ Promise.<(BooleanResult|Failed)>

Check if the given user has a valid active subscription in the given plan index.

Kind: global function
Returns: Promise.<(BooleanResult|Failed)> - - Result of request

Param	Type	Description
userAddress	string	Address Of User
providerAddress	string	Address of Provider
planIndex	number	plan_index

checkSubscriptionWithUsername(username-, providerAddress, planIndex) ⇒ Promise.<(BooleanResult|Failed)>

Check if the given user has a valid active subscription in the given plan index.

Kind: global function
Returns: Promise.<(BooleanResult|Failed)> - - Result of request

Param	Type	Description
username-	string	Username
providerAddress	string	Address of Provider
planIndex	number	plan_index

retrieveWholeDataWithUsername(username, password) ⇒ Promise.<(SubscriptionFetched|Failed)>

Retrieving Whole Subscription Data With Password of SubsCrypt dashboard

Kind: global function
Returns: Promise.<(SubscriptionFetched|Failed)> - - Result of request

Param	Type	Description
username	string	Username
password	string	password

retrieveDataWithUsername(username, providerAddress, password) ⇒ Promise.<(SubscriptionFetched|Failed)>

Retrieving Subscription Data to given provider With Password

Kind: global function
Returns: Promise.<(SubscriptionFetched|Failed)> - - Result of request

Param	Type	Description
username	string	Username
providerAddress	string	Address of Provider
password	string	password

retrieveDataWithWallet(sender, providerAddress) ⇒ Promise.<(SubscriptionFetched|Failed)>

Retrieving Subscription Data to given provider With wallet

Kind: global function
Returns: Promise.<(SubscriptionFetched|Failed)> - - Result of request

Param	Type	Description
sender	string	Address of wallet
providerAddress	string	Address of Provider

retrieveWholeDataWithWallet(sender) ⇒ Promise.<(SubscriptionFetched|Failed)>

Retrieving whole Subscription Data With wallet

Kind: global function
Returns: Promise.<(SubscriptionFetched|Failed)> - - Result of request

Param	Type	Description
sender	string	Address of wallet

userCheckAuth(userAddress, password) ⇒ Promise.<(BooleanResult|Failed)>

Check password of user for SubsCrypt Dashboard

Kind: global function
Returns: Promise.<(BooleanResult|Failed)> - - Result of request

Param	Type	Description
userAddress	string	Address Of User
password	string	password

providerCheckAuth(providerAddress, password) ⇒ Promise.<(BooleanResult|Failed)>

Check password of provider for SubsCrypt Dashboard

Kind: global function
Returns: Promise.<(BooleanResult|Failed)> - - Result of request

Param	Type	Description
providerAddress	string	Address Of Provider
password	string	password

providerCheckAuthWithUsername(providerUsername, password) ⇒ Promise.<(BooleanResult|Failed)>

Check password of provider for SubsCrypt Dashboard with username

Kind: global function
Returns: Promise.<(BooleanResult|Failed)> - - Result of request

Param	Type	Description
providerUsername	string	Username of provider
password	string	password

userCheckAuthWithUsername(username, password) ⇒ Promise.<(BooleanResult|Failed)>

Check password of user for SubsCrypt Dashboard with username

Kind: global function
Returns: Promise.<(BooleanResult|Failed)> - - Result of request

Param	Type	Description
username	string	Username
password	string	password

checkAuth(userAddress, providerAddress, password) ⇒ Promise.<(BooleanResult|Failed)>

Check password of user for given provider with wallet

Kind: global function
Returns: Promise.<(BooleanResult|Failed)> - - Result of request

Param	Type	Description
userAddress	string	Address of User
providerAddress	string	Address of provider
password	string	password

checkAuthWithUsername(username, providerAddress, password) ⇒ Promise.<(BooleanResult|Failed)>

Check password of user for given provider with username

Kind: global function
Returns: Promise.<(BooleanResult|Failed)> - - Result of request

Param	Type	Description
username	string	Username
providerAddress	string	Address of provider
password	string	password

getSha2(anyString) ⇒ Promise.<(HashResult|Failed)>

Getting sha2 of string

Kind: global function
Returns: Promise.<(HashResult|Failed)> - - Result of request

Param	Type	Description
anyString	string	Any String to be hashed

getPlanCharacteristics(providerAddress, planIndex) ⇒ Promise.<(CharacteristicsFetched|Failed)>

Getting plan Characteristics of given plan

Kind: global function
Returns: Promise.<(CharacteristicsFetched|Failed)> - - Result of request

Param	Type	Description
providerAddress	string	Address of Provider
planIndex	number	plan_index

isUsernameAvailable(username) ⇒ Promise.<(boolean|Failed)>

if username is available or not

Kind: global function
Returns: Promise.<(boolean|Failed)> - - Result of request

Param	Type	Description
username	string	username

getUsername(sender) ⇒ Promise.<(string|Failed)>

returns username of given address

Kind: global function
Returns: Promise.<(string|Failed)> - - Result of request

Param	Type	Description
sender	string	Address of user

getAddressByUsername(username) ⇒ Promise.<(Address|Failed)>

returns address of given username

Kind: global function
Returns: Promise.<(Address|Failed)> - - Result of request

Param	Type	Description
username	string	Username

getPlanLength(providerAddress) ⇒ Promise.<(number|Failed)>

returns that how many plans a provider has

Kind: global function
Returns: Promise.<(number|Failed)> - - Result of request

Param	Type	Description
providerAddress	string	Address of Provider

PlanConst

Kind: global typedef
Properties

Name	Type
duration	number
price	number
max_refund_permille	number
disabled	bool

SubscriptionRecord

Kind: global typedef
Properties

Name	Type
provider	string
plan	PlanConst
plan_index	number
subscription_time	number
characteristics_values_encrypted	Array.<string>
refunded	bool

Failed

Kind: global typedef
Properties

Name	Type	Description
status	string	Status of request("Failed") in this case
result	*	Debug Data

PlanFetched

Kind: global typedef
Properties

Name	Type	Description
status	string	Status of request("Fetched") in this case
result	PlanConst	Plan Const data

CharacteristicsFetched

Kind: global typedef
Properties

Name	Type	Description
status	string	Status of request("Fetched") in this case
characteristics	Array.<string>	keys of characteristics mapping of plan

HashResult

Kind: global typedef
Properties

Name	Type	Description
status	string	Status of request("Fetched") in this case
result	string	Hash of given string

BooleanResult

Kind: global typedef
Properties

Name	Type	Description
status	string	Status of request("Fetched") in this case
result	bool

SubscriptionFetched

Kind: global typedef
Properties

Name	Type	Description
status	string	Status of request("Fetched") in this case
result	Array.<SubscriptionRecord>	Array of SubscriptionRecords