Microsoft.VisualStudio.LiveShare

Enables other VS extensions to interact with a Live Share session.

Globally unique identifier for the current session, or null if there is no current session.

Globally unique identifier for the current conversation within a session, or null if there is no current session. Regular sessions will only have one conversation. Persistent sessions may have multiple.

Gets a value indicating whether collaboration session is connected. Only implemented for CollaborationSession within VS.

Gets a task that is completed when the session is disconnected. Only implemented for CollaborationSession within VS.

List of participants connected to the current sharing session, NOT including oneself.

Event that notifies listeners when peers join or leave the session.

Raises a event.

Gets a local service that is available in the context of the Live Share session.

Gets a collection of service names that are shared by the remote Host, when this session is connected as a Guest.

This collection is empty when the current session is in the Host role, so it does not include services shared by the current Host.

Notifies listeners when remote services become available or unavailable.

Raises a event.

Gets a proxy for a named service provided by a remote Host. The service is available only while a Live Share session is active in the Guest role.

NOTE: Access to remote services may be restricted. If the caller is not permitted, this method returns null. Otherwise, a service proxy instance is returned even if the service is not currently available (either because there is no active sharing session or because the host has not provided the service). Check the collection to see if the service is currently available, and listen to the event to be notified when the service becomes available or unavailable. Attempting to call a method on an unavailable service will throw a . Service interface type Name that identifies the remote service, corresponding to the property. Cancellation token Proxy for the named service, or null if the extension does not have permission to access remote services.

Converts a local path to a shared URI with the `vsls:` scheme.

Local file or directory path Converted URI suitable for sharing between hosts and guests, or null if the path could not be converted, possibly because the path is outside one of the shared roots.

Converts a shared `vsls:` URI to a local path.

Shared URI with the `vsls:` scheme. Local file or directory path. Note the file or directory may not exist if the file has not been downloaded. Use the method to ensure a file has been downloaded.

Lists the `vsls:` URIs that make up the roots of the shared workspace.

Array of one or more workspace root `vsls:` URIs. Most commonly a shared workspace has only a single root, which corresponds to the directory of the solution or opened folder, but multiple roots are also possible. The returned root URI(s) may be converted to local paths using .

Lists the files and directories under a specified shared directory.

`vsls:` URI of a shared directory (or shared root). Options to filter the listing. Array of `vsls:` URIs of children of the shared directory. If the shared directory does not exist. Returned child directory URIs end with a `/` character; in this way they may be distinguished from file URIs. A shared workspace can potentially contain a very large number of files, so for best performance when using the recursive option also specify pattern(s) to filter the set of results.

Downloads a shared file, if it has not already been downloaded.

Shared file URI with the `vsls:` scheme. Local file path, or null if the file could not be downloaded, possibly because the file does not exist on the host or is not available to the guest. If the file is being co-edited then the file contents do not include unsaved changes, but saving the changes will update the downloaded file.

Options for .

Specifies whether all matching recursive descendants should be included in the results. If false, only immediate children are returned.

If true, include hidden files in the listing.

Hidden files are not shown in guests' file explorer, but they may still be accessed by guests in other ways. Files are hidden if they have a hidden filesystem attribute or they are matched by the `hideFiles` globs in `.vsls.json`.

List of glob (.gitignore style) patterns to exclude from results.

List of glob (.gitignore style) patterns to include in results.

Exception.Data keys recognized by Live Share

If there is data with this key (regardless of the value) in an exception thrown from guest CollaborationServiceFactory, the join will fail on the guest and LS may display the exception message. You can provide MEF export to control how LS responds to join failures.

Combines MEF export attribute with export metadata for a collaboration service factory. Declares a type of collaboration service the factory is able to create. The factory class needs to implement .

Optional file service root configuration provider MEF export. If an export is present, LS will use it to query for file service root configuration before it starts sharing. If multiple providers are present, Live Share will ignore them and trace an error. If the result of is not persistent, it'll be ignored. Sharing will fail if root configuration is present and it is not compatible with what is being shared.

Try get file service root configuration or null if it's not applicable.

File service root directory configuration.

Create a new instance of class.

Local full path to the directory or drive, e.g. c:\ or d:\foo or d:\foo\bar\. Must be rooted Uri relative path, e.g. /c$/

Local full path to the directory or drive, e.g. c:\ or d:\foo\ or d:\foo\bar\. It is normalized to use Path.DirectorySeparator and ends with it.

Uri relative path, e.g. /c$/. It is normalized to start and end with '/'.

File service root configuration.

Mounted directories if the configuration is for a list of mounted directories.

Creates a new instance of class for deserialization.

Creates a new instance of class for given subdirectories. The configuration is persistan, with full access for owner

Tries to find a directory configuration by the local full path.

