Skip to content

Commit 8b6be60

Browse files
committed
Update the iOS SDK documentation
1 parent 06cc421 commit 8b6be60

File tree

2 files changed

+27
-4
lines changed

2 files changed

+27
-4
lines changed

fern/docs/pages/sdks/mobile/ios/features.mdx

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,12 @@ If you want to display the support chat screen from the top-most view controller
244244
await DevRev.showSupport(isAnimated:)
245245
```
246246

247+
To create a new support conversation directly, use the following method:
248+
249+
```swift
250+
await DevRev.createSupportConversation(isAnimated:)
251+
```
252+
247253
For example:
248254

249255
```swift
@@ -255,6 +261,9 @@ await DevRev.showSupport(from: settingsViewController)
255261

256262
// Show the support chat screen from the top-most view controller, without an animation.
257263
await DevRev.showSupport(isAnimated: false)
264+
265+
// Create a new support conversation directly from the top-most view controller.
266+
await DevRev.createSupportConversation()
258267
```
259268
### SwiftUI
260269

@@ -354,6 +363,20 @@ The session recording feature includes the following methods to control the reco
354363
|`DevRev.stopRecording()` | Ends the session recording and uploads it to the portal. |
355364
|`DevRev.pauseRecording()` | Pauses the ongoing session recording. |
356365
|`DevRev.resumeRecording()` | Resumes a paused session recording. |
366+
|`DevRev.processAllOnDemandSessions()` | Stops the ongoing user recording and sends all on-demand sessions along with the current recording. |
367+
368+
You can also check the following flags for session recording:
369+
370+
```swift
371+
// Check if session recording is currently active.
372+
let isRecording = DevRev.isRecording
373+
374+
// Check if session monitoring is enabled.
375+
let isMonitoringEnabled = DevRev.isMonitoringEnabled
376+
377+
// Check if on-demand sessions are enabled.
378+
let areOnDemandSessionsEnabled = DevRev.areOnDemandSessionsEnabled
379+
```
357380

358381
### Session properties
359382

@@ -395,7 +418,7 @@ You can implement your own masking logic by conforming to the `DevRev.MaskLocati
395418
- `DevRev.SnapshotMask`: Describes the regions of a snapshot to be masked.
396419
- `DevRev.SnapshotMask.Location`: Describes a masked region.
397420

398-
#### Example
421+
For example:
399422
```swift
400423
import Foundation
401424
import UIKit
@@ -435,7 +458,7 @@ DevRev.startTimer(_:properties:)
435458
To stop a timer, use the following method:
436459

437460
```swift
438-
DevRev.stopTimer(_:properties:)
461+
DevRev.endTimer(_:properties:)
439462
```
440463

441464
For example:
@@ -445,7 +468,7 @@ DevRev.startTimer("response-time", properties: ["id": "task-1337"])
445468

446469
// Perform the task that you want to measure.
447470

448-
DevRev.stopTimer("response-time", properties: ["id": "task-1337"])
471+
DevRev.endTimer("response-time", properties: ["id": "task-1337"])
449472
```
450473

451474
### Screen tracking

fern/docs/pages/sdks/mobile/ios/migration-guide.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ This guide and chart should help facilitate the transition from the legacy UserE
1414
| Opting in/out | `UserExperior.consentOptIn()`<br />`UserExperior.consentOptOut()`<br />`UserExperior.getConsentStatus`<br />`UserExperior.getOptOutStatus` | `DevRev.stopAllMonitoring()`<br />`DevRev.resumeAllMonitoring()` |
1515
| Session Properties | `UserExperior.setUserProperties(_ properties: [String: Any])` | `DevRev.addSessionProperties(properties: [String: String])`<br />`DevRev.clearSessionProperties()` |
1616
| Masking Sensitive Data | `UserExperior.markSensitiveViews(_ viewsToSecure: NSArray)`<br />`UserExperior.unmarkSensitiveViews(_ viewsToSecure: NSArray)` | `DevRev.markSensitiveViews(_ sensitiveViews: [UIView])`<br />`DevRev.unmarkSensitiveViews(_ sensitiveViews: [UIView])` |
17-
| Timers | `UserExperior.startTimer(_ timerName: String)`<br />`UserExperior.endTimer(_ timerName: String)` | `DevRev.startTimer(_ name: String, properties: [String: String])`<br />`DevRev.stopTimer(_ name: String, properties: [String: String])` |
17+
| Timers | `UserExperior.startTimer(_ timerName: String)`<br />`UserExperior.endTimer(_ timerName: String)` | `DevRev.startTimer(_ name: String, properties: [String: String])`<br />`DevRev.endTimer(_ name: String, properties: [String: String])` |
1818
| PLuG support chat | Not supported. | `DevRev.showSupport(isAnimated: Bool)`<br />`DevRev.showSupport(from parentViewController: UIViewController, isAnimated: Bool)`<br />`DevRev.showSupport(from navigationController: UINavigationController, isAnimated: Bool)`<br />`DevRev.createSupportConversation(isAnimated: Bool)`<br />`DevRev.shouldDismissModalsOnOpenLink`<br />`DevRev.inAppLinkHandler` |
1919
| Push Notifications | Not supported. | `DevRev.registerDeviceToken(_ deviceToken: Data, deviceID: String)`<br />`DevRev.processPushNotification(_ userInfo: [String: String])` |

0 commit comments

Comments
 (0)