App Codex Version: 1.0.0

Type Definitions

Type Definitions reveal insight into the type data used by hooks, including which data you need to pass to and from each hook.

Object

# ActionButton

Properties:
Name Type Attributes Description
icon Number <nullable>

Image loaded via "require"
label String

Translatable string
doFunction DoFunction

Redux action to dispatch or simple function to execute
getError GetError <nullable>

Redux action to dispatch or simple function to execute
isNavigation Boolean <nullable>

If true button will not show spinner when changing state
promptMessage String <nullable>

If set prompt popup with input will show on action executed
promptDefaultValue function
Object

# ActionButtonProps

Properties:
Name Type Description
global Object

App global style
button Object

Default actions when button is pressed
color Object

Color for icon
style Object
t TranslationFunction
withLabel Boolean

Returns true if button has label
labelStyle Object
loading Boolean

Returns true if component is still loading
first Boolean

Returns true if button is first in the list
last Boolean

Returns true if button is last in the list
highlight Boolean

Returns true if button is highlighted
"just-me" | "friends" | "groups" | "favorites" | "mentions" | "following"

# ActivitiesFilter

Object

# ActivitiesItemWidgetComponentProps

Properties:
Name Type Description
user User
item ActivityViewModel
global Object

App global style
colors Object

App colors
tagsStyles Object

Tag default styles
contentWrapperStyle Object

Default content wrapper for activity item
style Object

Default style for activity item wrapper
attemptDeepLink function

Helper function which is used for deeplinking
avatarSize Number

Returns default size of avatar
hidePrivacy Boolean

Returns true if privacy button should be hidden
"-1" | "new_member" | "new_avatar" | "updated_profile" | "activity_update" | "activity_comment" | "friendship_accepted" | "friendship_created" | "created_group" | "joined_group" | "group_details_updated" | "bbp_topic_create" | "bbp_reply_create"

# ActivitiesSubFilter

Object

# ActivitiesWidgetComponentProps

Properties:
Name Type Description
bgColor String

Background color of the widgets container
title String

Title for the widgets container
activities Array.<Object>

Contains activities object with fields such as name, date, media, title etc.
onActivitiesSeeAllClick function

Function that will redirect to the activities list
t TranslationFunction
navigation NavigationService
Object

# ActivitiesWidgetTitleProps

Properties:
Name Type Description
global Object

App global style
colors Object

App colors
icon String
title String

Title of the widget
textColor String
seeMoreHidden Boolean

Returns false by default
seeMoreHandler function

Helper function that redirects to appropriate screen
seeMoreLabel String

Default label of "See More" button
activities Array.<ActivityViewModel>
t TranslationFunction
navigation NavigationService

# ActivityButtonsFilterCallback(buttons, item, actionsList, settings) → {Array.<Button>}

Parameters:
Name Type Description
buttons Array.<Button>

Current buttons array
item ActivityViewModel

Activity view model
actionsList Array.<string>

List of allowed actions
settings Object

Settings object got from API

Changed array of buttons

Array.<Button>
Object

# ActivityHeaderComponentProps

Properties:
Name Type Description
user User
item ActivityViewModel
global Object

App global style
colors Object

App colors
tagsStyles Object

Tag default styles
contentWrapperStyle Object

Default content wrapper for activity item
style Object

Default style for activity item wrapper
attemptDeepLink function

Helper function which is used for deep linking when activity is pressed
avatarSize Number

Returns default size of avatar
hidePrivacy Boolean

Returns true if privacy button should be hidden
onChangePrivacy function

Helper function which is used for changing the activity's privacy
Object

# ActivityLikeComponentProps

Properties:
Name Type Description
icon LocalImageSource
pressHandler function

Mark activity as favorite
tintColor String

Default tint color of activity like button. Changes value depending on if activity is liked or not.
touchableStyle Array.<Object>

Default styling of the like button container
style Object

Default styling of the like button
renderText function

Returns JSX to display text beside the like button
ActivityViewModel
Object

# ActivityModelDependencies

Properties:
Name Type Description
config Object

App configuration object
t TranslationFunction

Translation function
actions Object

Object with activity actions
isProfileList boolean

Flag that tells if it's the current screen under profile
currentUser User

Logged in user
toUserBasedOnSettings ToUserBasedOnSettings

Navigate to user function
"-1" | "new_member" | "new_avatar" | "updated_profile" | "activity_update" | "activity_comment" | "friendship_accepted" | "friendship_created" | "created_group" | "joined_group" | "group_details_updated" | "bbp_topic_create" | "bbp_reply_create"

# ActivitySubFilter

Object

# ActivityViewModel

Properties:
Name Type Description
id Number

Activity id
action String

Description of activity update
component String

Info on where the activity came from such as "groups", "activity"
user Object

User's id and name
content String

Html content of activity to display
contentStripped String

Content of activity to display stripped of html tags
parentId Number

Used for activity relative id
firstParentId Number

Used for activity relative id
type String

Type of activity. Ex: "activity_update"
avatarUrl String

Url to user's avatar
can_report Boolean

True if user can report activity
reported Boolean

True if user has already reported the activity
isMine Boolean

True if activity is from user
can_comment Boolean

True if user can comment
can_delete Boolean

True if user can delete the activity
can_favorite Boolean

True if user can mark activity as favorite
can_edit Boolean

True if user can edit the activity
isFavorite Boolean

True if activity is marked as favorite
activityData Object

Contains more activity data such as groupName if post came from group activity
commentCount Number

Number of people commented in the activity
authorClick function

Function that will navigate to profile of the user who posted the activity
dateRecorded String

Ex: "a month ago"
dateRecordedLong String

Ex: "3 weeks, 6 days ago"
children Array.<Object>

Activity data related to main activity such as if there are comments in the activity
media Array.<Object>

Media attached to activity
documents Array

Documents attached to activity
platformMedia Array

Platform media attached to activity
gif Object

Gif information including preview_url, video_url and rendered html
actions Object.<function()>

Actions for reply() and edit()
privacy String

Privacy setting of the activity

# ActivityViewModelFilterCallback() → {Object}

Properties:
Name Type Description
viewModel ActivityViewModel

Activity view model
activity Activity

Original activity object
depend ActivityModelDependencies

Dependencies (functions used to create view model)

New view model

Object

# AfterAuthRoutesFilter(routes) → {RoutesObject}

Parameters:
Name Type Description
routes RoutesObject

Current routes

New routes

RoutesObject
Object

# AfterBlogProfileHeaderProps

Properties:
Name Type Description
blog BlogViewModel
Object

# AfterBlogSingleBodyProps

Properties:
Name Type Description
blog BlogViewModel
global Object

App global style
colors Object

App colors
linkClickHandler function

Helper function for deep linking
t TranslationFunction
navigation NavigationService
Object

# AfterDetailsComponentProps

Properties:
Name Type Description
blog BlogViewModel

# AfterFilterComponent(props) → (nullable) {React.ComponentType.<any>}

Parameters:
Name Type Description
props FilterProps
React.ComponentType.<any>
Object

# AfterForumDetailsComponentProps

Properties:
Name Type Description
forum ForumViewModel
Object

# AfterForumProfileHeaderProps

Properties:
Name Type Description
forum ForumViewModel
Object

# AfterGroupDetailsComponentProps

Properties:
Name Type Description
global Object

App global style
color Object

App colors
group GroupViewModel
Object

# AfterGroupProfileHeaderProps

Properties:
Name Type Description
global Object

App global style
color Object

App colors
group GroupViewModel
Object

# AfterMaterialsComponentProps

Properties:
Name Type Attributes Description
global Object

App global style
colors Object

App colors
lesson LessonViewModel
labels Object

Learndash labels
t TranslationFunction
onQuizClick function

Function to execute if previous or next button is a quiz
onLessonClick function

Function to execute if previous or next button is a lesson
onTopicClick function

Function to execute if previous or next button is a topic
prevObject Object <nullable>

Information about previous lesson/topic/quiz
nextObject Object <nullable>

Information about next lesson/topic/quiz
nextLockedAlert function

Shows an alert with information that next object is locked
loading Boolean

Returns true if screen is still loading
course CourseViewModel
navigation NavigationService
materials String

Lesson materials
Object

# AfterProfileDetailsComponentProps

Properties:
Name Type Description
user MemberViewModel
Object

# AfterProfileHeaderProps

Properties:
Name Type Description
user MemberViewModel

# AfterSearchInputComponent(props) → (nullable) {React.ComponentType.<any>}

Parameters:
Name Type Description
props SearchProps
React.ComponentType.<any>
Object

# AfterSettingsListComponentProps

Properties:
Name Type Description
SettingsListProps SettingsListProps
Object

# AnimatedListHeaderProps

Properties:
Name Type Description
title String

Screen's title
subTitle String
global Object

App global style
titleStyle Object
Object

# animatedSwitchNavigatorProps

Properties:
Name Type Description
routes Object

Default navigation routes
options Object

Default navigation options
routeProps Object

Contains information which can be utilized when creating custom navigators
Object

# animatedSwitchNavigatorReturn

Properties:
Name Type Description
routes Object

New navigation routes
options Object