Local full path. Must be rooted and not null. Optional function to get the path comparison for the given path. If null, Ordinal is used. Directory configuration if there is a match; Otherwise, null.

Tries to find a directory configuration by the remote URI path.

Remote URI path. Must be not null. If is normalized to start with '/'. Offset into , 0-based. Directory configuration if there is a match; Otherwise, null. Also null if is greater than length.

Try to get local path from that match at .

Unescaped remote path, ot null. Offset in to look for a directory prefix. Optional function to get the path comparison for the given path. If null, Ordinal is used. Local full path if the directory entry is found, null otherwise.

Check if this configuration is a subset of . This means all directories in this configuration are also present in with the same local paths and remote URI paths.

VS collaboration service factory that can produce different collaboration services for different guests. If result of is a task that returns , Live Share will use this client collaboration service factory to create guest-specific instances of the remote service whenever guests join. This is only supported on host VS remote service factory attributed with [] that has scope and role. Client collaboration service factories may optionally implement IDisposable or IAsyncDisposable. If they do, they will be disposed when the collaboration session ends.

Create a new collaboration service for guest when he or she joins the session. The guest is described by .

Guest that just joined the session. Cancellation token. Service instance or null. The service instance must implement the service interface declared in exporting that created this instance of .

Client context that describes a guest in collaboration session.

Peer number that corresponds to in the collection of current collaboration session. Peer numbers are unique for each new guest, even if the same user joins multiple times, or joins, leaves, and joins again.

A value indicating whether this owner guest, the guest that uses the same account as the host user.

A value indicating whther this online user guest.

Declares collaboration service attributes and capabilities.

Currently it is a placeholder for future metadata. This will help us to keep factory interface unchanged. Collaboration services may optionally implement IDisposable or IAsyncDisposable. If they do, they will be disposed when the collaboration session ends. If the collaboration service instance was created by in response to a guest joining, it'll be disposed when that guest leaves the session.

A factory interface as exported by a LiveShare extension component.

Get an instance of the exported service type for the session context or a task with null result.

Metadata associated with a MEF export attribute.

The name of the service as registered in a RPC session.

Collaboration service type the factory creates.

Collaboration session scope the factory should be activated for.

A role the service fulfills. Can be one of the following: remote service, service proxy or local service.

List of features the collaboration service contributes to.

Priority value that will affect how this collaboration service will be created compared to others being defined

Range version to consider for this liveshare service

MEF export for controlling Live Share service endpoint.

Get custom Live Share service endpoint. URI result should be https sub-domain of liveshare.vsengsaas.visualstudio.com. If not, Live Sharew will use the default endpoint.

A host service in Live Share session that allows guests to connect streams to the host.

Create a channel with the given name on the host in the active collaboration session. The client needs to configure channel's event and call to start listening.

The name of the channel, not null or empty. Channel names must be unique within a collaboration session.

Host channel interface. Disposing of it will stop listening on the channel, open streams will also disconnect.

The channel name used in .

Start listening on the channel.

Thrown if no event handler has been added to the event.

Event handler to call when a guest connects a stream to the channel.

Event args for event on .

Connected stream, not null. The stream is binary, bidirectional, and sequential.

Connected guest peer number.

A value indicating whether connecting guest is the owner.

A value indicating whether connecting guest is online user.

A guest service that allows to connect to the channels on the host in a collaboration session.

Connects to a channel on the host. If the channel is not active, waits for the host to start listening on it.

Channel name Connected stream. The stream is binary, bidirectional, and sequential.

Optional MEF export to provide response to join failures that may happen if a guest collaboration service factory throws an exception with data set. If joining a session fails like this, LS will iterate over these MEF exports passing the exception until a handler returns non-null task result. If there is a non-null task result, LS will set VS command result to it and may show error dialog or gold bar. If there are no exports, or none returns a task with non-null result, LS will display the exception message in a gold bar similar to other join errors.

If join flow failed with an exception from collaboration service factory, check if the exception can be handled, and return non-null object to set LS OLE JoinWorkspace command result and show error dialog.

This code runs on the guest Exception thrown by a guest collaboration service factory, not null. Cancellation token that may be set, e.g. when VS is shutting down. Task that returns non-null to set as the variant result of the join command and, maybe, show an error dialog. Task that returns null to indicate it doesn't know how to response to this exception.

How command failure should be reported to the user

Default reporting with a gold bar. The error message comes from the message of collaboration factory exception which has Data.

No reporting.

Close collaboration session with an error dialog. The error message comes from the message of collaboration factory exception which has data. In case of online client, VS will restart after user dismisses the dialog.

How Live Share should handle join command failures

What result to return from join workspace OLE command. This must be convertible to variant with Marshal.GetNativeVariantForObject().

A value indicating how Live Share should report the failure.

Interface for sharing local servers. Query it off collaboration session on the host or owner guest side.

