Skip to content

Documentation / @imvu/client / ConversationManager

Class: ConversationManager ​

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

The account's IMs (private and group conversations).

Extends ​

Constructors ​

Constructor ​

ts
new ConversationManager(client): ConversationManager;

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

Parameters ​

ParameterType
clientClient

Returns ​

ConversationManager

Inherited from ​

BaseManager.constructor

Properties ​

client ​

ts
protected client: Client;

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

Inherited from ​

BaseManager.client

Accessors ​

account ​

Get Signature ​

ts
get protected account(): AccountManager;

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

Returns ​

AccountManager

Inherited from ​

BaseManager.account

Methods ​

authenticated() ​

ts
protected authenticated(): boolean;

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

Returns ​

boolean

Inherited from ​

BaseManager.authenticated


fetch() ​

ts
fetch(id, options?): Promise<Conversation>;

Defined in: packages/client/src/managers/ConversationManager.ts:14

Parameters ​

ParameterType
idstring
options?FetchOptions

Returns ​

Promise<Conversation>


list() ​

ts
list(): Collection<Conversation>;

Defined in: packages/client/src/managers/ConversationManager.ts:10

The account's conversations, most recent first. Fresh on every read.

Returns ​

Collection<Conversation>


observe() ​

ts
observe(options?): Promise<ConversationObserver>;

Defined in: packages/client/src/managers/ConversationManager.ts:34

Follow incoming IMs. See ConversationObserver.

Parameters ​

ParameterType
options?ConversationObserveOptions

Returns ​

Promise<ConversationObserver>


send() ​

ts
send(to, text): Promise<void>;

Defined in: packages/client/src/managers/ConversationManager.ts:23

Send a text IM. Pass a conversation to reply in it, or one or more user ids to message them. Messaging people who are not friends needs a verified email (RATE-001 otherwise).

Parameters ​

ParameterType
to| string | number | Conversation | (string | number)[]
textstring

Returns ​

Promise<void>

Released under the MIT License.