Global

Members

(constant) root

Where the App function is called and the website instance is rendered
Source:

Methods

addFilter(request) → {Promise.<any>}

Creates a new user filter
Parameters:
Name Type Description
request is the request json body sent to the endpoint
Source:
Returns:
is the json data returned
Type
Promise.<any>

addList(request) → {Promise.<any>}

Creates a new user list
Parameters:
Name Type Description
request is the request json body sent to the endpoint
Source:
Returns:
is the json data returned
Type
Promise.<any>

AddListModal()

This is the Add List modal function which creates new lists
Source:
Returns:
The list modal which adds new lists

addPostToFavoritesList(request) → {Promise.<any>}

Adds a post to a list
Parameters:
Name Type Description
request is the request json body sent to the endpoint
Source:
Returns:
is the json data returned
Type
Promise.<any>

addTag(request) → {Promise.<any>}

Creates a new user post tag
Parameters:
Name Type Description
request is the request json body sent to the endpoint
Source:
Returns:
is the json data returned
Type
Promise.<any>

App()

The App function, where users can navigate to and from different pages
Source:
Returns:
The user interface and the current page the user is on

CheckBox(list)

This is the checkbox function which will be used in the posts popups
Parameters:
Name Type Description
list array all lists to be included
Source:
Returns:
the formcontrol label material

Creator(addedState, curCreatorList, displayName, urlName, description, imgUrl, verified)

This is the Creator function which will populate the posts with the Creator information
Parameters:
Name Type Description
addedState string
curCreatorList array
displayName string
urlName string
description string
imgUrl string
verified bool
Source:
Returns:
Creator information

deleteFilter(request) → {Promise.<any>}

Deletes a user filter
Parameters:
Name Type Description
request is the request json body sent to the endpoint
Source:
Returns:
is the json data returned
Type
Promise.<any>

deleteList(request) → {Promise.<any>}

Deletes a user list
Parameters:
Name Type Description
request is the request json body sent to the endpoint
Source:
Returns:
is the json data returned
Type
Promise.<any>

deletePostFromFavoritesList(request) → {Promise.<any>}

Deletes a post from a list
Parameters:
Name Type Description
request is the request json body sent to the endpoint
Source:
Returns:
is the json data returned
Type
Promise.<any>

deleteTag(request) → {Promise.<any>}

Deletes a user post tag
Parameters:
Name Type Description
request is the request json body sent to the endpoint
Source:
Returns:
is the json data returned
Type
Promise.<any>

Explore()

This is the Explore function which creates the explore page
Source:
Returns:
The explore page user interface

Feed()

This is the Main Feed function which will appear on the home page
Source:
Returns:
Visual representation of the list of posts

Filter(filterChoices, dateRange)

This is the Filters function which will appear on the home page
Parameters:
Name Type Description
filterChoices Array.<array> The name of current filters
dateRange Array.<array> The range of dates including start and end
Source:
Returns:
Visual representation of the filters component

FormContainers()

Calls the files that holds the function LoginForm and RegistrationForm
Source:
Returns:
The header tab of sign in and registration form integrated

getFilters(token) → {Promise.<any>}

Gets the filter objects of the user
Parameters:
Name Type Description
token is the login token of the user's session
Source:
Returns:
is the json data returned
Type
Promise.<any>

getLists(token) → {Promise.<any>}

Gets the List objects of the user
Parameters:
Name Type Description
token is the login token of the user's session
Source:
Returns:
is the json data returned
Type
Promise.<any>

getListsFromPost(url, token) → {Promise.<any>}

Gets the List objects of the user that contain a certain post
Parameters:
Name Type Description
url is the url of the post
token is the login token of the user's session
Source:
Returns:
is the json data returned
Type
Promise.<any>

getPosts(campaign) → {Promise.<any>}

Gets the posts of a specific creator
Parameters:
Name Type Description
campaign is the campaign ID we want to get the posts of
Source:
Returns:
is the json data returned
Type
Promise.<any>

getPostsFromList(token, list_id) → {Promise.<any>}

