Class CommentActor

Actor representing the comments of a single quiz. This will be started as a child of the corresponding quiz actor

Hierarchy (View Summary)

SubscribableActor<Comment, CommentActorMessage, ResultType>
- CommentActor

Index

Constructors

constructor

new CommentActor(
    name: string,
    system: ActorSystem,
    uid: string & BRAND<"UID">,
): CommentActor
Parameters
- name: string
- system: ActorSystem
- uid: string & BRAND<"UID">
Returns CommentActor
Overrides SubscribableActor.constructor
- Defined in backend/src/actors/CommentActor.ts:46

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>
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<
        {
            answered: boolean;
            archived?: Timestamp;
            authorId: string & BRAND<"UID">;
            authorName: string;
            created: Timestamp;
            relatedQuestion?: string & BRAND<"UID">;
            relatedQuiz: string & BRAND<"UID">;
            text: string;
            uid: string & BRAND<"UID">;
            updated: Timestamp;
            upvoters: (string & BRAND<"UID">)[];
        },
    >,
>
Parameters
- uid: string & BRAND<"UID">
Returns Promise<
    MaybeBase<
        {
            answered: boolean;
            archived?: Timestamp;
            authorId: string & BRAND<"UID">;
            authorName: string;
            created: Timestamp;
            relatedQuestion?: string & BRAND<"UID">;
            relatedQuiz: string & BRAND<"UID">;
            text: string;
            uid: string & BRAND<"UID">;
            updated: Timestamp;
            upvoters: (string & BRAND<"UID">)[];
        },
    >,
>
Inherited from SubscribableActor.getEntity
- Defined in backend/src/actors/StoringActor.ts:90

receive

receive(
    from: ActorRef,
    message:
        | { CommentActorMessage: "Create" } & {
            value: Omit<
                {
                    answered: boolean;
                    archived?: Timestamp;
                    authorId: string & BRAND<"UID">;
                    authorName: string;
                    created: Timestamp;
                    relatedQuestion?: string & BRAND<"UID">;
                    relatedQuiz: string & BRAND<"UID">;
                    text: string;
                    uid: string & BRAND<"UID">;
                    updated: Timestamp;
                    upvoters: (string & BRAND<"UID">)[];
                },
                "uid",
            >;
        }
        | { CommentActorMessage: "Update" } & {
            value: Partial<
                {
                    answered: boolean;
                    archived?: Timestamp;
                    authorId: string & BRAND<"UID">;
                    authorName: string;
                    created: Timestamp;
                    relatedQuestion?: string & BRAND<"UID">;
                    relatedQuiz: string & BRAND<"UID">;
                    text: string;
                    uid: string & BRAND<"UID">;
                    updated: Timestamp;
                    upvoters: (string & BRAND<"UID">)[];
                },
            > & { uid: string & BRAND<"UID"> };
        }
        | { CommentActorMessage: "Upvote" } & {
            value: {
                commentId: string & BRAND<"UID">;
                userId: string & BRAND<"UID">;
            };
        }
        | { CommentActorMessage: "Delete" } & { value: string & BRAND<"UID"> }
        | { CommentActorMessage: "GetAll" } & { value: {} }
        | { CommentActorMessage: "SubscribeToCollection" } & { value: {} }
        | { CommentActorMessage: "UnsubscribeFromCollection" } & { value: {} },
): Promise<ResultType>
Abstract method that handles all incoming messages
Parameters
- from: ActorRef
  actor that has send the message
