Skip to end of metadata
Go to start of metadata

Pro or Enterprise Subscription Required

Icon

This AMPLIFY(TM) Appcelerator Services feature requires a Pro or Enterprise Subscription. 

Introduction

This guide walks through the setup of the AMPLIFY Appcelerator Services for iOS applications.  The AMPLIFY Appcelerator Services SDK gives you access to the Appcelerator Analytics, Cloud and Performance services.  Note that the Appcelerator Test service does not currently work with Swift projects.

Not developing a native iOS application with Swift?

See the following topics to use the AMPLIFY Appcelerator Services on other platforms:

For native Android applications built with Java, see Quick Start Guide for Android APS SDK.

For native iOS applications built with Objective-C, see Quick Start Guide for iOS APS SDK.

For Titanium Applications, see Quick Start.

Requirements

You should be familiar with developing native iOS applications using Xcode and Swift.  The SDKs supports the following base SDK and target iOS versions:

Maximum SDK versionMinimum SDK versionMaximum target iOS versionMinimum target iOS version
9.0.x8.0.x9.0.x7.1.x

Setup

Before you can use Appcelerator Services in your application you need to:

  • Create an application in Dashboard
  • Download the SDK
  • Get the APS application key

 To register an Android Java, or iOS Objective-C or Swift application in Dashboard:

  1. Log in to Appcelerator Dashboard.
  2. Click the Add menu (+) and select Register App for Services to open the Register App for Services form.
     
     
  3. In the Register App for Services form, enter an application Name, and select a Platform and Category. Optionally, you can provide a custom icon to display in Dashboard for your application, and a description. To add application team members from the organization, click the add (+) button in the Members form at right.
     
  4. Click OK.

Dashboard displays the Platform Services tab for your application. In the tab, you can download the APS SDK, and get code snippets to copy and paste into your application.

For more information, refer to Managing Non-Titanium Client Applications in Dashboard.

Quick Tutorial

The following tutorial demonstrates basic setup and usage of Analytics, Cloud, and Performance libraries in a Swift Xcode project. To complete the tutorial you will need your APS application key for the Cloud, Analytics, and Performance services.  Download a complete version of the project.

To create a basic application using APS:

  1. In Xcode, create a new iOS Project (Single View Application). When prompted for options, select Swift in the Language drop-down.
  2. Create a Header File and name it <PROJECT_NAME>-Bridging-Header.h.  Make sure the main project's application target folder is selected, then from the menu, select FileNewFile... or drag a Header File from the File Template library to the application target folder.  The application target folder is a folder under the root project folder and will be named the same as the project if the name has not been changed.
     

  3. Unzip appcelerator-sdk-ios-<VERSION>.zip file and drag the Appcelerator.framework folder into the root project folder. 
  4. Select Copy items into destination… and click Finish.
  5. Select your project in the Project navigator and click the Build Phases tab.
  6. Expand the Link Binary With Libraries section and add the libsqlite3.tbd and libz.tbd frameworks. Prior to Xcode 7, the framework extension is dylib rather than tbd.
  7. Click the Build Settings tab, then click the All button in the top-left corner of the tab.
  8. If you are using Xcode 7, you will need to disable bitcode since some third-party libraries do not have bitcode enabled. Expand the Build Options section and set Enable Bitcode to No.
  9. Expand the Linking section and add -ObjC  to Other Linker Flags .
  10. Expand the Swift Compiler - Code Generation section (near the bottom) and add the bridging header file (with the relative path from the root folder) to Objective-C Bridging Header, for example, <PROJECT_NAME>/<PROJECT_NAME>-Bridging-Header.h.
     

  11. Open the bridging header file and add the following import statement: 

  12. Open the application delegate file (AppDelegate.swift) and add the following initialization code to the application() method: 

    The iOS application is now ready to make method calls using the APS SDK APIs.

Icon

If the application attempts to make APS SDK API calls without first setting the application key, the application will raise an exception and crash.

Bridging Header File

Icon

Alternatively, to have Xcode automatically create a bridging header file and add the build flag:

  1. Skip steps 2 and 9 in the previous directions.
  2. After step 8, create an Objective-C file. (From the menu, select File > New > File... or drag an Objective-C file from the File Template library to the application target folder.)
  3. After creating the file, a dialog appears with the message "Would you like to configure an Objective-C bridging header?" Click Yes.
  4. Xcode creates the header file and adds it to the build flag. Delete the Objective-C file you just created.
  5. Follow steps 10 and 11.

 

