Cheetah CES Docs Portal

Navigation
Home
GitHub
Email
Corporate Site

JS SDK
Introduction
Getting Started
Cheetah Elements
Cheetah API Calls
Branding (Template Sets)
SSO
Visitor Token
Override UI Templates
JS SDK CDN

Cheetah API Calls

API

Methods

addPreferenceDomain(preference,callback)

Allows the user to add a member-supplied preference. This, of course, will only work if “Users can enter other values” option is enabled in marketing console.

1
	Stellar.api.addPreferenceDomain(preference, callback);

preference

object (required)

preference object

name (required) specific name of the preference
domain (required) member supplied domain value

callback

function (optional) 		callback function that handles the response

callActivities(callConfig, callback)

List of member activities information

1
	Stellar.api.callActivities(callConfig, callback);

callConfig

object (optional)

activity object

dataKey string (optional) data property name stored in Stellar.member.activities[dataKey]
activity_types string (optional) Comma-separated activity type names to filter by type/s
period string (optional) Default is 'last3m', see table Options for Period below for other options
period_start string (optional) Specify start date, i.e. 2014-01-01
period_end string (optional) Specify end date, i.e. 2014-01-01
with_details boolean (optional) Values can be true or false
with_line_items boolean (optional) Values can be true or false
earned_metrics string or array (optional) List of metric names either CSV string or array
with_metric_change boolean (optional) Values can be true or false
page numeric (optional) Offset page parameter
per_page numeric (optional) Number of items per page

callback

function (optional) 		callback function that handles the response

Options for Period
Value Description
alltime Activities all time
ytd Year to date
prevytd Year to date of previous n years e.g. prev1ytd. If today is 05/05/2017, then it would be 01/01/2016-05/05/2016. Used for period-to-period comparison.
mtd Month to date
prevmtd Same period as mtd but of previous n months e.g. prev1mtd. If today is 05/05/2017, then it would be 04/01/2017-04/05/2017. Used for period-to-period comparison.
wtd Week to date, starts on a Monday
prevwtd Same period as wtd but of previous n weeks e.g. prev1wtd. If today is 05/05/2017 (Friday), then it would be 04/24/2017-04/28/2017 (Monday to Friday). Used for period-to-period comparison.
qtd Quarter to date
prevqtd Same period as qtd but of previous n quarters e.g. prev1qtd. If today is 05/05/2017, then it would be 01/01/2017-02/05/2017 since previous quarter is from January to March. Used for period-to-period comparison.
lastd Last n days; e.g. last5d
lastw Last n weeks; e.g. last3w
lastm Last n months; e.g. last2m
prevd Previous n days; e.g. prev5d. The 5 days before the last 5 days. Used for period-to-period comparison.
prevw Previous n weeks; e.g. prev5w. The 5 weeks before the last 5 weeks. Used for period-to-period comparison.
prevm Previous n months; e.g. prev5m. The 5 months before the last 5 minths. Used for period-to-period comparison.

callChallenges(callConfig, callback)

Lists all challenges available to the user.

1
	Stellar.api.callChallenges(callConfig, callback);

callConfig

object (optional)

challenge object

id numeric (optional) If provided, it will return specific challenge by id
name string (optional) Same as id property, it will return specific challenge by internal name
dataKey string (optional) property key name stored in Stellar.member.challenges[dataKey]
staticSrcKey string (optional) External link for static challenges
dataType string (optional) If static value is provided it will use staticSrcKey property to load static challenge
type string (optional) Type of challenge. Values can be facebook, photo, video, view_content, survey or multi_question, update_profile
respondable boolean (optional) Return all respondable challenges. values can be true or false.
result_with_categories boolean (optional)

values can be true or false.

This parameter will return the category keys of the challenge in an array. NOTE: This parameter performs extra database queries. Please use sparingly.
category string (optional) Returns challenge by category. Key from the list of Challenge Categories
layout string (optional)

