Class FingerprintStore

Hierarchy (View Summary)

SubscribableActor<Fingerprint, FingerprintStoreMessage, FingerprintStoreResult>
- FingerprintStore

Index

Constructors

Properties

Methods

afterEntityRemovedFromCache afterEntityWasCached afterStart beforeShutdown cleanup deleteEntity determineRole getEntity receive storeEntity updateIndices

Constructors

constructor

new FingerprintStore(name: string, system: ActorSystem): FingerprintStore
Parameters
- name: string
- system: ActorSystem
Returns FingerprintStore
Overrides SubscribableActor.constructor
- Defined in backend/src/actors/FingerprintStore.ts:21

Properties

`Protected` `Readonly`collectionName

collectionName: string

`Protected` `Readonly`connector

connector: DbClient = ...

`Protected`state

state: FingerprintStoreState = ...

Methods

`Protected`afterEntityRemovedFromCache

afterEntityRemovedFromCache(_uid: string & BRAND<"UID">): Promise<void>
Parameters
- _uid: string & BRAND<"UID">
Returns Promise<void>
Inherited from SubscribableActor.afterEntityRemovedFromCache
- Defined in backend/src/actors/StoringActor.ts:63

`Protected`afterEntityWasCached

afterEntityWasCached(_uid: string & BRAND<"UID">): Promise<void>
Parameters
- _uid: string & BRAND<"UID">
Returns Promise<void>
Inherited from SubscribableActor.afterEntityWasCached
- Defined in backend/src/actors/StoringActor.ts:86

afterStart

afterStart(): Promise<void>
Runs after the actor was started and is ready to receive messages.

Returns Promise<void>
Inherited from SubscribableActor.afterStart
- Defined in backend/src/actors/StoringActor.ts:33

beforeShutdown

beforeShutdown(): Promise<void>
Runs before the actor gets shut down by the actor system

Returns Promise<void>
Inherited from SubscribableActor.beforeShutdown
- Defined in backend/src/actors/SubscribableActor.ts:37

`Protected`cleanup

cleanup(): void
Returns void
Inherited from SubscribableActor.cleanup
- Defined in backend/src/actors/SubscribableActor.ts:64

`Protected`deleteEntity

deleteEntity(uid: string & BRAND<"UID">): Promise<Unit>
Parameters
- uid: string & BRAND<"UID">
Returns Promise<Unit>
Inherited from SubscribableActor.deleteEntity
- Defined in backend/src/actors/StoringActor.ts:135

`Protected`determineRole

determineRole(
    from: ActorRef,
): Promise<
    [
        UserRole: AccessRole,
        UserID: string & BRAND<"UID">,
        IsTemporaryAccount: boolean,
    ],
>
Parameters
- from: ActorRef
Returns Promise<
    [
        UserRole: AccessRole,
        UserID: string & BRAND<"UID">,
        IsTemporaryAccount: boolean,
    ],
>
Inherited from SubscribableActor.determineRole
- Defined in backend/src/actors/StoringActor.ts:42

`Protected`getEntity

getEntity(
    uid: string & BRAND<"UID">,
): Promise<
    MaybeBase<
        {
            blocked: boolean;
            created: Timestamp;
            initialQuiz?: string & BRAND<"UID">;
            lastSeen: Timestamp;
            uid: string & BRAND<"UID">;
            updated: Timestamp;
            usageCount: number;
            userUid: string & BRAND<"UID">;
        },
    >,
>
Parameters
- uid: string & BRAND<"UID">
Returns Promise<
    MaybeBase<
        {
            blocked: boolean;
            created: Timestamp;
            initialQuiz?: string & BRAND<"UID">;
            lastSeen: Timestamp;
            uid: string & BRAND<"UID">;
            updated: Timestamp;
            usageCount: number;
            userUid: string & BRAND<"UID">;
        },
    >,
