Class SessionPreferenceProvider

ReadonlyonDidPreferencesChanged

ready

• get ready(): Promise<void>

  Resolved when the preference provider is ready to provide preferences It should be resolved by subclasses.

  Returns Promise<void>

dispose

• dispose(): void

  Dispose this object.

  Returns void

get

• get<T>(preferenceName: string, resourceUri?: string): undefined | T

  Retrieve the stored value for the given preference and resource URI.

  Type Parameters

  • T

  Parameters

  • preferenceName: string

    the preference identifier.

  • OptionalresourceUri: string

    the uri of the resource for which the preference is stored. This is used to retrieve a potentially different value for the same preference for different resources, for example files.encoding.

  Returns undefined | T

  the value stored for the given preference and resourceUri if it exists, otherwise undefined.

getConfigUri

• getConfigUri(resourceUri?: string, sectionName?: string): undefined | URI

  Retrieve the configuration URI for the given resource URI.

  Parameters

  • OptionalresourceUri: string

    the uri of the resource or undefined.

  • OptionalsectionName: string

    the section to return the URI for, e.g. tasks or launch. Defaults to settings.

  Returns undefined | URI

  the corresponding resource URI or undefined if there is no valid URI.

OptionalgetContainingConfigUri

• getContainingConfigUri?(
      resourceUri?: string,
      sectionName?: string,
  ): undefined | URI

  Retrieves the first valid configuration URI contained by the given resource.

  Parameters

  • OptionalresourceUri: string

    the uri of the container resource or undefined.

  • OptionalsectionName: string

  Returns undefined | URI

  the first valid configuration URI contained by the given resource undefined if there is no valid configuration URI at all.

getDomain

• getDomain(): undefined | string[]

  Retrieve the domain for this provider.

  Returns undefined | string[]

  the domain or undefined if this provider is suitable for all domains.

resolve

• resolve<T>(
      preferenceName: string,
      resourceUri?: string,
  ): PreferenceResolveResult<T>

  Resolve the value for the given preference and resource URI.

  Type Parameters

  • T

  Parameters

  • preferenceName: string

    the preference identifier.

  • OptionalresourceUri: string

    the URI of the resource for which this provider should resolve the preference. This is used to retrieve a potentially different value for the same preference for different resources, for example files.encoding.

  Returns PreferenceResolveResult<T>

  an object containing the value stored for the given preference and resourceUri if it exists, otherwise undefined.