Skip to content

Latest commit

 

History

History
67 lines (56 loc) · 2.79 KB

README.md

File metadata and controls

67 lines (56 loc) · 2.79 KB
Raw

Getting Started

This repository contains the RealifeTech Core SDK which can be installed into your Swift project using the CocoaPods dependency manager. Here you’ll find a guide on getting started, and examples of how to use the SDK’s features.

1. Ensure the following requirements are met

  • Xcode 11.3+
  • Deployment Target of iOS 13.0+
  • CocoaPods 1.8.4+
  • Swift 5 Note that our SDK currently depends on RxSwift packages which are automatically managed with CocoaPods. This package should be compatible with any peer requirements on RxSwft and RxCocoa versions greater than 4.2.

2. Install the RealifeTech-CoreSDK Pod dependency

Add the following line to your .podfile under your Apps target:

pod 'RealifeTech-CoreSDK', '~> 1.0.8'

Open your terminal, navigate to the directory containing your podfile, and run:

$ pod install

3. Create core services

Configuration

To use the core services of the SDK, you need to initialise the CoreSDKConfiguration first. Use the following function to configure the SDK. You will be provided the values necessary as part of your onboarding. Note that the SDK provides default values for its API endpoints, unless you are provided with unique endpoints as part of onboarding leave these fields blank.

let configuration = CoreSDKConfiguration(
    appCode: “APPLICATION_CODE”,
    clientSecret: “API_SECRET”,
    apiUrl: “http://API_URL”, // OPTIONAL
    graphApiUrl: “http://GRAPH_API_URL” // OPTIONAL
)

Setup core services

RealifeTech-CoreSDK provides factory methods in CoreFactory to allow you to initialise the services.

  1. UIDeviceInterface: A helper to get the UUID, model and system version of the current device.
static func makeDeviceHelper() -> UIDeviceInterface
  1. ReachabilityChecking: A helper to detect network connection and Bluetooth state.
static func makeReachablitiyChecker() -> ReachabilityChecking
  1. V3APITokenManagable: A helper to setups RealifeTech API with setting the deviceId and configuration to the requesters.
static func makeApiHelper(deviceId: String, configuration: CoreSDKConfiguration) -> V3APITokenManagable
  1. GraphQLDispatching: A dispatcher to request RealifeTech GraphQL API
static func makeGraphQLDispatcher(
        configuration: CoreSDKConfiguration,
        tokenHelper: V3APITokenManagable,
        deviceId: String,
        reachabilityHelper: ReachabilityChecking
    ) -> GraphQLDispatching
  1. Get the valid token for using RealifeTech APIs.
static func requestValidToken(fromApiHelper apiHelper: V3APITokenManagable)

To ensure the SDK is configured before any other functionality is used, we recommend adding the code to your AppDelegate’s applicationDidFinishLaunching(_:).