Class MembershipCache

Hierarchy

MembershipCache

Index

Constructors

Methods

getMemberEntry getMemberProfile getMembersForRoom isUserRegistered setMemberEntry

Constructors

constructor

new MembershipCache(): MembershipCache
Returns MembershipCache

Methods

getMemberEntry

getMemberEntry(roomId: string, userId: string): UserMembership
Gets 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.

Returns
The membership state of the user, e.g. "joined"
Parameters
- roomId: string
  
  Room id to check the state of.
- userId: string
  
  The userid to check the state of.
Returns UserMembership

getMemberProfile

getMemberProfile(roomId: string, userId: string): UserProfile
Gets 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.

Returns
The member's profile information.
Parameters
- roomId: string
  
  Room id to check the state of.
- userId: string
  
  The userid to check the state of.
Returns UserProfile

getMembersForRoom

getMembersForRoom(roomId: string, filterFor?: UserMembership): null | string[]
Parameters
- roomId: string
- Optional filterFor: UserMembership
Returns null | string[]

isUserRegistered

isUserRegistered(userId: string): boolean
Is a user considered registered with the homeserver.
Parameters
- userId: string
  
  A Matrix userId
Returns boolean

setMemberEntry

setMemberEntry(roomId: string, userId: string, membership: UserMembership, profile: UserProfile): void
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
- roomId: string
  
  Room id to set the state of.
- userId: string
  
  The userid to set the state of.
- membership: UserMembership
  
  The membership value to set for the user e.g joined.
- profile: UserProfile
Returns void

Generated using TypeDoc