Skip to content

Interface: ICacheClient

modules/cache-client.ICacheClient

Implemented by

Table of contents

Properties

Properties

addDIDToWatchList

• addDIDToWatchList: (did: string) => Promise<void>

Type declaration

▸ (did): Promise<void>

Parameters
Name Type
did string
Returns

Promise<void>

deleteClaim

• deleteClaim: (claimId: string) => Promise<void>

Type declaration

▸ (claimId): Promise<void>

Parameters
Name Type
claimId string
Returns

Promise<void>

getAppDefinition

• getAppDefinition: (namespace: string) => Promise<IAppDefinition>

Type declaration

▸ (namespace): Promise<IAppDefinition>

Parameters
Name Type
namespace string
Returns

Promise<IAppDefinition>

getApplicationRoles

• getApplicationRoles: (namespace: string) => Promise<IRole[]>

Type declaration

▸ (namespace): Promise<IRole[]>

Parameters
Name Type
namespace string
Returns

Promise<IRole[]>

getApplicationsByOrganization

• getApplicationsByOrganization: (namespace: string) => Promise<IApp[]>

Type declaration

▸ (namespace): Promise<IApp[]>

Parameters
Name Type
namespace string
Returns

Promise<IApp[]>

getApplicationsByOwner

• getApplicationsByOwner: (owner: string) => Promise<IApp[]>

Type declaration

▸ (owner): Promise<IApp[]>

Parameters
Name Type
owner string
Returns

Promise<IApp[]>

getAssetById

• getAssetById: (id: string) => Promise<Asset>

Type declaration

▸ (id): Promise<Asset>

Parameters
Name Type
id string
Returns

Promise<Asset>

getAssetHistory

• getAssetHistory: (id: string, filter?: AssetsFilter) => Promise<AssetHistory[]>

Type declaration

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

Parameters
Name Type
id string
filter? AssetsFilter
Returns

Promise<AssetHistory[]>

getClaimById

• getClaimById: (claimId: string) => Promise<undefined | Claim>

Type declaration

▸ (claimId): Promise<undefined | Claim>

Parameters
Name Type
claimId string
Returns

Promise<undefined | Claim>

getClaimsByIssuer

• getClaimsByIssuer: (issuer: string, filter?: ClaimsFilter) => Promise<Claim[]>

Type declaration

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

Parameters
Name Type
issuer string
filter? ClaimsFilter
Returns

Promise<Claim[]>

getClaimsByRequester

• getClaimsByRequester: (requester: string, filter?: ClaimsFilter) => Promise<Claim[]>

Type declaration

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

Parameters
Name Type
requester string
filter? ClaimsFilter
Returns

Promise<Claim[]>

getClaimsByRevoker

• getClaimsByRevoker: (revoker: string, filter?: ClaimsFilter) => Promise<Claim[]>

Type declaration

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

Parameters
Name Type
revoker string
filter? ClaimsFilter
Returns

Promise<Claim[]>

getClaimsBySubject

• getClaimsBySubject: (subject: string, filter?: ClaimsFilter) => Promise<Claim[]>

Type declaration

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

Parameters
Name Type
subject string
filter? ClaimsFilter
Returns

Promise<Claim[]>

getClaimsBySubjects

• getClaimsBySubjects: (subjects: string[]) => Promise<Claim[]>

Type declaration

▸ (subjects): Promise<Claim[]>

Parameters
Name Type
subjects string[]
Returns

Promise<Claim[]>

getDIDsForRole

• getDIDsForRole: (namespace: string) => Promise<string[]>

Type declaration

▸ (namespace): Promise<string[]>

Parameters
Name Type
namespace string
Returns

Promise<string[]>

getDidDocument

• getDidDocument: (did: string, includeClaims?: boolean) => Promise<IDIDDocument>

Type declaration

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

Parameters
Name Type
did string
includeClaims? boolean
Returns

Promise<IDIDDocument>

getNamespaceBySearchPhrase

