The HTTP method e.g. "GET".
The HTTP path after the supplied prefix e.g. "/createRoom".
A dict of query params (these will NOT be urlencoded). If unspecified, there will be no query params.
Optional
body: BodyThe HTTP JSON body.
additional options.
When paramOpts.doNotAttemptTokenRefresh
is true, token refresh will not be attempted
when an expired token is encountered. Used to only attempt token refresh once.
The parsed response.
Get the content repository url with query parameters.
An object with a 'base', 'path' and 'params' for base URL, path and query parameters respectively.
Form and return a homeserver request URL based on the given path params and prefix.
The HTTP path after the supplied prefix e.g. "/createRoom".
Optional
queryParams: QueryDictA dict of query params (these will NOT be urlencoded).
Optional
prefix: stringThe full prefix to use e.g. "/_matrix/client/v2_alpha", defaulting to this.opts.prefix.
Optional
baseUrl: stringThe baseUrl to use e.g. "https://matrix.org", defaulting to this.opts.baseUrl.
URL
Perform a request to the homeserver without any credentials.
The HTTP method e.g. "GET".
The HTTP path after the supplied prefix e.g. "/createRoom".
Optional
queryParams: QueryDictA dict of query params (these will NOT be urlencoded). If unspecified, there will be no query params.
Optional
body: BodyThe HTTP JSON body.
Optional
opts: IRequestOptsadditional options
The parsed response.
Sets the base URL for the identity server
Optional
url: stringThe new base url
Upload content to the homeserver
The object to upload. On a browser, something that can be sent to XMLHttpRequest.send (typically a File). Under node.js, a Buffer, String or ReadStream.
options object
Promise which resolves to response object, or rejects with an error (usually a MatrixError).
Perform an authorised request to the homeserver.