MediQuoSDK

Welcome to MediQuoSDK for Apple Platforms, the easiest way to integrate the MediQuo functionality into your app!

This repository contains a sample app that you can inspect to see how to integrate the MediQuo SDK into your own Application.

Note: If you are coming from one of the versions of the SDK previous to the v10.0 release, then this is a breaking change and you should delete all the integration you had before continuing.

• Xcode 16 or later
• iOS 15 Deployment Target

We support installation via Swift Package Manager and as a standalone XCFramework.

• Go to your Xcode Project and add the package https://github.com/mediquo/mediquo-ios-sdk.git and add the Package to your app.

• From the Releases tab of the Repo, choose the latest release, expand Assets and download the ZIP file

• Drag and Drop it in Xcode, link the framework to your target and make sure that the XCFramework is "Embedded and Signed" into your App target.

In order to integrate the SDK, we support both UIKit-based apps (the ones with AppDelegate and SceneDelegate) and SwiftUI-based apps (the ones with @main and WindowGroup).

We recommend initializing the SDK right after an entitled user logs in. Before doing this, make sure you have at hand these two values:

• API_KEY: provided by mediQuo
• USER_ID: created with Patients API

You initialize it simply:

Task {
  self.mediquo = try await MediQuo(apiKey: API_KEY, userID: USER_ID)
}

After the MediQuo object is created, we call getSDKViewController(for:) in order to create a UIViewController and add it do the hierarchy as you see fit (in this example, we're presenting this View Controller modally). Equivalent APIs are available for SwiftUI-based apps.

let vc = self.mediquo.getSDKViewController(for: .professionalList)
self.present(vc, animated: true)

All the possibles views are defined in MediQuo.ViewKind and you can use Xcode's autocomplete to find the appropiate view for any use case.

Note: For most applications, we recommend instantiating a single MediQuo object at the start of an entitled user’s session. Store this instance in AppDelegate or within your dependency management system to ensure consistent access throughout the app.

However, if the user logs out, make sure to call this method to deauthenticate and clean up the instance properly:

try? await mediquo.deauthenticateSDK()

This prevents unauthorized access and ensures a fresh state when a new user logs in.

The MediQuo SDK supports Firebase-based pushes as well as regular APNS based ones.

try? await mediquo.setPushNotificationToken(type: .appleAPNS(data))

try? await mediquo.setPushNotificationToken(type: .firebase(token))

In order to allow the user an opportunity to keep interacting with your app when receiving a push, we offer an affordance API to parse the incoming push payload into a MediQuo view. However, it is your responsibility as the app's owner to call this API and present this view as you see fit.

For example:

public func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {
  let userInfo = notification.request.content.userInfo as? [String: any Sendable]
  /// Handle pushes from other sources different from Mediquo
  /// and only call the MediQuo SDK if you haven't handled this push yourself
  
  /// Generate a ViewController from the remote push payload
  let vc = self.mediquo.getSDKViewController(forRemotePush: userInfo)
  
  // Present the ViewController returned by the MediQuoSDK however you want.
  self.rootViewController.present(vc, animated: true)
  completionHandler()
}

You can find an example of notification payloads here.

• To test with the simulator, Drag and drop the APNS file, and remember to replace $BUNDLE_ID with your app's Bundle ID.

In order to listen to events, make sure you conform with the MediQuoEventDelegate protocol and set an instance of that object as the delegate using:

self.mediquo.eventDelegate = self

You can listen to events like socket connection changes or incoming calls. Please refer to the Sample App code in order to see how to integrate this functionality.

Note: As of version 10.7.1 of the SDK, if an incoming call is received and eventDelegate is nil, MediQuo will attempt to present a full screen UIViewController to handle that call.

The SDK allows the users to send voice notes, images and files, so in order to allow this functionality, you must add the following entries to your Info.plist with an appropiate description:

• NSMicrophoneUsageDescription
• NSCameraUsageDescription

The SDK will use your app's Accent Color to customize it's look and feel. If you need any more customization points, feel free to open an Issue in this Repository to request any feature.

During the SPM integration, in case you find an issue such as "invalid archive returned from 'https://github.com/mediquo/mediquo-ios-sdk/releases/download/X.X.X/MediQuoSDK.xcframework.zip' which is required by binary target 'XXX'", close Xcode and run the following commands in your Terminal.

rm -rf $HOME/Library/Caches/org.swift.swiftpm/
rm -rf $HOME/Library/org.swift.swiftpm