Gradle requires Java JDK or JRE version 7 or higher. To check the version of Java you are currently using, execute the following command:

java -version

It is recommended that you use Gradle version 2.4 or higher

To install Gradle, follow the installation instructions and setup instructions on the Gradle website.

Alternatively, to install Gradle using the SDK manager tool, follow the section with instructions on installing Gradle using SDKMAN on the Gradle website.

Download the sample app to get started with a new native Android application which has the RHMAP SDK already included.

Declare the following dependency in your build.gradle file:

compile 'com.feedhenry:fh-android-sdk:3.2.0'

If you are not using Gradle, you can manually download the SDK in a JAR along with its dependencies. For more details, see the Usage section in the README file of the SDK’s Github repository.

If you use Maven to manage dependencies for your project, declare the fh-android-sdk as a dependency by adding the following code to the pom.xml file:

<dependencies>
  <dependency>
			<groupId>com.feedhenry</groupId>
			<artifactId>fh-android-sdk</artifactId>
			<version>3.2.0</version>
		</dependency>
</dependencies>

The SDK requires the INTERNET permission. If not already added, add the permission to the AndroidManifest.xml file:

<uses-permission android:name="android.permission.INTERNET"/>

Define the properties which allow the app to communicate with RHMAP servers. Create a new file in the assets folder called fhconfig.properties. Add the following contents and replace the references, including the brackets, with the values from your project:

host = <RHMAP Core host>
projectid = <Project ID>
connectiontag = <Connection tag>
appid = <Client App ID>
appkey = <Client App API key>

An example of a configured fhconfig.properties file:

host = https://cldapps.testsite.com
projectid = 0BiqQ5g8kfnUw8d1fn9NnAeR
connectiontag = 0.0.2
appid = 0BiqQAqVu9quH6BIrlH_LT9c
appkey = bfb20ee69d29add08e974eff89b9a571bacb7959

Additional properties you might encounter when working with RHMAP:

PUSH_SERVER_URL - <The hostname of the MBaaS target you will be targeting>
PUSH_SENDER_ID - <Firebase Sender ID>
PUSH_VARIANT- <UPS VARIANT>
PUSH_SECRET - <UPS SECRET>

See Projects - Connections for more information on connections between Client Apps and Cloud Apps.

Before invoking any cloud requests from the RHMAP SDK, initialisation is required:

FH.init(this, new FHActCallback() {
  public void success(FHResponse pRes) {
    // Init okay, free to use FHActRequest
  }

  public void fail(FHResponse pRes) {
    // Init failed
    Log.e("FHInit", pRes.getErrorMessage(), pRes.getError());
  }
});

To migrate your app to Android N:

To install CocoaPods using the RubyGems package manager, execute the following command. This requires the sudo command to be enabled in OSX.

sudo gem install cocoapods

As an optional part of the CocoaPods setup, you can store your Podspec metadata locally at ~/.cocoapods/repos. This helps to increase the dependency resolution speed and shortens the build time for your apps. To clone the spec-repo and create the directory, execute the following command:

pod setup

Alternatively, to install CocoaPods without using sudo, follow the Sudo-less Installation section of the CocoaPods Getting Started Guide.

The RHMAP iOS Objective-C and Swift SDK packages rely on the cocoapods-packager and cocapods-appledoc plugins. To install both plugins, execute the following command:

[sudo] gem install cocoapods-packager cocoapods-appledoc

To enable Cocoapods Xcode app project after installation execute the following commands:

To install the dependencies defined in the podfile of Xcode project using CocoaPods, execute the following command:

pod install

When starting with a new template app, you have two options:

git clone https://github.com/feedhenry-templates/blank-ios-app.git
cd blank-ios-app

pod install

git clone https://github.com/feedhenry-templates/blank-ios-app.git

When you are integrating an existing app with RHMAP, you have two options:

pod FH, '3.1.1'

The RHMAP iOS SDK has a number of framework and library dependencies — you must re-configure your Build Phases to link against these frameworks and libraries at build time for the SDK to compile in your project correctly. The libraries you must link against are:

To add these, go to Build Phases > Link Binary with Libraries and add the above dependencies as link dependencies.

You will also need to add a Linker Flag to your app. To add this, go to the Build Settings screen of your project’s target. Use the search to find Other linker flags, and add the following:

-Objective-C

Finally, add a Property List file called fhconfig.plist to your Project.

You must define the properties which allow your app to communicate with RHMAP servers. Add the following values to the fhconfig.plist configuration file:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
  <key>host</key>
  <string>__RHMAP_Core_host__</string>
  <key>appid</key>
  <string>__Client_App_ID__</string>
  <key>projectid</key>
  <string>__Project_ID__</string>
  <key>appkey</key>
  <string>__Client_App_ API_key___</string>
  <key>connectiontag</key>
  <string>__Connection_tag__</string>
</dict>
</plist>

