ISettingsService.InitAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| InitAsync(String, String) | |
| InitAsync(String, String, Guid) | |
| InitAsync(String, Boolean, Int32, Guid, String) |
Initializes the service. Must be called once and only once per client connection, before any of the other methods. |
| InitAsync(String, Boolean, Int32, String, Guid, String) |
Initializes the service. Must be called once and only once per client connection, before any of the other methods. |
InitAsync(String, String)
public System.Threading.Tasks.Task InitAsync (string collectionName, string telemetrySettings = default);abstract member InitAsync : string * string -> System.Threading.Tasks.TaskPublic Function InitAsync (collectionName As String, Optional telemetrySettings As String = Nothing) As TaskParameters
- collectionName
- String
- telemetrySettings
- String
Returns
Applies to
InitAsync(String, String, Guid)
public System.Threading.Tasks.Task InitAsync (string collectionName, string telemetrySettings = default, Guid clientId = default);abstract member InitAsync : string * string * Guid -> System.Threading.Tasks.TaskPublic Function InitAsync (collectionName As String, Optional telemetrySettings As String = Nothing, Optional clientId As Guid = Nothing) As TaskParameters
- collectionName
- String
- telemetrySettings
- String
- clientId
- Guid
Returns
Applies to
InitAsync(String, Boolean, Int32, Guid, String)
Initializes the service. Must be called once and only once per client connection, before any of the other methods.
public System.Threading.Tasks.Task InitAsync (string collectionName, bool isRoamingEnabled, int roamingEnabledRevision, Guid clientId = default, string durableClientIdentity = default);abstract member InitAsync : string * bool * int * Guid * string -> System.Threading.Tasks.TaskPublic Function InitAsync (collectionName As String, isRoamingEnabled As Boolean, roamingEnabledRevision As Integer, Optional clientId As Guid = Nothing, Optional durableClientIdentity As String = Nothing) As TaskParameters
- collectionName
- String
The collection of settings to target. Each collection is isolated from the others. Typically a specific client instance will target a single collection. In VS, the collection matches the /rootSuffix parameter of the client, facilitating scenarios like isolation of the experimental hive for extension development. Must be non-null; empty string is OK.
- isRoamingEnabled
- Boolean
Tells the service whether to synchronize with the user's online settings.
- roamingEnabledRevision
- Int32
The client's stored revision number for the roaming enabled setting. This is used to avoid overwriting a more recently updated value.
- clientId
- Guid
The idenitifier of the client
- durableClientIdentity
- String
The identifier of the client, i.e. a devenv instance
Returns
Exceptions
Thrown when this is called more than once.
Applies to
InitAsync(String, Boolean, Int32, String, Guid, String)
Initializes the service. Must be called once and only once per client connection, before any of the other methods.
public System.Threading.Tasks.Task InitAsync (string collectionName, bool isRoamingEnabled, int roamingEnabledRevision, string telemetrySettings = default, Guid clientId = default, string durableClientIdentity = default);abstract member InitAsync : string * bool * int * string * Guid * string -> System.Threading.Tasks.TaskPublic Function InitAsync (collectionName As String, isRoamingEnabled As Boolean, roamingEnabledRevision As Integer, Optional telemetrySettings As String = Nothing, Optional clientId As Guid = Nothing, Optional durableClientIdentity As String = Nothing) As TaskParameters
- collectionName
- String
The collection of settings to target. Each collection is isolated from the others. Typically a specific client instance will target a single collection. In VS, the collection matches the /rootSuffix parameter of the client, facilitating scenarios like isolation of the experimental hive for extension development. Must be non-null; empty string is OK.
- isRoamingEnabled
- Boolean
Tells the service whether to synchronize with the user's online settings.
- roamingEnabledRevision
- Int32
The client's stored revision number for the roaming enabled setting. This is used to avoid overwriting a more recently updated value.
- telemetrySettings
- String
Output of ITelemetrySession.SerializeSettings from the client.
- clientId
- Guid
The idenitifier of the client
- durableClientIdentity
- String
The identifier of the client, i.e. a devenv instance
Returns
Exceptions
Thrown when this is called more than once.