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

# AchievementsComponentProps

AchievementsComponentProps

Properties:
Name Type Description
styles Record.<any, any>

Default styles
ContainerComponent React.ComponentType.<any>

Returns the default container component
achievements Record.<any, any>

Achievement data
navigateToAchievements function

Navigates to the achievements screen
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

ActionButtonProps

Properties:
Name Type Description
global Record.<any, any>

App global style
button Record.<any, any>

Default actions when button is pressed
color Record.<any, any>

Color for icon
style Record.<any, any>

Style for the button
t TTranslationFunction

Translation function
withLabel boolean

Returns true if button has label
labelStyle Record.<any, any>

Style for the label
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
Object

# ActiveSubFiltersProps

Properties:
Name Type Description
defaultSubFilters Object

Default subfilters for the screen
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
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

# ActivityCommentAvatarProps

Properties:
Name Type Description
userId Number

User id of the comment author
handleAuthorClick function

Navigates to the author's profile
size Number

Default avatar size
source Object

Default uri for author's image
Object

# ActivityCommentHeaderComponentProps

Properties:
Name Type Description
styles Object

Default styles
handleAuthorClick function

Used for navigating to the author's profile
username String

Author's name
date String

Comment date
item Object

Activity comment details
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
privacyModalVisible Boolean

Returns true if modal for setting privacy should be visible
contentWrapperStyle Object

Returns the default styling for the content wrapper
avatarSize Number

The default size of the avatar
hidePrivacy Boolean

Returns true if privacy indicator should be shown
profileAvatarType String

Avatar type to be displayed in the activitypost
enableProfileGravatar Boolean

Returns true if profile gravatar is enabled
defaultProfileAvatarType String

The default profile avatar type
defaultCustomProfileAvatarImage String

The default custom profile avatar image
activitiesFilter String

Active filter in the activities list
isGroupScreen Boolean

Returns true if component is being rendered in a group screen
renderActivityOptions function

Function to render activity options
Object

# ActivityImageComponentProps

Properties:
Name Type Description
thumbnail String

Url to image's thumbnail
source String

Url to image's source
styles Object

Default styles
resizeMode String

Default resize mode
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
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
Object

# AfterAboutSettingComponentProps

Properties:
Name Type Description
t TranslationFunction
global Object

App global style
colors Object

App colors
listProps Object

Object containing default list styles and other props
Object

# AfterActivityContentComponentProps

Properties:
Name Type Description
item ActivityViewModel
currentUser User
Object

# AfterActivitySingleComponentProps

Properties:
Name Type Description
item ActivityViewModel
index Number
currentUser User

# AfterAuthRoutesFilter(routes) → {RoutesObject}

Parameters:
Name Type Description
routes RoutesObject

Current routes

New routes

RoutesObject
object

# AfterBlogProfileHeaderProps

AfterBlogProfileHeaderProps

Properties:
Name Type Description
blog BlogViewModel
object

# AfterBlogSingleBodyProps

AfterBlogSingleBodyProps

Properties:
Name Type Description
blog BlogViewModel
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
linkClickHandler function

Helper function which is used for deep linking when a link is pressed
t TTranslationFunction
navigation NavigationService
object

# AfterDetailsComponentProps

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

AfterGroupDetailsComponentProps

Properties:
Name Type Description
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
group TGroupViewModel
object

# AfterGroupProfileHeaderProps

AfterGroupProfileHeaderProps

Properties:
Name Type Description
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
group TGroupViewModel
Object

# AfterHeaderComponentProps

Properties:
Name Type Description
props FilterProps
object

# AfterMaterialsComponentProps

AfterMaterialsComponentProps

Properties:
Name Type Description
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
lesson TLessonViewModel
labels Record.<string, string>

Learndash labels
t TTranslationFunction
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 Record.<any, any>

Data about previous lesson/topic/quiz
nextObject Record.<any, any>

Data 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 Course
navigation NavigationProp.<any, any>
materials undefined | string

Lesson materials
object

# AfterProfileDetailsComponentProps

AfterProfileDetailsComponentProps

Properties:
Name Type Description
user TMemberViewModel
object

# AfterProfileHeaderProps

AfterProfileHeaderProps

Properties:
Name Type Description
user TMemberViewModel

# 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
object

# AnswerResultMessageProps

AnswerResultMessageProps

Properties:
Name Type Description
hideSummaryMessage undefined | boolean

Returns true if summary message should be hidden
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
answer Record.<any, any>

Answer details
object

# AnswerResultModalMessageProps

AnswerResultModalMessageProps

Properties:
Name Type Description
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
styles Record.<any, any>

Default styles
answerResult Record.<any, any>

Answer details
t TTranslationFunction
showSummaryMessage boolean

Returns true if a summary message should be visible
correctIcon number

Returns the source of an icon if answer is correct
inCorrectIcon number

Returns the source of an icon if answer is incorrect
iconColor string

Returns default appropriate icon color
"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" | "pinActivity" | "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" | "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

Object

# ArcContentProps

Properties:
Name Type Description
config Object

App configuration object
t TranslationFunction
result Object

Quiz result details
quizVM QuizVM
size Number

Size of circle
progress Number

Percentage of the score
arcColor String

Default color depending on the value of the average score

# AssetFilterCallback(path, source) → {LocalImageSource}

Parameters:
Name Type Description
path string
source LocalImageSource
LocalImageSource
object

# AssignmentItemCommentProps

AssignmentItemCommentProps

Properties:
Name Type Description
pressHandler function

Opens the comments modal
tintColor string

Default button color
containerStyle Record.<any, any> | undefined

Default container style
count number

Number of comments
size string

Button size
global Record.<any, any>

App global style
lightMode boolean | undefined

Can be used to determine if button should use light or dark style
object

# AssignmentItemCommentProps

AssignmentItemCommentProps

Properties:
Name Type Description
pressHandler function

Opens the comments modal
tintColor string

Default button color
containerStyle Record.<any, any> | undefined

Default container style
count number

Number of comments
size string

Button size
global Record.<any, any>

App global style
lightMode boolean | undefined

Can be used to determine if button should use light or dark style
object

# AssignmentItemDownloadProgressProps

AssignmentItemDownloadProgressProps

Properties:
Name Type Description
progress number

Download progress
unfilledColor string

Unfilled color of the ProgressCircle component
tintColor string

Color of the ProgressCircle component
object

# AssignmentItemDownloadProgressProps

AssignmentItemDownloadProgressProps

Properties:
Name Type Description
progress number

Download progress
unfilledColor string

Unfilled color of the ProgressCircle component
tintColor string

Color of the ProgressCircle component
object

# AssignmentItemDownloadProps

AssignmentItemDownloadProps

Properties:
Name Type Description
pressHandler function

Downloads the assignment item
tintColor string

Default button color
containerStyle Record.<any, any> | undefined

Default container style
count number

Number of comments
size string

Button size
global Record.<any, any>

App global style
lightMode boolean | undefined

Can be used to determine if button should use light or dark style
object

# AssignmentItemDownloadProps

AssignmentItemDownloadProps

Properties:
Name Type Description
pressHandler function

Downloads the assignment item
tintColor string

Default button color
containerStyle Record.<any, any> | undefined

Default container style
count number

Number of comments
size string

Button size
global Record.<any, any>

App global style
lightMode boolean | undefined

Can be used to determine if button should use light or dark style
object

# AssignmentItemIconProps

AssignmentItemIconProps

Properties:
Name Type Description
icon number

Default icon for the item
styles Record.<any, any>

Default style for the item
object

# AssignmentItemIconProps

AssignmentItemIconProps

Properties:
Name Type Description
icon number

Default icon for the item
styles Record.<any, any>

Default style for the item
object

# AssignmentItemStatusProps

AssignmentItemStatusProps

Properties:
Name Type Description
global Record.<any, any>

App global style
text string

Assignment item status
containerStyle Record.<any, any>

Default container style
textStyle Record.<any, any>

Default text style
object

# AssignmentItemStatusProps

AssignmentItemStatusProps

Properties:
Name Type Description
global Record.<any, any>

App global style
text string

Assignment item status
containerStyle Record.<any, any>

Default container style
textStyle Record.<any, any>

Default text style
object

# AssignmentItemTitleProps

AssignmentItemTitleProps

Properties:
Name Type Description
title string

Assignment item title
style Record.<any, any>

Default style for the item
object

# AssignmentItemTitleProps

AssignmentItemTitleProps

Properties:
Name Type Description
title string

Assignment item title
style Record.<any, any>

Default style for the item
object

# AssignmentsHeaderProps

AssignmentsHeaderProps

Properties:
Name Type Description
global Record.<any, any>

App global style
t TTranslationFunction
totalAssignments number

Total number of assignments uploaded
approved number

Number of assignments approved
object

# AssignmentsHeaderProps

AssignmentsHeaderProps

Properties:
Name Type Description
global Record.<any, any>

App global style
t TTranslationFunction
totalAssignments number

Total number of assignments uploaded
approved number

Number of assignments approved
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

# AverageResultProps

Properties:
Name Type Description
quizVM QuizVM
global Object

App global style
styles Object
progressColor String
t TranslationFunction
result Object

Quiz result details
Object

# BackButtonComponentProps

Properties:
Name Type Description
navigation NavigationService
headerColor String
styles RNStyleValue

Back button default styling
delay Boolean | undefined

Returns true for default setting is to delay rendering
withUnderlay Boolean | undefined

Returns true if button should be rendered with an underlay
text String

Default text
textStyle Record.<any, any>

Default text style
textMaxWidth Number

Defaul text max width
colors Record.<any, any>

App colors
afterAction function

Action after the screen has navigated to the previous screen
handlePressParam function | undefined

Default behavior when button is pressed
containerStyle Object | undefined

Container style
fontIconName String | undefined

Font name of icon
fontIconWeight Number | undefined

Font weight of icon
Object

# BeforeActivitySingleComponentProps

Properties:
Name Type Description
item ActivityViewModel
index Number
currentUser User
object

# BeforeBlogSingleBodyProps

BeforeBlogSingleBodyProps

Properties:
Name Type Description
blog BlogViewModel
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
linkClickHandler function

Helper function which is used for deep linking when a link is pressed
t TTranslationFunction
navigation NavigationService
object

# BeforeDetailsComponentProps

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

BeforeGroupDetailsComponentProps

Properties:
Name Type Description
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
group TGroupViewModel
object

# BeforeProfileDetailsComponentProps

BeforeProfileDetailsComponentProps

Properties:
Name Type Description
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
user TMemberViewModel

# 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

# BlogComment

Blog comment

Properties:
Name Type Description
id number

Id of comment
post number

Id of post where comment was written
parent number

Id of the parent entity if the comment is a child of it
author number

Id of the author of the comment
author_name string

Author name
date string

Date when the comment was posted
content Record.<any, any>

Content of the comment
link string

Url to the comment
status string

Comment status
can_report boolean

Returns true if comment can be reported
reported boolean

Returns true if comment was reported
report_button_text string

Text of the report button
report_type string

Type of report
can_delete boolean

Returns true if comment can be deleted
object