See Projects - Connections for more information on connections between Client Apps and Cloud Apps.

Before invoking any cloud requests from the RHMAP iOS Swift SDK, you must first initialize it. Copy the following code snippet to your App Delegate’s didFinishLaunchingWithOptions: method, or any other location which ensures the code is called before any cloud requests:

#import <FH/FH.h>
#import <FH/FHResponse.h>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  // Override point for customization after application launch.

  // Call a cloud side function when init finishes
  void (^success)(FHResponse *)=^(FHResponse * res) {
    // Initialisation is now complete, you can now make FHActRequest's
    NSLog(@"SDK initialised OK");
  };

  void (^failure)(id)=^(FHResponse * res){
    NSLog(@"Initialisation failed. Response = %@", res.rawResponse);
  };

  //View loaded, init the library
  [FH initWithSuccess:success AndFailure:failure];

  return YES;
}

CocoaPods is a Swift And Objective-C dependency manager for Xcode projects. It is built with Ruby, which comes pre-installed with OSX. It is used to distribute the RHMAP iOS Swift and iOS Objective-C Client SDKs.

sudo gem install cocoapods

pod setup

[sudo] gem install cocoapods-packager cocoapods-appledoc

pod install

Clone the sample app to get started with a new iOS application which has the RHMAP iOS Swift SDK included as a CocoaPods dependency.

git clone https://github.com/feedhenry-templates/blank-ios-swift.git
cd blank-ios-app

Fetch the dependencies defined in the Podfile:

pod install

Open the blank-ios-app.xcworkspace workspace in Xcode. The required dependencies are located in the Pods group.

If your app does not have a Podfile already, create a new file named Podfile at the root of your project with the following contents:

source 'https://github.com/CocoaPods/Specs.git'

project 'ProjectName.xcodeproj'
platform :ios, '8.0'
use_frameworks!

target 'TargetName' do
    pod 'FeedHenry', '4.1.1'

end

Replace '4.1.1' with the version of RHMAP iOS Swift SDK you are targeting, ProjectName.xcodeproj with the name of your project and TargetName with the name of your target. If you do not specify a version number, the latest version in the CocoaPods central repository will be used.

Fetch the dependencies defined in the Podfile:

pod install

You can now open ProjectName.xcworkspace in Xcode.

You must define the properties which allow your app to communicate with RHMAP servers. Add the following values to the fhconfig.plist configuration file:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
  <key>host</key>
  <string>__RHMAP_Core_host__</string>
  <key>appid</key>
  <string>__Client_App_ID__</string>
  <key>projectid</key>
  <string>__Project_ID__</string>
  <key>appkey</key>
  <string>__Client_App_ API_key___</string>
  <key>connectiontag</key>
  <string>__Connection_tag__</string>
</dict>
</plist>

See Projects - Connections for more information on connections between Client Apps and Cloud Apps.

Before invoking any cloud requests from the RHMAP iOS Swift SDK, you must first initialize it. Copy the following code snippet to your App Delegate’s application(_, didFinishLaunchingWithOptions:) method, or any other location which ensures the code is called before any cloud requests:

import FeedHenry

func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
  FH.init { (resp:Response, error: NSError?) -> Void in
    if let error = error {
      print("Error: \(error)")
      return
    }
    print("Response: \(resp.parsedResponse)")
  }
  return true
}

To migrate your app to Swift 2.3:

To migrate your app to Swift 3.0:

To install NuGet on Windows-based Systems, download and run the NuGet Commandline installer.

If you are using Chocolatey, you can install NuGet by executing the following command on the Windows command line:

choco install nuget.commandline

FH SDK is available on NuGet: https://www.nuget.org/packages/FH.SDK/. If you are using the NuGet plugin inside Visual Studio, search for FH.SDK. NuGet will install dependecy libraries automatically.

Download the SDK and unzip it. Adding the .dll assembly files inside the wp80 folder as references to your project.

If you are developing a Portable Class Library project, only reference the FHSDK.dll file.

The SDK is depending on Json.Net and Microsoft HTTP Client Libraries. You need to install the assemblies of those libraries as well if they are not available in your project.

You need to create a new file called fhconfig.json in your project. The content of the file should be look like this:

{
  "appid": "__ID_OF_APP_IN_PROJECT__",
  "appkey": "__APP_API_KEY_OF_APP_IN_PROJECT__",
  "connectiontag": "__CONNECTION_TAG_TO_USE_FOR_CLOUD__",
  "host": "__APP_STUDIO_HOST__",
  "projectid": "__PROJECT_ID__"
}

Make sure the build action of the file is Content.

To use the RHMAP .NET SDK, you will need to initialise the SDK like this (normally when app is started).

try
{
  bool inited = await FHClient.Init();
  if(inited) {
    //Initialisation is successful
  }
}
catch(FHException e)
{
  //Initialisation failed, handle exception
}

More information on connections can be found here.

