Documentation

Modules: collectionIds

Contains ids for collections (lists of entities). Some collections have no parameters and are exported as constant strings. Collections that have parameters are exported as functions that receive parameters and return a string id.

Source:

Members

<static, constant> BANNERS :string

Type:
  • string
Source:

<static, constant> BOOKMARKS

User bookmarks

Source:

<static, constant> CAMPAIGNS :string

Type:
  • string
Source:

<static, constant> COLLECTION_WILDCARD :string

A wildcard collection id. When this is used instead of a collection id, the action will affect all collections which are currently in state

Type:
  • string
Source:

<static, constant> COMMUNITY_TAGS :string

Tags in Community

Type:
  • string
Source:

<static, constant> COVER_PHOTOS :string

Cover photos which can be picked for a users profile

Type:
  • string
Source:

<static, constant> FAVOURITES

User favourites

Source:

<static, constant> FEATURES :string

Type:
  • string
Source:

<static, constant> FREE_FOOD_ALLOWANCE :string

Free Food Allowance available for syns estimator

Type:
  • string
Source:

<static, constant> IRISH_COUNTIES :string

Irish counties available during the group registration flow

Type:
  • string
Source:

<static, constant> NOTIFICATIONS :string

User notifications (globally available)

Type:
  • string
Source:

<static, constant> PUBLIC_RECIPES :string

PublicRecipes

Type:
  • string
Source:

<static, constant> RECIPES :string

Type:
  • string
Source:

<static, constant> RECOMMENDED_READING_META_DATA :string

List of meta data for each of the different reading sections

Type:
  • string
Source:

<static, constant> SUBSCRIPTION_PACKAGES :string

Subscription packages available for purchase when creating an account

Type:
  • string
Source:

<static, constant> SUCCESS_STORIES :string

Type:
  • string
Source:

<static, constant> WEEKS_META_DATA :string

List of data for each week of the 12 week program

Type:
  • string
Source:

Methods

activities(params)

Collection of user logged activities for a specific user

Parameters:
Name Type Description
params object
Properties
Name Type Description
userId string
Source:

activityGoals(params)

Collection of Body Magic awards for a specific user

Parameters:
Name Type Description
params object
Properties
Name Type Description
userId string
startDate string
Source:

activityTypes(params)

Collection of search result activity types for a specific user

Parameters:
Name Type Description
params object
Properties
Name Type Description
limit number
profileId string
searchText string
Source:

awardsCollectionId(params)

The collection of awards for a specific user

Parameters:
Name Type Description
params object
Properties
Name Type Description
userId string
Source:

communityCommentsCollectionId(params)

The collection of comments on a discussion or another comment

Parameters:
Name Type Description
params object
Properties
Name Type Argument Description
parentId string

The id of the parent discussion or comment
parentIsComment boolean <optional>

true if the parent is a comment. Otherwise the parent is a discussion
deeplink boolean <optional>

true if the this is a collection for a deeplink, meaning that the pagination of this collection will be a partition rather than offset-based pagination
Source:

communityGroupPostsCollectionId(params)

The collection of posts visible on the community group page

Parameters:
Name Type Description
params object
Properties
Name Type Argument Description
slug string <optional>

Slug of the community group
tags number <optional>

A number representing the active tag filters (bitwise flag)
onlyCurrentUser boolean <optional>

true if the 'only me' filter is active
postType string <optional>

Filter by post type
containerId string <optional>

Id of the containing post
sort string <optional>

The sorting type used
Source:

communityPostsCollectionId(params)

The collection of posts visible on the CommunityOverview page

Parameters:
Name Type Description
params object
Properties
Name Type Argument Description
tags number <optional>

A number representing the active tag filters (bitwise flag)
onlyCurrentUser boolean <optional>

true if the 'only me' filter is active
sort string <optional>

The sorting type used
Source:

communityRelatedPostsCollectionId(params)

The collection of posts related to a given post

Parameters:
Name Type Description
params object
Properties
Name Type Description
postId string

The id of the post
Source:

customFoodResultsCollectionId(params)

List of custom food result from a given search query

Parameters:
Name Type Description
params object
Properties
Name Type Description
filters string
limit number
offset number
query string
Source:

foodResultsCollectionId(params)

List of food result from a given search query

Parameters:
Name Type Description
params object
Properties
Name Type Description
filters string
limit number
offset number
query string
Source:

goalsCollectionId(params)

The collection of goals for a specific user

Parameters:
Name Type Description
params object
Properties
Name Type Description
userId string
Source:

groupPostsCollectionId(params)

The collection of posts in a specific Slimming Group

Parameters:
Name Type Description
params object
Properties
Name Type Description
containerId string

The id of the Slimming Group
Source:

mealCategoriesCollectionId(params)

Collection of meal categories for a specific user

Parameters:
Name Type Description
params object
Properties
Name Type Description
userId string
limit number
Source:

mealCategoriesCollectionId(params)

Collection of healthy extra search

Parameters:
Name Type Description
params object
Properties
Name Type Description
userId string
limit number
Source:

menuPurchaseResultsCollectionId(params)

Purchase result for member account setting menu display

Parameters:
Name Type Description
params object
Source:

parameterizedCollectionId(collectionName, paramNames)

Returns a function that generates a collection id with the given collection name and parameters.

Parameters:
Name Type Description
collectionName string

the name of the collection
paramNames Array.<string>

the names of the parameters
Source:
Returns:

A function that accepts an object with parameters and returns a string collection ID.

Type
function
Example
export const fooCollectionId = parameterizedCollectionId(
  'foo',
  ['sort', 'category']
);

// usage, get collection id for foo collection with sort==1 and category==10
fooCollectionId({ sort: 1, category: 10 });
// usage, foo collection with wildcard, applies to all foo collections regardless of parameters
fooCollectionId();

productCollectionId(params)

Collection of products

Parameters:
Name Type Description
params object
Properties
Name Type Description
limit number
category number
Source:

productCollectionId(params)

Collection of products

Parameters:
Name Type Description
params object
Properties
Name Type Description
limit number
category number
Source:

promotedSearchResultsCollectionId(params)

List of promoted search result from a given search query

Parameters:
Name Type Description
params object
Source:

purchaseResultsCollectionId(params)

List of purchase result

Parameters:
Name Type Description
params object
Source:

returnResultsCollectionId(params)

List of return result

Parameters:
Name Type Description
params object
Source:

searchResultsCollectionId(params)

List of search result from a given search query

Parameters:
Name Type Description
params object
Source:

slimmingGroupsCollectionId(params)

The collection of slimming groups in the MySlimmingGroups onboarder

Parameters:
Name Type Description
params object
Properties
Name Type Argument Description
day number <optional>

A number representing the day of the week
timeSlot number <optional>

timeslot on a day (morning/afternoon/evening)
timeZoneId string <optional>

A country/city string to represent timezone (America/Chicago)
Source: