interface ICoreWebView2ExperimentalSharedWorker

Note

This reference is no longer being maintained. For the latest API reference, see WebView2 API Reference.

Note

This an experimental API that is shipped with our prerelease SDK. See WebView2 release notes.

interface ICoreWebView2ExperimentalSharedWorker
  : public IUnknown

This interface represents a shared worker in WebView2 and provides methods and properties for interacting with it, such as listening to destroying events and getting the script URI, origin, and top-level origin of the worker.

Summary

Members	Descriptions
add_Destroying	Adds an event handler for the Destroying event.
get_Origin	A string representing the URI of the origin where the worker is executing.
get_ScriptUri	A string representing the Uri of the script that the worker is executing.
get_TopLevelOrigin	A string representing the URI of the top-level document that the worker is associated with.
remove_Destroying	Removes an event handler previously added with add_Destroying.

Applies to

Product	Introduced
WebView2 Win32	N/A
WebView2 Win32 Prerelease

Members

add_Destroying

Adds an event handler for the Destroying event.

public HRESULT add_Destroying(ICoreWebView2ExperimentalSharedWorkerDestroyingEventHandler * eventHandler, EventRegistrationToken * token)

Add an event handler for the Destroying event that is raised when the worker object is Destroying.

A worker object is Destroying when the worker script is terminated or when the CoreWebView2SharedWorker object is Destroying.

If the worker has already been destroyed before the event handler is registered, the handler will never be called.

get_Origin

A string representing the URI of the origin where the worker is executing.

public HRESULT get_Origin(LPWSTR * value)

If a worker created with ScriptUri set to https://example.com/worker.js, the origin will be https://example.com/.

Refer to the Host Name Canonicalization for details on how normalization is performed.

The caller must free the returned string with CoTaskMemFree. See API Conventions.

get_ScriptUri

A string representing the Uri of the script that the worker is executing.

public HRESULT get_ScriptUri(LPWSTR * value)

The scriptUri is a fully qualified URI, including the scheme, host, and path. In contrast, the scriptURL property of the Worker object in the DOM returns the relative URL of the script being executed by the worker. For more details on DOM API, see the DOM API documentation.

Refer to the Host Name Canonicalization for details on how normalization is performed. The same process applies to the scriptURL when a worker is created from DOM API. The scriptUri property reflects this normalization, ensuring that the URL is standardized. For example, HTTPS://EXAMPLE.COM/worker.js is canonicalized to https://example.com/worker.js; https://b????cher.de/worker.js is canonicalized to https://xn--bcher-kva.de/worker.js.

The caller must free the returned string with CoTaskMemFree. See API Conventions.

get_TopLevelOrigin

A string representing the URI of the top-level document that the worker is associated with.

public HRESULT get_TopLevelOrigin(LPWSTR * value)

If a worker is created with ScriptUri set to https://example.com/worker.js, the top-level origin is https://example.com/. If the same worker is created from a iframe at https://example.com/ which is hosted on https://example2.com/, the top-level origin is https://example2.com/.

Refer to the Host Name Canonicalization for details on how normalization is performed.

When CustomDataPartitionId is set, the TopLevelOrigin will be a generated site like guid.invalid. For example, if the top-level document is https://example.com/worker.js, the top-level origin will be https://guid.invalid/.

For more details see ICoreWebView2Experimental20::CustomDataPartitionId.

The caller must free the returned string with CoTaskMemFree. See API Conventions.

remove_Destroying

Removes an event handler previously added with add_Destroying.

public HRESULT remove_Destroying(EventRegistrationToken token)