Skip to content

Commit 85ca33c

Browse files
Fiona2016Fiona2016
committed
docs: unify SDK naming conventions and add installation options
- Add Note explaining dependency vs import naming (Flashcat deps, Datadog imports) - Unify product name from Flashcat to Flashduty across all SDK docs - Correct Android imports (cloud.flashcat.android -> com.datadog.android) - Correct iOS imports (FlashcatCore -> DatadogCore, etc.) - Add SPM and CocoaPods installation options for iOS SDK - Update version placeholders with release page links - Update SDK module tables with both dependency and import names
1 parent 68e825b commit 85ca33c

15 files changed

Lines changed: 614 additions & 452 deletions

‎en/rum/sdk/android/advanced-config.mdx‎

Lines changed: 56 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,14 @@ title: "Advanced Configuration"
33
description: "Configure advanced features of Android RUM SDK, including custom events, user tracking, sampling control, and data security"
44
---
55

6-
Android RUM SDK provides rich advanced configuration options to help you customize data collection and context information based on business needs.
6+
<Note>
7+
**About Dependencies and Package Names**
8+
9+
Flashduty Android SDK is fully compatible with the Datadog open-source protocol. In `build.gradle`, use `cloud.flashcat` group for dependencies, but in Kotlin/Java code, import classes from the `com.datadog.android` package. You can seamlessly leverage Datadog ecosystem documentation, examples, and best practices while enjoying Flashduty platform services.
10+
11+
</Note>
12+
13+
Flashduty Android RUM SDK provides rich advanced configuration options to help you customize data collection and context information based on business needs.
714

815
<Info>
916
**Supported Configuration Scenarios:**
@@ -23,28 +30,28 @@ When using `ActivityViewTrackingStrategy` or `FragmentViewTrackingStrategy`, the
2330
<Tabs>
2431
<Tab title="Kotlin">
2532
```kotlin
26-
import cloud.flashcat.android.rum.GlobalRum
33+
import com.datadog.android.rum.GlobalRumMonitor
2734

2835
fun onResume() {
29-
GlobalRum.get().startView(viewKey, viewName, attributes)
36+
GlobalRumMonitor.get().startView(viewKey, viewName, attributes)
3037
}
3138

3239
fun onPause() {
33-
GlobalRum.get().stopView(viewKey, attributes)
40+
GlobalRumMonitor.get().stopView(viewKey, attributes)
3441
}
3542
```
3643
</Tab>
3744

3845
<Tab title="Java">
3946
```java
40-
import cloud.flashcat.android.rum.GlobalRum;
47+
import com.datadog.android.rum.GlobalRumMonitor;
4148

4249
public void onResume() {
43-
GlobalRum.get().startView(viewKey, viewName, attributes);
50+
GlobalRumMonitor.get().startView(viewKey, viewName, attributes);
4451
}
4552

4653
public void onPause() {
47-
GlobalRum.get().stopView(viewKey, attributes);
54+
GlobalRumMonitor.get().stopView(viewKey, attributes);
4855
}
4956
```
5057
</Tab>
@@ -64,11 +71,11 @@ In addition to auto-tracked user interactions, you can track specific custom use
6471
<Tabs>
6572
<Tab title="Kotlin">
6673
```kotlin
67-
import cloud.flashcat.android.rum.GlobalRum
68-
import cloud.flashcat.android.rum.RumActionType
74+
import com.datadog.android.rum.GlobalRumMonitor
75+
import com.datadog.android.rum.RumActionType
6976

7077
fun onUserInteraction() {
71-
GlobalRum.get().addAction(
78+
GlobalRumMonitor.get().addAction(
7279
RumActionType.TAP,
7380
name,
7481
attributes
@@ -79,11 +86,11 @@ fun onUserInteraction() {
7986

8087
<Tab title="Java">
8188
```java
82-
import cloud.flashcat.android.rum.GlobalRum;
83-
import cloud.flashcat.android.rum.RumActionType;
89+
import com.datadog.android.rum.GlobalRumMonitor;
90+
import com.datadog.android.rum.RumActionType;
8491