# BlogDetailsComponentProps

BlogDetailsComponentProps

Properties:
Name Type Description
blog BlogViewModel
globalStyle Record.<any, any>

App global style
animatedOpacity function

Uses useMemo() hook and returns animatedOpacity
textStyle Record.<any, any>

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

# BlogHeaderAvatarProps

BlogHeaderAvatarProps

Properties:
Name Type Description
blog BlogViewModel
global Record.<any, any>

App global style
textStyle Record.<any, any>

Returns a 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
allowBookmark Boolean

Returns true if item can be bookmarked
bookmarkActions function

Toogles the bookmark action
isSavedItems Boolean

Returns true if currently viewing saved items only
Object

# BlogItemWidgetDetailsComponentProps

Properties:
Name Type Description
styles Object

Default styles
global Object

App global style
blog BlogViewModel
object

# BlogSingleBodyProps

BlogSingleBodyProps

Properties:
Name Type Description
blog BlogViewModel
online boolean

Return true if online
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
navigation NavigationService
config Record.<any, any>

App configuration object
tagsStyles Record.<any, any>

Tag default styles
baseFontStyle function

Function to set a font style
computedWidth number

Default computed width of component to render
linkClickHandler function

Helper function which is used for deep linking when a link is pressed
onShouldStartLoadWithRequest function

Helper function which can be passed to a webview to start a request by attempting to deep link
Object

# BlogSubFilterProps

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

Year values in the sub filter
object

# BlogWebViewProps

BlogWebViewProps

Properties:
Name Type Description
blog BlogViewModel
online boolean

true if device is online
t TTranslationFunction
webViewHeight number

Default height for the web view
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
source WebSource
onShouldStartLoadWithRequest function

function which can be used by the web view's onShouldStartLoadWithRequest prop
ModalHeaderComponent React.Component.<any>

Modal which shows up when the "Read More" component is pressed
Object

# BlogWidgetTitleProps

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
seeMoreHandler function

Helper function that redirects to appropriate screen
t TranslationFunction
Object

# BookmarkComponentProps

Properties:
Name Type Description
global Object

App global style
styles Object

Default styles
onPress function

Toggles bookmark function
hitSlop Object

Default hit slop assigned to the button
animatedStyle Object

Bookmark animation
fixAlignRight Boolean

Returns true if fix for alignRight should be added
bookmarked Boolean

Returns true item is bookmarked
fontIconName String

Default icon name
fontIconVariant String

Default icon variant
tintColor String

Tint color of bookmark
withUnderlay Boolean

Returns true if underlay style should be used
underlayTheme String

Returns underlay theme to be used
navigation NavigationService
object

# BookmarkComponentProps

BookmarkComponentProps

Properties:
Name Type Description
global Record.<any, any>

App global style
styles Record.<any, any>

Default styles
onPress function

Toggles bookmark function
hitSlop Record.<any, any>

Default hit slop assigned to the button
animatedStyle Record.<any, any>

Bookmark animation
fixAlignRight boolean

Returns true if fix for alignRight should be added
bookmarked boolean

Returns true item is bookmarked
fontIconName string

Default icon name
fontIconVariant string

Default icon variant
tintColor string

Tint color of bookmark
withUnderlay boolean

Returns true if underlay style should be used
underlayTheme string

Underlay theme to be used
navigation NavigationService

Navigation service
Object

# BottomTabBarProps

Properties:
Name Type Description
state Object

Route state information
descriptors Object

Bottom tab bar menu items
navigation NavigationService

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

Parameters:
Name Type Description
routes Object

Current bottom tab routes
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

ButtonConfig

Properties:
Name Type Description
permissionField string
statusField string
flow Array
Object

# ButtonConfig

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

# ButtonFlow

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

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

Object

# CategoryScoreComponentProps

Properties:
Type Description
ResultDetailsProps
object

# CategoryTagsHiddenCallback

CategoryTagsHiddenCallback

Properties:
Name Type Description
course TCourseViewModel
object

# CheckProperty

CheckProperty

Properties:
Name Type Description
object Record.<any, any>

# CheckProperty(object) → {Boolean}

Parameters:
Name Type Description
object Object

View model
Boolean
Object

# CircleProgressResultProps

Properties:
Name Type Description
progress Number

Percentage of the score
progressColor String

Filled color according to progress
width Number

Line width of circle
size Number

Size of circle
unfilledColor String

Default color used for the unfilled portion of the circle
children React.ComponentType

Component that contains the content of the circle
object

# CommentAvatarProps

CommentAvatarProps

Properties:
Name Type Description
avatarUrl string

Url of avatar
object

# CommentButtonsProps

CommentButtonsProps

Properties:
Name Type Description
comment BlogComment
t TTranslationFunction
onComment function

Links the reply to the comment being added in the input component
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
navigateToReport function

Opens a modal for reporting the comment
object

# CommentContentProps

CommentContentProps

Properties:
Name Type Description
commentVM BlogComment
global Record.<any, any>

App global style
blogCommentTagStyles Record.<any, any>

Default styles for blog comments
onLinkPress function

Helper function which is used for deep linking
object

# CommentHeaderProps

CommentHeaderProps

Properties:
Name Type Description
global Record.<any, any>

App global style
commentVM BlogComment
nameDateContainerStyle Record.<any, any>

Default style for container
object

# CommentReplyButtonsProps

CommentReplyButtonsProps

Properties:
Name Type Description
item BlogComment
t TTranslationFunction
replyPress function

Links the reply to the comment being added in the input component
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
navigateToReport function

Opens a modal for reporting the comment
object

# CommentsModalHeaderProps

CommentsModalHeaderProps

Properties:
Name Type Description
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
t TTranslationFunction
modalHeaderContainerStyle Record.<any, any>

Default style of modal header
closeCommentsModal function

Closes the modal
allowComments boolean

Returns true if comments are allowed in the post
object

# Course

Course

Properties:
Name Type Description
id number

Course id
title Record.<any, any>

Course title
content Record.<any, any>

Course content
date string

Date when course was created
date_gmt string

Date when course was created
modified string

Date when course was modified
modified_gmt string

Date when course was modified
link string

Link to the course
slug string

Slug of url to course
author number

User id of author
excerpt Record.<any, any>

Course excerpt
menu_order number
featured_media Record.<any, any>

Url to featured image
cover_media Record.<any, any>

Url to cover image
has_course_access boolean

Returns true if user has access
offline_disabled boolean

Returns true if offline disabled
has_content_access boolean

Returns true if logged-in user has access to course's content
materials undefined | string

Course materials
purchasable boolean

Returns true if course can be purchased
price Record.<any, any>

Course price and currency
hide_content_table boolean

Returns true if content table is hidden
progression number

User's progress in the course
is_closed boolean

Returns true if course is closed
can_enroll boolean

Returns true if user can enroll to course
points number
duration Record.<any, any>
categories Array

Course categories
tags Array

Course tags
enrolled_members number

Shows number of enrolled members
certificate Record.<any, any>

Certificate details
module Array
video string

Url to video of course
group number
forum number
lessons Array

Lessons associated to the course
quizzes Array

Quizzes associated to the course
completed boolean

Returns true if lesson has been completed
quiz_completed boolean

Returns true if quiz has been completed
show_start boolean

Returnstrue if start function should be showed
error_message Array
last_activity_time string
excerpt_native Record.<any, any>
content_native Array

Blocks in the course
bb_access Record.<any, any>

Access controls
bbapp_products Record.<any, any>

IAP products associated to the course
_link Record.<any, any>
_embedded Record.<any, any>
members Array

Shows members enrolled in course
Object

# CourseAuthorComponentProps

Properties:
Name Type Description
hideAuthor Boolean

Returns true if author of the course should be hidden
userId Number

User id of the course's author
global Object

App global style
colors Object

App colors
Object

# CourseBlock

Properties:
Name Type Description
title String
tint_color String
data_source Object

Object with fields such as course ids, type, any other data added via custom work
object

# CourseContentTitleProps

CourseContentTitleProps

Properties:
Name Type Description
global Record.<any, any>

App global style
t TTranslationFunction
labels Record.<any, any>
isCollapsable boolean

Returns true if course content is collapsable
expanded boolean

Returns true if collapsable items are already expanded
hideAll function

Hides all the collapsable items
expand function

Expands all the collapsable items
Object

# CourseDateComponentProps

Properties:
Name Type Description
showDate Boolean

Returns true if date of the course should be visible
styles Object

Default styles
date String

Course date
object

# CourseDescriptionHiddenCallback

CourseDescriptionHiddenCallback

Properties:
Name Type Description
course TCourseViewModel
object

# CourseDescriptionReadMoreComponentProps

CourseDescriptionReadMoreComponentProps

Properties:
Name Type Description
courseVM TCourseViewModel
openDescriptionModal function

Opens the desription modal
global Record.<any, any>

App global style
t TTranslationFunction
object

# CourseDescriptionSectionTitleProps

CourseDescriptionSectionTitleProps

Properties:
Name Type Description
shouldRenderBlocks boolean

Returns true if there are blocks to be rendered natively
courseVM TCourseViewModel
global Record.<any, any>

App global style
t TTranslationFunction
labels Record.<any, any>
object

# CourseHeaderDetailsProps

CourseHeaderDetailsProps

Properties:
Name Type Description
courseVM TCourseViewModel
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
labels Record.<any, any>
t TTranslationFunction
lCount number

Lessons count
tCount number

Topics count
qCount number

Quizzes count
learndashCourseParticipants number

Can be used to determine if participants should be shown in the component
navigation NavigationProp.<any, any>
shouldShowParticipants Boolean

Returns true if participants should be shown
shouldShowImageBackground Boolean

Returns true if course image should be shown
shouldShowVideo Boolean

Returns true if course video should be shown
shouldShowCourseIncludesTitle Boolean

Returns true if "Course Includes" label should be shown
shouldShowLessonsText Boolean

Returns true if lessons label should be shown
shouldShowTopicsText Boolean

Returns true if topics label should be shown
shouldShowQuizzesText Boolean

Returns true if quizzes label should be shown
shouldShowCertificatesText Boolean

Returns true if course certificate label should be shown
lessonsText String

Returns the lessons label
topicsText String

Returns the topics label
quizzesText String

Returns the quizzes label
enrolledText String

Returns the enrolled label
styles Record.<any, any>

Default styles
object

# CourseHeaderRightProps

CourseHeaderRightProps

Properties:
Name Type Description
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
t TTranslationFunction
courseVM TCourseViewModel
isShowingOpenCourseForGuestUser boolean

Returns true if course should be open for guest user
contentStyle Record.<any, any>

Can be used to indicate what DownloadStatusIndicator component style should use
object

# CourseMaterialsProps

CourseMaterialsProps

Properties:
Name Type Description
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
t TTranslationFunction
materials string

Contents of course materials field
tagsStyles Record.<any, any>

Default styles for different tags
materialsStyles Record.<any, any>

Default styles for course materials
baseFontStyle function

Function to set a font style
navigation NavigationProp.<any, any>
onLinkPress function

