Microsoft.VisualStudio.LiveShare.Contracts VS Code Only. Extensibility API VS Code Only. Enables local redo Enable VS IDE support for multiroot workspaces (e.g. when a guest joining a VS Code instance w/ multiroot enabled) Support opening a folder during a collaboration session Enable agent extension support Enable comments. Adds support to try reconnecting to the same session on network disruptions. Adds Support for supporting undoing only locally made changes when invoking the undo command in VS. Enable Dev Tools Disable Live Share package auto load after share or join. Enable wait for host during join Enable project files editing Enable Live Share in Nexus Should be unused now, keeping it to leave contracts the same If the RpcSession should check if the request has been cancelled before returning a response. Non-vscore file service constants Optional reconnection identifier Number of milliseconds to keep the agent alive when the session is disconnected If reconnect succeeded during Initialize The rpc session number associated The agent process id Represent an RPC Agent Session that has capabilities to reconnect to an existing RPC session Initialize this rpc session by adding services or reconnecting to an existing session The initialize request options Enable this rpc session to be later reconnected Keep the agent alive for some milliseconds to avoid the agent process to exit when rpc session are disconnected and the AutoStop is enable Force kills the agent Indicate a change in the status of the current authenticate user Get info of current user info and the access token Gets info about the currently authenticated user, if any. User info, or null if the session is not authenticated. Removes a recent collaborator from the current profile. Removes all recent collaborators from the current profile. Sets the authentication token for the RPC session(s). Token acquired from the Cascade authentication service, or a short code that can be used to acquire a token. Login options. User info. A cancellation token. Information about the logged-in user, or null if the token is invalid or expired. Sets the anonymnous authentication token for the RPC session(s). Information about the logged-in user, or null if the token is invalid or expired. Looks for a cached auth token matching the provided account info, and attempts to sets the authentication token for the RPC session(s) with that cached token, if the token is still valid. Details about the account used to find a matching cached auth token. Login options. A cancellation token. Information about the logged-in user, or null if a matching token was not found or the token is invalid or expired. Using the supplied credential, conduct and attempts to sets the authentication token for the RPC session(s) with that cached token, if the token is still valid. Details about the account used to find a matching cached auth token. Login options. User info. A cancellation token. Information about the logged-in user, or null if a matching token was not found or the token is invalid or expired. Clears the authentication token for the RPC session(s). Logout options. A cancellation token. Gets current cached token. An equality operator for two AuthenticationToken objects is implemented in order to allow for tests to mock operations that receive parameters of this type, and be able to compare them during unit test execution. For an example of this see test SignInAsync_WhenLoginFails_ThenThrows in class VsCascadeClientServiceTests. Implemented given that we also provide our own Equals() method. UserAccountInfo represents the minimum information we require in order to retrieve cached credentials in a machine. It purposefully doesn't include the User's Id, as that is unknown at the time of retrieval. Name of the identity provider used to sign in, e.g. "GitHub" or "AAD" or "anonymous". Username (or email address) for the identity provider account. The Cascade user ID (provider-independent opaque identifier string). User's full name. Clients should handle cases where a user has not provided any name. Primary email address for the user. (May or may not be the same as the account ID.) The username received from the provider. Status of the user's account / registration. True if this user is logged in as the default user for the agent instance. False if the user is logged in only in the current session. Uri for the Avatar image of the user. Whether user is anonymous. The collection of collaborators recently interacted with. Programs that the user is a part of. Telemetry id for user profile User has not registered for Cascade. User has registered for Cascade but the registration has not been accepted. User registration has been accepted by an admin. User was removed by an admin. True to force a refresh of the cached token with the external token. True to set or clear the token in the auth token cache. True to set or clear this account as the default account in the auth token cache. True to set or clear the auth token for all future RPC sessions (for the lifetime of the agent process); false to only set or clear the auth token for the current RPC session. The default is false. True to skip fetching the profile when logging in, so that the user will be logged in with only a token and no profile. This optimization may be used by a noninteractive tool that is ONLY JOINING a session. Other operations (like sharing) will throw exceptions if the profile is missing. Agent RPC service designed to authorize a broker process to access workspace services. Authorizes the broker process and configures the RPC session with permitted services. A broker token issued by the . Cancellation token When the token is not found or revoked. A data object containing charasteristics necessary to establish and configure a broker RPC session. List of names of permitted host RPC services. List of names of permitted guest RPC services. Represents event data associated with certain broker events. A workspace service providing an API to control brokers' access. Registers a broker entry for the current workspace. Configuration object of the broker Cancellation token A broker token is a unique string used by a broker process to authorize itself when establishing an RPC session with the agent. Attempts to revoke a broker token issued earlier. Issued broker token Cancellation token True if succeeded, false if given token cannot be found. Message sent by a guest or Nexus client when he or she opens the first editor window for a project file. Message sent by a guest or Nexus client when he or she closes the last editor window for a project file. The zero-based id of the line number. The zero-based id of the character in the line. The zero-based index of the character in the buffer. The comment thread is active. The comment thread is closed. This serves as the identify for the file comparison. The position of the comment on the left side of the diff. This is the start position of the selected text. The position of the comment on the left side of the diff. This is the end position of the selected text. The position of the comment on the right side of the diff. This is the start position of the selected text. The position of the comment on the right side of the diff. This is the end position of the selected text. Refers to the coediting version of the document, to help with initial comment placement. Comment identifier. The id of the parent comment. ParentId is 0 for root comment. -1 for adding comment at the end of the comment thread. The unique participant id matching PeerIdentity.Id or WorkspaceUserProfile.Id. The participant label to display in UI. Usually just the user name. The user session id that has updated the comment, this is the unique session id. Same user joined in different sessions, will have different session id for each session. The thread to which the comment belongs to. Comment text, cannot be null or empty. The list of participant Ids that have liked this comment. Specifies if the comment has been deleted. When the comment was published to the service. This is set by the service. When the service last updated the comment, this is set by the service. The thread identifier. The user session id that has updated the comment, this is the unique session id. Same user joined in different sessions, will have different session id for each session. When there are different baselines, this refers to the zero-based index of the left side file snapshot for a given comparison. When there are different baselines, this refers to the zero-based index of the right side file snapshot for a given comparison. The comments in the current thread. Comments[0] is the root comment. The position of the comment thread. Specifies if this thread got deleted. The thread status. When the comment thread was published to the service. This is set by the service. When the service last updated the comment thread, this is set by the service. The new thread that was added. The comment that was added, deleted or updated. The id of the thread. Thread id can be 0. The thread context. Service that exposes the ability to add comments in a liveshare session. Creates a new comment thread. The comment thread. The comment thread should contain the root comment. Cancellation token. The new comment thread. Creates a new comment. The comment. Cancellation token. The new comment. Updates the specified comment. Thread id of the comment. The comment id. The user session that is updating the comment. The new text of the comment. Cancellation token. The updated comment. Deletes the specified comment. Thread id of the comment. The comment id. The user session that is deleting the comment. Cancellation token. The updated comment. Gets all comments from the service. Cancellation token. List of comments. Updates the positions of the commentThreads to the latest document version on the host. List of comment threads with updated positions. Updates the likers on the comment. The thread id of the comment. The comment id. The session that's updating the comment. The participant that's liking/disliking the comment. If it was a like or a dislike. Cancellation Token. This event is fired whenever there is a change to any comment thread. Gives an agent some metadata about the version of the caller, and returns version information about the callee. Information about the agent that is calling, or null if this call is made directly from a client. Information about the client tool that initiated the request (possibly indirectly via another agent), or null if an agent is calling not on behalf of any client. A cancellation token. Information about the agent that is called. After this call, either end may choose to terminate the connection if they determine that the versions are incompatible. Gives an agent user settings from the caller, including feature flags. Finds the network interface that contains the given IP address and returns all subnet masks for all IP addreses belonging to this interface. A service to retrieve an object dispatcher by a name An interfaces that can check if a given file is exluded from a workspace Get a value indicating whether the is excluded. Workspace file. True if the file is excluded. Get a value indicating whether guest with can support persistent root and the persistent root is configured. Guest's session number. True if the persistent root is configured and the guest can use it; Otherwise, false. Get a value indicating whether the client can support persistent root and the persistent root is configured. True if the persistent root is configured and the client can use it; Otherwise, false. Check if can be expressed as persistent vsls path. Check if the current RPC client may use persistent paths if is true. Null if is null, or there is no persistent root configuration, or the path cannot be expressed with it, or if is true and the caller cannot use persisten roots. Otherwise, normalized persistent vsls path with / slashes and without trailing /, e.g. /~~/c$/workspace/foo/bar.cs Try converting to/from persistent form. Workspace file id to convert. May be null. A value indicating whether persistent root form should be used if it's possible and allowed. Whether to check caller permissions if is true. The argument if it's already in the right format and that format is allowed. New converted workspace file id if is not null and can be converted. If is true, and cannot be expressed in persistent root form, it's returned as non-persistent form. Otherwise, null. Gets info about vsls-agent firewall rules. Firewall does not have any rules for the process. Firewall has a rule for the process with Allow action. Firewall has a rule for the process with Block action. This service replicates host notifications for scenarios like accept-reject approval and guest leaving the session. This service is initialized only for online environment owner guest. Service provided by Online Environment Server to know information about Live Share session shared by Online environment client. Get the current state of Live Share session in online environment Update the state of Live Share session in online environment Update session state to newState Only online environment owner client can update the state. Represents state of Live Share session at online environment client. Interface for enumerating shared servers and pipes. Gets all shared servers. Cancellation token An array of all active shared servers. Gets all shared pipes. Cancellation token An array of all active shared pipes. Get the last timestamp when PFA was accessed Cancellation token Last accessed time in ticks Update local port of forwarded server or set the mapping for the future forwarded server. Source port of the shared server. Must be > 0. New local destination port. Must be >= 0. Use 0 to pick the first free port. If not 0, and the port is already used, 0 assumed. Cancellation token. Updated with the new destination port or null if there is no such shared server. An event to fire when a new server is shared. An event to fire when a new pipe is shared. An event to fire when browse sharing is started. An event to fire when server is no longer shared. An event to fire when pipe is no longer shared. An event to fire when shared server has changed. Interface to expose a service provide that can dynamically register a service instance Replace a registered service with another instance Register a service instance type If a service is available Interface for sharing local servers and named pipes. It controls what local tcp ports and pipes can be forwarded to, and configures appropriately. Configures a forwarding stream provider in to start forwarding to localhost: tcp socket. Use the result's and to get a stream from which would wrap the network stream to the socket. If the port is already forwarded, is ignored. Local tcp port to connect to. Not 0 or negative. Port forwarding session name. Not null or empty. Browser URL if the server is a browser session or null. Cancellation token Shared local server info, not null. Configures a forwarding stream provider in to start forwarding to local pipe . Use the result's and to get a stream from which would wrap the network stream to the pipe. If the pipe is already forwarded, is ignored. Local pipe name to connect to 0. Not null or empty. Pipe forwarding session name. Not null or empty. A value indicating whether Server Sharing Service will send a ClientAccessInfo off the RPC context to the pipe when a guest connects to it. Cancellation token Shared local pipe info, not null. Stops sharing of the local tcp . Port to stop sharing. Not 0 or negative. A cancellation token. Stops sharing of the local pipe . Pipe to stop sharing. Not null or empty string. A cancellation token. Stops sharing all previousely shared browse sessions. Gets all shared local servers. Cancellation token An array of all active shared local servers. Gets all shared local pipes. Cancellation token An array of all active shared local pipes. Updates the session name of the shared server Port of the shared server to update. Not 0 or negative New session name. Cancellation token. DEPRECATED! Use UpdateSharedServerPrivacyAsync instead. Updates the port visibility. TODO: Remove after clients have been updated to not use this method anymore. Port of the shared server to update. Not 0 or negative Port visibility. True when port is public. Cancellation token. Updates the port protocol. Port of the shared server to update. Not 0 or negative Port protocol. True when port is https and False with it is http. Cancellation token. Updates the port privacy setting. Port of the shared server to update. Not 0 or negative Port privacy setting. Cancellation token Triggers SharingSucceeded and any handlers subscribed to it. Triggers SharingFailed and any handlers subscribed to it. An event to fire when a new server is shared. An event to fire when a new pipe is shared. An event to fire when browse sharing is shared. It is fired any time when is called with isBrowseSession = true, even if the port is already shared. An event to fire when server is no longer shared. An event to fire when pipe is no longer shared. An event to fire when shared server has changed. An event to fire when starting/updating/stopping a shared server succeeds. An event to fire when starting/updating/stopping a shared server fails. Shared server info. StreamName and Condition can be used to get the streams from . Local tcp port being shared. Remote tcp port that forwards to the local port. Session name. Stream name to use with to get the forwarded stream. Condition to use with to get the forwarded stream. Browse url for shared browser session or null. Privacy setting for the source port. True when we were able to establish connection with forwarded TCP server. True when we were able to perform TLS handshake with forwarded TCP server. Shared pipe info. StreamName and Condition can be used to get the streams from . Local pipe being shared. Remote pipe that forwards to the local pipe. A value indicating whether Server Sharing Service should send a client id (32bit little endian encoded) first to the source pipe when a new client connects to it. Session name. Stream name to use with to get the forwarded stream. Condition to use with to get the forwarded stream. Event args for an event when a new server is shared. Event args for an event when a new pipe is shared. Event args for an event when a server is no longer shared. Event args for an event when a pipe is no longer shared. Event args for an event when a server is updated. Event args for an event when a server change succeeds. The type of change that succeeded. The port for which the change succeeded. Session name. The port privacy setting if the change is a privacy update. The URL where the port is being forwarded to. The tunnel type that is being enqueued and dequeued Event args for an event when a server change fails. The type of change that resulted in failure. The port for which the change failed. The state of the shared server before the operation that failed. The tunnel type that is being enqueued and dequeued The error code response from the Codespaces front-end. The error message response from the Codespaces front-end. Sets values of server side policies retrieved from the workspace after the session has been started Workspace of the current session Returns if a server policy is enabled, and if so has a restriction or not Name of the policy setting to see if it set true if is set to true false if is set to false and null if is not configured The value of some of the settings are not set until the session has been started and the values are cached, which occurs when SetServerSidePoliciesAsync is called in the workspace Clears the server side policy values of the current workspace once the session ends Event raised when agent sends a notification of a session state update Event raised when agent sends a notification of a session status update Name of telemetry event Interface to define a shared workspace being shared by the agent Joined info Information Source control service. This service should be proffered by the host client. Get all source controls in the collaboration session. Get specific source controls in the collaboration session for the given source control. Get specific source control in the collaboration session for the given source control and instance. Get recent versions from the source control. Get recent versions upto a given merge base from the source control. Get list of diffs between working directory and sepecific version. Get diff data for the given source control resource, or null if not found. Get content of resource from source control. Clean (discard changes) the specified resources it source control. Gets the merge base - the common ancestor of the local branch and the remote branch. Id of the source control. The remote branch. CancellationToken The merge base as commit id. Gets the list of all remote branches for the given source control. Id of the source control. CancellationToken List of remote branches in the format remoteName/branchName Gets the current branch name the host is on. Id of the source control. CancellationToken The local branch name An event that fires when some source control changed. And event that fires when some source control resource changed. Source control identity. Id of the source control. E.g. for Git it is "git". ID of the source control instance. E.g. for Git it is repo's root URI. Version within source control. Version within the source control. This data is source-control specific. Short description of the version in host UI language. Verbose description of the version in host UI language. Type of source control resource. The resource path points to a file or folder within the collaboration workspace working directory. Corresponds to vsls: scheme. The resource version is not set, and should be ignored if set. The resource is editable. The resource path points to a file or folder outside the collaboration workspace. Corresponds to vsls-external: scheme The resource version is not set, and should be ignored if set. The resource is read-only. The resource path and version specify a source-controlled resource that may only exists in source control, e.g. some file or folder at specific revision. The resource can be fetched via ISourceControlService.GetSourceControlResource(). The resource is read-only. The path is source-control specific and does not necessarily translates to a file path. The resource path points to a file or folder within the collaboration workspace. It corresponds to vsls: scheme. The difference from Workspace is that this resource also specifies version. Type of source control resource change or diff. Corresponds to INDEX_ADDED in Git. Corresponds to MODIFIED in Git. Corresponds to DELETED in Git. Corresponds to INDEX_RENAMED in Git. Corresponds to BOTH_MODIFIED in Git. Corresponds to INDEX_MODIFIED in Git. Corresponds to INDEX_DELETED in Git. Corresponds to INDEX_COPIED in Git. Corresponds to UNTRACKED in Git. Corresponds to IGNORED in Git. Corresponds to ADDED_BY_US in Git. Corresponds to ADDED_BY_THEM in Git. Corresponds to DELETED_BY_US in Git. Corresponds to DELETED_BY_THEM in Git. Corresponds to BOTH_ADDED in Git. Corresponds to BOTH_DELETED in Git. Resource under source control. Type of the resource. Path to the resource. The path depends on the resource type: For Workspace or WorkspaceWithSpecificVersion it is the same as path for 'vsls:/....' URI. For External it is the same as path for 'vslsexternal:/...' URI. For SpecificVerision it is some opaque string that source control service understands and guest should treat as just an id. Optionally, the version of the resource if its type is SpecificVersion or WorkspaceWithSpecificVersion. Empty string means "baseline" if the resource type is WorkspaceWithSpecificVersion. Otherwise, it is specific to source control Individual file state under source control. Source control resource. It is displayed on the source control viewlet in VSCode. Type of the change the resource state is about. If set, the original resource for quick diff and decorations. Identifier of the source control resource. Optional group id. Optional source control id. E.g. for Git it is "git" Optional source control instance id. E.g. for Git is root URI of the Git repo. Group of source-controlled states, e.g. "Changes", "Index", or "Merge" in git. Group id. Language-agnostic. Group label in host UI language. A value indicating whether to hide the group if it is empty. A value indicating whether the resource states in the group can be cleaned. A value indicating whether the resource states in the group can be opened. A value indicating whether the changes for resource states in the group can be opened. Resource states within the group. Source control data. Source control label in host UI language. E.g. "Git" Optional Source control instance name, usually the folder name of the source control root folder. Groups of source-controlled files within this source control. Source control resource diff info. The right resource of the diff. Can be null if there is no right resource for diffing (e.g. the file was deleted) Type of the diff. The left resource of the diff. Can be null if there is no left resource for diffing (e.g. the file was added) The title of the diff. Source control change type. Existing source control instance updated. New source control instance added. Existing source control instance removed. Event args for event when source control changed on the host. Source control instance that changed, or null if all of them did. What kind of change happened. Event args for event when source control resources changed on the host. Source control instance where the change happened. Resources that changed. Service for detecting if a guest's document is in sync with the host's Checks if documents are in sync. File to check sync status of. Hash code of file on guest. Cancellation token. If the document is in sync. Checks if documents are in sync. File to check sync status of. The server version that the hash corresponds to. Hash code of file on guest. Cancellation token. If the document is in sync. Checks if documents are in sync. File to check sync status of. Version of the file, which increments each time it's reset. The server version that the hash corresponds to. Hash code of file on guest. Cancellation token. If the document is in sync. Represents a service providing CRUD operations over task outputs produced by the host. Retrieves a collection of task outputs shared by the host. Creates a new instance of a shared task output. The name of the task output. Options . The token to monitor for cancellation requests. A data object representing the new instance of the task output. Updates the task output by replacing its current feed with the new one. The ID of the task output. The cancellation token. The task output with the new feed. When a task output with the given ID cannot be found. Closes the shared task output. The ID of the task output. The cancellation token. Occurs when new task output shared. Occurs when a task output feed updated. Occurs when a task output closed. A content type of a task output or feed. Plain text content. Text with ANSI escape codes. Single task execution feed The identifier of the feed. The stream moniker of corresponding remote stream. Options pertaining to a task output The type of the content. Collection of task kinds associated with the task output. Text encoding of the content. Represents a task output, typically associated with a output or terminal window in IDE. It can be used to send ouput from task execution feeds. Only one feed can be active. The identifier of the task output. Display name of the task output. Active feed. Task output options. Represents an event data sent with a task output event. Enables client and agent to exchange telemetry settings. Gets the service uri Event raised when agent sends a notification of a operation occuring Event raised when agent sends a notification of a fault Name of telemetry event Result of the operation The payload of the operation Name of fault telemetry event Description of the fault event The payload of the event Terminal endpoint - connection to terminal stdio streams. Reads bytes from the stream. Writes bytes to the stream. Reads bytes as UTF-8 string from the terminal stream. Writes UTF-8 string to the terminal stream. Terminal service interface Start a terminal and open local pipe that connects to it Query terminals that are running. Resize a terminal. Stop running terminal Clear the buffer. Set read-only for guests flag for a terminal. Event that fires when a terminal has started. Event that fires when a terminal has resized. Event that fires when a terminal has stopped. Event that fires when terminal read-only status has changed. Options that control how terminal is started Terminal name to be shown on client UI Rows count, greater than 0 Columns count, greater than 0 Working directory on the host machine where terminal starts. Path to terminal application on the host machine. Mandatory if a data pipe name is not provided. Terminal command line A value indicating whether command line arguments must be quoted. false, the default, means that the arguments must be quoted and quotes inside escaped then concatenated with spaces. true means that the arguments must not be quoted and just concatenated with spaces. Terminal environment variables. A value indicating whether the terminal is read-only for guests. A value indicating whether the terminal is a shared debug terminal. Name of a duplex pipe of an integrated terminal. Mandatory if a terminal application path is not specified. Size of the backing circular buffer. Info on running terminal Identity to distinguish from other terminals Options used to create the terminal. Stream name for the StreamManagerService Stream condition for the StreamManagerService Local named pipe name to connect to the terminal ProcessId of the created process. Null if the integrated shell is used. Event args for notification for a terminal The terminal this event is about. Restricted operation for a specific terminal Terminal Id Whether the operation is writing of an escape sequence. Service that manages access control for collaboration session. Gets access control for the collaboration session. Sets access control for the collaboration session. Requests host to allow access to a specific in the collaboration session. If this this the first time, a notification will pop up for the host asking that a guest wants to allow a restricted operation. If the host make any decision, event will fire and this method returns the host's decision on the access. Sets explicit on a given . Only host can invoke this method. Calls event. Only host can invoke this method. Event that fires when session or user access control has changed. Event that fires when host a restricted opreation is rejected. Event that fires when the host changes access for an operation. Event that fires when somebody requested access to a restricted operation for the first time in the session. Event args for an event when user access control changes. Default workspace access control, allows full access Session default access control. User session access control. It takes precedence over the default access control. Get user-specific access control or default one. Get user-specific access control or default one. Event args for an event when user access control changes. Session access control. Event args for an event when a guest requests access to a restricted operation. Restricted operation. Session id of the participant that requests access. A service providing a list of diagnostic entries, including warnings, errors, and problems, emitted by a workspace task. Retrieves a list of diagnostic entries for the current workspace. A collection of diagnostic entries. Will return an empty array or null when no errors are present. Raised when diagnostic data has changed. The event will contain full list (a snapshot) of the active entries present at the moment the event is raised. Represents severity of an error reported by a workspace task. An entry representing error, warning or message generated by a workspace task Severity of the error. See Canonical ID of an associated file in the collaboration workspace. 0-based line number where the error is detected. 0-based columnt number where the error is detected. Error code. User-friendly error message. Collection of additional properties associated with the error. Describes a diagnostic data event containing a collection of diagnostic entries emitted by a workspace task. Gets information about a single workspace by ID. Queries the cloud service if the ID does not refer to a local workspace. Lists local workspaces, and optionally queries the cloud service to find a list of all workspaces owned by or shared with the current user. Create a persistent workspace with optional label parameter Planned sessions require label for persistent workspaces. Delete a Planned Session Rename Planned Session Planned sessions require id and name to rename persistent workspaces. Starts sharing a local workspace, and sets the current workspace context for the RPC session. Removes chat service from host services when policy disables chat Create invitation link for a workspace based on link conditions from InvitationLinkInfo Get invitation links for a workspace Only owner of the workspace can query for invitation link Stops sharing a local workspace, and clears the current workspace context for the RPC session. Hints to the service that a join is about to take place and requests the workspace. This itself does not perform a join, you must still call . It is also not required but acts as a hint to the service that we're about to perform a join so close-together web operations can be cached if possible. Establishes a connection to a workspace, and sets the current workspace context for the RPC session. It is possible to join a local workspace (that was already shared by / owned by the current user); in that case no remote connection is made, but the current-workspace context is of the RPC session is still set. Disconnects from a workspace, and clears the current workspace context for the RPC session. Unjoining a local workspace does not stop sharing, it merely clears the current workspace context of the RPC session. Registers or unregisters service proxies that enable the client to provide RPC services to other clients in the workspace. Other clients can make RPC requests to the registered services by name without knowing details about exactly who is providing each service. (Services can still be provided by the agent also.) Services registered by clients can also raise events, which then get broadcast as RPC notification messages to any other clients that are listening for events from the service. (Where broadcast functionality is not needed, consider using a request instead of events; requests and responses are never broadcast.) If there are multiple instances of the same service, RPC requests to that service may result in an error when a single service provider cannot be identified. (But when are 2 providers of a service and the caller is one of them, then the request is delivered to the non-caller provider, because there are no loopback requests so there is no ambiguity.) However, multiple instances of a service may all broadcast notifications without limitations. The client must separately register the service implementation(s) on its RPC session. Also before invoking this method, a current workspace must have been already set via a share or join request. The registrations only last as long as the current workspace sesssion. Returns true if current user can be the sharer for the workspace. A user can be a sharer if there is no sharer in the workspace (verified by IsHostConnected) and user is either the owner or in the list of host users for the workspace Returns true if current user can host using the workspace id Create public invite link for shared workspace. Id for the workspace Disconnect guest from the active session Guest id Workspace id True if successfully disconnected Unjoin Online environment guests within a Live share session where host is online environment Id for the workspace Set shared workspace as ready for connection. Id for the workspace Cancellation token Updates the owner of the workspace from the user specified by to the user specified by . must be a workspace id, it cannot be an invitation link. The workspace to update The token of the current owner The token of the new owner The cancellation token A for the new owner Notifies clients when available services on a workspace have changed, possibly because other clients have registered/unregistered services or connected/disconnected. Event raised when the connection status of the current workspace changes. Workspace progress updates sent from agent to client Raised when host removes guest from collaboration session Raised when host blocks guest from collaboration session Raised when workspace gets ready for connection Invitation link info provided to the agent to create an access control link Identity of the workspace - used by clients to join a workspace. ConversationId assigned to a workspace Friendly name of the workspace. URI to the web page for joining the workspace. UserId of the user that owns this workspace. Connection status of the workspace. Whether host is connected to persistent session In case of persistent workspace, time at which it will expire. The label of a managed workspace. Set to true when the share operation is successfully completed. Unknown/uninitialized connection status. The workspace is shared and the host is currently listening for connections. The workspace was previously shared. It is currently not available because the host is no longer listening for connections. But it has not been unshared/deleted. The workspace is shared, and the local agent is currently connected (joined). The workspace was previously connected, but has become disconnected. It may or may not be available to reconnect. Unknown/uninitialized reason. The client intentionally disconnected from the workspace. The client was removed from (kicked out of) the collaboration session by the owner. The client was removed and blocked from the collaboration session by the owner. The collaboration session was ended by the sharer. The connection to the remote shared workspace was unexpectedly lost. It may be possible to reconnect. An unrecoverable application error has occurred. The collaboration session expired. The collaboration session has ended due to network connectivity issues. The collaboration session has ended due to the tcplistener or relaylistener going offline. Critical failure of callaboration service factory as indicated by "Microsoft.VisualStudio.LiveShare.CriticalFactoryFailure" data key on exception thrown by the factory. New connection status. Reason for a disconnection. Required only when the ConnectionStatus value is Disconnected. Event that is fired by when shared workspace become ready for connections Workspace that become ready for connection. Duration in ms of how long this event took to complete Specifies whether direct connections and/or relay connections will be enabled for connecting to the workspace. Specifies anonymous guests allowed for the workspace. Indicates whether the workspace should remain shared even after the client that shared the workspace disconnects. If false, the workspace will be automatically unshared when the host client disconnects. List of users (other than the owner) that can share the workspace If set to true, then create workspace with an expiration date If true, then only basic file services (list, read, write) are available. File indexing, file watching (change notification), and text searching capabilities are disabled for the session. This option reduces CPU and memory load for a large workspace when these services are not needed. Persistent root configuration if enabled If true, host agent will watch Tcp Listeners on the server and try to determine whether the service runs on Http(s). List of services provided by the client. The agent will not register its implementation of the services in this list. A value indicating whether guest supports peristent root on the host ID of a local workspace, or a remote workspace for which connection info is to be obtained from the service. Id to correlate the join event with a visit to the join page URI of the Live Share service to connect to (if different from config). Note when included as part of a vsls: URI, this value must be URL-encoded. DEPRECATED - Do not use. Temporarily maintained for backward-compatibility. URI of a websocket relay for connection to a remote workspace. SAS to be used for authentication when connecting to the relay. The joiner's user session token Specifies whether a direct connection or relay connection will be used to connect to the workspace. Client capabilities. Anonymous user name specified on join. True if user is in remote workspace self join mode The Codespace ID if joining a remote workspace The Codespace name if joining a remote workspace True if user wants to share using the given workspace id Tenant for the user id used for signing in the user. User identity used for join workspace. Indicates the initial view name; null means to use the default. Indicates whether the workspace should remain joined even after the client that joined the workspace disconnects. If false, the workspace will be automatically unjoined when the guest client disconnects. A value indicating whether the connection is from Codespaces PortForwarding service which needs IPAddress.Any for forwarding ports. Any other connection should only have IPAddress.LoopBack. The absolute path to the target folder or sln file to open as an initial workspace Only used by Codespaces client to pass data to the Codespace IVSServerHostService Defines the ways that an RPC caller can connect to a workspace when joining. Changes to this enum may require corresponding updates to the available values offered for users to select in client settings. Try connecting directly, if that fails then try connecting via a relay. Direct (peer-to-peer) TCP connection; may be on the same local network, through VPN, or through NAT traversal. Connection through a cloud relay server. Indicates the workspace to be joined is one that is hosted locally by the agent being called; the callee must not forward the join request to another remote agent. This mode is not to be specified by a user, therefore it should be hidden from user settings. It is used internally based on application or agent logic when the target workspace is known to be hosted by the agent being called. Connection through a signalR service. Note: this is considered an 'internal' type that will be attempted when the 'Relay/Auto' mode is selected Connection through a dev tunnel. Note: this is considered an 'internal' type that will be attempted when the 'Relay/Auto' mode is selected Optionally include remote workspaces. Get only the managed workspaces. Optionally include only workspaces with a specific owner. Integer that identifies the session with the workspace, guaranteed to be unique across all other sessions connected to the same workspace at the same time. Session numbers are assigned by the workspace hosting agent. They are valid for the duration of a collaboration session, not for the extended lifetime a workspace. That means if a workspace owner stops sharing and then later re-shares the same workspace, the session numbers may be different (and numbers may be re-used from past sharing sessions). String that identifies the collective shared workspace conversation that's happening across all participants. Conversation ID is set by the cloud services whenever the owner shares a workspace or re-joins a workspace that they previously shared. The conversation ID is then shared across all parties that connect to the workspace (both owner and participants) in order to correlate the telemetry events emitted. Indicates the mode that was actually used to connect to the workspace. Indicates if relay connection was successful. Time that the workspace was created. Time that the workspace was last updated. Currently connected sessions Session access control A value indicating whether this session is read-only. A value indicating whether the session has Presentation Mode features enabled. This value will be stored as the workspace is shared and read during co-editing. A value indicating whether the connection is from Codespaces PortForwarding service which needs IPAddress.Any for forwarding ports. Any other connection should only have IPAddress.LoopBack. Full remote paths to the shared workspace roots. Persistent root paths /~~/... are preferred to regular root paths /~0/.. if persistent root configuration is set, shared workspace path can be expressed with it, and the client can use it. Registered service names Group policy setting provider Tries to get a configured policy setting. Policy setting to be queried. Value of the policy setting, if configured. Returns true if the is configured. Policy supports having multiple domains in the allow list. Returns empty list if all domains are allowed. Group policy settings Restricts if anonymous guests can join the session Maps to PolicySettings DisableAnonymousGuest Restricts if guests can use a shared server Maps to PolicySettings DisableSharedServer Restricts if guests can edit the terminal Maps to as PolicySettings DisableReadWriteTerminal Restricts user to use direct connection mode Maps to as PolicySettings EnableDirectConnectionMode Requires host to approve guests into the session Maps to as PolicySettings EnableGuestApproval Restricts user to log in with approved email to start a session Maps to as PolicySettings EnableDomainRestriction Restricts user from using chat in a session Maps to as PolicySettings DisableChat Enterprise policy setting provider Checks if server side policy or group policy is enabled for the setting Name of the policy setting to see if it set The value of the policy, or if no value is set then the default policy Determines if a domain restriction policy has been enabled, and if so whether the user is signed in with an approved email Email user used to log into Live Share true if a user is signed in with an approved email and false if the user is not signed in with an approved email Enterprise policy settings Restricts if anonymous guests can join the session Maps to GroupPolicySettings AnonymousGuest, default value of false Restricts if guests can use a shared server Maps to GroupPolicySettings DisableSharedServer, default value of true Restricts if guests can edit the terminal Maps to GroupPolicySettings DisableReadWriteTerminal, default value of false Restricts user to use direct connection mode Maps to GroupPolicySettings DirectConnectionMode, default value of false Requires host to approve guests into the session Maps to GroupPolicySettings GuestApprovalRequired, default value of false Restricts user to log in with approved email to start a session Maps to GroupPolicySettings DomainJoined, default value of false Restricts user from using chat in a session Maps to GroupPolicySettings DisableChat, default value of false If RPC service method synchronous part takes longer, Live Share will emit a telemetry fault event Should the agent process terminate immediately after this client has disconnected if there are no other shared workspaces or connected clients on the agent. Persistent root configuration override. If it is set LS will use it and ignore IFileServiceRootConfigurationProvider. Format: LocalPath=RemoteUriPrefix;... E.g. @"C:\=c$;D:\=d$" Use empty string to suppress persistent root configuration. Names of clients for WorkspaceSessionChangedEventArgs.ApplicationName RPC message contexts - keys to RPC Message.Context dictionary Names of restricted operations Map of specialized types of restricted operations by operation name. It is used by RestrictedOperationJsonConverter to instantiate the right type when it deserializes a restricted operation from JSON. Services defined on the vsls-agent Names of streams that one can get from Type-safe representation of a canonical file ID used for sharing workspace file paths among collaboration session participants. Canonical format of a file id requires the id to start with '/' and to comprise legal file path characters only. Converts canonical id to a full local path within a given workspace directory. Converter to resolve this path against Full path to a local file. Creates canonical file ID by extracting the relative path to the workspace directory. Full path to a file (Windows compatible) Converter to resolve this path against null if file is not located under a workspace directory A workspace Uri from vscode Definition of a workspace folder Defines how to respond to anonymous guests join requests. Changes to this enum may require corresponding updates to the available values offered for users to select in client settings. Prompt for approval. Auto accept in read-only mode. Auto reject all anonymous users. When is the user identity flag is shown. Shown only when the local user hovers over the selection. Shown when the local user hovers or when the remote user makes an edit or changes their selection. Always displayed. When read-only user is shown. Show read-only users in editor only if following them. Always show read-only users in editor. Specifies how to respond to focus requests from other participants. Follows automatically. Prompts user to choose to follow or ignore. A value indicating when the flag is shown for remote users. How read-only users are shown. A value indicating what the behavior on receiving a focus request should be. Set of configuration settings for language services. Allow guests to run arbitrary commands via Code Actions (“Quick Fixes”) and CodeLens Whether shared terminal start as external process or integrated into IDE Permissions for the shared terminals. Host has full access, guests can only read Host has full access, guests can read or write, but cannot start new terminals Controls whether shared terminal start as external process or integrated into IDE. Width of shared terminal window, characters. Height of shared terminal window, characters. Path to the terminal application. If null, the default is "%SYSTEMROOT%\System32\WindowsPowerShell\v1.0\powershell.exe" Arguments for the terminal application. Indicates whether the client service should spawn an agent process Agent URI to connect when using an external agent. Two schemes are currently supported: net.pipe://localhost/NamedPipe - for named pipes, net.tcp://localhost:5555/ - for TCP connections. If null, the agent will automatically start using a unique pipe name, and will automatically shutdown when VS exits. An id to use when reconnecting to the agent to restore a session. Live Share backend service endpoint Live Share authentication token service endpoint Live Share authentication token audience Uri of the registration page for new users Verbosity level of the log messages Name flag visibility Name flag visibility Specifies whether a direct connection or relay connection will be used to connect to the workspace. Specifies how to respond to anonymous guests join requests. Focus behavior. Debugger configuration settings. Coauthoring configuration settings. Preferred user account for Live Share user authentication. Specifies whether Diagnostic Logging is active Require host to approve all guests attempting to join the collaboration session. Automatically share external files opened by host during collaboration session Maximum number of text search results to be returned by host Team status - E.g. Dev, PM, Outside. To override VS Telemetry's categorization for reporting purposes Uri for what's new notification Indicates if the Chat view has ever been displayed Indicates if the Welcome Page has ever been displayed Indicates if the next join will be the first join of a user after activation Indicates if the next share will be the first share of a user after activation Indicates if the VS Viewlet has ever been displayed Indicates if notification for switching to stable has ever been displayed User name of anonymous. Indicates if the we showed anonymous user join toast. Stores the extension version of the first activation Text for what's new notification User specified settings. Extensibility: List of enabled LiveShare features Feature flags from user settings file Shared terminal settings Time in seconds to wait before sending keep alive messages in an idle session. Updates user settings if there are restriction policies set when a session is shared Gets the workspace task configuration settings. Language services configuration settings Specifies User FeatureSet selection (Insiders, Stable) Increases the guest limit from 5 to 30. Controls whether to show passive notifications Controls whether to automatically open shared servers in user's default browser. Mapping from extension IDs to permission lists. Amount of millisecs before liveshare consider the app 'idle' Waits for the settings to initialize and checks if the fault is critical In "CriticalFaults" remote setting. Controls chat window open behavior Persistent root configuration override. If it is set LS will use it and ignore IFileServiceRootConfigurationProvider. Format: LocalPath=RemoteUriPrefix;... E.g. @"C:\=c$;D:\=d$" Use empty string to suppress persistent root configuration. Async provider of VS configuration settings. To get VS settings we need to get to the main thread to query for ISettingsManager service. Do not wait synchronously for VS settings in importing constructors, or else VS may dead lock on startup Get VS configuration settings. Set of configuration settings for shared workspace tasks capability. Gets or sets a value indicating whether a guest is allowed to execute workspace tasks on the host. Determines account provider to be used when authenticating a Live Share user. Do NOT sort or rename values needed for persisting account data. Represents the source of a . Represents user identity needed for authentication to Live Share services Value indicating whether the cascade session is read-only. Value indicating whether the cascade session is read-only for the user. Restricted operation name. Access level of the operation. Default access control updated on host Host rejects restricted operation. A guest requests a host to get access to a restricted operation. Host sets access on a restricted operation. Host toggle anonymous user access level. Host toggle signed in user access level. Exception updating default access control on host Property to indicate the reason a coediting message was blocked. Event to indicate that we dropped a coediting message due to access control. Defines event IDs for VSLS tracing events. Identifies agent output when it is piped into clients. It should be excluded from client logs to avoid duplication. DEPRECATED: Identifies calling output when it is piped into clients. Collection of well-known trace sources, one per component.