Gets the posts from a list
Parameters:
Name Type Description
token is the login token of the user's session
list_id is the id of the list we are trying to find the posts of
Source:
Returns:
is the json data returned
Type
Promise.<any>

getSocialIntegrations(token) → {Promise.<any>}

Gets the login token's social integrations
Parameters:
Name Type Description
token is the login token of the user's session
Source:
Returns:
is the json data returned
Type
Promise.<any>

getTags(token) → {Promise.<any>}

Gets the tag objects of the users posts
Parameters:
Name Type Description
token is the login token of the user's session
Source:
Returns:
is the json data returned
Type
Promise.<any>

Home()

This is the Home function which creates the home page
Source:
Returns:
The home page user interface

ListButton()

This is the List button function which navigates to the list page
Source:
Returns:
The list button allows users to add new lists and navigate to the lists page

ListConfigModal()

This is the List config modal function which creates the list options
Source:
Returns:
The list options allowing users to create new lists and edit them

ListFeed()

This is the List feed function to display the list feed
Source:
Returns:
The list feed interface

ListPage()

This is the List page function which creates the list page
Source:
Returns:
The list page user interface

LoginForm()

The Login Form, where users can login to the website
Source:
Returns:
the login form

LoginPage()

The login function which controls what is displayed on the login page
Source:
Returns:
The login page user interface

loginUser(credentials) → {Promise.<any>}

Logs the user in using credentials
Parameters:
Name Type Description
credentials user login credentials
Source:
Returns:
is the json data returned
Type
Promise.<any>

logoutUser(token) → {Promise.<any>}

Deletes the local session token from the database
Parameters:
Name Type Description
token is the session token
Source:
Returns:
is the json data returned
Type
Promise.<any>

PatreonConnect()

This is the Patreon Connect function which will be used for patreon connect oauth button in the Creator settings
Source:
Returns:
Connect to Patreon Button

Post(title, creator_page_url, is_public, content, url, published_at, lists)

The post object which will appear in the feed
Parameters:
Name Type Description
title string The name of the post
creator_page_url string The creator of the post
is_public boolean The checkmark display for private posts
content string The message contained in the post
url string The url of the creator
published_at Date The date and time the post was published
lists The user's lists
Source:
Returns:
A single post component to be displayed in the feed

registerUser(credentials) → {Promise.<any>}

Registers the user
Parameters:
Name Type Description
credentials are the credentials of the user we want to register
Source:
Returns:
is the json data returned
Type
Promise.<any>

RegistrationForm()

The Registration Form, where users can register an account
Source:
Returns:
the registration form

resetPassword(request) → {Promise.<any>}

resets a user password
Parameters:
Name Type Description
request is the request json body sent to the endpoint
Source:
Returns:
is the json data returned
Type
Promise.<any>
This is the searchbar component above the main feed
Parameters:
Name Type Description
searchTerm string The search term to filter posts for
Source:
Returns:
A search term for filtering posts by

SettingsContainers()

Calls the files that holds the function LoginForm and RegistrationForm
Source:
Returns:
The header tab of sign in and registration form integrated
This is the Sidebar Component of the home page
Source:
Returns:
Visual representation of the sidebar and it's options

SidebarOption(text, Icon, active)

The SidebarOption component to populate the sidebar component
Parameters:
Name Type Description
text string The text displayed on each option
Icon icon The icon used to represent each
active boolean Determines which page you are currently on
Source:
Returns:
A sidebaroption component for use in the sidebar

TagPopUp(url)

This is the tag component for each post
Parameters:
Name Type Description
url string The url for finding the correct post
Source:
Returns:
The tags to be listed on each post

TwitterConnect()

This is the TwitterConnect function which will be used to connect to twitter for cross-posting
Source:
Returns:
Connect to twitter button

updateList(request) → {Promise.<any>}

Updates a user list
Parameters:
Name Type Description
request is the request json body sent to the endpoint
Source:
Returns:
is the json data returned
Type
Promise.<any>

updateListsForPost(request) → {Promise.<any>}

Updates a post from every user list
Parameters:
Name Type Description
request is the request json body sent to the endpoint
Source:
Returns:
is the json data returned
Type
Promise.<any>