Class RecordUpsertForm

constructor

• new RecordUpsertForm(app, record): RecordUpsertForm

• Parameters

  • app: excludeHooks<App>

  • record: models.Record

  Returns RecordUpsertForm

addFiles

• addFiles(key, ...files): void

• AddFiles adds the provided file(s) to the specified file field.

  If the file field is a SINGLE-value file field (aka. "Max Select = 1"), then the newly added file will REPLACE the existing one. In this case if you pass more than 1 files only the first one will be assigned.

  If the file field is a MULTI-value file field (aka. "Max Select > 1"), then the newly added file(s) will be APPENDED to the existing one(s).

  Example

   f1, _ := filesystem.NewFileFromPath("/path/to/file1.txt")
   f2, _ := filesystem.NewFileFromPath("/path/to/file2.txt")
   form.AddFiles("documents", f1, f2)
  Copy

  Parameters

  • key: string

  • Rest ...files: filesystem.File[]

  Returns void

data

• data(): _TygojaDict

• Data returns the loaded form's data.

  Returns _TygojaDict

drySubmit

• drySubmit(callback): void

• DrySubmit performs a form submit within a transaction and reverts it. For actual record persistence, check the form.Submit() method.

  This method doesn't handle file uploads/deletes or trigger any app events!

  Parameters

  • callback: ((txDao) => void)

    • • (txDao): void

      • Parameters

        • txDao: daos.Dao

        Returns void

  Returns void

filesToDelete

• filesToDelete(): string[]

• FilesToUpload returns the parsed request filenames ready to be deleted.

  Returns string[]

filesToUpload

• filesToUpload(): _TygojaDict

• FilesToUpload returns the parsed request files ready for upload.

  Returns _TygojaDict

loadData

• loadData(requestData): void

• LoadData loads and normalizes the provided regular record data fields into the form.

  Parameters

  • requestData: _TygojaDict

  Returns void

loadRequest

• loadRequest(r, keyPrefix): void

• LoadRequest extracts the json or multipart/form-data request data and lods it into the form.

  File upload is supported only via multipart/form-data.

  Parameters

  • r: Request

  • keyPrefix: string

  Returns void

removeFiles

• removeFiles(key, ...toDelete): void

• RemoveFiles removes a single or multiple file from the specified file field.

  NB! If filesToDelete is not set it will remove all existing files assigned to the file field (including those assigned with AddFiles)!

  Example

   // mark only only 2 files for removal
   form.RemoveFiles("documents", "file1_aw4bdrvws6.txt", "file2_xwbs36bafv.txt")
  
   // mark all "documents" files for removal
   form.RemoveFiles("documents")
  Copy

  Parameters

  • key: string

  • Rest ...toDelete: string[]

  Returns void

setDao

• setDao(dao): void

• SetDao replaces the default form Dao instance with the provided one.

  Parameters

  • dao: daos.Dao

  Returns void

setFullManageAccess

• setFullManageAccess(fullManageAccess): void

• SetFullManageAccess sets the manageAccess bool flag of the current form to enable/disable directly changing some system record fields (often used with auth collection records).

  Parameters

  • fullManageAccess: boolean

  Returns void

submit

• submit(...interceptors): void

• Submit validates the form and upserts the form Record model.

  You can optionally provide a list of InterceptorFunc to further modify the form behavior before persisting it.

  Parameters

  • Rest ...interceptors: InterceptorFunc<models.Record>[]

  Returns void

validate

• validate(): void

• Validate makes the form validatable by implementing [validation.Validatable] interface.

  Returns void

validateAndFill

• validateAndFill(): void

• Returns void

email

emailVisibility

id

oldPassword

password

passwordConfirm

username

verified