Documentation / @imvu/client / FriendManager

Class: FriendManager

Defined in: packages/client/src/managers/FriendManager.ts:8

Manage a client's friends list.

Extends

• BaseManager

Constructors

Constructor

new FriendManager(client): FriendManager;

Defined in: packages/client/src/managers/BaseManager.ts:5

Parameters

Parameter	Type
client	Client

Returns

FriendManager

Inherited from

BaseManager.constructor

Properties

client

protected client: Client;

Defined in: packages/client/src/managers/BaseManager.ts:5

Inherited from

BaseManager.client

Accessors

account

Get Signature

get protected account(): AccountManager;

Defined in: packages/client/src/managers/BaseManager.ts:7

Returns

AccountManager

Inherited from

BaseManager.account

Methods

add()

Call Signature

add(user): Promise<boolean>;

Defined in: packages/client/src/managers/FriendManager.ts:20

Parameters

Parameter	Type
user	User

Returns

Promise<boolean>

Call Signature

add(username): Promise<boolean>;

Defined in: packages/client/src/managers/FriendManager.ts:21

Parameters

Parameter	Type
username	string

Returns

Promise<boolean>

Call Signature

add(id): Promise<boolean>;

Defined in: packages/client/src/managers/FriendManager.ts:22

Parameters

Parameter	Type
id	number

Returns

Promise<boolean>

---

authenticated()

protected authenticated(): boolean;

Defined in: packages/client/src/managers/BaseManager.ts:11

Returns

boolean

Inherited from

BaseManager.authenticated

---

count()

count(): Promise<number>;

Defined in: packages/client/src/managers/FriendManager.ts:16

Returns

Promise<number>

---

list()

list(): Collection<User<UserRelations>>;

Defined in: packages/client/src/managers/FriendManager.ts:12

An asynchronous generator which yields each User on the client's friends list.

Returns

Collection<User<UserRelations>>

---

remove()

Call Signature

remove(user): Promise<boolean>;

Defined in: packages/client/src/managers/FriendManager.ts:38

Parameters

Parameter	Type
user	User

Returns

Promise<boolean>

Call Signature

remove(username): Promise<boolean>;

Defined in: packages/client/src/managers/FriendManager.ts:39

Parameters

Parameter	Type
username	string

Returns

Promise<boolean>

Call Signature

remove(id): Promise<boolean>;

Defined in: packages/client/src/managers/FriendManager.ts:40

Parameters

Parameter	Type
id	number

Returns

Promise<boolean>