- message:
      | { CommentActorMessage: "Create" } & {
          value: Omit<
              {
                  answered: boolean;
                  archived?: Timestamp;
                  authorId: string & BRAND<"UID">;
                  authorName: string;
                  created: Timestamp;
                  relatedQuestion?: string & BRAND<"UID">;
                  relatedQuiz: string & BRAND<"UID">;
                  text: string;
                  uid: string & BRAND<"UID">;
                  updated: Timestamp;
                  upvoters: (string & BRAND<"UID">)[];
              },
              "uid",
          >;
      }
      | { CommentActorMessage: "Update" } & {
          value: Partial<
              {
                  answered: boolean;
                  archived?: Timestamp;
                  authorId: string & BRAND<"UID">;
                  authorName: string;
                  created: Timestamp;
                  relatedQuestion?: string & BRAND<"UID">;
                  relatedQuiz: string & BRAND<"UID">;
                  text: string;
                  uid: string & BRAND<"UID">;
                  updated: Timestamp;
                  upvoters: (string & BRAND<"UID">)[];
              },
          > & { uid: string & BRAND<"UID"> };
      }
      | { CommentActorMessage: "Upvote" } & {
          value: {
              commentId: string & BRAND<"UID">;
              userId: string & BRAND<"UID">;
          };
      }
      | { CommentActorMessage: "Delete" } & { value: string & BRAND<"UID"> }
      | { CommentActorMessage: "GetAll" } & { value: {} }
      | { CommentActorMessage: "SubscribeToCollection" } & { value: {} }
      | { CommentActorMessage: "UnsubscribeFromCollection" } & { value: {} }
  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/CommentActor.ts:54

`Protected`storeEntity

storeEntity(
    entity: {
        answered: boolean;
        archived?: Timestamp;
        authorId: string & BRAND<"UID">;
        authorName: string;
        created: Timestamp;
        relatedQuestion?: string & BRAND<"UID">;
        relatedQuiz: string & BRAND<"UID">;
        text: string;
        uid: string & BRAND<"UID">;
        updated: Timestamp;
        upvoters: (string & BRAND<"UID">)[];
    },
): Promise<
    {
        answered: boolean;
        archived?: Timestamp;
        authorId: string & BRAND<"UID">;
        authorName: string;
        created: Timestamp;
        relatedQuestion?: string & BRAND<"UID">;
        relatedQuiz: string & BRAND<"UID">;
        text: string;
        uid: string & BRAND<"UID">;
        updated: Timestamp;
        upvoters: (string & BRAND<"UID">)[];
    },
>
Parameters
- entity: {
      answered: boolean;
      archived?: Timestamp;
      authorId: string & BRAND<"UID">;
      authorName: string;
      created: Timestamp;
      relatedQuestion?: string & BRAND<"UID">;
      relatedQuiz: string & BRAND<"UID">;
      text: string;
      uid: string & BRAND<"UID">;
      updated: Timestamp;
      upvoters: (string & BRAND<"UID">)[];
  }
Returns Promise<
    {
        answered: boolean;
        archived?: Timestamp;
        authorId: string & BRAND<"UID">;
        authorName: string;
        created: Timestamp;
        relatedQuestion?: string & BRAND<"UID">;
        relatedQuiz: string & BRAND<"UID">;
        text: string;
        uid: string & BRAND<"UID">;
        updated: Timestamp;
        upvoters: (string & BRAND<"UID">)[];
    },
>
Inherited from SubscribableActor.storeEntity
- Defined in backend/src/actors/StoringActor.ts:115

`Protected`updateIndices

updateIndices(
    _draft: State,
    _quiz: {
        answered: boolean;
        archived?: Timestamp;
        authorId: string & BRAND<"UID">;
        authorName: string;
        created: Timestamp;
        relatedQuestion?: string & BRAND<"UID">;
        relatedQuiz: string & BRAND<"UID">;
        text: string;
        uid: string & BRAND<"UID">;
        updated: Timestamp;
        upvoters: (string & BRAND<"UID">)[];
    },
): void
Parameters
- _draft: State
- _quiz: {
      answered: boolean;
      archived?: Timestamp;
      authorId: string & BRAND<"UID">;
      authorName: string;
      created: Timestamp;
      relatedQuestion?: string & BRAND<"UID">;
      relatedQuiz: string & BRAND<"UID">;
      text: string;
      uid: string & BRAND<"UID">;
      updated: Timestamp;
      upvoters: (string & BRAND<"UID">)[];
  }
Returns void
Overrides SubscribableActor.updateIndices
- Defined in backend/src/actors/CommentActor.ts:42

Class CommentActor

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CommentActor

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