Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Namespaces

Enumerations

Classes

Type aliases

Functions

Type aliases

GrantCreateParams

GrantCreateParams: { capabilities?: Capabilities | string; condition?: Condition; delegating?: GrantId; grantee: IdentityId | "everyone" }

Type declaration

  • Optional capabilities?: Capabilities | string

    The capabilities attached to this grant. The default is read.

  • Optional condition?: Condition

    The condition that must be matched to receive access to one or more Documents.

  • Optional delegating?: GrantId

    The grant to extend by delegation. If you are the delegating grant's grantee is you, and it has the extend capability, then this grant will have the same granter as the delegating grant.

  • grantee: IdentityId | "everyone"

    The singular Identity to which permission is given, or everyone;

GrantId

GrantId: Opaque<ResourceId, "GrantId">

ListGrantsFilter

ListGrantsFilter: Partial<{ grantee?: IdentityId; granter?: IdentityId }>

PODGrant

PODGrant: Readonly<PODModel & { capabilities: string; condition?: Condition; delegating?: ResourceId; grantee?: ResourceId; granter: ResourceId; permission?: ResourceId }>

Functions

parseCaps

  • Parameters

    • Optional strCaps: string

    Returns Capabilities

stringifyCaps

  • Parameters

    Returns string

Generated using TypeDoc