Helper function that handles link press for the HTML component
object

# CourseMaterialsSectionTitleProps

CourseMaterialsSectionTitleProps

Properties:
Name Type Description
global Record.<any, any>

App global style
t TTranslationFunction
labels Record.<any, any>
object

# CoursePropsFilterCallback

CoursePropsFilterCallback

Properties:
Name Type Description
oldProps Record.<any, any>

Course props
object

# CourseQuizItemProps

CourseQuizItemProps

Properties:
Name Type Description
item TQuizViewModel
style Record.<any, any>
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
skipProgress boolean

Can be used to determine if actual progress should be shown or if item should be indicated as completed
onPress function

Navigates to the quiz
allowNavigation boolean

Returns true if navigation to the item is allowed
IconComponent JSX.Element

Default component for displaying the left-most icon in the item
object

# CourseSectionItemProps

CourseSectionItemProps

Properties:
Name Type Description
item Record.<any, any>

Data about item to be rendered
progression number

Returns progression of the item
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
allowNavigation boolean

Returns true if navigation to the item is allowed
onItemPress function

Navigates to the lesson; topic or quiz
count number

Returns number of topics and quizzes for the top-level item., This can be used when determining if the lesson should be expandable or not.
icon number

Result of using require() when fetching the appropriate icon for each item
toggleExpand function

Toggle or expand the item. This can be called when creating a custom IconComponent
blockType string | undefined

Returs the type of section item
showAlertMessage function

Calls an alert component which shows an error message
StepsComponent JSX.Element

Default component for displaying the steps label in the item
IconComponent JSX.Element

Default component for displaying the left-most icon in the item
Object

# CoursesItemWidgetDetailsComponentProps

Properties:
Name Type Description
styles Object

Default styles
global Object

App global style
colors Object

App colors
hideAuthor Boolean

Returns true if course author should be hidden
course CourseViewModel
object

# CourseStartedHeaderDetailsProps

CourseStartedHeaderDetailsProps

Properties:
Name Type Description
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
t TTranslationFunction
courseVM TCourseViewModel
styles Record.<any, any>

Default styles for the header component
formatDateFunc function

Helper function for parsing dates
object

# CourseStatusHiddenCallback

CourseStatusHiddenCallback

Properties:
Name Type Description
course TCourseViewModel
hasStarted boolean

Returns true if course progress has started
courseTree Record.<any, any>

Course structure
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
block CourseBlock
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
block Object

Object which contains block data such as the source, params, colors etc
courses Array.<CourseViewModel>
t TranslationFunction
navigation NavigationService
block CourseBlock
Object

# CourseTitleComponentProps

Properties:
Name Type Description
styles Object

Default styles
title String

Course title
object

# CourseTitleProps

CourseTitleProps

Properties:
Name Type Description
course TCourseViewModel
_globalStyles Record.<any, any>

App global style
colors Record.<any, any>

App colors
lightStyle boolean

Returns true if course is using cover image
styles Record.<any, any>

Default title styles
animatedOpacity Record.<any, any>

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

# DetailCategoryTitleProps

Properties:
Type Description
ResultDetailsProps
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
object

# DownloadProgressComponentProps

DownloadProgressComponentProps

Properties:
Name Type Description
onPress function

Cancels the download progress
colors Record.<any, any>

App colors
progress number

Current progress of download
size number

Size of progress circle
lightStyle boolean

Returns true if component should use lightStyle
hitSlop Record.<string, number>

Default hitSlop for component
containerStyle Record.<any, any>

Default container style
object

# EditProfileComponentDidUpdateCallback

EditProfileComponentDidUpdateCallback

Properties:
Name Type Description
prevProps Record.<any, any>
prevState Record.<any, any>
props Record.<any, any>
state Record.<any, any>
updateStoreValues function

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

# EditProfileInputComponentProps

EditProfileInputComponentProps

Properties:
Name Type Description
values Record.<any, any>

Profile component details
handleInput function

Function to handle input changes to the component
config Record.<any, any>
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
t TTranslationFunction
errors undefined | Record.<any, any>

Error details
formItem Record.<any, any>

Current form component
object

# EditProfileItemProps

EditProfileItemProps

Properties:
Name Type Description
formItem Record.<any, any>

Form item details
values Record.<any, any>

Profile component details
handleInput function

Function to handle input changes to the component
handleVisibility function

Function to handle visibility changes to the component
config Record.<any, any>
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
t TTranslationFunction
errors Record.<any, any>

Error details
styles Record.<any, any>

Default styles
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

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 "asc" | "desc"

Order sort attribute ascending or descending. Default value: desc. Allowed values: asc, desc
orderby "date_created" | "last_activity" | "total_member_count" | "name" | "random"

Order Groups by which attribute. Default value: date_created. Allowed values: date_created, last_activity, total_member_count, name, random
type "active" | "newest" | "alphabetical" | "random" | "popular"

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

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:

# 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

# 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

# FreeAnswerComponentProps

FreeAnswerComponentProps

Properties:
Name Type Description
Wrapper React.ComponentType

Default wrapper for input component
wrapperOnPress function

Calls default function when wrapper is pressed
styles Record.<any, any>

Default styles for the input
defaultValue string | undefined

Returns the default value of the input
onChangeText function

Updates the answer in the input component
t TTranslationFunction
question QuestionViewModel
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

# GroupActionButton

GroupActionButton

Properties:
Name Type Attributes Description
icon number
label string
doFunction function

Default function of action button
onPressValidation Record.<any, any> <optional>

Validation details
object

# GroupDetailsComponentProps

GroupDetailsComponentProps

Properties:
Name Type Description
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
group TGroupViewModel
t TTranslationFunction
filteredActions Array

Functions used in group details
onLinkPress function

Default function when a link is pressed
truncated Record.<any, any>

Group description
headerStyle Record.<any, any>

used for controlling the alignment of the view
styles Record.<any, any>

Styles group details component
showGroupType boolean

Boolean value for controlling Group type text display
showGroupPrivacy boolean

Boolean value for controlling Group status text display
object

# GroupFieldsTitleProps

GroupFieldsTitleProps

Properties:
Name Type Description
group Record.<any, any>

Fieldset details
styles Record.<any, any>

Default styles
object

# GroupHeaderAvatarProps

GroupHeaderAvatarProps

Properties:
Name Type Description
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
group TGroupViewModel
disableGroupAvatarUpload boolean

Returns true if group avatar upload is disabled
object

# GroupHeaderButtonsProps

GroupHeaderButtonsProps

Properties:
Name Type Description
OldButtonComponent function

Default button component displayed for the group. Ex: "Request to Join", "Member", etc.
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
group TGroupViewModel
currentUser Record.<any, any>

Details about the currently logged-in user
t TTranslationFunction
filteredActions Array

Functions used in group details
onLinkPress function

Default function when a link is pressed
buttonTextColor string
buttonStyle Record.<any, any>
styles Record.<any, any>

Default styles
canJoin boolean

true when user can join Group
isAdmin boolean

true, if user is admin
joinGroupLoading boolean

true, when Group join request is processing
deleteJoinLoading boolean

true, when Group delete join request is processing
joinGroup function

Functions to join a Group
deleteJoinRequest function

Functions to delete Group join request
object

# GroupItemComponentProps

GroupItemComponentProps

Properties:
Name Type Description
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
item TGroupViewModel
index number
t TTranslationFunction
actions Array
currentUserId number
object

# GroupListTab

GroupListTab

Properties:
Name Type Description
icon number
label string
count number

Indicates badge value
loading boolean

Returns true if tab is loading
onPress function

Default function of the tab
object

# GroupManageTab

GroupManageTab

Properties:
Name Type Description
icon number

Default icon
label string

Default label
onPress function

Default function to execute when tab is pressed
object

# GroupPendingMemberItemComponentProps

GroupPendingMemberItemComponentProps

Properties:
Name Type Description
colors Record.<any, any>

App colors
global Record.<any, any>

App global style
item TMemberViewModel
index number

Index of the item in the list
t TTranslationFunction
groupInvite Record.<any, any>

Group inviter details
object

# GroupSendInvitesTab

GroupSendInvitesTab

Properties:
Name Type Description
icon number

Default icon
label string

Default label
onPress function

Default function to execute when tab is pressed
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

# GroupTabArrowComponentProps

GroupTabArrowComponentProps

Properties:
Name Type Description
tintColor string

Icon color
icon number

Icon resource
styles Record.<any, any>

Default styles
object

# GroupTabBadgeProps

GroupTabBadgeProps

Properties:
Name Type Description
item Record.<any, any>

Badge details
global Record.<any, any>

App global style
text number

Badge text
styles Record.<any, any>

Default styles
object

# GroupTabIconProps

GroupTabIconProps

Properties:
Name Type Description
link Record.<any, any>

Icon details
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
object

# GroupTabTitleComponentProps

GroupTabTitleComponentProps

Properties:
Name Type Description
index number

Tab index
styles Record.<any, any>

Default styles
title string

Tab title
Object

# HeaderActionComponentProps

Properties:
Name Type Description
canCreateActivity Boolean

Returns true if create activity component should be visible
onPress function

Navigates user to the create activity post screen
colors Object

App colors
object

# HeaderAuthorComponentProps

HeaderAuthorComponentProps

Properties:
Name Type Description
user Record.<any, any>

Author details
lightStyle boolean

Returns true if course is using cover image
global Record.<any, any>

App global style
userId number

User id of course author
onUserProfilePress function
loadingInProgress function
t TTranslationFunction

# 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

# HeaderRightComponentProps

HeaderRightComponentProps

Properties:
Name Type Description
styles Record.<any, any>
t TTranslationFunction
group TGroupViewModel
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
onLinkPress function

Handles link press for the HTML component
icon number

Default icon
headerColor string

Default header color
actionButtons Array

Action buttons to render
canSubscribe boolean

Returns true if logged-in user can subscribe to the group
isSubscribed boolean

Returns true if logged-in user is subscribed to the group
subscriptionLoading boolean

Returns true if subscription state is loading
subscribeToGroup function

Function to toggle user's subscription to the group
fontIconName string

Default font icon name of the header action button
fontIconWeight number

Default font icon weight of the header action button
fontIconSubscribeName string

Default font icon name of the subscribe button
fontIconSubscribeWeight number

Default font icon weight of the subscribe button
canPost boolean

Returns true if user can create post in group
openCreateActivityScreen function

Function to open Group Activity screen.
Object

# HeaderRightProps

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

Default function called when the HeaderRight component is pressed

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

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

Initial HOCs array

New HOCs array

Array.<function()>
object

# HTMLQuestionTitleProps

HTMLQuestionTitleProps

Properties:
Name Type Description
tagsStyles Record.<any, any>

Default tags styles
baseFontStyle Record.<any, any>

Default font style
html string

Returns the question title in html format
imageMaxWidth number

Default image max width when generated by the HTML component
onLinkPress function

Handles link press for the HTML component
ignoredTags Array

Default ignored tags
classesStyles Record.<any, any>

Default classes styles
colors Record.<any, any>

App colors
navigation NavigationService
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
item Object