Content layout name

Default: medium_rectangle
html boolean (optional)

Returns the parsed HTML content layout. Values can be true or false.

Default: true
page numeric (optional)

Offset page parameter

Default: 1
per_page numeric (optional)

Number of items per page

Default: 15
sort_by string (optional)

Sort options. Values can be updated_at or publish_date or name or points

Default: updated_at
sort_dir string (optional)

Sort direction. Values can be desc or asc

Default: desc NOTE: default is desc if sort_by is date otherwise asc
show_as_alert boolean (optional) Values can be true or false. Returns challenges list that has show_as_alert = true

callback

function (optional) 		callback function that handles the response

callChallengesResponses(callConfig, callback)

Fetch Member challenges responses

1
	Stellar.api.callChallengesResponses(callConfig, callback);

callConfig

object

challenge response object properties

id numeric (optional) If provided, it will return specific challenge response by id
name string (optional) Same as id property, it will return specific challenge response by internal name
dataKey string (optional) property key name stored in Stellar.member.challengesResponses[dataKey]
category string (optional) Returns challenge responses by category
layout string (optional)

Content layout name

Default: medium_rectangle
html boolean (optional)

Returns the parsed HTML content layout. Values can be true or false.

Default: true
page numeric (optional)

Offset page parameter

Default: 1
per_page numeric (optional)

Number of items per page

Default: 15

callback

function (optional) 		callback function that handles the response

callCodesResponses(callConfig, callback)

Lists all code responses made by the user

1
	Stellar.api.callCodesResponses(callConfig, callback);

callConfig

object (optional)

codesResponses object properties

dataKey (optional) string (optional) data property name stored in Stellar.member.codesResponses[dataKey]
page numeric (optional)

Offset page parameter

Default: 1
per_page numeric (optional)

Number of items per page

Default: 15

callback

function (optional) 		callback function that handles the response

callContentBlocks(callConfig, callback)

Lists all content blocks

1
	Stellar.api.callContentBlocks(callConfig, callback);

callConfig

object

content blocks object properties

id numeric (optional) If provided, it will return specific content blocks by id
name string (optional) Same as id property, it will return specific content blocks by internal name
dataKey string (optional) property key name stored in Stellar.member.contentBlocks[dataKey]
layout string (optional)

Content layout name

Default: medium_rectangle
html boolean (optional)

Returns the parsed HTML content layout. Values can be true or false.

Default: true
page numeric (optional)

Offset page parameter

Default: 1
per_page numeric (optional)

Number of items per page

Default: 15

callback

function (optional) 		callback function that handles the response

callContentPages(callConfig, callback)

Lists all content pages

1
	Stellar.api.callContentPages(callConfig, callback);

callConfig

object

content pages object properties

id numeric (optional) If provided, it will return specific content page by id
name string (optional) Same as id property, it will return specific content page by internal name
dataKey string (optional) property key name stored in Stellar.member.contentPages[dataKey]
layout string (optional)

Content layout name

Default: medium_rectangle
html boolean (optional)

Returns the parsed HTML content layout. Values can be true or false.

Default: true
page numeric (optional)

Offset page parameter

Default: 1
per_page numeric (optional)

Number of items per page

Default: 15

callback

function (optional) 		callback function that handles the response

callContentTokens(callback, forceRefresh)

Fetch Content Tokens

1
	Stellar.api.callContentTokens(callback, forceRefresh);

callback

function (optional) 		callback function that handles the response

forceRefresh

boolean (optional) 		Default: true, it will always call new content tokens

callCountriesList(callback)

Fetch Countries with country codes

1
	Stellar.api.callCountriesList(callback);

callback

function (optional) 		callback function that handles the response

callFlagNewspost(callConfig, callback)

Allows user to flag a post feed

1
	Stellar.api.callFlagNewspost(callConfig, callback);

callConfig

object

call flag news post object properties

id (required) id of a specific news feed post user want to flag