New navigation options
"loadEmailPreferences" | "updateEmailPreferences" | "getEmailInvites" | "revokeEmailInvite" | "checkBiometricSupport" | "checkBiometricEnrollmentStatus" | "sendAppFeedback" | "fetchPhotoActivity" | "createNewPhotos" | "deletePhotos" | "updatePhoto" | "albumsTree" | "loadHostedPhotos" | "loadAlbumPhotos" | "editAlbum" | "loadProfileBlog" | "fetchPost" | "loadBlog" | "loadBlogSingleComments" | "loadBlogCategories" | "loadBlogCreationTimes" | "deleteBlogComment" | "blogComment" | "loadGroupTypes" | "loadProfileTypes" | "viewAsRestore" | "viewAsSwitch" | "deleteAccount" | "loadAccountSettings" | "loadPrivacySettings" | "updatePrivacySettings" | "loadLoginInfo" | "updateLoginInfo" | "loadGroupInviteSettings" | "updateGroupInviteSettings" | "fetchActivity" | "updateActivity" | "updateViewAsSession" | "restNoRouteHandler" | "removeFriend" | "loadFriendRequests" | "friendRequestCreate" | "friendRequestModify" | "loadGroupInvites" | "groupInviteModify" | "groupInviteCreate" | "loadGroupRequests" | "groupRequestCreate" | "loadProfileTopics" | "loadTagTopics" | "groupRequestModify" | "loadSignupFields" | "signup" | "socialLogin" | "forgot" | "getUser" | "getAnyUser" | "navigateToProfile" | "loadProfileReplies" | "navigateToGroup" | "loadUserProfileData" | "loadTopicForUser" | "loadSubGroups" | "loadGroups" | "joinGroup" | "leaveGroup" | "groupsDetails" | "loadSocialGroups" | "joinSocialGroup" | "loadSingleSocialGroup" | "loadGroupSettings" | "socialGroupTabRequest" | "notificationAction" | "loadNotifications" | "markNotification" | "deleteNotification" | "loadForums" | "subscribeForum" | "unsubscribeForum" | "navigateToSubforum" | "loadTopics" | "fetchTopic" | "subscribeTopic" | "unsubscribeTopic" | "newTopicEpic" | "closeKeyBoard" | "blockUser" | "unblockUser" | "loadSingleForum" | "loadForumFromSubForum" | "loadRepliesForTopic" | "unfavoriteTopic" | "favoriteTopic" | "openTopic" | "closeTopic" | "stickTopic" | "unstickTopic" | "superstickTopic" | "spamTopic" | "unspamTopic" | "trashTopic" | "loadRelatedTopicsForTopic" | "spamReply" | "unspamReply" | "trashReply" | "newReply" | "refreshRepliesForTopic" | "loadDropdownTopics" | "doMergeEpic" | "doSplitEpic" | "doMoveEpic" | "uploadMedia" | "uploadDocument" | "getPreviewData" | "loadMenuSettings" | "loadSites" | "loadCoursesOnRequest" | "loadCoursesByCategoryOnRequest" | "loadCoursesWithCategoriesOnRequest" | "loadSingleCourse" | "loadSingleCourseMembers" | "loadSingleTopic" | "completeTopic" | "coursesDetails" | "enrollCourse" | "loadSingleLessonWithTopics" | "completeLesson" | "loadSingleQuiz" | "startQuizEpic" | "completeQuiz" | "updateSettings" | "loadReportCategories" | "reportContentRequest" | "clearCookiesOnLogout" | "loadFriendsToList" | "loadGroupDocumentsToList" | "loadProfileDocumentsToList" | "loadProfileActivitiesToList" | "loadProfileGroups" | "loadGroupMembersToList" | "loadGroupActivitiesToList" | "loadMembersToList" | "membersDetails" | "loadMembersAdvancedSearchForm" | "loadActivitiesToList" | "loadMessagesToList" | "loadThread" | "deleteThread" | "actionThread" | "newMessage" | "favoriteActivity" | "replyToActivity" | "deleteActivity" | "newActivity" | "documentsDetails" | "foldersTree" | "fetchFolder" | "loadDocumentsToList" | "deleteDocument" | "newDocument" | "updateDocument" | "activitiesDetails" | "followMember" | "resetStateOnLogout" | "blockDataRequest" | "loadBlockContent" | "memberProfileFields" | "memberProfileFieldsEdit" | "uploadProfileImage" | "deleteUserPhoto" | "uploadGroupImage" | "uploadGroupCover" | "groupUpdate" | "deleteGroup" | "deleteGroupCover" | "deleteGroupPhoto" | "promoteMember" | "bulkResources" | "surveyEntriesRequest" | "surveyFormDataRequest" | "surveyResultsRequest" | "loadInAppProducts" | "makePurchase" | "registerPurchaseListeners" | "loadProductsForScreen" | "applyLoadedData" | "loadDataForAppInitialisation" | "extendSandbox" | "loadUsersToCache" | "askFileUploadPermissions" | "navigateToTopic" | "navigateToAddTopic" | "loadNotificationSubscriptions" | "updateNotificationSubscriptions" | "initializeFirebase" | "manageNotifications" | "manageFirePushToken" | "updateFirebaseTopics" | "setNativeBadgeValue" | "notificationClickHandle" | "loadProfileCourses" | "loadProfilePhotos" | "selectSinglePhoto" | "deleteProfilePhoto" | "uploadProfilePhoto" | "fetchProfileAlbums" | "createProfileAlbum" | "setFilterPhoto" | "uploadProfileAlbumPhotoRequest" | "deleteProfileAlbumPhoto" | "deleteProfileAlbum" | "loadPhotoActivity" | "replyToPhotoComment" | "loadPhotoActivityItem" | "photoFavoriteActivity" | "addPhotoComment" | "deletePhotoActivity" | "loadGroupPhotos" | "deleteGroupPhoto" | "uploadGroupPhoto" | "setGroupFilterPhoto" | "fetchGroupAlbums" | "uploadProfileAlbumPhotoRequest" | "deleteGroupAlbumPhoto" | "createGroupAlbum" | "deleteGroupAlbum" | "loadGroupCourses" | "loadGlobalPhotosToList" | "loadGlobalPhotosDetails" | "validateToken" | "loadProfileTabs" | "loadGifs" | "completePurchase" | "addRepeater" | "deleteRepeater" | "reorderRepeaters"

# AppEpic

Redux reducers implemented in app

"accountSettings" | "documentsCache" | "documents" | "activities" | "activitiesCache" | "albums" | "appFeedback" | "auth" | "blockData" | "blockUser" | "blockLoadableDataCache" | "blockLoadableDataError" | "blockLoadableDataLoading" | "blog" | "blogCache" | "blogSingleComments" | "blogSingleCommentsCache" | "config" | "courses" | "courseCategories" | "coursesCache" | "coursesByCategory" | "emailInvites" | "featureStatuses" | "firebase" | "fonts" | "forgot" | "forums" | "forumsCache" | "friendRequests" | "gifs" | "groupDocuments" | "groupActivities" | "groupMembers" | "groups" | "groupsCache" | "groupInvites" | "groupMessages" | "groupRequests" | "groupCourses" | "groupSettings" | "localAuthentication" | "media" | "files" | "preview" | "members" | "messages" | "messagesCache" | "thread" | "menuSettings" | "merge" | "move" | "notifications" | "notificationsCache" | "privacySettings" | "profileDocuments" | "profileActivities" | "profileBlog" | "profileCourses" | "groupAlbums" | "groupPhotos" | "globalPhotos" | "profilePhotos" | "hostedPhotos" | "photos" | "mediaCache" | "profileAlbums" | "albumsCache" | "profileFriends" | "profileGroups" | "profileTopics" | "profileTabs" | "tagTopics" | "profileReplies" | "repliesCache" | "reportContentCategories" | "reportContentRequest" | "settings" | "signup" | "signupFields" | "singleAlbumPhotos" | "singleCourse" | "singleGroup" | "singleForum" | "singleLearnTopic" | "singleLesson" | "singleQuiz" | "singleQuizQuestions" | "singleTopic" | "sites" | "socialGroups" | "split" | "survey" | "subgroups" | "cardModal" | "groupTabs" | "topicCache" | "topicDropdown" | "topics" | "trackPlayer" | "urls" | "user" | "userProfile" | "usersCache" | "xProfile" | "inAppPurchases" | "appInitialisation" | "profileDetails" | "notificationSubscriptions" | "network"

# AppReducers

Redux reducers implemented in app

# AssetFilterCallback(path, source) → {LocalImageSource}

Parameters:
Name Type Description
path string
source LocalImageSource
LocalImageSource
Object

# AssociatedGroupComponentProps

Properties:
Name Type Description
t TranslationFunction
colors Object

App colors
global Object

App global style
navigate NavigationService
uri String

Contains link to group's image
name String

Group name
subtitle String

Outputs the value of forums:associatedGroup translation
"LoginScreen" | "SignupScreen" | "CodeVerificationScreen" | "LinkAccountScreen" | "SocialLoginDataInputScreen" | "ForgotScreen" | "SocialLoginScreen"

# AuthStackScreenNames

Object

# BackButtonComponentProps

Properties:
Name Type Description
navigation NavigationService
headerColor String
styles RNStyleValue

Back button default styling
delay Boolean

Returns true for default setting is to delay rendering
Object

# BeforeBlogSingleBodyProps

Properties:
Name Type Description
blog BlogViewModel
global Object

App global style
colors Object

App colors
linkClickHandler function

Helper function for deep linking
t TranslationFunction
navigation NavigationService
Object

# BeforeDetailsComponentProps

Properties:
Name Type Description
blog BlogViewModel

# BeforeFilterComponent(props) → (nullable) {React.ComponentType.<any>}

Parameters:
Name Type Description
props FilterProps
React.ComponentType.<any>
Object

# BeforeForumDetailsComponentProps

Properties:
Name Type Description
forum ForumViewModel
Object

# BeforeGroupDetailsComponentProps

Properties:
Name Type Description
global Object

App global style
color Object

App colors
group GroupViewModel
Object

# BeforeProfileDetailsComponentProps

Properties:
Name Type Description
colors Object

App colors
global Object

App global style
user MemberViewModel

# BeforeSearchInputComponent(props) → (nullable) {React.ComponentType.<any>}

Parameters:
Name Type Description
props SearchProps
React.ComponentType.<any>
Object

# BeforeSettingsListComponentProps

Properties:
Name Type Description
SettingsListProps SettingsListProps
Object

# BlockProps

Properties:
Name Type Description
block Object

Block data from API
calcFontSize function

Used to calculate font size based on the fixed value you assign and percent set on branding options
colors Object

App colors
fontFamilyStyle Object

App font style
global Object

App global style
handleLinkClicks function

Link click handler
htmlHandleClicks function

Link click handler for webview
isNavActive boolean

Returns true if current screen is visible
lastItem boolean

Returns true if component is last block
navigation NavigationService
toUserBasedOnSettings ToUserBasedOnSettings
viewWidth number

Default window width used by blocks
wrapHtml function

Function that will wrap string in an HTML template
wrapStyle ReactStyles

Default wrap style used by blocks
"core/image" | "core/video" | "core/audio" | "core/gallery" | "core/paragraph" | "core/heading" | "core/quote" | "core/table" | "core/list" | "core/html" | "core/cover" | "core/media-text" | "core/buttons" | "core/button" | "core/columns" | "core/embed" | "bbapp/courses" | "bbapp/topics" | "bbapp/forums" | "bbapp/groups" | "bbapp/members" | "bbapp/activity" | "bbapp/notifications" | "bbapp/qlinks" | "bbapp/h5p" | "tincanny/content" | "core/code" | "core/pullquote" | "core/preformatted" | "core/verse" | "core/file" | "core/more" | "core/nextpage" | "core/separator" | "core/spacer" | "core/group"

# BlockTypes

Object

# BlogDetailsComponentProps

Properties:
Name Type Description
blog BlogViewModel
global Object

App global style
titleOpacity function

Uses useMemo() hook and returns titleOpacity
textStyle Object

Returns a defined style object if blog is using a featured image
Object

# BlogHeaderAvatarProps

Properties:
Name Type Description
blog BlogViewModel
global Object

App global style
textStyle Object

Returns defined style object if blog is using a featured image
Object

# BlogItemProps

Properties:
Name Type Description
global Object

App global style
colors Object

App colors
item BlogViewModel
index Number
t TranslationFunction
currentUserId Number
Object

# BlogSubFilterProps

Properties:
Name Type Description
categories Array.<Object>
year Array.<Object>

Year values in the sub filter
Object

# BlogViewModel

Blog model used by the app that came from Blog API. All fields from api response will also be available in BlogViewModel aside from the fields defined below. Refer to: https://www.buddyboss.com/resources/api/#api-Blogs

Properties:
Name Type Description
id Number

Blog Id
link String

Link to the blog post
title String

Blog title
contentNative Array

Blocks used in the blog
content String

HTML content of the blog
authorName String

Name of blog's author
avatar String

Link to author's avatar
date String

Date posted
commentCount Number

Number of comments in the blog
allowComments Boolean

Returns true if blog allows comments
replies Array

Replies posted in the blog
featuredImage String | Number

If a featured image is set, returns a string link to the featured image. Otherwise, will return an integer indicating that require("../assets/img/default/default-blog-img.png") is used for the featured image
Object

# BottomTabBarProps

Properties:
Name Type Description
style Object

Contains colors for nav bar use
showLabel Boolean

Returns true if label should be used
activeTintColor String
inactiveTintColor String
Navigation NavigationService
height Number

Default tab bar height
safeAreaInset Number

SafeArea for IOS use

# BottomTabsRoutesFilterCallback(routes, metaMoreScreen, constructTabbarAllScreens, showTabBarOnAllScreens) → {Object}

Parameters:
Name Type Description
routes Object

Current bottom tab routes
metaMoreScreen Object

Meta data of the More Screen
constructTabbarAllScreens function

Returns the appropriate screens depending on value of "Tab Bar Visibility"
showTabBarOnAllScreens Boolean

Returns true if "Tab Bar Visibility" is set to "Show on All Screens"

New routes

Object

# BottomTabsSettingsFilterCallback(tabsOptions, colors) → {Object}

Parameters:
Name Type Description
tabsOptions Object

tabsOptions include tabBarOptions, initialRouteName tabBarComponent etc..
colors Object

App colors

New tab settings

Object
Object

# Button

Object

# ButtonConfig

Properties:
Name Type Attributes Description
permissionField string <nullable>
statusField string
flow Array.<ButtonFlow>
Object

# ButtonConfig

Properties:
Name Type Attributes Description
permissionField String <nullable>
statusField String
flow Array.<ButtonFlow>
Object

# ButtonFlow

Properties:
Name Type Description
check CheckProperty

