Class: ProfilePostsHelper

ProfilePostsHelper()

A helper type for profile post-related API endpoints.

Constructor

new ProfilePostsHelper()

Source:

Methods

(async) create(message) → {number}

Create a new profile post on your profile.
Parameters:
Name Type Description
message string The content of the message to modify to.
Source:
Returns:
The identifer of the newly-created profile post.
Type
number

(async) delete(profilePostId)

Delete a profile post on your profile that you've authored.
Parameters:
Name Type Description
profilePostId number The identifier of the profile post to delete.
Source:

(async) fetch(profilePostId) → {ProfilePost}

Fetch information about a profile post on your profile.
Parameters:
Name Type Description
profilePostId number The identifier of the profile post to fetch.
Source:
Returns:
A raw data object.
Type
ProfilePost

(async) list(sort) → {Array.<ProfilePost>}

List a page of profile posts on your profile.
Parameters:
Name Type Description
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<ProfilePost>

(async) listAll(sort) → {Array.<ProfilePost>}

List all pages of profile posts on your profile.
Parameters:
Name Type Description
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<ProfilePost>

(async) listUntil(shouldContinue, sort) → {Array.<ProfilePost>}

List multiple pages of profile posts on your profile until a condition is no longer met.
Parameters:
Name Type Description
shouldContinue function A function which determines if further pages are requested.
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<ProfilePost>

(async) modify(profilePostId, message)

Modify a profile post on your profile that you've authored.
Parameters:
Name Type Description
profilePostId number The identifier of the profile post to modify.
message string The content of the message to modify to.
Source: