matrix-js-sdk

    Interface MembershipConfig

    interface MembershipConfig {
        callMemberEventRetryDelayMinimum?: number;
        callMemberEventRetryJitter?: number;
        maximumNetworkErrorRetryCount?: number;
        maximumRateLimitRetryCount?: number;
        memberEventCheckPeriod?: number;
        membershipExpiryTimeout?: number;
        membershipExpiryTimeoutHeadroom?: number;
        membershipKeepAlivePeriod?: number;
        membershipServerSideExpiryTimeout?: number;
        useNewMembershipManager?: boolean;
    }
    Index

    Properties

    callMemberEventRetryDelayMinimum?: number

    The minimum delay (in milliseconds) after which we will retry sending the membership event if it failed to send.

    callMemberEventRetryJitter?: number

    It should be possible to make it stable without this.

    maximumNetworkErrorRetryCount?: number

    The maximum number of retries that the manager will do for delayed event sending/updating and state event sending when a network error occurs.

    maximumRateLimitRetryCount?: number

    The maximum number of retries that the manager will do for delayed event sending/updating and state event sending when a server rate limit has been hit.

    memberEventCheckPeriod?: number

    The period (in milliseconds) with which we check that our membership event still exists on the server. If it is not found we create it again.

    membershipExpiryTimeout?: number

    The timeout (in milliseconds) after we joined the call, that our membership should expire unless we have explicitly updated it.

    This is what goes into the m.rtc.member event expiry field and is typically set to a number of hours.

    membershipExpiryTimeoutHeadroom?: number

    The time in (in milliseconds) which the manager will prematurely send the updated state event before the membership expires time to make sure it sends the updated state event early enough.

    A headroom of 1000ms and a membershipExpiryTimeout of 10000ms would result in the first membership event update after 9s and a membership event that would be considered expired after 10s.

    This value does not have an effect on the value of SessionMembershipData.expires.

    membershipKeepAlivePeriod?: number

    The interval (in milliseconds) in which the client will send membership keep-alives to the server.

    membershipServerSideExpiryTimeout?: number

    The timeout (in milliseconds) with which the deleayed leave event on the server is configured. After this time the server will set the event to the disconnected stat if it has not received a keep-alive from the client.

    useNewMembershipManager?: boolean

    Use the new Manager.

    Default: false.

    MMNEPVFCICPMFPCPTTAAATR