GetSocial iOS SDK Upgrade Guide¶

For a minor version update, please check version-specific upgrade instructions in the Changelog.

If you are integrating from scratch, please follow Getting Started with GetSocial iOS SDK guide.

Upgrade from SDK 6 to SDK 7¶

In your Xcode project go to Project Settings → select target you want to modify → Build Phases tab.

Create new Run Script phase with the content:

"$PROJECT_DIR/getsocial-sdk7.sh --app-id=[your-getsocial-app-id] --framework-version=[latest]"

Build your project.

Configuration¶

Most of the GetSocial settings are moved to a single getsocial.json file which could be used across all platforms. You can read more about this configuration file.

Open getsocial.json, which should reside in the root directory of your project and generated automatically by our script.. in the key name means it is inner json object, e.g. pushNotifications.autoRegister in json file should be translated to:

// getsocial.json
{
    ...
    "pushNotifications": {
        ...
        "autoRegister": true
    }
}

iOS Installer script¶

framework-version, use-ui and app-id are still used as parameter for getsocial-sdk7.sh.

getsocial.sh parameter	getsocial.json key
autoInit	autoInit
uiConfig	uiConfig
autoRegisterForPush	pushNotifications.autoRegister
foregroundNotifications	pushNotifications.foreground
disableFacebookReferralCheck	disableFacebookReferralCheck

CocoaPods¶

Update GetSocial SDK version to 7.0.0-alpha-0.0.2 in your Podfile
Execute pod update

Manual Integration¶

Download the latest GetSocial frameworks from the Downloads page.
Overwrite your existing instances with the new version.

Methods¶

All methods that had a CompletionCallback, Callback or other callback mechanism now have two different parameters for callbacks: ResultCallback and SuccessCallback are called if operation succeeds and FailureCallback is called in case of error.

All methods that supported operations by GetSocial User ID now support both GetSocial ID and Identity ID. This is encapsulated in UserId and UserIdList classes for a single and multiple users respectively. Read more about this.

All methods that support pagination are now unified and use the same approach with classes PagingQuery and PagingResult. Read more about this.

Initialization¶

whenInitialized is changed to addOnInitializedListener. You can add multiple listeners.

SDK v6 Method	SDK v7 Method
GetSocial.whenInitialized	GetSocial.addOnInitializedListener

User Management¶

Current User¶

All methods related to the current user were in GetSocial.User class. Now you can get an object of CurrentUser using GetSocial.currentUser(). This method returns nil if SDK is not initialized. When you update user properties like avatar or display name, the object is automatically updated after operation succeeded. If you switch or reset user, this object is changed to a new one. You will receive the new object in OnCurrentUserChangedListener or you can call GetSocial.currentUser() again and get the new instance.

All getters should be called on GetSocial.crrentUser() instance.
All setters are removed and you should use a single method GetSocial.getCurrentUser().updateDetails(...) instead.

GetSocial.addOnCurrentUserChangedListener can be called multiple times with different listeners. It returns a String - listener ID - which can be used in GetSocial.removeOnCurrentUserChangedListener if you want to remove a certain listener.

SDK v6 Method	SDK v7 Method
GetSocial.User.get*	GetSocial.currentUser().*
GetSocial.User.set*	GetSocial.currentUser().updateDetails
GetSocial.User.addAuthIdentity	GetSocial.currentUser().addIdentity
GetSocial.User.removeAuthIdentity	GetSocial.currentUser().removeIdentity
GetSocial.User.switchUser	GetSocial.switchUser
GetSocial.User.reset	GetSocial.resetUser
GetSocial.User.setOnUserChangedListener	GetSocial.addOnCurrentUserChangedListener
GetSocial.User.removeOnUserChangedListener	GetSocial.removeOnCurrentUserChangedListener

Search Users¶

findUsers returned only the first page of matching users. New Communities.users method supports pagination.
You can also get a number of users that match a certain query using Communities.usersCount.

