/
index.tsx
174 lines (159 loc) · 5.86 KB
/
index.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
//
// Copyright 2020 PLAID, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
import { NativeModules } from 'react-native';
import { normalize } from '@react-native-karte/utilities';
import type { KRTCoreNativeModule } from './types';
const nativeModule: KRTCoreNativeModule = NativeModules.RNKRTCoreModule;
/** KARTE SDKのエントリポイントクラスです。 */
export class KarteApp {
private constructor() {}
/**
* ビジターIDを返します。
*
* @remarks
* ユーザーを一意に識別するためのID(ビジターID)を返します。
*
* なお初期化が行われていない場合は空文字列を返します。
*/
public static get visitorId(): string {
return nativeModule.getVisitorId();
}
/**
* オプトアウトの設定有無を返します。
*
* @remarks
* オプトアウトされている場合は、`true` を返し、されていない場合は `false` を返します。
*
* また初期化が行われていない場合は `false` を返します。
*/
public static get isOptOut(): boolean {
return nativeModule.isOptOut();
}
/**
* オプトインします。
*
* @remarks
* 初期化が行われていない状態で呼び出した場合はオプトインは行われません。
*/
public static optIn(): void {
nativeModule.optIn();
}
/**
* オプトアウトします。
*
* @remarks
* 初期化が行われていない状態で呼び出した場合はオプトアウトは行われません。
*/
public static optOut(): void {
nativeModule.optOut();
}
/**
* ビジターIDを再生成します。
*
* @remarks
* ビジターIDの再生成は、現在のユーザーとは異なるユーザーとして計測したい場合などに行います。
* 例えば、アプリケーションでログアウトを行った場合などがこれに該当します。
*
* なお初期化が行われていない状態で呼び出した場合は再生成は行われません。
*/
public static renewVisitorId(): void {
nativeModule.renewVisitorId();
}
}
/** イベントトラッキングを行うためのクラスです。 */
export class Tracker {
private constructor() {}
/**
* イベントの送信を行います。
* @param name イベント名
* @param values イベントに紐付けるカスタムオブジェクト
*/
public static track(name: string, values: object = {}) {
nativeModule.track(name, normalize(values));
}
/**
* Identifyイベントの送信を行います。
*
* @param values Identifyイベントに紐付けるカスタムオブジェクト
*/
public static identify(values: object): void;
/**
* Identifyイベントの送信を行います。
*
* @param userId ユーザーを識別する一意なID
* @param values Identifyイベントに紐付けるカスタムオブジェクト
*/
public static identify(userId: string, values?: object): void;
public static identify(value: string | object, values?: object): void {
if (typeof value === 'string') {
nativeModule.identifyWithUserId(value, normalize(values ?? {}));
} else {
nativeModule.identify(normalize(value));
}
}
/**
* Attributeイベントの送信を行います。
*
* @param values Attributeイベントに紐付けるカスタムオブジェクト
*/
public static attribute(values: object) {
nativeModule.attribute(normalize(values));
}
/**
* Viewイベントの送信を行います。
* @param viewName 画面名
* @param title タイトル
* @param values Viewイベントに紐付けるカスタムオブジェクト
*/
public static view(viewName: string, title?: string, values: object = {}) {
nativeModule.view(viewName, title, normalize(values));
}
}
/**
* WebView 連携するためのクラスです。
*
* @remarks
* WebページURLに連携用のクエリパラメータを付与した状態で、URLをWebViewで開くことでWebとAppのユーザーの紐付けが行われます。
* なお連携を行うためにはWebページに、KARTEのタグが埋め込まれている必要があります。
*/
export class UserSync {
private constructor() {}
/**
* @deprecated User sync function using query parameters is deprecated. It will be removed in the future. Use {@link getUserSyncScript} instead.
*
* 指定されたURL文字列にWebView連携用のクエリパラメータを付与します。
*
* @remarks
* 連携用のクエリパラメータを付与したURL文字列を返します。
* 指定されたURL文字列の形式が正しくない場合、またはSDKの初期化が行われていない場合は、引数に指定したURL文字列を返します。
*
* @param url 連携するページのURL文字列
*/
public static appendingQueryParameter(url: string): string {
return nativeModule.appendingUserSyncQueryParameter(url);
}
/**
* WebView 連携用のスクリプト(javascript)を返却します。
*
* @remarks
* ユーザースクリプトとしてWebViewに設定することで、WebView内のタグと連携されます。
* なおSDKの初期化が行われていない場合はnullを返却します。
*/
public static getUserSyncScript(): string {
return nativeModule.getUserSyncScript();
}
}
export { normalize };