Introduction

AGE Invitation UI is a drop-in IOS controls that you can deploy to your app within minutes. AGE Invitation UI will help your users identify and share your app with friends & associates having compatible mobile devices and highest LTV. For complete feature set and how it works, please visit Hook Mobile.

Getting Sample App Up and Running

A sample app is included with this project that demonstrate AGE Invitation UI launched from a button. Once you download and open the Xcode project, click on Run button in Xcode. You may launch the sample app in the simulator or your IOS device. Running on your iPhone is preferred because you are likely to have more contacts in your iPhone address book to invite from.

When AGE Invitation UI is invoked for first time, it will analyze the address book. It may take a few seconds before the list of suggested contacts is displayed. You may use swipe-pull gesture to force a refresh of the list. The list of contacts shown in the list is filtered by criteria you define for your app profile in our developer portal.

Select one or more entries from the suggested and click on the Send button to fire off the invitation text message. The recipient(s) of the invitation will receive a personalized text message on their phone:

The message is completely customizable by you, and it can be further personalized to include the sender and app name.

Integration Setup

Now that you have a good understanding of the AGE Invitation UI, you are ready to integrate AGE Invitation UI into your app. The first step is to signup for an App Key for your app at Hook Mobile developer portal. This App Key will be used in the next section when you start doing your integration.

The next step is to copy all the necessary files into your Xcode project. AGE Invitation UI requires linking with following system libraries:

• AddressBook.Framework
• MessageUI.Framework
• QuartzCore.Framework

AGE Invitation UI depends on following third party open-source libraries. Source codes for these libraries are included in this project.

• MBProgressHUD
• ODRefreshControl
• OpenUDID
• SBJson

Integration Point

AGE Invitation UI should literally take minutes to integrate because there is only one integration point to your existing app. You just need to decide when and how to trigger the AGE Invitation UI. E.g. Do you want to trigger it from a Share button or from an time or conditional event?

The following sample code snipet demonstrate launching AGE Invitation UI:

- (void)showListView
{
    HKInviteView *inviteView = [[HKInviteView alloc] initWithKey:@"Your-App-Key"
                                                     title:@"Suggested Contacts" 
                                              sendBtnLabel:@"Invite"];
    inviteView.delegate = self;
    [inviteView showInView:self.window animated:YES];
    [inviteView release];
}

Note that in above example, it is passing self as the delegate for receiving message from inviteView. The assigned delegate can receive two types of messages: invitedCount:count and invitedCancelled. invitedCount:count message is sent to delegate when app user invited one or more recipients so the host app can keep counter of invitation sent. The invitedCancelled message is sent to delegate when app user cancelled out of the AGE Invitation UI dialog.

Below sample code snippet illustrates implementation of the delegate protocol by the host app:

#pragma mark - HKInvite delegates
- (void)invitedCount:(NSInteger)count;
{
    _infoLabel.text = [NSString stringWithFormat:@"You have shared this app with %d friends", count];
}

- (void)inviteCancelled
{
    _infoLabel.text = @"You have cancelled from sharing";
}

#UI Customization You may customize the look and feel of the AGE Invitation UI specifically for your app. There are few things you can easily tweak with minimal effort:

• Dimension of AGE Invitation UI - You can change the value of #define POPLISTVIEW_SCREENINSET constant defined in HKInviteView.m
• Default contact image - You can replace the default image contact.png with another image you provide.

We understand that you may want a look and feel that is completely different from what AGE Invitation offers. You can still take advantage of AGE invitation API by integrating with AGE SDK.