Checks for a view model property, and based on the check it decides if it should show button
buttons Array.<Button>

Buttons to show if check passes
Object

# ButtonFlow

Properties:
Name Type Description
check CheckProperty

Checks for a view model property and checks if it should show the button
buttons Array

Buttons to show if check passes
Object

# CancelablePromise

# CheckProperty(object) → {boolean}

Parameters:
Name Type Description
object Object

View model
boolean

# CheckProperty(object) → {Boolean}

Parameters:
Name Type Description
object Object

View model
Boolean
Object

# CourseHeaderDetailsProps

Properties:
Name Type Description
courseVM CourseViewModel
global Object

App global style
colors Object

App colors
labels Object

Learndash labels
t TranslationFunction
lCount Number

Lessons count
t Number

Learn Topics count
qCount Number

Quizzes count
navigation NavigationService
learndashCourseParticipants String

Can be used to determine if participants should be shown in the component
Object

# CourseMaterialsProps

Properties:
Name Type Description
global Object

App global style
colors Object

App colors
t TranslationFunction
materials HTML

Contents of course materials field
tagsStyles RNStyleValue

Defined styles for different tags
materialsStyles RNStyleValue

Defined styles for course materials
baseFontStyle function

Function to set a font style
navigation NavigationService
onLinkPress function

Helper function that handles link press for HTML component

# CoursePropsFilterCallback(oldProps) → {Object}

Parameters:
Name Type Description
oldProps Object

Course props

New props

Object
Object

# CoursesWidgetComponentProps

Properties:
Name Type Description
bgColor String

Background color of the widgets container
title String

Title for the widgets container
courses Array.<Object>

Contains courses object with fields such as title, date, has_course_access, slug etc.
onCourseClick function

Function that will redirect to the selected course
onCourseSeeAllClick function

Function that will redirect to the courses list
t TranslationFunction
navigation NavigationService
Object

# CoursesWidgetTitleProps

Properties:
Name Type Attributes Description
global Object

App global style
colors Object

App colors
style Object
icon String
title String

Title of the widget
textColor String
seeMoreHidden Boolean <nullable>

Returns true if "See More" button should be hidden
seeMoreHandler function

Helper function that redirects to appropriate screen
seeMoreLabel String

Default label of "See More" button
courses Array.<CourseViewModel>
t TranslationFunction
navigation NavigationService
Object

# CourseTitleProps

Properties:
Name Type Description
course CourseViewModel
global Object

App global style
colors Object

App colors
lightStyle Boolean

Returns true if course is using cover image
opacity Object

Returns an object generated by React Native Animated
Object

# CourseViewModel

Properties:
Name Type Attributes Description
canEnroll Boolean

Returns true if user can enroll to the course
incompletePrerequisiteMessage String <nullable>

Returns a message if incomplete prerequisite
id Number

Course id
featuredUrl String

Url to featured image
coveredUrl String

Url to cover image
title String

Course title
progression Number

Returns course progression by the user
date String

Date of when course was created
lessonsCount Number

Number of lessons in the course
lessonsCompleted Number

Number of lessons completed in the course
onClick function

Default function when a course widget is clicked
isClosed Boolean

Returns true if course is closed
hasAccess Boolean

Returns true if user has access
hasContentAccess Boolean

Returns true if has content access
hidecontentTable Boolean

Returns true if content table is hidden
paidCourse Boolean

Returns true if course can only be accessed if user has paid for it
completed Boolean

Returns true if course has been completed by the logged-in user
link String

Link to the course
puchasable Boolean

Returns true if course can be purchased
offlineDisabled Boolean

Returns true if offline disabled
videoUrl String | undefined

Course video
price Object <nullable>

Course price and currency
error Object

Error message encountered
authorId Number

Id of course's author
author Object <nullable>

Author details
modifiedDate String <nullable>

Date of when course was last modified
certificate Object

Certificate details
enrolledMembers Number

Number of enrolled members in the course

# CssToCssCallback(htmlContentCss, typographynullable) → {string}

Parameters:
Name Type Attributes Description
htmlContentCss string
typography Typography <nullable>
string

# CustomAPIRequestFunction(urlPath, method, paramsOrPayload, validation, headers, isfullUrl) → {CancelablePromise}

Parameters:
Name Type Description
urlPath string

URL
method "post" | "get" | "delete" | "patch"
paramsOrPayload Object

Params to send with request body
validation ValidationFunction

Runs a validation over response object. You can define your own function or use objectValidation (checks if response is an object) or arrayOfObjectsValidation (checks if response is an array of objects). If validation fails, app will go in offline mode.
headers Object

Define request headers
isfullUrl boolean

Set true if you want to use the full URL, instead of appending the path to your connected site URL.
CancelablePromise

# CustomBlockPropsCallback(renderer) → {Object}

Block props

Parameters:
Name Type Description
renderer BlockProps

New props

Object

# CustomBlockRenderCallback(renderer) → {React.ComponentType.<any>}

A custom block render function

Parameters:
Name Type Description
renderer BlockProps

React Component

React.ComponentType.<any>

# DeeplinksFallbackCallback(defaultValue, linkObject, navigation) → {boolean}

Parameters:
Name Type Description
defaultValue boolean
linkObject Object

Link object provided by API
navigation NavigationService
boolean

# DeeplinksWithoutEmbeddedCallback(defaultValue, linkObject, navigation) → {Boolean}

Parameters:
Name Type Description
defaultValue Boolean
linkObject Object

Link object provided by API
navigation NavigationService
Boolean
Object

# DocumentItemComponentProps

Properties:
Name Type Description
currentUserId Number
profileUserId Number
formatDateFunc function

Function to help format dates
t TranslationFunction
token String

access token for authentication
global Object

App global style
colors Object

App colors
viewModel DocumentViewModel
navigation NavigationService
item Object

Data fetched from API
Object

# DocumentViewModel

Properties:
Name Type Description
id Number

Document id
activityId Number
size String

Document size
extension_description String
parent Number
count Number
title String
filename String
extension String
description String
type String
dateModified String

Date when document was last modified
displayName String

Name of document uploader
privacy String

Privacy of document
can_report Boolean

Returns true if item can be reported
reported Boolean

Returns true if item has been already reported
visibility String

Members who can view the document
groupId Number

Group where document is uploaded
folderId Number

Folder where document is uploaded
groupName String

Group name where document is uploaded
groupStatus String

Status of group
userId Number

User id of uploader
svgIcon String
dateCreatedFormatted String
downloadUrl String

Download url of document

# DoFunction(item, valuenullable) → {function}

Redux action to dispatch or simple function to execute

Parameters:
Name Type Attributes Description
item Object

View model
value String <nullable>

Value from prompt popup input
function
Example
doFunction: (item, value) => () => { navigateToReport(item.id) } // `navigateToReport` is function that we dont want to dispatch on redux
	doFunction: (item, value) =>
						documentUpdateRequest(item, {
							title: value,
							group_id: item.groupId,
							folder_id: item.folderId
						}) // `documentUpdateRequest` is redux action to dispatch

# EditProfileComponentDidUpdateCallback(prevProps, prevState, props, state, updateStoreValues)

Parameters:
Name Type Description
prevProps Object
prevState Object
props Object
state Object
updateStoreValues function

Helper function which you can use to update the Edit Profile screen's field values
Object

# Epic

See:

# EpicWrapper() → {Epic}

Parameters:
Type Description
Epic

Original epic
  • Changed epic
Epic

# ExternalLinkNavigation(path, params, navigate) → {boolean|null}

Parameters:
Name Type Description
path string
params Object
navigate function
boolean | null
Object

# FeatureValues

Object

# FetchActivitiesParams

Properties:
Name Type Attributes Description
display_comments String

Allowed values: stream, threaded, false
search String <nullable>

Limit results to those matching a string.
See:
Object

# FetchBlogParams

Properties:
Name Type Description
per_page Number

Maximum number of items to be returned in result set.
page Number

Current page of the collection.
search String

Limit results to those matching a string.
order String
orderby String
author Number

ID of the user whose blogs user can post to.
See:
Object

# FetchCourseCategoriesParams

Properties:
Name Type Description
page Number

Page to fetch
per_page Number

Maximum number of items to be returned in result set
courses_limit Number

Number of courses to fetch
mycourses Number

Limit results to current user courses
order String

Sort result set by given order. Allowed values: asc or desc.
orderby String

Sort result set by given field. Allowed values: date, term_id, name, slug.
See:
Object

# FetchCourseParams

Properties:
Name Type Attributes Description
page Number <nullable>

Page to fetch
per_page Number <nullable>

Maximum number of items to be returned in result set
order String

Sort result set by given order. Allowed values: asc or desc
orderby String

Sort result set by given field. Allowed values: date, id, title, menu_order
categories Array.<Number>

Limit results to those assigned to specific categories.
include Array.<Number>

Ensure result set includes specific IDs.
_embed boolean
See:
Object

# FetchDocumentsParams

https://www.buddyboss.com/resources/api/#api-Document-GetBBDocuments

Properties:
Name Type Description
group_id Number

A unique numeric ID for the Group.
folder_id Number

A unique numeric ID for the Document Folder.
user_id Number

Limit result set to items created by a specific user (ID).
order String

Order sort attribute ascending or descending. Allowed values: asc or desc
orderby String

Order by a specific parameter. Default value: title. Allowed values: title, date_created, date_modified, group_id, privacy
search String

Limit results to those matching a string.
Object

# FetchForumsFactoryParams

Properties:
Name Type Attributes Description
provider function

Redux state provider, function with no args
requiredPage Number
filter "all"
search String <nullable>
_embed Boolean
Object

# FetchGroupsParams

Properties:
Name Type Description
per_page Number

Maximum number of items to be returned in result set.
page Number

Current page of the collection.
search String

Limit results to those matching a string.
order String

Order sort attribute ascending or descending. Default value: desc. Allowed values: asc, desc
orderby String

Order Groups by which attribute. Default value: date_created. Allowed values: date_created, last_activity, total_member_count, name, random
type String

Shorthand for certain orderby/order combinations. Default value: active. Allowed values: active, newest, alphabetical, random, popular
scope String

Limit result set to items with a specific scope. Default value: all. Allowed values: all, personal
See:
Object

# FetchMembersParams

Properties:
Name Type Description
per_page Number

Maximum number of items to be returned in result set.
page Number

Current page of the collection.
scope String

Limit result set to items with a specific scope.
search String

Limit results to those matching a string.
type String

Shorthand for certain orderby/order combinations.
See:
Object

# FetchMessagesParams

Properties:
Name Type Description
per_page Number

Maximum number of items to be returned in result set.
page Number

Current page of the collection.
See:
Object

# FetchNotificationsParams

Properties:
Name Type Description
per_page Number

Maximum number of items to be returned in result set.
page Number

Current page of the collection.
sort_order String

Order sort attribute ascending or descending. Default value: ASC. Allowed values: ASC, DESC
order_by String

Name of the field to order according to. Default value: date_notified. Allowed values: id, date_notified, item_id
is_new Boolean

Limit result set to items from specific states
See:
Object

# FetchPhotosParams

Properties:
Name Type Description
page Number

Current page of the collection.
per_page Number

Maximum number of items to be returned in result set.
scope String

Scope of the media. Allowed values: friends, groups, personal
search String

Limit results to those matching a string.
type String

Shorthand for certain orderby/order combinations.
See:
Object

# FetchTopicsParams

Properties:
Name Type Description
per_page Number

Maximum number of items to be returned in result set.
page Number

Current page of the collection.
search String

Limit results to those matching a string.
orderby String

Sort retrieved topics by parameter. Allowed values: meta_value, date, ID, author, title, modified, parent, rand, popular, activity
order String

Designates ascending or descending order of topics. Allowed values: asc, desc
parent Number

Forum ID to retrieve all the topics.
See:
Object

# FieldSetObject

Properties:
Name Type Description
id Number

id of field set
name String
description Object
group_order Number
can_delete Boolean