Start forwarding from localhost: tcp socket.

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. If not null, the guests will be asked if they want to open it in browser.

Stops sharing of the local tcp .

Port to stop sharing. Not 0 or negative.

Interface for sharing local servers which also lets the caller know what local tcp port is forwarded to. Query it off collaboration session on the host or owner guest side or cast to it.

Start forwarding from localhost: tcp socket and get the local tcp port number (which may be different from ).

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. If not null, the guests will be asked if they want to open it in browser. A task which result is the local tcp port number where port forwarding is set up

Service that can provide Live Share configuration. Live Share extensions can query for this service from . Importing this service from MEF is allowed, please consider that it'd make VS load several Live Share assemblies. This service is not supported for agent extensions.

Load Live Share settings and get the setting or throw if the setting is not found.

Type of the setting. See for each setting type. Setting name. Not null or empty. One of string constants from . Cancellation token. Setting value.

Live Share setting names for use in .

Live Share Feature Set. A string that can be one of constants on or null if it is something else.

Allow guest control of the debugger

Live Share setting value for setting. What feature set Live Share operates with.

Stable feature set.

Insiders feature set.

A debugger service that can run ouside of a Live Share session.

Returns the set of active debug sessions.

The token to monitor for cancellation requests. A task that represets the set of active debug sessions.

Disposes unmanaged resources held by this object.

A task that represents the asynchronous dispose operation.

A factory for debugger services that can run ouside of a Live Share session.

Creates a new .

The token to monitor for cancellation requests. A task that represets the newly created service.

A debug session service that can run outside a Live Share session.

Handles a debug adapter protocol request.

Type of the request. Arguments for the request. Typically a JObject. The token to monitor for cancellation requests. A task that represets the result. Typically extends Microsoft.VisualStudio.Shared.VSCodeDebugProtocol.Messages.ResponseBody.

An event that fires when the debug server sends an event to the client.

Preempts the Find All click in legacy find in files.

__VSFINDOPTIONS state of the find operation being performed. The find pattern for which the find operation is being performed The replace pattern for which the replace operation is being performed. Not Supported in LiveShare. Not supported in LiveShare. The location or file types where the find operation is performed.

MEF-exported internal interface used by the debugger to access the current debugger host

Provides the current debugger host. This will throw if there isn't one already.

Internal interface to the debugger host

Callback invoked by the debugger in Codespaces scenarios to tell the debugger host how to start a debug adapter and begin launching.

JSON content for a launch or attach request. This will also indicate how to start the debug adapter.

Invoked by the debugger in Codespaces scenarios to tell the debugger host how to start a debug adapter and begin launching, with notification via callback when launch completes.

JSON content for a launch or attach request. This will also indicate how to start the debug adapter. Callback to be invoked when launch completes.

Interface used by the debugger (and potentially other parts of Visual Studio in the future) to launch a shared terminal. Must be called on the host.

Start a terminal and open local pipe that connects to it

Options that control how terminal is started

Terminal name to be shown on client UI. This must be set.

Path to terminal application on the host machine. This must be set.

A value indicating whether the terminal is read-only for guests. This must be set.

Working directory on the host machine where terminal starts.

Terminal command line arguments

Terminal environment variables.

A value indicating whether the terminal is a debug terminal.

Information about a participant (host or guest) in a Live Share collaboration session.

Integer that uniquely identifies a peer within the scope of a session. Peer numbers are unique each time a peer joins the session, even if the same user joins multiple times, or joins, leaves, and joins again.

Authenticated Live Share user identity information.

NOTE: Access to user identity information may be restricted. If the caller is not permitted, this property returns 'null'.

Role within the session. Each session has exactly one host; the rest of the peers are guests.

Access level within the session. The host has full "owner" access to the session. Guests may have their access limited by the host.

Event that notifies listeners when a property on this object changed.

The identity may change when an anonymous user signs in. The access may change when the host changes a guest's access level. The other properties may change when a sharing session starts or ends.

Raises a event.

Access level of a peer within a Live Share session.

Creates a new peer identity object.

User display name.

Validated email address, if known.

User id. This is persistent ID that stays the same for the same user if the user re-joins the session and even between sessions for some time.

Role of a peer within a Live Share session.

Arguments for an event raised when peers join or leave a Live Share session.

Constructs a new event args structure with information about changed peers.

Type of change action, add or remove List of peers that were added or removed

Gets the type of change action. (Only add or remove change events are raised.)

Gets the list of peers that were added or removed.

Combines MEF export attribute with export metadata for a ProtectedOperation backed by Live Share access service. Attribute metadata declares when the ProtectedOperation is enabled. The export part needs to implement or may be null.

Create a new instance of for the given .

Protected operation moniker, not null.

Protected operation that Live Share access control service can handle. Implementations of this interface must be exported with . Live Share may use it both on the guest and on the host.

