Options
All
  • Public
  • Public/Protected
  • All
Menu

Module permission

Index

Namespaces

Classes

Type aliases

Type aliases

GrantSpec

GrantSpec: { condition?: Condition; grantee?: GranteeRef; granter: GranterRef }

Type declaration

  • Optional condition?: Condition

    The Grant's condition. @see Grant.condition.

  • Optional grantee?: GranteeRef

    The symbolic grantee.

  • granter: GranterRef

    The symbolic granter.

GranteeRef

GranteeRef: "app" | "participant" | "everyone" | IdentityId

A ResourceId causes the grant to be made to a specific Identity, app grants to the app, participant grants to the joining identity, and everyone refers to, well, everyone.

GranterRef

GranterRef: "app" | "participant"

app represents the app, participant represents the joining identity.

PODPermission

PODPermission: Readonly<PODModel & PermissionCreateParams & { appId: ResourceId }>

PermissionCreateParams

PermissionCreateParams: { allowText: string; denyText: string; description: string; grants: GrantSpec[]; name: string }

Type declaration

  • allowText: string

    The text seen by users when accepting this permission.

  • denyText: string

    The text seen by users when denying this permission.

  • description: string

    The description of this permission seen by users when shown in an app.

  • grants: GrantSpec[]

    The Grants to make when the App containing this Permission is joined.

  • name: string

    The name of this permission.

PermissionId

PermissionId: Opaque<ResourceId, "PermissionId">

Generated using TypeDoc