Spec: iOS SDK
- Dominant language
- HTML
- Stars
- 5
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
@pranavrajs commented on [Thu Sep 02 2021](https://github.com/chatwoot/product/issues/201)
**Todo:**
- [ ] List of APIs and their documents to be shared with Shamsu. (@sojan-official)
- [ ] Design mocks/wireframes for him to work. (@pranavrajs)
- [ ] Account on staging to test and work on the APIs
- [ ] Create a list of tasks/milestones for the task
- [ ] Spec out the functions and input for SDK.
---
@pranavrajs commented on [Fri Sep 03 2021](https://github.com/chatwoot/product/issues/201#issuecomment-911982755)
- Native SDK for iOS should support all the features supported by the web-widget. The expected features for the SDK are as follows:
- **Initialization:** Allow users to initialize the SDK with a Host, an inbox identifier, language.
- **Conversations:** Allow the users to support more that one conversation in the widget and respond to them simultaneously.
- Once a conversation is resolved, based on the configuration, the conversation may or may not be reopened.
- Notify the user on new messages if the app is closed/minimized.
- Provide a notification badge option to display how many unread messages are available.
- **Message Types:** (Upload and render)
- **V1**:
- Text - Should support markdown
- Image
- Audio
- File
- If none of these, use a fallback that the message type is not supported.
- **V2:**
- Options message
- Form message
- Input box
- Card message
- Article Message
- CSAT Message
- **Contact**:
- There are 3 types of contacts: Anonymous, Users set by SDK, Users authenticated by identity validation.
- `setUser` method which accepts the user attributes along with the identifier.
- Allow adding tags to the contact. `setContactLabel` method should be exposed.
- Allow adding custom attributes to the contact using `setCustomAttributes` method.
- Display "Powered by Chatwoot" at the bottom.
- Support i18n as we have it in web widget.
- **Open questions:**
- Do we need to support business hours?
- Do we need to support pre-chat form?
- Do we need to support email collect box?
---
@pranavrajs commented on [Fri Sep 03 2021](https://github.com/chatwoot/product/issues/201#issuecomment-911995839)
|list|conversation|
|--|--|
|
|
|
Contributor guide
No contributing guide indexed for this repository
Research direction
No files or tests are named. Start by reviewing the proposed API list, wireframes, feature requirements, and open questions, then define the SDK functions, inputs, milestones, and unresolved product decisions. Done means an agreed iOS SDK specification covering the listed widget features and contact behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ios
- Domain
- mobile
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100