Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MemberStateService

A MemberStateService is used by collaboration servers to store and retrieve member states. This is a key component for the clustering of collaboration servers.

Hierarchy

  • MemberStateService

Index

Methods

Methods

addOnlineMember

  • addOnlineMember(collaborationId: string, memberId: string): Promise<boolean>

  • Add a member to the online member list of a collaboration.

    Parameters

    • collaborationId: string

      The id of the collaboration.

    • memberId: string

      The id of the member.

    Returns Promise<boolean>

    • true means success.
    • false means failure.

getOnlineMembers

  • getOnlineMembers(collaborationId: string): Promise<Set<string>>

  • Get online members of a collaboration.

    Parameters

    • collaborationId: string

      The id of the collaboration.

    Returns Promise<Set<string>>

    • A set of member ids.

removeOnlineMember

  • removeOnlineMember(collaborationId: string, memberId: string): Promise<boolean>

  • Remove a member from the online member list of a collaboration.

    Parameters

    • collaborationId: string

      The id of the collaboration.

    • memberId: string

      The id of the member.

    Returns Promise<boolean>

    • true means success.
    • false means failure.

Generated using TypeDoc