callback

function (optional) 		callback function that handles the response

callGallery(callConfig, callback)

Fetch List of Newsfeed with attachments

1
	Stellar.api.callGallery(callConfig, callback);

config

object

preference object

id numeric (optional) If provided, it will return specific news feed by id
name string (optional) Same as id property, it will return specific news feed post by internal name
dataKey string (optional) property key name stored in Stellar.member.gallery[dataKey]

callback

function (optional) 		callback function that handles the response

callGiftcardBalance(callConfig, callback)

Check member’s giftcard balance

1
	Stellar.api.callGiftcardBalance(callConfig, callback);

callConfig

object (required)

callConfig properties

card_number (required) card number of the giftcard
pin (required) pin number of the giftcard

callback

function (optional) 		callback function that handles the response

callGiftcardClasses(callback)

Get list of available giftcards classes

1
	Stellar.api.callGiftcardClasses(callback);

callback

function (optional) 		callback function that handles the response

callGiftcardTransactions(callConfig, callback)

Get a list of giftcard transactions

1
	Stellar.api.callGiftcardTransactions(callConfig, callback);

callConfig

object (required)

callConfig properties

card_number (optional) giftcard card_number

callback

function (optional) 		callback function that handles the response

callGiftcardsPurchase(callConfig, callback)

Purchase a digital giftcard

1
	Stellar.api.callGiftcardsPurchase(callConfig, callback);

callConfig

object (required)

callConfig properties

amount (required) The amount to use for purchase
payment_method_nonce (required) Payment method nonce from Braintree
giftcard_class (required) Specifies a giftcard_class to purchase from; default: default_class seeded initially

callback

function (optional) 		callback function that handles the response

callGiftcardsToken(callback)

Get giftcard client_token

1
	Stellar.api.callGiftcardsToken(callback);

callback

function (optional) 		callback function that handles the response

callLeaderboards(callConfig, callback)

Fetch Leaderboards

1
	Stellar.api.callLeaderboards(callConfig, callback);

callConfig

object

callConfig properties

dataKey (optional) string (optional) data property name stored in Stellar.member.leaderboards[dataKey]
id numeric (optional) If provided, it will return specific challenge response by id
name string (optional) Same as id property, it will return specific challenge response by internal name
layout string (optional)

Content layout name

Default: medium_rectangle
html boolean (optional)

Returns the parsed HTML content layout. Values can be true or false.

Default: true
page numeric (optional)

Offset page parameter

Default: 1
per_page numeric (optional)

Number of items per page

Default: 15
endpoint string (optional)

Support leaderboard endpoints, such as top, group_mates, friends

Default: top
all_time_group_mates boolean (optional) Fetch users around the current user’s rank
group_id numeric (optional)

id of one of the current user’s groups.

Default: user’s primary group

callback

function (optional) 		callback function that handles the response

callLinkGiftcard(callConfig, callback)

Link a member to a gift card

1
	Stellar.api.callLinkGiftcard(callConfig, callback);

callConfig

object (required)

callConfig properties

card_number (required) card number of the giftcard
pin (required) pin number of the giftcard

callback

function (optional) 		callback function that handles the response

callMemberAttributesMetaData(callback, cache)

List of member profile metadata information

1
	Stellar.api.callMemberAttributesMetaData(callback, cache);

callback

function (optional) 		callback function that handles the response

cache

boolean (optional) 		Default: true, it will always call new content tokens

callMemberDocuments(callConfig, callback)

Fetch Member Documents

1
	Stellar.api.callMemberDocuments(callConfig, callback);

config

object

preference object

dataKey (optional) string (optional) data property name stored in Stellar.member.documents[dataKey]
id numeric (optional) If provided, it will return specific documents by id
name string (optional) Same as id property, it will return specific documents by internal name
page numeric (optional)

Offset page parameter

Default: 1
per_page numeric (optional)

Number of items per page

Default: 15

callback

