ibmbluemix

Mobile Cloud Services Core JavaScript SDK for IBM Bluemix

ATTENTION: This service is currently deprecated on Bluemix and will be completely removed shortly. Please use the 2nd generation of Bluemix MobileFirst Services.

This package contains the required native components to interact with the IBM Mobile Cloud Services for Bluemix. You can use the JavaScript SDK to build Web or Hybrid applications. You can also use this SDK in server-side Node.js JavaScript modules. The SDK manages all the communication and security integration between the client and the Mobile Cloud Services in Bluemix.

When you use Bluemix to create a Mobile Cloud application, BlueMix provisions multiple services under a single application context. Your mobile application is given access to the following mobile services: Mobile Application Security, Push, and Mobile Data.

Version: v1.0.0-20160421-1718

Install the SDK

You can install the SDK by downloading a zip file, or by installing the desired components with Bower, or NPM. Using the Bower or NPM tools can shorten the time required to start a new project and make managing library version requirements as well as the dependencies easier. If you are using one of the samples, instructions for using the package manager is included with the documentation.

Get the SDK for Node.js (NPM)

NPM is included in current Node.js distributions. To install Node.js, go to Download Node.js.

Run the following command to install the ibmbluemix package:

npm install ibmbluemix

Get the SDK for Web or Hybrid (Bower)

To install Bower, see Bower.io.

Run the following command to install the ibmbluemix package:

bower install https://hub.jazz.net/git/bluemixmobilesdk/ibmbluemix-javascript/.git

Download zip file

To download a zip of the entire SDK, see Building Mobile Cloud applications.

SDK modules

The complete SDK consists of a core, plus a collection of modules that correspond to function that is included in the Mobile Cloud Services.

The downloaded zip file contains all of these components. However, each piece of the JavaScript SDK is also available as a separate module that you can add to your project individually so that you can choose the modules that are required for your application.

You can add any of the following components to your project:

• ibmbluemix : SDK foundation, and controls connection and communication with back end services
• ibmpush - Service SDK for Push
• ibmdata - Service SDK for Mobile Data
• ibmfilesync - Service SDK for cloud file storage with Mobile Data
• ibmcloudcode - Service SDK for cloud code invocation
• ibmlocation - Service SDK for the beta mobile location services
• docs/ - Documentation for the SDK

Get started

Services are associated with a Mobile Cloud application. Connectivity and interaction with these services depends on the application ID, application secret, and application route that is associated with a Mobile Cloud Application.

The IBMBluemix module is the entry point for interacting with the Mobile Cloud Services SDKs. You must invoke the initialize method before any other API calls. IBMBluemix provides information about the current SDK level and access to service SDKs.

An example of initializing the Mobile Cloud Services SDK follows:

var config = {
  applicationId:"<ApplicationID>",
  applicationRoute:"<ApplicationRoute>",
  applicationSecret:"<ApplicationSecret>"
};
IBMBluemix.initialize(config);

Learn more

To learn more about using the SDK, please consult the following resources:

• Mobile Cloud Services SDK Developer Guide
• Samples and Tutorials
• Bluemix Developers Community
• Connect with Bluemix: Twitter | YouTube | Blog | Facebook | Meetup

Licensed Materials - Property of IBM (C) Copyright IBM Corp. 2013, 2015. All Rights Reserved. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Terms of Use | Notices