SDK v6 Method	SDK v7 Method
GetSocial.userWithId(id), GetSocial.userWithId(id, providerId)	Communities.user(UserId, ResultCallback, FailureCallback)
GetSocial.usersWithIds(ids, providerId)	Communities.users(UserIdList, ResultCallback<[String: User]>, FailureCallback)
GetSocial.findUsers	Communities.users(UsersPagingQuery, ResultCallback, FailureCallback)

Activities¶

All activities related methods are moved to Communities class.
Like concept is now extended to Reaction and supports multiple reactions, like is one of them.

All GetSocial.post* methods are replaced with a single Communities.postActivity method with PostActivityTarget parameter. Read more about new features in Feeds 2.0.

SDK v6 Method	SDK v7 Method
GetSocial.postActivityToFeed, GetSocial.postActivityToGlobalFeed, GetSocial.postCommentToActivity	Communities.postActivity
GetSocial.likeActivity(…, true, …)	Communities.addReaction
GetSocial.likeActivity(…, false, …)	Communities.removeReaction
GetSocial.getActivityLikers	Communities.reactions
GetSocial.findTags	Communities.tags

Notifications¶

All notifications related methods are moved to Notifications class.

NotificationListener is now split into two: OnNotificationClickedListener and OnNoticationReceivedListener.

OnNotificationReceivedListener is called when application is in foreground and GetSocial Push Notification is received. Note that now it is called even if notifications in foreground are enabled.

Enable Click Listener

In order to make OnNotificationClickedListener being invoked, you have to set pushNotifications.customListener to true in getsocial.json:

// getsocial.json
{
    ...
    "pushNotifications": {
        ...
        "customListener": true
    }
}

OnNotificationClickedListener does not need to return a boolean anymore. If you have a custom listener and want to invoke a default behaviour, you should call GetSocial.handle(_ action) in places where you would return false in SDK 6.

SDK v6 Method	SDK v7 Method
GetSocial.registerForPushNotifications	Notifications.registerDevice
GetSocial.setNotificationListener	Notifications.setOnNotificationClickedListener, Notifications.setOnNotificationReceivedListener
GetSocial.setPushNotificationTokenListener	Notifications.setOnTokenReceivedListener
GetSocial.User.getNotifications	Notifications.get
GetSocial.User.getNotificationsCount	Notifications.getCount
GetSocial.User.sendNotification	Notifications.send
GetSocial.User.setNotificationsStatus	Notifications.setStatus
GetSocial.User.setPushNotificationsEnabled	Notifications.setPushNotificationsEnabled
GetSocial.User.isPushNotificationsEnabled	Notifications.arePushNotificationsEnabled

Invites¶

All invites related methods are moved to Invites class.

Getting list of available invite channels is now asynchronous operation.

To get referral data, you now have a ReferralDataListener, which will be called every time when the new referral data appears after clicking on the link, whether on application launch or if application was running before.

SDK v6 Method	SDK v7 Method
GetSocial.isInviteChannelAvailable	Removed. You can get the list of available invite channels and check if invite channel is there.
GetSocial.getInviteChannels	Invites.getAvailableChannels
GetSocial.sendInvite	Invites.send
GetSocial.registerInviteChannelPlugin	Invites.registerPlugin
GetSocial.getReferralData	Invites.setReferralDataListener
GetSocial.clearReferralData	Removed. You don’t need to clear referral data anymore, as you will receive only the new referral data in the listener.

Analytics¶

All analytics methods are moved to Analytics class.

SDK v6 Method	SDK v7 Method
GetSocial.trackCustomEvent	Analytics.trackCustomEvent
GetSocial.trackPurchaseEvent	Analytics.trackPurchase

All promo codes methods are moved to PromoCodes class.

SDK v6 Method	SDK v7 Method
GetSocial.createPromoCode	PromoCodes.create
GetSocial.getPromoCode	PromoCodes.get
GetSocial.claimPromoCode	PromoCodes.claim

Give us your feedback! Was this article helpful?

😀 🙁