To install NuGet on Windows-based Systems, download and run the NuGet Commandline installer.

If you are using Chocolatey, you can install NuGet by executing the following command on the Windows command line:

choco install nuget.commandline

FH SDK is available on NuGet: https://www.nuget.org/packages/FH.SDK/. If you are using the NuGet plugin inside Xamarin Studio, search for FH.SDK. NuGet will install dependecy libraries automatically.

Download the SDK and unzip it. Adding the .dll assembly files from the folder that is corresponding to your project’s build target as references.

If you are developing a Portable Class Library project, only reference the FHSDK.dll file.

The SDK depends on Json.Net and Microsoft HTTP Client Libraries. You need to install the assemblies of those libraries as well if they are not available in your project.

For each platform-specific application, you need to create the corresponding configuration files. The content of each file should be the same as described in each platform’s native SDK doc.

fhconfig.plist in the root of the application. Set build action to BundleResource.

fhconfig.plist file contents:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
  <key>host</key>
  <string>__APP_STUDIO_HOST__</string>
  <key>appid</key>
  <string>__ID_OF_APP_IN_PROJECT__</string>
  <key>projectid</key>
  <string>__PROJECT_ID__</string>
  <key>appkey</key>
  <string>__APP_API_KEY_OF_APP_IN_PROJECT__</string>
  <key>connectiontag</key>
  <string>__CONNECTION_TAG_TO_USE_FOR_CLOUD__</string>
</dict>
</plist>

fhconfig.properties in the Assets directory of the application. Set build action to AndroidAsset.

fhconfig.properties file contents:

host = __APP_STUDIO_HOST__
projectid = __PROJECT_ID__
connectiontag = __CONNECTION_TAG_TO_USE_FOR_CLOUD__
appid = __ID_OF_APP_IN_PROJECT__
appkey = __APP_API_KEY_OF_APP_IN_PROJECT__

fhconfig.json in the root of the application. Set build action to Content.

fhconfig.json file contents:

{
  "appid": "__ID_OF_APP_IN_PROJECT__",
  "appkey": "__APP_API_KEY_OF_APP_IN_PROJECT__",
  "connectiontag": "__CONNECTION_TAG_TO_USE_FOR_CLOUD__",
  "host": "__APP_STUDIO_HOST__",
  "projectid": "__PROJECT_ID__"
}

More information on connections can be found here.

To use the RHMAP .NET SDK, you will need to initialise the SDK like this in the platform-specific project (not the PCL project) when app finish starting.

try
{
  bool inited = await FHClient.Init();
  if(inited) {
    //Initialisation is successful
  }
}
catch(FHException e)
{
  //Initialisation failed, handle exception
}

FHClient is available in the following namespaces:

Depending on your app’s build target, only one of these name spaces should be available to your app.

The main reason for having the same FHClient class defined in different name spaces is to ensure that the platform-specific assembly file is loaded correctly.

You must have Node.js installed on your system to use npm. It is recommended that you install NodeJS version 4.x or later, which includes npm version 2.x by default.

sudo npm -v

To install NodeJS on systems running RHEL, you must obtain the installation files from the Red Hat Software Collections. Installing NodeJS requires a subscription to the Red Hat Subscription Manager.

To install NodeJS on RHEL, follow the guide on the Red Hat Developers Portal.

Download the sample app to get started with a new Cordova App which has the RHMAP JavaScript SDK already included.

Finally, you need to define properties which allow your app to communicate with RHMAP servers. Create a new file in the same directory as the SDK file, called fhconfig.json, with the following contents, replacing the references in brackets with values from your project:

{
  "host": "<RHMAP Core host>",
  "projectid": "<Project ID>",
  "connectiontag": "<Connection tag>",
  "appid": "<Client App ID>",
  "appkey": "<Client App API key>"
}

See Projects - Connections for more information on connections between Client Apps and Cloud Apps.

You must have Node.js installed on your system to use npm. It is recommended that you install NodeJS version 4.x or later, which includes npm version 2.x by default.

sudo npm -v

To install NodeJS on systems running RHEL, you must obtain the installation files from the Red Hat Software Collections. Installing NodeJS requires a subscription to the Red Hat Subscription Manager.

To install NodeJS on RHEL, follow the guide on the Red Hat Developers Portal.

Add the following code to your index.html file.

<head>
  <script src="feedhenry.js" type="text/javascript"></script>
</head>

Create a new file in the same directory as the SDK file (feedhenry.js) called fhconfig.json, with the following contents:

{
  "appid": "__ID_OF_APP_IN_PROJECT__",
  "appkey": "__APP_API_KEY_OF_APP_IN_PROJECT__",
  "connectiontag": "__CONNECTION_TAG_TO_USE_FOR_CLOUD__",
  "host": "__APP_STUDIO_HOST__",
  "projectid": "__PROJECT_ID__"
}

More information on connections can be found here.