Skip to content

Commit 4fddc73

Browse files
committed
Follow the language recommendation by EKLine in the mobile SDKs
1 parent 3e5d9b0 commit 4fddc73

File tree

13 files changed

+53
-54
lines changed

13 files changed

+53
-54
lines changed

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ The steps to identify a verified user are as follows:
8383
3. Pass the user identifier and the exchanged session token to the `DevRev.identifyVerifiedUser(_:sessionToken:)` method.
8484

8585
<Callout intent="warning">
86-
For security reasons we **strongly recommend** that the token exchange is executed on your backend to prevent exposing your application access token (AAT).
86+
For security reasons, it is **strongly recommended** that the token exchange is executed on your backend to prevent exposing your application access token (AAT).
8787
</Callout>
8888

8989
#### Generate an AAT
@@ -98,7 +98,7 @@ Ensure that you copy the generated application access token, as you cannot view
9898

9999
#### Exchange your AAT for a session token
100100

101-
In order to proceed with identifying the user, you need to exchange your AAT for a session token. This step will help you identify a user of your own system within the DevRev platform.
101+
To proceed with identifying the user, you need to exchange your AAT for a session token. This step helps you identify a user of your own system within the DevRev platform.
102102

103103
Here is a simple example of an API request to the DevRev backend to exchange your AAT for a session token:
104104

@@ -119,7 +119,7 @@ curl \
119119
}'
120120
```
121121

122-
The response of the API call will contain a session token that you can use with the verified identification method in your app.
122+
The response of the API call contains a session token that you can use with the verified identification method in your app.
123123

124124
<Callout intent="warning">
125125
As a good practice, **your** app should retrieve the exchanged session token from **your** backend at app launch or any relevant app lifecycle event.
@@ -186,7 +186,7 @@ You can perform a logout of the current user by calling the following method:
186186
</Tab>
187187
</Tabs>
188188

189-
The user will be logged out by clearing their credentials, as well as unregistering the device from receiving push notifications, and stopping the session recording.
189+
The user is logged out by clearing their credentials, as well as unregistering the device from receiving push notifications, and stopping the session recording.
190190

191191
### Identity model
192192

@@ -209,7 +209,7 @@ The `Identity` class contains the following properties:
209209
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.
210210
</Callout>
211211

212-
##### UserTraits
212+
##### User traits
213213

214214
The `UserTraits` class contains detailed information about the user:
215215

@@ -226,7 +226,7 @@ All properties in `UserTraits` are optional.
226226
| `phoneNumbers` | `[String]?` | Array of the user's phone numbers |
227227
| `customFields` | `[String: Any]?` | Dictionary of custom fields configured in DevRev |
228228

229-
##### OrganizationTraits
229+
##### Organization traits
230230

231231
The `OrganizationTraits` class contains detailed information about the organization:
232232

@@ -243,7 +243,7 @@ All properties in `OrganizationTraits` are optional.
243243
| `tier` | `String?` | The organization's tier or plan level |
244244
| `customFields` | `[String: Any]?` | Dictionary of custom fields configured in DevRev |
245245

246-
##### AccountTraits
246+
##### Account traits
247247

248248
The `AccountTraits` class contains detailed information about the account:
249249

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This guide helps transition from the legacy UserExperior SDK to the new DevRev SDK.
44

5-
## Feature Equivalence Chart
5+
## Feature equivalence chart
66

77
| Feature | UserExperior SDK | DevRev SDK (Kotlin) | DevRev SDK (Java) |
88
|-|-|-|-|

fern/docs/pages/sdks/mobile/android/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Use this property to check whether the DevRev SDK has been configured:
102102
</Tabs>
103103

104104
<Callout intent="tip">
105-
`prefersDialogMode`, if set to true, enables the SDK to open the screens in the app's main task/activity.
105+
The property `prefersDialogMode`, when set to `true`, enables the SDK to open the screens in the app's main task/activity.
106106
</Callout>
107107

108108
4. To configure the SDK, you need to call the following method inside your `Application` class:

fern/docs/pages/sdks/mobile/android/troubleshooting.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
- **Issue**: How does the DevRev SDK handle errors?
77
**Solution**: The DevRev SDK reports all errors using Android's logging utility. Look for error messages in Android Studio's Logcat after applying `DEVREV SDK` filter.
88

9-
- **Issue**: Support chat doesn't show.
9+
- **Issue**: Support chat won't show.
1010
**Solution**: Ensure you have correctly called one of the identification methods: `DevRev.identifyUnverifiedUser(...)`, `DevRev.identifyVerifiedUser(...)`, or `DevRev.identifyAnonymousUser(...)`.
1111

1212
- **Issue**: Not receiving push notifications.
@@ -17,11 +17,10 @@
1717
- **Issue**: Missing class `com.google.android.play.core.splitcompat.SplitCompatApplication`.
1818
**Solution**: Add the following line to your `proguard-rules.pro` file: `-dontwarn com.google.android.play.core.**`.
1919

20-
- **Issue**: Missing class issue due to transitive Flutter dependencies.
20+
- **Issue**: Missing class issue due to transitive Flutter dependencies.
2121
**Solution**: Add the following lines to your `proguard-rules.pro` file:
2222
```bash
2323
-keep class io.flutter.** { *; }
2424
-keep class io.flutter.plugins.** { *; }
2525
-keep class GeneratedPluginRegistrant { *; }
2626
```
27-

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The steps to identify a verified user are as follows:
4242
3. Pass the user identifier and the exchanged session token to the `DevRev.identifyVerifiedUser(_:sessionToken:)` method.
4343

4444
<Callout intent="warning">
45-
For security reasons we **strongly recommend** that the token exchange is executed on your backend to prevent exposing your application access token (AAT).
45+
For security reasons, it is **strongly recommended** that the token exchange is executed on your backend to prevent exposing your application access token (AAT).
4646
</Callout>
4747

4848
#### Generate an AAT
@@ -57,7 +57,7 @@ Ensure that you copy the generated application access token, as you cannot view
5757

5858
#### Exchange your AAT for a session token
5959

60-
In order to proceed with identifying the user, you need to exchange your AAT for a session token. This step will help you identify a user of your own system within the DevRev platform.
60+
To proceed with identifying the user, you need to exchange your AAT for a session token. This step helps you identify a user of your own system within the DevRev platform.
6161

6262
Here is a simple example of an API request to the DevRev backend to exchange your AAT for a session token:
6363

@@ -78,7 +78,7 @@ curl \
7878
}'
7979
```
8080

