Interface PapiWebViewProviderService

interface PapiWebViewProviderService {
    postMessageToWebView: (
        webViewId: string,
        webViewNonce: string,
        message: unknown,
        targetOrigin?: string,
    ) => Promise<void>;
    register: (
        ...args: [webViewType: string, webViewProvider: IWebViewProvider],
    ) => Promise<IDisposableWebViewProvider>;
    registerWebViewController: <WebViewType extends keyof WebViewControllers>(
        webViewType: WebViewType,
        webViewId: string,
        webViewController: WebViewControllers[WebViewType],
    ) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>;
    registerWebViewProvider: (
        webViewType: string,
        webViewProvider: IWebViewProvider,
    ) => Promise<IDisposableWebViewProvider>;
}

Index

Properties

postMessageToWebView register registerWebViewController registerWebViewProvider

Properties

postMessageToWebView

postMessageToWebView: (
    webViewId: string,
    webViewNonce: string,
    message: unknown,
    targetOrigin?: string,
) => Promise<void>

Type declaration

- (
      webViewId: string,
      webViewNonce: string,
      message: unknown,
      targetOrigin?: string,
  ): Promise<void>
- Sends a message to the specified web view. Expected to be used only by the IWebViewProvider that created the web view or the WebViewControllers that represents the web view created by the Web View Provider.
  
  postMessage is used to deliver the message to the web view iframe. The web view can use window.addEventListener("message", ...) in order to receive these messages.
  Parameters
  - webViewId: string
    Id of the web view to which to send a message.
  - webViewNonce: string
    Nonce used to perform privileged interactions with the web view. Pass in the nonce the web view provider received from IWebViewProvider.getWebView's webViewNonce parameter or from WebViewFactory.createWebViewController's webViewNonce parameter
  - message: unknown
    Data to send to the web view. Can only send serializable information
  - OptionaltargetOrigin: string
    Expected origin of the web view. Does not send the message if the web view's origin does not match. See postMessage's targetOrigin for more information. Defaults to same origin only (works automatically with React and HTML web views)
  Returns Promise<void>

register

register: (
...args: [webViewType: string, webViewProvider: IWebViewProvider],
) => Promise<IDisposableWebViewProvider>

Deprecated

13 November 2024. Renamed to registerWebViewProvider

registerWebViewController

registerWebViewController: <WebViewType extends keyof WebViewControllers>(
    webViewType: WebViewType,
    webViewId: string,
    webViewController: WebViewControllers[WebViewType],
) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>

Type declaration

- <WebViewType extends keyof WebViewControllers>(
      webViewType: WebViewType,
      webViewId: string,
      webViewController: WebViewControllers[WebViewType],
  ): Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>
- Register a web view controller to represent a web view. It is expected that a web view provider calls this to register a web view controller for a web view that is being created. If a web view provider extends WebViewFactory, it will call this function automatically.
  
  A Web View Controller is a network object that represents a web view and whose methods facilitate communication between its associated web view and extensions that want to interact with it.
  
  You can get web view controllers with webViewService.getWebViewController.
  Type Parameters
  - WebViewType extends keyof WebViewControllers
  Parameters
  - webViewType: WebViewType
    Type of web view for which you are providing this web view controller
  - webViewId: string
    Id of web view for which to register the web view controller
  - webViewController: WebViewControllers[WebViewType]
    Object to register as a web view controller including control over disposing of it. Note: the web view controller will be disposed automatically when the web view is closed
    
    WARNING: setting a web view controller mutates the provided object.
  Returns Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>
  webViewController modified to be a network object

registerWebViewProvider

registerWebViewProvider: (
webViewType: string,
webViewProvider: IWebViewProvider,
) => Promise<IDisposableWebViewProvider>

Type declaration

- (
  webViewType: string,
  webViewProvider: IWebViewProvider,
  ): Promise<IDisposableWebViewProvider>
- Register a web view provider to serve webViews for a specified type of webViews
  Parameters
  - webViewType: string
    Type of web view to provide
  - webViewProvider: IWebViewProvider
    Object to register as a webView provider including control over disposing of it.
    
    WARNING: setting a webView provider mutates the provided object.
  Returns Promise<IDisposableWebViewProvider>
  webViewProvider modified to be a network object and able to be disposed with dispose