forked from heap/react-native-heap
-
Notifications
You must be signed in to change notification settings - Fork 2
/
index.d.ts
151 lines (135 loc) · 6.64 KB
/
index.d.ts
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
import * as React from 'react';
import { HeapIgnore, HeapIgnoreTargetText } from './js/autotrack/heapIgnore';
export const setTracking: (track: (event: string, properties: any) => void) => void
/**
* `setAppId` Initializes Heap tracking and sets the app ID where you'll be sending data. It can be used to switch
* between projects or between your production and development environments.
*
* __NOTE:__ On iOS, subsequent calls are ignored. On Android, a new session is initialized each time
* `setAppId` is called.
*
* @param appId the appId corresponding to one of your projects
*/
export function setAppId(appId: string): void;
/**
* Send additional events to Heap.
*
* The properties map may be null to track an event with no properties.
* The `withProperties` object will first be flattened before sending the event, so that any nested structure
* will be represented by a dot notation (e.g. a key "bar" nested under "foo" will appear as "foo.bar").
*
* Custom event properties can be queried in the same fashion as any other event property.
*
* @param event name of the custom interaction. Limited to 255 characters.
* @param withProperties a JSON object containing key-value pairs to be associated with an event. Nested objects
* will be flattened.
*/
export function track(event: string, properties?: object): void;
/**
* Attach a unique identity to a user.
*
* If you assign the same identity to a user on a separate device, their past sessions and event activity will be
* merged into the existing Heap user with that identity.
*
* To better understand the client-side `identify` and `addUserProperties` APIs,
* [take a look at our comprehensive guide.](https://docs.heapanalytics.com/docs/using-identify)
*
* __NOTE:__ The string you pass to heap.identify() is case sensitive. To avoid split users due to capitalization,
* we recommend converting your identity to lowercase before sending to Heap if you are using email as the identity.
*
* @param identity a case-sensitive string that uniquely identifies a user, such as an email, handle, or username.
* This means no two users in one environment may share the same identity. Must be fewer than 255 characters.
*/
export function identify(identity: string): void;
/**
* Attach custom properties to user profiles.
*
* The `addUserProperties` API lets you attach custom properties to user profiles,
* such as account-level info from your database, or demographic info.
*
* The `properties` object will first be flattened before sending the event, so that any nested structure
* will be represented by a dot notation (e.g. a key "bar" nested under "foo" will appear as "foo.bar").
*
* To better understand the client-side `identify` and `addUserProperties` APIs,
* [take a look at our comprehensive guide.](https://docs.heapanalytics.com/docs/using-identify)
*
* @param properties a JSON object containing key-value pairs to be associated with a user.
* Keys and values must be a number or string, with the value being 255 characters or fewer.
*
* Also, the string user_id cannot be used as a key in the user properties object.
* For Android, the property map keys and values must be converted to strings,
* but they can be queried as numbers in Heap.
*
* User properties are associated with all of the user's past activity, in addition to their future activity.
* Custom user properties can be queried in the same fashion as any other user property.
*
* __Important:__ If you want to write your user's email into the builtin Email property,
* you must send the key lowercase i.e. heap.addUserProperties({"email": `"[email protected]"`});
* Sending an email value with a non-lowercase key will create a new property to store this data.
*/
export function addUserProperties(properties: object): void;
/**
* Specify a set of global key-value pairs to get attached to all of a user's subsequent events.
*
* These event properties will persist across multiple sessions on the same device and get applied to both
* auto-captured and custom events.
*
* This is useful if you have some persistent state, but you don't want to apply it across all of a user's
* events with `addUserProperties`. A good example is "Logged In", which changes over the user's lifecycle.
* You can use `addEventProperties` to measure how a user's behavior changes when they're logged in
* vs. when they're logged out.
*
* The `properties` object will first be flattened before sending the event, so that any nested structure
* will be represented by a dot notation (e.g. a key "bar" nested under "foo" will appear as "foo.bar").
*
* @param properties a JSON object containing key-value pairs to be associated with
* every subsequent event. Keys and values must be a number or string fewer than 1024 characters.
*
* For Android, the property map keys and values must be converted to strings,
* but they can be queried as numbers in Heap.
*/
export function addEventProperties(properties: object): void;
/**
* Stops a single event property from getting attached to all subsequent events.
*
* @param property name of the event property to remove. This stops attaching the property to all subsequent events.
*/
export function removeEventProperty(property: string): void;
/**
* Removes all stored event properties.
*/
export function clearEventProperties(): void;
/**
* Resets a user's identity to a random anonymous user ID. A new session for an anonymous user will begin when called if the user was
* previously identified. The method has no effect if the user was previously anonymous when called.
*/
export function resetIdentity(): void;
/**
* Returns a promise that resolves to the stringified version of the numeric user ID associated with user.
*/
export function getUserId(): Promise<string>;
/**
* Returns an HOC of a component with specific HeapIgnore properties.
*
* @param IgnoredComponent the component to wrap with HeapIgnore.
* @param heapIgnoreConfig the HeapIgnore configuration
*/
export function withHeapIgnore(IgnoredComponent: React.Component, heapIgnoreConfig?: object): React.Component;
/**
* Component for ignoring all or parts of interactions with children of this component.
*/
export class Ignore extends React.Component {}
/**
* Convenience component for ignoring 'target_text' on interactions with children of this component.
*/
export const IgnoreTargetText: React.SFC;
export { HeapIgnore, HeapIgnoreTargetText };
/**
* The following functions are not available via the iOS and Android API.
*
* export function enableVisualizer(): void;
* export function startDebug(): void;
* export function stopDebug(): void;
* export function libVersion(): Promise<string>;
* export function changeInterval(interval: number): void;
*/