Make sure you install the following tools and libraries.
You should already have Node.js/npm and the Cordova package installed. If you don't, you can download and install Node from https://nodejs.org/en/download/.
The Cordova CLI tool is also required to use this plugin. You can find instructions to install Cordova and set up your Cordova app at https://cordova.apache.org/#getstarted.
You should have Cocoapods installed. If you don't, you can download and install Cocoapods from http://cocoapods.org/
To create a Cordova application, use the Cordova Plugin for the IBM Bluemix Mobile Services Core SDK:
Run the following commands to create a new Cordova application. Alternatively you can use an existing application as well.
$ cordova create {appName}
$ cd {appName}
Edit the config.xml
file and set the desired application name in the <name>
element instead of a default HelloCordova.
Continue editing config.xml
For iOS, update the <platform name="ios">
element with a deployment target declaration as shown in the following code snippet.
<platform name="ios">
<preference name="deployment-target" value="8.0" />
<!-- add deployment target declaration -->
</platform>
For Android, update the <platform name="android">
element with a minimum and target SDK versions as shown in the following code snippet.
<platform name="android">
<preference name="android-minSdkVersion" value="15" />
<preference name="android-targetSdkVersion" value="23" />
<!-- add minimum and target Android API level declaration -->
</platform>
Note:
The minSdkVersion should be above 15.
The targetSdkVersion should always reflect the latest Android SDK available from Google supported by Cordova. Currently, Cordova supports up to Android 24.
Run the following commands for the platforms that you want to add to your Cordova application:
cordova platform add ios
cordova platform add android@5.2.2
Run the following command from your Cordova application's root directory to add the bms-core plugin:
cordova plugin add bms-core
You can check if the plugin installed successfully by running the following command, which lists your installed Cordova plugins:
cordova plugin list
Note: Before you begin, make sure that you are using Xcode 7 or above.
Run cordova prepare ios
to prepare the Cordova application with the necessary CocoaPod dependencies.
Build and run your application with Xcode or by running the following command:
cordova build ios
Note: You may receive the following error when running cordova build ios
. This issue is due to a bug in a dependency plugin which is being tracked in Issue 12. You can still run the iOS project in XCode through a simulator or device.
xcodebuild: error: Unable to find a destination matching the provided destination specifier:
{ platform:iOS Simulator }
Missing required device specifier option.
The device type “iOS Simulator” requires that either “name” or “id” be specified.
Please supply either “name” or “id”.
If you get a prompt asking whether you want to convert Swift code to the latest version, click Cancel.
Pods_{YOUR_PROJECT_MODULE_NAME}.framework
is present in the linked libraries list.Note: If you get the message that your application requires Use Legacy Swift Language Version
, set the flag to NO
.
BMSAnalytics
and BMSAnalyticsAPI
. Build your Android project by running the following command:
cordova build android
Important: Before opening your project in Android Studio, you must first build your Cordova application through the Cordova commmand-line interface (CLI). Otherwise, you will encounter build errors.
The BMSClient
class allows you to initialize the SDK. By initializing the SDK, you can connect to the server app that you created in the Bluemix dashboard. Initializing the BMSClient
instance is required before sending requests.
Initialize the BMSClient
by copying and pasting the following code snippet into your main JavaScript file. If your app is in a different region, the following constants are available: BMSClient.REGION_US_SOUTH
, BMSClient.REGION_UK
,BMSClient.REGION_GERMANY
, BMSClient.REGION_SYDNEY
, BMSClient.REGION_US_EAST
and BMSClient.REGION_TOKYO
.
BMSClient.initialize(BMSClient.REGION_US_SOUTH);
Note: If you created a Cordova app using the cordova CLI, for example, cordova create app-name
command with the Cordova command-line, add the following Javascript code in the index.js
file, within the onDeviceReady
function to initialize the BMSClient
.
onDeviceReady: function() {
BMSClient.initialize(BMSClient.REGION_US_SOUTH);
},
The following JavaScript code is your entry point to the Bluemix Mobile services. Call this method before making any request. You must pass in the region for your application. The following constants are provided:
REGION_US_SOUTH // ".ng.bluemix.net";
REGION_UK //".eu-gb.bluemix.net";
REGION_SYDNEY // ".au-syd.bluemix.net";
REGION_GERMANY // ".eu-de.bluemix.net"
REGION_US_EAST // ".us-east.bluemix.net"
BMSClient.initialize(BMSClient.REGION_US_SOUTH);
After you initialize the client, you can create a new BMSRequest
instance by specifiying a URL endpoint, request method, and an optional timeout value in milliseconds.
var request = new BMSRequest("http://your_app.mybluemix.net/protected", BMSRequest.GET, 20000);
var headers = {
header1: "val1",
header2: "val2"
};
request.setHeaders(headers);
var queryParams = {
param1: "val1",
param2: "val2"
};
request.setQueryParameters(queryParams);
The query parameters are parameters that are added to the request URL.
request.send("some body",
function(successResponse){
console.log("text :: " + successResponse.responseText);
console.log("status :: " + successResponse.status);
console.log("headers :: " + successResponse.headers);
},
function (failureResponse){
console.log("text :: " + failureResponse.responseText);
console.log("errorCode:: " + failureResponse.errorCode);
console.log("errorDescription :: " + failureResponse.errorDescription);
}
);
The successResponse
and failureResponse
parameters are JSON objects that will be passed to your callbacks with the following fields:
response.status => Integer
response.responseText => Undefined or String
response.headers => JSON object with key:value pairs of headers
response.errorCode => Integer
response.errorDescription => Undefined or String
var myPackageLogger = BMSLogger.getLogger("myPackage");
// Globally set the logging level
BMSLogger.setLogLevel(BMSLogger.WARN);
// Log a message at FATAL level
myPackageLogger.fatal("Fatal level message");
// Send the logs to the server
BMSLogger.send();
//Initialize BMSClient
BMSClient.initialize(BMClient.REGION_US_SOUTH);
//Initialize BMSAnalytics
BMSAnalytics.initialize(appName, apiKey, hasUserContext, [BMSAnalytics.ALL]
// Enable analytics logging
BMSAnalytics.enable();
// If hasUserContext is set to true set "userIdentity"
BMSAnalytcs.setUserIdentity("user1");
// Send the analytics log to the server
BMSAnalytics.send();
// Invoke feedback mode on any application event such as buttons, menu actions or gestures on calling the method
BMSAnalytics.triggerFeedbackMode();
Note: In iOS, BMSAnalytics.ALL and BMSAnalytics.NONE is not supported natively and will be treated as BMAnaltyics.LIFECYCLE.
Note: For more information about Mobile Analytics, see the documentation.
Removed BMSSecurity (mobileaccess)
userIdentity
logLevelDictionary
EXEC_BAD_ACCESS errorDeviceEvent.NETWORK
as an available event for BMSAnalytics
<pod id=/podId/ value="~>2.0"/>
to grab the latest pod dependency from version [2.0,3.0)<pod id=/podId/ value=">=2.0.0"/>
to grab the latest pod dependencyBMSAnalytics
pod dependency to 2.1.1BMSSecurity
pod dependency to 2.0.2setUserIdentity
method to BMSAnalytics
Changed JS API signatures
BMSClient.initialize(backendRoute, backendGuid)
--> BMSClient.initialize(region)
MFPRequest
--> BMSClient
MFPLogger
--> BMSLogger
getInstance
--> getLogger
getCapture
--> isStoringLogs
setCapture
--> storeLogs
getMaxStoreSize
--> getMaxLogStoreSize
setMaxStoreSize
--> setMaxLogStoreSize
getLevel
--> getLogLevel
setLevel
--> setLogLevel
MFPAuthorizationManager
--> BMSAuthorizationManager
MFPAnalytics
--> BMSAnalytics
Added isSDKDebugLoggingEnabled
to BMSLogger
/MFPLogger
Added BMSAnalytics.NONE
, BMSAnalytics.ALL
, and BMSAnalytics.LIFECYCLE
to BMSLogger
/MFPLogger
Added BMSAnalytics.initialize
to BMSLogger
/MFPLogger
Removed initialize
from BMSAuthorization
/MFPAuthorizationManager
, use native implementation
Removed the use of using a copy of Bridging-Header.h
, so that developers will no longer need to do this manually
Added a new initializer for BMSClient that does not require the app route and app guid: BMSClient.initialize(BMSClient.REGION_US_SOUTH);
Removed filters and capture methods for BMSLogger
, use BMSLogger.getLogLevel
or BMSLogger.setLogLevel
Added initMCAAuthorizationManagerManager
to handle initialize MCA in iOS native
Copyright 2016 IBM Corp.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.