Skip to content

Latest commit

 

History

History
62 lines (47 loc) · 1.75 KB

File metadata and controls

62 lines (47 loc) · 1.75 KB
title User invite
category 5f9705393c689a065c409b23
parentDoc 645213236f53a00d4daa9230
order 10
hidden false

User invite

1. setAppInviteOneLinkID(oneLinkID, callback)

Set the OneLink ID that should be used for User-Invite-API. The link that is generated for the user invite will use this OneLink ID as the base link ID.

parameter type description
oneLinkID string oneLinkID
callback function success callback
2. generateInviteLink(parameters, success, error)

A complete list of supported parameters is available here. Custom parameters can be passed using a userParams{} nested object, as in the example above.

parameter type description
parameters json parameters for Invite link
success function success callback (generated link)
error function error callback

Example:

// set the tamplate ID before you generate a link. Without it UserInvite won't work.
appsFlyer.setAppInviteOneLinkID('scVs', null);

// set the user invite params
appsFlyer.generateInviteLink(
 {
   channel: 'gmail',
   campaign: 'myCampaign',
   customerID: '1234',
   userParams: {
     deep_link_value : 'value', // deep link param
     deep_link_sub1 : 'sub1', // deep link param
     custom_param : 'custom',
     brandDomain:'myexample.com'
   },
 },
 (link) => {
   console.log(link);
 },
 (err) => {
   console.log(err);
 }
);