Class AutoDiscovery

constructor

• new AutoDiscovery(): AutoDiscovery

• Returns AutoDiscovery

Static ReadonlyALL_ERRORS

Static ReadonlyERROR_GENERIC_FAILURE

Static ReadonlyERROR_INVALID

Static ReadonlyERROR_INVALID_HOMESERVER

Static ReadonlyERROR_INVALID_HS_BASE_URL

Static ReadonlyERROR_INVALID_IDENTITY_SERVER

Static ReadonlyERROR_INVALID_IS

Static ReadonlyERROR_INVALID_IS_BASE_URL

Static ReadonlyERROR_INVALID_JSON

Static ReadonlyERROR_MISSING_WELLKNOWN

Static ReadonlyERROR_UNSUPPORTED_HOMESERVER_SPEC_VERSION

Static ReadonlyFAIL_ERROR

Static ReadonlyFAIL_PROMPT

Static ReadonlyPROMPT

Static ReadonlySUCCESS

StaticfindClientConfig

• findClientConfig(domain: string): Promise<ClientConfig>

• Attempts to automatically discover client configuration information prior to logging in. Such information includes the homeserver URL and identity server URL the client would want. Additional details may also be discovered, and will be transparently included in the response object unaltered.

  Parameters

  • domain: string

    The homeserver domain to perform discovery on. For example, "matrix.org".

  Returns Promise<ClientConfig>

  Promise which resolves to the discovered configuration, which may include error states. Rejects on unexpected failure, not when discovery fails.

StaticfromDiscoveryConfig

• fromDiscoveryConfig(wellknown?: IClientWellKnown): Promise<ClientConfig>

• Validates and verifies client configuration information for purposes of logging in. Such information includes the homeserver URL and identity server URL the client would want. Additional details may also be included, and will be transparently brought into the response object unaltered.

  Parameters

  • Optionalwellknown: IClientWellKnown

    The configuration object itself, as returned by the .well-known auto-discovery endpoint.

  Returns Promise<ClientConfig>

  Promise which resolves to the verified configuration, which may include error states. Rejects on unexpected failure, not when verification fails.

StaticgetRawClientConfig

• getRawClientConfig(domain?: string): Promise<IClientWellKnown>

• Gets the raw discovery client configuration for the given domain name. Should only be used if there's no validation to be done on the resulting object, otherwise use findClientConfig().

  Parameters

  • Optionaldomain: string

    The domain to get the client config for.

  Returns Promise<IClientWellKnown>

  Promise which resolves to the domain's client config. Can be an empty object.

StaticsetFetchFn

• setFetchFn(
      fetchFn: {
          (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
          (input: string | Request | URL, init?: RequestInit): Promise<Response>;
      },
  ): void

• Parameters

  • fetchFn: {
        (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
        (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }
    • • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: RequestInfo | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>
      • (input: string | Request | URL, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: string | Request | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>

  Returns void