1. @sitecore-cloudsdk/events/browser

clearEventQueue

Version:

Type

Function

Import path

@sitecore-cloudsdk/events/browser

Empties the event queue, removing all the events that are in it, without sending any of the events.

Signature

export async function clearEventQueue(): Promise<void>

Return value

Returns a promise.

Examples

Example 38. Running the clearEventQueue function

Next.js

Note

To run this function, you have to first initialize the Cloud SDK.

Here's an example of how to use the clearEventQueue function to empty the event queue.

In this scenario, we add different events to the event queue depending on whether a site visitor clicked a dropdown menu and a dropdown menu item.

If a certain condition is met, you decide to empty the event queue and not send any of the events you previously added to it.

"use client"; // Used only in Next.js App Router
import { addToEventQueue, clearEventQueue } from "@sitecore-cloudsdk/events/browser";

export default function Component(){
  const sendEvents = async () => {
    if (true) {
      await addToEventQueue({ type: "DROPDOWN_CLICK" });
      console.log("Added DROPDOWN_CLICK event to event queue.");

      if (true) {
        await addToEventQueue({ type: "DROPDOWN_ITEM_CLICK" });
        console.log("Added DROPDOWN_ITEM_CLICK event to event queue.");
      } else {
        await addToEventQueue({ type: "DROPDOWN_ABANDON" });
        console.log("Added DROPDOWN_ABANDON event to event queue.");
      }

      const timeout = true;
      if (timeout) {
        await clearEventQueue();
        console.log("Did not send any of the queued events.");
      }
    }
  };

  return (
    <div>
      <button onClick={sendEvents}>send events</button>
    </div>
  );
};


If you have suggestions for improving this article, let us know!