Returns true if field set can be deleted
repeater_enabled Boolean

Returns true if repeater is enabled
fields Array.<Object>

Fields in a field set

# FilterAllButtonHiddenCallback(filterType) → {Boolean}

Parameters:
Name Type Description
filterType String

Returns the filter type used in the screen. Such values include: courses, members, groups, courseCategories

Return true if component should be hidden

Boolean

# FilterComponent(props) → (nullable) {React.ComponentType.<any>}

Parameters:
Name Type Description
props FilterProps
React.ComponentType.<any>
Object

# FilterItemComponentProps

Properties:
Name Type Description
index Number
style RNStyleValue
onPress function

onPress handler
global Object

App global style
text String

Label of filter item
icon LocalImageSource
isSelected Boolean

Returns true if filter item is selected
Object

# FilterProps

Note: There are more data available in this props but the listed below are valuable when customizing a filter row. Data also might also be different for each screens.

Properties:
Name Type Description
filter String
activeSubFilters Object
navigation NavigationService
disableSubFilters Boolean
filterType String
renderFilter React.ComponentType.<any>
Object

# Font

Properties:
Name Type Description
weight number

Font weight
style string

Font style
ext string

Font extension
base64 string

Font value when in base64
Object

# FontStyle

Properties:
Name Type Description
size number

Font size
family string

Font family
scale number

Font scale value
Object

# Forum

Object

# Forum

Object

# ForumDetailsComponentProps

Properties:
Name Type Description
contentStyle String

Suggested content style
hideShortContent Boolean

Returns true if a hook was used to indicate that short content should be hidden
global Object

App global style
forum ForumViewModel
forumShortContent String

Formatted forum short content
ForumBottomSheetWrapper React.ComponentType

Reusable component derived from src/components/ActionButtons/ActionSheetButtonWrapper
Object

# ForumHeaderProps

Properties:
Name Type Description
hideShortContent Boolean

Returns true if forum short content is hidden
colors Object

App colors
global Object

App global style
forum ForumViewModel
formatDateFunc function

Helper function which can be used to format dates
HEADER_HEIGHT Number

Default height of header used for ForumHeader component
disableActionButtons Boolean

Returns true if actions buttons are disabled
actionButtons Array.<Object>

Default action buttons such as creating a discussion or toggling subscription to a forum
t TranslationFunction
navigateToGroup function

Function to navigate to associated group
Object

# ForumItemProps

Properties:
Name Type Description
forum ForumViewModel
colors Object

App colors
global Object

App global style
formatDateFunc function

Helper function which can be used to format dates
t TranslationFunction
actionButtons Array.<Object>

Forum actions from redux
Object

# ForumsGetParam

Properties:
Name Type Description
page Number

Page to fetch
per_page Number

Maximum number of items to be returned in result set
search String

Limit results to those matching a string.
include Array.<number>

An array of forums IDs to retrieve.
_embed Boolean
See:
Object

# ForumsWidgetTitleProps

Properties:
Name Type Description
global Object

App global style
colors Object

App colors
icon String
title String

Title of the widget
textColor String
seeMoreHidden Boolean

Returns false by default
seeMoreHandler function

Helper function that redirects to appropriate screen
seeMoreLabel String

Default label of "See More" button
forums Array.<ForumViewModel>
t TranslationFunction
navigation NavigationService
Object

# ForumViewModel

Properties:
Name Type Description
id Number

Forum id
title String

Forum title
shortContent String

Html for displaying forum's description
can_report Boolean

Returns true if forum can be reported
reported Boolean

Returns true if forum is already reported
author Object

Details of forum author
date String

Date of when forum was created
modified String

Date of when forum was last modified
lastActive String

Date of when last activity in forum
actionStates Object

contains subscribed field which returns true if user is subscribed to forum
replyCount String

Number of replies
topicCount String

Number of discussions
group Object

Group associated with the forum
content String

Html for displaying forum's description
coverImage String

Link to forum's cover image
coverImageThumbnail String

Link to forum's thumbnail cover image
canCreateTopic Boolean

Returns true if user can create a topic in the forum
canSeeTopics Boolean

Returns true if user can create a topic in the forum
canSeeSubForums Boolean

Returns true if user can see sub forums in the forum
subForums Array

Sub forums associated to forum
subscribe function

Function to subscribe to forum
toSingle function

Function navigate to forum item
navigateToProfile function

Function to navigate to a user's profile
Object

# GetAPI

Properties:
Name Type Description
customRequest CustomAPIRequestFunction

Used to make custom API requests

