Recapp Code Reference
    Preparing search index...

    Class QuizActor

    Actor representing a quiz. Will also start a child actors for quiz comments

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    collectionName connector state

    Methods

    afterEntityRemovedFromCache afterEntityWasCached afterStart beforeShutdown cleanup deleteEntity determineRole getEntity receive storeEntity updateIndices

    Constructors

    Properties

    collectionName: string
    connector: DbClient = ...
    state: State = ...

    Methods

    • Parameters

      • from: ActorRef

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

    • Parameters

      • uid: string & BRAND<"UID">

      Returns Promise<
          MaybeBase<
              {
                  allowedQuestionTypesSettings: Partial<
                      Record<"SINGLE" | "MULTIPLE" | "TEXT", boolean>,
                  >;
                  archived?: Timestamp;
                  comments: (string & BRAND<"UID">)[];
                  created: Timestamp;
                  createdBy?: string & BRAND<"UID">;
                  description: string;
                  groups: {
                      name: string;
                      questions: (string & BRAND<"UID">)[];
                      statistics?: {
                          answers: number[];
                          correctAnswers: number[];
                          groupName: string;
                          maximumParticipants: number;
                          questionIds: (string & BRAND<"UID">)[];
                          quizId: string & BRAND<"UID">;
                          wrongAnswers: number[];
                      };
                  }[];
                  hideComments: boolean;
                  lastExport?: Timestamp;
                  previewers?: (string & BRAND<"UID">)[];
                  runOptions?: { runningEntity?: string & BRAND<"UID"> };
                  shuffleAnswers: boolean;
                  shuffleQuestions: boolean;
                  state: "EDITING" | "ACTIVE" | "STARTED" | "STOPPED";
                  statistics?: {
                      answers: number[];
                      correctAnswers: number[];
                      groupName: string;
                      maximumParticipants: number;
                      questionIds: (string & BRAND<"UID">)[];
                      quizId: string & BRAND<"UID">;
                      wrongAnswers: number[];
                  };
                  studentComments: boolean;
                  studentParticipationSettings: Partial<
                      Record<"NAME" | "NICKNAME" | "ANONYMOUS", boolean>,
                  >;
                  studentQuestions: boolean;
                  students: (string & BRAND<"UID">)[];
                  studentsCanSeeStatistics?: boolean;
                  teachers: (string & BRAND<"UID">)[];
                  title: string;
                  uid: string & BRAND<"UID">;
                  uniqueLink: string;
                  updated: Timestamp;
              },
          >,
      >

    • Abstract method that handles all incoming messages

      Parameters

      • from: ActorRef

        actor that has send the message

      • message:
            | { QuizActorMessage: "Create" } & {
                value: Omit<
                    {
                        allowedQuestionTypesSettings: Partial<
                            Record<"SINGLE" | "MULTIPLE" | "TEXT", boolean>,
                        >;
                        archived?: Timestamp;
                        comments: (string & BRAND<"UID">)[];
                        created: Timestamp;
                        createdBy?: string & BRAND<"UID">;
                        description: string;
                        groups: {
                            name: string;
                            questions: (string & BRAND<"UID">)[];
                            statistics?: {
                                answers: number[];
                                correctAnswers: number[];
                                groupName: string;
                                maximumParticipants: number;
                                questionIds: ((...) & (...))[];
                                quizId: string & BRAND<(...)>;
                                wrongAnswers: number[];
                            };
                        }[];
                        hideComments: boolean;
                        lastExport?: Timestamp;
                        previewers?: (string & BRAND<"UID">)[];
                        runOptions?: { runningEntity?: string & BRAND<"UID"> };
                        shuffleAnswers: boolean;
                        shuffleQuestions: boolean;
                        state: "EDITING" | "ACTIVE" | "STARTED" | "STOPPED";
                        statistics?: {
                            answers: number[];
                            correctAnswers: number[];
                            groupName: string;
                            maximumParticipants: number;
                            questionIds: (string & BRAND<"UID">)[];
                            quizId: string & BRAND<"UID">;
                            wrongAnswers: number[];
                        };
                        studentComments: boolean;
                        studentParticipationSettings: Partial<
                            Record<"NAME" | "NICKNAME" | "ANONYMOUS", boolean>,
                        >;
                        studentQuestions: boolean;
                        students: (string & BRAND<"UID">)[];
                        studentsCanSeeStatistics?: boolean;
                        teachers: (string & BRAND<"UID">)[];
                        title: string;
                        uid: string & BRAND<"UID">;
                        uniqueLink: string;
                        updated: Timestamp;
                    },
                    "uid"
                    | "uniqueLink",
                >;
            }
            | { QuizActorMessage: "Update" } & {
                value: Partial<
                    {
                        allowedQuestionTypesSettings: Partial<
                            Record<"SINGLE" | "MULTIPLE" | "TEXT", boolean>,
                        >;
                        archived?: Timestamp;
                        comments: (string & BRAND<"UID">)[];
                        created: Timestamp;
                        createdBy?: string & BRAND<"UID">;
                        description: string;
                        groups: {
                            name: string;
                            questions: (string & BRAND<(...)>)[];
                            statistics?: {
                                answers: (...)[];
                                correctAnswers: (...)[];
                                groupName: string;
                                maximumParticipants: number;
                                questionIds: (...)[];
                                quizId: (...) & (...);
                                wrongAnswers: (...)[];
                            };
                        }[];
                        hideComments: boolean;
                        lastExport?: Timestamp;
                        previewers?: (string & BRAND<"UID">)[];
                        runOptions?: { runningEntity?: string & BRAND<(...)> };
                        shuffleAnswers: boolean;
                        shuffleQuestions: boolean;
                        state: "EDITING" | "ACTIVE" | "STARTED" | "STOPPED";
                        statistics?: {
                            answers: number[];
                            correctAnswers: number[];
                            groupName: string;
                            maximumParticipants: number;
                            questionIds: (string & BRAND<(...)>)[];
                            quizId: string & BRAND<"UID">;
                            wrongAnswers: number[];
                        };
                        studentComments: boolean;
                        studentParticipationSettings: Partial<
                            Record<"NAME" | "NICKNAME" | "ANONYMOUS", boolean>,
                        >;
                        studentQuestions: boolean;
                        students: (string & BRAND<"UID">)[];
                        studentsCanSeeStatistics?: boolean;
                        teachers: (string & BRAND<"UID">)[];
                        title: string;
                        uid: string & BRAND<"UID">;
                        uniqueLink: string;
                        updated: Timestamp;
                    },
                > & { uid: string & BRAND<"UID"> };
            }
            | { QuizActorMessage: "Delete" } & { value: string & BRAND<"UID"> }
            | { QuizActorMessage: "GetAll" } & { value: {} }
            | { QuizActorMessage: "SubscribeToCollection" } & { value: string[] }
            | { QuizActorMessage: "UnsubscribeFromCollection" } & { value: {} }
            | { QuizActorMessage: "Get" } & { value: string & BRAND<"UID"> }
            | { QuizActorMessage: "Import" } & {
                value: {
                    filename: string;
                    titlePrefix: string | undefined;
                    userId: string & BRAND<"UID"> | undefined;
                    userRole: "STUDENT" | "TEACHER" | "ADMIN" | undefined;
                };
            }
            | { QuizActorMessage: "Has" } & { value: string & BRAND<"UID"> }
            | { QuizActorMessage: "AddTeacher" } & {
                value: { quiz: string & BRAND<"UID">; teacher: string & BRAND<"UID"> };
            }
            | { QuizActorMessage: "AddStudent" } & {
                value: { quiz: string & BRAND<"UID">; student: string & BRAND<"UID"> };
            }
            | { QuizActorMessage: "RemoveUser" } & {
                value: { quiz: string & BRAND<"UID">; user: string & BRAND<"UID"> };
            }
            | { QuizActorMessage: "SubscribeTo" } & { value: string & BRAND<"UID"> }
            | { QuizActorMessage: "UnsubscribeFrom" } & {
                value: string & BRAND<"UID">;
            }
            | { QuizActorMessage: "Export" } & { value: string & BRAND<"UID"> }
            | { QuizActorMessage: "Duplicate" } & { value: string & BRAND<"UID"> }
            | { QuizActorMessage: "GetUserRun" } & {
                value: {
                    quizId: string & BRAND<"UID">;
                    studentId: string & BRAND<"UID">;
                };
            }

        message type

      Returns Promise<any>

      promised return value. If the caller used ask, this value will be returned to the calling actor

    • Parameters

      • entity: {
            allowedQuestionTypesSettings: Partial<
                Record<"SINGLE" | "MULTIPLE" | "TEXT", boolean>,
            >;
            archived?: Timestamp;
            comments: (string & BRAND<"UID">)[];
            created: Timestamp;
            createdBy?: string & BRAND<"UID">;
            description: string;
            groups: {
                name: string;
                questions: (string & BRAND<"UID">)[];
                statistics?: {
                    answers: number[];
                    correctAnswers: number[];
                    groupName: string;
                    maximumParticipants: number;
                    questionIds: (string & BRAND<"UID">)[];
                    quizId: string & BRAND<"UID">;
                    wrongAnswers: number[];
                };
            }[];
            hideComments: boolean;
            lastExport?: Timestamp;
            previewers?: (string & BRAND<"UID">)[];
            runOptions?: { runningEntity?: string & BRAND<"UID"> };
            shuffleAnswers: boolean;
            shuffleQuestions: boolean;
            state: "EDITING" | "ACTIVE" | "STARTED" | "STOPPED";
            statistics?: {
                answers: number[];
                correctAnswers: number[];
                groupName: string;
                maximumParticipants: number;
                questionIds: (string & BRAND<"UID">)[];
                quizId: string & BRAND<"UID">;
                wrongAnswers: number[];
            };
            studentComments: boolean;
            studentParticipationSettings: Partial<
                Record<"NAME" | "NICKNAME" | "ANONYMOUS", boolean>,
            >;
            studentQuestions: boolean;
            students: (string & BRAND<"UID">)[];
            studentsCanSeeStatistics?: boolean;
            teachers: (string & BRAND<"UID">)[];
            title: string;
            uid: string & BRAND<"UID">;
            uniqueLink: string;
            updated: Timestamp;
        }

      Returns Promise<
          {
              allowedQuestionTypesSettings: Partial<
                  Record<"SINGLE" | "MULTIPLE" | "TEXT", boolean>,
              >;
              archived?: Timestamp;
              comments: (string & BRAND<"UID">)[];
              created: Timestamp;
              createdBy?: string & BRAND<"UID">;
              description: string;
              groups: {
                  name: string;
                  questions: (string & BRAND<"UID">)[];
                  statistics?: {
                      answers: number[];
                      correctAnswers: number[];
                      groupName: string;
                      maximumParticipants: number;
                      questionIds: (string & BRAND<"UID">)[];
                      quizId: string & BRAND<"UID">;
                      wrongAnswers: number[];
                  };
              }[];
              hideComments: boolean;
              lastExport?: Timestamp;
              previewers?: (string & BRAND<"UID">)[];
              runOptions?: { runningEntity?: string & BRAND<"UID"> };
              shuffleAnswers: boolean;
              shuffleQuestions: boolean;
              state: "EDITING" | "ACTIVE" | "STARTED" | "STOPPED";
              statistics?: {
                  answers: number[];
                  correctAnswers: number[];
                  groupName: string;
                  maximumParticipants: number;
                  questionIds: (string & BRAND<"UID">)[];
                  quizId: string & BRAND<"UID">;
                  wrongAnswers: number[];
              };
              studentComments: boolean;
              studentParticipationSettings: Partial<
                  Record<"NAME" | "NICKNAME" | "ANONYMOUS", boolean>,
              >;
              studentQuestions: boolean;
              students: (string & BRAND<"UID">)[];
              studentsCanSeeStatistics?: boolean;
              teachers: (string & BRAND<"UID">)[];
              title: string;
              uid: string & BRAND<"UID">;
              uniqueLink: string;
              updated: Timestamp;
          },
      >

    • Parameters

      • _draft: State
      • _quiz: {
            allowedQuestionTypesSettings: Partial<
                Record<"SINGLE" | "MULTIPLE" | "TEXT", boolean>,
            >;
            archived?: Timestamp;
            comments: (string & BRAND<"UID">)[];
            created: Timestamp;
            createdBy?: string & BRAND<"UID">;
            description: string;
            groups: {
                name: string;
                questions: (string & BRAND<"UID">)[];
                statistics?: {
                    answers: number[];
                    correctAnswers: number[];
                    groupName: string;
                    maximumParticipants: number;
                    questionIds: (string & BRAND<"UID">)[];
                    quizId: string & BRAND<"UID">;
                    wrongAnswers: number[];
                };
            }[];
            hideComments: boolean;
            lastExport?: Timestamp;
            previewers?: (string & BRAND<"UID">)[];
            runOptions?: { runningEntity?: string & BRAND<"UID"> };
            shuffleAnswers: boolean;
            shuffleQuestions: boolean;
            state: "EDITING" | "ACTIVE" | "STARTED" | "STOPPED";
            statistics?: {
                answers: number[];
                correctAnswers: number[];
                groupName: string;
                maximumParticipants: number;
                questionIds: (string & BRAND<"UID">)[];
                quizId: string & BRAND<"UID">;
                wrongAnswers: number[];
            };
            studentComments: boolean;
            studentParticipationSettings: Partial<
                Record<"NAME" | "NICKNAME" | "ANONYMOUS", boolean>,
            >;
            studentQuestions: boolean;
            students: (string & BRAND<"UID">)[];
            studentsCanSeeStatistics?: boolean;
            teachers: (string & BRAND<"UID">)[];
            title: string;
            uid: string & BRAND<"UID">;
            uniqueLink: string;
            updated: Timestamp;
        }

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods