Titanium SDK and ACS

The Appcelerator Cloud Services APIs are supported in Titanium using the ti.cloud module, an optional module which is packaged with the Titanium SDK.

When new APIs are added to ACS, they may not be immediately available in the Titanium.Cloud module. See the module API reference for a list of supported objects and methods.

Adding ACS to your Titanium Project

This section describes how to add ACS to a Titanium application. If you don't have an existing ACS backend application, Studio can create one for you.

If you are using the CLI, you must create the ACS application using the ACS website and integrate it as descibed in Adding an Existing ACS Application to a Titanium Project.

Adding ACS to a New Titanium Application

If you are using Studio to create a new Titanium application, you can create a new ACS application at the same time:

  1. Click File > New > Mobile Project to start the new project wizard.
  2. Choose a template and click Next.
  3. On the next screen, make sure Automatically cloud-enable this application checked.
  4. Enter the project name and ID and click Finish.

This creates a new Titanium application and a new ACS application, and configures the Titanium project to access ACS.

Adding ACS to an Existing Titanium Application

If you have an existing Titanium project in Studio, and want to create a new ACS backend application for it:

  1. Open the project's tiapp.xml and switch to the Overview tab.
  2. Next to Enable Cloud Services, click the Enable button.

Adding an Existing ACS Application to a Titanium Project

If you have already created an ACS application, you can add it to a Titanium project by editing the tiapp.xml file. You'll need the API key, OAuth key, and OAuth secret generated when you created the ACS application.

  1. Open the project's tiapp.xml and switch to the tiapp.xml (source view) tab.

  2. Add the following entries to the file:

    <property name="acs-api-key-development" type="string">YOUR DEVELOPMENT API KEY HERE</property>
    <property name="acs-oauth-key-development" type="string">YOUR DEVELOPMENT OAUTH KEY HERE</property>
    <property name="acs-oauth-secret-development" type="string">YOUR DEVELOPMENT OAUTH SECRET HERE</property>
    
    <property name="acs-api-key-production" type="string">YOUR PRODUCTION API KEY HERE</property>
    <property name="acs-oauth-key-production" type="string">YOUR PRODUCTION OAUTH KEY HERE</property>
    <property name="acs-oauth-secret-production" type="string">YOUR PRODUCTION OAUTH SECRET HERE</property>
    
  3. Find the <modules> element in the file, and add the following:

    <module platform="commonjs">ti.cloud</module>
    

    If there is no <modules> element, add the following inside the <ti:app> element:

    <modules>
        <module platform="commonjs">ti.cloud</module>
    </modules>
    

    (This element is usually placed just above the <deployment-targets> element.)

Importing the Module

ACS support is baked into Titanium. However, you must include the cloud services module into your project to use ACS functionality. In your app.js (or other suitable file), include the require() statement as shown here:

var Cloud = require('ti.cloud');
Cloud.debug = true;  // optional; if you add this line, set it to false for production

Authenticating your Application

Your application must prove that it is allowed to talk to ACS. This keeps your data secure by preventing anyone from making requests to ACS that impersonate your app. There are several methods for authenticating with ACS:

  • API key
  • 2-Legged OAuth

For 2-legged OAuth or API key authentication, use the Users.create and Users.login methods:

Cloud.Users.login({ 
    login: "test@example.com",
    password: "passwd"
}, function(e) {
    if (e.success) {
        Ti.API.info("Logged in user, id = " + users[0].id + ", session ID = " + Cloud.sessionId);
    } else {
        Ti.API.info("Login failed.");
    }
});

For more information, see Authentication.

Push Notifications

To setup your Titanium application to use push notifications, see Push Notification guide.

Using the ACS APIs

The ti.cloud module APIs follow the same basic pattern. For each ACS method supported by the API, the module supplies a JavaScript method that takes two arguments: a parameters dictionary, which holds the parameters passed to the method, and a callback to be invoked when the method completes.

The response callback receives a single object, which is a slightly modified version of the REST response object. The REST response contains two objects:

  • meta : Object. Response metadata, such as success or failure, error messages, pagination information.
  • response : Object. Response data specific to the call. For example, if you search for places, the response object contains an array of places.

The module's response object includes any properties from response at the top level of the object. For example, if the REST response includes response.places, this is included as places.

