Interface IMembershipManager`Internal`

This interface defines what a MembershipManager uses and exposes. This interface is what we use to write tests and allows to change the actual implementation Without breaking tests because of some internal method renaming.

interface IMembershipManager {
    getActiveFocus(): undefined | Focus;
    isJoined(): boolean;
    join(fociPreferred: Focus[], fociActive?: Focus): void;
    leave(timeout: undefined | number): Promise<boolean>;
    onRTCSessionMemberUpdate(memberships: CallMembership[]): Promise<void>;
}

Index

Methods

getActiveFocus isJoined join leave onRTCSessionMemberUpdate

Methods

getActiveFocus

getActiveFocus(): undefined | Focus
Returns undefined | Focus
- Defined in src/matrixrtc/MembershipManager.ts:28

isJoined

isJoined(): boolean
Returns boolean
- Defined in src/matrixrtc/MembershipManager.ts:21

join

join(fociPreferred: Focus[], fociActive?: Focus): void
Parameters
- fociPreferred: Focus[]
- OptionalfociActive: Focus
Returns void
- Defined in src/matrixrtc/MembershipManager.ts:22

leave

leave(timeout: undefined | number): Promise<boolean>
Parameters
- timeout: undefined | number
Returns Promise<boolean>
- Defined in src/matrixrtc/MembershipManager.ts:23

onRTCSessionMemberUpdate

onRTCSessionMemberUpdate(memberships: CallMembership[]): Promise<void>
call this if the MatrixRTC session members have changed
Parameters
- memberships: CallMembership[]
Returns Promise<void>
- Defined in src/matrixrtc/MembershipManager.ts:27