Class: MembershipCache

MembershipCache()

Caches membership of virtual users to rooms in memory and also stores the state of whether users are registered.

Constructor

new MembershipCache()

Source:

Methods

getMemberEntry(}, userId) → {string}

Get's the *cached* state of a user's membership for a room. This DOES NOT check to verify the value is correct (i.e the room may have state reset and left the user from the room). This only caches users from the appservice.
Parameters:
Name Type Description
} string roomId Room id to check the state of.
userId string The userid to check the state of.
Source:
Returns:
The membership state of the user, e.g. "joined"
Type
string

setMemberEntry(roomId, userId, membership)

Set the *cached* state of a user's membership for a room. Use this to optimise intents so that they do not attempt to join a room if we know they are joined. This DOES NOT set the actual membership of the room. This only caches users from the appservice.
Parameters:
Name Type Description
roomId string Room id to set the state of.
userId string The userid to set the state of.
membership string The membership value to set for the user e.g joined.
Source: