@inrupt/solid-client-access-grants / common/getters

Module: common/getters#

Classes#

AccessGrantWrapper

Functions#

getAccessModes#

▸ getAccessModes(vc): AccessModes

Get the access modes granted to a resources via an Access Grant/Request.

Example

const modes = getAccessModes(accessGrant);

Parameters#

Name	Type	Description
`vc`	`AccessGrant` \| `AccessRequest` \| `AccessGrantOdrl`	The Access Grant/Request

Returns#

AccessModes

The access modes the grant recipient can exercise.

Defined in#

src/common/getters.ts:118

getExpirationDate#

▸ getExpirationDate(vc): Date | undefined

Get the expiration date of an Access Grant/Request.

Example

const date = getExpirationDate(accessGrant);

Parameters#

Name	Type	Description
`vc`	`AccessGrant` \| `AccessRequest` \| `AccessGrantOdrl`	The Access Grant/Request

Returns#

Date | undefined

The expiration date

Defined in#

src/common/getters.ts:201

getId#

▸ getId(vc): string

Get the ID (URL) of an Access Grant/Request.

Example

const id = getId(accessGrant);

Parameters#

Name	Type	Description
`vc`	`AccessGrant` \| `AccessRequest` \| `AccessGrantOdrl`	The Access Grant/Request

Returns#

string

The VC ID URL

Defined in#

src/common/getters.ts:147

getInherit#

▸ getInherit(vc): boolean

Check whether a given Access Grant applies recursively to child resources or not.

Example

const isInherited = getInherit(accessGrant);

Parameters#

Name	Type	Description
`vc`	`AccessGrant` \| `AccessRequest` \| `AccessGrantOdrl`	The Access Grant/Request

Returns#

boolean

true if the Grant applies to contained resources, false otherwise.

Defined in#

src/common/getters.ts:239

getIssuanceDate#

▸ getIssuanceDate(vc): Date

Get the issuance date of an Access Grant/Request.

Example

const date = getIssuanceDate(accessGrant);

Parameters#

Name	Type	Description
`vc`	`AccessGrant` \| `AccessRequest` \| `AccessGrantOdrl`	The Access Grant/Request

Returns#

Date

The issuance date

Defined in#

src/common/getters.ts:183

getIssuer#

▸ getIssuer(vc): string

Get the issuer of an Access Grant/Request.

Example

const date = getIssuer(accessGrant);

Parameters#

Name	Type	Description
`vc`	`AccessGrant` \| `AccessRequest` \| `AccessGrantOdrl`	The Access Grant/Request

Returns#

string

The VC issuer

Defined in#

src/common/getters.ts:221

getRequestor#

▸ getRequestor(vc): string

Get the requestor asking for access to a resources with an Access Grant/Request.

Example

const requestorWebId = getRequestor(accessGrant);

Parameters#

Name	Type	Description
`vc`	`AccessGrant` \| `AccessRequest` \| `AccessGrantOdrl`	The Access Grant/Request

Returns#

string

The requestor WebID

Defined in#

src/common/getters.ts:94

getResourceOwner#

▸ getResourceOwner(vc): string

Get the resource owner granting access to their resources from an Access Grant/Request.

Example

const ownerWebId = getResourceOwner(accessGrant);

Parameters#

Name	Type	Description
`vc`	`AccessGrant` \| `AccessGrantOdrl`	The Access Grant/Request

Returns#

string

The resource owner WebID

Defined in#

src/common/getters.ts:67

▸ getResourceOwner(vc): string | undefined

Parameters#

Name	Type
`vc`	`AccessGrant` \| `AccessRequest` \| `AccessGrantOdrl`

Returns#

string | undefined

Defined in#

src/common/getters.ts:70

getResources#

▸ getResources(vc): string[]

Get the resources to which an Access Grant/Request applies.

Example

const resources = getResources(accessGrant);

Parameters#

Name	Type	Description
`vc`	`AccessGrant` \| `AccessRequest` \| `AccessGrantOdrl`	The Access Grant/Request

Returns#

string[]

The resources IRIs

Defined in#

src/common/getters.ts:41

getTypes#

▸ getTypes(vc): string[]

Get the VC types of an Access Grant/Request.

Example

const types = getTypes(accessGrant);

Parameters#

Name	Type	Description
`vc`	`AccessGrant` \| `AccessRequest` \| `AccessGrantOdrl`	The Access Grant/Request

Returns#

string[]

The VC types

Defined in#

src/common/getters.ts:165