Initialize Referd User Profile

Show your users's profile including all details and progress on your iOS app.

Showing the Referd widget on your mobile application is slightly different than showing it on the website. You have two options; first, if you want to design your customer interface, you will use our set of REST APIs. The other option as this section elaborates, is through using our iOS SDK.

Using the SDK, you can open the Referd user profile from a button in your app, programmatically when someone does something, or from a persistent button that sits over your app’s UI.

When you trigger the Referd user profile, your user is presented with a home screen. This is configurable inside Referd to change how it looks and what’s presented.

From there, your user can check his progress across different Referd programs as per your configurations.

Referd’s views are accessible through the code below. You just need to use it on any button action.

Register User

The Register User method is used to create or update user accounts at Referd. This API call should be made when the user successfully logs in or whenever there are updates to the user's account information.

// After completion block is called from init the SDK, you can register player

self.gameball?.registerPlayer(
    playerUniqueId: "UNIQUE_PLAYER_ID", // The only required field
    deviceToken: "firebase_token",
    playerAttributes: [
        "custom_attribute": "custom_value",
        "country": "Egypt"
    ],
    completion: { (playerId, error) in // Completion block after registeration is complete
    // You either get Referd playerId or error
})

The below is description of register user parameters

Parameter	Type	Required	Description
playerUniqueId	string	Yes	Unique identifier for the user in your database. Could be database ID, random string, email or anything that uniquely identifies the user.
deviceToken	string	No	Firebase token obtained from Firebase SDK to avail Referd to send notifications to the user.
playerAttributes	dictionary	No	Any custom parameters you want to attach to the user.
completion	Completion block	Yes	Returns either Referd user ID or error in registration.

Every time the Referd View is initialized with a new PlayerUniqueId , the user profile is created or updated at Referd side. You may consider enriching your Referd's user profile with attributes that are not available to the UI by using server side Create\Update User API

Choose an Unchangeable Player Unique ID

Referd user profile gets created using the playerUniqueId. It is highly recommended to have the unique ID as an identifier that would NEVER be changed. If this unique ID changes for a given user , you risk losing all original data for that user on Referd. Accordingly, it is NOT recommended to use email address or mobile number as the unique ID as both can be changed by the user at anytime.

To generate Device Token (FCM Token) you can use Firebase latest SDK you can put this code in AppDelegate or your ViewController to get the token and once you get the token you can call the above method to register and Launch Referd

// Based on latest Firebase documentation you can generate token by

       Messaging.messaging().token { token, error in
          if let error = error {
            print("Error fetching FCM registration token: \(error)")
          } else if let token = token {
            print("FCM registration token: \(token)")
              // you can save the token anyware then use it while launching Referd
          }
        }

Once the APIKey and playerUniqueId have been registered, Referd views can be made visible to the user. So ideally, registerPlayer is called after the completion block of the SDK initalization.

Show the widget

To show the Referd user profile that contains the user details, user challenges, and the leaderboard use the showProfile SDK function.

@IBAction func didTapLaunch(_ sender: UIButton) {
    gameball?.showProfile(
        playerUniqueId: "UNIQUE_PLAYER_ID",
        openDetail: "custom_detail",
        hideNavigation: false,
        completion: { viewController, errorMessage in
            guard let gameBallVC = viewController else {return}
            gameBallVC.modalPresentationStyle = .fullScreen
            self.present(gameBallVC, animated: true, completion: nil)
        }
    )
}

Upon user action, you can use showProfile function to show the widget. The completion block tells you that the viewController is ready and you can present it the way you want, for example by default if you don't explicitly specify modalPresentationStyle, it'll appear as modal. If you want it full screen, you can specify it like the above example.

Parameter	Type	Required	Description
playerUniqueId	String	Required	Unique identifier for the user in your database.Could be database ID, random string, email or anything that uniquely identifies the user.
openDetail	String	Optional	Specify if you want the widget to open on a specific view. Possible values are details_referral
hideNavigation	Boolean	Optional	Set to true to stop widget navigation otherwise leave as null

You may also check the sample project here to view full implementation.