ThreadMemberManager

classe · Source

Manages API methods for GuildMembers and stores their cache.

Extends: CachedManager

Properties

thread

thread: ThreadChannel

The thread this manager belongs to Source

cache

cache: Collection<Snowflake, ThreadMember>

The cache of this Manager Source

me

readonly · nullable

me: ThreadMember

The client user as a ThreadMember of this ThreadChannel Source

_cache

readonly · private

_cache: Collection

The private cache of items for this manager. Source

holds

readonly · private

holds: function

The data structure belonging to this manager. Source

client

readonly

client: Client

The client that instantiated this Manager Source

Methods

fetchMe

fetchMe(options?: BaseFetchOptions): Promise<ThreadMember>

Fetches the client user as a ThreadMember of the thread. Parameters

Name	Type	Description
options?	BaseFetchOptions	The options for fetching the member

Returns: Promise<ThreadMember>Source

resolve

resolve(member: ThreadMemberResolvable): GuildMember

Resolves a ThreadMemberResolvable to a ThreadMember object. Parameters

Name	Type	Description
member	ThreadMemberResolvable	The user that is part of the thread

Returns: GuildMemberSource

resolveId

resolveId(member: ThreadMemberResolvable): Snowflake

Resolves a ThreadMemberResolvable to a ThreadMember id string. Parameters

Name	Type	Description
member	ThreadMemberResolvable	The user that is part of the guild

Returns: SnowflakeSource

add

async

async add(member: UserResolvable | '@me', reason?: string): Promise<Snowflake>

Adds a member to the thread. Parameters

Name	Type	Description
member	UserResolvable | '@me'	The member to add
reason?	string	The reason for adding this member

Returns: Promise<Snowflake>Source

remove

async

async remove(id: Snowflake | '@me', reason?: string): Promise<Snowflake>

Remove a user from the thread. Parameters

Name	Type	Description
id	Snowflake | '@me'	The id of the member to remove
reason?	string	The reason for removing this member from the thread

Returns: Promise<Snowflake>Source

fetch

fetch(member?: UserResolvable | FetchThreadMembersOptions | boolean, options?: FetchThreadMemberOptions | FetchThreadMembersOptions): Promise<(ThreadMember|Collection<Snowflake, ThreadMember>)>

Fetches member(s) for the thread from Discord. Parameters

Name	Type	Description
member?	UserResolvable | FetchThreadMembersOptions | boolean	The member to fetch. If undefined, all members in the thread are fetched, and will be cached based on options.cache.
options?	FetchThreadMemberOptions | FetchThreadMembersOptions	Additional options for this fetch

Returns: Promise<(ThreadMember\|Collection<Snowflake, ThreadMember>)>Source