Type alias HttpApiEventHandlerMap

HttpApiEventHandlerMap: {
    Session.logged_out: ((err: MatrixError) => void);
    no_consent: ((message: string, consentUri: string) => void);
}

Type declaration

  • Session.logged_out: ((err: MatrixError) => void)
      • (err: MatrixError): void
      • Fires whenever the login session the JS SDK is using is no longer valid and the user must log in again. NB. This only fires when action is required from the user, not when then login session can be renewed by using a refresh token.

        Example

        matrixClient.on("Session.logged_out", function(errorObj){
        // show the login screen
        });

        Parameters

        Returns void

  • no_consent: ((message: string, consentUri: string) => void)
      • (message: string, consentUri: string): void
      • Fires when the JS SDK receives a M_CONSENT_NOT_GIVEN error in response to a HTTP request.

        Example

        matrixClient.on("no_consent", function(message, contentUri) {
        console.info(message + ' Go to ' + contentUri);
        });

        Parameters

        • message: string
        • consentUri: string

        Returns void

Generated using TypeDoc