Home / @sym20/core-conversations / IConversationStore / createIM

IConversationStore.createIM() method

Create a one to one chat with another user

Signature
createIM(userId: UserId): Promise<IConversationIM>;

Remarks

If an IM conversation with the given user already exists, that same conversation will be returned

Parameters

ParameterTypeDescription
userIdUserId

The user to start an one to one chat with

Returns

TypeDescription
Promise<IConversationIM>

The existing or created conversation

Throws

Error

TooManyMembersInConversation

InactiveMembersInConversation

UserNotEntitled

InformationBarrierViolation

UserConnectionMissing

UserInactive