We cannot use Microsoft.ServiceHub.Framework.Services.ProtectedOperation directly because it's not available in 15.9 and 16.0 VS. So Live Share will pass operation moniker and required trust level. Also this is only what data on protected operation is passed between peers.

Gets a message for the guest telling that they have no access to protected operation.

Protected operation moniker, not null. Protected operation required trust level. Not null if the guest can display insufficient access message. Otherwise, null.

Gets a message for the guest telling that the host has granted access to perform a protected operation.

Protected operation moniker, not null. Protected operation required trust level. Not null if the guest can display permission granted message. Otherwise, null.

Gets a message for the guest telling that the host has rejected access to perform a protected operation.

Protected operation moniker, not null. Protected operation required trust level. Not null if the guest can display permission denied message. Otherwise, null.

Get a value indicating if the protected operation is allowed.

Protected operation moniker, not null. Protected operation required trust level. Client context. True if the operation is allowed. Otherwise, false.

Get permission request message for the protected operation or null if permission request is not allowed.

Protected operation moniker, not null. Protected operation required trust level. Client context. Not null if the user can request permission on the host. Otherwise, null.

Grant permission for the protected operation.

Protected operation moniker, not null. Protected operation required trust level. Client context. Task that completes when the permission is granted. Not null.

Event that fires when protected operation permission changes.

Protected operation message details

Create a new instance of .

Message contents, not null. A value indicating if the message is verbose (verbose messaged can be turned off in Live Share settings in Tools -> Options).

Get the message, not null.

Get a value indicating if the message is verbose (verbose messaged can be turned off in Live Share settings in Tools -> Options).

Event args that describe what protected operation changed and how

Create a new instance of .

Protected operation moniker. Not null. Protected operation required trust level. A value indicating if this protected operation has been enabled or disabled.

Protected operation moniker. Not null.

Protected operation required trust level.

A value indicating if this protected operation has been enabled or disabled.

Live Share peer role

Any Live Share peer - host, guest, or anynomous guest

Host or owner guest user, that is, the guest that is the same user as host, like in Codespaces client.

Host user only.

Metadata for

Protected operation moniker

Required trust level. Set to true if you set this property.

A value indicatingh whether the required trust level has value. If true, has the required trust level value.

A value indicating that this protected operation is enabled for read-only peers.

A value indicating that this protected operation is disabled if the file root is not persistent (e.g. remote URIs not like /~~/c$/....)

Peers that allowed to run the operation.

Client context that describes a guest in collaboration session that invokes a protected operation.

Get a value indicating if the user is read-only .

Get a value indicating if the file root is persistent (normally Codespaces only)

Get user display name.

Exception thrown by a proxy when a request to a shared service cannot be made because the service is not available or cannot be reached.

Creates an exception with the default message.

Creates an exception with an exception message.

An exception thrown from a remote method that was propagated back to the caller and rethrown.

Creates an exception with the default message and no remote stack trace.

Creates an exception with an exception message and no remote stack trace.

Creates an exception with an exception message and a remote stack trace.

Gets the stack trace of the exception that was thrown on the remote side of the RPC call.

Arguments for an event raised when availability of remote services changed within a Live Share session.

Constructs a new event args structure with information about changed services.

Type of change action, add or remove List of services that were added or removed

Gets the type of change action. (Only add or remove change events are raised.)

Gets the list of services that were added or removed.

Client Credentials in Brokered Service Activation Options

Culture-neutral string representation of peer number of the client

Live Share Session Id of the client

Conversation Id of the client

Brokered service monikers

Characterizes a role a collaboration service fulfills. The Live Share extensibility framework refers to the role value when activating the service in a session context.

The numeric value corresponds to a creation priority used by the extensibility framework when instantiating services in particular order.

Client for a remote RPC service. Activatable in guest sessions.

Local service (non-RPC) available within current session that other local services and Remote Workspace can use during their initialization. Activatable in both host and guest sessions.

Local service (non-RPC). Activatable in both host and guest sessions.

RPC service that may be called by remote guests. Activatable in host sessions.

The remote workspace extension (AnyCode workspace provider(s))

The remote service exposed by the owner guest client.

Collaboration session scope used to declare collaboration service affinity.

The service does not have collaboration session affinity.

Collaboration session created on a host for sharing a workspace.

Collaboration session created on a guest client for joining a workspace.

Indicates collaboration service should be activated for both host and guest collaboration sessions.

Event arguments for a debugger event outside a Live Share context.

Gets information about the event. Extends Microsoft.VisualStudio.Shared.VSCodeDebugProtocol.Messages.DebugEvent.

Creates a new .

Information about the event.

Assembly version information for Microsoft.VisualStudio.LiveShare.dll assembly

Assembly version.

Assembly name (without .dll extension)

File name (with .dll extension)

Public key token.