Route information
focused Boolean

Returns true if icon is currently active
tintColor String

Icon color
calcFontSize function

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

App colors

# 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

# IntercomButtonProps

Properties:
Name Type Description
insets Object
style Object
isEnabled Boolean

Returns true if Intercom is enabled
Object

# IOMiddlewareOptions

Properties:
Name Type Description
navigationService NavigationService

Object similar to the navigation property of "@react-navigation/native". 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

# 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
Object

# KeyboardOptionsButtonsProps

Properties:
Name Type Description
navigation NavigationService
richTextEnabled Boolean

Returns true if the rich text button should be displayed
photosEnabled Boolean

Returns true if the photo button should be displayed
videosEnabled Boolean

Returns true if the video button should be displayed
docsEnabled Boolean

Returns true if the document button should be displayed
gifsEnabled Boolean

Returns true if the gif button should be displayed
RichTextButton React.ComponentType

Renders the rich text button
PhotoButton React.ComponentType

Renders the photo button
VideoButton React.ComponentType

Renders the video button
DocButton React.ComponentType

Renders the document button
GifButton React.ComponentType

Renders the gif button
renderMoreOptions function

Renders additional buttons depending on which screen the KeyboardOptions component is
richTextButtonOnPress function

Calls the default on press function of the rich text button
photoButtonOnPress function

Calls the default on press function of the photo button
videoButtonOnPress function

Calls the default on press function of the video button
docButtonOnPress function

Calls the default on press function of the doc button
gifButtonOnPress function

Calls the default on press function of the gif button
Object

# LabelProps

Properties:
Name Type Description
props Object

Route information
textStyle Array.<Object>

Default style for the text component
string

# LanguageLocale

Example
"en_US"
"de_DE"
object

# LearnTopic

LearnTopic

Properties:
Name Type Description
id number

Topic id
title Record.<any, any>

Topic title
date string

Date created
date_gmt string

Date created
modified string

Date modified
modified_gmt string

Date modified
link string

Link to topic
slug string

Topic's url slug
author number

User id of author
excerpt Record.<any, any>

Topic excerpt
menu_order number
has_course_access boolean

Returns true if user has access
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
has_content_access boolean

Returns true if logged-in user has access to course's content
featured_media Record.<any, any>

Featured media of topic
course number

Course id of topic's parent
lesson number

Lesson id of topic's parent
next_topic number

Id of the next topic
materials string

Topic materials
duration Record.<any, any>
video string

Url for video progression
assignment_upload boolean

Returns true if assignment upload is enabled
category Record.<any, any>

Topic category
tag Record.<any, any>

Topic's tag
quizzes Array

Quizzes associated to the topic
categories Array

Course categories
categoriesCount number

Number of course categories
isEnrolling boolean

Returns true if user is enrolling to the course
object

# LearnTopicActionComponentProps

LearnTopicActionComponentProps

Properties:
Name Type Description
showComplete boolean

Returns true if "Mark Complete" button should be shown
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
t TTranslationFunction
topicVM TLearnTopicViewModel
onCompleteTopicClick function

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

Returns true if topic is being completed
completeDisabled boolean

Returns true if "Mark Complete" button should be disabled
prevObject Record.<any, any>

Data about previous lesson/topic/quiz
nextObject Record.<any, any>

Data about next lesson/topic/quiz
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
object

# LearnTopicAfterContentRendererProps

LearnTopicAfterContentRendererProps

Properties:
Name Type Description
topic LearnTopic
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
navigation NavigationService
object

# LearnTopicAfterMaterialsComponentProps

LearnTopicAfterMaterialsComponentProps

Properties:
Name Type Description
topic TLearnTopicViewModel
lessonOrder number
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
labels Record.<any, any>
lesson Lesson
t TTranslationFunction
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 Record.<any, any>

Data about previous lesson/topic/quiz
nextObject Record.<any, any>

Data about next lesson/topic/quiz
nextLockedAlert function

Shows an alert with information that next object is locked
course Course
loading boolean

Returns true if data is loading
navigation NavigationService
materials string

Topic material
object

# LearnTopicHeaderProps

LearnTopicHeaderProps

Properties:
Name Type Description
topic TLearnTopicViewModel
lessonOrder number
paddingTop number
setHeaderHeight function
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
labels Record.<any, any>

Learndash labels
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 Record.<any, any>

Data about previous lesson/topic/quiz
nextObject Record.<any, any>

Data 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
course Course
loading boolean

Returns true if data is loading
renderTimer boolean | React.ComponentType

Returns false if topic doesn't have a timer set. Returns a component if a 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. Returns buttons which can navigate through previous and next screens if hidePrevNext is false
object

# LearnTopicMaterialsSectionTitleProps

LearnTopicMaterialsSectionTitleProps

Properties:
Name Type Description
global Record.<any, any>

App global style
t TTranslationFunction
object

# LearnTopicOfflineComponentProps

LearnTopicOfflineComponentProps

Properties:
Name Type Description
global Record.<any, any>

App global style
t TTranslationFunction
containerStyle Record.<any, any>

Default container style
emptyListStyle Record.<any, any>

Default style of EmptyList component
object

# LearnTopicPrevNextComponentProps

LearnTopicPrevNextComponentProps

Properties:
Name Type 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 Record.<any, any>

App global style
colors Record.<any, any>

App colors
t TTranslationFunction
prevObject Record.<any, any>

Data about previous lesson/topic/quiz
nextObject Record.<any, any>

Data 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

# LearnTopicScreenHeaderProps

LearnTopicScreenHeaderProps

Properties:
Name Type Description
headerLeftStyle Record.<any, any>

Default styling for left section of the header
style Record.<any, any>

Default styling of lesson header
headerRightAuthWrapperProps Record.<any, any>

Props which can be passed to an AuthWrapper
topic TLearnTopicViewModel
lessonOrder number
paddingTop number
setHeaderHeight function
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
labels Record.<any, any>
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 Record.<any, any>

Data about previous lesson/topic/quiz
nextObject Record.<any, any>

Data 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
course Course
loading boolean

Returns true if data is loading
renderTimer boolean | React.ComponentType

Returns false if topic doesn't have a timer set. Returns a component if a 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. Returns buttons which can navigate through previous and next screens if hidePrevNext is false
object

# LearnTopicVideoProgressionComponentProps

LearnTopicVideoProgressionComponentProps

Properties:
Name Type Description
topicVideoStyle Record.<any, any>

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 Record.<any, any>

App global style
isNavActive boolean

Returns true if screen is active
topic TLearnTopicViewModel
showVideo boolean

Returns true if video should be shown
videoWatched boolean

Returns true if video has already been watched
setVideoWatched function

Dispatches an action and marks the video as watched
completeTopic function

Dispatches an action to mark the topic as complete
onCompleteTopicClick function

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

# LearnTopicWebViewContentComponentProps

LearnTopicWebViewContentComponentProps

Properties:
Name Type Description
online boolean

Returns true if device is connected to an internet network
t TTranslationFunction
onShouldStartLoadWithRequest function

The default function used for determining how to handle webview requests.
height number

Default height
source Record.<any, any>

Contains data of the web site to be loaded in the webview
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
ModalHeaderComponent React.FC

Modal which shows up when the "Read More" component is pressed
object

# Lesson

Lesson

Properties:
Name Type Description
id number

Lesson id
title Record.<any, any>

Lesson title
content Record.<any, any>

Lesson content
date string

Date created
date_gmt string

Date created
modified string

Date modified
modified_gmt string

Date modified
link string

Url to lesson
slug string

Lesson's url slug
author number

User id of author
excerpt Record.<any, any>

Lesson excerpt
menu_order number
has_course_access boolean

Returns true if user has access
has_content_access boolean

Returns true if logged-in user has access to lessons's content
featured_media Record.<any, any>

Featured media of lesson
course number

Course id of lessons's parent
next_lesson number

Next lesson's id
duration Record.<any, any>
materials string

Lesson materials
video string

Url for video progression
assignment_upload boolean

Returns true if f upload is enabled
is_sample boolean
topics Array

Topics associated to the lesson
quizzes Array

Quizzes associated to the lesson
completed boolean

Returns true if topic has been completed
quiz_completed boolean

Returns true if quiz in the lesson has been completed
settings Record.<any, any>
can_complete boolean

Returns true if lesson can be marked as completed
error_message Array
excerpt_native Record.<any, any>
content_native Record.<any, any>

Blocks in the lesson
_links Record.<any, any>
_embedded Record.<any, any>
object

# LessonActionComponentProps

LessonActionComponentProps

Properties:
Name Type Description
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
lesson TLessonViewModel
labels Record.<string, string>

Learndash labels
t TTranslationFunction
onCompleteButtonClick function

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

Returns true if "Mark Complete" button should be shown
completing boolean

Returns true if lesson is being completed
completeDisabled boolean

Returns true if "Mark Complete" button should be disabled
prevObject Record.<any, any>

Data about previous lesson/topic/quiz
nextObject Record.<any, any>

Data about next lesson/topic/quiz
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

# 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

LessonHeaderProps

Properties:
Name Type Description
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
lesson TLessonViewModel
labels Record.<string, string>

Learndash labels
t TTranslationFunction
paddingTop number
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 Record.<any, any>

Data about previous lesson/topic/quiz
nextObject Record.<any, any>

Data 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 TCourseViewModel
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 NavigationProp.<any, any>
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

# LessonMaterialsSectionTitleProps

LessonMaterialsSectionTitleProps

Properties:
Name Type Description
global Record.<any, any>

App global style
t TTranslationFunction
object

# LessonProgressStepsProps

LessonProgressStepsProps

Properties:
Name Type Description
t TTranslationFunction
item Record.<any, any>

Item details
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
count number

Number of items inside the item
course TCourseViewModel
blockType string

Describes the type of item being generated
completedSteps number

Number of completed steps inside the lesson
object

# LessonScreenHeaderProps

LessonScreenHeaderProps

Properties:
Name Type Description
headerLeftStyle Record.<any, any>

Default styling for left section of the header
style Record.<any, any>

Default styling of lesson header
headerRightAuthWrapperProps Record.<any, any>

Props which can be passed to an AuthWrapper
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
lesson TLessonViewModel
labels Record.<string, string>

Learndash labels
t TTranslationFunction
paddingTop number
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 Record.<any, any>

Data about previous lesson/topic/quiz
nextObject Record.<any, any>

Data 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 TCourseViewModel
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 NavigationProp.<any, any>
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

# 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
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
doLogin function

Default login function
auth Object
screenProps Object
Object

# LoginLogoProps

Properties:
Name Type Description
hideLogo Boolean | undefined

Returns true if logo should be visible
headerStyle Object

Default style of the logo container
logoStyle Object

Default style of the logo image
source Number

Returns the image for the logo
Object

# LogoutComponentProps

Properties:
Name Type Description
global Object
t TranslationFunction
isLoggingOut Boolean

Returns true if app is currently logging out
logout function

Use this to execute the logout function
"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" | "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

# MaterialsComponentProps

MaterialsComponentProps

