Variable ContentRepoConst

ContentRepo: { getHttpUriForMxc: ((baseUrl: string, mxc: string, width?: number, height?: number, resizeMethod?: "crop" | "scale", allowDirectLinks?: boolean) => string) } = ...

Type declaration

  • getHttpUriForMxc: ((baseUrl: string, mxc: string, width?: number, height?: number, resizeMethod?: "crop" | "scale", allowDirectLinks?: boolean) => string)
      • (baseUrl: string, mxc: string, width?: number, height?: number, resizeMethod?: "crop" | "scale", allowDirectLinks?: boolean): string
      • Get the HTTP URL for an MXC URI.

        Returns

        The complete URL to the content. May be empty string if mxc is not a string.

        Parameters

        • baseUrl: string

          The base homeserver url which has a content repo.

        • mxc: string

          The mxc:// URI.

        • Optional width: number

          The desired width of the thumbnail.

        • Optional height: number

          The desired height of the thumbnail.

        • Optional resizeMethod: "crop" | "scale"

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

        • Optional allowDirectLinks: boolean

          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.

        Returns string

Generated using TypeDoc