Skip to end of metadata
Go to start of metadata

The AMPLIFY Appcelerator Platform Services SDK for iOS provides APIs for your iOS application built with Objective-C to access Mobile Backend Services (MBS).

Getting the SDK

To download and start using the SDK, you first need to register a new iOS application in Dashboard. See Managing Non-Titanium Client Applications in Dashboard for details on registering a new application. After you register an application, a service key is generated that associates your application with all the Platform services. The Dashboard also provides full instructions for enabling all Platform Services in your application. This guide will deal specifically with enabling and using Mobile Backend Services in an iOS application.

Running the APSCloud Example application

The SDK ZIP file includes an iOS sample project that demonstrates the basic usage of each of the Cloud APIs. To run the sample, register a new application in Dashboard to obtain the necessary service application. You will then copy the key into the imported sample project's application delegate, then run the application.

To create the APSCloud Example application in Dashboard:

  1. Log into the AMPLIFY Platform.
  2. Select the Dashboard link on the Dashboard tile.
  3. Select your MBS application from the Apps tab.
  4. If you are a member of multiple organizations, from the User menu, select the organization to associate with the application.
  5. Click the Add menu (+) and select Register App for Services.
  6. In the dialog:
    • Enter APSCloudExampleApp (or another name) in the Name field.
    • Select APS SDK from the Type menu.
    • Select iOS from the Platform menu.
    • (Optional) Enter an identifier in the Identifier field.
    • (Optional) Enter a description in the Description field.
    • Select the Services to be enabled.
  7. (Optional) Click the + icons to add additional team members.
  8. Click Save.
  9. Click the Services tab.
  10. Select Development from the Environment menu, then click the clipboard icon to copy the key to your clipboard.

Next, import the APSCloudExample project into Xcode, copy the key from your clipboard into the application delegate, and run the application.

To import the completed APSCloudExample project:

  1. In Xcode, open the appcelerator-sdk-ios-<VERSION>/examples/APSCloudExample.xcodeproj file.
  2. Open AppDelegate.m, add the code below to your application delegate's application:didFinishLaunchingWithOptions method, and replace << YOUR APP KEY >> with the application key you copied to your clipboard previously.

  3. Run the application on an iOS device or 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 and then click Create. If the user is created successfully, the following dialog is shown:
  • View the newly created user in Dashboard:
    1. Log into the AMPLIFY Platform.
    2. Select the Dashboard link on the Dashboard tile.
    3. Select your MBS application from the Apps tab.
    4. Select Manage Data, then click Users in the Manage Data Objects table. You should see the user you created listed in the Users table.

Enabling Cloud services in a new project

Once you've registered an application in Dashboard, downloaded the SDK, and obtained your application service key, there are few steps to enable Cloud services in your iOS project. The steps are slightly different if you are using Xcode 6 or 5.

To enable the Cloud service in an existing Xcode project:

  1. Add the  appcelerator-sdk-ios-<VERSION>/Appcelerator.framework  folder to your project:
    • For Xcode 5 projects, drag the Appcelerator.framework folder to your project's Frameworks folder, making sure Copy items into destination group's folder is checked, and click Finish.
    • For Xcode 6 projects, drag the Appcelerator.framework folder to the project's root folder, making sure Copy Items if Needed is checked, and click Finish.
  2. On your project's Build Phases tab, expand the Link Binary With Libraries section and add the libsqlite3.dylib and libz.dylib frameworks.
  3. On your project's Build Settings tab, click All in the top-left corner, then expand the Linking section.
  4. In the Other Linker Flags field, enter -ObjC.
  5. Import Appcelerator.h into your application delegate:

  6. Lastly, initialize Platform services by calling the [APSServiceManager enableWithAppKey] method, replacing << YOUR APP KEY >> with the service key generated by Dashboard when you created your application. (See View Application Information for information on how to locate your application key.)

At this point, your application can begin making API calls.

Making API calls and handling responses

The iOS framework includes a collection of classes whose methods map to individual REST API method endpoints. For example, the APSUsers create method that corresponds to the /users/create.json method endpoint.

Alternatively, you can use the generic APSCloud sendRequest method to make REST calls directly against the Cloud APIs. For more information, see Making Generic REST API Calls.

Building request parameters

The first parameter of each Cloud API method is a NSDictionary object that contains the parameters to send with the request. For example, the APSPhotos show method takes a photo_id parameter whose value is, naturally, the ID of the photo to show.

Handling responses

The second parameter of each method call is a block that is passed to an APSResponse whose properties contain information about the response. For instance, the success property contains a boolean indicating if the method call was successful or not, the response property returns a JSON-encoded object with the results of the method call.

Note that the block will be called on the thread on which the request was started.

Example: APSUsers login call with response handler

The following example logs in an existing MBS user by their username and password. After a successful login, the application displays an alert indicating a successful login.

Monitoring request progress

For Cloud API methods that involve uploading large files, such as APSPhotos create or APSFiles create, there is an overloaded version that takes an additional progressBlock parameter. This parameter is a code block that is periodically invoked and passed a float value indicating the progress of the request, and a boolean indicating if the request is for an upload (YES) or download (NO).

Example: APSPhotos create a call with progress handler

The following example creates a new Photo object from a binary photo attachment. The progressBlock code block sets the progress property on a ProgressBar object, displaying the status of the upload.

Making generic REST APIs method calls

The APSCloud sendRequest method lets you easily make REST API calls directly against MBS, rather than using the specialized classes. In general, you should use specialized classes as they provide an easier API. However, if new REST methods are deployed to the APS Cloud backend, this approach lets you immediately start using those methods without waiting for an update to the SDK.

To make a generic request, you call APSCloud sharedInstance to get a reference to the shared APSCloud object and then call its sendRequest method. For each call, you must specify the following:

  • REST API method endpoint relative to "". Method endpoints are listed in the corresponding entries in the REST API documentation.
  • The HTTP method to use.
  • Data to send with the request.

For example, to create a post, pass the sendRequest() method the following information:

  • REST API method endpoint: posts/create.json
  • The HTTP method to use: POST
  • Data to send with the request: at a minimum, you must specify the content property.

The following example calls the users/login.json REST method directly and logs the result to the console.

Working with push notifications

The  APSPushNotifications class lets your application subscribe, send, and receive push notifications. To use the class:

Once push services have been configured, the application needs to register with iOS to receive push notifications. For example, you can add the following code to the application delegate implementation file in the application:didFinishLaunchingWithOptions: method:

After the application registers with iOS to receive push notifications, the application needs to register the device with Appcelerator Cloud. Call the subscribe or subscribeToken method inside the application delegate's application:didRegisterForRemoteNotificationsWithDeviceToken: method. Note that you will need to convert the NSData parameter to a hex string before passing it to either the subscribe or subscribeToken method.

Once push services have been configured, and you've obtained a device token by registering your application to receive remote notifications, you can start calling methods of the APSPushNotifications class.