Properties:
Name Type Description
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
t TTranslationFunction
materials string

Contents of course materials field
tagsStyles Record.<any, any>

Default styles for different HTML tags
materialsStyles Record.<any, any>

Default styles for course materials
baseFontStyle function

Function to set a font style
navigation NavigationService
onLinkPress function

Handles link press for the HTML component
object

# MaterialsComponentProps

MaterialsComponentProps

Properties:
Name Type Description
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
t TTranslationFunction
materials string

Contents of course materials field
tagsStyles Record.<any, any>

Default styles for different HTML tags
materialsStyles Record.<any, any>

Default styles for course materials
baseFontStyle function

Function to set a font style
navigation NavigationProp.<any, any>
onLinkPress function

Handles link press for the HTML component
object

# MatrixItemOnDragEndCallbackProps

MatrixItemOnDragEndCallbackProps

Properties:
Name Type Description
dragEnd function

Calls the dragEnd function
index number

Index of item
item Record.<any, any>

Answer details
object

# MatrixItemOnDraggingCallbackProps

MatrixItemOnDraggingCallbackProps

Properties:
Name Type Description
dragging function

Calls the dragging function
index number

Index of item
item Record.<any, any>

Answer details
object

# MatrixItemOnDragStartCallbackProps

MatrixItemOnDragStartCallbackProps

Properties:
Name Type Description
dragStart function

Calls the dragStart function
index number

Index of item
item Record.<any, any>

Answer details
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

# 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

# MoreScreenProfileItemProps

Properties:
Name Type Description
user Object

Object containing user details
global Object

App global style
colors Object

App colors
styles Object

Default Component style
navigateToUserProfile function

function which navigates to user's profile
hideHandle Boolean

Boolean specifying whether to show or hide handles
showProfile Boolean

Boolean specifying whether to show or hide Profile Component set via custom code
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

NavigateToTabCallback

Properties:
Name Type Description
defaultNavigation function

Function to call to navigate to the next default screen
currentTab string

Current tab
nextTab string

Next tab
group Record.<any, any>

Group object
navigation NavigationService
object

Navigation object from "@react-navigation/native"

Properties:
Name Type Description
navigate function
dispatch function
replace function
push function
pop function
goBack function
reset function
setParams function
isFocused function
canGoBack function
isActive Boolean
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

# NewReplyKeyboardOptionsButtonsProps

Properties:
Name Type Description
navigation NavigationService
richTextEnabled Boolean

Returns true if the rich text button should be displayed
photosEnabled Boolean

Returns true if the photo button should be displayed
videosEnabled Boolean

Returns true if the video button should be displayed
docsEnabled Boolean

Returns true if the document button should be displayed
gifsEnabled Boolean

Returns true if the gif button should be displayed
RichTextButton React.ComponentType

Renders the rich text button
PhotoButton React.ComponentType

Renders the photo button
VideoButton React.ComponentType

Renders the video button
DocButton React.ComponentType

Renders the document button
GifButton React.ComponentType

Renders the gif button
renderMoreOptions function

Renders additional buttons depending on which screen the KeyboardOptions component is
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
item Object

Notification object
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.
thisRowCollapsed function

Function that is called when action panel starts animating on close.
renderRightActions function

Function that is expected to return an action panel that is going to be revealed from the right side when user swipes left.
onItemPress function

Function that is called when user pressed on the notification.
wrapperProps Object

Contains different objects such as colors, action buttons, navigation etc.
Object

# NotificationsListHeaderComponentProps

Properties:
Name Type Description
styles Object

Default styles
t TranslationFunction
screenTitle String

Title of screen
adjustedScroll function

Returns calculated values using react animated
global Object

App global style
colors Object

App colors
filterProps Object

Props used by the filter
headerIsDark Boolean

Returns true if the set color for the header is dark
fontSizeAdjustment Number

Returns font adjusted values for the filter
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
object

# OfflineComponentProps

OfflineComponentProps

Properties:
Name Type Description
global Record.<any, any>

App global style
t TTranslationFunction
containerStyle Record.<any, any>

Default container style
emptyListStyle Record.<any, any>

Default style of EmptyList component
object

# OnChangeEventListenerCallback

OnChangeEventListenerCallback

Properties:
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
object

# OverrideQuestionHTMLWrapperCallback

OverrideQuestionHTMLWrapperCallback

Properties:
Name Type Description
HTML string

Default HTML wrapper
inputHTML string

HTML that contains the input element
css string

CSS passed to webview by default
object

# OverrideQuestionImageSizeCallback

OverrideQuestionImageSizeCallback

Properties:
Name Type Description
isPopup boolean

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

Current image max width

# 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

# PageScreenTitleProps

object

# ParentGroupBarProps

ParentGroupBarProps

Properties:
Name Type Description
styles Record.<any, any>

Default styles
parentGroup null | Record.<any, any>

Details of group's parent
group TGroupViewModel
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
navigateToParent function

Navigate to parent group
t TTranslationFunction
Object

# PostInComponentProps

Properties:
Name Type Description
disableSelection Boolean

Returns true if the component should be disabled
togglePostInOptions function

Toggles the modal where the user can select visibility
global Object

App global style
colors Object

App colors
styles Object

Default styles
icon Object

Default Icon
object

# PrevNextComponentProps

PrevNextComponentProps

Properties:
Name Type 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 Record.<any, any>

App global style
colors Record.<any, any>

App colors
t TTranslationFunction
prevObject Record.<any, any>

Data about previous lesson/topic/quiz
nextObject Record.<any, any>

Data 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

PrevNextPlaceholderProps

Properties:
Name Type Description
global Record.<any, any>

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
object

# ProfileHeaderButtonObject

ProfileHeaderButtonObject

Properties:
Name Type Description
icon number

Button icon
label string

Button label
doFunction function

Function to call
getError function

Callback if an error occured
object

# ProfileHeaderWrapperProps

ProfileHeaderWrapperProps

Properties:
Name Type Description
styles Record.<any, any>
children React.ComponentType
object

# ProfileItemProps

ProfileItemProps

Properties:
Name Type Description
isLast boolean

Returns true if item to be rendered is last in the list
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
formatDateFunc function

Helper function which can be used to format dates
attemptDeepLink function

Helper function which is used for deep linking
styles Record.<any, any>

Default styles
field Record.<any, any>

Field details
object

# ProfileItemValueProps

ProfileItemValueProps

Properties:
Name Type Description
global Record.<any, any>

App global style
data Record.<any, any>

Field details
type string

Field type
options Array

Field options
formatDateFunc function

Helper function which can be used to format dates
attemptDeepLink function

Helper function which is used for deep linking
ProfileItemValue React.ComponentType.<any>

Default component used for rendering the values
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
object

# QuestionAssessmentHTMLProps

QuestionAssessmentHTMLProps

Properties:
Name Type Description
item Record.<any, any>

Question assessment details
index number

Index of item
styles Record.<any, any>

Default styles
global Record.<any, any>

App global style
tagsStyles Record.<any, any>

Default tags styles which can be used for rendering the question assessment HTML description
object

# QuestionClosedComponentProps

QuestionClosedComponentProps

Properties:
Name Type Description
contentId string
source Record.<any, any>

Source to render in the webview
inputChange function

Updates the answer in the input component
typography function
htmlStylesCss string

Default css for webview
htmlAdjustedCss string

Default css for webview
tagsStyles Record.<any, any>

Default tags styles for rendering the HTML
baseFontStyle Record.<any, any>

Default font styles for rendering the HTML
questionText string

Question to render in the HTML component
computedWidth number

Can be used for staticContentMaxWidth
alterChildren function

Default alterChildren value which can be used for the HTML component
onLinkPress function

Implements deep linking in the HTML component
ignoredTags Array

Default list of ignored tags
renderers function

Default renderer value which can be used for the HTML component
object

# QuestionCountComponentProps

QuestionCountComponentProps

Properties:
Name Type Description
hideTitle undefined | boolean
styles Record.<any, any>

Default styles
t TTranslationFunction
labels Record.<any, any>

Learndash labels
total number

Total number of questions
questionNumber number

Current question number
object

# QuestionEssayComponentProps

QuestionEssayComponentProps

Properties:
Name Type Description
styles Record.<any, any>

Default styles
error null | string

Returns a string if an error was encountered
t TTranslationFunction
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
onPress function

Calls function to enable upload
showIcon boolean

Returns true if icon should be visible
showLoading boolean

Returns true if file is currently uploading
icon string | number

Default icon
title string

Default title of upload button
object

# QuestionHintComponentProps

QuestionHintComponentProps

Properties:
Name Type Description
showFooter boolean

Returns true if the hint component should be visible.
global Record.<any, any>

App global style
question Record.<any, any>

Question data
htmlStylesCss string

Default html css styles. This can be added to an html string if the hint is to be generated in an HTML component.
htmlAdjustedCss string

Default html css styles. This can be added to an html string if the hint is to be generated in an HTML component.
typography Record.<any, any>

Font data
t TTranslationFunction
styles Record.<any, any>

Default styles for the Hint component
object

# QuestionNumberIndicatorsProps

QuestionNumberIndicatorsProps

Properties:
Name Type Description
styles Record.<any, any>
colors Record.<any, any>

App colors
t TTranslationFunction
object

# QuestionNumberProps

QuestionNumberProps

Properties:
Name Type Description
item Record.<any, any>

Question details
onPress function

Selects the question when executed
title number

Title of the component
markItemSize number

Size of the status indicated placed on the component
isMarked boolean

Returns true if the component should be marked
titleColor string

Title color
itemSize number

Question number component size
backgroundColor string

Background color for the question number component
markColor string

Color of the status indicator placed on the component
object

# QuestionOverviewButtonsProps

QuestionOverviewButtonsProps

Properties:
Name Type Description
style Record.<any, any>
global Record.<any, any>

App global style
t TTranslationFunction
labels Record.<any, any>

Learndash labels
onReviewPress function

Marks a question for review
onSummaryPress function

Shows summary of the quiz
disableSummaryButton boolean

Returns true if the summary button should be disabled
object

# QuestionSortItemComponentProps

QuestionSortItemComponentProps

Properties:
Name Type Description
Component React.ComponentType

Default wrapper for sort component
styles Record.<any, any>

Default styles
data Record.<any, any>

Item data
icon number

Default icon for sort component
active boolean

Returns true if component is being dragged
object

# QuestionSubmitButtonProps

QuestionSubmitButtonProps

Properties:
Name Type Description
styles Record.<any, any>
global Record.<any, any>

App global style
quiz TQuizViewModel
hasAnswer boolean

Returns true if question has an answer
hasBackButton boolean

Returns true if back button should be visible
showNoAnswerAlert function

Shows an alert modal if a question requires an answer but no answer was inputted
isLastQuestion false

Returns true if the question in the screen is the last question in the quiz
completing boolean

Returns true when a request is made to submit the quiz
onQuestionOverviewSummaryPress function

Shows the quiz summary in a modal
submitQuiz function

Submits the quiz
onQuestionSubmitClick function

Submits the answer to a question
label string

Returns the default button label
submitting boolean