function (optional) 		callback function that handles the response

callMemberGiftcards(callConfig, callback)

Get Member giftcards

1
	Stellar.api.callMemberGiftcards(callConfig, callback);

config

object

preference object

dataKey (optional) string (optional) data property name stored in Stellar.member.giftcards[dataKey]
id numeric (optional) If provided, it will return specific giftcards by id
name string (optional) Same as id property, it will return specific giftcards by internal name
page numeric (optional)

Offset page parameter

Default: 1
per_page numeric (optional)

Number of items per page

Default: 15
processing_status array (optional) all typs of giftcards status

callback

function (optional) 		callback function that handles the response

callMemberGroups(callConfig, callback)

Fetch all Groups that are visible to the member

1
	Stellar.api.callMemberGroups(callConfig, callback);

callConfig

object

callConfig properties

id numeric (optional) If provided, it will return specific groups by id
name string (optional) Same as id property, it will return member groups response by internal name
dataKey string (optional) property key name stored in Stellar.member.groups[dataKey]
page numeric (optional)

Offset page parameter

Default: 1
per_page numeric (optional)

Number of items per page

Default: 15

callback

function (optional) 		callback function that handles the response

callMemberGroupsJoined(callConfig, callback, cache)

Fetch Groups Member belongs to

1
	Stellar.api.callMemberGroupsJoined(callConfig, callback, cache)

callConfig

object

callConfig properties

dataKey string (optional) property key name stored in Stellar.member.challengesResponses[dataKey]
page numeric (optional)

Offset page parameter

Default: 1
per_page numeric (optional)

Number of items per page

Default: 15

callback

function (optional) 		callback function that handles the response

callMemberPreferences(callConfig, callback)

Lists all possible preference types that a member could modify to further tweak the kinds of offers or content that can be retrieved.

1
	Stellar.api.callMemberPreferences(callConfig, callback);

callConfig

object

callConfig properties

id numeric (optional) If provided, it will return specific preferences by id
name string (optional) Same as id property, it will return specific preferences by internal name
dataKey string (optional) property key name stored in Stellar.member.preferences[dataKey]
page numeric (optional)

Offset page parameter

Default: 1
per_page numeric (optional)

Number of items per page

Default: 15

callback

function (optional) 		callback function that handles the response

callMemberPreferencesMetaData(callback)

List of member preferences information metadata

1
	Stellar.api.callMemberPreferencesMetaData(callback);

callback

function (optional) 		callback function that handles the response

callMemberProfile(callback, forceRefresh)

Fetch Member Profile

1
	Stellar.api.callMemberProfile(callback, forceRefresh);

callback

function (optional) 		callback function that handles the response

cache

boolean (optional) 		Default: true, it will always call new content tokens

callMemberPunchcards(opts, callback)

Get Member Punchcards

1
	Stellar.api.callMemberPunchcards(callConfig, callback);

opts

object (required) 		opts properties Default: 1</td> Default: activeDefault: false</td> Default: desc</td> Default: desc</td> Default: true</td>
page string (required) Offset page parameter
per_page integer (optional) The number of results per page, defaults to program settings value
category string (optional) Punchcard by category
status string (optional) Filter by status, Values can be active, expired or completed
show_hidden boolean (optional) Shows invisible punch cards
sort_by string (optional) Sort options. Values can be effectivity_start, effectivity_end, expiration_date, update_date, publish_date, name, label, points or required_metric
details_sort_by string (optional) If a punchcard has named punches, this parameter sorts this list. Values can be created_at, updated_at or label
details_sort_dir string (optional) If a punchcard has named punches this sort spunch details direction. Values can be desc or asc
virtual boolean (optional) If set to true, eligible punch card types will be mixed in the response and will appear as empty punch cards
hide_expired boolean (optional) Hide expired punchcards
sort_dir string (optional) Sort direction. Values can be desc or asc
show_contents boolean (optional) Shows punch card contents

