RelationshipManager

classe · Source

Manages API methods for Relationships and stores their cache.

Properties

cache

cache: Collection<Snowflake, RelationshipType>

A collection of users this manager is caching. (Type: Number) Source

friendNicknames

friendNicknames: Collection<Snowflake, string>

[Source](https://github.com/AltKit/discord/blob/selfbotjs/src/managers/RelationshipManager.js#L25)

sinceCache

sinceCache: Collection<Snowflake, Date>

[Source](https://github.com/AltKit/discord/blob/selfbotjs/src/managers/RelationshipManager.js#L29)

friendCache

readonly

friendCache: Collection<Snowflake, User>

Get all friends Source

blockedCache

readonly

blockedCache: Collection<Snowflake, User>

Get all blocked users Source

incomingCache

readonly

incomingCache: Collection<Snowflake, User>

Get all incoming friend requests Source

outgoingCache

readonly

outgoingCache: Collection<Snowflake, User>

Get all outgoing friend requests Source

Methods

toJSON

toJSON(): Array<RelationshipJSONData>

Return array of cache Returns: Array<RelationshipJSONData>Source

_setup

private

_setup(users: Array<User>): void

**Parameters**

Name	Type	Description
users	Array<User>	An array of users to add to the cache

Returns: voidSource

resolveId

resolveId(user: UserResolvable): Snowflake

Resolves a UserResolvable to a User id. Parameters

Name	Type	Description
user	UserResolvable	The UserResolvable to identify

Returns: SnowflakeSource

resolveUsername

resolveUsername(user: UserResolvable): string

Resolves a UserResolvable to a User username. Parameters

Name	Type	Description
user	UserResolvable	The UserResolvable to identify

Returns: stringSource

fetch

async

async fetch(user?: UserResolvable, options?: BaseFetchOptions): Promise<(RelationshipType|RelationshipManager)>

Obtains a user from Discord, or the user cache if it's already available. Parameters

Name	Type	Description
user?	UserResolvable	The user to fetch
options?	BaseFetchOptions	Additional options for this fetch

Returns: Promise<(RelationshipType\|RelationshipManager)>Source

deleteRelationship

async

async deleteRelationship(user: UserResolvable): Promise<boolean>

Deletes a friend / blocked relationship with a client user or cancels a friend request. Parameters

Name	Type	Description
user	UserResolvable	Target

Returns: Promise<boolean>Source

sendFriendRequest

async

async sendFriendRequest(options: UserResolvable): Promise<boolean>

Sends a friend request. Parameters

Name	Type	Description
options	UserResolvable	Target (User Object, Username, User Id)

Returns: Promise<boolean>Source

addFriend

async

async addFriend(user: UserResolvable): Promise<boolean>

Accepts a friend request. Parameters

Name	Type	Description
user	UserResolvable	The user to add as a friend

Returns: Promise<boolean>Source

setNickname

async

async setNickname(user: UserResolvable, nickname: string): Promise<boolean>

Changes the nickname of a friend. Parameters

Name	Type	Description
user	UserResolvable	The user to change the nickname
nickname	string	New nickname Default: null.

Returns: Promise<boolean>Source

addBlocked

async

async addBlocked(user: UserResolvable): Promise<boolean>

Blocks a user. Parameters

Name	Type	Description
user	UserResolvable	User to block

Returns: Promise<boolean>Source