Interface IWorkspaceSettings
- Namespace
- RDCore.SDK.Server.Configuration
- Assembly
- RDCore.SDK.dll
The settings of a workspace: the lists that apply to that workspace only, for whoever opens it, such as the codes of the diagnostics it disables
(Analysis.DisabledDiagnostics).
public interface IWorkspaceSettings
Remarks
A setting of a workspace adds to the user's setting of the platform: a code either one disables is disabled (DisabledCodesWith(IEnumerable<string>)). What a workspace keeps is checked as the user's settings are: an item that is not a value of the setting is neither kept nor read.
Where a workspace keeps its settings is the implementation's to say. A client changes them as a change of its own, as it changes the user's settings: the
language server asks it to (rdcore/settings/listValue).
Methods
Add(Uri, string, string)
Adds items to the list a workspace has for a setting whose value is a list, as Add(string, string) adds them to the user's.
UserSettingChange Add(Uri workspaceRoot, string key, string value)
Parameters
workspaceRootUriThe root folder of the workspace.
keystringThe key of the setting, without regard to case.
valuestringThe item, or items, as they are written:
RDC01001.
Returns
- UserSettingChange
What became of the value.
Read(Uri, string)
The items of the list a workspace has for a setting; none when it has none.
IReadOnlyList<string> Read(Uri workspaceRoot, string key)
Parameters
workspaceRootUriThe root folder of the workspace.
keystringThe key of the setting, without regard to case:
Analysis.DisabledDiagnostics.
Returns
Remove(Uri, string, string)
Removes items from the list a workspace has for a setting whose value is a list, as Remove(string, string) removes them from the user's.
UserSettingChange Remove(Uri workspaceRoot, string key, string value)
Parameters
workspaceRootUriThe root folder of the workspace.
keystringThe key of the setting, without regard to case.
valuestringThe item, or items, as they are written:
RDC01001.
Returns
- UserSettingChange
What became of the value.