@sitecore-cloudsdk/events/browser

Version:


Import path	`@sitecore-cloudsdk/events/browser`

The browser module of the Cloud SDK events package provides the following functions, interfaces, types, and variables to capture and send events from the browser side.

Functions

Work with events using the following functions:

Name	Description
`addEvents`	Used as a method by the `CloudSDK` function to initialize the `events` package.
`pageView`	Sends a `VIEW` event.
`identity`	Sends an `IDENTITY` event.
`form`	Sends a `FORM` event.
`event`	Sends a custom event with custom data.
`addToEventQueue`	Adds an event with a valid payload to the event queue.
`processEventQueue`	Sends all the events in the event queue, in the order they were added.
`clearEventQueue`	Empties the event queue without sending any of the events.

Interfaces

Structure objects using the following interfaces:

Name	Description
`EventAttributesInput`	Data common to `VIEW`, `IDENTITY`, and custom events.
`PageViewData`	Data for `VIEW` events.
`IdentityData`	Data for `IDENTITY` events.
`EventData`	Data for custom events.

Types

Populate data requests with objects implementing the following types:

Name	Description
`ExtensionData`	Any custom data to collect about an event in addition to the other attributes provided for the event data.

Variables

Name	Description
`EVENTS_NAMESPACE`	The Cloud SDK and package name.
`PACKAGE_NAME`	The name of the installed Cloud SDK package.
`PACKAGE_VERSION`	The version of the installed Cloud SDK package.
`PACKAGE_INITIALIZER_METHOD_NAME`	The name of the initializer method of the Cloud SDK package.

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