-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Mobile-sdk.mdx #108
Mobile-sdk.mdx #108
Conversation
ISS-124016
Published docs preview URL: https://devrev-preview-4efa3878-8a12-431f-ab2f-e397a0bc7a1a.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-7b380d2c-c1d8-471d-9a4b-5e3ac38e9826.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-36402793-5a5c-4629-a964-1fdf93d5c1d1.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-34dc815e-94c1-4106-ac87-2f37a16ac10c.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-e5246786-947f-48a3-a793-f63d95d4b04e.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-125c5335-e2cc-4e51-ab85-91e21eaa37d8.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-10e0e011-e2f4-412e-8f3a-7a37f2bda127.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-1d8d2204-d4ac-414b-93d2-45de30b60410.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-6a503e16-edb8-4e43-97da-baa0169c1e41.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-7ff7fb76-55fd-4350-a5f2-62b133ecfd56.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-8817e305-8e2d-4159-9a22-60cbebc1f5ab.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-d78abb71-6b53-4653-ac56-869a29d21234.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-5c4f8f45-7d74-41bd-8f54-8d5c0ab41a00.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-09b4a537-8028-4348-90ab-8c5ac9598370.docs.buildwithfern.com |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few minor things.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The copies are ready.
Published docs preview URL: https://devrev-preview-5c4f7d84-fd60-4bf8-ac81-b55d6e8fa639.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-2a0d3b2b-cbcf-4e60-ac9c-52090f7deba6.docs.buildwithfern.com |
Co-authored-by: Bojan Dimovski <[email protected]>
Published docs preview URL: https://devrev-preview-294186bc-2559-47e1-b769-e33e2623aa33.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-a14e406c-4898-4638-b044-74ffe1697904.docs.buildwithfern.com |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good to go!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
EkLine
📝 [EkLine] reported by reviewdog 🐶
Avoid using 'we' as it can come off as patronizing. For example, write 'The configuration is complete' rather than 'We are now done with the configuration.' (EK81039)
We recommend integrating the DevRev SDK using SPM. |
🚫 [EkLine] reported by reviewdog 🐶
'Swift Package Manager' should use sentence-style capitalization. (EK00037)
### Swift Package Manager |
Consider using 'go' instead of 'navigate'. (EK25033)
1. Open your project in Xcode and navigate to the **Add Package Dependency**. |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- For SSH: `[email protected]:devrev/devrev-sdk-ios.git` |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
1. Add the following to your Podfile: |
📝 [EkLine] reported by reviewdog 🐶
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
This will install the DevRev SDK in your project, making it ready for use. |
📝 [EkLine] reported by reviewdog 🐶
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
The SDK will be ready for use once you execute the following configuration method. |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- UIKit apps |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- SwiftUI apps |
📝 [EkLine] reported by reviewdog 🐶
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
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. |
Consider using 'go' instead of 'navigate'. (EK25033)
The DevRev SDK offers automatic screen tracking to help you understand how users navigate through your app. Although view controllers are automatically tracked, you can manually track screens using the following method: |
📝 [EkLine] reported by reviewdog 🐶
Consider removing 'properly '. (EK00006)
To properly handle push notifications, implement the following method, typically in either the `UNUserNotificationCenterDelegate.userNotificationCenter(_:didReceive:)` or `UIApplicationDelegate.application(_:didReceiveRemoteNotification:fetchCompletionHandler:)`: |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
1. Add your credentials: |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
3. Configure code signing for the sample target: |
📝 [EkLine] reported by reviewdog 🐶
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
- **Issue**: Support chat won't show. |
If you are configuring an iOS app, proceed to step 2. For an Android app, skip to step 3. | ||
</Callout> | ||
|
||
2. iOS app configuration |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
2. iOS app configuration | |
2. iOS app configuration. |
|
||
b. Click **Save App** to complete the iOS setup. | ||
|
||
3. Android app configuration |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
3. Android app configuration | |
3. Android app configuration. |
</Tabs> | ||
|
||
4. In the `onCreate` method of your `Application`, configure the DevRev SDK with the required parameters using the credentials obtained earlier. | ||
5. Ensure that the custom application is specified in the `AndroidManifest.xml`, as shown below: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
5. Ensure that the custom application is specified in the `AndroidManifest.xml`, as shown below: | |
5. Ensure that the custom application is specified in the `AndroidManifest.xml`, as shown below. |
</Tab> | ||
<Tab title="Java"> | ||
```java | ||
DevRev.INSTANCE.identifyAnonymousUser( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
</Tab> | ||
<Tab title="Java"> | ||
```java | ||
DevRev.INSTANCE.identifyUnverifiedUser( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
||
4. To extract a specific piece of data from the payload, use the key to access the value in the data map. | ||
|
||
5. To retrieve the "message" from the payload: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
5. To retrieve the "message" from the payload: | |
5. To retrieve the "message" from the payload: |
<Tab title="Kotlin"> | ||
```kotlin | ||
class MyFirebaseMessagingService: FirebaseMessagingService { | ||
// ... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
||
## Requirements | ||
|
||
- Xcode 16.0 or higher (latest stable version available on the App Store) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- Xcode 16.0 or higher (latest stable version available on the App Store) | |
- Xcode 16.0 or higher (latest stable version available on the App Store). |
## Requirements | ||
|
||
- Xcode 16.0 or higher (latest stable version available on the App Store) | ||
- Swift 5.9 or later |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- Swift 5.9 or later | |
- Swift 5.9 or later. |
|
||
- Xcode 16.0 or higher (latest stable version available on the App Store) | ||
- Swift 5.9 or later | ||
- Set the minimum deployment target for your iOS application as iOS 13 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- Set the minimum deployment target for your iOS application as iOS 13 | |
- Set the minimum deployment target for your iOS application as iOS 13. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really needs some polish but let's get it out with the few small changes I've indicated.
And the suggestions from EkLine where appropriate. |
I noticed that most of the EkLine suggestions in the code blocks are breaking changes. I wouldn't change the code blocks since they might become incompilable. |
Published docs preview URL: https://devrev-preview-2bb2d0b3-d289-4beb-b428-aa81eb5033b2.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-fcb200c8-7904-48df-8233-20fffb963471.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-c581036a-d4a8-4e46-8d45-0ab16358a420.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-baf1bca8-6929-467e-a982-9a5d3586de2a.docs.buildwithfern.com |
ISS-124016