You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: fern/docs/pages/sdks/mobile/flutter/features.mdx
+22-23Lines changed: 22 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,11 @@ To access certain features of the DevRev SDK, user identification is required.
6
6
7
7
The identification function should be placed appropriately in your app after the user logs in. If you have the user information available at app launch, call the function after the `DevRev.configure(appID:)` method.
8
8
9
-
<Calloutintent="note">
9
+
<Calloutintent="tip">
10
10
On iOS, if you haven't previously identified the user, the DevRev SDK will automatically create an anonymous user for you immediately after the SDK is configured.
11
11
</Callout>
12
12
13
-
<Calloutintent="note">
13
+
<Calloutintent="tip">
14
14
The `Identity` structure allows for custom fields in the user, organization, and account traits. These fields must be configured through the DevRev app before they can be used. For more information, refer to [Object customization](https://devrev.ai/docs/product/object-customization).
15
15
</Callout>
16
16
@@ -52,7 +52,7 @@ For security reasons we **strongly recommend** that the token exchange is execut
52
52
2. Open the **PLuG Tokens** page.
53
53
3. Under the **Application access tokens** panel, click **New token** and copy the token that's displayed.
54
54
55
-
<Calloutintent="note">
55
+
<Calloutintent="warning">
56
56
Ensure that you copy the generated application access token, as you cannot view it again.
57
57
</Callout>
58
58
@@ -81,7 +81,7 @@ curl \
81
81
82
82
The response of the API call will contain a session token that you can use with the verified identification method in your app.
83
83
84
-
<Calloutintent="note">
84
+
<Calloutintent="warning">
85
85
As a good practice, **your** app should retrieve the exchanged session token from **your** backend at app launch or any relevant app lifecycle event.
86
86
</Callout>
87
87
@@ -101,11 +101,11 @@ You can update the user's information using the following method:
101
101
DevRev.updateUser(identity)
102
102
```
103
103
104
-
<Calloutintent="note">
104
+
<Calloutintent="warning">
105
105
The `userID` property cannot be updated.
106
106
</Callout>
107
107
108
-
<Calloutintent="note">
108
+
<Calloutintent="tip">
109
109
The identification functions are asynchronous. Ensure you wrap them in a `Task` when calling from synchronous contexts.
110
110
</Callout>
111
111
@@ -161,15 +161,18 @@ The `Identity` class contains the following properties:
161
161
|`organizationTraits`|`OrganizationTraits?`| ❌ | Additional information about the organization |
162
162
|`accountTraits`|`AccountTraits?`| ❌ | Additional information about the account |
163
163
164
-
> [!NOTE]
165
-
> The custom fields properties defined as part of the user, organization and account traits, must be configured in the DevRev web app **before** they can be used. See [Object customization](https://devrev.ai/docs/product/object-customization) for more information.
164
+
<Calloutintent="note">
165
+
The custom fields properties defined as part of the user, organization and account traits, must be configured in the DevRev web app **before** they can be used. See [Object customization](https://devrev.ai/docs/product/object-customization) for more information.
166
+
</Callout>
166
167
167
168
#### UserTraits
168
169
169
170
The `UserTraits` class contains detailed information about the user:
170
171
171
-
> [!NOTE]
172
-
> All properties in `UserTraits` are optional.
172
+
<Calloutintent="note">
173
+
All properties in `UserTraits` are optional.
174
+
</Callout>
175
+
173
176
| Property | Type | Description |
174
177
|----------|------|-------------|
175
178
|`displayName`|`String?`| The displayed name of the user |
@@ -182,8 +185,10 @@ The `UserTraits` class contains detailed information about the user:
182
185
183
186
The `OrganizationTraits` class contains detailed information about the organization:
184
187
185
-
> [!NOTE]
186
-
> All properties in `OrganizationTraits` are optional.
188
+
<Calloutintent="note">
189
+
All properties in `OrganizationTraits` are optional.
190
+
</Callout>
191
+
187
192
| Property | Type | Description |
188
193
|----------|------|-------------|
189
194
|`displayName`|`String?`| The displayed name of the organization |
@@ -197,8 +202,10 @@ The `OrganizationTraits` class contains detailed information about the organizat
197
202
198
203
The `AccountTraits` class contains detailed information about the account:
199
204
200
-
> [!NOTE]
201
-
> All properties in `AccountTraits` are optional.
205
+
<Calloutintent="note">
206
+
All properties in `AccountTraits` are optional.
207
+
</Callout>
208
+
202
209
| Property | Type | Description |
203
210
|----------|------|-------------|
204
211
|`displayName`|`String?`| The displayed name of the account |
@@ -213,10 +220,6 @@ The `AccountTraits` class contains detailed information about the account:
213
220
214
221
Once user identification is complete, you can start using the chat (conversations) dialog supported by our DevRev SDK. The support chat feature can be shown as a modal screen from the top-most screen.
215
222
216
-
<Calloutintent="note">
217
-
This feature requires the SDK to be configured and the user to be identified, whether they are unverified or anonymous.
218
-
</Callout>
219
-
220
223
```dart
221
224
DevRev.showSupport();
222
225
```
@@ -241,10 +244,6 @@ Setting this flag to true applies the system's default behavior for opening link
241
244
242
245
## Analytics
243
246
244
-
<Calloutintent="note">
245
-
This feature requires the SDK to be configured and the user to be identified, whether they are unverified or anonymous.
246
-
</Callout>
247
-
248
247
The DevRev SDK allows you to send custom analytic events by using a properties map. You can track these events using the following function:
249
248
250
249
```dart
@@ -301,7 +300,7 @@ You can add custom properties to the session recording to help you understand th
301
300
DevRev.addSessionProperties(properties);
302
301
```
303
302
304
-
To clear the session properties in scenarios such as user logout or when the session ends, use the following method:
303
+
To clear the session properties in scenarios such as user logout or when the session ends, use the following method:
0 commit comments