>
Inherited from SubscribableActor.getEntity
- Defined in backend/src/actors/StoringActor.ts:90

receive

receive(
    from: ActorRef,
    message:
        | { FingerprintStoreMessages: "SubscribeToCollection" } & { value: {} }
        | { FingerprintStoreMessages: "StoreFingerprint" } & {
            value: Partial<
                {
                    blocked: boolean;
                    created: Timestamp;
                    initialQuiz?: string & BRAND<"UID">;
                    lastSeen: Timestamp;
                    uid: string & BRAND<"UID">;
                    updated: Timestamp;
                    usageCount: number;
                    userUid: string & BRAND<"UID">;
                },
            > & { uid: string & BRAND<"UID"> };
        }
        | { FingerprintStoreMessages: "Get" } & { value: string & BRAND<"UID"> }
        | { FingerprintStoreMessages: "Block" } & { value: string & BRAND<"UID"> }
        | { FingerprintStoreMessages: "Unblock" } & {
            value: string & BRAND<"UID">;
        }
        | { FingerprintStoreMessages: "IncreaseCount" } & {
            value: {
                fingerprint: string & BRAND<"UID">;
                initialQuiz: string & BRAND<"UID"> | undefined;
                userUid: string & BRAND<"UID">;
            };
        }
        | { FingerprintStoreMessages: "GetMostRecent" } & { value: {} },
): Promise<FingerprintStoreResult>
Abstract method that handles all incoming messages
Parameters
- from: ActorRef
  actor that has send the message
- message:
      | { FingerprintStoreMessages: "SubscribeToCollection" } & { value: {} }
      | { FingerprintStoreMessages: "StoreFingerprint" } & {
          value: Partial<
              {
                  blocked: boolean;
                  created: Timestamp;
                  initialQuiz?: string & BRAND<"UID">;
                  lastSeen: Timestamp;
                  uid: string & BRAND<"UID">;
                  updated: Timestamp;
                  usageCount: number;
                  userUid: string & BRAND<"UID">;
              },
          > & { uid: string & BRAND<"UID"> };
      }
      | { FingerprintStoreMessages: "Get" } & { value: string & BRAND<"UID"> }
      | { FingerprintStoreMessages: "Block" } & { value: string & BRAND<"UID"> }
      | { FingerprintStoreMessages: "Unblock" } & {
          value: string & BRAND<"UID">;
      }
      | { FingerprintStoreMessages: "IncreaseCount" } & {
          value: {
              fingerprint: string & BRAND<"UID">;
              initialQuiz: string & BRAND<"UID"> | undefined;
              userUid: string & BRAND<"UID">;
          };
      }
      | { FingerprintStoreMessages: "GetMostRecent" } & { value: {} }
  message type
Returns Promise<FingerprintStoreResult>
promised return value. If the caller used ask, this value will be returned to the calling actor
Overrides SubscribableActor.receive
- Defined in backend/src/actors/FingerprintStore.ts:45

`Protected`storeEntity

storeEntity(
    entity: {
        blocked: boolean;
        created: Timestamp;
        initialQuiz?: string & BRAND<"UID">;
        lastSeen: Timestamp;
        uid: string & BRAND<"UID">;
        updated: Timestamp;
        usageCount: number;
        userUid: string & BRAND<"UID">;
    },
): Promise<
    {
        blocked: boolean;
        created: Timestamp;
        initialQuiz?: string & BRAND<"UID">;
        lastSeen: Timestamp;
        uid: string & BRAND<"UID">;
        updated: Timestamp;
        usageCount: number;
        userUid: string & BRAND<"UID">;
    },
>
Parameters
- entity: {
      blocked: boolean;
      created: Timestamp;
      initialQuiz?: string & BRAND<"UID">;
      lastSeen: Timestamp;
      uid: string & BRAND<"UID">;
      updated: Timestamp;
      usageCount: number;
      userUid: string & BRAND<"UID">;
  }
