VariablesettingsServiceObjectToProxyConst

Type declaration

• dataProviderName: "platform.settingsServiceDataProvider"

  This name is used to register the settings service data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

• registerValidator: (<SettingName>(key: SettingName, validator: SettingValidator<SettingName>) => Promise<UnsubscriberAsync>)

  Registers a function that validates whether a new setting value is allowed to be set.

  • • <SettingName>(key, validator): Promise<UnsubscriberAsync>

    • Type Parameters

      • SettingName extends keyof SettingTypes

      Parameters

      • key: SettingName

        The string id of the setting to validate
      • validator: SettingValidator<SettingName>

        Function to call to validate the new setting value

      Returns Promise<UnsubscriberAsync>

      Unsubscriber that should be called whenever the providing extension is deactivated