getHttpUriForMxc
getHttpUriForMxc(
baseUrl,mxc?,width?,height?,resizeMethod?,allowDirectLinks?,allowRedirects?,useAuthentication?,animated?):string
Defined in: src/content-repo.ts:57
Get the HTTP URL for an MXC URI.
Parameters
Section titled “Parameters”baseUrl
Section titled “baseUrl”string
The base hub url which has a content repo.
string
The mxc:// URI.
width?
Section titled “width?”number
The desired width of the thumbnail.
height?
Section titled “height?”number
The desired height of the thumbnail.
resizeMethod?
Section titled “resizeMethod?”string
The thumbnail resize method to use, either “crop” or “scale”.
allowDirectLinks?
Section titled “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.
allowRedirects?
Section titled “allowRedirects?”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.
useAuthentication?
Section titled “useAuthentication?”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).
animated?
Section titled “animated?”boolean
Whether the desired thumbnail should be animated.
Returns
Section titled “Returns”string
The complete URL to the content, may be an empty string if the provided mxc is not valid.