Returns Promise<
    {
        blocked: boolean;
        created: Timestamp;
        initialQuiz?: string & BRAND<"UID">;
        lastSeen: Timestamp;
        uid: string & BRAND<"UID">;
        updated: Timestamp;
        usageCount: number;
        userUid: string & BRAND<"UID">;
    },
>
Inherited from SubscribableActor.storeEntity
- Defined in backend/src/actors/StoringActor.ts:115

`Protected`updateIndices

updateIndices(
    _draft: FingerprintStoreState,
    _entity: {
        blocked: boolean;
        created: Timestamp;
        initialQuiz?: string & BRAND<"UID">;
        lastSeen: Timestamp;
        uid: string & BRAND<"UID">;
        updated: Timestamp;
        usageCount: number;
        userUid: string & BRAND<"UID">;
    },
): void
Parameters
- _draft: FingerprintStoreState
- _entity: {
      blocked: boolean;
      created: Timestamp;
      initialQuiz?: string & BRAND<"UID">;
      lastSeen: Timestamp;
      uid: string & BRAND<"UID">;
      updated: Timestamp;
      usageCount: number;
      userUid: string & BRAND<"UID">;
  }
Returns void
Overrides SubscribableActor.updateIndices
- Defined in backend/src/actors/FingerprintStore.ts:25

Class FingerprintStore

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FingerprintStore

Properties

Protected ReadonlycollectionName

Protected Readonlyconnector

Protectedstate

Methods

ProtectedafterEntityRemovedFromCache

Parameters

Returns Promise<void>

ProtectedafterEntityWasCached

Parameters

Returns Promise<void>

afterStart

Returns Promise<void>

beforeShutdown

Returns Promise<void>

Protectedcleanup

Returns void

ProtecteddeleteEntity

Parameters

Returns Promise<Unit>

ProtecteddetermineRole

Parameters

Returns Promise< [ UserRole: AccessRole, UserID: string & BRAND<"UID">, IsTemporaryAccount: boolean, ],>

ProtectedgetEntity

Parameters

Returns Promise< MaybeBase< { blocked: boolean; created: Timestamp; initialQuiz?: string & BRAND<"UID">; lastSeen: Timestamp; uid: string & BRAND<"UID">; updated: Timestamp; usageCount: number; userUid: string & BRAND<"UID">; }, >,>

receive

Parameters

Returns Promise<FingerprintStoreResult>

ProtectedstoreEntity

Parameters

Returns Promise< { blocked: boolean; created: Timestamp; initialQuiz?: string & BRAND<"UID">; lastSeen: Timestamp; uid: string & BRAND<"UID">; updated: Timestamp; usageCount: number; userUid: string & BRAND<"UID">; },>

ProtectedupdateIndices

Parameters

Returns void

Settings

On This Page

`Protected` `Readonly`collectionName

`Protected` `Readonly`connector

`Protected`state

`Protected`afterEntityRemovedFromCache

`Protected`afterEntityWasCached

`Protected`cleanup

`Protected`deleteEntity

`Protected`determineRole

Returns Promise<
[
UserRole: AccessRole,
UserID: string & BRAND<"UID">,
IsTemporaryAccount: boolean,
],
>

`Protected`getEntity

Returns Promise<
MaybeBase<
{
blocked: boolean;
created: Timestamp;
initialQuiz?: string & BRAND<"UID">;
lastSeen: Timestamp;
uid: string & BRAND<"UID">;
updated: Timestamp;
usageCount: number;
userUid: string & BRAND<"UID">;
},
>,
>

`Protected`storeEntity

Returns Promise<
{
blocked: boolean;
created: Timestamp;
initialQuiz?: string & BRAND<"UID">;
lastSeen: Timestamp;
uid: string & BRAND<"UID">;
updated: Timestamp;
usageCount: number;
userUid: string & BRAND<"UID">;
},
>

`Protected`updateIndices