|
1 | 1 | ---
|
2 | 2 | title: Signals Implementation Guide
|
| 3 | +hidden: true |
3 | 4 | ---
|
4 | 5 |
|
5 | 6 |
|
| 7 | +## Configure Signals |
6 | 8 |
|
| 9 | +### Swift |
7 | 10 |
|
8 | 11 |
|
9 | 12 | | `Option` | Required | Value | Description |
|
10 | 13 | | ---------------------- | -------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
11 | 14 | | `writeKey` | Yes | String | Source write key |
|
12 | 15 | | `maximumBufferSize` | No | Integer | The number of signals to be kept for JavaScript inspection. This buffer is first-in, first-out. Default is `1000`. |
|
13 |
| -| `relayCount` | No | Integer | Relays signals to Segment every Xth event. Default is `20`. | |
14 |
| -| `relayInterval` | No | TimeInterval (default: 60) | Relays signals to segment every X seconds. Default is `60`. | |
| 16 | +| `relayCount` | No | Integer | Relays signals to Segment every Xth event. Default is `20`. | |
| 17 | +| `relayInterval` | No | TimeInterval (default: 60) | Relays signals to segment every X seconds. Default is `60`. | |
15 | 18 | | `broadcasters` | No | `SignalBroadcaster` | An array of broadcasters. These objects forward signal data to their destinations, like `WebhookBroadcaster` or `DebugBroadcaster` writing to the developer console. Default is `SegmentBroadcaster`. |
|
16 | 19 | | `useUIKitAutoSignal` | No | Bool | Tracks UIKit component interactions automatically. Default is `false`. |
|
17 | 20 | | `useSwiftUIAutoSignal` | No | Bool | Tracks SwiftUI component interactions automatically. Default is `false`. |
|
18 | 21 | | `useNetworkAutoSignal` | No | Bool | Tracks network events automatically. Default is `false`. |
|
19 | 22 | | `allowedNetworkHosts` | No | [String] | |
|
20 | 23 | | `blockedNetworkHosts` | No | [String] | |
|
21 | 24 |
|
| 25 | + |
| 26 | +### Kotlin |
| 27 | + |
| 28 | +| `Option` | Required | Value | Description | |
| 29 | +| ------------------- | -------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| 30 | +| `writeKey` | Yes | String | Source write key | |
| 31 | +| `maximumBufferSize` | No | Integer | The number of signals to be kept for JavaScript inspection. This buffer is first-in, first-out. Default is `1000`. | |
| 32 | +| `broadcastInterval` | No | Integer | Broadcasts signals to Segment every X event. Default is `60`. | |
| 33 | +| `broadcasters` | No | `List<SignalBroadcaster>` | An array of broadcasters. These objects forward signal data to their destinations, like `WebhookBroadcaster` or `DebugBroadcaster` writing to the developer console. Default is `SegmentBroadcaster`. | |
| 34 | + |
| 35 | + |
| 36 | +## Converting Signals to events |
| 37 | + |
| 38 | + |
| 39 | + |
| 40 | +## Example rule implementations |
| 41 | + |
0 commit comments