Telehealth application (#2)

* added telehealth application to Examples
* changed project name
* readme user list added

README.md

@@ -20,6 +20,8 @@ Choose a sample application that demonstrates the use of chat components.
 | Name | Features | Chat type | Use case |
 |-----|---------|---------|---------|
 | [`getting-started`](getting-started/) | <br><ul><li>Message list and message input integration</li><li>Light & dark themes</li></ul></br> | 1:1 | <img src="/assets/getting-started-ios-app.png" alt="Getting Started app for iOS" style="width:300px"/> |
+| [`telehealth`](telehealth-example/) | <br><ul><li>Doctor to patient chat</li><li>Light & dark themes</li></ul></br> | 1:1 | <img src="/assets/telehealth-ios-app.png" alt="Telehealth sample application" style="width:300px"/> |
+
 
 ## Useful links
 

getting-started/getting-started.xcodeproj/project.pbxproj

@@ -375,9 +375,8 @@
 			isa = XCRemoteSwiftPackageReference;
 			repositoryURL = "https://github.com/pubnub/chat-components-ios";
 			requirement = {
-				kind = versionRange;
-				maximumVersion = 1.0.0;
-				minimumVersion = 0.0.0;
+				branch = master;
+				kind = branch;
 			};
 		};
 /* End XCRemoteSwiftPackageReference section */

telehealth-example/.gitignore

@@ -0,0 +1,75 @@
+## macOS
+.DS_Store
+
+## Build generated
+build/
+DerivedData/
+
+## Config files containing secret keys
+*.debug.xcconfig
+*.release.xcconfig
+
+## Various settings
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+xcuserdata/
+
+## Other
+*.moved-aside
+*.xccheckout
+*.xcscmblueprint
+keysset.plist
+
+## Obj-C/Swift specific
+*.hmap
+*.ipa
+*.dSYM.zip
+*.dSYM
+
+## Playgrounds
+timeline.xctimeline
+playground.xcworkspace
+
+# Swift Package Manager
+#
+# Add this line if you want to avoid checking in source code from Swift Package Manager dependencies.
+# Packages/
+# Package.pins
+# Package.resolved
+.build
+.swiftpm
+Package.resolved
+
+# CocoaPods
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+
+Pods/
+
+# Add this line if you want to avoid checking in source code from the Xcode workspace
+# *.xcworkspace
+
+# Carthage
+#
+# Add this line if you want to avoid checking in source code from Carthage dependencies.
+# Carthage/Checkouts
+
+Carthage
+
+# fastlane
+#
+# It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the
+# screenshots whenever they are needed.
+# For more information about the recommended setup visit:
+# https://docs.fastlane.tools/best-practices/source-control/#source-control
+
+fastlane/report.xml
+fastlane/test_output

telehealth-example/README.md