callback

function (optional) 		callback function that handles the response

callMemberSummary(callback, cache)

Fetch Member Summary

1
	Stellar.api.callMemberSummary(callback, cache);

callback

function (optional) 		callback function that handles the response

cache

boolean (optional) 		Default: true, it will always call new content tokens

callNewsfeed(callConfig, callback)

Fetch newsfeeds

1
	Stellar.api.callNewsfeed(callConfig, callback);

callConfig

object

callConfig properties

id numeric (optional) If provided, it will return specific newsfeed by id
name string (optional) Same as id property, it will return newsfeed response by internal name
dataKey string (optional) property key name stored in Stellar.member.newsfeed[dataKey]
staticSrcKey string (optional) External link for static newsfeed
dataType string (optional) If static value is provided it will use staticSrcKey property to load static newsfeed
layout string (optional)

Content layout name

Default: medium_rectangle
page numeric (optional)

Offset page parameter

Default: 1
per_page numeric (optional)

Number of items per page

Default: 15

callback

function (optional) 		callback function that handles the response

callOffers(callConfig, callback)

Lists all offers available to the user.

1
	Stellar.api.callOffers(callConfig, callback);

config

object

preference object

id numeric (optional) If provided, it will return specific offer by id
name string (optional) Same as id property, it will return specific offer by internal name
dataKey string (optional) property key name stored in Stellar.member.offers[dataKey]
category string (optional) Returns offers by category
layout string (optional)

Content layout name

Default: medium_rectangle
html boolean (optional)

Returns the parsed HTML content layout. Values can be true or false.

Default: true
respondable boolean (optional) Return all respondable challenges. values can be true or false.
page numeric (optional)

Offset page parameter

Default: 1
per_page numeric (optional)

Number of items per page

Default: 15
sort_by string (optional)

Sort options. Values can be updated_at or publish_date or name or points

Default: updated_at
sort_dir string (optional)

Sort direction. Values can be desc or asc

Default: desc NOTE: default is desc if sort_by is date otherwise asc
set string (optional) Internal name of a known Offer Set
placement string (optional) Internal name of a known Placement
campaign string (optional) Internal name of a known Campaign
offer_type string (optional) Return only matching offer_types based on offer_type parameter. Can be any of ‘barcode’, ‘certificate’, ‘coupon’, ‘url’ or ‘stellar’.
start_index Integer (optional) Start index of the available Offers subset. Used in conjunction with set.
end_index Integer (optional) End index of the available Offers subset. Used in conjunction with set.
result_with_categories boolean (optional)
offer_with_responses boolean (optional)
include_responses boolean (optional)
include_clipped boolean (optional)
show_clipped boolean (optional)
has_usable boolean (optional)
processing_status array (optional)
has_processing_status boolean (optional)
prioritized_category boolean (optional)

callback

function (optional) 		callback function that handles the response

callProfileIdentities(options)

List all member connected identities.

1
	Stellar.api.callProfileIdentities(options);

options

object

options properties

success function (optional) success callback that handles the response
error function (required) error callback that handles the error response

callRedeemRewards(callConfig, callback)

Allows the user to respond to a reward.

1
	Stellar.api.callRedeemRewards(callConfig, callback);

callConfig

object (required)

callConfig properties

id (required) Id of the reward user is reponding
formdata (required) formdata

callback

function (optional) 		callback function that handles the response

callReferralCodes(callback)

Get Member referal codes

1
	Stellar.api.callReferralCodes(callback);

callback

function (optional) 		callback function that handles the response

callRespondChallenge(callConfig, callback)

Respond to a challenge

1
	Stellar.api.callRespondChallenge(callConfig, callback);

callConfig

object

callConfig properties

id numeric (require) challenge id
name string (optional) challenge internal name
formdata formdata interface (required) formdata of the challenge

callback

function (optional) 		callback function that handles the response

callRespondCodes(callConfig, callback)

Respond a code