81-
The response of the API call will contain a session token that you can use with the verified identification method in your app.
81+
The response of the API call contains a session token that you can use with the verified identification method in your app.
8282

8383
<Callout intent="warning">
8484
As a good practice, **your** app should retrieve the exchanged session token from **your** backend at app launch or any relevant app lifecycle event.
@@ -149,7 +149,7 @@ All properties in `UserTraits` are optional.
149149
| `description` | `string OR null` | A description of the user |
150150
| `customFields` | `{ [key: string]: any }` | Dictionary of custom fields configured in DevRev |
151151

152-
##### OrganizationTraits
152+
##### Organization traits
153153

154154
The `OrganizationTraits` class contains detailed information about the organization:
155155

@@ -166,7 +166,7 @@ All properties in `OrganizationTraits` are optional.
166166
| `tier` | `string OR null` | The organization's tier or plan level |
167167
| `customFields` | `{ [key: string]: any }` | Dictionary of custom fields configured in DevRev |
168168

169-
##### AccountTraits
169+
##### Account traits
170170

171171
The `AccountTraits` class contains detailed information about the account:
172172

@@ -184,7 +184,7 @@ All properties in `AccountTraits` are optional.
184184
| `tier` | `string OR null` | The account's tier or plan level |
185185
| `customFields` | `{ [key: string]: any }` | Dictionary of custom fields configured in DevRev |
186186

187-
The user will be logged out by clearing their credentials, as well as unregistering the device from receiving push notifications, and stopping the session recording.
187+
The user is logged out by clearing their credentials, as well as unregistering the device from receiving push notifications, and stopping the session recording.
188188

189189
## PLuG support chat
190190

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This guide and chart should help facilitate the transition from the legacy UserExperior SDK to the new DevRev SDK in your Cordova application, providing insights into feature equivalents and method changes.
44

5-
## Feature Equivalence Chart
5+
## Feature equivalence chart
66

77
| Feature | UserExperior SDK | DevRev SDK |
88
|-|-|-|

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The steps to identify a verified user are as follows:
4343
3. Pass the user identifier and the exchanged session token to the `DevRev.identifyVerifiedUser(userID, sessionToken)` method.
4444

4545
<Callout intent="warning">
46-
For security reasons we **strongly recommend** that the token exchange is executed on your backend to prevent exposing your application access token (AAT).
46+
For security reasons, it is **strongly recommended** that the token exchange is executed on your backend to prevent exposing your application access token (AAT).
4747
</Callout>
4848

4949
#### Generate an AAT
@@ -58,7 +58,7 @@ Ensure that you copy the generated application access token, as you cannot view
5858

5959
#### Exchange your AAT for a session token
6060

61-
In order to proceed with identifying the user, you need to exchange your AAT for a session token. This step will help you identify a user of your own system within the DevRev platform.
61+
To proceed with identifying the user, you need to exchange your AAT for a session token. This step helps you identify a user of your own system within the DevRev platform.
6262

6363
Here is a simple example of an API request to the DevRev backend to exchange your AAT for a session token:
6464