@@ -0,0 +1,38 @@
+# Telehealth Application
+
+`telehealth-example` is a basic chat application that features communication between doctor and patient.
+
+<img src="../assets/telehealth-ios-app.png" alt="Getting Started app for iOS" style="width:300px"/> 
+
+## Prerequisites
+
+This application uses [PubNub Swift SDK](https://github.com/pubnub/swift) for chat components and [UIKit](https://developer.apple.com/documentation/uikit) as the UI Toolkit.
+
+To use the app, you need:
+
+* [Xcode](https://developer.apple.com/xcode/) (>= Xcode 13)
+* PubNub account on [Admin Portal](https://dashboard.pubnub.com/).
+
+## Usage
+
+Read the [Getting Started](https://www.pubnub.com/docs/chat/components/ios/get-started-ios) guide to learn how to use the app and better understand the logic behind it.
+
+## Features
+
+The `telehealth-example` app showcases these PubNub Chat Components for iOS:
+
+* [MessageInput](https://www.pubnub.com/docs/chat/components/ios/ui-components-ios#messageinput)
+* [MessageList](https://www.pubnub.com/docs/chat/components/ios/ui-components-ios#messagelist)
+
+## Usernames
+
+### Patients
+
+* lukeyoung
+* saraflores
+
+### Doctors
+
+* suejones
+
+## Pasword is not needed

telehealth-example/Resources/Fonts/Poppins/OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2020 The Poppins Project Authors (https://github.com/itfoundry/Poppins)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

telehealth-example/Resources/JSON/channels.json

@@ -0,0 +1,22 @@
+[
+  {
+    "name": "Dr Sue Jones",
+    "profileUrl": "https://randomuser.me/api/portraits/men/1.jpg",
+    "description": "General Practitioner",
+    "eTag": null,
+    "id": "telehealth-0948aa84-0222c484",
+    "updated": null,
+    "type": "Virtual Examination Room",
+    "status": null
+  },
+  {
+    "name": "Dr Sue Jones",
+    "profileUrl": "https://randomuser.me/api/portraits/men/2.jpg",
+    "description": "General Practitioner",
+    "eTag": null,
+    "id": "telehealth-0948aa84-601f9324",
+    "updated": null,
+    "type": "Virtual Examination Room",
+    "status": null
+  }
+]

telehealth-example/Resources/JSON/memberships.json

@@ -0,0 +1,18 @@
+[
+  {
+    "channel": "telehealth-0948aa84-0222c484",
+    "members": [
+      "0948aa84",
+      "0222c484"
+    ],
+    "custom": {}
+  },
+  {
+    "channel": "telehealth-0948aa84-601f9324",
+    "members": [
+      "0948aa84",
+      "601f9324"
+    ],
+    "custom": {}
+  }
+]

telehealth-example/Resources/JSON/users.json

@@ -0,0 +1,50 @@
+[
+  {
+    "name": "Luke Young",
+    "custom": {
+      "title": "Product Engineer",
+      "username":"lukeyoung",
+      "painLevel":"3/10",
+      "queuePosition":"1"
+    },
+    "type": "patient",
+    "email": null,
+    "eTag": null,
+    "externalId": "lukeyoung",
+    "id": "601f9324",
+    "profileUrl": "https://randomuser.me/api/portraits/men/3.jpg",
+    "updated": null
+  },
+  {
+    "name": "Dr Sue Jones",
+    "custom": {
+      "title": "General Practitioner",
+      "username": "suejones",
+      "painLevel":"3/10",
+      "queuePosition":"0"
+    },
+    "type": "doctor",
+    "email": null,
+    "eTag": null,
+    "externalId": "suejones",
+    "id": "0948aa84",
+    "profileUrl": "https://randomuser.me/api/portraits/women/3.jpg",
+    "updated": null
+  },
+  {
+    "name": "Sara Flores",
+    "custom": {
+      "title": "VP, Sales",
+      "username":"saraflores",
+      "painLevel":"9/10",
+      "queuePosition":"2"
+    },
+    "type": "patient",
+    "email": null,
+    "eTag": null,
+    "externalId": "saraflores",
+    "id": "0222c484",
+    "profileUrl": "https://randomuser.me/api/portraits/men/2.jpg",
+    "updated": null
+  }
+]

telehealth-example/Telehealth/AppDelegate.swift

@@ -0,0 +1,57 @@
+//
+//  AppDelegate.swift
+//
+//  PubNub Real-time Cloud-Hosted Push API and Push Notification Client Frameworks
+//  Copyright © 2021 PubNub Inc.
+//  https://www.pubnub.com/
+//  https://www.pubnub.com/terms
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in
+//  all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+//  THE SOFTWARE.
+//
+
+import UIKit
+import PubNub
+
+@main
+class AppDelegate: UIResponder, UIApplicationDelegate {
+
+  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
+    // Override point for customization after application launch.
+
+    PubNub.log.levels = [.all]
+    PubNub.log.writers = [ConsoleLogWriter()]
+
+    return true
+  }
+
+  // MARK: UISceneSession Lifecycle
+
+  func application(_ application: UIApplication, configurationForConnecting connectingSceneSession: UISceneSession, options: UIScene.ConnectionOptions) -> UISceneConfiguration {
+    // Called when a new scene session is being created.
+    // Use this method to select a configuration to create the new scene with.
+    return UISceneConfiguration(name: "Default Configuration", sessionRole: connectingSceneSession.role)
+  }
+
+  func application(_ application: UIApplication, didDiscardSceneSessions sceneSessions: Set<UISceneSession>) {
+    // Called when the user discards a scene session.
+    // If any sessions were discarded while the application was not running, this will be called
+    // shortly after application:didFinishLaunchingWithOptions.
+    // Use this method to release any resources that were specific to the discarded scenes, as they will not return.
+  }
+}