FileMaker Data API Tools API - v1.8.0
    Preparing search index...

    Class SettingsService

    Index
    constructor
    migrateDeprecatedSettings consumeDeprecatedSettingsUsed getLoggingLevel getRequestTimeoutMs getDefaultApiBasePath getDefaultApiVersionPath getSavedQueriesScope getSchemaCacheTtlSeconds isSchemaMetadataEnabled getHistoryMaxEntries shouldIncludeAuthInSnippetsByDefault isScriptRunnerEnabled getSchemaSnapshotsStorage getSnapshotsMaxPerLayout isSchemaDiagnosticsEnabled getTypegenOutputDir getBatchMaxRecords getBatchConcurrency getBatchDryRunDefault isRecordEditEnabled isBatchEnabled getContainerUploadMaxBytes isEnterpriseModeEnabled isPowerUserModeEnabled getEnterpriseRole getPerformanceMode isOfflineModeEnabled getOfflineStaleCacheWarnHours getSchemaHashAlgorithm getConnectBackoffPolicy getBridgeRateLimitConfig getConnectionWizardTestPolicy getSessionMaxAgeMs getSessionRefreshLeadMs getNeutralizeExportFormulas getSecretsFallbackMode

    • Moves explicitly set deprecated filemakerDataApiTools.* values to their filemaker.* replacements and removes the old values. Because getPreferred resolves scope by scope with the new key winning inside each scope, copying old to new in a scope where the new key is unset (and dropping an old value the new key already shadows) leaves every effective value unchanged, in this workspace and in any other workspace sharing the user settings. Covers user and workspace scopes; folder-level values are left alone. Returns the old keys that were migrated.

      Returns Promise<string[]>

    • Returns the deprecated setting keys observed this session and clears the set.

      Returns string[]

    • Controls whether the advanced/diagnostic command palette entries (Show Jobs, Open Diagnostics Dashboard, Circuit Breaker, plugins, profile import/export) surface in the FileMaker command palette. Default false to keep the palette focused for new users.

      Returns boolean

    • Returns a hash algorithm name that is guaranteed to be supported by the current Node crypto runtime. Unknown / empty values silently fall back to sha256 and are reported via the optional warning callback so the user sees the rejection.

      Parameters

      • OptionalonInvalid: (configured: string) => void

      Returns string

    • Returns { maxRetries: number; initialMs: number; maxMs: number; multiplier: number }

    • Returns { perSecond: number; burst: number; budget: number }

    • filemaker.export.neutralizeFormulas: user settings only; on unless the user turned it off.

      Returns boolean

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods
    migrateDeprecatedSettingsconsumeDeprecatedSettingsUsedgetLoggingLevelgetRequestTimeoutMsgetDefaultApiBasePathgetDefaultApiVersionPathgetSavedQueriesScopegetSchemaCacheTtlSecondsisSchemaMetadataEnabledgetHistoryMaxEntriesshouldIncludeAuthInSnippetsByDefaultisScriptRunnerEnabledgetSchemaSnapshotsStoragegetSnapshotsMaxPerLayoutisSchemaDiagnosticsEnabledgetTypegenOutputDirgetBatchMaxRecordsgetBatchConcurrencygetBatchDryRunDefaultisRecordEditEnabledisBatchEnabledgetContainerUploadMaxBytesisEnterpriseModeEnabledisPowerUserModeEnabledgetEnterpriseRolegetPerformanceModeisOfflineModeEnabledgetOfflineStaleCacheWarnHoursgetSchemaHashAlgorithmgetConnectBackoffPolicygetBridgeRateLimitConfiggetConnectionWizardTestPolicygetSessionMaxAgeMsgetSessionRefreshLeadMsgetNeutralizeExportFormulasgetSecretsFallbackMode