/**

# GetError(store) → {any}

Get error from redux state

Parameters:
Name Type Description
store Object

Whole redux store
any
Example
state => state.forums.unsubscribe.error
Object

# Group

Object

# GroupDetailsComponentProps

Properties:
Name Type Description
global Object

App global style
color Object

App colors
group GroupViewModel
t TranslationFunction
filteredActions Array.<Object>

Helper functions used in group details
onLinkPress function

Helper function to be used when a link in html is pressed
Object

# GroupHeaderAvatarProps

Properties:
Name Type Description
global Object

App global style
color Object

App colors
group GroupViewModel
Object

# GroupHeaderButtonsProps

Properties:
Name Type Description
OldButtonComponent function

Default button component displayed for the group. Ex: "Request to Join", "Member", etc.
global Object

App global style
color Object

App colors
group GroupViewModel
currentUser Object

Details about the currently logged-in user
t TranslationFunction
filteredActions Array.<Object>

Helper functions used in group details
onLinkPress function

Helper function to be used when a link in html is pressed
buttonTextColor String
buttonStyle Object
Object

# GroupItemComponentProps

Properties:
Name Type Description
global Object

App global style
colors Object

App colors
item GroupViewModel
index Number

Item index in a list
t TranslationFunction
actions Array

Group actions such as functions to join or leave a group
currentUserId Number

Logged in user ID
Object

# GroupPendingMemberItemComponentProps

Properties:
Name Type Description
colors Object

App colors
global Object

App global style
item MemberViewModel
index Number

Index of the item in the list
t TranslationFunction
groupInvite Object

Group inviter details
Object

# GroupsWidgetTitleProps

Properties:
Name Type Description
global Object

App global style
colors Object

App colors
icon String
title String

Title of the widget
textColor String
seeMoreHidden Boolean

Returns false by default
seeMoreHandler function

Helper function that redirects to appropriate screen
seeMoreLabel String

Default label of "See More" button
groups Array.<GroupViewModel>
t TranslationFunction
navigation NavigationService
Object

# GroupViewModel

Properties:
Name Type Description
parentId Number
id Number

Group id
avatar String

Group avatar
coverImage Boolean

Returns true if group has cover image
isMember Boolean

Returns true if logged in user is a member
isAdmin Boolean

Returns true if logged in user is an admin
isAuthor Boolean

Returns true if logged in user is the creator of the group
isMod Boolean

Returns true if logged in user is assigned as a moderator
isSoloOrganizer Boolean

Returns true if logged in user is assigned as an organizer
notAdmin Boolean

Returns true if logged in user is not an admin
inviteId Boolean | Number

Returns the invite id if logged in user has been invited to join. Otherwise, will return false
can_report Boolean

Returns true if group can be reported
reported Boolean

Returns true if group has already been reported
requestId Boolean

Returns request id if logged in user is trying to join the group. Otherwise, will return false
title String

Group title
content String

Group description
contentRendered String

Group description rendered
shortContent String

Group short description
hasForum Boolean

Returns true if group has associated forum
membersCount Number

Number of members in the group
status String

Group visibility. Ex: public, hidden
admins Array
role String

Role of logged in user
roleLabel String

Role label of logged in user
type String

Group type
subgroupIds Array
navigateToWeb function

Function to navigate to group link in web
getGroup function

Function to get all fields given by api. Ex: const group = getGroup(g => g).
canPost Boolean

Returns true if logged in user can post
canJoin Boolean

Returns true if logged in user can join
canCreateMedia Boolean

Returns true if logged in user can create media
canCreateDocument Boolean

Returns true if logged in user can create document
onClick function

Function to navigate to group item
Object

# HeaderAuthorComponentProps

Properties:
Name Type Description
user Object

Author details
lightStyle Boolean

Returns true if course is using cover image
global Object

App global style
userId Number

User id of course author
onUserProfilePress function
loadingInProgress function

# HeaderHeightCallback(defaultHeaderHeight, filterType, navigation) → {Number}

Parameters:
Name Type Description
defaultHeaderHeight Number

Default header height
filterType String

Name of filter in the index screen
navigation NavigationService
Number
Object

# headerProps

Properties:
Name Type Description
headerLeft React.ComponentType.<any>
headerTitle React.ComponentType.<any>
headerRight React.ComponentType.<any>
getHeaderRight function
Object

# HeaderRightComponentProps

Properties:
Name Type Description
t TranslationFunction
forum ForumViewModel
colors Object

App colors
global Object

App global style
headerColor String

Header color used in app
actionButtons Array.<Object>

Contains objects for forum actions such as Create Discussion and Subscribe
Object

# HeaderRightProps

Properties:
Name Type Description
headerRight React.ComponentType.<any>

# HOCsFilter(hocs) → {Array.<function()>}

Parameters:
Name Type Description
hocs Array.<function()>

Initial HOCs array

New HOCs array

Array.<function()>
Object

# IAPDisabledMessageComponentProps

Props listed below are props related to IAP. Actual prop might contain more data.

Properties:
Name Type Description
course CourseViewModel
loadProducts function

Function to load products for the course
inAppEnabled Boolean

Returns true if IAP is enabled
products Array

Products available for purchase
Object

# IconProps

Properties:
Name Type Description
route Object

Route information such as label, icon, route name etc.
focused Boolean

Returns true if icon is currently active
tintColor String

Icon color
LocalImageSource | RemoteImageSource

# ImageSource

# InitialAfterAuthRouteCallback(props) → {String}

Parameters:
Name Type Description
props Object

AppNavigator component props

Route

String
Object

# InputColors

Properties:
Name Type Description
inputPlaceholderColor string
inputBorderColor string
inputFocusBorderColor string
inputIconColor string
Object

# IOMiddlewareOptions

Properties:
Name Type Description
navigationService NavigationService

Object similar to the navigation property of "react-navigation". The most used methods are navigate anddispatc. Both are used for triggering navigation.
buildConfig BuildConfigType

Build configuration object which contains all things required for specific app builds, including URL to the app icon, app launch screen, and many more.
inApp Object

"react-native-iap" default export object
getApi GetAPI

Function that gets an instance of the class containing all the methods used for fetching data
t TranslationFunction
Object

# IsCategoryTagsHiddenCallback

Properties:
Name Type Description
course CourseViewModel
Object

# IsCourseDescriptionHiddenCallback

Properties:
Name Type Description
course CourseViewModel
Object

# IsCourseStatusHiddenCallback

Properties:
Name Type Description
course CourseViewModel
hasStarted Boolean

Returns true if course progress has started
courseTree Object

Course lessons, topics, quizzes
Object

# ItemCourseComponentProps

Properties:
Name Type Description
key Number

Index of the item
viewModel CourseViewModel
global Object

App global style
colors Object

App colors
textColor string

Text color used in the component item
locale string

App locale
inList boolean

Returns true if the item is in vertical self-loading list
wStyles Object

Defined styles for container and item
online boolean

Returns true if user is online
labels Object

Dynamic names for Leandash CPTs; set on site
string

# LanguageLocale

Example
"en_US"
"de_DE"

# LearnTopicAfterContentRendererFunction(props) → (nullable) {React.ComponentType.<any>}

Parameters:
Name Type Description
props LearnTopicAfterContentRenderProps
React.ComponentType.<any>
Object

# LearnTopicAfterContentRenderProps

Properties:
Name Type Description
topic LearnTopicViewModel
global Object

App global style
colors Object

App colors
navigation NavigationService
Object

# LearnTopicAfterMaterialsComponentProps

Properties:
Name Type Attributes Description
topic LearnTopicViewModel
lessonOrder Number

Order of lesson where topic belongs to
global Object

App global style
colors Object

App colors
lesson LessonViewModel
labels Object

Learndash labels
t TranslationFunction
onQuizClick function

Function to execute if previous or next button is a quiz
onLessonClick function

Function to execute if previous or next button is a lesson
onTopicClick function

Function to execute if previous or next button is a topic
prevObject Object <nullable>

Information about previous lesson/topic/quiz
nextObject Object <nullable>

Information about next lesson/topic/quiz
nextLockedAlert function

Shows an alert with information that next object is locked
loading Boolean

Returns true if screen is still loading
course CourseViewModel
navigation NavigationService
materials String

Lesson materials
Object

# LearnTopicHeaderProps

Properties:
Name Type Attributes Description
global Object

App global style
colors Object

App colors
topic LearnTopicViewModel
lessonOrder Number

Order of lesson where topic belongs to
setHeaderHeight function

Helper function which can be called to set header height
labels Object

Learndash labels
t TranslationFunction
paddingTop Number

Default padding top applied to component
onQuizClick function

Function to execute if previous or next button is a quiz
onLessonClick function

Function to execute if previous or next button is a lesson
onTopicClick function

Function to execute if previous or next button is a topic
prevObject Object <nullable>

Information about previous lesson/topic/quiz
nextObject Object <nullable>

Information about next lesson/topic/quiz
courseId Number

Course id of lesson/topic/quiz
nextLockedAlert function

Shows an alert with information that next object is locked
backToCourse React.ComponentType

Returns default back button component
loading Boolean

Returns true if screen is still loading
course CourseViewModel
renderTimer Boolean | React.ComponentType

Returns false if topic doesn't have a timer set. Will return a component if timer for the topic is set.
onTimePassed function

Function which updates the seconds passed in the topic screen container
navigation NavigationService
hidePrevNext Boolean

Returns true if prev/next buttons should be hidden
prevNext Boolean | React.ComponentType

Returns false if hidePrevNext is true. Will return buttons which can navigate through previous and next screens if hidePrevNext is false
Object

# LearnTopicPrevNextComponentProps

Properties:
Name Type Attributes Description
onQuizClick function

Function to execute if previous or next button is a quiz
onLessonClick function

Function to execute if previous or next button is a lesson
onTopicClick function

Function to execute if previous or next button is a topic
global Object

App global style
colors Object

App colors
t TranslationFunction
prevObject Object <nullable>

Information about previous lesson/topic/quiz
nextObject Object <nullable>

Information about next lesson/topic/quiz
courseId Number

Course id of lesson/topic/quiz
nextLockedAlert function

Shows an alert with information that next object is locked
Object

# LearnTopicProps

Properties:
Name Type Description
topic LearnTopicViewModel
Object

# LearnTopicScreenHeaderProps

Properties:
Name Type Description
LearnTopicHeaderProps LearnTopicHeaderProps
headerLeftStyle Object

Default styling for left section of the header
style Object

Default styling of lesson header
headerRightAuthWrapperProps Object

Props which can be passed to an AuthWrapper
Object

# LearnTopicTitleComponentProps

Properties:
Name Type Description
LearnTopicHeaderProps LearnTopicHeaderProps
Object

# LearnTopicVideoProgressionComponentProps

Properties:
Name Type Description
topicVideoStyle Object

Default styling applied to topic video
controls Boolean

Returns true if controls should be displayed
autoplay Boolean

Returns true if auto play should be enabled
videoCallback function

Helper function which can be called when the video has finished playing
url String

Video url
width Number

Player width
height Number

Player height
global Object

App global style
isNavActive Boolean

Returns true if screen is active
topic LearnTopicViewModel
showVideo Boolean

Returns true if video should be shown
videoWatched Boolean

Returns true if video has already been watched
setVideoWatched function

Helper function which dispatches an action and marks the video as watched
completeTopic function

Helper function which dispatches an action to mark the topic as complete
onCompleteTopicClick function

Helper function which considers different conditions (such as if quizzes inside a topic are already completed) before calling the completeTopic function
Object

# LearnTopicViewModel

Properties:
Name Type Description
id Number

Topic id
title Object

Topic title
content Object

Content of topic
date String

Date created
date_gmt String

Date created
modified String

Date modified
modified_gmt String

Date modified
link String

Url to topic
slug String

Slug used for topic
author Number

Author's id
featured_media Number

Featured media of topic
course Number

Course id of topic's parent
lesson Number

Lesson id of topic's parent
materials String

Topic materials
video String

Url for video progression

# LessonEntitiesCallback(columns) → {Object}

Parameters:
Name Type Description
columns Object

Lesson columns

New columns

Object

# LessonEntitiesCallback(columns) → {Object}

Parameters:
Name Type Description
columns Object

Lesson columns

New columns

Object
Object

# LessonHeaderProps

Properties:
Name Type Attributes Description
global Object

App global style
colors Object

App colors
lesson LessonViewModel
labels Object

Learndash labels
t TranslationFunction
paddingTop Number

Default padding top applied to component
onQuizClick function

Function to execute if previous or next button is a quiz
onLessonClick function

Function to execute if previous or next button is a lesson
onTopicClick function

Function to execute if previous or next button is a topic
prevObject Object <nullable>

Information about previous lesson/topic/quiz
nextObject Object <nullable>

Information about next lesson/topic/quiz
courseId Number

Course id of lesson/topic/quiz
nextLockedAlert function

Shows an alert with information that next object is locked
backToCourse React.ComponentType

Returns default back button component
loading Boolean

Returns true if screen is still loading
course CourseViewModel
renderTimer Boolean | React.ComponentType

Returns false lesson doesn't have a timer set. Will return a component if timer for the lesson is set.
onTimePassed function

Function which updates the seconds passed in the lesson screen container
navigation NavigationService
hidePrevNext Boolean

Returns true if prev/next buttons should be hidden
prevNext Boolean | React.ComponentType

Returns false if hidePrevNext is true. Will return buttons which can navigate through previous and next screens if hidePrevNext is false
Object

# LessonScreenHeaderProps

Properties:
Name Type Description
LessonHeaderProps LessonHeaderProps
headerLeftStyle Object

Default styling for left section of the header
style Object

Default styling of lesson header
headerRightAuthWrapperProps Object

Props which can be passed to an AuthWrapper
Object

# LessonTitleComponentProps

Properties:
Name Type Description
LessonHeaderProps LessonHeaderProps
Object

# LessonViewModel

Properties:
Name Type Description
id Number

Lesson id
title String

Lesson title
content String

Lesson content
contentNative Array

Blocks used in the lesson
quizCompleted Boolean

Returns true if quiz in the lesson has been completed
quizCount Number

Number of quizzes in the lesson
lessonQuizzes QuizViewModel
completed Boolean

Returns true if lesson has been completed
requireTimer Boolean

Returns true if lesson requires timer
timerRequiredTime Number

Timer required time
progression Number

User's progress in the lesson
hasAccess Boolean

Returns true if logged in user has access to lesson
hasContentAccess Boolean

Returns true if logged in user has access to lesson's content
topicsCount Number

Number of topics in the lesson
videoUrl String

Url added in video progression of the lesson
video Object

Video details
Object

# LinksWidgetTitleProps

Properties:
Name Type Description
global Object

App global style
colors Object

App colors
textColor String
icon String
title String

Title of the widget
seeMoreHidden Boolean

Returns false by default
quickLinks Array.<Object>

Quick links object
t TranslationFunction
navigation NavigationService
number

# LocalImageSource

Image resource (via request('...src'))

Object

# LoginButtonProps

Properties:
Name Type Description
t TranslationFunction
global Object

App global style
colors Object

App colors
stateUsername String

Username field state
statePassword String

Password field state
isSignUpEnabled Boolean

Returns true if signup is enabled
privacyPolicy Object

Content of privacy policy
termsOfService Object

Content of terms of service
withUserAgreementCheckbox Boolean

Returns true if screen has user agreement checkbox
stateAgreementChecked Boolean

Returns state of user agreement checkbox
passwordInputRef function

Returns reference to password component
usernameInputRef function

Returns reference to username component
doLogin function

Default login function
auth Object
screenProps Object
"my_library" | "blog" | "settings" | "groups" | "notifications" | "topics" | "courses" | "courses_category" | "courses_all" | "activity" | "documents" | "messages" | "members" | "forums" | "profile" | "iap_products" | "photos" | "videos" | "gamipress_achievements" | "badgeos_achievements" | "course_certificates"
"SettingsAboutScreen" | "ProfileGroupSingleScreen" | "SurveyScreen" | "ActivitiesCreatePostScreen" | "MessagesCreatePostScreen" | "MessagesCreatePostDeeplink" | "QuizSingleScreen" | "QuizResults" | "QuizDetails" | "QuizReview" | "CourseSectionScreen" | "CourseQuizzesScreen" | "CourseMaterialsScreen" | "BBMediaFullView" | "ActivityMedia" | "MergeTopicScreen" | "LessonSingleScreen" | "LearnTopicSingleScreen" | "SubForumsSingleScreen" | "ForumsSingleScreen" | "CoursesSingleScreen" | "CoursesScreen" | "CoursesCategorySingleScreen" | "TopicsTagScreen" | "TopicsSingleScreen" | "AddTopicScreen" | "SelectScreen" | "MoveReplyScreen" | "SplitReplyScreen" | "NewReplyScreen" | "CreateNewAlbum" | "AddNewProfilePhoto" | "AddNewGroupPhoto" | "SettingsPushScreen" | "SettingsPrivacyScreen" | "GroupsSingleScreen" | "PageScreen" | "BlockScreen" | "ProfileScreen" | "PrivacySettingsScreen" | "GroupInviteSettingsScreen" | "LoginInfoScreen" | "AlbumSingleScreen" | "CreateNewPhotosScreen" | "AlbumAddPhotosScreen" | "HomeNotificationsScreen" | "HomeForumsScreen" | "HomeCourseCategoriesScreen" | "HomeTopicsScreen" | "HomeGroupsScreen" | "HomeMemberScreen" | "HomeActivityScreen" | "HomeMembersScreen" | "ReportFormScreen" | "ManageGroupDetails" | "EditNavigation" | "EditXprofile" | "ViewXprofile" | "PhotoXprofile" | "CoverXprofile" | "ProfileCourses" | "ProfilePhotos" | "GlobalPhotos" | "ProfileGamipress_achievements" | "ProfileGamipress_points" | "ProfileGamipress_ranks" | "ProfileBadgeos_achievements" | "ProfileBadgeos_points" | "ProfileBadgeos_ranks" | "ProfileActivities" | "ProfileCertificates" | "ProfileResults" | "ProfileBlog" | "ProfileXprofile" | "ProfileInvites" | "ProfileFriends" | "ProfileForums" | "ProfileGroups" | "GroupMessages" | "GroupMessageCreatePostScreen" | "GroupActivity" | "GroupPhotos" | "GroupAdmin" | "GroupManageSettings" | "GroupManageSettingsForm" | "GroupManageCoverPhoto" | "GroupManageMembers" | "GroupManagePhoto" | "GroupManageDelete" | "GroupManageDetails" | "GroupMembers" | "GroupSubgroups" | "GroupInvite" | "SelectGroupMembers" | "PendingInvites" | "SubmitInvite" | "GroupRequests" | "GroupCourses" | "ProductSingleScreen" | "ActivitySingleScreen" | "BlogSingleScreen" | "BlogSingleDeeplink" | "BlogReplyScreen" | "MyLibraryScreen" | "DownloadedCoursesScreen" | "BlogScreen" | "SettingsScreen" | "GroupsScreen" | "NotificationsScreen" | "TopicsScreen" | "CourseCategoriesScreen" | "ActivitiesScreen" | "MessagesScreen" | "MembersScreen" | "ForumsScreen" | "ProductsScreen" | "EmailInvitesSendScreen" | "EmailInvitesSentScreen" | "EmailInviteMessageScreen" | "SendFeedbackScreen" | "ReportBugScreen"

# MainStackScreenNames

# MapStateToProps(state) → {Object}

Parameters:
Name Type Description
state Object

Redux state
  • Props
Object
Object

# Member

Object

# MemberItemComponentProps

Properties:
Name Type Attributes Description
groupId Number <nullable>

Group Id
groupMember Boolean <nullable>

Returns true if user is a member of the group
colors Object

App colors
global Object

App global style
item MemberViewModel
index Number

Index of the item in the list
t TranslationFunction
actions Array

Member actions
settings Object

App settings
lastItem Boolean

Returns true if it is the last element in the list
locale String
rawData Object

Member data from API
Object

# MembersWidgetTitleProps

Properties:
Name Type Description
global Object

App global style
colors Object

App colors
icon String
title String

Title of the widget
seeMoreHidden Boolean

Returns false by default
seeMoreHandler function

Helper function that redirects to appropriate screen
seeMoreLabel String

Default label of "See More" button
users Array.<MemberViewModel>
t TranslationFunction
navigation NavigationService
Object

# MemberViewModel

Properties:
Name Type Attributes Description
id Number

Id of member
someoneelse Boolean

Returns true if member is not the user logged in
fullname String

Full name of user
avatarUrl String

Url to user's avatar
avatarFull String

Url to user's full avatar image
friendStatus String

Returns friend status
nicename String

Returns a nice name format of user's name
friendshipId Number <nullable>

Returns the friendship id between logged in user and user loaded in the model
lastActivity String

Returns last activity of user
onClick function

Can be used to redirect to user's profile
coverSrc String

Url to user's cover image
points Number

Points associated to user
userPoints Array

User points information
type String

User type
registeredDate String

Date when the user registered
groupJoiningDate String

Date when the user joined the group
followers Number

Number of followers
following Number

Number of persons that the user is following
can_report Boolean

Returns true if user can be reported
reported Boolean

Returns true if user has already been reported
inviter MemberViewModel

Inviter member details
Object

# MessageSingleComponentProps

Properties:
Name Type Description
item Object

Message data
index Number
user MemberViewModel
toThread function

Helper function to redirect user to the message thread screen
t TranslationFunction
global Object

App global style
colors Object

App colors

# MoreScreenNavigationCallback(navigation, routeName, menuItem, userId)

Parameters:
Name Type Description
navigation NavigationService
routeName String
menuItem Object

Information about the menu item such as label, icon, type
userId number

Logged-in user's id
Object

# MoreScreenRendererProps

Properties:
Name Type Description
screenProps Object
navigation NavigationService
settings Object

App settings
user MemberViewModel
menuSettings Object

Information about the menu such as items in the tab bar and in the more screen
auth Object

Logged-in user information
onMenuItemPress function

Default navigation function or what was set in moreScreenApi.navigationHandler hook
sections Object

Menu items in more screen
Object

Nativation object from "react-navigation"

Properties:
Name Type Description
navigate function
dispatch function
See:
Object
Properties:
Name Type Description
navigation NavigationService

Navigation object
dispatch function

Dispatch function
Parameters:
Name Type Description
navigator Navigator

Root navigator object
"Auth" | "noAuth" | "Main" | "All"
Object

# NotificationItemMoreButtonProps

Properties:
Name Type Description
global Object

App global style
colors Object

App colors
notList Boolean

Returns true if component is not being used in a list such as if it's being used in the Block Screen's Notifications Widget
Object

# NotificationsItemRowComponentProps

Properties:
Name Type Description
styles Object

Notification item styles
renderContent function

Helper function which renders the content of the notification item row. Parameters to pass in order are: align, truncate, global, colors, item, textColor, navigation
global Object

App global style
colors Object

App colors
item Object

Notification object
textColor String
navigation NavigationService
formatDateFunc function

Helper function which returns time since last posted
DefaultMetadataComponent React.ComponentType

Can be used to render the default metadata component. Requires the following props: global, formatDateFunc, item
Object

# NotificationsItemWidgetAvatarComponentProps

Properties:
Name Type Description
item Object

Notification object
styles Object

Default notification item styles
notList Boolean

Returns boolean which can be used to set marginLeft of notification item
getAvatar function

Helper function which returns the url of the user's avatar
Object

# NotificationsItemWidgetContentComponentProps

Properties:
Name Type Description
item Object

Notification object
textStyle Object

Default notification text styles
textProps Object

Contains information on how text should be rendered
truncate Boolean

Returns true if line content should be limited
capitalizedStrippedTitle String

Returns title with capitalized character
navigation NavigationService
global Object

App global style
colors Object

App colors
Object

# NotificationsItemWidgetMetadataComponentProps

Properties:
Name Type Description
item Object

Notification object
formatDateFunc function

Helper function which returns time since last posted
global Object

App global style
Object

# NotificationsItemWrapperComponentProps

Properties:
Name Type Description
global Object

App global style
colors Object

App colors
item Object

Notification object
navigation NavigationService
actionButtons Array

Action buttons for ActionSheetButtonWrapper
t TranslationFunction
notList Boolean

Returns true if component is not being used in a list such as if it's being used in the Block Screen's Notifications Widget
renderInnerContent function

Can be used by ActionSheetButtonWrapper to render the notification item row content
renderSheetHeader function

Can be used by ActionSheetButtonWrapper to render its ActionSheetHeader
shouldOpen Boolean

Returns true if action sheet should open upon initialization
wrapStyle Object

Default wrap component style
Object

# NotificationsMoreButtonWrapperComponentProps

Properties:
Name Type Description
global Object

App global style
colors Object

App colors
item Object

Notification object
navigation NavigationService
actionButtons Array

Action buttons for ActionSheetButtonWrapper
t TranslationFunction
notList Boolean

Returns true if component is not being used in a list such as if it's being used in the Block Screen's Notifications Widget
renderInnerContent function

Can be used by ActionSheetButtonWrapper to render the notification item row content
renderSheetHeader function

Can be used by ActionSheetButtonWrapper to render its ActionSheetHeader
shouldOpen Boolean

Returns true if action sheet should open upon initialization
wrapStyle Object

Default wrap component style
Object

# NotificationsWidgetTitleProps

Properties:
Name Type Description
global Object

App global style
colors Object

App colors
icon String
title String

Title of the widget
textColor String
seeMoreHidden Boolean

Returns false by default
seeMoreHandler function

Helper function that redirects to appropriate screen
seeMoreLabel String

Default label of "See More" button
notifications Array.<Object>

Notification object
t TranslationFunction
navigation NavigationService

# OnChangeEventListenerCallback(id, groupKey, required, isDate, newValue)

Parameters:
Name Type Description
id Number

Field id
groupKey Number

Group key
required Boolean

Returns true if value for field is required
isDate Boolean

Returns true if input is date
newValue String

Returns value of input

# OnNavigationStateChangeCallback(navState)

Parameters:
Name Type Description
navState Object

Navigation state object from React Native WebView's onNavigationStateChange method

# OnShouldStartLoadWithRequestCallback(index, req, isLoading, isFocused, currentUrl, nextUrl, isExternalDeeplink, onNext, openExternal, shouldOpenInExternalBrowser, isSameSite, attemptDeepLink)

Parameters:
Name Type Description
index Number

Web view page index
req Object

Request object from React Native WebView's onShouldStartLoadWithRequest method
isLoading Boolean

Returns true if component is currently loading
isFocused Boolean

Returns true if webview is focused
currentUrl Object

Data of current url
nextUrl Object

Data of next url
isExternalDeeplink function

Helper function to determine if deep link url should be opened externally
onNext function

Helper function to render the new WebView and animate the current WebView out of view
openExternal Boolean

Returns value of navigation state's open_external data
shouldOpenInExternalBrowser function

Helper function to determine if url should open in an external browser
isSameSite Boolean

Returns true if the url to open has the same host name as app's server url
attemptDeepLink function

Helper function to attempt deep link

# OverrideQuestionHTMLWrapperCallback(HTML, inputHTML, css)

Parameters:
Name Type Description
HTML String

Default HTML wrapper
inputHTML String

HTML that contains the input element
css String

CSS passed to webview by default

# OverrideQuestionImageSizeCallback(Boolean, Number) → {number}

Parameters:
Name Type Description
Boolean isPopup

Returns true if component is intended to be displayed in a modal
Number value

Current image max width
number

# PageRenderer(props, component)

Parameters:
Name Type Description
props Object

Props which can be used to create a custom page renderer
component React.ComponentType.<any>

Default component used in the app
Object

# PrevNextComponentProps

Properties:
Name Type Attributes Description
onQuizClick function

Function to execute if previous or next button is a quiz
onLessonClick function

Function to execute if previous or next button is a lesson
onTopicClick function

Function to execute if previous or next button is a topic
global Object

App global style
colors Object

App colors
t TranslationFunction
prevObject Object <nullable>

Information about previous lesson/topic/quiz
nextObject Object <nullable>

Information about next lesson/topic/quiz
courseId Number

Course id of lesson/topic/quiz
nextLockedAlert function

Shows an alert with information that next object is locked
Object

# PrevNextPlaceholderProps

Properties:
Name Type Description
global Object

App global style
Object

# ProductListComponentProps

Props listed below are props related to IAP. Actual prop might contain more data.

Properties:
Name Type Description
storeProductPairs Array.<Object>

Information about loaded products
productsIds Array

Ids of products
iapSettings Object

Settings related to in-app purchases
"xprofile" | "courses" | "certificates" | "gamipress_points" | "gamipress_achievements" | "gamipress_ranks" | "badgeos_points" | "badgeos_achievements" | "badgeos_ranks" | "results" | "favourites" | "subscribed" | "replies" | "topics" | "activities" | "forums" | "friends" | "blocked_users" | "groups" | "documents"

# ProfileTab

Object

# ProgressBarComponentProps

Object

# ProgressCircleComponentProps

Object

# ProgressListItemComponentProps

Properties:
Name Type Description
item Object
global Object

App global style
colors Object

App colors
onPress function

onPress handler
allowNavigation Boolean
"webview" | "htmlparser"

# QuestionClosedRenderMode

Object

# QuizHeaderProps

Properties:
Name Type Attributes Description
quiz QuizViewModel
currentSwiperPosition Number
global Object

App global style
labels Object

Learndash labels
questions Object.<Array>

Current questions in the quiz
quizOrder Number
quizTotalCount Number
colors Object

App colors
setHeaderHeight function

Helper function which can be called to set header height
renderQuizTimer Boolean | React.ComponentType

Returns false if quiz doesn't have a timer set. Will return a component if timer for the quiz is set.
t TranslationFunction
navigation NavigationService
onQuizClick function

Function to execute if previous or next button is a quiz
onLessonClick function

Function to execute if previous or next button is a lesson
onTopicClick function

Function to execute if previous or next button is a topic
courseId Number

Course id of lesson/topic/quiz
nextObject Object <nullable>

Information about next lesson/topic/quiz
prevObject Object <nullable>

Information about previous lesson/topic/quiz
course CourseViewModel
nextLockedAlert function

Shows an alert with information that next object is locked
isResultsVisible Boolean

Returns true if screen is currently showing the results of the quiz
backToCourse React.ComponentType

Returns default back button component
hidePrevNext Boolean

Returns true if prev/next buttons should be hidden
prevNext Boolean | React.ComponentType

Returns false if hidePrevNext is true. Will return buttons which can navigate through previous and next screens if hidePrevNext is false
Object

# QuizPrevNextComponentProps

Properties:
Name Type Attributes Description
onQuizClick function

Function to execute if previous or next button is a quiz
onLessonClick function

Function to execute if previous or next button is a lesson
onTopicClick function

Function to execute if previous or next button is a topic
global Object

App global style
colors Object

App colors
t TranslationFunction
prevObject Object <nullable>

Information about previous lesson/topic/quiz
nextObject Object <nullable>

Information about next lesson/topic/quiz
courseId Number

Course id of lesson/topic/quiz
nextLockedAlert function

Shows an alert with information that next object is locked
Object

# QuizScreenHeaderProps

Properties:
Name Type Description
QuizHeaderProps QuizHeaderProps
headerLeftStyle Object

Default styling for left section of the header
style Object

Default styling of lesson header
Object

# QuizTitleComponentProps

Properties:
Name Type Description
QuizHeaderProps QuizHeaderProps
Object

# QuizViewModel

Properties:
Name Type Description
id Number

Quiz id
title Object

Quiz title
date String

Date when quiz was created
date_gmt String

Date when quiz was created
modified String

Date when quiz was last modified
modified_gmt String

Date when quiz was last modified
link String

Url to quiz
slug String

Slug of url to quiz
author Number

User id of author
course Number

Course id where quiz is located
lesson Number

Lesson id where quiz is located
topic Number

Topic id where quiz is located
completed Boolean

Returns true if quiz has been completed
can_take_again Boolean

Returns true if quiz can be taken again

# Reducer(previousState, action) → {ReduxStore}

Redux reducer

Parameters:
Name Type Description
previousState ReduxStore

The current state
action ReduxAction

An action to execute to update the store
See:

The next state

ReduxStore

# ReducerWrapper() → {Reducer}

Parameters:
Type Description
Reducer

Original reducer
  • Changed reducer
Reducer
Object

# ReduxAction

Redux action

Properties:
Name Type Description
type String

Indicator for the handling of the action
See:

# ReduxMiddleware()

See:
Object

# ReduxStore

See:
Object

# RemoteImageSource

Object

# ReplyItemAvatarProps

Properties:
Name Type Description
reply Object

Reply details
global Object

App global style
isNested Boolean

Returns true if the reply is nested inside a reply
Object

# ReplyItemContentProps

Properties:
Name Type Description
formatTextForDisplay function

Helper function which formats a text
filterContentCss function

Helper function which filters css to a safe format
reply Object

Reply details
colors Object

App colors
t TranslationFunction
global Object

App global style
tagsStyles Object

Default styling for HTML tags
imagesInitialDimensions Object
computedWidth Number
referer String

Used by iframeRender to add referer to a webview
alterChildrenHTML function

Helper function which cleans up HTML
attemptDeepLink function

Helper function to attempt deep link
aTagRenderer function

Helper function for rendering anchor tags
iframeRender function

Helper function for rendering iFrame in an HTML
Object

# ReplyItemHeaderProps

Properties:
Name Type Description
global Object

App global style
headerTitleStyle Object

Default styling applied to the component
reply Object

Reply details
formatDateFunc function

Helper function which can be used to format dates

# RNStyleValue

React Native Style Object. Refer to: https://reactnative.dev/docs/style

Object

# RoutesObject

Example
{
    AppLockScreen: {screen: AppLockNavigator},
    Main: {screen: MainScreenNavigator, navigationOptions: {header: null}},
	   ...
}
AuthStackScreenNames | MainStackScreenNames | MainMenuScreenNames

# ScreenName

Object

# screenProps

Properties:
Name Type Description
global Object
colors Object
t TranslationFunction
isFeatureEnabled boolean
Object

# ScrollHeaderProps

Properties:
Name Type Attributes Description
headerProps Array.<headerProps>
navigation NavigationService
screenTitle String

Title of screen
global Object

App global style
t TranslationFunction
headerTitleStyle Object
screenSubtitle String <nullable>

# SearchInputComponent(props) → (nullable) {React.ComponentType.<any>}

Parameters:
Name Type Description
props SearchProps
React.ComponentType.<any>
Object

# SearchProps

Properties:
Name Type Description
searchTerm String
setSearchTerm function
inputProps Object
global Object

App global style
colors Object

App colors
animatedHeight Animated.Node.<number>
containerStyle Object

Default search component container style
renderAdvancedSearch function | Boolean
t TranslationFunction
cancelSearchTextStyle Object

Default cancel component style
lightStyle Boolean

Returns true to suggest that component should have a light theme

# ServerUrlOverriderFunction(sitesState) → (nullable) {string}

Parameters:
Name Type Description
sitesState SitesState

url

string
Object

# SettingsListProps

Properties:
Name Type Description
navigation navigationService
settings Object

App settings from API
config Object

App config from API
user Object

Information about logged-in user
lockAppFeatureEnabled Boolean

Returns true if lock app feature is enabled
pushNotificationsEnabled Boolean

Returns true if push notification feature is enabled
isMultisiteEnabled Boolean

Returns true if multisite feature is enabled
isBiometricEnrolled Boolean

Returns true if biometric is enrolled
isLocalAuthEnabled Boolean

Returns true if local auth is enabled
supportedBiometric Number

Returns the number of supported biometric
autoLock Boolean

Returns true if auto lock is enabled
autoLockDuration Number

Returns the number of auto lock duration in seconds
bugReportingEnabled Boolean

Returns true if bug reporting is enabled
feedbackEnabled Boolean

Returns true if sending of feedback is enabled
hasDevAccess Boolean

Returns true if app has dev access
termsPage Object

Title and link to terms page
privacyPage Object

Title and link to privacy page
restorePurchases function

Function to restore app purchases
logout function

Function to logout from app
toggleLocalAuth function

Function to enable or disable app local authentication
toggleLocalAuthAutoLock function

Function to enable or diable auto lock of app
changeAutoLockDuration function

Function to change auto lock duration
Object

# ShakeMenuItem

Properties:
Name Type Description
title string
onPress function

# ShouldUpdateCallback(thisProps, nextProps, thisState, nextState) → {Boolean}

Parameters:
Name Type Description
thisProps Object

Current props
nextProps Object

Next props
thisState Object

Current state
nextState Object

Next state

Return true if component should update

Boolean
Boolean

# ShowSearchProps

Returns true if "Allow forum wide search" in BuddyBoss plugin is checked

Object

# SignupButtonProps

Properties:
Name Type Description
disabled Boolean

Returns true if button should be disabled
global Object

App global style
doSignup function

Default signup function
label String

Button label
loading Boolean

Returns true if button is loading
spinnerColor Boolean

Returns spinner color in button
visibleFields Array.<Object>

Visible fields in sign up form
fieldValues Object

Default field values. See: https://react-hook-form.com/v5/api#getValues
formState Object

Information about form state. See: https://react-hook-form.com/v5/api#formState
getValues function

Returns entire form data. See: https://react-hook-form.com/v5/api#getValues
Object

# SignupFields

Properties:
Name Type Attributes Description
display boolean <nullable>
id string

Ex: signup_email, field_1
label string

Field's label
member_type string
options Array.<any>

If field is a checkbox, this contains the checkbox fields
required boolean

True if field is required
type string

Ex: email, checkbox

# SignupFieldsFilterCallback(fields) → {Array.<SignupFields>}

Parameters:
Name Type Description
fields Array.<SignupFields>

Old fields array

Changed fields array

Array.<SignupFields>
Object

# Site

Properties:
Name Type Attributes Description
blog_id number
blogname string
domain string
path string
siteurl string
app_home_screen_logo string <nullable>
app_splash string <nullable>
Object

# SitesState

Properties:
Name Type Attributes Description
sites Array.<Site> <nullable>
selectedSite Site <nullable>
Object

# StoreApi

Object

# SubscreenObject

Object

# Tab

Properties:
Name Type Description
icon String
label String
count Number

Indicates badge value
loading Boolean
onPress function

Default function of the tab
Object

# ThreadItemAvatarProps

Properties:
Name Type Description
message Object

Message data filtered by a view model
thread Object

Contains thread information such as recipients, messages etc
item Object

Message data
size Number

Default avatar size in message thread item
source Object

Contains uri of user image
style Object

Default thread item style
Object

# ThreadItemHeaderProps

Properties:
Name Type Description
message Object

Message data filtered by a view model
thread Object

Contains thread information such as recipients, messages etc
item Object

Message data
global Object

App global style
Object

# ThreadItemTextProps

Properties:
Name Type Description
message Object

Message data filtered by a view model
thread Object

Contains thread information such as recipients, messages etc
item Object

Message data
t TranslationFunction
global Object

App global style
attemptDeepLink function

Attempt deep linking
size Number

Character length to display
Object

# TopicContentComponentProps

Properties:
Name Type Description
topicProps TopicProps
tagsStyles Object

Styles used for different HTML tags
content String

Topic content
attemptDeepLink function

Helper function to attempt deep link
computedWidth Number

Default computed width of component to render
Object

# TopicItemHeaderProps

Properties:
Name Type Description
item TopicViewModel
formatDateFunc FormatDateFunction

Function to help format date
global Object

App global style
textColor String

Default text color
linkColor String

Default link color
light Boolean

Returns true if text should be light colored
alignItems String

Default alignment of items
avatarSize Number

Default size of avatar
titleStyle Object

Default styling for title
actionButtons Object

Topic functions from redux
Object

# TopicItemProps

Properties:
Name Type Description
firstItem Boolean

Returns true if data is the first item in the list
topic TopicViewModel
formatDateFunc FormatDateFunction

Function to help format date
styles Object

App global style and app colors
actionButtons Object

Topic functions from redux
t TranslationFunction
Object

# TopicItemWidgetComponentProps

Properties:
Name Type Description
topic Array.<Object>

Contains topic object with fields such as title, shortContent, id etc.
isLast Boolean

Returns true if current item is last in the list
global Object

App global style
colors Object

App colors
Object

# TopicMetadataComponentProps

Properties:
Name Type Description
topicProps TopicProps
Object

# TopicProps

Properties:
Name Type Description
global Object

App global style
colors Object

App colors
t TranslationFunction
topic TopicViewModel
Object

# TopicReplyButtonProps

Properties:
Name Type Description
topicProps TopicProps
topicCloseForUser Boolean

Returns true if topic is closed for the logged-in user
openClosedDiscussionModal function

Helper function that shows a modal if the topic has been closed to new replies
Object

# TopicsWidgetComponentProps

Properties:
Name Type Description
title String

Title for the widgets container
topics Array.<Object>

Contains topics object with fields such as title, slug, id etc.
onTopicSeeAllClick function

Function that will redirect to the topics list
onTopicClick function

Function that will redirect to the topic
onAvatarClick function

Function that will redirect to the profile of the author of the topic
t TranslationFunction
Object

# TopicsWidgetTitleProps

Properties:
Name Type Description
global Object

App global style
colors Object

App colors
icon String
title String

Title of the widget
textColor String
seeMoreHidden Boolean

Returns false by default
seeMoreHandler function

Helper function that redirects to appropriate screen
seeMoreLabel String

Default label of "See More" button
topics Array.<TopicViewModel>
t TranslationFunction
navigation NavigationService
Object

# TopicTitleComponentProps

Properties:
Name Type Description
topicProps TopicProps
Object

# TopicViewModel

Properties:
Name Type Description
id Number

Topic id
title String

Topic title
shortContent String

Topic short content
author Object

Details about topic creator
replyCount String

Number of replies in the topic
voiceCount String

Number of members replied in the topic
date String

Date created
canSeeReplies Boolean

Returns true if logged in user can see replies
canReply Boolean

Returns true if logged in user can reply
content String

HTML string of topic content
mediaItems Array

Media items in the topic
lastActive String

Date of the topic's last activity
forumTitle String

Forum title of the topic's parent
navigateToForum function

Function to navigate to topic's forum
navigateToProfile function

Function to navigate to topic author's profile
newReply function

Function to open new reply screen
favourite function

Function to toggle topic as favourite

# ToUserBasedOnSettings(selectedTabIdnullable, User, params)

Parameters:
Name Type Attributes Description
selectedTabId String <nullable>

Profile subscreen idenitifier
User User

User to navigate to
params Object

Params to send through route

# TransformActivitiesParams() → {Object}

Parameters:
Type Description
FetchActivitiesParams
Object

# TransformBlogButtonsCallback()

Properties:
Name Type Description
buttons Array

Buttons for comment, facebook and twitter share
blog BlogViewModel

# TransformBlogParams() → {Object}

Parameters:
Type Description
FetchBlogParams
Object

# TransformBlogSubFiltersFilterCallback() → {Object}

Properties:
Type Description
BlogSubFilterProps
Object

# TransformCategoriesSubFiltersFilterCallback(filters) → {Array.<string>}

Parameters:
Name Type Description
filters Array.<string>

Available filters: title, date
Array.<string>

# TransformContentHeadersCallback(headers, rootSiteUrl, url, accessToken) → {Object}

Parameters:
Name Type Description
headers Object
rootSiteUrl String
url String
accessToken String
  • New headers object
Object

# TransformCourseActionButtonsCallback()

Properties:
Name Type Description
buttons React.ComponentType

Course action button
course CourseViewModel
t TranslationFunction
colors Object

App colors
global Object

App global style
products Array.<Object>

Products for IAP
navigation NavigationService
startCourse function

Function to start a course
continueCourse function

Function to continue a course
continueCourse React.ComponentType

Renders pricing for the course

# TransformCourseCategoriesParams() → {Object}

Parameters:
Type Description
FetchCourseCategoriesParams
Object

# TransformCourseViewModelCallback() → {Object}

Properties:
Name Type Description
viewModel CourseViewModel
course Object

Course raw data from API
params Object

Additional data passed by component
navigation NavigationService

New view model

Object

# TransformDocumentsParams() → {Object}

Parameters:
Type Description
FetchDocumentsParams
Object

# TransformEditProfileFieldSetsCallback(fieldSets) → {Array.<FieldSetObject>}

Parameters:
Name Type Description
fieldSets Array.<FieldSetObject>

List of field sets

New list of field sets

Array.<FieldSetObject>

# TransformEditProfileFieldSetsFilterCallback(list) → {Array.<Object>}

Parameters:
Name Type Description
list Array.<Object>

List of filters

New list of filters

Array.<Object>

# TransformForumActionButtonsCallback()

Properties:
Name Type Description
action Array.<Object>

Contains objects for default action buttons

# TransformForumParamsCallback(ForumsGetParam) → {Object}

Parameters:
Name Type Description
ForumsGetParam ForumsGetParam
Object

# TransformForumViewModelCallback(viewModel, forum) → {Object}

Parameters:
Name Type Description
viewModel Object
forum Forum
Object

# TransformGroupActionButtonsCallback(action) → {Array.<Object>}

Parameters:
Name Type Description
action Array.<Object>

Contains group's default action
Array.<Object>

# TransformGroupActionsCallback() → {Array.<ButtonConfig>}

Parameters:
Type Description
Array.<ButtonConfig>
Array.<ButtonConfig>

# TransformGroupActivityCallback(list) → {Array.<string>}

Parameters:
Name Type Description
list Array.<ActivitySubFilter>
Array.<string>

# TransformGroupsParams() → {Object}

Parameters:
Type Description
FetchGroupsParams
Object
Object

# TransformGroupSubFiltersFilterCallback

Properties:
Name Type Description
type Object

Filter types such as active, popular, newest, alphabetical
group_type Object

Group types

# TransformGroupTabListCallback(tabs)

Parameters:
Name Type Description
tabs Array.<Tab>

Tabs in groups screen

# TransformLessonActionButtonsCallback()

Properties:
Name Type Description
lessonButton React.ComponentType

Lesson action button
showComplete Boolean

Returns true if "Mark as Complete" button should be shown
global Object

App global style
colors Object

App colors
lesson LessonViewModel
completing Boolean

Returns true if lesson is being completed
labels Object

Labels in the lesson

# TransformMemberActionsCallback() → {Array.<ButtonConfig>}

Parameters:
Type Description
Array.<ButtonConfig>
Array.<ButtonConfig>

# TransformMembersParams() → {Object}

Parameters:
Type Description
FetchMembersParams
Object

# TransformMemberViewModelCallback(viewModel, item, toUserBasedOnSettings, isOwnAccount, isProfile) → {Object}

Parameters:
Name Type Description
viewModel MemberViewModel
item Object

Member data from API
toUserBasedOnSettings ToUserBasedOnSettings
isOwnAccount Boolean

Returns true if item is logged in user's own account
isProfile Boolean
Object

# TransformMessagesParams() → {Object}

Parameters:
Type Description
FetchMessagesParams
Object

# TransformModalStyleCallback(styles) → {Object}

Parameters:
Name Type Description
styles Object
Object

# TransformMoreScreenListCallback(section, dispatch, navigation, toUserBasedOnSettings, attemptDeepLink, auth) → {Array.<Object>}

Parameters:
Name Type Description
section Array.<Object>

Menu item information
dispatch function

Redux dispatch function
navigation NavigationService
toUserBasedOnSettings function

Navigate to user function
attemptDeepLink function

Attempt deep linking
auth Object

User details

Modified section

Array.<Object>

# TransformNotificationsParams() → {Object}

Parameters:
Type Description
FetchNotificationsParams
Object

# TransformParams() → {Object}

Parameters:
Type Description
FetchCourseParams
Object

# TransformPhotosParams() → {Object}

Parameters:
Type Description
FetchPhotosParams
Object

# TransformPrivateGroupIgnoredItemsCallback(list) → {Array.<string>}

Parameters:
Name Type Description
list Array.<string>

list of items that should not show to non-members if group is private
Array.<string>

# TransformProfileActivityFilters(list) → {Array.<string>}

Parameters:
Name Type Description
list Array.<ActivitiesFilter>
  • New list
Array.<string>

# TransformProfileIgnoredSubscreensCallback(list, isOwnAccount) → {Array.<string>}

Parameters:
Name Type Description
list Array.<ProfileTab>

Ignored subscreens list
isOwnAccount Boolean

Returns true if profile displayed in screen is logged-in user's own account

New list of ignored subscreens

Array.<string>

# TransformProfileSubscreensListCallback(list, navigation, user, isOwnAccount) → {Array.<SubscreenObject>}

Parameters:
Name Type Description
list Array.<SubscreenObject>

Subscreens list
navigation NavigationService
user User
isOwnAccount Boolean

Returns true if profile displayed in screen is logged-in user's own account

New subscreens list

Array.<SubscreenObject>

# TransformSubFiltersFilterCallback(filters) → {Array.<string>}

Parameters:
Name Type Description
filters Array.<string>

Available filters: title, recent, my_progress
Array.<string>

# TransformSubFiltersFilterCallback(filters) → {Array.<string>}

Parameters:
Name Type Description
filters Array.<string>

Available filters: activity, date, title, popular
Array.<string>

# TransformTopicActionButtonsCallback()

Properties:
Name Type Description
topicButton React.ComponentType

Topic action button
showComplete Boolean

Returns true if "Mark as Complete" button should be shown
global Object

App global style
colors Object

App colors
topic TopicViewModel
completing Boolean

Returns true if topic is being completed
labels Object

Labels in the topic
handleComplete function

Function that marks the topic as complete

# TransformTopicsParams() → {Object}

Parameters:
Type Description
FetchTopicsParams
Object

# TransformTopicSubFiltersFilterCallback(filters) → {Array.<string>}

Parameters:
Name Type Description
filters Array.<string>

Available filters: activity, date, title, popular
Array.<string>

# TransformTopicViewModelCallback(viewModel, topic) → {Object}

Parameters:
Name Type Description
viewModel TopicViewModel
topic Object
  • new view model
Object

# TransformTranslationCallback() → {Translation}

Parameters:
Type Description
Translation
Translation

# TransformViewProfileFieldSetsCallback(fieldSets) → {Array.<FieldSetObject>}

Parameters:
Name Type Description
fieldSets Array.<FieldSetObject>

List of field sets

New list of field sets

Array.<FieldSetObject>
Object.<LanguageLocale, {key: string}>

# Translation

Example
"en_US" :{
	// Key                      value
	"common.failDefaultMessage": "Server request failed",
}

# TranslationFunction() → {string}

Parameters:
Type Description
string
string
Example
t("common:ok") // gives "Ok"
Object

# Typography

Properties:
Name Type Description
bodyText FontStyle
appHeaderTitle FontStyle
appHeadings FontStyle
appTabBar FontStyle
appMenus FontStyle
Object

# User

Logged-in user's data

Object

# UserAgreementModalComponentProps

Properties:
Name Type Description
calcFontSize function

Used to calculate font size based on the fixed value you assign and percent set on branding options
authDarkStyle Boolean

Returns true if component should use dark style
config Object
modalContent String

Modal content string
modalHeader String

Modal header string
onClosed function

Helper function which resets the modal
refModal function

Modal reference
hideModal function

Helper function which closes the modal
global Object

App global style
colors Object

App colors
t TranslationFunction
termsOfService Object

Terms of service data
privacyPolicy Object

Privacy policy data
withCheckbox Boolean

Returns true if component should have a checkbox
onPress function

Helper function which shows the user agreement content
onAgreementChecked function

Sets the state of agreementChecked
agreementChecked function

Returns true if agreement is checked
Object

# UserAgreementTextComponentProps

Properties:
Name Type Description
t TranslationFunction
authBg String

Screen background color
global Object

App global style
backgroundColor String

input wrap background color
textColor String
userIcon Number

Default user icon
setUsernameState function

Helper function for setting the username state
stateUsername String

Username field state
placeholderColor String
calcFontSize function
passwordIcon Number

Default password icon
setPasswordState function

Helper function for setting the password state
statePassword String

Password field state
doLogin function

Default login function
setInputRef function

Helper function which sets the component reference within the parent component

/**
register Boolean

Returns true if used for registration
global Object

App global style
colors Object

App colors
t TranslationFunction
termsOfService Object

Terms of service data
privacyPolicy Object

Privacy policy data
withCheckbox Boolean

Returns true if component should have a checkbox
onPress function

Helper function which shows the user agreement content
onAgreementChecked function

Sets the state of agreementChecked
agreementChecked function

Returns true if agreement is checked
Object

# UserAvatarProps

Properties:
Name Type Description
isOwnAccount Boolean

Returns true if the logged-in user is viewing their own account
t TranslationFunction
global Object
user MemberViewModel
Object

# UserFollowingComponentProps

Properties:
Name Type Description
user MemberViewModel
global Object

App global style
colors Object

App colors
t TranslationFunction
Object

# UserFullNameComponentProps

Properties:
Name Type Attributes Description
user MemberViewModel
global Object

App global style
textStyle Object
topicLoading Object <nullable>
Object

# UserHandleComponentProps

Properties:
Name Type Description
user MemberViewModel
global Object

App global style
textStyle Object
hideHandle Boolean

Returns true if a setting to hide the handle was set
Object

# UserRegisteredComponentProps

Properties:
Name Type Description
user MemberViewModel
global Object

App global style
t TranslationFunction
formatDateFunc function

Helper function for parsing dates
Object

# UserTypeComponentProps

Properties:
Name Type Description
isUserProfile Boolean
user MemberViewModel
global Object

App global style
textStyle Object

# ValidationFunction(responseObject) → {boolean}

Parameters:
Name Type Description
responseObject Object

Object returned in response
boolean
Object

# VideoProgressionComponentProps

Properties:
Name Type Description
lessonVideoStyle Object

Default styling applied to lesson video
controls Boolean

Returns true if controls should be displayed
autoplay Boolean

Returns true if auto play should be enabled
videoCallback function

Helper function which can be called when the video has finished playing
url String

Video url
width Number

Player width
height Number

Player height
global Object

App global style
isNavActive Boolean

Returns true if screen is active
lesson LessonViewModel
showVideo Boolean

Returns true if video should be shown
videoWatched Boolean

Returns true if video has already been watched
setVideoWatched function

Helper function which dispatches an action and marks the video as watched
completeLesson function

Helper function which dispatches an action to mark the lesson as complete
onCompleteButtonClick function

Helper function which considers different conditions (such as if topics inside a lesson are already completed) before calling the completeLesson function