Class UserStore

Hierarchy (View Summary)

SubscribableActor<User, UserStoreMessage, ResultType>
- UserStore

Index

Constructors

Properties

Methods

afterEntityRemovedFromCache afterEntityWasCached afterStart beforeShutdown cleanup deleteEntity determineRole getEntity receive storeEntity updateIndices

Constructors

constructor

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

Properties

`Protected` `Readonly`collectionName

collectionName: string

`Protected` `Readonly`connector

connector: DbClient = ...

`Protected`state

state: State = ...

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>
Overrides SubscribableActor.afterStart
- Defined in backend/src/actors/UserStore.ts:57

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
Overrides SubscribableActor.cleanup
- Defined in backend/src/actors/UserStore.ts:72

`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<
        {
            active: boolean;
            archived?: Timestamp;
            created: Timestamp;
            email?: string;
            fingerprint?: string;
            initialQuiz?: string;
            isTemporary: boolean;
            lastLogin: Timestamp;
            nickname?: string;
            quizUsage: Map<
                string & BRAND<"UID">,
                { name?: string; type: "NAME" | "NICKNAME" | "ANONYMOUS" },
            >;
            role: "STUDENT" | "TEACHER" | "ADMIN";
            uid: string & BRAND<"UID">;
            updated: Timestamp;
            username: string;
        },
    >,
>
Parameters
- uid: string & BRAND<"UID">
Returns Promise<
    MaybeBase<
        {
            active: boolean;
            archived?: Timestamp;
            created: Timestamp;
            email?: string;
            fingerprint?: string;
            initialQuiz?: string;
            isTemporary: boolean;
            lastLogin: Timestamp;
            nickname?: string;
            quizUsage: Map<
                string & BRAND<"UID">,
                { name?: string; type: "NAME" | "NICKNAME" | "ANONYMOUS" },
            >;
            role: "STUDENT" | "TEACHER" | "ADMIN";
            uid: string & BRAND<"UID">;
            updated: Timestamp;
            username: string;
        },
    >,
>
Inherited from SubscribableActor.getEntity
- Defined in backend/src/actors/StoringActor.ts:90

receive

receive(
    from: ActorRef,
    message:
        | { UserStoreMessage: "Create" } & {
            value: {
                active: boolean;
                archived?: Timestamp;
                created: Timestamp;
                email?: string;
                fingerprint?: string;
                initialQuiz?: string;
                isTemporary: boolean;
                lastLogin: Timestamp;
                nickname?: string;
                quizUsage: Map<
                    string & BRAND<"UID">,
                    { name?: string; type: "NAME" | "NICKNAME" | "ANONYMOUS" },
                >;
                role: "STUDENT" | "TEACHER" | "ADMIN";
                uid: string & BRAND<"UID">;
                updated: Timestamp;
                username: string;
            };
        }
        | { UserStoreMessage: "Update" } & {
            value: Partial<
                {
                    active: boolean;
                    archived?: Timestamp;
                    created: Timestamp;
                    email?: string;
                    fingerprint?: string;
                    initialQuiz?: string;
                    isTemporary: boolean;
                    lastLogin: Timestamp;
                    nickname?: string;
                    quizUsage: Map<
                        string & BRAND<"UID">,
                        { name?: string; type: "NAME" | "NICKNAME" | "ANONYMOUS" },
                    >;
                    role: "STUDENT" | "TEACHER" | "ADMIN";
                    uid: string & BRAND<"UID">;
                    updated: Timestamp;
                    username: string;
                },
            > & { uid: string & BRAND<"UID"> };
        }
        | { UserStoreMessage: "GetAll" } & { value: {} }
        | { UserStoreMessage: "SubscribeToCollection" } & { value: string[] }
        | { UserStoreMessage: "UnsubscribeFromCollection" } & { value: {} }
        | { UserStoreMessage: "Get" } & { value: string & BRAND<"UID"> }
        | { UserStoreMessage: "Has" } & { value: string & BRAND<"UID"> }
        | { UserStoreMessage: "SubscribeTo" } & { value: string & BRAND<"UID"> }
        | { UserStoreMessage: "UnsubscribeFrom" } & {
            value: string & BRAND<"UID">;
        }
        | { UserStoreMessage: "Find" } & {
            value: { query: string; role: "STUDENT" | "TEACHER" | "ADMIN" };
        }
        | { UserStoreMessage: "GetOwn" } & { value: {} }
        | { UserStoreMessage: "GetRole" } & { value: string & BRAND<"UID"> }
        | { UserStoreMessage: "GetByFingerprint" } & { value: string }
        | { UserStoreMessage: "GetNames" } & { value: (string & BRAND<"UID">)[] }
        | { UserStoreMessage: "GetTeachers" } & { value: {} }
        | { UserStoreMessage: "IsNicknameUnique" } & { value: string }
        | { UserStoreMessage: "Remove" } & { value: string & BRAND<"UID"> },
): Promise<ResultType>
Abstract method that handles all incoming messages
Parameters
- from: ActorRef
  actor that has send the message
- message:
      | { UserStoreMessage: "Create" } & {
          value: {
              active: boolean;
              archived?: Timestamp;
              created: Timestamp;
              email?: string;
              fingerprint?: string;
              initialQuiz?: string;
              isTemporary: boolean;
              lastLogin: Timestamp;
              nickname?: string;
              quizUsage: Map<
                  string & BRAND<"UID">,
                  { name?: string; type: "NAME" | "NICKNAME" | "ANONYMOUS" },
              >;
              role: "STUDENT" | "TEACHER" | "ADMIN";
              uid: string & BRAND<"UID">;
              updated: Timestamp;
              username: string;
          };
      }
      | { UserStoreMessage: "Update" } & {
          value: Partial<
              {
                  active: boolean;
                  archived?: Timestamp;
                  created: Timestamp;
                  email?: string;
                  fingerprint?: string;
                  initialQuiz?: string;
                  isTemporary: boolean;
                  lastLogin: Timestamp;
                  nickname?: string;
                  quizUsage: Map<
                      string & BRAND<"UID">,
                      { name?: string; type: "NAME" | "NICKNAME" | "ANONYMOUS" },
                  >;
                  role: "STUDENT" | "TEACHER" | "ADMIN";
                  uid: string & BRAND<"UID">;
                  updated: Timestamp;
                  username: string;
              },
          > & { uid: string & BRAND<"UID"> };
      }
      | { UserStoreMessage: "GetAll" } & { value: {} }
      | { UserStoreMessage: "SubscribeToCollection" } & { value: string[] }
      | { UserStoreMessage: "UnsubscribeFromCollection" } & { value: {} }
      | { UserStoreMessage: "Get" } & { value: string & BRAND<"UID"> }
      | { UserStoreMessage: "Has" } & { value: string & BRAND<"UID"> }
      | { UserStoreMessage: "SubscribeTo" } & { value: string & BRAND<"UID"> }
      | { UserStoreMessage: "UnsubscribeFrom" } & {
          value: string & BRAND<"UID">;
      }
      | { UserStoreMessage: "Find" } & {
          value: { query: string; role: "STUDENT" | "TEACHER" | "ADMIN" };
      }
      | { UserStoreMessage: "GetOwn" } & { value: {} }
      | { UserStoreMessage: "GetRole" } & { value: string & BRAND<"UID"> }
      | { UserStoreMessage: "GetByFingerprint" } & { value: string }
      | { UserStoreMessage: "GetNames" } & { value: (string & BRAND<"UID">)[] }
      | { UserStoreMessage: "GetTeachers" } & { value: {} }
      | { UserStoreMessage: "IsNicknameUnique" } & { value: string }
      | { UserStoreMessage: "Remove" } & { value: string & BRAND<"UID"> }
  message type
Returns Promise<ResultType>
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/UserStore.ts:91

`Protected`storeEntity

storeEntity(
    entity: {
        active: boolean;
        archived?: Timestamp;
        created: Timestamp;
        email?: string;
        fingerprint?: string;
        initialQuiz?: string;
        isTemporary: boolean;
        lastLogin: Timestamp;
        nickname?: string;
        quizUsage: Map<
            string & BRAND<"UID">,
            { name?: string; type: "NAME" | "NICKNAME" | "ANONYMOUS" },
        >;
        role: "STUDENT" | "TEACHER" | "ADMIN";
        uid: string & BRAND<"UID">;
        updated: Timestamp;
        username: string;
    },
): Promise<
    {
        active: boolean;
        archived?: Timestamp;
        created: Timestamp;
        email?: string;
        fingerprint?: string;
        initialQuiz?: string;
        isTemporary: boolean;
        lastLogin: Timestamp;
        nickname?: string;
        quizUsage: Map<
            string & BRAND<"UID">,
            { name?: string; type: "NAME" | "NICKNAME" | "ANONYMOUS" },
        >;
        role: "STUDENT" | "TEACHER" | "ADMIN";
        uid: string & BRAND<"UID">;
        updated: Timestamp;
        username: string;
    },
>
Parameters
- entity: {
      active: boolean;
      archived?: Timestamp;
      created: Timestamp;
      email?: string;
      fingerprint?: string;
      initialQuiz?: string;
      isTemporary: boolean;
      lastLogin: Timestamp;
      nickname?: string;
      quizUsage: Map<
          string & BRAND<"UID">,
          { name?: string; type: "NAME" | "NICKNAME" | "ANONYMOUS" },
      >;
      role: "STUDENT" | "TEACHER" | "ADMIN";
      uid: string & BRAND<"UID">;
      updated: Timestamp;
      username: string;
  }
Returns Promise<
    {
        active: boolean;
        archived?: Timestamp;
        created: Timestamp;
        email?: string;
        fingerprint?: string;
        initialQuiz?: string;
        isTemporary: boolean;
        lastLogin: Timestamp;
        nickname?: string;
        quizUsage: Map<
            string & BRAND<"UID">,
            { name?: string; type: "NAME" | "NICKNAME" | "ANONYMOUS" },
        >;
        role: "STUDENT" | "TEACHER" | "ADMIN";
        uid: string & BRAND<"UID">;
        updated: Timestamp;
        username: string;
    },
>
Inherited from SubscribableActor.storeEntity
- Defined in backend/src/actors/StoringActor.ts:115

`Protected`updateIndices

updateIndices(
    draft: State,
    user: {
        active: boolean;
        archived?: Timestamp;
        created: Timestamp;
        email?: string;
        fingerprint?: string;
        initialQuiz?: string;
        isTemporary: boolean;
        lastLogin: Timestamp;
        nickname?: string;
        quizUsage: Map<
            string & BRAND<"UID">,
            { name?: string; type: "NAME" | "NICKNAME" | "ANONYMOUS" },
        >;
        role: "STUDENT" | "TEACHER" | "ADMIN";
        uid: string & BRAND<"UID">;
        updated: Timestamp;
        username: string;
    },
): void
Parameters
- draft: State
- user: {
      active: boolean;
      archived?: Timestamp;
      created: Timestamp;
      email?: string;
      fingerprint?: string;
      initialQuiz?: string;
      isTemporary: boolean;
      lastLogin: Timestamp;
      nickname?: string;
      quizUsage: Map<
          string & BRAND<"UID">,
          { name?: string; type: "NAME" | "NICKNAME" | "ANONYMOUS" },
      >;
      role: "STUDENT" | "TEACHER" | "ADMIN";
      uid: string & BRAND<"UID">;
      updated: Timestamp;
      username: string;
  }
Returns void
Overrides SubscribableActor.updateIndices
- Defined in backend/src/actors/UserStore.ts:67

Class UserStore

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UserStore

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

receive

Parameters

Returns Promise<ResultType>

ProtectedstoreEntity

Parameters

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

`Protected`storeEntity

`Protected`updateIndices