Interface ICompletionProviderManager

interface ICompletionProviderManager {
    activeProvidersChanged: ISignal<ICompletionProviderManager, void>;
    inline?: IInlineCompleterActions;
    inlineProviders?: IInlineCompletionProviderInfo[];
    selected: ISignal<ICompletionProviderManager, ICompleterSelection>;
    invoke(id: string): void;
    registerInlineProvider(
        provider: IInlineCompletionProvider<IInlineCompletionItem>,
    ): void;
    registerProvider(provider: ICompletionProvider<ICompletionItem>): void;
    select(id: string): void;
    setInlineCompleterFactory(factory: IInlineCompleterFactory): void;
    updateCompleter(newCompleterContext: ICompletionContext): Promise<void>;
}

Implemented by

CompletionProviderManager

Index

Properties

activeProvidersChanged inline? inlineProviders? selected

Methods

invoke registerInlineProvider registerProvider select setInlineCompleterFactory updateCompleter

Properties

activeProvidersChanged

activeProvidersChanged: ISignal<ICompletionProviderManager, void>

Signal emitted when active providers list is changed.

`Optional`inline

inline?: IInlineCompleterActions

Inline completer actions.

`Optional`inlineProviders

inlineProviders?: IInlineCompletionProviderInfo[]

Inline providers information.

selected

selected: ISignal<ICompletionProviderManager, ICompleterSelection>

Signal emitted when a selection is made from a completer menu.

Methods

invoke

invoke(id: string): void
Invoke the completer in the widget with provided id.
Parameters
- id: string
  the id of notebook panel, console panel or code editor.
Returns void
- Defined in packages/completer/src/tokens.ts:369

registerInlineProvider

registerInlineProvider(
provider: IInlineCompletionProvider<IInlineCompletionItem>,
): void
Register an inline completer provider with the manager.
Parameters
- provider: IInlineCompletionProvider<IInlineCompletionItem>
Returns void
- Defined in packages/completer/src/tokens.ts:357

registerProvider

registerProvider(provider: ICompletionProvider<ICompletionItem>): void
Register a completer provider with the manager.
Parameters
- provider: ICompletionProvider<ICompletionItem>
  the provider to be registered.
Returns void
- Defined in packages/completer/src/tokens.ts:352

select

select(id: string): void
Activate select command in the widget with provided id.
Parameters
- id: string
  the id of notebook panel, console panel or code editor.
Returns void
- Defined in packages/completer/src/tokens.ts:376

setInlineCompleterFactory

setInlineCompleterFactory(factory: IInlineCompleterFactory): void
Set inline completer factory.
Parameters
- factory: IInlineCompleterFactory
Returns void
- Defined in packages/completer/src/tokens.ts:362

updateCompleter

updateCompleter(newCompleterContext: ICompletionContext): Promise<void>
Update completer handler of a widget with new context.
Parameters
- newCompleterContext: ICompletionContext
  The completion context.
Returns Promise<void>
- Defined in packages/completer/src/tokens.ts:383