Class Roles

constructor

• new Roles(opts): Roles

• Parameters

  • opts: {
        coreManager: CoreManager;
        coreOwnership: CoreOwnership;
        dataType: DataType<DataStore<"auth", "role" | "coreOwnership">, JsonSchemaToDrizzleSqliteTable<{}, {}, "role", AdditionalColumns, "docId">, "role", {}, {}>;
        deviceKey: Buffer;
        projectKey: Buffer;
    }

    • coreManager: CoreManager

    • coreOwnership: CoreOwnership

    • dataType: DataType<DataStore<"auth", "role" | "coreOwnership">, JsonSchemaToDrizzleSqliteTable<{}, {}, "role", AdditionalColumns, "docId">, "role", {}, {}>

    • deviceKey: Buffer

      public key of this device

    • projectKey: Buffer

  Returns Roles

StaticNO_ROLE

assignRole

• assignRole(deviceId, roleId, opts?): Promise<void>

• Assign a role to the specified deviceId. Devices without an assigned role are unable to sync, except the project creator who can do anything. Only the project creator can assign their own role. Will throw if the device's role cannot assign the role by consulting roleAssignment.

  Parameters

  • deviceId: string
  • roleId:
        | "f7c150f5a3a9a855"
        | "012fd2d431c0bf60"
        | "9e6d29263cba36c9"
        | "8ced989b1904606b"
  • Optionalopts: {
        reason: string;
    }

    • reason: string

  Returns Promise<void>

getAll

• getAll(): Promise<Map<string, Role<
      | "a12a6702b93bd7ff"
      | "f7c150f5a3a9a855"
      | "012fd2d431c0bf60"
      | "9e6d29263cba36c9"
      | "8ced989b1904606b"
      | "08e4251e36f6e7ed">>>

• Get roles of all devices in the project. For your own device, if you have not yet synced your own role record, the "no role" capabilties is returned. The project creator will have the creator role unless a different one has been assigned.

  Returns Promise<Map<string, Role<
      | "a12a6702b93bd7ff"
      | "f7c150f5a3a9a855"
      | "012fd2d431c0bf60"
      | "9e6d29263cba36c9"
      | "8ced989b1904606b"
      | "08e4251e36f6e7ed">>>

  Map of deviceId to Role

getRole

• getRole(deviceId): Promise<Role<
      | "a12a6702b93bd7ff"
      | "f7c150f5a3a9a855"
      | "012fd2d431c0bf60"
      | "9e6d29263cba36c9"
      | "8ced989b1904606b"
      | "08e4251e36f6e7ed">>

• Get the role for device deviceId.

  Parameters

  • deviceId: string

  Returns Promise<Role<
      | "a12a6702b93bd7ff"
      | "f7c150f5a3a9a855"
      | "012fd2d431c0bf60"
      | "9e6d29263cba36c9"
      | "8ced989b1904606b"
      | "08e4251e36f6e7ed">>

getRoleReason

• getRoleReason(deviceId): Promise<undefined | string>

• Get the reason for the role of deviceId (if it exists).

  Parameters

  • deviceId: string

  Returns Promise<undefined | string>