interface ICoreWebView2NotificationReceivedEventArgs

Article
11/18/2024

interface ICoreWebView2NotificationReceivedEventArgs
  : public IUnknown

Event args for the NotificationReceived event.

Summary

Members	Descriptions
get_Handled	Gets whether the `NotificationReceived` event is handled by host.
get_Notification	The notification that was received.
get_SenderOrigin	The origin of the web content that sends the notification, such as `https://example.com/` or `https://www.example.com/`.
GetDeferral	Returns an ICoreWebView2Deferral object.
put_Handled	Sets whether the `NotificationReceived` event is handled by the host after the event handler completes or if there is a deferral then after the deferral is completed.

    // Register a handler for the NotificationReceived event.
    CHECK_FAILURE(m_webView2_24->add_NotificationReceived(
        Callback<ICoreWebView2NotificationReceivedEventHandler>(
            [this](ICoreWebView2* sender, ICoreWebView2NotificationReceivedEventArgs* args)
                -> HRESULT
            {
                // Block notifications from specific URIs and set Handled to
                // true so the the default notification UI will not be
                // shown by WebView2 either.
                CHECK_FAILURE(args->put_Handled(TRUE));

                Microsoft::WRL::ComPtr<ICoreWebView2Deferral> deferral;
                CHECK_FAILURE(args->GetDeferral(&deferral));
                wil::unique_cotaskmem_string origin;
                CHECK_FAILURE(args->get_SenderOrigin(&origin));
                std::wstring originString = origin.get();
                Microsoft::WRL::ComPtr<ICoreWebView2Notification> notification;
                CHECK_FAILURE(args->get_Notification(&notification));

                notification->add_CloseRequested(
                    Callback<ICoreWebView2NotificationCloseRequestedEventHandler>(
                        [this, &sender](
                            ICoreWebView2Notification* notification, IUnknown* args) -> HRESULT
                        {
                            // Remove the notification from the list of active
                            // notifications.
                            RemoveNotification(notification);
                            return S_OK;
                        })
                        .Get(),
                    &m_notificationCloseRequestedToken);

                m_appWindow->RunAsync(
                    [this,
                     notificationCom =
                         wil::make_com_ptr<ICoreWebView2Notification>(notification.Get()),
                     deferral, originString]()
                    {
                        ShowNotification(notificationCom.get(), originString);
                        deferral->Complete();
                    });

                return S_OK;
            })
            .Get(),
        &m_notificationReceivedToken));

Applies to

Product	Introduced
WebView2 Win32	1.0.2739.15
WebView2 Win32 Prerelease	1.0.2730

Members

get_Handled

Gets whether the NotificationReceived event is handled by host.

public HRESULT get_Handled(BOOL * value)

get_Notification

The notification that was received.

public HRESULT get_Notification(ICoreWebView2Notification ** value)

You can access the properties on the Notification object to show your own notification.

get_SenderOrigin

The origin of the web content that sends the notification, such as https://example.com/ or https://www.example.com/.

public HRESULT get_SenderOrigin(LPWSTR * value)

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

GetDeferral

Returns an ICoreWebView2Deferral object.

public HRESULT GetDeferral(ICoreWebView2Deferral ** deferral)

Use this operation to complete the event at a later time.

put_Handled

Sets whether the NotificationReceived event is handled by the host after the event handler completes or if there is a deferral then after the deferral is completed.

public HRESULT put_Handled(BOOL value)

If Handled is set to TRUE then WebView will not display the notification with the default UI, and the host will be responsible for handling the notification and for letting the web content know that the notification has been displayed, clicked, or closed. You must set Handled to TRUE before you call ReportShown, ReportClicked, ReportClickedWithActionIndex and ReportClosed, otherwise they will fail with HRESULT_FROM_WIN32(ERROR_INVALID_STATE). If after the event handler or deferral completes Handled is set to FALSE then WebView will display the default notification UI. Note that you cannot un-handle this event once you have set Handled to be TRUE. The initial value is FALSE.

Partager via