8592
public void onUserInteraction() {
86-
GlobalRum.get().addAction(
93+
GlobalRumMonitor.get().addAction(
8794
RumActionType.TAP,
8895
name,
8996
attributes
@@ -110,22 +117,22 @@ In addition to auto-tracked resources, you can manually track specific custom re
110117
<Tabs>
111118
<Tab title="Kotlin">
112119
```kotlin
113-
import cloud.flashcat.android.rum.GlobalRum
114-
import cloud.flashcat.android.rum.RumResourceKind
120+
import com.datadog.android.rum.GlobalRumMonitor
121+
import com.datadog.android.rum.RumResourceKind
115122

116123
fun loadResource() {
117-
GlobalRum.get().startResource(resourceKey, method, url, attributes)
124+
GlobalRumMonitor.get().startResource(resourceKey, method, url, attributes)
118125
}
119126

120127
fun resourceLoadSuccess() {
121-
GlobalRum.get().stopResource(
128+
GlobalRumMonitor.get().stopResource(
122129
resourceKey, statusCode, size,
123130
RumResourceKind.NATIVE, attributes
124131
)
125132
}
126133

127134
fun resourceLoadError() {
128-
GlobalRum.get().stopResourceWithError(
135+
GlobalRumMonitor.get().stopResourceWithError(
129136
resourceKey, statusCode, message, source, throwable
130137
)
131138
}
@@ -134,22 +141,22 @@ fun resourceLoadError() {
134141

135142
<Tab title="Java">
136143
```java
137-
import cloud.flashcat.android.rum.GlobalRum;
138-
import cloud.flashcat.android.rum.RumResourceKind;
144+
import com.datadog.android.rum.GlobalRumMonitor;
145+
import com.datadog.android.rum.RumResourceKind;
139146

140147
public void loadResource() {
141-
GlobalRum.get().startResource(resourceKey, method, url, attributes);
148+
GlobalRumMonitor.get().startResource(resourceKey, method, url, attributes);
142149
}
143150

144151
public void resourceLoadSuccess() {
145-
GlobalRum.get().stopResource(
152+
GlobalRumMonitor.get().stopResource(
146153
resourceKey, statusCode, size,
147154
RumResourceKind.NATIVE, attributes
148155
);
149156
}
150157

151158
public void resourceLoadError() {
152-
GlobalRum.get().stopResourceWithError(
159+
GlobalRumMonitor.get().stopResourceWithError(
153160
resourceKey, statusCode, message, source, throwable
154161
);
155162
}
@@ -180,9 +187,9 @@ To record specific errors, notify the RUM SDK when an exception occurs:
180187
<Tabs>
181188
<Tab title="Kotlin">
182189
```kotlin
183-
import cloud.flashcat.android.rum.GlobalRum
190+
import com.datadog.android.rum.GlobalRumMonitor
184191

185-
GlobalRum.get().addError(
192+
GlobalRumMonitor.get().addError(
186193
message,
187194
source,
188195
throwable,
@@ -193,9 +200,9 @@ GlobalRum.get().addError(
193200

194201
<Tab title="Java">
195202
```java
196-
import cloud.flashcat.android.rum.GlobalRum;
203+
import com.datadog.android.rum.GlobalRumMonitor;
197204

198-
GlobalRum.get().addError(
205+
GlobalRumMonitor.get().addError(
199206
message,
200207
source,
201208
throwable,
@@ -216,20 +223,20 @@ In addition to RUM SDK's default performance metrics, you can use the `addTiming
216223
<Tabs>
217224
<Tab title="Kotlin">
218225
```kotlin
219-
import cloud.flashcat.android.rum.GlobalRum
226+
import com.datadog.android.rum.GlobalRumMonitor
220227

221228
fun onHeroImageLoaded() {
222-
GlobalRum.get().addTiming("hero_image")
229+
GlobalRumMonitor.get().addTiming("hero_image")
223230
}
224231
```
225232
</Tab>
226233

227234
<Tab title="Java">
228235
```java
229-
import cloud.flashcat.android.rum.GlobalRum;
236+
import com.datadog.android.rum.GlobalRumMonitor;
230237

231238
public void onHeroImageLoaded() {
232-
GlobalRum.get().addTiming("hero_image");
239+
GlobalRumMonitor.get().addTiming("hero_image");
233240
}
234241
```
235242
</Tab>
@@ -246,9 +253,9 @@ The RUM SDK automatically tracks user attributes. You can also add additional cu
246253
<Tabs>
247254
<Tab title="Kotlin">
248255
```kotlin
249-
import cloud.flashcat.android.rum.GlobalRum
256+
import com.datadog.android.rum.GlobalRumMonitor
250257

251-
GlobalRum.get().setUserInfo(
258+
GlobalRumMonitor.get().setUserInfo(
252259
id = "1234",
253260
name = "John Doe",
254261
email = "john@doe.com",
@@ -262,15 +269,15 @@ GlobalRum.get().setUserInfo(
262269

263270
<Tab title="Java">
264271
```java
265-
import cloud.flashcat.android.rum.GlobalRum;
272+
import com.datadog.android.rum.GlobalRumMonitor;
266273
import java.util.HashMap;
267274
import java.util.Map;
268275

269276
Map<String, Object> extraInfo = new HashMap<>();
270277
extraInfo.put("plan", "premium");
271278
extraInfo.put("group", "vip");
272279

273-
GlobalRum.get().setUserInfo(
280+
GlobalRumMonitor.get().setUserInfo(
274281
"1234",
275282
"John Doe",
276283
"john@doe.com",
@@ -293,17 +300,17 @@ Use `clearAllData` to clear all unsent data currently stored in the SDK:
293300
<Tabs>
294301
<Tab title="Kotlin">
295302
```kotlin
296-
import cloud.flashcat.android.Flashcat
303+
import com.datadog.android.Datadog
297304

298-
Flashcat.clearAllData()
305+
Datadog.clearAllData()
299306
```
300307
</Tab>
301308

302309
<Tab title="Java">
303310
```java
304-
import cloud.flashcat.android.Flashcat;
311+
import com.datadog.android.Datadog;
305312

306-
Flashcat.clearAllData();
313+
Datadog.clearAllData();
307314
```
308315
</Tab>
309316
</Tabs>
@@ -328,18 +335,18 @@ To comply with privacy regulations like GDPR and CCPA, you can set user tracking
328335

329336
```kotlin
330337
// Set consent state during initialization
331-
Flashcat.initialize(this, configuration, TrackingConsent.PENDING)
338+
Datadog.initialize(this, configuration, TrackingConsent.PENDING)
332339

333340
// Update consent state when user grants permission
334-
Flashcat.setTrackingConsent(TrackingConsent.GRANTED)
341+
Datadog.setTrackingConsent(TrackingConsent.GRANTED)
335342

336343
// Update consent state when user revokes permission
337-
Flashcat.setTrackingConsent(TrackingConsent.NOT_GRANTED)
344+
Datadog.setTrackingConsent(TrackingConsent.NOT_GRANTED)
338345
```
339346

340347
| State | Behavior |
341348
|-------|----------|
342-
| `GRANTED` | Start collecting data and send to Flashcat |
349+
| `GRANTED` | Start collecting data and send to Flashduty |
343350
| `NOT_GRANTED` | Do not collect any data |
344351
| `PENDING` | Collect but do not send, wait for user decision |
345352

@@ -350,25 +357,25 @@ Add global context attributes that will be attached to all RUM events:
350357
<Tabs>
351358
<Tab title="Kotlin">
352359
```kotlin
353-
import cloud.flashcat.android.rum.GlobalRum
360+
import com.datadog.android.rum.GlobalRumMonitor
354361

355362
// Add attribute
356-
GlobalRum.get().addAttribute("user_type", "premium")
363+
GlobalRumMonitor.get().addAttribute("user_type", "premium")
357364

358365
// Remove attribute
359-
GlobalRum.get().removeAttribute("user_type")
366+
GlobalRumMonitor.get().removeAttribute("user_type")
360367
```
361368
</Tab>
362369

363370
<Tab title="Java">
364371
```java
365-
import cloud.flashcat.android.rum.GlobalRum;
372+
import com.datadog.android.rum.GlobalRumMonitor;
366373

367374
// Add attribute
368-
GlobalRum.get().addAttribute("user_type", "premium");
375+
GlobalRumMonitor.get().addAttribute("user_type", "premium");
369376

370377
// Remove attribute
371-
GlobalRum.get().removeAttribute("user_type");
378+
GlobalRumMonitor.get().removeAttribute("user_type");
372379
```
373380
</Tab>
374381
</Tabs>

0 commit comments

Comments
 (0)