matrix-js-sdk
    Preparing search index...

    Function getHttpUriForMxc

    • Get the HTTP URL for an MXC URI.

      Parameters

      • baseUrl: string

        The base homeserver url which has a content repo.

      • Optionalmxc: string

        The mxc:// URI.

      • Optionalwidth: number

        The desired width of the thumbnail.

      • Optionalheight: number

        The desired height of the thumbnail.

      • OptionalresizeMethod: string

        The thumbnail resize method to use, either "crop" or "scale".

      • allowDirectLinks: boolean = false

        If true, return any non-mxc URLs directly. Fetching such URLs will leak information about the user to anyone they share a room with. If false, will return the emptry string for such URLs.

      • OptionalallowRedirects: boolean

        If true, the caller supports the URL being 307 or 308 redirected to another resource upon request. If false, redirects are not expected. Implied true when useAuthentication is true.

      • OptionaluseAuthentication: boolean

        If true, the caller supports authenticated media and wants an authentication-required URL. Note that server support for authenticated media will not be checked - it is the caller's responsibility to do so before calling this function. Note also that useAuthentication implies allowRedirects. Defaults to false (unauthenticated endpoints).

      • Optionalanimated: boolean

        Whether the desired thumbnail should be animated.

      Returns string

      The complete URL to the content, may be an empty string if the provided mxc is not valid.