Modify the Application

Customize the application's UI to display a picker, text field and button, and add some logic to respond to user interaction.  The picker will display a list of available user accounts.  The user can enter their password in the text field, then click the button to log in.

  1. Open your project's Main.storyboard file.
  2. Drag a Picker View, Text Field and Button from the Object library to the view.
  3. Open the Assistant Editor. (From the menu, select View > Assistant Editor Show Assistant Editor or click the Assistant Editor button in the top-right corner.)
  4. In the right pane, display the ViewController.swift file.
  5. Control-drag the Picker View to the View Controller icon at the top of the view.  Select dataSource.  Repeat for the delegate option.
     
  6. Drag the Picker View to the header file to create an IBOutlet.  Name the outlet picker and click Connect.  Repeat the same procedure for the Text Field and name it textField.
     
  7. In the ViewController.swift file:

    1. Declare the View Controller to implement the UIPickerViewDelegateUIPickerViewDataSource, and UITextFieldDelegate protocols.

    2. Add a Dictionary array called usernames to keep track of the Picker View's data source and a String variable called username to reference the current selection. 

    3. Create an IBAction callback for the button named doClick.  In the following sections, you will add code to this handler that calls Cloud, Analytics and Performance services.  

    4. Implement the methods of UIPickerViewDelegateUIPickerViewDataSource and UITextFieldDelegate protocols.  Add the following code to the file:

    ViewController.swift
  8. Control-drag the Button to the onClick() method to create an action connection.

Send an Analytics Feature Event

The Analytics library automatically captures and sends application life-cycle events to the backend Analytics service. You can also send custom analytics events, as shown in this example. There are two types of custom events: feature events and navigation events.

In the  doClick method, add a APSAnalytics.sharedInstance().sendAppFeatureEvent() method call to send a feature event with the string "sample.feature.login". The optional payload parameter is set to nil for this example, but it lets you send additional data along with the event.

ViewController.swift

Query Cloud Users

To use the APS Cloud component, most of the methods require a user to be logged in.  This sample uses the Picker View to select a Cloud user account.  To populate the Picker View values, the application needs to retrieve a list of users. Call the APSUsers.query() method to retrieve a list of user accounts from inside the viewDidLoad() method.

Every APS Cloud method includes a withBlock parameter that specifies the callback to handle the server response. The callback is passed an APSResponse object that contains response metadata (such as success or failure) and the response payload.

ViewController.swift

Login to a Cloud Account

To login to a Cloud account, you need the username and password.  Since the application was modified to get all available user accounts and populate the Picker View, the application needs to get the current value of the picker and the text entered in the Text Field.  These values are passed to the APSUsers.login() method.  Modify the doClick method to login to a Cloud user account.

ViewController.swift

Set a Username for Crash Logs

To help differentiate crash logs, use the username property.  When the application successfully logs in to the Cloud user account, the application sets the username property.

ViewController.swift

Testing the Tutorial Sample

Before testing the sample, you need to create user accounts for the application to query.  To create Cloud user accounts:

  1. Log in to Appcelerator Dashboard.
  2. In Dashboard, select your application from the APIs menu in the upper-left corner.
  3. In the left navigation bar, click Manage Data.
  4. Click Users, then the Create User button.
  5. In the Username field enter the user's username.
  6. In the Password field enter the new user's password (four-character minimum).
  7. Click Save Changes.
Icon

To create a Cloud user account, you only need a username or e-mail address, and a password.

For more information about managing Cloud user accounts, see Managing Organizations.

After you have created a few Cloud user accounts, build the sample and launch it on either a device or emulator.

Once the application launches:

  1. Click on the Picker.  You should see a list of all the Cloud user accounts you added.
  2. Select a user account from the Picker and enter that user's password.  Click the Button.  In the log output, you should see an info log that login command was successful or not.
  3. Go back to the Appcelerator Dashboard.
  4. In Dashboard, select your application from the Apps menu in the upper-left corner.
  5. In the left navbar, select Analytics.
  6. In the Real Time view, you should see at least one active session.
  7. In the left navbar, click Events.  You should see the "sample.feature.login" feature event.

Next Steps for Appcelerator Analytics, Cloud and Performance

This tutorial only covers a small portion of what the Analytics, Cloud and Performance services can provide.  For more in-depth information about these features, see the following topics. Note that these guides were written for Objective-C projects.  You will need to adapt the API calls for Swift.

  • No labels