@ digia- 约定/ 核心

反应原生 SDK 用于 Digia 启动它提供应用经验(努力, 在Android和iOS上的React Index apps.

如何运作

@digia-engage/core 包好本地的Digia 接触Android和iOS SDKs. 当地人 SDKs 装入运动,决定显示什么, 并做起推力, 调查和内线 内容。 工具提示和聚光灯指南在React Industrial中通过 <DigiaHost />锁定到您的 <DigiaAnchorView> 要素.

运动是由CEP(CleverTap、WebEngage、或MoEngage)引发的 @digia-engage/* 软件包)或由您的应用程序通过 Digia.triggerCampaign()。 。 。 .

所需资源

安装

npm install @digia-engage/core
# or
yarn add @digia-engage/core

自动链接处理本地设置 .

iOS 模块

Digia Involution iOS SDK 被发布到 Digia CocoaPods spec repo. 点可口可乐Pods在它.

展览 : 将配置插件添加到 app.json运行 npx expo prebuild数字 :

{ "expo": { "plugins": ["@digia-engage/core"] } }

裸体反应原生 : 将这些行添加到 ios/Podfile,保持此顺序:

source 'https://github.com/Digia-Technology-Private-Limited/digia-podspecs.git'
source 'https://cdn.cocoapods.org/'

然后安装吊舱并重建应用程序:

cd ios && pod install

要使用CEP,请同时安装其软件包: @digia-engage/clevertap, (中文(简体) ), @digia-engage/webengage,或 @digia-engage/moengage。 。 。 .

使用量

1 — SDK 初始化

打电话 Digia.initialize() 一次,尽可能早(最多 App.tsx:

import { Digia } from '@digia-engage/core';

await Digia.initialize({
  apiKey: 'YOUR_API_KEY',
  environment: 'production', // or 'sandbox'
  logLevel: 'error',
});

initialize() 最多等待2秒, 运动可以加载, 如果 装入失败 .

自定义字体

使用 Expo 软件嵌入字体 expo-font 配置插件或 您的本地项目,然后将注册的姓氏传给 Digia Evolution. 自动适用由机板提供的权重.

await Digia.initialize({
  apiKey: 'YOUR_API_KEY',
  fontFamily: 'Inter',
});

家庭必须登记为土著多面家庭。 如果被要求 面部不可用,操作系统执行正常字体倒置.

2 — 挂载 <DigiaHost />

地点 <DigiaHost /> 一次在您的组件树根后 导航容器。 它使工具指针和聚光灯向导.

// app/_layout.tsx (Expo Router) or App.tsx
import { DigiaHost } from '@digia-engage/core';

export default function RootLayout() {
  return (
    <>
      <Stack />
      <DigiaHost />
    </>
  );
}

3 — 轨迹屏幕变化

import { Digia } from '@digia-engage/core';

<NavigationContainer
  onStateChange={() => {
    const route = navRef.getCurrentRoute();
    if (route) Digia.setCurrentScreen(route.name);
  }}
>

4-为指导运动增加主播

环绕任何您想要工具提示或聚光灯指向的 UI 元素 :

import { DigiaAnchorView } from '@digia-engage/core';

<DigiaAnchorView anchorKey="home_banner_btn">
  <Button title="Banner" />
</DigiaAnchorView>

5——为内线运动增加插槽

import { DigiaSlotView } from '@digia-engage/core';

// Auto-sizes to the content height
<DigiaSlotView placementKey="home_banner" />

6-触发运动

带CEP 安装其软件包,并在之后注册 initialize()数字 :

import { DigiaCleverTapPlugin } from '@digia-engage/clevertap';

await Digia.initialize({ apiKey: 'YOUR_API_KEY' });
Digia.register(new DigiaCleverTapPlugin());

register() 如果 CEP 软件包没有安装或链接,则拒绝 。 每个CEP 软件包的 README 列出了它需要的额外设置 .

从你的应用程序 ——按键显示运动:

const { accepted, dropReason } = await Digia.triggerCampaign('welcome_tour');
if (!accepted) console.warn(`Not shown: ${dropReason}`);

dropReason 例如,解释拒绝的理由 frequency_capped, (中文(简体) ), screen_not_targeted, (中文(简体) ), unknown_campaign_key,或 not_ready 在竞选期间 还装入。 通过第二个参数来推翻竞选的变量 这个快递.

7——(备选)处理行动

只登记您的应用程序拥有的动作 。 配置的处理器抑制 SDK 倒置 :

await Digia.initialize({
  apiKey: 'YOUR_API_KEY',
  actionHandlers: {
    customKV: (payload) => handleCustomAction(payload),
    deepLink: (url) => router.push(url),
    openURL: (url) => openInAppBrowser(url),
  },
  linking: {
    routeViaSystemLinking: true,
    inAppBrowser: defaultInAppBrowser, // requires react-native-inappbrowser-reborn
  },
});

当屏幕停止拥有动作时, 处理器可以在初始化后被替换并清除 :

Digia.setCustomKVHandler((payload) => handleCustomAction(payload));
Digia.setCustomKVHandler(null);

8——(备选) 识别用户

Digia.setUserId('user-123'); // after login
Digia.clearUserId();         // on logout
Digia.clearAllInlineContent(); // drop the previous user's inline content

API 参考

Digia

DigiaConfig

<DigiaHost />

没有道具。 渲染器工具提示和聚光灯指南。 把它放在应用程序根上一次.

<DigiaAnchorView>

<DigiaSlotView>

在命名的布局中,Renders内置竞选内容(banners,卡片). 当没有为槽活动时折叠到零高度 .

许可证

业务来源许可证1.1(BUSL-1.1) · 叮当技术私人有限公司——见 自由主义