Class: Referral

Referral

Methods

(static) getReferredUsers() → {Promise.<Array.<ReferredUser>>}

List of users referred by the current user.
Source:
Returns:
- A Promise of an array of referred users.
Type
Promise.<Array.<ReferredUser>>

Type Definitions

ReferredUser

Type:
  • Object
Properties:
Name Type Description
id string User ID
display_name string Username
avatar_url string URL to user's picture
auth_identities Object.<string, string> Custom identity key/value pairs, e.g "email":"hello@example.com"
install_date string The date the user installed the app, in RFC3339 format. Only applies to users who install the app from a GetSocial link.
install_channel string The channel the user installed the app from, e.g whatsapp.
Source: