event

package
v0.0.12 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 16, 2023 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package event defines the event emitted by the state machine.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Event

type Event struct {
	common.Common `bson:",inline"`

	// PreviousQuestion is the previous question.
	PreviousQuestion question.Question `json:"previousQuestion" bson:"previousQuestion"`

	// CurrentQuestion is the current question.
	CurrentQuestion question.Question `json:"currentQuestion" bson:"currentQuestion"`

	// CurrentQuestionIndex is the current question index.
	CurrentQuestionIndex int `json:"currentQuestionIndex" bson:"currentQuestionIndex"`

	// CurrentAnswer is the current answer.
	CurrentAnswer answer.Answer `json:"currentAnswer" bson:"currentAnswer"`

	// State is the current state of the questionnaire.
	State status.Status `json:"state" bson:"state"`

	// TotalAnswers is the total number of answers.
	TotalAnswers int `json:"totalAnswers" bson:"totalAnswers"`

	// TotalQuestions is the total number of questions.
	TotalQuestions int `json:"totalQuestions" bson:"totalQuestions"`

	// Answers is the list of answers.
	Answers *safeorderedmap.SafeOrderedMap[answer.Answer] `json:"answers" bson:"answers"`

	// Questionnaire is the questionnaire.
	Questionnaire questionnaire.Questionnaire `json:"questionnaire" bson:"questionnaire" validate:"-"`

	// UserID is the ID of the user.
	UserID string `json:"userID" bson:"userID"`
}

Event emitted every time the state of the questionnaire changes.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL