ckaczor/sqltoolsservice
1
0
Fork 0
mirror of https://github.com/ckaczor/sqltoolsservice.git synced 2026-02-16 10:58:30 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update ConnectionCompleteParams definitions and doc comments (#1665)

Browse Source
This commit is contained in:
Charles Gagnon
2022-08-31 14:19:26 -07:00
committed by GitHub
parent bc32f332c7
commit a78691c86b
1 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
src/Microsoft.SqlTools.ServiceLayer/Connection/Contracts/ConnectionCompleteNotification.cs
View File

@@ -19,34 +19,34 @@ namespace Microsoft.SqlTools.ServiceLayer.Connection.Contracts
public string OwnerUri { get; set; } public string OwnerUri { get; set; }
/// <summary> /// <summary>
/// A GUID representing a unique connection ID /// A GUID representing a unique connection ID, only populated if the connection was successful.
/// </summary> /// </summary>
public string ConnectionId { get; set; } public string? ConnectionId { get; set; }
/// <summary> /// <summary>
/// Gets or sets any detailed connection error messages. /// Additional optional detailed error messages, if an error occurred.
/// </summary> /// </summary>
public string Messages { get; set; } public string? Messages { get; set; }
/// <summary> /// <summary>
/// Error message returned from the engine for a connection failure reason, if any. /// Error message for the connection failure, if an error occured.
/// </summary> /// </summary>
public string ErrorMessage { get; set; } public string? ErrorMessage { get; set; }
/// <summary> /// <summary>
/// Error number returned from the engine for connection failure reason, if any. /// Error number returned from the engine or server host, if an error occurred.
/// </summary> /// </summary>
public int ErrorNumber { get; set; } public int? ErrorNumber { get; set; }
/// <summary> /// <summary>
/// Information about the connected server. /// Information about the connected server, if the connection was successful.
/// </summary> /// </summary>
public ServerInfo ServerInfo { get; set; } public ServerInfo? ServerInfo { get; set; }
/// <summary> /// <summary>
/// Gets or sets the actual Connection established, including Database Name /// Information about the actual connection established, if the connection was successful.
/// </summary> /// </summary>
public ConnectionSummary ConnectionSummary { get; set; } public ConnectionSummary? ConnectionSummary { get; set; }
/// <summary> /// <summary>
/// The type of connection that this notification is for /// The type of connection that this notification is for
@@ -54,14 +54,14 @@ namespace Microsoft.SqlTools.ServiceLayer.Connection.Contracts
public string Type { get; set; } = ConnectionType.Default; public string Type { get; set; } = ConnectionType.Default;
/// <summary> /// <summary>
/// Gets or sets a boolean value indicates whether the current server version is supported by the service. /// Whether the server version is supported
/// </summary> /// </summary>
public bool IsSupportedVersion { get; set; } public bool? IsSupportedVersion { get; set; }
/// <summary> /// <summary>
/// Gets or sets the additional warning message about the unsupported server version. /// Additional optional message with details about why the version isn't supported.
/// </summary> /// </summary>
public string UnsupportedVersionMessage { get; set; } public string? UnsupportedVersionMessage { get; set; }
} }
/// <summary> /// <summary>