Description
Provides convenient way to call PDS server API of edzLabs.com's PDS service.
Full API reference is located at app.dase.io
Examples
var CONN = require("dsd-client-conn-lib");
var dsdConn = CONN.connClient2;
var dsdCst = CONN.Consts;
function log(title, msg) {
console.log(title, msg ? msg : "");
}
log("sendSilver should success");
dsdConn.getCoreClient().sendSilver({
senderId: "0x003e8c791cb39b4cad756b9c25431d6eb3fed85c",
senderPassword: "12345678",
silverAmount: 100,
toUserId: "0xb35ef3e31f2944d252eda42801caf5d890d1d7f9"
}).then(
ok => { log("sendSilver ok: ", ok); },
err => { log("sendSilver err: ", err); }
);
log("sendSilver2 should error");
dsdConn.getDaseClient().sendSilver({
senderId: "0x003e8c791cb39b4cad756b9c25431d6eb3fed85c",
senderPassword: "12345678",
toUserId: "0xb35ef3e31f2944d252eda42801caf5d890d1d7f9"
}).then(
ok => { log("sendSilver2 ok: ", ok); },
err => {
log("sendSilver2 err: ", err);
*specify error handlers if necessary
if(err.code === dsdCst.errorCodes.WrongParametersCount.id) {
log("I have wrong parameters count..."+dsdCst.errorCodes.WrongParametersCount.name);
*do something
}
else if(err.code === dsdCst.errorCodes.ServerSideError.id) {
log("I have server error..."+ dsdCst.errorCodes.ServerSideError.name);
*do something
}
}
);
console.log("addDab should success");
dsdConn.getPdsClient().addDab({
ownerId: "0x003e8c791cb39b4cad756b9c25431d6eb3fed85c",
assetUrl: "http:*localhost",
ownerPassword: "12345678",
publicDescription: "new client lib asset"
}).then(
ok => { log("addDab ok: ", ok); },
err => { log("addDab err: ", err); }
);
API reference
Core API methods here
DASE API methods here
PDS API methods here
Keychain API methods here
CORE API methods
(Back)
Functions
- newUser(password) ⇒
Keys
Description:
Method newUser
- newUser_Public(password) ⇒
Keys
Description:
Method newUser_Public
- getKeys(userId, password) ⇒
Keys
Description:
Method getKeys
- getKeys_Public(userId, password) ⇒
Keys
Description:
Method getKeys_Public
- sendWeis_Public(sender, senderPassword, receiver, weiAmount, databytes) ⇒
Transaction
Description:
Method sendWeis_Public
- getSilverBalance(userId) ⇒
Integer
Description:
Method getSilverBalance
- getAddressByPubKey(pubKey) ⇒
Address
Description:
Method getAddressByPubKey
- getSystemAccounts() ⇒
Object
Description:
Method getSystemAccounts
- getGoldBalance_Public(userId) ⇒
Integer
Description:
Method getGoldBalance_Public
- transferOut(srcUserId, password, destUserId, amount) ⇒
Transaction
Description:
Method transferOut
- transferOut_Public(srcUserId, password, destUserId, amount) ⇒
Transaction
Description:
Method transferOut_Public
- getBalanceWeis_Public(userId) ⇒
Integer
Description:
Method getBalanceWeis_Public
- buyGoldForWeis_Public(userId, password, goldAmount, weisAmount) ⇒
Integer
Description:
Method buyGoldForWeis_Public
- weisAmountForGold_Public(userId, goldAmount) ⇒
Integer
Description:
Method weisAmountForGold_Public
- getEventsCore(userId, pos, size, filterName, relation) ⇒
Event
Description:
Method getEventsCore
- getEventsCore_Public(userId, pos, size, filterName, relation) ⇒
Event
Description:
Method getEventsCore_Public
- getLastBlock() ⇒
Integer
Description:
Method getLastBlock
- getLastBlock_Public() ⇒
Integer
Description:
Method getLastBlock_Public
- silverCostInGold(userId, silverAmount) ⇒
Integer
Description:
Method silverCostInGold
- goldCostInSilver_Public(userId, goldAmount) ⇒
Integer
Description:
Method goldCostInSilver_Public
- approveUserToSpendMySilver(fromUserId, password, silverAmount, toUserId) ⇒
Transaction
Description:
Method approveUserToSpendMySilver
- approveTreasuryToSpendMySilver(fromUserId, password, silverAmount) ⇒
Transaction
Description:
Method approveTreasuryToSpendMySilver
- sendSilver(senderId, senderPassword, silverAmount, toUserId) ⇒
Transaction
Description:
Method sendSilver
- sendGold_Public(senderId, senderPassword, goldAmount, toUserId) ⇒
Transaction
Description:
Method sendGold_Public
- spendAlienSilver(spenderId, password, fromUserId, silverAmount, toUserId) ⇒
Transaction
Description:
Method spendAlienSilver
- isValidUser(account, password) ⇒
Boolean
Description:
Method isValidUser
- isValidUser_Public(account, password) ⇒
Boolean
Description:
Method isValidUser_Public
- getEligibilityValue(userId) ⇒
Integer
Description:
Method getEligibilityValue
- wantVote(userId, userPassword, iWish) ⇒
Transaction
Description:
Method wantVote
- getVoteRewardInSilver(userId) ⇒
Integer
Description:
Method getVoteRewardInSilver
- getVoteCostInSilver(userId) ⇒
Integer
Description:
Method getVoteCostInSilver
- getContractVoters(userId) ⇒
Address
Description:
Method getContractVoters
- getQuorumVoters() ⇒
Address
Description:
Method getQuorumVoters
- getCandidatesPool(userId) ⇒
Address
Description:
Method getCandidatesPool
- isInCandidatesPool(userId) ⇒
Boolean
Description:
Method isInCandidatesPool
- hasPledge(userId) ⇒
Boolean
Description:
Method hasPledge
- isLicensedForVoting(userId) ⇒
Boolean
Description:
Method isLicensedForVoting
- getMyCoinbase() ⇒
Address
Description:
Method getMyCoinbase
- withdrawPledge(userId, userPassword) ⇒
Transaction
Description:
Method withdrawPledge
- offerBuyVoting(userId, userPassword, silverAmount) ⇒
Transaction
Description:
Method offerBuyVoting
- offerExchangeGoldForWeis(seller, sellerPassword, buyer, goldAmount, weisAmount) ⇒
Boolean
Description:
Method offerExchangeGoldForWeis
- offerExchangeWeisForGold(seller, sellerPassword, buyer, goldAmount, weisAmount) ⇒
Boolean
Description:
Method offerExchangeWeisForGold
- recallExchangeOffer(seller, sellerPassword, offerId) ⇒
Boolean
Description:
Method recallExchangeOffer
- getExchangeOffer(userId, offerId) ⇒
Object
Description:
Method getExchangeOffer
- getExchangeOffers(userId, offersIds) ⇒
Object
Description:
Method getExchangeOffers
- acceptExchangeGoldForWeisOffer(buyer, buyerPassword, offerId, goldAmount) ⇒
Boolean
Description:
Method acceptExchangeGoldForWeisOffer
- acceptExchangeWeisForGoldOffer(buyer, buyerPassword, offerId, weisAmount) ⇒
Boolean
Description:
Method acceptExchangeWeisForGoldOffer
- declineExchangeOffer(buyer, buyerPassword, offerId) ⇒
Boolean
Description:
Method declineExchangeOffer
- getExchangeOffersIdsToMe(userId, pos, size) ⇒
Integer
Description:
Method getExchangeOffersIdsToMe
- getExchangeOffersCountFor(userId) ⇒
Integer
Description:
Method getExchangeOffersCountFor
- getExchangePurchaseHistory(userId, startBlock) ⇒
Event
Description:
Method getExchangePurchaseHistory
- getExchangeSellHistory(userId, startBlock) ⇒
Event
Description:
Method getExchangeSellHistory
- sendMessageSecured(userId, userPassword, cipherText) ⇒
Transaction
Description:
Method sendMessageSecured
- getMessageSecured(userId, messageId) ⇒
BytesArray
Description:
Method getMessageSecured
- getMessagesSecuredCount(userId) ⇒
Integer
Description:
Method getMessagesSecuredCount
- getLastReadMessageIndex(userId) ⇒
Integer
Description:
Method getLastReadMessageIndex
- setAttributeSecured(userId, userPassword, attrId, cipherText) ⇒
Transaction
Description:
Method setAttributeSecured
- getAttributeSecured(userId, attrId) ⇒
BytesArray
Description:
Method getAttributeSecured
newUser(password) ⇒ Keys
Description:
Method newUser
Kind: global function
Returns: Keys
- Look at Type description in Docs.
newUser_Public(password) ⇒ Keys
Description:
Method newUser_Public
Kind: global function
Returns: Keys
- Look at Type description in Docs.
getKeys(userId, password) ⇒ Keys
Description:
Method getKeys
Kind: global function
Returns: Keys
- Look at Type description in Docs.
Param | Type |
---|
userId | Address |
password | String |
getKeys_Public(userId, password) ⇒ Keys
Description:
Method getKeys_Public
Kind: global function
Returns: Keys
- Look at Type description in Docs.
Param | Type |
---|
userId | Address |
password | String |
sendWeis_Public(sender, senderPassword, receiver, weiAmount, databytes) ⇒ Transaction
Description:
Method sendWeis_Public
Kind: global function
Returns: Transaction
- Look at Type description in Docs.
Param | Type |
---|
sender | Address |
senderPassword | String |
receiver | Address |
weiAmount | Integer |
databytes | String |
getSilverBalance(userId) ⇒ Integer
Description:
Method getSilverBalance
Kind: global function
getAddressByPubKey(pubKey) ⇒ Address
Description:
Method getAddressByPubKey
Kind: global function
getSystemAccounts() ⇒ Object
Description:
Method getSystemAccounts
Kind: global function
getGoldBalance_Public(userId) ⇒ Integer
Description:
Method getGoldBalance_Public
Kind: global function
transferOut(srcUserId, password, destUserId, amount) ⇒ Transaction
Description:
Method transferOut
Kind: global function
Returns: Transaction
- Look at Type description in Docs.
Param | Type |
---|
srcUserId | Address |
password | String |
destUserId | Address |
amount | Integer |
transferOut_Public(srcUserId, password, destUserId, amount) ⇒ Transaction
Description:
Method transferOut_Public
Kind: global function
Returns: Transaction
- Look at Type description in Docs.
Param | Type |
---|
srcUserId | Address |
password | String |
destUserId | Address |
amount | Integer |
getBalanceWeis_Public(userId) ⇒ Integer
Description:
Method getBalanceWeis_Public
Kind: global function
buyGoldForWeis_Public(userId, password, goldAmount, weisAmount) ⇒ Integer
Description:
Method buyGoldForWeis_Public
Kind: global function
Param | Type |
---|
userId | Address |
password | String |
goldAmount | Integer |
weisAmount | Integer |
weisAmountForGold_Public(userId, goldAmount) ⇒ Integer
Description:
Method weisAmountForGold_Public
Kind: global function
Param | Type |
---|
userId | Address |
goldAmount | Integer |
getEventsCore(userId, pos, size, filterName, relation) ⇒ Event
Description:
Method getEventsCore
Kind: global function
Returns: Event
- - Array of Look at Type description in Docs.
Param | Type | Description |
---|
userId | Address | |
pos | Integer | (optional. default: 0) |
size | Integer | (optional. default: 10) |
filterName | String | |
relation | Object | Look at Constants description in Docs. |
getEventsCore_Public(userId, pos, size, filterName, relation) ⇒ Event
Description:
Method getEventsCore_Public
Kind: global function
Returns: Event
- - Array of Look at Type description in Docs.
Param | Type | Description |
---|
userId | Address | |
pos | Integer | (optional. default: 0) |
size | Integer | (optional. default: 10) |
filterName | String | |
relation | Object | Look at Constants description in Docs. |
getLastBlock() ⇒ Integer
Description:
Method getLastBlock
Kind: global function
getLastBlock_Public() ⇒ Integer
Description:
Method getLastBlock_Public
Kind: global function
silverCostInGold(userId, silverAmount) ⇒ Integer
Description:
Method silverCostInGold
Kind: global function
Param | Type |
---|
userId | Address |
silverAmount | Integer |
goldCostInSilver_Public(userId, goldAmount) ⇒ Integer
Description:
Method goldCostInSilver_Public
Kind: global function
Param | Type |
---|
userId | Address |
goldAmount | Integer |
approveUserToSpendMySilver(fromUserId, password, silverAmount, toUserId) ⇒ Transaction
Description:
Method approveUserToSpendMySilver
Kind: global function
Returns: Transaction
- Look at Type description in Docs.
Param | Type |
---|
fromUserId | Address |
password | String |
silverAmount | Integer |
toUserId | Address |
approveTreasuryToSpendMySilver(fromUserId, password, silverAmount) ⇒ Transaction
Description:
Method approveTreasuryToSpendMySilver
Kind: global function
Returns: Transaction
- Look at Type description in Docs.
Param | Type |
---|
fromUserId | Address |
password | String |
silverAmount | Integer |
sendSilver(senderId, senderPassword, silverAmount, toUserId) ⇒ Transaction
Description:
Method sendSilver
Kind: global function
Returns: Transaction
- Look at Type description in Docs.
Param | Type |
---|
senderId | Address |
senderPassword | String |
silverAmount | Integer |
toUserId | Address |
sendGold_Public(senderId, senderPassword, goldAmount, toUserId) ⇒ Transaction
Description:
Method sendGold_Public
Kind: global function
Returns: Transaction
- Look at Type description in Docs.
Param | Type |
---|
senderId | Address |
senderPassword | String |
goldAmount | Integer |
toUserId | Address |
spendAlienSilver(spenderId, password, fromUserId, silverAmount, toUserId) ⇒ Transaction
Description:
Method spendAlienSilver
Kind: global function
Returns: Transaction
- Look at Type description in Docs.
Param | Type |
---|
spenderId | Address |
password | String |
fromUserId | Address |
silverAmount | Integer |
toUserId | Address |
isValidUser(account, password) ⇒ Boolean
Description:
Method isValidUser
Kind: global function
Param | Type |
---|
account | Address |
password | String |
isValidUser_Public(account, password) ⇒ Boolean
Description:
Method isValidUser_Public
Kind: global function
Param | Type |
---|
account | Address |
password | String |
getEligibilityValue(userId) ⇒ Integer
Description:
Method getEligibilityValue
Kind: global function
wantVote(userId, userPassword, iWish) ⇒ Transaction
Description:
Method wantVote
Kind: global function
Returns: Transaction
- Look at Type description in Docs.
Param | Type |
---|
userId | Address |
userPassword | String |
iWish | Boolean |
getVoteRewardInSilver(userId) ⇒ Integer
Description:
Method getVoteRewardInSilver
Kind: global function
getVoteCostInSilver(userId) ⇒ Integer
Description:
Method getVoteCostInSilver
Kind: global function
getContractVoters(userId) ⇒ Address
Description:
Method getContractVoters
Kind: global function
Returns: Address
- - Array of
getQuorumVoters() ⇒ Address
Description:
Method getQuorumVoters
Kind: global function
Returns: Address
- - Array of
getCandidatesPool(userId) ⇒ Address
Description:
Method getCandidatesPool
Kind: global function
Returns: Address
- - Array of
isInCandidatesPool(userId) ⇒ Boolean
Description:
Method isInCandidatesPool
Kind: global function
hasPledge(userId) ⇒ Boolean
Description:
Method hasPledge
Kind: global function
isLicensedForVoting(userId) ⇒ Boolean
Description:
Method isLicensedForVoting
Kind: global function
getMyCoinbase() ⇒ Address
Description:
Method getMyCoinbase
Kind: global function
withdrawPledge(userId, userPassword) ⇒ Transaction
Description:
Method withdrawPledge
Kind: global function
Returns: Transaction
- Look at Type description in Docs.
Param | Type |
---|
userId | Address |
userPassword | String |
offerBuyVoting(userId, userPassword, silverAmount) ⇒ Transaction
Description:
Method offerBuyVoting
Kind: global function
Returns: Transaction
- Look at Type description in Docs.
Param | Type |
---|
userId | Address |
userPassword | String |
silverAmount | Integer |
offerExchangeGoldForWeis(seller, sellerPassword, buyer, goldAmount, weisAmount) ⇒ Boolean
Description:
Method offerExchangeGoldForWeis
Kind: global function
Param | Type |
---|
seller | Address |
sellerPassword | String |
buyer | Address |
goldAmount | Integer |
weisAmount | Integer |
offerExchangeWeisForGold(seller, sellerPassword, buyer, goldAmount, weisAmount) ⇒ Boolean
Description:
Method offerExchangeWeisForGold
Kind: global function
Param | Type |
---|
seller | Address |
sellerPassword | String |
buyer | Address |
goldAmount | Integer |
weisAmount | Integer |
recallExchangeOffer(seller, sellerPassword, offerId) ⇒ Boolean
Description:
Method recallExchangeOffer
Kind: global function
Param | Type |
---|
seller | Address |
sellerPassword | String |
offerId | Integer |
getExchangeOffer(userId, offerId) ⇒ Object
Description:
Method getExchangeOffer
Kind: global function
Param | Type |
---|
userId | Address |
offerId | Integer |
getExchangeOffers(userId, offersIds) ⇒ Object
Description:
Method getExchangeOffers
Kind: global function
Returns: Object
- - Array of
Param | Type |
---|
userId | Address |
offersIds | Integer |
acceptExchangeGoldForWeisOffer(buyer, buyerPassword, offerId, goldAmount) ⇒ Boolean
Description:
Method acceptExchangeGoldForWeisOffer
Kind: global function
Param | Type |
---|
buyer | Address |
buyerPassword | String |
offerId | Integer |
goldAmount | Integer |
acceptExchangeWeisForGoldOffer(buyer, buyerPassword, offerId, weisAmount) ⇒ Boolean
Description:
Method acceptExchangeWeisForGoldOffer
Kind: global function
Param | Type |
---|
buyer | Address |
buyerPassword | String |
offerId | Integer |
weisAmount | Integer |
declineExchangeOffer(buyer, buyerPassword, offerId) ⇒ Boolean
Description:
Method declineExchangeOffer
Kind: global function
Param | Type |
---|
buyer | Address |
buyerPassword | String |
offerId | Integer |
getExchangeOffersIdsToMe(userId, pos, size) ⇒ Integer
Description:
Method getExchangeOffersIdsToMe
Kind: global function
Returns: Integer
- - Array of
Param | Type | Description |
---|
userId | Address | |
pos | Integer | (optional. default: 0) |
size | Integer | (optional. default: 10) |
getExchangeOffersCountFor(userId) ⇒ Integer
Description:
Method getExchangeOffersCountFor
Kind: global function
getExchangePurchaseHistory(userId, startBlock) ⇒ Event
Description:
Method getExchangePurchaseHistory
Kind: global function
Returns: Event
- - Array of Look at Type description in Docs.
Param | Type |
---|
userId | Address |
startBlock | Integer |
getExchangeSellHistory(userId, startBlock) ⇒ Event
Description:
Method getExchangeSellHistory
Kind: global function
Returns: Event
- - Array of Look at Type description in Docs.
Param | Type |
---|
userId | Address |
startBlock | Integer |
sendMessageSecured(userId, userPassword, cipherText) ⇒ Transaction
Description:
Method sendMessageSecured
Kind: global function
Returns: Transaction
- Look at Type description in Docs.
Param | Type |
---|
userId | Address |
userPassword | String |
cipherText | BytesArray |
getMessageSecured(userId, messageId) ⇒ BytesArray
Description:
Method getMessageSecured
Kind: global function
Param | Type |
---|
userId | Address |
messageId | Integer |
getMessagesSecuredCount(userId) ⇒ Integer
Description:
Method getMessagesSecuredCount
Kind: global function
getLastReadMessageIndex(userId) ⇒ Integer
Description:
Method getLastReadMessageIndex
Kind: global function
setAttributeSecured(userId, userPassword, attrId, cipherText) ⇒ Transaction
Description:
Method setAttributeSecured
Kind: global function
Returns: Transaction
- Look at Type description in Docs.
Param | Type |
---|
userId | Address |
userPassword | String |
attrId | Integer |
cipherText | BytesArray |
getAttributeSecured(userId, attrId) ⇒ BytesArray
Description:
Method getAttributeSecured
Kind: global function
Param | Type |
---|
userId | Address |
attrId | Integer |
DASE API methods
(Back)
Functions
- addDab(ownerId, ownerPassword, assetUrl, publicDescription, linkedDabId, custodians, publicityType, dataHash) ⇒
Integer
Description:
Method addDab
- addDabList(ownerId, ownerPassword, dataArr) ⇒
Integer
Description:
Method addDabList
- addTag(ownerId, ownerPassword, publicDescription, custodians, title, encryptedKey) ⇒
Integer
Description:
Method addTag
- getTagsIdsForDab(dabId, requestor) ⇒
Integer
Description:
Method getTagsIdsForDab
- getOwnedDabsIds(userId) ⇒
Integer
Description:
Method getOwnedDabsIds
- getSharedDabsIds(userId) ⇒
Integer
Description:
Method getSharedDabsIds
- getCustodiedDabsIds(userId) ⇒
Integer
Description:
Method getCustodiedDabsIds
- getDabs(userId, dabIds) ⇒
Asset
Description:
Method getDabs
- getTags(userId, tagIds) ⇒
Tag
Description:
Method getTags
- getDabParentsIds(dabId, maxLength, requestor) ⇒
Integer
Description:
Method getDabParentsIds
- getTagEncryptedKey(buyer, seller, tagId) ⇒
Key
Description:
Method getTagEncryptedKey
- exploreTagRelationsPage(userId, userPassword, rootTagId, tagId, pos) ⇒
Dab
Description:
Method exploreTagRelationsPage
- getAvailableDabs(userId, dabTypeCode, licenseTypeCode, pos, size) ⇒
Dab
Description:
Method getAvailableDabs
- getAvailableLicenses(userId, dabTypeCode, licenseTypeCode, pos, size) ⇒
License
Description:
Method getAvailableLicenses
- getAvailableLicensesForDab(userId, dabId) ⇒
License
Description:
Method getAvailableLicensesForDab
- getSellOfferedLicenses(userId, dabTypeCode, licenseTypeCode, pos, size) ⇒
License
Description:
Method getSellOfferedLicenses
- getBuyOfferedLicenses(userId, dabTypeCode, licenseTypeCode, pos, size) ⇒
License
Description:
Method getBuyOfferedLicenses
- getSellOfferedLicensesForDab(userId, dabId) ⇒
License
Description:
Method getSellOfferedLicensesForDab
- getBuyOfferedLicensesForDab(userId, dabId) ⇒
License
Description:
Method getBuyOfferedLicensesForDab
- actualiseDeals(userId, userPassword, licenseTypeCode) ⇒
Boolean
Description:
Method actualiseDeals
- getEventsDase(userId, pos, size, filterName, relation) ⇒
Event
Description:
Method getEventsDase
- getDabsPage(userId, startDabId, pageSize) ⇒
Asset
Description:
Method getDabsPage
- getTagsPage(userId, startTagId, pageSize) ⇒
Tag
Description:
Method getTagsPage
- getDabsForTag(userId, tagTitle, tagId) ⇒
Asset
Description:
Method getDabsForTag
- offerSellOwnership(seller, sellerPassword, buyer, dabId, minPrice) ⇒
Boolean
Description:
Method offerSellOwnership
- offerBuyOwnership(buyer, buyerPassword, dabId, maxPrice) ⇒
Boolean
Description:
Method offerBuyOwnership
- approveOwnershipDeal(custodian, custodianPassword, buyer, dabId) ⇒
Boolean
Description:
Method approveOwnershipDeal
- offerBuyCustody(buyer, buyerPassword, dabId, maxPrice) ⇒
Boolean
Description:
Method offerBuyCustody
- offerSellCustody(seller, sellerPassword, buyer, dabId, minPrice) ⇒
Boolean
Description:
Method offerSellCustody
- approveCustodyDeal(custodian, custodianPassword, buyer, dabId) ⇒
Boolean
Description:
Method approveCustodyDeal
- offerSellAccess(seller, sellerPassword, buyerId, dabId, minPrice) ⇒
Boolean
Description:
Method offerSellAccess
- offerBuyAccess(buyer, buyerPassword, dabId, maxPrice) ⇒
Boolean
Description:
Method offerBuyAccess
- approveAccessDeal(custodian, custodianPassword, buyer, dabId) ⇒
Boolean
Description:
Method approveAccessDeal
- offerSellReshare(seller, sellerPassword, buyerId, dabId, minPrice) ⇒
Boolean
Description:
Method offerSellReshare
- offerBuyReshare(buyer, buyerPassword, dabId, maxPrice) ⇒
Boolean
Description:
Method offerBuyReshare
- approveReshareDeal(custodian, custodianPassword, buyer, dabId) ⇒
Boolean
Description:
Method approveReshareDeal
- offerSellTag(seller, sellerPassword, buyerId, dabId, minPrice, tagId) ⇒
Boolean
Description:
Method offerSellTag
- offerBuyTag(buyer, buyerPassword, dabId, maxPrice, tagId) ⇒
Boolean
Description:
Method offerBuyTag
- approveTagDeal(custodian, custodianPassword, buyer, dabId, tagId) ⇒
Boolean
Description:
Method approveTagDeal
- offerSellTagAccess(seller, sellerPassword, buyerId, dabId, minPrice) ⇒
Boolean
Description:
Method offerSellTagAccess
- offerBuyTagAccess(buyer, buyerPassword, dabId, maxPrice) ⇒
Boolean
Description:
Method offerBuyTagAccess
- approveTagAccessDeal(custodian, custodianPassword, buyer, dabId) ⇒
Boolean
Description:
Method approveTagAccessDeal
- offerSellExplore(seller, sellerPassword, buyerId, dabId, minPrice, buyerPubKeyEncryptedTagKey) ⇒
Boolean
Description:
Method offerSellExplore
- offerBuyExplore(buyer, buyerPassword, dabId, maxPrice) ⇒
Boolean
Description:
Method offerBuyExplore
- approveExploreDeal(custodian, custodianPassword, buyer, dabId) ⇒
Boolean
Description:
Method approveExploreDeal
- offerSellBulk(seller, sellerPassword, buyerId, dabId, minPrice) ⇒
Boolean
Description:
Method offerSellBulk
- offerBuyBulk(buyer, buyerPassword, dabId, maxPrice) ⇒
Boolean
Description:
Method offerBuyBulk
- approveBulkDeal(custodian, custodianPassword, buyer, dabId) ⇒
Boolean
Description:
Method approveBulkDeal
- offerSellTransitive(seller, sellerPassword, buyerId, dabId, minPrice) ⇒
Boolean
Description:
Method offerSellTransitive
- offerBuyTransitive(buyer, buyerPassword, dabId, maxPrice) ⇒
Boolean
Description:
Method offerBuyTransitive
- approveTransitiveDeal(custodian, custodianPassword, buyer, dabId) ⇒
Boolean
Description:
Method approveTransitiveDeal
- getTotalLicenseFee(licenseTypeCode) ⇒
Integer
Description:
Method getTotalLicenseFee
- trustToBuyAccess(seller, sellerPassword, buyer, dabId, minPrice) ⇒
Boolean
Description:
Method trustToBuyAccess
- trustToBuyOwnership(seller, sellerPassword, buyer, dabId, minPrice) ⇒
Boolean
Description:
Method trustToBuyOwnership
- untrustToBuyAccess(seller, sellerPassword, buyer, dabId) ⇒
Boolean
Description:
Method untrustToBuyAccess
- untrustToBuyOwnership(seller, sellerPassword, buyer, dabId) ⇒
Boolean
Description:
Method untrustToBuyOwnership
- getDealsForDab(userId, dabId) ⇒
Deal
Description:
Method getDealsForDab
- addRelation(userId, userPassword, licenseTypeCode, fromDabId, toDabId) ⇒
Boolean
Description:
Method addRelation
- isHierarchicalChildOf(userId, parentDabId, dabId) ⇒
Boolean
Description:
Method isHierarchicalChildOf
- checkUserPrvPayment(msgId, userId, userPassword, userToCheck, zetonsAmount) ⇒
Integer
Description:
Method checkUserPrvPayment
- addDataSecured(userId, userPassword, dabHash, cipherText) ⇒
Integer
Description:
Method addDataSecured
- getSecuredDabsInfoPage(userId, startDabId, pageSize) ⇒
BytesArray
Description:
Method getSecuredDabsInfoPage
- getSecuredDabsInfo(userId, dabsIds) ⇒
BytesArray
Description:
Method getSecuredDabsInfo
- listSecuredOwnedDabs(userId) ⇒
BytesArray
Description:
Method listSecuredOwnedDabs
- listSecuredSharedDabs(userId) ⇒
BytesArray
Description:
Method listSecuredSharedDabs
- listSecuredCustodiedDabs(userId) ⇒
BytesArray
Description:
Method listSecuredCustodiedDabs
- getSecuredDabsInfo(userId, dabsIds) ⇒
BytesArray
Description:
Method getSecuredDabsInfo
- payBill(userId, userPassword, price, signature, seller) ⇒
Integer
Description:
Method payBill
addDab(ownerId, ownerPassword, assetUrl, publicDescription, linkedDabId, custodians, publicityType, dataHash) ⇒ Integer
Description:
Method addDab
Kind: global function
Param | Type | Description |
---|
ownerId | Address | |
ownerPassword | String | |
assetUrl | String | |
publicDescription | String | |
linkedDabId | Integer | (optional. default: 0) |
custodians | Address | (optional. default: []) - Array of |
publicityType | Integer | (optional. default: 0) Look at Constants description in Docs. |
dataHash | Integer | (optional. default: 0) |
addDabList(ownerId, ownerPassword, dataArr) ⇒ Integer
Description:
Method addDabList
Kind: global function
Returns: Integer
- - Array of
Param | Type | Description |
---|
ownerId | Address | |
ownerPassword | String | |
dataArr | Object | Array of |
addTag(ownerId, ownerPassword, publicDescription, custodians, title, encryptedKey) ⇒ Integer
Description:
Method addTag
Kind: global function
Param | Type | Description |
---|
ownerId | Address | |
ownerPassword | String | |
publicDescription | String | |
custodians | Address | (optional. default: []) - Array of |
title | String | |
encryptedKey | String | (optional. default: null) |
getTagsIdsForDab(dabId, requestor) ⇒ Integer
Description:
Method getTagsIdsForDab
Kind: global function
Returns: Integer
- - Array of
Param | Type |
---|
dabId | Integer |
requestor | Address |
getOwnedDabsIds(userId) ⇒ Integer
Description:
Method getOwnedDabsIds
Kind: global function
Returns: Integer
- - Array of
getSharedDabsIds(userId) ⇒ Integer
Description:
Method getSharedDabsIds
Kind: global function
Returns: Integer
- - Array of
getCustodiedDabsIds(userId) ⇒ Integer
Description:
Method getCustodiedDabsIds
Kind: global function
Returns: Integer
- - Array of
getDabs(userId, dabIds) ⇒ Asset
Description:
Method getDabs
Kind: global function
Returns: Asset
- - Array of Look at Type description in Docs.
Param | Type | Description |
---|
userId | Address | |
dabIds | Integer | Array of |
getTags(userId, tagIds) ⇒ Tag
Description:
Method getTags
Kind: global function
Returns: Tag
- - Array of Look at Type description in Docs.
Param | Type | Description |
---|
userId | Address | |
tagIds | Integer | Array of |
getDabParentsIds(dabId, maxLength, requestor) ⇒ Integer
Description:
Method getDabParentsIds
Kind: global function
Returns: Integer
- - Array of
Param | Type |
---|
dabId | Integer |
maxLength | Integer |
requestor | Address |
getTagEncryptedKey(buyer, seller, tagId) ⇒ Key
Description:
Method getTagEncryptedKey
Kind: global function
Returns: Key
- Look at Type description in Docs.
Param | Type |
---|
buyer | Address |
seller | Address |
tagId | Integer |
exploreTagRelationsPage(userId, userPassword, rootTagId, tagId, pos) ⇒ Dab
Description:
Method exploreTagRelationsPage
Kind: global function
Returns: Dab
- - Array of Look at Type description in Docs.
Param | Type | Description |
---|
userId | Address | |
userPassword | String | |
rootTagId | Integer | |
tagId | Integer | |
pos | Integer | (optional. default: 0) |
getAvailableDabs(userId, dabTypeCode, licenseTypeCode, pos, size) ⇒ Dab
Description:
Method getAvailableDabs
Kind: global function
Returns: Dab
- - Array of Look at Type description in Docs.
Param | Type | Description |
---|
userId | Address | |
dabTypeCode | Integer | Look at Constants description in Docs. |
licenseTypeCode | Integer | Look at Constants description in Docs. |
pos | Integer | (optional. default: 0) |
size | Integer | (optional. default: 10) |
getAvailableLicenses(userId, dabTypeCode, licenseTypeCode, pos, size) ⇒ License
Description:
Method getAvailableLicenses
Kind: global function
Returns: License
- - Array of Look at Type description in Docs.
Param | Type | Description |
---|
userId | Address | |
dabTypeCode | Integer | Look at Constants description in Docs. |
licenseTypeCode | Integer | Look at Constants description in Docs. |
pos | Integer | (optional. default: 0) |
size | Integer | (optional. default: 10) |
getAvailableLicensesForDab(userId, dabId) ⇒ License
Description:
Method getAvailableLicensesForDab
Kind: global function
Returns: License
- - Array of Look at Type description in Docs.
Param | Type |
---|
userId | Address |
dabId | Integer |
getSellOfferedLicenses(userId, dabTypeCode, licenseTypeCode, pos, size) ⇒ License
Description:
Method getSellOfferedLicenses
Kind: global function
Returns: License
- - Array of Look at Type description in Docs.
Param | Type | Description |
---|
userId | Address | |
dabTypeCode | Integer | Look at Constants description in Docs. |
licenseTypeCode | Integer | Look at Constants description in Docs. |
pos | Integer | (optional. default: 0) |
size | Integer | (optional. default: 10) |
getBuyOfferedLicenses(userId, dabTypeCode, licenseTypeCode, pos, size) ⇒ License
Description:
Method getBuyOfferedLicenses
Kind: global function
Returns: License
- - Array of Look at Type description in Docs.
Param | Type | Description |
---|
userId | Address | |
dabTypeCode | Integer | Look at Constants description in Docs. |
licenseTypeCode | Integer | Look at Constants description in Docs. |
pos | Integer | (optional. default: 0) |
size | Integer | (optional. default: 10) |
getSellOfferedLicensesForDab(userId, dabId) ⇒ License
Description:
Method getSellOfferedLicensesForDab
Kind: global function
Returns: License
- - Array of Look at Type description in Docs.
Param | Type |
---|
userId | Address |
dabId | Integer |
getBuyOfferedLicensesForDab(userId, dabId) ⇒ License
Description:
Method getBuyOfferedLicensesForDab
Kind: global function
Returns: License
- - Array of Look at Type description in Docs.
Param | Type |
---|
userId | Address |
dabId | Integer |
actualiseDeals(userId, userPassword, licenseTypeCode) ⇒ Boolean
Description:
Method actualiseDeals
Kind: global function
Param | Type | Description |
---|
userId | Address | |
userPassword | String | |
licenseTypeCode | Integer | Look at Constants description in Docs. |
getEventsDase(userId, pos, size, filterName, relation) ⇒ Event
Description:
Method getEventsDase
Kind: global function
Returns: Event
- - Array of Look at Type description in Docs.
Param | Type | Description |
---|
userId | Address | |
pos | Integer | (optional. default: 0) |
size | Integer | (optional. default: 10) |
filterName | String | |
relation | Object | Look at Constants description in Docs. |
getDabsPage(userId, startDabId, pageSize) ⇒ Asset
Description:
Method getDabsPage
Kind: global function
Returns: Asset
- - Array of Look at Type description in Docs.
Param | Type | Description |
---|
userId | Address | |
startDabId | Integer | (optional. default: 0) |
pageSize | Integer | (optional. default: 10) |
getTagsPage(userId, startTagId, pageSize) ⇒ Tag
Description:
Method getTagsPage
Kind: global function
Returns: Tag
- - Array of Look at Type description in Docs.
Param | Type | Description |
---|
userId | Address | |
startTagId | Integer | (optional. default: 0) |
pageSize | Integer | (optional. default: 10) |
getDabsForTag(userId, tagTitle, tagId) ⇒ Asset
Description:
Method getDabsForTag
Kind: global function
Returns: Asset
- - Array of Look at Type description in Docs.
Param | Type | Description |
---|
userId | Address | |
tagTitle | String | (optional. default: "") |
tagId | Integer | (optional. default: null) |
offerSellOwnership(seller, sellerPassword, buyer, dabId, minPrice) ⇒ Boolean
Description:
Method offerSellOwnership
Kind: global function
Param | Type |
---|
seller | Address |
sellerPassword | String |
buyer | Address |
dabId | Integer |
minPrice | Integer |
offerBuyOwnership(buyer, buyerPassword, dabId, maxPrice) ⇒ Boolean
Description:
Method offerBuyOwnership
Kind: global function
Param | Type |
---|
buyer | Address |
buyerPassword | String |
dabId | Integer |
maxPrice | Integer |
approveOwnershipDeal(custodian, custodianPassword, buyer, dabId) ⇒ Boolean
Description:
Method approveOwnershipDeal
Kind: global function
Param | Type |
---|
custodian | Address |
custodianPassword | String |
buyer | Address |
dabId | Integer |
offerBuyCustody(buyer, buyerPassword, dabId, maxPrice) ⇒ Boolean
Description:
Method offerBuyCustody
Kind: global function
Param | Type |
---|
buyer | Address |
buyerPassword | String |
dabId | Integer |
maxPrice | Integer |
offerSellCustody(seller, sellerPassword, buyer, dabId, minPrice) ⇒ Boolean
Description:
Method offerSellCustody
Kind: global function
Param | Type |
---|
seller | Address |
sellerPassword | String |
buyer | Address |
dabId | Integer |
minPrice | Integer |
approveCustodyDeal(custodian, custodianPassword, buyer, dabId) ⇒ Boolean
Description:
Method approveCustodyDeal
Kind: global function
Param | Type |
---|
custodian | Address |
custodianPassword | String |
buyer | Address |
dabId | Integer |
offerSellAccess(seller, sellerPassword, buyerId, dabId, minPrice) ⇒ Boolean
Description:
Method offerSellAccess
Kind: global function
Param | Type |
---|
seller | Address |
sellerPassword | String |
buyerId | Address |
dabId | Integer |
minPrice | Integer |
offerBuyAccess(buyer, buyerPassword, dabId, maxPrice) ⇒ Boolean
Description:
Method offerBuyAccess
Kind: global function
Param | Type |
---|
buyer | Address |
buyerPassword | String |
dabId | Integer |
maxPrice | Integer |
approveAccessDeal(custodian, custodianPassword, buyer, dabId) ⇒ Boolean
Description:
Method approveAccessDeal
Kind: global function
Param | Type |
---|
custodian | Address |
custodianPassword | String |
buyer | Address |
dabId | Integer |
offerSellReshare(seller, sellerPassword, buyerId, dabId, minPrice) ⇒ Boolean
Description:
Method offerSellReshare
Kind: global function
Param | Type |
---|
seller | Address |
sellerPassword | String |
buyerId | Address |
dabId | Integer |
minPrice | Integer |
offerBuyReshare(buyer, buyerPassword, dabId, maxPrice) ⇒ Boolean
Description:
Method offerBuyReshare
Kind: global function
Param | Type |
---|
buyer | Address |
buyerPassword | String |
dabId | Integer |
maxPrice | Integer |
approveReshareDeal(custodian, custodianPassword, buyer, dabId) ⇒ Boolean
Description:
Method approveReshareDeal
Kind: global function
Param | Type |
---|
custodian | Address |
custodianPassword | String |
buyer | Address |
dabId | Integer |
offerSellTag(seller, sellerPassword, buyerId, dabId, minPrice, tagId) ⇒ Boolean
Description:
Method offerSellTag
Kind: global function
Returns: Boolean
- isOK
Param | Type |
---|
seller | Address |
sellerPassword | String |
buyerId | Address |
dabId | Integer |
minPrice | Integer |
tagId | Integer |
offerBuyTag(buyer, buyerPassword, dabId, maxPrice, tagId) ⇒ Boolean
Description:
Method offerBuyTag
Kind: global function
Returns: Boolean
- isOK
Param | Type |
---|
buyer | Address |
buyerPassword | String |
dabId | Integer |
maxPrice | Integer |
tagId | Integer |
approveTagDeal(custodian, custodianPassword, buyer, dabId, tagId) ⇒ Boolean
Description:
Method approveTagDeal
Kind: global function
Returns: Boolean
- isOK
Param | Type |
---|
custodian | Address |
custodianPassword | String |
buyer | Address |
dabId | Integer |
tagId | Integer |
offerSellTagAccess(seller, sellerPassword, buyerId, dabId, minPrice) ⇒ Boolean
Description:
Method offerSellTagAccess
Kind: global function
Returns: Boolean
- isOK
Param | Type |
---|
seller | Address |
sellerPassword | String |
buyerId | Address |
dabId | Integer |
minPrice | Integer |
offerBuyTagAccess(buyer, buyerPassword, dabId, maxPrice) ⇒ Boolean
Description:
Method offerBuyTagAccess
Kind: global function
Returns: Boolean
- isOK
Param | Type |
---|
buyer | Address |
buyerPassword | String |
dabId | Integer |
maxPrice | Integer |
approveTagAccessDeal(custodian, custodianPassword, buyer, dabId) ⇒ Boolean
Description:
Method approveTagAccessDeal
Kind: global function
Returns: Boolean
- isOK
Param | Type |
---|
custodian | Address |
custodianPassword | String |
buyer | Address |
dabId | Integer |
offerSellExplore(seller, sellerPassword, buyerId, dabId, minPrice, buyerPubKeyEncryptedTagKey) ⇒ Boolean
Description:
Method offerSellExplore
Kind: global function
Returns: Boolean
- isOK
Param | Type | Description |
---|
seller | Address | |
sellerPassword | String | |
buyerId | Address | |
dabId | Integer | |
minPrice | Integer | |
buyerPubKeyEncryptedTagKey | String | (optional. default: null) |
offerBuyExplore(buyer, buyerPassword, dabId, maxPrice) ⇒ Boolean
Description:
Method offerBuyExplore
Kind: global function
Returns: Boolean
- isOK
Param | Type |
---|
buyer | Address |
buyerPassword | String |
dabId | Integer |
maxPrice | Integer |
approveExploreDeal(custodian, custodianPassword, buyer, dabId) ⇒ Boolean
Description:
Method approveExploreDeal
Kind: global function
Returns: Boolean
- isOK
Param | Type |
---|
custodian | Address |
custodianPassword | String |
buyer | Address |
dabId | Integer |
offerSellBulk(seller, sellerPassword, buyerId, dabId, minPrice) ⇒ Boolean
Description:
Method offerSellBulk
Kind: global function
Returns: Boolean
- isOK
Param | Type |
---|
seller | Address |
sellerPassword | String |
buyerId | Address |
dabId | Integer |
minPrice | Integer |
offerBuyBulk(buyer, buyerPassword, dabId, maxPrice) ⇒ Boolean
Description:
Method offerBuyBulk
Kind: global function
Returns: Boolean
- isOK
Param | Type |
---|
buyer | Address |
buyerPassword | String |
dabId | Integer |
maxPrice | Integer |
approveBulkDeal(custodian, custodianPassword, buyer, dabId) ⇒ Boolean
Description:
Method approveBulkDeal
Kind: global function
Returns: Boolean
- isOK
Param | Type |
---|
custodian | Address |
custodianPassword | String |
buyer | Address |
dabId | Integer |
offerSellTransitive(seller, sellerPassword, buyerId, dabId, minPrice) ⇒ Boolean
Description:
Method offerSellTransitive
Kind: global function
Returns: Boolean
- isOK
Param | Type |
---|
seller | Address |
sellerPassword | String |
buyerId | Address |
dabId | Integer |
minPrice | Integer |
offerBuyTransitive(buyer, buyerPassword, dabId, maxPrice) ⇒ Boolean
Description:
Method offerBuyTransitive
Kind: global function
Returns: Boolean
- isOK
Param | Type |
---|
buyer | Address |
buyerPassword | String |
dabId | Integer |
maxPrice | Integer |
approveTransitiveDeal(custodian, custodianPassword, buyer, dabId) ⇒ Boolean
Description:
Method approveTransitiveDeal
Kind: global function
Returns: Boolean
- isOK
Param | Type |
---|
custodian | Address |
custodianPassword | String |
buyer | Address |
dabId | Integer |
getTotalLicenseFee(licenseTypeCode) ⇒ Integer
Description:
Method getTotalLicenseFee
Kind: global function
Param | Type | Description |
---|
licenseTypeCode | Integer | Look at Constants description in Docs. |
trustToBuyAccess(seller, sellerPassword, buyer, dabId, minPrice) ⇒ Boolean
Description:
Method trustToBuyAccess
Kind: global function
Returns: Boolean
- isOK
Param | Type |
---|
seller | Address |
sellerPassword | String |
buyer | Address |
dabId | Integer |
minPrice | Integer |
trustToBuyOwnership(seller, sellerPassword, buyer, dabId, minPrice) ⇒ Boolean
Description:
Method trustToBuyOwnership
Kind: global function
Returns: Boolean
- isOK
Param | Type |
---|
seller | Address |
sellerPassword | String |
buyer | Address |
dabId | Integer |
minPrice | Integer |
untrustToBuyAccess(seller, sellerPassword, buyer, dabId) ⇒ Boolean
Description:
Method untrustToBuyAccess
Kind: global function
Param | Type |
---|
seller | Address |
sellerPassword | String |
buyer | Address |
dabId | Integer |
untrustToBuyOwnership(seller, sellerPassword, buyer, dabId) ⇒ Boolean
Description:
Method untrustToBuyOwnership
Kind: global function
Param | Type |
---|
seller | Address |
sellerPassword | String |
buyer | Address |
dabId | Integer |
getDealsForDab(userId, dabId) ⇒ Deal
Description:
Method getDealsForDab
Kind: global function
Returns: Deal
- - Array of Look at Type description in Docs.
Param | Type |
---|
userId | Address |
dabId | Integer |
addRelation(userId, userPassword, licenseTypeCode, fromDabId, toDabId) ⇒ Boolean
Description:
Method addRelation
Kind: global function
Param | Type | Description |
---|
userId | Address | |
userPassword | String | |
licenseTypeCode | Integer | Look at Constants description in Docs. |
fromDabId | Integer | |
toDabId | Integer | |
isHierarchicalChildOf(userId, parentDabId, dabId) ⇒ Boolean
Description:
Method isHierarchicalChildOf
Kind: global function
Param | Type |
---|
userId | Address |
parentDabId | Integer |
dabId | Integer |
checkUserPrvPayment(msgId, userId, userPassword, userToCheck, zetonsAmount) ⇒ Integer
Description:
Method checkUserPrvPayment
Kind: global function
Returns: Integer
- msgId
Param | Type |
---|
msgId | Integer |
userId | Address |
userPassword | String |
userToCheck | Address |
zetonsAmount | Integer |
addDataSecured(userId, userPassword, dabHash, cipherText) ⇒ Integer
Description:
Method addDataSecured
Kind: global function
Returns: Integer
- dabId
Param | Type |
---|
userId | Address |
userPassword | String |
dabHash | String |
cipherText | String |
getSecuredDabsInfoPage(userId, startDabId, pageSize) ⇒ BytesArray
Description:
Method getSecuredDabsInfoPage
Kind: global function
Returns: BytesArray
- cipheredText - Array of
Param | Type | Description |
---|
userId | Address | |
startDabId | Integer | |
pageSize | Integer | (optional. default: 10) |
getSecuredDabsInfo(userId, dabsIds) ⇒ BytesArray
Description:
Method getSecuredDabsInfo
Kind: global function
Returns: BytesArray
- cipheredText - Array of
Param | Type | Description |
---|
userId | Address | |
dabsIds | Integer | Array of |
listSecuredOwnedDabs(userId) ⇒ BytesArray
Description:
Method listSecuredOwnedDabs
Kind: global function
Returns: BytesArray
- cipheredText - Array of
listSecuredSharedDabs(userId) ⇒ BytesArray
Description:
Method listSecuredSharedDabs
Kind: global function
Returns: BytesArray
- cipheredText - Array of
listSecuredCustodiedDabs(userId) ⇒ BytesArray
Description:
Method listSecuredCustodiedDabs
Kind: global function
Returns: BytesArray
- cipheredText
getSecuredDabsInfo(userId, dabsIds) ⇒ BytesArray
Description:
Method getSecuredDabsInfo
Kind: global function
Returns: BytesArray
- cipheredText - Array of
Param | Type | Description |
---|
userId | Address | |
dabsIds | Integer | Array of |
payBill(userId, userPassword, price, signature, seller) ⇒ Integer
Description:
Method payBill
Kind: global function
Returns: Integer
- paidAmount
Param | Type |
---|
userId | Address |
userPassword | String |
price | Integer |
signature | String |
seller | Address |
PDS API methods
(Back)
Functions
- listVaults(ownerId) ⇒
Vault
Description:
Method listVaults
- getUploadTicket(userId, password, vaultAuth) ⇒
Ticket
Description:
Method getUploadTicket
- getAccessTicket(dabId, buyer, seller, argsBuyerSignature, publicKey, vaultAuth) ⇒
Ticket
Description:
Method getAccessTicket
- getAccessTicketSecured(dealMessageId, buyer, seller, argsBuyerSignature, publicKey, vaultAuth) ⇒
Ticket
Description:
Method getAccessTicketSecured
- getBulkAccessTicket(dabId, buyer, bulkSeller, tagId, argsBuyerSignature, publicKey, vaultAuth) ⇒
Ticket
Description:
Method getBulkAccessTicket
listVaults(ownerId) ⇒ Vault
Description:
Method listVaults
Kind: global function
Returns: Vault
- - Array of Look at Type description in Docs.
getUploadTicket(userId, password, vaultAuth) ⇒ Ticket
Description:
Method getUploadTicket
Kind: global function
Returns: Ticket
- Look at Type description in Docs.
Param | Type |
---|
userId | Address |
password | String |
vaultAuth | Object |
getAccessTicket(dabId, buyer, seller, argsBuyerSignature, publicKey, vaultAuth) ⇒ Ticket
Description:
Method getAccessTicket
Kind: global function
Returns: Ticket
- Look at Type description in Docs.
Param | Type |
---|
dabId | Integer |
buyer | Address |
seller | Address |
argsBuyerSignature | String |
publicKey | String |
vaultAuth | Object |
getAccessTicketSecured(dealMessageId, buyer, seller, argsBuyerSignature, publicKey, vaultAuth) ⇒ Ticket
Description:
Method getAccessTicketSecured
Kind: global function
Returns: Ticket
- Look at Type description in Docs.
Param | Type |
---|
dealMessageId | Integer |
buyer | Address |
seller | Address |
argsBuyerSignature | String |
publicKey | String |
vaultAuth | Object |
getBulkAccessTicket(dabId, buyer, bulkSeller, tagId, argsBuyerSignature, publicKey, vaultAuth) ⇒ Ticket
Description:
Method getBulkAccessTicket
Kind: global function
Returns: Ticket
- Look at Type description in Docs.
Param | Type |
---|
dabId | Integer |
buyer | Address |
bulkSeller | Address |
tagId | Integer |
argsBuyerSignature | String |
publicKey | String |
vaultAuth | Object |
KEYCHAIN API methods
(Back)
Functions
- newAccount(account, secret, encryptedKeyData) ⇒
Boolean
Description:
Method newAccount
- getChallenge(account) ⇒
String
Description:
Method getChallenge
- getEncryptedKeyData(account, responseOnChallenge) ⇒
BytesArray
Description:
Method getEncryptedKeyData
- setEncryptedKeyData(account, responseOnChallenge, keyData) ⇒
Description:
Method setEncryptedKeyData
newAccount(account, secret, encryptedKeyData) ⇒ Boolean
Description:
Method newAccount
Kind: global function
Param | Type |
---|
account | String |
secret | String |
encryptedKeyData | BytesArray |
getChallenge(account) ⇒ String
Description:
Method getChallenge
Kind: global function
getEncryptedKeyData(account, responseOnChallenge) ⇒ BytesArray
Description:
Method getEncryptedKeyData
Kind: global function
Param | Type |
---|
account | String |
responseOnChallenge | String |
setEncryptedKeyData(account, responseOnChallenge, keyData) ⇒
Description:
Method setEncryptedKeyData
Kind: global function
Returns: unspecified
Param | Type |
---|
account | String |
responseOnChallenge | String |
keyData | BytesArray |