Returns true when the quiz is being submitted
object

# QuestionViewModel

QuestionViewModel

Properties:
Name Type Description
category string

Question category
quizId number

Id of quiz
id number

Id of question
index number

Index of question in the quiz
title string

Question title
titleNative Array

Title block
hint string

Hint
options Array

Answer options
matrixValues Array

Answer data if question is matrix sorting
questionType string

Question type
gradedType string

Graded type
resumeData Record.<any, any>

Data for resuming a question
object

# Quiz

Quiz

Properties:
Name Type Description
id number

Quiz id
title string

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
timeLimit number | undefined

Slug of url to quiz, Time limit to take the quiz
content string

Quiz content
contentNative Array
author Record.<any, any>

Name and avatar of author
link string | undefined

Link to quiz
completed boolean

Returns true if quiz has been completed
hasAccess boolean

Returns true if user has access to the quiz
hasContentAccess boolean

Returns true if user has access to the content of the quiz
canTakeAgain boolean

Returns true if user can take the quiz again
disabledAnswerMark boolean

Returns true if answer mark is disabled
hideAnswerMessageBox boolean

Returns true if answer message box should be hidden
numberedAnswer boolean

Returns true if quiz has numbered answers
showReviewQuestion boolean

Returns true if review question should be shown
hideQuestionNumbering boolean

Returns true if question numbering should be hidden
showCategory boolean

Returns true if quiz category should be shown
showPoints boolean

Returns true if points per question should be shown
forcingQuestionSolve boolean

Returns true if users are forced to answer all questions
titleHidden boolean | null

Returns true if quiz title should be hidden
formActivated boolean

Returns true if quiz form is activated
formShowPosition number

Returns the position of the form
form boolean | Array

Returns the quiz form
quizSummaryHide boolean

Returns true if summary button should be hidden
autoStart boolean | null

Returns true if quiz should start automatically
quizSaving boolean | Record.<any, any>

Returns data about quiz saving
quizSavingTimeout number

Returns number of seconds allowed for taking the quiz
quizSavedAnswers Record.<any, any>

Quiz saved answers
onClick function

Executes an "onClick" function passed to the model
Object

# QuizCompleteButtonProps

Properties:
Name Type Description
showContinue Boolean

Returns true if the continue button should be shown
global Object

App global style
colors Object

App colors
onCompleteButtonClick function

Function to execute when the continue button is pressed
t TranslationFunction
Object

# QuizDetailVM

Properties:
Name Type Description
showCategoryScore Boolean

Returns true if category score should be shown
hideResultQuizTime Boolean

Returns true if result quiz time should be hidden
hideResultPoints Boolean

Returns true if result points should be hidden
showAverageResult Boolean

Returns true if average result should be shown
btnViewQuestionHidden Boolean

Returns true if review button should be hidden
object

# QuizMaterialsComponentProps

QuizMaterialsComponentProps

Properties:
Name Type Description
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
t TTranslationFunction
materials string

Contents of course materials field
tagsStyles Record.<any, any>

Default styles for different HTML tags
materialsStyles Record.<any, any>

Default styles for course materials
baseFontStyle function

Function to set a font style
navigation NavigationService
onLinkPress function

Handles link press for the HTML component
object

# QuizOfflineComponentProps

QuizOfflineComponentProps

Properties:
Name Type Description
global Record.<any, any>

App global style
t TTranslationFunction
wrapperCompsStyle Record.<any, any>

Default wrapper style
renderNav function

Renders the navigation component
styles Record.<any, any>

Default styles for the offline component
object

# QuizPrevNextComponentProps

QuizPrevNextComponentProps

Properties:
Name Type 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 Record.<any, any>

App global style
colors Record.<any, any>

App colors
t TTranslationFunction
prevObject Record.<any, any>

Data about previous lesson/topic/quiz
nextObject Record.<any, any>

Data 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
headerRightAuthWrapperProps Record.<any, any>

Props which can be passed to an AuthWrapper
object

# QuizReviewFreeAnswerComponentProps

QuizReviewFreeAnswerComponentProps

Properties:
Name Type Description
answer Record.<any, any>

Answer details
correct boolean

Returns true if answer is correct
styles Record.<any, any>

Default styles
icon Record.<any, any>

Default success or fail icon
tintColor string

Default tint color for success or fail status
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
object

# QuizReviewHTMLQuestionTitleProps

QuizReviewHTMLQuestionTitleProps

Properties:
Name Type Description
tagsStyles Record.<any, any>

Default tags styles
baseFontStyle Record.<any, any>

Default font style
html string

Returns the question title in html format
imageMaxWidth number

Default image max width when generated by the HTML component
onLinkPress function

Handles link press for the HTML component
ignoredTags Array

Default ignored tags
classesStyles Record.<any, any>

Default classes styles
colors Record.<any, any>

App colors
navigation NavigationService
object

# QuizReviewQuestionAssessmentHTMLProps

QuizReviewQuestionAssessmentHTMLProps

Properties:
Name Type Description
item Record.<any, any>

Question assessment details
index number

Index of item
styles Record.<any, any>

Default styles
global Record.<any, any>

App global style
tagsStyles Record.<any, any>

Default tags styles which can be used for rendering the question assessment HTML description
object

# QuizReviewQuestionClosedComponentProps

QuizReviewQuestionClosedComponentProps

Properties:
Name Type Description
global Record.<any, any>

App global style
styles Record.<any, any>

Default styles
questionText string

Question and answer details
tagsStyles Record.<any, any>

Default tags styles for rendering the HTML
object

# QuizReviewQuestionEssayComponentProps

QuizReviewQuestionEssayComponentProps

Properties:
Name Type Description
styles Record.<any, any>

Default styles
t TTranslationFunction
global Record.<any, any>

App global style
object

# QuizReviewQuestionSortItemComponentProps

QuizReviewQuestionSortItemComponentProps

Properties:
Name Type Description
Component React.ComponentType

Default wrapper for sort component
styles Record.<any, any>

Default styles
data Record.<any, any>

Item data
icon Record.<any, any>

Default icon for sort component
active boolean

Returns true if component is being dragged
object

# QuizReviewRadioDescriptionProps

QuizReviewRadioDescriptionProps

Properties:
Name Type Description
index number

Index of the answer
color string

Default color of the description component
styles Record.<any, any>

Default styles for the description
baseFontStyle Record.<any, any>

Font details
description string

Description of the answer
renderers Record.<any, any>

Default renderers for the HTML component
object

# QuizReviewRadioIconProps

QuizReviewRadioIconProps

Properties:
Name Type Description
multiselect boolean

Returns true if radio is used in a multiple choice question
styles Record.<any, any>

Default styles for the radio
isWrong boolean | undefined

Returns true if the answer selected is wrong
isRight boolean | undefined

Returns true if the answer selected is correct
multipleChoiceIcon number

Returns the default resource used in the radio
radio Record.<any, any>

Answer details
object

# QuizScreenHeaderProps

QuizScreenHeaderProps

Properties:
Name Type Description
quiz TQuizViewModel
currentSwiperPosition number
global Record.<any, any>

App global style
labels Record.<any, any>

Learndash labels
questions Array

Current questions in the quiz
quizOrder number
quizTotalCount number
colors Record.<any, any>

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 TTranslationFunction
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
prevObject Record.<any, any>

Data about previous lesson/topic/quiz
nextObject Record.<any, any>

Data about next lesson/topic/quiz
course Course
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
hideQuestionNumbering boolean

Returns true if question numbering should be hidden
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
headerLeftStyle Record.<any, any>

Default styling for left section of the header
style Record.<any, any>

Default styling of lesson header
object

# QuizSectionTitleProps

QuizSectionTitleProps

Properties:
Name Type Description
global Record.<any, any>

App global style
t TTranslationFunction
object

# QuizStartButtonProps

QuizStartButtonProps

Properties:
Name Type Description
showStart boolean

Returns true if quiz start button should be visible.
global Record.<any, any>

App global style
styles Record.<any, any>

Default styles for the button.
quiz TQuizViewModel
quizStartLoading boolean

Returns true if quiz is currently loading.
checkForm function

Checks form and sets state as invalid if applicable.
startQuiz function

Starts the quiz.
t TTranslationFunction
labels Record.<any, any>

Learndash labels
isResumeQuiz boolean | null

Returns true if quiz can be resumed.
object

# QuizTimerProps

QuizTimerProps

Properties:
Name Type Description
showTimer boolean

Returns true if timer should be visible
item TQuizViewModel
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
styles Record.<any, any>
timerRef Record.<any, any>
onTimePassed function

Updates the timer value
onTimeOver function

Submits the quiz
object

# QuizTitleComponentProps

QuizTitleComponentProps

Properties:
Name Type Description
quiz TQuizViewModel
currentSwiperPosition number
global Record.<any, any>

App global style
labels Record.<any, any>

Learndash labels
questions Array

Current questions in the quiz
quizOrder number
quizTotalCount number
colors Record.<any, any>

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 TTranslationFunction
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
prevObject Record.<any, any>

Data about previous lesson/topic/quiz
nextObject Record.<any, any>

Data about next lesson/topic/quiz
course Course
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
hideQuestionNumbering boolean

Returns true if question numbering should be hidden
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

# QuizVM

Properties:
Name Type Description
showCategoryScore Boolean

Returns true if category score should be shown
hideResultQuizTime Boolean

Returns true if result quiz time should be hidden
hideResultPoints Boolean

Returns true if result points should be hidden
showAverageResult Boolean

Returns true if average result should be shown
toplistActivated Boolean

Returns true if top list is activated
hideResultCorrectQuestion Boolean

Returns true if result correct question should be hidden
btnRestartQuizHidden Boolean

Returns true if restart quiz button should be hidden
toplistData Object

Contains top list data used for showing quiz leader board
resultGradeEnabled Boolean

Returns true if result grade is enabled
resultText Object

Contains result message which can also be displayed in Quiz Details screen
object

# QWebViewContentComponentProps

QWebViewContentComponentProps

Properties:
Name Type Description
online boolean

Returns true if device is connected to an internet network
t TTranslationFunction
onShouldStartLoadWithRequest function

The default function used for determining how to handle webview requests.
height number

Default height
source Record.<any, any>

Contains data of the web site to be loaded in the webview
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
ModalHeaderComponent React.FC

Modal which shows up when the "Read More" component is pressed
object

# RadioContainerProps

RadioContainerProps

Properties:
Name Type Description
styles Record.<any, any>

Default styles
key number

Index of the component
Component React.FC

Returns the default component used
onPress function

Calls the function used when the component is pressed
selected boolean

Returns true if the component is selected
numbered boolean

Returns true if the component is set to be numbered
children React.FC

Default children components
object

# RadioDescriptionProps

RadioDescriptionProps

Properties:
Name Type Description
index number

Index of the answer
styles Record.<any, any>

Default styles for the description
baseFontStyle Record.<any, any>

Font details
description string

Description of the answer
ignoredTags Array

List of tags to be ignored by the html renderer
navigation NavigationService
object

# RadioIconProps

RadioIconProps

