Guides
Start typing to search…

Invites Guide

An additional deep linking function of the StreamLayer SDK is the way we integrate Branch.io to invite users. Please see the documentation in the StreamLayer Studio section of this document.

  1. Create a new account on Branch.io or use your existing account. Integrate Branch SDK according to official documentation.
  2. Enable universal linking. To do this you will need to enable Associated Domains in the Apple Member Center for your Bundle ID under the Capabilities tab of your project (see screenshot below).

Note to support app links, the keyword 'applinks' must be before the domain, like the example shows in the screenshot above.


  1. Add branch key support by copying the branch_key value into info.plist. You can find your Branch key by logging into your Branch Dashboard


The 'branch_key' value is a string you will need to add to your info.plist as shown in the screenshot below.


  1. Add BranchIO link domain support by copying your domain name from your Branch Dashboard

Back in Xcode, switch to the Capabilities tab and in the domain section click on the + to add the new domain in the format as shown below. Please make sure that xxxx matches your domain EXACTLY.

applinks:xxxx.app.link
applinks:xxxx-alternate.app.link
applinks:xxxx.test-app.link
applinks:xxxx-alternate.test-app.link

This action will add the following keys to your info.plist


  1. Call Branch.getInstance().initSession(launchOptions: launchOptions) after StreamLayer SDK has been initialized in the:
func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication .LaunchOptionsKey: Any]?
  ) -> Bool {
  
  /// your code
  /// StreamLayer SDK initialization
    Branch.getInstance().initSession(launchOptions: launchOptions) { (params, _) in
      if StreamLayer.handleDeepLink(params: params) {
        // handled by StreamLayer
      } else {
        // otherwise, handle the link inside you app
      }
    }
  return true
}

  1. The final step is registering Branch.io in the project by implementing the following function call in AppDelegate.swift
// MARK: App Links
  func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey: Any] = [:]) -> Bool {
    return Branch.getInstance().application(app, open: url, options: options)
  }

  // MARK: Universal Links
  func application(_ application: UIApplication,
                   continue userActivity: NSUserActivity,
                   restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
    return Branch.getInstance().continue(userActivity)
  }

There is one more step to complete the integration process. If you would like a new users that are invited to a StreamLayer host application Watch Party, your application will have to implement the following function in your AppDelegate class

func inviteHandled(invite: SLRInviteData, completion: @escaping (_ cancel: Bool) -> Void)

SLRInviteData

StreamLayer notifies the host application about accepted Watch Party invites and associated streamid (if any) that is associated with a given Watch Party. It is expected that the host application will navigate to the appropriate streaming page and will call a complete handler that will indicate to the StreamLayer SDK that is time to show the prompt to join the Watch Party now.

The incoming data to the StreamLayer SDK is found in the SLRInviteData type. It includes all of the information that the host application needs about the user that sent invite, the event of the stream, and the Watch Party. See the parameters in the code snippet below:

/// Contains stream id that was associated with a watch party at the time of creation
public let eventId: String?
/// Contains watch party group id
public let watchPartyGroupId: String?
/// Contains user id that created the invite
public let userId: String
/// Contains tinode user id that created the invite
public let tinodeUserId: String
/// Contains public username of the user who created the invite
public let username: String
/// Contains URL to the avatar of the user who created the invite
public let avatar: URL?

Additional Resources

Please see this section of the demo app for further details.

Additional Branch.io integration tips can be found here

Updated 6 months ago