Send Your First Smart Invite on iOS

Prerequisite

Send Invites

GetSocial SDK provides two ways to send Smart Invites: using our data API or via provided GetSocial UI.

Smart Invites are powered by Smart Links. Internally we generate a unique Smart Link for each invitation and attach information about the sender to the Smart Link.

Also, we expose API to attach any string-string key-value pairs to the Smart Link. Receiving user can get the data attached to the Smart Link on the app start, even if an app was just installed from the store.

Check the code below for examples.

Using GetSocial Data API

The code below shows how to send Smart Invite with custom data attached via a Facebook channel. All supported Invite Channels are listed in GetSocialConstants.h file with GetSocial_InviteChannelPluginId_ prefix.

Reserved Parameters

Keys starting with $ are reserved by GetSocial. See here for a reference of all such keys.

Supported value types

The linkParams dictionary supports NSString* values for custom data, other types will be ignored.

  1. Create an NSMutableDictionary object with key-value pairs you want to attach to the Smart Link:

    1
    2
    3
    NSMutableDictionary* linkParams = [NSMutableDictionary dictionary];
    [linkParams setValue:@"value1" forKey:@"key1"];
    [linkParams setValue:@"value2" forKey:@"key2"];
    
  2. Use GetSocial Data API to send invitation with custom referral data attached:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    GetSocialMutableInviteContent* inviteContent = [GetSocialMutableInviteContent new];
    
    [GetSocial sendInviteWithChannelId:GetSocial_InviteChannelPluginId_Facebook inviteContent:inviteContent linkParams:linkParams success:^{
        NSLog(@"Invitation with referral data via FACEBOOK was sent");
    } cancel:^{
        NSLog(@"Invitation with referral data via FACEBOOK was cancelled");
    } failure:^(NSError * _Nonnull error) {
        NSLog(@"Invitation with referral data via FACEBOOK failed, error: %@", error.description);
    }];
    

Facebook Share Dialog will be presented as a result:

GetSocial Smart Ivites View

Open GetSocial Smart Invites View

GetSocial UI library provide a view that lists all Smart Invite channels available on the device and enabled on the GetSocial Dashboard.

To send an invite with custom data attached using GetSocial UI:

Reserved Parameters

Keys starting with $ are reserved by GetSocial. See here for a reference of all such keys.

Supported value types

The linkParams dictionary supports NSString* values for custom data, other types will be ignored.

  1. Create an NSMutableDictionary object with key-value pairs you want to attach to the Smart Link:

    1
    2
    3
    NSMutableDictionary* linkParams = [NSMutableDictionary dictionary];
    [linkParams setValue:@"value1" forKey:@"key1"];
    [linkParams setValue:@"value2" forKey:@"key2"];
    
  2. Create and show the view:

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    GetSocialUIInvitesView* invitesView = [GetSocialUI createInvitesView];
    
    [invitesView setLinkParams:linkParams];
    [invitesView setHandlerForInvitesSent:^(NSString * _Nonnull channelId) {
        NSLog(@"Invitation via %@ was sent", channelId);
    } cancel:^(NSString * _Nonnull channelId) {
        NSLog(@"Invitation via %@ was cancelled", channelId);
    } failure:^(NSString * _Nonnull channelId, NSError * _Nonnull error) {
        NSLog(@"Invitation via %@ failed, error: %@", channelId, error.description);
    }];
    
    BOOL wasShown = [invitesView show];
    NSLog(@"GetSocial Smart Invites UI was shown: %d", wasShown);
    

You will see the following view on your screen:

GetSocial Smart Ivites View

Retrieve Referral Data

Smart Invites are powered by Smart Links. To retrieve data attached to the invitation you have to follow Receiving Smart Links guide.

Retrieve Referred Users

Using GetSocial data API you can retrieve the list of users who installed application from the invitations sent by current user:

1
2
3
4
5
6
7
[GetSocial referredUsersWithSuccess:^(NSArray<GetSocialReferredUser *> * _Nonnull referredUsers) {
    if (referredUsers.count > 0) {
        // current user invited others to the app
    }
} failure:^(NSError * _Nonnull error) {
       NSLog(@"Failed to retrieve Referred Users, error: %@", error.description);
}];

GetSocialReferredUser object contains user details, including installationDate, which is the date when the invited user installed the app.

This way, for example, you can reward your users for inviting other users:

  1. Read last reward check date from local storage.
  2. If GetSocialReferredUser object installationDate value is after reward check date, you can give the reward.
  3. Update reward check date to current date.

Next Steps

Give us your feedback! Was this article helpful?

😀 🙁