Properties:
Name Type Description
multiselect boolean

Returns true if radio is used in a multiple choice question
styles Record.<any, any>

Default styles for the radio
isWrong boolean | undefined

Returns true if the answer selected is wrong
isRight boolean | undefined

Returns true if the answer selected is correct
multipleChoiceIcon number

Returns the default resource used in the radio
radio Record.<any, any>

Answer details
object

# RadioOnPressCallbackProps

RadioOnPressCallbackProps

Properties:
Name Type Description
setRadioState function

Selects the radio
multiselect boolean

Returns true if radio is used in a multiple choice question
radios Array

Answer details
selected Array

Selected answers
index number

Index of the pressed radio
Object

# RecapMessageProps

Properties:
Type Description
ResultDetailsProps

# 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:

# RegisterIntercomUserCallback(user) → {void}

Parameters:
Name Type Description
user User
void
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
Object

# RestartQuizButtonProps

Properties:
Name Type Description
quizVM QuizVM
global Object

App global style
colors Object

App colors
styles Object
onAgainClick function

Allows users to take the quiz again
Object

# ResultCorrectCountProps

Properties:
Name Type Description
quizVM QuizVM
global Object

App global style
labels Object

Learndash labels
correctAnswers Number

Total count of correct answers
result Object

Quiz result details
Object

# ResultDetailsProps

Properties:
Name Type Description
result Object

Quiz result details
quizVM QuizDetailVM
global Object

App global style
colors Object

App colors
t TranslationFunction
Object

# ResultIconComponentProps

Properties:
Type Description
ResultDetailsProps
Object

# ResultMessageProps

Properties:
Type Description
ResultDetailsProps
Object

# ResultPointsComponentProps

Properties:
Type Description
ResultDetailsProps
Object

# ResultQuizTimeProps

Properties:
Name Type Description
quizVM QuizVM
global Object

App global style
colors Object

App colors
t TranslationFunction
result Object

Quiz result details
Object

# ReviewQuizButtonProps

Properties:
Name Type Description
ResultDetailsProps
bottomSafeArea Number
onReviewClick function

Helper function that navigates to Quiz Review screen
labels Object

Learndash labels

# 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
SearchComponent React.ComponentType

Renders the default search component

# 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
object

# showMarkAsCompleteProps

showMarkAsCompleteProps

Properties:
Name Type Description
topic LearnTopic
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

# SignUpInputComponentProps

Properties:
Name Type Description
DefaultComponent React.Component

Default input component
label String

Input label
field Record.<any, any>

Input details
setValue function

Function to handle input changes to the component
theme Record.<any, any>

Default style
initialValue undefined | string

Initial value of field

# SignUpInputsValidationCallback(doValidation, fieldName, field, t) → {void}

Parameters:
Name Type Description
doValidation function

Calls the default validation function
fieldName String

Name of the field
field Object

Field details
t TranslationFunction
void
Object

# SignUpLinkProps

Properties:
Name Type Description
isSignUpEnabled Boolean

Returns true if sign up is enabled
footerRef Object

Footer reference for the component
onPress function

Calls the default sign up function
styles Object

Default style of the component
t TranslationFunction
global Object

App global style
colors Object

App colors
navigation NavigationService
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

# SortItemOnDragEndCallbackProps

SortItemOnDragEndCallbackProps

Properties:
Name Type Description
dragEnd function

Calls the dragEnd function
index number

Index of the item related to data where the event was executed
data Array

Answer details
order Array

Order of answers displayed
object

# SortItemOnDraggingCallbackProps

SortItemOnDraggingCallbackProps

Properties:
Name Type Description
dragging function

Calls the dragging function
data Array

Answer details
order Array

Order of answers displayed
object

# SortItemOnDragStartCallbackProps

SortItemOnDragStartCallbackProps

Properties:
Name Type Description
dragStart function

Calls the dragStart function
index number

Index of the item related to data where the event was executed
data Array

Answer details
order Array

Order of answers displayed
Object

# StoreApi

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

Parameters:
Name Type Description
list Array.<ActivitiesFilter>
Properties:
Name Type Attributes Description
icon number | Record.<any, any>
label string
count number <optional>
onPress function
  • New list
Array.<string>
object

# TCourseViewModel

TCourseViewModel

Properties:
Name Type Description
id number

Course id
featuredUrl string

Url to featured image
coverUrl string

Url to cover image
canEnroll boolean

Returns true if user can enroll to course
incompletePrerequisiteMessage string

Returns a message if incomplete prerequisite
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
purchasable boolean

Returns true if course can be purchased
offlineDisabled boolean

Returns true if offline disabled
videoUrl string | undefined

Url to video of course
bb_access Record.<any, any>

Returns detail of access granted
price Record.<any, any>

Course price and currency
error Record.<any, any>

Error message encountered
authorId number

Id of course's author
author Record.<any, any>

Author details
modifiedDate string

Date of when course was last modified
showStart boolean

Returnstrue if start function should be showed
certificate Record.<any, any>

Certificate details
members Array

Shows members enrolled in course
enrolledMmebers number

Shows number of enrolled members
iapProducts Array

IAP products associated to the course
forumId number

Forum associated to the course
materials undefined | string

Course materials
content string

Course content
contentNative Array

Blocks in the course
lessons Array

Lessons associated to the course
loading boolean

Returns true if course is loading
quizzes Array

Quizzes associated to the course
categories Array

Course categories
categoriesCount number

Number of course categories
isEnrolling boolean

Returns true if user is enrolling to the course
object

# TGroupViewModel

TGroupViewModel

Properties:
Name Type Attributes Description
parentId number

Returns id of the group parent if available
id number

Group id
avatar string

Group avatar
coverImage string

Returns true if group has cover image
coverIsDefault boolean

Returns true if cover image is default
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 number | boolean

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 number | 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.<TMember>
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
navigateToForum function <optional>

Function to navigate to group's forum
subscribeClick function <optional>

Toggle subscription to group
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

# 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

# TLearnTopicViewModel

TLearnTopicViewModel

Properties:
Name Type Description
id number

Topic id
title string

Topic title
contentNative Record.<any, any>

Blocks in the topic
content string

Topic content
author Record.<any, any>

Topic author
video Record.<any, any>

Video progression
link string

Link to topic
videoUrl string

Url of the video used in video progression
order number

Order number of topic
total number

Number of topics
lessonProgress number
completed boolean

Returns true if topic has been marked as complete
assignment_upload boolean

Returns true if assignment upload is enabled
quizzes Array

Quizzes associated to the topic
requiredTimer boolean

Returns true if timer should be shown
duration number

Duration of timer
settings Record.<any, any>
date string

Date created
object

# TLessonViewModel

TLessonViewModel

Properties:
Name Type Description
id number

Lesson id
title string

Lesson title
content string

Lesson content
contentNative Array

Blocks used in the lesson
excerpt string

Lesson excerpt
link string

Url to lesson
quizCompleted boolean

Returns true if quiz in the lesson has been completed
lessonQuizzes Array
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 Record.<any, any>

Video details
object

# TMember

TMember

Properties:
Name Type Attributes Description
id number

User id
name string

Name of user
user_login string

Login name of user
link string

Url to user's profile
member_types Record.<any, any>

Member type
registered_date string

User's date of registration
profile_name string

User's profile name
last_activity string

User's last activity
xprofile Record.<any, any>

Extended profile data
followers number

Number of followers
following number

Number of user's connections
is_wp_admin boolean

Returns true if user is wp admin
friendship_status "pending" | "is_friend" | "not_friends" | "awaiting_response"

Friendship status
mention_name string

User's handle
avatar_urls Record.<any, any> <optional>

User's avatars
cover_url string | boolean

User's profile cover image
cover_is_default boolean
points Record.<any, any>

Gamipress points
is_admin boolean
user_points Array

User's points
Object

# ToolbarHeaderProps

Properties:
Name Type Description
t TranslationFunction
renderToolBarHeader function

Function that returns the default component used for the screen
colors Object

App colors
global Object

App global style
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

# TopicsItemWidgetDetailsComponentProps

Properties:
Name Type Description
styles Object

Default styles
global Object

App global style
topic TopicViewModel
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
Object

# TransformActivityCommentButtons

Properties:
Name Type Description
params Array.<String>

Default buttons allowed in the ActivityComment component
object

# TransformBlogButtonsCallback

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>

# TransformContainerPaddingTopCallback(containerPaddingTop) → {Number}

Parameters:
Name Type Description
containerPaddingTop Number

New padding top value

Number

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

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

# TransformContentInsetTopCallback(contentInsetTop) → {Number}

Parameters:
Name Type Description
contentInsetTop Number

New content inset value

Number

# TransformContentOffsetYCallback(contentOffsetY) → {Number}

Parameters:
Name Type Description
contentOffsetY Number

New content offset value

Number
object

# TransformCourseActionButtonsCallback

TransformCourseActionButtonsCallback

Properties:
Name Type Description
CourseActionBtn JSX.Element
course TCourseViewModel
t function
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
products Array

Products associated to the course
navigation NavigationService
startCourse function

Starts the course when called
continueCourse function

Continues the course when called for a course in progress
priceComponentRender function

Renders the price component when called

# 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
Object

# TransformCreateActivityParams

Properties:
Name Type Description
props Object

Activity details

# TransformDocumentsParams() → {Object}

Parameters:
Type Description
FetchDocumentsParams
Object
object

# TransformEditProfileFieldSetsCallback

TransformEditProfileFieldSetsCallback

Properties:
Name Type Description
id number

id of field set
name string

Name of the field set
description Record.<any, any>

Description of the field set
group_order number

Order of the group
can_delete boolean

Returns true if field set can be deleted
repeater_enabled boolean

Returns true if repeater is enabled
fields Array

Fields in a field set

# 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
object

# TransformGroupActionButtonsCallback

TransformGroupActionButtonsCallback

Properties:
Name Type Description
action Array
object

# TransformGroupActionsCallback

TransformGroupActionsCallback

Properties:
Name Type Description
TransformGroupActionsCallback Array
object

# TransformGroupsParams

TransformGroupsParams

Properties:
Name Type Description
group FetchGroupsParams
object

# TransformGroupSubFiltersFilterCallback

TransformGroupSubFiltersFilterCallback

Properties:
Name Type Description
type Record.<any, any>

Filter types such as active, popular, newest, alphabetical
group_type Record.<any, any>

Group types
object

# TransformLearnTopicViewModelCallback

TransformLearnTopicViewModelCallback

Properties:
Name Type Description
viewModel TLearnTopicViewModel
topic LearnTopic
object

# TransformLessonActionButtonsCallback

TransformLessonActionButtonsCallback

Properties:
Name Type Description
LessonButton React.ComponentType

Lesson action button
showComplete boolean

Returns true if "Mark Complete" button should be shown
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
lesson TLessonViewModel
completing boolean

Returns true if lesson is being completed
labels Record.<string, string>

Learndash labels
object

# TransformLessonViewModelCallback

TransformLessonViewModelCallback

Properties:
Name Type Description
viewModel TLessonViewModel
lesson Record.<any, any>

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

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

