citric.enums¶

Useful enums.

Classes¶

`StringEnum`	Enum with string values.
`ImportGroupType`	Group file type.
`ImportSurveyType`	Survey file type.
`NewSurveyType`	New survey type.
`StatisticsExportFormat`	Statistics export type.
`ResponsesExportFormat`	Responses export type.
`SurveyCompletionStatus`	Survey completion status values.
`HeadingType`	Types of heading in responses export.
`ResponseType`	Types of responses in export.
`TimelineAggregationPeriod`	Timeline aggregation level.
`QuotaAction`	Quota action.
`EmailSendStrategy`	Email send flag.
`UserStatus`	User status.

Module Contents¶

class citric.enums.StringEnum[source]¶

Bases: str, enum.Enum

Enum with string values.

class citric.enums.ImportGroupType[source]¶

Bases: StringEnum

Group file type.

LSG = 'lsg'[source]¶

CSV = 'csv'[source]¶

class citric.enums.ImportSurveyType[source]¶

Bases: StringEnum

Survey file type.

LSS = 'lss'[source]¶

CSV = 'csv'[source]¶

TXT = 'txt'[source]¶

LSA = 'lsa'[source]¶

class citric.enums.NewSurveyType[source]¶

Bases: StringEnum

New survey type.

ALL_ON_ONE_PAGE = 'A'[source]¶

GROUP_BY_GROUP = 'G'[source]¶

SINGLE_QUESTIONS = 'S'[source]¶

class citric.enums.StatisticsExportFormat[source]¶

Bases: StringEnum

Statistics export type.

PDF = 'pdf'[source]¶

XLS = 'xls'[source]¶

HTML = 'html'[source]¶

class citric.enums.ResponsesExportFormat[source]¶

Bases: StringEnum

Responses export type.

PDF = 'pdf'[source]¶

CSV = 'csv'[source]¶

XLS = 'xls'[source]¶

DOC = 'doc'[source]¶

JSON = 'json'[source]¶

class citric.enums.SurveyCompletionStatus[source]¶

Bases: StringEnum

Survey completion status values.

COMPLETE = 'complete'[source]¶

INCOMPLETE = 'incomplete'[source]¶

ALL = 'all'[source]¶

class citric.enums.HeadingType[source]¶

Bases: StringEnum

Types of heading in responses export.

CODE = 'code'[source]¶

FULL = 'full'[source]¶

ABBREVIATED = 'abbreviated'[source]¶

class citric.enums.ResponseType[source]¶

Bases: StringEnum

Types of responses in export.

LONG = 'long'[source]¶

SHORT = 'short'[source]¶

class citric.enums.TimelineAggregationPeriod[source]¶

Bases: StringEnum

Timeline aggregation level.

HOUR = 'hour'[source]¶

DAY = 'day'[source]¶

class citric.enums.QuotaAction[source]¶

Bases: StringEnum

Quota action.

TERMINATE = 'terminate'[source]¶: Terminate after related visible question was submitted.

CONFIRM_TERMINATE = 'confirm_terminate'[source]¶: Soft terminate after related visible question was submitted, answer will be editable.

TERMINATE_VISIBLE_HIDDEN = 'terminate_visible_hidden'[source]¶: Terminate after related visible and hidden questions were submitted.

Added in version NEXT_VERSION.

Warning

This attribute is only supported in LimeSurvey 6.6.7 and above.

TERMINATE_PAGES = 'terminate_pages'[source]¶: Terminate after all page submissions.

Added in version NEXT_VERSION.

Warning

This attribute is only supported in LimeSurvey 6.6.7 and above.

property integer_value: int[source]¶

Return database value of the action.

Returns:: Database value of the action.
Return type:: int

class citric.enums.EmailSendStrategy[source]¶

Bases: enum.IntEnum

Email send flag.

PENDING = 1[source]¶

RESEND = 2[source]¶

classmethod to_flag(value)[source]¶

Return the flag for this email send enum.

class citric.enums.UserStatus[source]¶

Bases: enum.IntEnum

User status.

ACTIVATED = 1[source]¶

DEACTIVATED = 0[source]¶