The module's response object also includes the following fields:

  • meta : Object. Metadata from the REST response.
  • success : Boolean. True if the request succeeded (that is, meta.status == "ok").
  • error : Boolean. True if the request failed (meta.status != "ok").
  • message : String. Error message, if available.
  • code : Number. Error code, if available.

Examples

With over 25 APIs available for you to use, we obviously can't cover them all here. But let's take a look at a couple of examples.

Create a user

// example assumes you have a set of text fields named username, password, etc.
Cloud.Users.create({
    username: username.value,
    password: password.value,
    password_confirmation: confirmPassword.value,
    first_name: firstName.value,
    last_name: lastName.value
}, function (e) {
    if (e.success) {
        // user created successfully
    } else {
        // oops, something went wrong
    }
});

Post a photo to a photo collection. To post a photo to a collection, you need to create the collection first using PhotoCollections.create.

// assumes you've obtained a photo from the camera or gallery, with blob data stored in an object named photo,
// and that collectionID contains the ID of an existing photo collection.
Cloud.Photos.create({
    photo: photo,
    collection_id: collectionID,
    'photo_sync_sizes[]': 'small_240'
}, function (e) {
    if (e.success) {
        // null out our photo objects to clean up memory
        photo = null;
        collectionID = null;
    } else {
        // oops, something went wrong
    }
});

Linking a Facebook login with your app. You must already be logged in using the Titanium Facebook module before calling the externalAccountLogin method.

Prior to Titanium 3.1, use Titanium.Facebook instead.

// Not shown is the code to implement the Facebook module in your app
// Use Titanium.Facebook prior to 3.1. 
var Facebook = require('facebook');   

// call the ACS Facebook SocialIntegrations API to link logged in states
function updateLoginStatus() {
    if (Facebook.loggedIn) {
        label.text = 'Logging in to ACS as well, please wait...';
        Cloud.SocialIntegrations.externalAccountLogin({
            type: 'facebook',
            token: Facebook.accessToken
        }, function (e) {
            if (e.success) {
                var user = e.users[0];
                alert('Logged in! You are now logged in as ' + user.id);
            }
            else {
                error(e);
            }
        });
    }
    else {
        label.text = 'Please login to Facebook.';
    }
}

// when the user logs into or out of Facebook, link their login state with ACS
Facebook.addEventListener('login', updateLoginStatus);
Facebook.addEventListener('logout', updateLoginStatus);

// add the Facebook login button
win.add(Facebook.createLoginButton({
    top: 10
}));

For more examples, see the ACS API documentation.

Importing and running the Ti.Cloud Sample application

The Titanium.Cloud module also includes a sample application that demonstrates each of the ACS request types.

To import and run the Ti.Cloud sample application:

  1. In Studio, select File > New > Mobile App Project.
  2. Select the Classic application type with the Default Project template.

  3. In the New Mobile App Project dialog, enter values for the Project Name and App ID fields, and check the option to Enable Appcelerator Platform Services (in Titanium Studio check the option to Cloud-enable this application).

  4. Click Finish.
  5. From your desktop, navigate to the following folder, where <latest_version> is the folder containing the latest SDK version:

    • Mac: ~Library/Application Support/Titanium/modules/commonjs/ti.cloud/<latest_version>/example
    • Windows 7: %ProgramData%\Titanium\modules\commonjs\ti.cloud\<latest_version>\example
    • Windows 8: %AppData%\Titanium\modules\commonjs\ti.cloud\<latest_version>\example
    • Linux: ~/titaniumsdk/modules/commonjs/ti.cloud/<latest_version>\example
  6. Select all the folders and files in the example folder and drag them to your project's Resources folder.

    • If prompted, select the option to Copy Files and Folders and click OK.
    • Click Yes to All when asked if you want to overwrite files.
  7. Open the project's tiapp.xml file and, in the Modules section, add the facebook and ti.cloudpush modules.

  8. Save tiapp.xml and run the project on the desired device or emulator/simulator.

Once the application is running, try the following:

  • Create a new user by selecting Users > Create User. Enter a username, password and password confirmation, first name, and last name, then click Create. If the user is created successfully, the following dialog is shown:

  • View the newly created user in Dashboard:

    1. Open Dashboard and select your application from the Apps menu.
    2. Select Cloud > Manage Data, then click Users in the Manage Data Object table. You should see the user you created listed in the Users table.

References