modules_cache_client.ICacheClient.md

Interface: ICacheClient

modules/cache-client.ICacheClient

Implemented by

• CacheClient

Table of contents

Properties

• pubKeyAndIdentityToken

Methods

• addDIDToWatchList
• deleteClaim
• getAppDefinition
• getApplicationRoles
• getApplicationsByOrganization
• getApplicationsByOwner
• getAssetById
• getAssetHistory
• getClaimById
• getClaimsByIssuer
• getClaimsByRequester
• getClaimsByRevoker
• getClaimsBySubject
• getClaimsBySubjects
• getDIDsForRole
• getDidDocument
• getNamespaceBySearchPhrase
• getOfferedAssets
• getOrgDefinition
• getOrgHierarchy
• getOrganizationRoles
• getOrganizationsByOwner
• getOwnedAssets
• getPreviouslyOwnedAssets
• getRoleDefinition
• getRolesByOwner
• getRolesByRevoker
• getRolesDefinition
• getSubOrganizationsByOrganization
• isAuthEnabled
• issueClaim
• login
• rejectClaim
• requestClaim

Properties

pubKeyAndIdentityToken

• pubKeyAndIdentityToken: undefined | IPubKeyAndIdentityToken

Methods

addDIDToWatchList

▸ addDIDToWatchList(did): Promise<void>

Parameters

Name	Type
did	string

Returns

Promise<void>

---

deleteClaim

▸ deleteClaim(claimId): Promise<void>

Parameters

Name	Type
claimId	string

Returns

Promise<void>

---

getAppDefinition

▸ getAppDefinition(namespace): Promise<IAppDefinition>

Parameters

Name	Type
namespace	string

Returns

Promise<IAppDefinition>

---

getApplicationRoles

▸ getApplicationRoles(namespace): Promise<IRole[]>

Parameters

Name	Type
namespace	string

Returns

Promise<IRole[]>

---

getApplicationsByOrganization

▸ getApplicationsByOrganization(namespace): Promise<IApp[]>

Parameters

Name	Type
namespace	string

Returns

Promise<IApp[]>

---

getApplicationsByOwner

▸ getApplicationsByOwner(owner): Promise<IApp[]>

Parameters

Name	Type
owner	string

Returns

Promise<IApp[]>

---

getAssetById

▸ getAssetById(id): Promise<Asset>

Parameters

Name	Type
id	string

Returns

Promise<Asset>

---

getAssetHistory

▸ getAssetHistory(id, filter?): Promise<AssetHistory[]>

Parameters

Name	Type
id	string
filter?	AssetsFilter

Returns

Promise<AssetHistory[]>

---

getClaimById

▸ getClaimById(claimId): Promise<undefined | Claim>

Parameters

Name	Type
claimId	string

Returns

Promise<undefined | Claim>

---

getClaimsByIssuer

▸ getClaimsByIssuer(issuer, filter?): Promise<Claim[]>

Parameters

Name	Type
issuer	string
filter?	ClaimsFilter

Returns

Promise<Claim[]>

---

getClaimsByRequester

▸ getClaimsByRequester(requester, filter?): Promise<Claim[]>

Parameters

Name	Type
requester	string
filter?	ClaimsFilter

Returns

Promise<Claim[]>

---

getClaimsByRevoker

▸ getClaimsByRevoker(revoker, filter?): Promise<Claim[]>

Parameters

Name	Type
revoker	string
filter?	ClaimsFilter

Returns

Promise<Claim[]>

---

getClaimsBySubject

▸ getClaimsBySubject(subject, filter?): Promise<Claim[]>

Parameters

Name	Type
subject	string
filter?	ClaimsFilter

Returns

Promise<Claim[]>

---

getClaimsBySubjects

▸ getClaimsBySubjects(subjects): Promise<Claim[]>

Parameters

Name	Type
subjects	string[]

Returns

Promise<Claim[]>

---

getDIDsForRole

▸ getDIDsForRole(namespace): Promise<string[]>

Parameters

Name	Type
namespace	string

Returns

Promise<string[]>

---

getDidDocument

▸ getDidDocument(did, includeClaims?): Promise<IDIDDocument>

Parameters

Name	Type
did	string
includeClaims?	boolean

Returns

Promise<IDIDDocument>

---

getNamespaceBySearchPhrase

▸ getNamespaceBySearchPhrase(phrase, types?): Promise<(IRole | IOrganization | IApp)[]>

Parameters

Name	Type
phrase	string
types?	SearchType[]

Returns

Promise<(IRole | IOrganization | IApp)[]>

---

getOfferedAssets

▸ getOfferedAssets(offeredTo): Promise<Asset[]>

Parameters

Name	Type
offeredTo	string

Returns

Promise<Asset[]>

---

getOrgDefinition

▸ getOrgDefinition(namespace): Promise<IOrganizationDefinition>

Parameters

Name	Type
namespace	string

Returns

Promise<IOrganizationDefinition>

---

getOrgHierarchy

▸ getOrgHierarchy(namespace): Promise<IOrganization>

Parameters

Name	Type
namespace	string

Returns

Promise<IOrganization>

---

getOrganizationRoles

▸ getOrganizationRoles(namespace): Promise<IRole[]>

Parameters

Name	Type
namespace	string

Returns

Promise<IRole[]>

---

getOrganizationsByOwner

▸ getOrganizationsByOwner(owner, excludeSubOrgs?): Promise<IOrganization[]>

Parameters

Name	Type
owner	string
excludeSubOrgs?	boolean

Returns

Promise<IOrganization[]>

---

getOwnedAssets

▸ getOwnedAssets(owner): Promise<Asset[]>

Parameters

Name	Type
owner	string

Returns

Promise<Asset[]>

---

getPreviouslyOwnedAssets

▸ getPreviouslyOwnedAssets(owner): Promise<Asset[]>

Parameters

Name	Type
owner	string

Returns

Promise<Asset[]>

---

getRoleDefinition

▸ getRoleDefinition(namespace): Promise<IRoleDefinition>

Parameters

Name	Type
namespace	string

Returns

Promise<IRoleDefinition>

---

getRolesByOwner

▸ getRolesByOwner(owner): Promise<IRole[]>

Parameters

Name	Type
owner	string

Returns

Promise<IRole[]>

---

getRolesByRevoker

▸ getRolesByRevoker(revoker): Promise<IRole[]>

Parameters

Name	Type
revoker	string

Returns

Promise<IRole[]>

---

getRolesDefinition

▸ getRolesDefinition(namespace): Promise<Record<string, IRoleDefinition>>

Parameters

Name	Type
namespace	string[]

Returns

Promise<Record<string, IRoleDefinition>>

---

getSubOrganizationsByOrganization

▸ getSubOrganizationsByOrganization(namespace): Promise<IOrganization[]>

Parameters

Name	Type
namespace	string

Returns

Promise<IOrganization[]>

---

isAuthEnabled

▸ isAuthEnabled(): boolean

Returns

boolean

---

issueClaim

▸ issueClaim(issuer, message): Promise<void>

Parameters

Name	Type
issuer	string
message	IClaimIssuance

Returns

Promise<void>

---

login

▸ login(): Promise<void>

Returns

Promise<void>

---

rejectClaim

▸ rejectClaim(issuer, message): Promise<void>

Parameters

Name	Type
issuer	string
message	IClaimRejection

Returns

Promise<void>

---

requestClaim

▸ requestClaim(message): Promise<void>

Parameters

Name	Type
message	IClaimRequest

Returns

Promise<void>