Skip to content
This repository has been archived by the owner on Nov 21, 2024. It is now read-only.

# PLEASE NOTE THIS REPOSITORY IS NO LONGER BEING MAINTAINED # THE NEXT GENERATION CLIENT LIBRARY IS AVAILABLE HERE: https://github.com/mimikgit/cocoapod-mimOE-SE-iOS-developer

License

Notifications You must be signed in to change notification settings

mimikgit/cocoapod-EdgeEngineDeveloper

Repository files navigation

PLEASE NOTE THIS REPOSITORY IS NO LONGER BEING MAINTAINED

THE NEXT GENERATION CLIENT LIBRARY IS AVAILABLE HERE: https://github.com/mimikgit/cocoapod-mimOE-SE-iOS-developer

EdgeEngineDeveloper

mimik Client Library for iOS provides a programmatic way to work with the edgeEngine Runtime to access information about the mobile device on which the application is running.

Overview

The purpose of the mimik Client Library for iOS is to provide a programmatic way to work with the edgeEngine Runtime to access information about the mobile device on which the application is running, as well as mobile devices running within a cluster of mobile devices that are hosting the edgeEngine Runtime. Also, to allow developers to use edge microservices running within a particular cluster.

The mimik Client Library for iOS suite consists of these individual cocoapod components:

- EdgeCore
- EdgeEngineDeveloper (for developer projects) 
- EdgeEngine (for enterprise projects) 

By leveraging the EdgeCore cocoapod, developers can build applications compatible with the edgeEngine Runtime.

Additionally, this component provides utility APIs that help developers with core operations such as Authentication, edgeEngine Runtime Setup, deployment of edge microservices and handling of network calls.

Furthermore, the EdgeEngineDeveloper (or EdgeEngine for enterprise projects) cocoapod provides edgeEngine Runtime lifecycle control API, as well as vendoring the actual edgeEngine Runtime binary into the iOS project.

Expanding the client library ecosystem is the EdgeService cocoapod, providing API for integrating mimik edge and backend microservices.

Supported Platforms, Targets

  • iOS Devices running iOS 15+
  • iOS Simulators running iOS 15+
  • iOS Mac Catalyst running macOS 12.0

Requirements

iOS 15.0+

Installation

To install EdgeCore and EdgeEngineDeveloper (or EdgeEngine for enterprise solutions) cocoapods simply add the following lines to your Podfile:

NOTE: Developers wanting to use their developer edge license from mimik developer console should specify EdgeEngineDeveloper cocoapod in their Podfile.

NOTE: Enterprise project developers should specify EdgeEngine cocoapod in their Podfile and use the full edge license they received from mimik support.

platform :ios, '15.0'
source 'https://github.com/CocoaPods/Specs.git'
source 'https://github.com/mimikgit/cocoapod-edge-specs.git'

use_frameworks!
inhibit_all_warnings!

def mimik
  pod 'EdgeCore'
  pod 'EdgeEngineDeveloper'
  ### or pod 'EdgeEngine' (for enterprise projects, see the two notes above)
end

target '{target}' do
  mimik()
end

post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      config.build_settings['ENABLE_BITCODE'] = 'NO'
      config.build_settings['VALID_ARCHS'] = '$(ARCHS_STANDARD_64_BIT)'
      config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '15.0'
      config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
    end
  end
end

Tutorials

After installation, try the following tutorials:

Documentation

EdgeCore/EdgeClient API reference documentation can be found online. Alternatively a docc archive file can be downloaded as a zip file and opened locally in Xcode.

EdgeEngineClient platform protocol API reference documentation can also be found online.

EdgeService API reference documentation is also online.

mimik client libraries

Explore all mimik client libraries available on Github.

Cocoapod sets:

Cocoapod individual pods:

Author

mimik Technology, Inc.

More details about how the edgeEngine platform revolutionizes computing with the hybrid-cloud approach are at mimik Developer Documentation.

License

Developers can get their developer edge license by following this tutorial.

For details about a full edge license please contact mimik support.