Class: MembersHelper

MembersHelper()

A helper type for member-related API endpoints.

Constructor

new MembersHelper()

Source:

Methods

(async) bans() → {Array.<Ban>}

Fetch a list of recently issued bans.
Source:
Returns:
An array of raw data objects.
Type
Array.<Ban>

(async) fetch(memberId) → {Member}

Fetch information about a member.
Parameters:
Name Type Description
memberId number The identifier of the member.
Source:
Returns:
A raw data object.
Type
Member

(async) fetchByDiscord(discordId) → {Member}

Fetch information about a member by Discord identifier.
Parameters:
Name Type Description
discordId string The identifier of the Discord account.
Source:
Returns:
A raw data object.
Type
Member

(async) fetchByUsername(username) → {Member}

Fetch information about a member by username.
Parameters:
Name Type Description
username string The username of the member.
Source:
Returns:
A raw data object.
Type
Member

(async) modifySelf(aboutMe, customTitle, signature)

Modify information about yourself.
Parameters:
Name Type Description
aboutMe string The 'about me' field content, or undefined.
customTitle string The 'custom title' field content, or undefined.
signature string The 'signature' field content, or undefined.
Source:

profilePosts() → {ProfilePostsHelper}

Access profile post-related helper functions.
Source:
Returns:
A newly-constructed profile post helper instance.
Type
ProfilePostsHelper

(async) self() → {Member}

Fetch information about yourself.
Source:
Returns:
A raw data object.
Type
Member