@@ -79,7 +79,7 @@ curl \
7979
}'
8080
```
8181

82-
The response of the API call will contain a session token that you can use with the verified identification method in your app.
82+
The response of the API call contains a session token that you can use with the verified identification method in your app.
8383

8484
<Callout intent="warning">
8585
As a good practice, **your** app should retrieve the exchanged session token from **your** backend at app launch or any relevant app lifecycle event.
@@ -123,7 +123,7 @@ You can perform a logout of the current user by calling the following method:
123123
DevRev.logout(deviceID);
124124
```
125125

126-
The user will be logged out by clearing their credentials, as well as unregistering the device from receiving push notifications, and stopping the session recording.
126+
The user is logged out by clearing their credentials, as well as unregistering the device from receiving push notifications, and stopping the session recording.
127127

128128
For example:
129129

@@ -165,7 +165,7 @@ The `Identity` class contains the following properties:
165165
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.
166166
</Callout>
167167

168-
#### UserTraits
168+
#### User traits
169169

170170
The `UserTraits` class contains detailed information about the user:
171171

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This guide helps you transition from the legacy UserExperior SDK to the new DevRev SDK in your Flutter application. Below is a feature equivalence chart and detailed instructions for migrating.
44

5-
## Feature equivalence Chart
5+
## Feature equivalence chart
66

77
| Feature | UserExperior SDK | DevRev SDK |
88
|-|-|-|

fern/docs/pages/sdks/mobile/flutter/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ DevRev.configure(appID: "abcdefg12345")
5050

5151
A sample app with use cases for the DevRev SDK for Flutter has been provided as a part of our [public repository](https://github.com/devrev/devrev-sdk-flutter). To set up and run the sample app:
5252

53-
1. Navigate to the `sample` directory:
53+
1. Go to the `sample` directory:
5454
```sh
5555
cd sample
5656
flutter clean

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The steps to identify a verified user are as follows:
4444
3. Pass the user identifier and the exchanged session token to the `DevRev.identifyVerifiedUser(_:sessionToken:)` method.
4545

4646
<Callout intent="warning">
47-
For security reasons we **strongly recommend** that the token exchange is executed on your backend to prevent exposing your application access token (AAT).
47+
For security reasons, it is **strongly recommended** that the token exchange is executed on your backend to prevent exposing your application access token (AAT).
4848
</Callout>
4949

5050
#### Generate an AAT
@@ -59,7 +59,7 @@ Ensure that you copy the generated application access token, as you cannot view
5959

6060
#### Exchange your AAT for a session token
6161

62-
In order to proceed with identifying the user, you need to exchange your AAT for a session token. This step will help you identify a user of your own system within the DevRev platform.
62+
To proceed with identifying the user, you need to exchange your AAT for a session token. This step helps you identify a user of your own system within the DevRev platform.
6363

6464
Here is a simple example of an API request to the DevRev backend to exchange your AAT for a session token:
6565

@@ -80,7 +80,7 @@ curl \
8080
}'
8181
```
8282

83-
The response of the API call will contain a session token that you can use with the verified identification method in your app.
83+
The response of the API call contains a session token that you can use with the verified identification method in your app.
8484

8585
<Callout intent="warning">
8686
As a good practice, **your** app should retrieve the exchanged session token from **your** backend at app launch or any relevant app lifecycle event.
@@ -128,7 +128,7 @@ You can perform a logout of the current user by calling the following method:
128128
DevRev.logout(deviceID:)
129129
```
130130

131-
The user will be logged out by clearing their credentials, as well as unregistering the device from receiving push notifications, and stopping the session recording.
131+
The user is logged out by clearing their credentials, as well as unregistering the device from receiving push notifications, and stopping the session recording.
132132

133133
For example:
134134

@@ -170,7 +170,7 @@ The `Identity` class contains the following properties:
170170
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.
171171
</Callout>
172172

173-
##### UserTraits
173+
##### User traits
174174

175175
The `UserTraits` class contains detailed information about the user:
176176

@@ -187,7 +187,7 @@ All properties in `UserTraits` are optional.
187187
| `phoneNumbers` | `[String]?` | Array of the user's phone numbers |
188188
| `customFields` | `[String: Any]?` | Dictionary of custom fields configured in DevRev |
189189

190-
##### OrganizationTraits
190+
##### Organization traits
191191

192192
The `OrganizationTraits` class contains detailed information about the organization:
193193

@@ -204,7 +204,7 @@ All properties in `OrganizationTraits` are optional.
204204
| `tier` | `String?` | The organization's tier or plan level |
205205
| `customFields` | `[String: Any]?` | Dictionary of custom fields configured in DevRev |
206206

207-
##### AccountTraits
207+
##### Account traits
208208

209209
The `AccountTraits` class contains detailed information about the account:
210210

0 commit comments

Comments
 (0)