react-native-custom-sitecore-engage

React-native Sitecore Engage

Copied and modified for supporting React-native library @sitecore/engage. Source library functionality stay as it is, but made some changes with (get/set) cookie properties, due to the lack of cookie parameters on mobile devices.

Created by:

© Sitecore Corporation A/S. All rights reserved. Sitecore© is a registered trademark of Sitecore Corporation A/S.

Sitecore Engage is a JavaScript library for sending behavioral data from a web application to Sitecore CDP.

Prerequisites

Before installing Custom Sitecore Engage, you need:

• Node.js
• npm
• A mobile application.

  Note A Sitecore JavaScript Rendering SDK (JSS) Next.js application with the nextjs-personalize add-on automatically installs Sitecore Engage.

• Your Sitecore CDP client key, target URL, and point of sale.

Installation

npm install react-native-custom-sitecore-engage

Importing

import { init, initAppStore } from "react-native-custom-sitecore-engage";

Usage

This section describes using Custom Sitecore Engage in your mobile application.

1. In the App (or any init) function, create an asynchronous function loadEngage for loading the Engage API, then call loadEngage in an Effect Hook.

Tip We recommend that you use the Effect Hook because the window object must be present before you load the Engage API.

export default function App() {
    const loadEngage = async () => {
        // Init appStore
        initAppStore(yourAppStore)
        // AppStore Must contain functions browserId & setBrowserId!!! 
        // f.e. appStore.browseId     appStore.setBrowserId(browserId)
      
        // Load Engage API
        const engage = await init({
            clientKey: "{client_key_PLACEHOLDER}", // for example, "ZpHxO9WvLOfQRVPlvo0BqB8YjGYuFfNe"
            targetURL: "{stream_api_target_endpoint_PLACEHOLDER}", // for example, "https://api-engage-eu.sitecorecloud.io"
            cookieDomain: "{cookie_domain_PLACEHOLDER}", // for example, ".beta.myretailsite.com"
            cookieExpiryDays: 365,
            includeUTMParameters: true,
            webPersonalization: true,
            forceServerCookieMode: true, // We recomend to set this option as True
        });

        // Send VIEW events
        engage.pageView({
            channel: "{channel_PLACEHOLDER}", // for example, "WEB"
            currency: "{currency_PLACEHOLDER}", // for example, "EUR"
            pos: "{point_of_sale_PLACEHOLDER}" // for example, "myretailsite/ireland"
        });
    };
    
    useEffect(() => {
      loadEngage();
    }, []);

    return (
      <></>
    );
};

2. Reload your application. Every time your app init, a VIEW event is sent to Sitecore CDP.

Documentation for official source library and community resources

• Official JSS documentation
• StackExchange
• Community Slack
• Sitecore Community Forum