1
	Stellar.api.callRespondCodes(callConfig, callback);

callConfig

object

callConfig properties

value (required) code value

callback

function (optional) 		callback function that handles the response

callRewards(callConfig, callback)

Lists all rewards available to the user.

1
	Stellar.api.callRewards(callConfig, callback);

callConfig

object

callConfig properties

id numeric (optional) If provided, it will return specific reward by id
name string (optional) Same as id property, it will return specific reward by internal name
staticSrcKey string (optional) External link for static challenges
dataType string (optional) If static value is provided it will use staticSrcKey property to load static reward
dataKey string (optional) property key name stored in Stellar.member.rewards[dataKey]
category string (optional) Returns rewars by category
layout string (optional)

Content layout name

Default: medium_rectangle
html boolean (optional)

Returns the parsed HTML content layout. Values can be true or false.

Default: true
page numeric (optional)

Offset page parameter

Default: 1
per_page numeric (optional)

Number of items per page

Default: 15
sort_by string (optional)

Sort options. Values can be updated_at or publish_date or name or points

Default: updated_at
sort_dir string (optional)

Sort direction. Values can be desc or asc

Default: desc NOTE: default is desc if sort_by is date otherwise asc
result_with_categories boolean (optional)

values can be true or false.

This parameter will return the category keys of the challenge in an array. NOTE: This parameter performs extra database queries. Please use sparingly.

callback

function (optional) 		callback function that handles the response

callRewardsResponses(callConfig, callback)

Fetch Reward Responses

1
	Stellar.api.callRewardsResponses(callConfig, callback);

callConfig

object

callConfig properties

id numeric (optional) If provided, it will return specific challenge response by id
name string (optional) Same as id property, it will return specific challenge response by internal name
redemption_status string (optional) Values can be pending, processing, completed, cancelled or errored
layout string (optional)

Content layout name

Default: medium_rectangle
html boolean (optional)

Returns the parsed HTML content layout. Values can be true or false.

Default: true
page numeric (optional)

Offset page parameter

Default: 1
per_page numeric (optional)

Number of items per page

Default: 15

callback

function (optional) 		callback function that handles the response

callSocialConnect(callConfig, callback)

Connect Facebook/Google identity to Member account

1
	Stellar.api.callSocialConnect(callConfig, callback);

callConfig

object

callConfig properties

formdata token (optional) formdata interface with token name
network (required) social media network type facebook or google

callback

function (optional) 		callback function that handles the response

callSubmitReceipts(callConfig, callback)

Submit a receipt

1
	Stellar.api.callSubmitReceipts(callConfig, callback);

config

object

preference object

id (optional) challenge id
formdata (required) formdata of the receipt.

callback

function (optional) 		callback function that handles the response

callTopupGiftcard(callConfig, callback)

Reload giftcard

1
	Stellar.api.callTopupGiftcard(callConfig, callback);

config

object

preference object

amount (required) The amount to use for purchase
card_number (required) giftcard number you want to topup
payment_method_nonce (required) Payment method nonce from Braintree

callback

function (optional) 		callback function that handles the response

callUnlinkGiftcard(callConfig, callback)

Unlink a member to a gift card

1
	Stellar.api.callUnlinkGiftcard(callConfig, callback);

callConfig

object

callConfig properties

card_number (required) giftcard number you want to unlink

callback

function (optional) 		callback function that handles the response

callUpdateGiftcard(callConfig, callback)

Update Giftcard

1
	Stellar.api.callUpdateGiftcard(callConfig, callback);

config

object

preference object

card_number (optional) giftcard card_number you want to update
auto_reload boolean (optional) Flag to indicate if auto-reload is on or off
auto_reload boolean (optional) Flag to indicate if auto-reload is on or off
reload_threshold string (optional) Amount theshold to trigger auto-reload
reload_amount string (optional) Amount to add during auto-reload
name string (optional) name of the giftcard
description string (optional) description for giftcard
payment_method_nonce string (optional) String Payment method nonce from Braintree

