Interface ShareProvider

A provider which generates share links for resources in the editor.

interface ShareProvider {
    id: string;
    label: string;
    priority: number;
    provideShare(
        item: ShareableItem,
        token: CancellationToken,
    ): ProviderResult<string | Uri>;
}

Index

Properties

id label priority

Methods

Properties

`Readonly`id

id: string

A unique ID for the provider. This will be used to activate specific extensions contributing share providers if necessary.

`Readonly`label

label: string

A label which will be used to present this provider's options in the UI.

`Readonly`priority

priority: number

The order in which the provider should be listed in the UI when there are multiple providers.

Methods

provideShare

provideShare(
item: ShareableItem,
token: CancellationToken,
): ProviderResult<string | Uri>
Parameters
- item: ShareableItem
  Data about an item which can be shared.
- token: CancellationToken
  A cancellation token.
Returns ProviderResult<string | Uri>
A Uri representing an external link or sharing text. The provider result will be copied to the user's clipboard and presented in a confirmation dialog.
- Defined in packages/plugin/src/theia.proposed.shareProvider.d.ts:71