Type Alias WithProjectDataProviderEngineSettingMethods<TProjectDataTypes>

Type declaration

• getSetting: <ProjectSettingName extends ProjectSettingNames>(
      key: ProjectSettingName,
  ) => Promise<ProjectSettingTypes[ProjectSettingName]>

  Get the value of the specified project setting.

  Note: This is good for retrieving a project setting once. If you want to keep the value up-to-date, use subscribeSetting instead, which can immediately give you the value and keep it up-to-date.

  Note for implementing: getSetting must call papi.projectSettings.getDefault if this project does not have a value for this setting

  Throws

  If no default value is available for the setting.

• resetSetting: <ProjectSettingName extends ProjectSettingNames>(
      key: ProjectSettingName,
  ) => Promise<boolean>

  Deletes the specified project setting, setting it back to its default value.

  Note for implementing: resetSetting should remove the value for this setting for this project such that calling getSetting later would cause it to call papi.projectSettings.getDefault and return the default value.

• setSetting: <ProjectSettingName extends ProjectSettingNames>(
      key: ProjectSettingName,
      newSetting: ProjectSettingTypes[ProjectSettingName],
  ) => Promise<
      DataProviderUpdateInstructions<
          TProjectDataTypes & MandatoryProjectDataTypes,
      >,
  >

  Set the value of the specified project setting on this project.

  Note for implementing: setSetting must call papi.projectSettings.isValid before allowing the setting change.

  Throws

  If the setting validator failed.

  See

  DataProviderUpdateInstructions for more info on what to return