• getNamespaceBySearchPhrase: (phrase: string, types?: SearchType[]) => Promise<(IRole | IOrganization | IApp)[]>

Type declaration

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

Parameters
Name Type
phrase string
types? SearchType[]
Returns

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

getOfferedAssets

• getOfferedAssets: (offeredTo: string) => Promise<Asset[]>

Type declaration

▸ (offeredTo): Promise<Asset[]>

Parameters
Name Type
offeredTo string
Returns

Promise<Asset[]>

getOrgDefinition

• getOrgDefinition: (namespace: string) => Promise<IOrganizationDefinition>

Type declaration

▸ (namespace): Promise<IOrganizationDefinition>

Parameters
Name Type
namespace string
Returns

Promise<IOrganizationDefinition>

getOrgHierarchy

• getOrgHierarchy: (namespace: string) => Promise<IOrganization>

Type declaration

▸ (namespace): Promise<IOrganization>

Parameters
Name Type
namespace string
Returns

Promise<IOrganization>

getOrganizationRoles

• getOrganizationRoles: (namespace: string) => Promise<IRole[]>

Type declaration

▸ (namespace): Promise<IRole[]>

Parameters
Name Type
namespace string
Returns

Promise<IRole[]>

getOrganizationsByOwner

• getOrganizationsByOwner: (owner: string, excludeSubOrgs?: boolean) => Promise<IOrganization[]>

Type declaration

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

Parameters
Name Type
owner string
excludeSubOrgs? boolean
Returns

Promise<IOrganization[]>

getOwnedAssets

• getOwnedAssets: (owner: string) => Promise<Asset[]>

Type declaration

▸ (owner): Promise<Asset[]>

Parameters
Name Type
owner string
Returns

Promise<Asset[]>

getPreviouslyOwnedAssets

• getPreviouslyOwnedAssets: (owner: string) => Promise<Asset[]>

Type declaration

▸ (owner): Promise<Asset[]>

Parameters
Name Type
owner string
Returns

Promise<Asset[]>

getRoleDefinition

• getRoleDefinition: (namespace: string) => Promise<IRoleDefinition>

Type declaration

▸ (namespace): Promise<IRoleDefinition>

Parameters
Name Type
namespace string
Returns

Promise<IRoleDefinition>

getRolesByOwner

• getRolesByOwner: (owner: string) => Promise<IRole[]>

Type declaration

▸ (owner): Promise<IRole[]>

Parameters
Name Type
owner string
Returns

Promise<IRole[]>

getRolesByRevoker

• getRolesByRevoker: (revoker: string) => Promise<IRole[]>

Type declaration

▸ (revoker): Promise<IRole[]>

Parameters
Name Type
revoker string
Returns

Promise<IRole[]>

getRolesDefinition

• getRolesDefinition: (namespace: string[]) => Promise<Record<string, IRoleDefinition>>

Type declaration

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

Parameters
Name Type
namespace string[]
Returns

Promise<Record<string, IRoleDefinition>>

getSubOrganizationsByOrganization

• getSubOrganizationsByOrganization: (namespace: string) => Promise<IOrganization[]>

Type declaration

▸ (namespace): Promise<IOrganization[]>

Parameters
Name Type
namespace string
Returns

Promise<IOrganization[]>

issueClaim

• issueClaim: (issuer: string, message: IClaimIssuance) => Promise<void>

Type declaration

▸ (issuer, message): Promise<void>

Parameters
Name Type
issuer string
message IClaimIssuance
Returns

Promise<void>

rejectClaim

• rejectClaim: (issuer: string, message: IClaimRejection) => Promise<void>

Type declaration

▸ (issuer, message): Promise<void>

Parameters
Name Type
issuer string
message IClaimRejection
Returns

Promise<void>

requestClaim

• requestClaim: (message: IClaimRequest) => Promise<void>

Type declaration

▸ (message): Promise<void>

Parameters
Name Type
message IClaimRequest
Returns

Promise<void>