blob: 4d5f5dc04f7fc0217a37a173257f5f644a96a72c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { Event } from 'vs/base/common/event';
import { IDisposable } from 'vs/base/common/lifecycle';
import { createDecorator } from 'vs/platform/instantiation/common/instantiation';
export const INotebookRendererMessagingService = createDecorator<INotebookRendererMessagingService>('INotebookRendererMessagingService');
export interface INotebookRendererMessagingService {
readonly _serviceBrand: undefined;
/**
* Event that fires when a message should be posted to extension hosts.
*/
onShouldPostMessage: Event<{ editorId: string; rendererId: string; message: unknown }>;
/**
* Prepares messaging for the given renderer ID.
*/
prepare(rendererId: string): void;
/**
* Gets messaging scoped for a specific editor.
*/
getScoped(editorId: string): IScopedRendererMessaging;
/**
* Called when the main thread gets a message for a renderer.
*/
receiveMessage(editorId: string | undefined, rendererId: string, message: unknown): Promise<boolean>;
}
export interface IScopedRendererMessaging extends IDisposable {
/**
* Method called when a message is received. Should return a boolean
* indicating whether a renderer received it.
*/
receiveMessageHandler?: (rendererId: string, message: unknown) => Promise<boolean>;
/**
* Sends a message to an extension from a renderer.
*/
postMessage(rendererId: string, message: unknown): void;
}
|
