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.

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 .

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.

A factory interface as exported by a LiveShare extension component.

Get an instance of the exported service type for the session context.

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

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 StreamConnected event and call Listen() to start listening.

The name of the channel, not null or empty. Chennel 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 IHostChannelFactory.CreateChannel.

Start listening on the channel. StreamConnected event handler must be set first.

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

Event args for StreamConnected event on IHostChannel.

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 guest service that allows to connect to the channels on the host in a collaborations 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.

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.

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

Stable feature set.

Insiders feature set.

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 Visual Studio Online Environments 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.

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.

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.

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. TODO: janraj, add documentation.

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.