# TransformMembersParams() → {Object}

Parameters:
Type Description
FetchMembersParams
Object

# TransformMembersSubFiltersFilterCallback() → {Object}

Parameters:
Type Description
Object
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

# TransformMessageActionsCallback(buttonConfig) → {Array}

Parameters:
Name Type Description
buttonConfig Array

Contains the default buttons for the list
Array

# 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>

# TransformNotificationListPropsCallback() → {Object}

Properties:
Name Type Description
props Object

Notifications list props
Object

# TransformNotificationsParams() → {Object}

Parameters:
Type Description
FetchNotificationsParams
Object

# TransformNotificationViewModelCallback() → {Object}

Properties:
Name Type Description
viewModel Object

Notifications view model

New view model

Object

# TransformParams() → {Object}

Parameters:
Type Description
FetchCourseParams
Object

# TransformPhotosParams() → {Object}

Parameters:
Type Description
FetchPhotosParams
Object

# TransformProfileHeaderButtonsCallback(profileHeaderButtons) → {Array.<ProfileHeaderButtonObject>}

Parameters:
Name Type Description
profileHeaderButtons Array.<ProfileHeaderButtonObject>

Array of objects that renders the header buttons

New Array of objects

Array.<ProfileHeaderButtonObject>
Object

# TransformProfileIgnoredSubscreensCallback

Logged-in user's data

Properties:
Name Type Description
list "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"
isOwnAcccount boolean

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

# TransformProfileSubscreensListCallback

TransformProfileSubscreensListCallback

Properties:
Name Type Description
list Array
navigation NavigationService
user User
isOwnAccount boolean

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

# TransformSearchContainerPaddingTopCallback(listTopMargin, navHeight) → {Number}

Parameters:
Name Type Description
listTopMargin Number
navHeight Number

New padding top value. Note: aside from the result of add(), you can also return a number as the new value.

Number

# 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>
object

# TransformTopicActionButtonsCallback

TransformTopicActionButtonsCallback

Properties:
Name Type Description
TopicButton JSX.Element

Topic action button
showComplete boolean

Returns true if "Mark Complete" button should be shown
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
topic TLearnTopicViewModel
completing boolean

Returns true if topic is being completed
labels Record.<any, any>

Learndash labels
handleComplete function

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
Object

# TransformUpdateActivityParams

Properties:
Name Type Description
props Object

Activity details
object

# TransformViewProfileFieldSetsCallback

TransformViewProfileFieldSetsCallback

Properties:
Name Type Description
id number

id of field set
name string

Name of the field set
description Record.<any, any>

Description of the field set
group_order number

Order of the group
can_delete boolean

Returns true if field set can be deleted
repeater_enabled boolean

Returns true if repeater is enabled
fields Array

Fields in a field set
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"

# TTranslationFunction(arg0, arg1opt) → {string}

Helper function to translate string

Parameters:
Name Type Attributes Description
arg0 string
arg1 Record.<any, any> <optional>
string
Object

# Typography

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

# User

User

Properties:
Name Type Description
id number

The user's ID
name string

The user's name
url string

The user's URL
description string

A description of the user
link string

The user's link
slug string

The user's slug
avatar_urls Record.<any, any>

An object containing the user's avatar URLs
meta Record.<any, any>

An object containing metadata about the user
push_notification_settings Record.<any, any>

An object containing the user's push notification settings
nicename string

The user's "nice" name (lowercase, no spaces, with hyphens)
points Record.<any, any>

An object containing the user's points
loggedin_user_permissions Record.<any, any>

An object containing the logged-in user's permissions
bbp_user_profile_url string

The URL of the user's profile
topics_started_count number

The number of topics started by the user
replies_created_count number

The number of replies created by the user
forum_role string

The user's forum role
user_points Array

An array of the user's points
user_achievements Array

An array of the user's achievements
user_ranks Array

An array of the user's ranks
member_rest Record.<any, any>

An object containing information about the user's membership
user_login string

The user's login name
member_types Record.<any, any>

An object containing information about the user's member types
registered_date string

The date when the user registered
profile_name string

The user's profile name
last_activity string

The date of the user's last activity
xprofile Record.<any, any>

An object containing the user's extended profile information
followers number

The number of followers the user has
following number

The number of users the user is following
is_wp_admin boolean

A boolean value indicating whether the user is a WordPress admin
friendship_status string

The user's friendship status
friendship_id any

The ID of the user's friendship (if applicable)
create_friendship boolean

A boolean value indicating whether the user can create a friendship
is_following boolean

A boolean value indicating whether the user is following the logged-in user
mention_name string

The user's mention name
cover_url string

The URL of the user's cover image
cover_is_default boolean

A boolean value indicating whether the user's cover image is the default
can_report boolean

A boolean value indicating whether the user can be reported
reported boolean

A boolean value indicating whether the user has been reported
can_user_report boolean

A boolean value indicating whether the logged-in user can report the user
user_reported boolean

A boolean value indicating whether the user has been reported by the logged-in user
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

# UserAgreementTextComponentProps

Properties:
Name Type Description
isSignUpEnabled Boolean

Returns true if sign up is enabled
register Boolean
global Object

App global style
colors Object

App colors
t TranslationFunction
guestEnabled Boolean

Returns true if guests are allowed to access the app
termsOfService Object

Terms of service details
privacyPolice privacyPolice

Privacy police details
withCheckBox Boolean

Returns true if a checkbox should be visible
onPress function

Calls the default on press function
onAgreementChecked function

Calls the default function when agreement is checked
agreementChecked Boolean

Returns true if agreement is checked
style Object

Default style of the component
navigation NavigationService
object

# UserAvatarContainerProps

UserAvatarContainerProps

Properties:
Name Type Description
styles Record.<any, any>

Default styles
object

# UserAvatarProps

UserAvatarProps

Properties:
Name Type Description
isOwnAccount boolean

Returns true if profile displayed in screen is logged-in user's own account
t TTranslationFunction
global Record.<any, any>

App global style
user TMemberViewModel
object

# UserFollowingComponentProps

UserFollowingComponentProps

Properties:
Name Type Description
user TMemberViewModel
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
t TTranslationFunction
object

# UserFullNameComponentProps

UserFullNameComponentProps

Properties:
Name Type Description
user TMemberViewModel
global Record.<any, any>

App global style
textStyle Record.<any, any>
topicLoading Record.<any, any>
object

# UserHandleComponentProps

UserHandleComponentProps

Properties:
Name Type Description
user TMemberViewModel
global Record.<any, any>

App global style
textStyle Record.<any, any>
hideHandle boolean

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

# UserRegisteredComponentProps

UserRegisteredComponentProps

Properties:
Name Type Description
user TMemberViewModel
global Record.<any, any>

App global style
t TTranslationFunction
formatDateFunc function

Helper function for parsing dates
object

# UserTypeComponentProps

UserTypeComponentProps

Properties:
Name Type Description
isUserProfile boolean
user TMemberViewModel
global Record.<any, any>

App global style
textStyle Record.<any, any>

# ValidationFunction(responseObject) → {boolean}

Parameters:
Name Type Description
responseObject Object

Object returned in response
boolean
object

# VideoProgressionComponentProps

VideoProgressionComponentProps

Properties:
Name Type Description
lessonVideoStyle Record.<any, any>

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 Record.<any, any>

App global style
isNavActive boolean

Returns true if screen is active
lesson TLessonViewModel
showVideo boolean

Returns true if video should be shown
videoWatched boolean

Returns true if video has already been watched
setVideoWatched boolean

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
Object

# ViewCertificateButtonProps

Properties:
Name Type Description
result Object

Quiz result details
styles Object
t TranslationFunction
setIsDownloadingState function

Sets the downloading state to true
setIsNotDownloadingState function

Sets the downloading state to false
downloading Boolean

Returns true if certificate is currently downloading
Object

# ViewDetailsQuizButtonProps

Properties:
Name Type Description
global Object

App global style
colors Object

App colors
styles Object
onDetailsClick function

Allows users to redirect to Quiz Details screen
object

# WebSource

WebSource

Properties:
Name Type Description
headers Record.<any, any>
uri string
object

# WebViewContentComponentProps

WebViewContentComponentProps

Properties:
Name Type Description
online boolean

Returns true if device is connected to an internet network
t TTranslationFunction
onShouldStartLoadWithRequest function

The default function used for determining how to handle webview requests.
height number

Default height
source Record.<any, any>

Contains data of the web site to be loaded in the webview
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
ModalHeaderComponent React.FC

Modal which shows up when the "Read More" component is pressed
object

# WebViewDescriptionComponentProps

WebViewDescriptionComponentProps

Properties:
Name Type Description
online boolean

Returns true if device is connected to an internet network
t TTranslationFunction
onShouldStartLoadWithRequest function

The default function used for determining how to handle webview requests.
heightLimit number

Default height limit
source Record.<any, any>

Contains data of the web site to be loaded in the webview
global Record.<any, any>

App global style
colors Record.<any, any>

App colors
ModalHeaderComponent React.FC

Modal which shows up when the "Read More" component is pressed
object

# WebViewOfflineComponentProps

WebViewOfflineComponentProps

Properties:
Name Type Description
global Record.<any, any>

App global style
t TTranslationFunction
containerStyle Record.<any, any>

Default container style
emptyListStyle Record.<any, any>

Default style of EmptyList component

# WebViewPropsParams(url, index, online, screenProps, source)

Parameters:
Name Type Description
url String

Returns the url of the website being loaded
index Number

Index of the webview being loaded
online Boolean

Returns true if device is connected to an internet connection
screenProps Object
source Object

Source used by the web view
object

# XProfileUserAvatarProps

XProfileUserAvatarProps

Properties:
Name Type Description
isOwnAccount boolean

Returns true if profile displayed in screen is logged-in user's own account
t TTranslationFunction
global Record.<any, any>

App global style
user TMemberViewModel
size number

Default avatar size
imagePickerProps Record.<any, any>

Default settings for image picker
object

# XProfileUserFollowingComponentProps

XProfileUserFollowingComponentProps

Properties:
Name Type Description
global Record.<any, any>

App global style
styles Record.<any, any>

Default styles
t TTranslationFunction
user TMemberViewModel
object

# XProfileUserFullNameComponentProps

XProfileUserFullNameComponentProps

Properties:
Name Type Description
user TMemberViewModel
styles Record.<any, any>

Default styles
object

# XProfileUserHandleComponentProps

XProfileUserHandleComponentProps

Properties:
Name Type Description
hideHandle boolean

Returns true if user handle should be hidden
name string

User nickname
colors Record.<any, any>

App colors
styles Record.<any, any>

Default styles
object

# XProfileUserRegisteredComponentProps

XProfileUserRegisteredComponentProps

Properties:
Name Type Description
user TMemberViewModel
global Record.<any, any>

App global style
t TTranslationFunction
formatDateFunc function

Helper function for parsing dates
object

# XProfileUserTypeComponentProps

XProfileUserTypeComponentProps

Properties:
Name Type Description
user TMemberViewModel
styles Record.<any, any>

Default styles