callback

function (optional) 		callback function that handles the response

callUseReferralCode(callConfig, callback)

Use a referral code

1
	Stellar.api.callUseReferralCode(callConfig, callback);

callConfig

object

callConfig properties

referral_code (required) referral code of the member that referred the user

callback

function (optional) 		callback function that handles the response

changePassword(opts, callback)

Update Member Password

1
	Stellar.api.changePassword(opts, callback);

config

object

preference object

current_password string (required or optional) The user’s current password. Optional if member record’s encrypted_password password is blank
password string (required) The user’s new password
password_confirmation string (required) Confirmation of the user’s new password

callback

function (optional) 		callback function that handles the response

getNewspostFlags(callConfig, callback)

Lists all available flags to be assigned or set later on a news feed post/comment.

1
	Stellar.api.getNewspostFlags(callConfig, callback);

callConfig

object

callConfig properties

page numeric (optional)

Offset page parameter

Default: 1
per_page numeric (optional)

Number of items per page

Default: 15

callback

function (optional) 		callback function that handles the response

joinMemberGroup(group, callback)

Member to join an existing group

1
	Stellar.api.joinMemberGroup(group, callback);

group

object

group properties

id (required) id of the specific group

callback

function (optional) 		callback function that handles the response

respondOffer(callConfig, callback)

Respond to offer

1
	Stellar.api.respondOffer(callConfig, callback);

callConfig

object

callConfig properties

id (required) offer id

callback

function (optional) 		callback function that handles the response

updateAvatar(data, callback)

Allows the user to upload an avatar of type image/jpeg or image/png. Uploading a new avatar overwrites the existing one.

1
	Stellar.api.updateAvatar(data, callback);

data

object

data properties

formdata (required) avatar field image of the avatar

callback

function (optional) 		callback function that handles the response

updateMemberPreferences(data, callback)

Update Member Preferences

1
	Stellar.api.updateMemberPreferences(data, callback);

data

object

data properties

name (required) internal name of the preferences
domain (required) member supplied domain value

callback

function (optional) 		callback function that handles the response

updateMemberProfile(data, callback)

Update Member Profile

1
	Stellar.api.updateMemberProfile(data, callback);

data

object

data object

formdata (required) formdata interface with profile attributes name/values

callback

function (optional) 		callback function that handles the response

getLoginStatus

Check user if logged in or not

1
	Stellar.getLoginStatus();

login(data, callback)

Login Member

1
	Stellar.login(data, callback);

config

object

data properties

[identifier] (required) Please see list of identifiers below
password (required) The user’s password

callback

function (optional) 		callback function that handles the response
Identifiers
Name Description
email Email attribute
integration_id Integration ID attribute
member_id Member ID attribute
card_id Card ID attribute
username The username attribute
mobile_phone Mobile Phone attribute if ProgramSetting.login_with_mobile_phone is enabled

fbLogin(opts, callback)

Signin/Singup via Facebook

1
	Stellar.fbLogin

opts

object

preference object

mode (optional) mode of login

callback

function (optional) 		callback function that handles the response

logout(callback)

Logout Member

1
	Stellar.logout();

callback

function (optional) 		callback function that handles the response

refresh

Refresh ui widgets

1
	Stellar.ui.refresh();

refreshSignup

Refresh Signup Form

1
   Stellar.ui.refreshSignup();

renderStatic

Refresh static and frame widgets

1
   Stellar.ui.renderStatic();

signup(opts, callback)

Signup User

1
   Stellar.signup(opts, callback)

opts

object (required) 		opts properties
email string (required) The user’s email address
password string (required) The user’s password to be used when logging in
pass_confirmation string (required) Confirms user's password is correct
first_name string (required) The user’s first name
last_name string (required) The user’s last name

callback

function (optional) 		callback function that handles the response




Previous Cheetah Elements