Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "lib/model"

Index

Type aliases

Type aliases

FieldCheck

FieldCheck: { checked: string[]; type: "CHECK" }

Type declaration

  • checked: string[]
  • type: "CHECK"

FieldDate

FieldDate: { date: Date; type: "DATE" }

Type declaration

  • date: Date
  • type: "DATE"

FieldInt

FieldInt: { type: "INT"; valueInt: number }

Type declaration

  • type: "INT"
  • valueInt: number

FieldList

FieldList: { text: string; type: "LIST" }

Type declaration

  • text: string
  • type: "LIST"

FieldNumber

FieldNumber: { type: "NUMBER"; value: number }

Type declaration

  • type: "NUMBER"
  • value: number

FieldRange

FieldRange: { max: number; min: number; type: "RANGE" }

Type declaration

  • max: number
  • min: number
  • type: "RANGE"

FieldText

FieldText: { text: string; type: "TEXT" }

Type declaration

  • text: string
  • type: "TEXT"

FieldType

FieldType: { id: string; immutable: boolean; info?: undefined | string; name: string; options?: string[]; required: boolean; type: "NUMBER" | "TEXT" | "RANGE" | "LIST" | "CHECK" | "INT" | "DATE" }

Type declaration

  • id: string
  • immutable: boolean
  • Optional info?: undefined | string
  • name: string
  • Optional options?: string[]
  • required: boolean
  • type: "NUMBER" | "TEXT" | "RANGE" | "LIST" | "CHECK" | "INT" | "DATE"

Form

Form: { allowAudio: boolean; allowImage: boolean; allowVideo: boolean; id: string; name: string; specificList: FormSpecific[] }

Type declaration

  • allowAudio: boolean
  • allowImage: boolean
  • allowVideo: boolean
  • id: string
  • name: string
  • specificList: FormSpecific[]

FormSpecific

FormSpecific: { id: string; markerStyle: MarkerStyle; name: string; questions: FieldType[] }

Type declaration

MarkerStyle

MarkerStyle: { iconFieldType?: undefined | string; iconNumberRanges?: number[]; image: string; imageNumber: number }

image: file name of the icon list imageNumber: number of icon in the icon list iconFieldType?: id of the field that controls the icon (FieldList or FieldText) iconNumberRanges?: ranges for the icon if the field is type number

Type declaration

  • Optional iconFieldType?: undefined | string
  • Optional iconNumberRanges?: number[]
  • image: string
  • imageNumber: number

Media

Media: { fileName: string; type: "IMAGE" | "AUDIO" | "VIDEO" }

Type declaration

  • fileName: string
  • type: "IMAGE" | "AUDIO" | "VIDEO"

Project

Project: { formList: Form[]; name: string; userList: ProjectUser[]; webHookList: WebHook[] }

Type declaration

ProjectUser

ProjectUser: { formList: string[]; preferences: any; role: "ADMIN" | "MOD" | "USER"; username: string }

Type declaration

  • formList: string[]
  • preferences: any
  • role: "ADMIN" | "MOD" | "USER"
  • username: string

Record

Record: { altitude: number; data: unknown; datetimeUtc: Date; featureId: string; formId: string; formSpecificId: string; latitude: number; longitude: number; mediaList: Media[]; projectName: string; recordId: string; username: string; zone: string }

zone: "Europe/Paris"

data is an object where the keys are the FieldType names and the values are the Fields, following these rules:

  • "NUMBER": FieldNumber
  • "TEXT": FieldText
  • "RANGE": FieldRange
  • "LIST": FieldList
  • "CHECK": FieldCheck
  • "INT": FieldInt
  • "DATE": FieldDate

Type declaration

  • altitude: number
  • data: unknown
  • datetimeUtc: Date
  • featureId: string
  • formId: string
  • formSpecificId: string
  • latitude: number
  • longitude: number
  • mediaList: Media[]
  • projectName: string
  • recordId: string
  • username: string
  • zone: string

User

User: { mail: string; password: string; username: string; verified: boolean }

Type declaration

  • mail: string
  • password: string
  • username: string
  • verified: boolean

WebHook

WebHook: { name: string; url: string }

Type declaration

  • name: string
  • url: string

Generated using TypeDoc