Class PermissionsProtocol

constructor

• new PermissionsProtocol(): PermissionsProtocol

• Returns PermissionsProtocol

Static Readonly definition

Static Readonly grantPath

Static Readonly requestPath

Static Readonly revocationPath

Static Readonly uri

Static createGrant

• createGrant(options): Promise<{
      dataEncodedMessage: DataEncodedRecordsWriteMessage;
      permissionGrantBytes: Uint8Array;
      permissionGrantData: PermissionGrantData;
      recordsWrite: RecordsWrite;
  }>

• Convenience method to create a permission grant.

  Parameters

  • options: PermissionGrantCreateOptions

  Returns Promise<{
      dataEncodedMessage: DataEncodedRecordsWriteMessage;
      permissionGrantBytes: Uint8Array;
      permissionGrantData: PermissionGrantData;
      recordsWrite: RecordsWrite;
  }>

Static createRequest

• createRequest(options): Promise<{
      permissionRequestBytes: Uint8Array;
      permissionRequestData: PermissionRequestData;
      recordsWrite: RecordsWrite;
  }>

• Convenience method to create a permission request.

  Parameters

  • options: PermissionRequestCreateOptions

  Returns Promise<{
      permissionRequestBytes: Uint8Array;
      permissionRequestData: PermissionRequestData;
      recordsWrite: RecordsWrite;
  }>

Static createRevocation

• createRevocation(options): Promise<{
      permissionRevocationBytes: Uint8Array;
      permissionRevocationData: PermissionRevocationData;
      recordsWrite: RecordsWrite;
  }>

• Convenience method to create a permission revocation.

  Parameters

  • options: PermissionRevocationCreateOptions

  Returns Promise<{
      permissionRevocationBytes: Uint8Array;
      permissionRevocationData: PermissionRevocationData;
      recordsWrite: RecordsWrite;
  }>

Static fetchGrant

• fetchGrant(tenant, messageStore, permissionGrantId): Promise<PermissionGrant>

• Fetches PermissionGrant with the specified recordID.

  Parameters

  • tenant: string
  • messageStore: MessageStore
  • permissionGrantId: string

  Returns Promise<PermissionGrant>

  the PermissionGrant matching the recordId specified.

  Throws

  if PermissionGrant does not exist

Static parseRequest

• parseRequest(base64UrlEncodedRequest): PermissionRequestData

• Parameters

  • base64UrlEncodedRequest: string

  Returns PermissionRequestData

Static validateSchema

• validateSchema(recordsWriteMessage, dataBytes): void

• Validates the given Permissions protocol RecordsWrite. It can be a request, grant, or revocation.

  Parameters

  • recordsWriteMessage: RecordsWriteMessage
  • dataBytes: Uint8Array

  Returns void